Merge pull request #143 from plivo/ppai-lookup-api

Add lookup API support

Author: nixonsam

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [4.12.0](https://github.com/plivo/plivo-python/tree/v4.12.0) (2020-10-06)
+- Add lookup API support.
+
 ## [4.11.0](https://github.com/plivo/plivo-python/tree/v4.11.0) (2020-09-24)
 - Add "public_uri" optional param support for Application API.
 

README.md

@@ -116,6 +116,16 @@ call_made = client.calls.create(
 
 ```
 
+### Lookup a number
+
+```python
+import plivo
+
+client = plivo.RestClient(auth_id='', auth_token='')
+resp = client.lookup.get("<insert-number-here>", info_type='carrier')
+print(resp)
+```
+
 ### Generate Plivo XML
 
 ```python

plivo/resources/__init__.py

@@ -13,4 +13,5 @@
 from .media import Media
 from .identities import Identities
 from .call_feedback import CallFeedback
-from .powerpacks import Powerpacks
+from .powerpacks import Powerpacks
+from .lookup import Lookup

plivo/resources/lookup.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+from plivo.base import PlivoResourceInterface, ResponseObject
+
+
+class Number(ResponseObject):
+    def __init__(self, client, data):
+        super(Number, self).__init__(data)
+
+
+class Lookup(PlivoResourceInterface):
+    _resource_type = Number
+
+    def get(self, number, info_type='carrier'):
+        params = {
+            'type': info_type,
+        }
+        return self.client.request(
+            'GET',
+            ('Lookup/Number', number),
+            data=params,
+            response_type=Number,
+            plivo_api_v1_base_url=True)

plivo/rest/client.py

@@ -12,7 +12,8 @@
                               PlivoRestError, PlivoServerError,
                               ResourceNotFoundError, ValidationError)
 from plivo.resources import (Accounts, Addresses, Applications, Calls,
-                             Conferences, Endpoints, Identities, Messages, Powerpacks, Media,
+                             Conferences, Endpoints, Identities,
+                             Messages, Powerpacks, Media, Lookup,
                              Numbers, Pricings, Recordings, Subaccounts, CallFeedback)
 from plivo.resources.live_calls import LiveCalls
 from plivo.resources.queued_calls import QueuedCalls
@@ -24,6 +25,7 @@
                                        'auth_id auth_token')
 
 PLIVO_API = 'https://api.plivo.com'
+PLIVO_API_V1 = '/'.join([PLIVO_API, 'v1'])
 PLIVO_API_BASE_URI = '/'.join([PLIVO_API, 'v1/Account'])
 
 # Will change these urls before putting this change in production
@@ -92,6 +94,7 @@ def __init__(self, auth_id=None, auth_token=None, proxies=None, timeout=5):
         self.conferences = Conferences(self)
         self.endpoints = Endpoints(self)
         self.messages = Messages(self)
+        self.lookup = Lookup(self)
         self.numbers = Numbers(self)
         self.powerpacks = Powerpacks(self)
         self.media = Media(self)
@@ -197,10 +200,17 @@ def process_response(self,
         return response_json
 
     def create_request(self, method, path=None, data=None, **kwargs):
-
+        # The abstraction created by request() and create_request() is moot
+        # now since several product-specific handling have been aded.
+        # Requires a refactor.
         if 'is_callinsights_request' in kwargs:
             url = '/'.join([CALLINSIGHTS_BASE_URL, kwargs['callinsights_request_path']])
             req = Request(method, url, **({'params': data} if method == 'GET' else {'json': data}))
+        elif kwargs.get('plivo_api_v1_base_url', False):
+            # currently used by lookup API but can be used by other APIs in future
+            path = path or []
+            url = '/'.join([PLIVO_API_V1] + list([str(p) for p in path]))
+            req = Request(method, url, **({'params': data} if method == 'GET' else {'json': data}))
         else:
             path = path or []
             req = Request(method, '/'.join([self.base_uri, self.session.auth[0]] +
@@ -285,6 +295,9 @@ def request(self,
                     kwargs["is_voice_request"] = True
                     return self.request(method, path, data, **kwargs)
                 return self.process_response(method, response, response_type, objects_type)
+            elif kwargs.get('plivo_api_v1_base_url', False):
+                req = self.create_request(method, path, data, plivo_api_v1_base_url=True)
+                del kwargs['plivo_api_v1_base_url']
             else:
                 req = self.create_request(method, path, data)
             session = self.session

plivo/version.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = '4.10.2'
+__version__ = '4.12.0'

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name='plivo',
-    version='4.11.0',
+    version='4.12.0',
     description='A Python SDK to make voice calls & send SMS using Plivo and to generate Plivo XML',
     long_description=long_description,
     url='https://github.com/plivo/plivo-python',

tests/resources/fixtures/lookupGetResponse.json

@@ -0,0 +1,23 @@
+{
+  "api_id": "a35a2e7a-fd27-42e6-910c-33382f43240e",
+  "phone_number": "+14154305555",
+  "country": {
+    "name": "United States",
+    "code_iso2": "US",
+    "code_iso3": "USA"
+  },
+  "format": {
+    "e164": "+14154305555",
+    "national": "(415) 430-5555",
+    "international": "+1 415-430-5555",
+    "rfc3966": "tel:+1-415-430-5555"
+  },
+  "carrier": {
+    "mobile_country_code": "310",
+    "mobile_network_code": "150",
+    "name": "Cingular Wireless",
+    "type": "mobile",
+    "ported": true
+  },
+  "resource_uri": "/v1/Lookup/Number/+14154305555?type=carrier"
+}

tests/resources/test_lookup.py

@@ -0,0 +1,12 @@
+from plivo import exceptions
+from tests.base import PlivoResourceTestCase
+from tests.decorators import with_response
+
+
+class LookupTest(PlivoResourceTestCase):
+    @with_response(200)
+    def test_get(self):
+        number = '+14154305555'
+        resp = self.client.lookup.get(number)
+        self.assertResponseMatches(resp)
+        self.assertEqual(self.client.current_request.method, 'GET')