Merge pull request #73 from plivo/sept-2018-release

Rajat Singh · web-flow · commit e445e65d99a2 · 2018-09-18T17:00:57.000+05:30
Add python3.7 support

Add support to get queued calls

Add powerpack support

Add support for filter of parent call UUID
diff --git a/.DS_Store b/.DS_Store
diff --git a/.travis.yml b/.travis.yml
@@ -1,12 +1,20 @@
 sudo: false
 language: python
-python:
-    - "2.7"
-    - "3.3"
-    - "3.4"
-    - "3.5"
-    - "3.5-dev" # 3.5 development branch
-    - "3.6"
-    - "3.6-dev" # 3.6 development branch
+matrix:
+  include:
+    - python: "2.7"
+      dist: trusty
+    - python: "3.4"
+      dist: trusty
+    - python: "3.5"
+      dist: trusty
+    - python: "3.6"
+      dist: trusty
+    - python: "3.7"
+      dist: xenial
+      sudo: true
+    - python: "3.7-dev"
+      dist: xenial
+      sudo: true
 install: pip install tox-travis
-script: tox
+script: tox
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Change Log
 
+## [4.1.1](https://github.com/plivo/plivo-python/tree/v4.1.1) (2018-06-29)
+- Added limit & offset parameters to endpoint list api
+
 ## [4.1.0](https://github.com/plivo/plivo-python/tree/v4.1.0) (2018-02-26)
 - Add Address and Identity resources
 - Change a few functions in numbers.py to support the verification flows
diff --git a/plivo/.DS_Store b/plivo/.DS_Store
diff --git a/plivo/resources/applications.py b/plivo/resources/applications.py
@@ -25,7 +25,8 @@ def update(self,
                message_method='POST',
                default_number_app=False,
                default_endpoint_app=False,
-               subaccount=None):
+               subaccount=None,
+               log_incoming_messages=True):
         params = to_param_dict(self.update, locals())
         self.__dict__.update(params)
         return self.client.applications.update(self.id, **params)
@@ -54,7 +55,8 @@ class Applications(PlivoResourceInterface):
         message_method=[optional(of_type(six.text_type))],
         default_number_app=[optional(of_type_exact(bool))],
         default_endpoint_app=[optional(of_type_exact(bool))],
-        subaccount=[optional(is_subaccount())])
+        subaccount=[optional(is_subaccount())],
+        log_incoming_messages = [optional(of_type_exact(bool))])
     def create(self,
                answer_url,
                app_name,
@@ -67,7 +69,8 @@ def create(self,
                message_method='POST',
                default_number_app=False,
                default_endpoint_app=False,
-               subaccount=None):
+               subaccount=None,
+               log_incoming_messages=True):
 
         if subaccount:
             if isinstance(subaccount, Subaccount):
@@ -117,7 +120,8 @@ def list(self, subaccount=None, limit=20, offset=0):
         message_method=[optional(of_type(six.text_type))],
         default_number_app=[optional(of_type_exact(bool))],
         default_endpoint_app=[optional(of_type_exact(bool))],
-        subaccount=[optional(is_subaccount())])
+        subaccount=[optional(is_subaccount())],
+        log_incoming_messages=[optional(of_type_exact(bool))])
     def update(self,
                app_id,
                answer_url,
@@ -130,7 +134,8 @@ def update(self,
                message_method='POST',
                default_number_app=False,
                default_endpoint_app=False,
-               subaccount=None):
+               subaccount=None,
+               log_incoming_messages=True):
         if subaccount:
             if isinstance(subaccount, Subaccount):
                 subaccount = subaccount.id
diff --git a/plivo/resources/calls.py b/plivo/resources/calls.py
@@ -167,7 +167,7 @@ def create(self,
             optional(of_type(six.text_type), is_in(('inbound', 'outbound')))
         ],
         from_number=[optional(is_phonenumber())],
-        to_number=[optional(is_iterable(six.text_type, '<'))],
+        to_number=[optional(is_iterable(of_type(six.text_type), sep='<'))],
         limit=[
             optional(
                 all_of(
@@ -179,6 +179,9 @@ def create(self,
                 all_of(
                     of_type(*six.integer_types),
                     check(lambda offset: 0 <= offset, '0 <= offset')))
+        ],
+        parent_call_uuid=[
+            optional(of_type(six.text_type))
         ])
     def list(self,
              subaccount=None,
@@ -197,7 +200,8 @@ def list(self,
              bill_duration=None,
              limit=20,
              offset=0,
-             status=None):
+             status=None,
+             parent_call_uuid=None):
         return self.client.request(
             'GET',
             ('Call', ),
@@ -358,3 +362,9 @@ def live_call_list_ids(self, limit=None, offset=None):
 
     def live_call_get(self, _id):
         return self.client.live_calls.get(_id)
+
+    def queued_call_list_ids(self, limit=None, offset=None):
+        return self.client.queued_calls.list_ids(limit, offset)
+
+    def queued_call_get(self, _id):
+        return self.client.queued_calls.get(_id)
diff --git a/plivo/resources/messages.py b/plivo/resources/messages.py
@@ -24,24 +24,36 @@ class Messages(PlivoResourceInterface):
     _resource_type = Message
 
     @validate_args(
-        src=[is_phonenumber()],
+        src=[optional(is_phonenumber())],
         dst=[is_iterable(of_type(six.text_type), '<')],
         text=[of_type(six.text_type)],
         type_=[optional(all_of(of_type(six.text_type), is_in(('sms', ))))],
         url=[optional(is_url())],
         method=[optional(of_type(six.text_type))],
-        log=[optional(of_type_exact(bool))])
+        log=[optional(of_type_exact(bool))],
+        trackable=[optional(of_type_exact(bool))],
+        powerpack_uuid=[optional(of_type(six.text_type))])
     def create(self,
-               src,
                dst,
                text,
+               src=None,
                type_='sms',
                url=None,
                method='POST',
-               log=True):
+               log=True,
+               trackable=False,
+               powerpack_uuid=None):
         if src in dst.split('<'):
             raise ValidationError(
                 'destination number cannot be same as source number')
+        elif (src is None) and (powerpack_uuid is None):
+            raise ValidationError(
+                'Specify either powerpack_uuid or src in request params to send a message'
+            )
+        elif (src is not None) and (powerpack_uuid is not None):
+            raise ValidationError(
+                'Both powerpack_uuid and src cannot be specified. Specify either powerpack_uuid or src in request params to send a message.'
+            )
         return self.client.request('POST', ('Message', ),
                                    to_param_dict(self.create, locals()))
 
diff --git a/plivo/resources/queued_calls.py b/plivo/resources/queued_calls.py
@@ -0,0 +1,39 @@
+from plivo.base import PlivoResource, PlivoResourceInterface
+
+from ..utils.validators import *
+
+
+class QueuedCall(PlivoResource):
+    _name = 'QueuedCall'
+    _identifier_string = 'call_uuid'
+
+
+class QueuedCalls(PlivoResourceInterface):
+    _resource_type = QueuedCall
+    _iterable = False
+
+    @validate_args(
+        limit=[
+            optional(
+                all_of(
+                    of_type(*six.integer_types),
+                    check(
+                        lambda limit: 0 < limit <= 20,
+                        message='0 < limit <= 20')))
+        ],
+        offset=[
+            optional(
+                all_of(
+                    of_type(*six.integer_types),
+                    check(lambda offset: 0 <= offset, message='0 <= offset')))
+        ])
+    def list_ids(self, limit=20, offset=0):
+        return self.client.request('GET', ('Call', ), {
+            'status': 'queued',
+            'limit': limit,
+            'offset': offset,
+        })
+
+    @validate_args(_id=[of_type(six.text_type)])
+    def get(self, _id):
+        return self.client.request('GET', ('Call', _id), {'status': 'queued'})
diff --git a/plivo/rest/client.py b/plivo/rest/client.py
@@ -15,6 +15,7 @@
                              Conferences, Endpoints, Identities, Messages,
                              Numbers, Pricings, Recordings, Subaccounts)
 from plivo.resources.live_calls import LiveCalls
+from plivo.resources.queued_calls import QueuedCalls
 from plivo.utils import is_valid_mainaccount, is_valid_subaccount
 from plivo.version import __version__
 from requests import Request, Session
@@ -77,6 +78,7 @@ def __init__(self, auth_id=None, auth_token=None, proxies=None, timeout=5):
         self.applications = Applications(self)
         self.calls = Calls(self)
         self.live_calls = LiveCalls(self)
+        self.queued_calls = QueuedCalls(self)
         self.conferences = Conferences(self)
         self.endpoints = Endpoints(self)
         self.messages = Messages(self)
diff --git a/plivo/version.py b/plivo/version.py
@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = '4.1.0'
+__version__ = '4.1.1'
diff --git a/plivo/xml/DTMFElement.py b/plivo/xml/DTMFElement.py
@@ -8,30 +8,30 @@ class DTMFElement(PlivoXMLElement):
     _nestable = []
 
     @property
-    def async(self):
+    def async_(self):
         return self.__async
 
-    @async.setter
-    def async(self, value):
+    @async_.setter
+    def async_(self, value):
         self.__async = bool(value) if value is not None else None
 
     def set_async(self, value):
-        self.async = value
+        self.async_ = value
         return self
 
     def __init__(
             self,
             content,
-            async=None,
+            async_=None,
     ):
         super(DTMFElement, self).__init__()
 
         self.content = content
-        self.async = async
+        self.async_ = async_
 
     def to_dict(self):
         d = {
-            'async': self.async,
+            'async': self.async_,
         }
         return {
             k: six.text_type(map_type(v))
diff --git a/plivo/xml/ResponseElement.py b/plivo/xml/ResponseElement.py
@@ -135,11 +135,11 @@ def add_user(
     def add_dtmf(
             self,
             content,
-            async=None,
+            async_=None,
     ):
         self.add(DTMFElement(
             content=content,
-            async=async,
+            async_=async_,
         ))
         return self
 
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 decorator==4.1.2
-lxml==3.8.0
+lxml==4.2.3
 requests==2.18.4
 six==1.10.0
diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@
 
 setup(
     name='plivo',
-    version='4.1.0',
+    version='4.1.1',
     description=
     'A Python SDK to make voice calls & send SMS using Plivo and to generate Plivo XML',
     long_description=long_description,
@@ -40,7 +40,7 @@
         'requests >= 2, < 3',
         'six >= 1, < 2',
         'decorator >= 4, < 5',
-        'lxml >= 3, < 4',
+        'lxml >= 3, < 5',
     ],
     keywords=['plivo', 'plivo xml', 'voice calls', 'sms'],
     include_package_data=True,
diff --git a/tests/resources/test_messages.py b/tests/resources/test_messages.py
@@ -28,6 +28,38 @@ def test_send_message_same_src_dst(self):
             dst='1234',
             text='Abcd')
 
+    def test_send_message_with_powerpack(self):
+        expected_response = {'message_uuid': 'adsdafkjadshf123123'}
+        self.client.set_expected_response(
+            status_code=202, data_to_return=expected_response)
+
+        test_message = self.client.messages.create(
+            powerpack_uuid='1234', dst='12345', text='Abcd')
+
+        self.assertEqual(
+            self.client.current_request.url,
+            'https://api.plivo.com/v1/Account/MAXXXXXXXXXXXXXXXXXX/Message/')
+        self.assertEqual(self.client.current_request.method, 'POST')
+        self.assertEqual(test_message.message_uuid,
+                         expected_response['message_uuid'])
+
+    def test_send_message_with_both_src_powerpack(self):
+        self.assertRaises(
+            exceptions.ValidationError,
+            self.client.messages.create,
+            powerpack_uuid='1234',
+            src='1234',
+            dst='1234',
+            text='Abcd')
+
+    def test_send_message_with_no_src_powerpack(self):
+        self.assertRaises(
+            exceptions.ValidationError,
+            self.client.messages.create,
+            dst='1234',
+            text='Abcd')
+
+
     @with_response(200)
     def test_get(self):
         message_uuid = 'message_uuid'
diff --git a/tox.ini b/tox.ini
@@ -6,10 +6,10 @@
 [tox]
 envlist =
     py27
-    py33
     py34
     py35
     py36
+    py37
     pypy
 
 [testenv]

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`		`-__version__ = '4.1.0'`
	`2`	`+__version__ = '4.1.1'`