extract response model for sms send result

Author: in-void

Makefile

@@ -40,4 +40,4 @@ dist: clean
 
 
 release: dist
-	python -m twine upload dist/*
+	. venv/bin/activate; python -m twine upload dist/*

smsapi/endpoint.py

@@ -88,7 +88,7 @@ def send_request(self):
                 'timeout': self.parameters.get('timeout', 10)
             }
 
-            if self.method is 'GET':
+            if self.method == 'GET':
                 kwargs.update({'params': self.compiled_parameters})
             else:
                 kwargs.update({'data': self.compiled_parameters})

smsapi/sms/api.py

@@ -5,6 +5,7 @@
 from smsapi.exception import EndpointException, SendException
 from smsapi.models import ResultCollection, SendResult, RemoveMessageResult
 from smsapi.sms import response_format_param
+from smsapi.sms.model import SmsSendResult
 from smsapi.utils import join_params
 
 sms_parameters = [
@@ -60,7 +61,7 @@ class Sms(Api):
     send = bind_api_endpoint(
         method='POST',
         path=path,
-        mapping=(SendResult, ResultCollection),
+        mapping=(SendResult, SmsSendResult),
         accept_parameters=sms_parameters + ['to'],
         force_parameters=response_format_param,
         exception_class=SendException,
@@ -70,7 +71,7 @@ class Sms(Api):
     send_fast = bind_api_endpoint(
         method='GET',
         path=path,
-        mapping=(SendResult, ResultCollection),
+        mapping=(SendResult, SmsSendResult),
         accept_parameters=sms_parameters + ['to'],
         force_parameters=fast_force_params,
         exception_class=SendException,
@@ -80,7 +81,7 @@ class Sms(Api):
     send_flash = bind_api_endpoint(
         method='GET',
         path=path,
-        mapping=(SendResult, ResultCollection),
+        mapping=(SendResult, SmsSendResult),
         accept_parameters=sms_parameters + ['to'],
         force_parameters=flash_force_params,
         exception_class=SendException,
@@ -90,7 +91,7 @@ class Sms(Api):
     send_to_group = bind_api_endpoint(
         method='GET',
         path=path,
-        mapping=(SendResult, ResultCollection),
+        mapping=(SendResult, SmsSendResult),
         accept_parameters=sms_parameters + ['group'],
         force_parameters=response_format_param,
         exception_class=SendException,

smsapi/sms/model.py

@@ -0,0 +1,28 @@
+from smsapi.models import ResultCollection
+
+
+class SmsSendResult(ResultCollection):
+
+    def __init__(self, count, results, message=None, length=None, parts=None):
+        super(SmsSendResult, self).__init__(count, results)
+
+        self.message = message
+        self.parts = parts
+        self.length = length
+
+    @classmethod
+    def parse(cls, json_response, model):
+        count = json_response.get('count')
+        message = json_response.get('message')
+        length = json_response.get('length')
+        parts = json_response.get('parts')
+
+        sms_list = json_response.get('list', [])
+
+        collection = []
+
+        for sms in sms_list:
+            m = model.from_dict(sms)
+            collection.append(m)
+
+        return cls(count, collection, message=message, length=length, parts=parts)

tests/__init__.py

@@ -10,6 +10,7 @@
 from smsapi.client import SmsApiPlClient
 from smsapi.models import ResultCollection
 from smsapi.sms import response_format_param
+from smsapi.sms.model import SmsSendResult
 
 from tests.unit.doubles import ApiSpy, request_fake
 from tests.unit.fixtures import create_send_result
@@ -38,20 +39,22 @@ def assertParamsForwardedToRequestEquals(self, params, *args):
 
         params.update(response_format_param)
 
-        if self.request_fake.http_method is 'GET':
-            data_sent = self.request_fake.params
-        else:
-            data_sent = self.request_fake.data
+        self.assertEqual(params, self.request_fake.payload)
 
-        self.assertEqual(params, data_sent)
+    def assertRequestPayloadContains(self, key, value):
+        self.assertIn(key, self.request_fake.payload.keys())
+        self.assertIn(value, self.request_fake.payload.values())
 
-    def assertSendResultForNumberEquals(self, number, result):
+    def assertSendResultForNumberEquals(self, number, result, result_class=ResultCollection):
         numbers = number if isinstance(number, list) else [number]
 
-        expected_result = ResultCollection(len(numbers), [create_send_result(n) for n in numbers])
+        expected_result = result_class(len(numbers), [create_send_result(n) for n in numbers])
 
         self.assertEqual(expected_result, result)
 
+    def assertSmsSendResultForNumberEquals(self, number, result):
+        self.assertSendResultForNumberEquals(number, result, result_class=SmsSendResult)
+
 
 def spy_endpoints(client):
 

tests/unit/doubles.py

@@ -41,6 +41,10 @@ def __call__(self, *args, **kwargs):
 
         return ResponseMock(status_code, content, headers)
 
+    @property
+    def payload(self):
+        return self.params if self.http_method == 'GET' else self.data
+
 
 class ResponseMock(object):
 

tests/unit/sms/api_test.py

@@ -20,7 +20,7 @@ def test_send_sms(self):
 
         result = self.client.sms.send(**kwargs)
 
-        self.assertSendResultForNumberEquals(number, result)
+        self.assertSmsSendResultForNumberEquals(number, result)
         self.assertParamsForwardedToRequestEquals(kwargs)
 
     @api_response_fixture('send')
@@ -30,7 +30,7 @@ def test_send_sms_with_custom_sender(self):
 
         result = self.client.sms.send(to=number, from_=any_sender_name)
 
-        self.assertSendResultForNumberEquals(number, result)
+        self.assertSmsSendResultForNumberEquals(number, result)
         self.assertParamsForwardedToRequestEquals({'to': number, 'from': any_sender_name})
 
     @api_response_fixture('send_to_many_recipients')
@@ -39,7 +39,7 @@ def test_send_sms_to_many_numbers(self):
 
         result = self.client.sms.send(to=[number_1, number_2])
 
-        self.assertSendResultForNumberEquals([number_1, number_2], result)
+        self.assertSmsSendResultForNumberEquals([number_1, number_2], result)
         self.assertParamsForwardedToRequestEquals({'to': '%s,%s' % (number_1, number_2)})
 
     @api_response_fixture('send_to_invalid_number')
@@ -63,7 +63,7 @@ def test_send_fast(self):
 
         result = self.client.sms.send_fast(**args)
 
-        self.assertSendResultForNumberEquals(number, result)
+        self.assertSmsSendResultForNumberEquals(number, result)
         self.assertParamsForwardedToRequestEquals(args, fast_force_params)
 
     def test_send_flash(self):
@@ -72,7 +72,7 @@ def test_send_flash(self):
 
         result = self.client.sms.send_flash(**args)
 
-        self.assertSendResultForNumberEquals(number, result)
+        self.assertSmsSendResultForNumberEquals(number, result)
         self.assertParamsForwardedToRequestEquals(args, flash_force_params)
 
     def test_remove_scheduled_sms(self):
@@ -127,7 +127,7 @@ def test_send_sms_as_utf8(self):
 
         result = self.client.sms.send(**args)
 
-        self.assertSendResultForNumberEquals(number, result)
+        self.assertSmsSendResultForNumberEquals(number, result)
         self.assertParamsForwardedToRequestEquals(args)
 
     def test_send_test_sms(self):
@@ -138,6 +138,15 @@ def test_send_test_sms(self):
 
         self.assertParamsForwardedToRequestEquals(args)
 
+    @api_response_fixture('detailed_response')
+    def test_send_sms_with_detailed_response(self):
+        result = self.client.sms.send(details=1)
+
+        self.assertEqual(4, result.length)
+        self.assertEqual(1, result.parts)
+        self.assertEqual("test", result.message)
+        self.assertRequestPayloadContains("details", "1")
+
 
 def create_sms_exception_for_number(number):
     e = SendException(u'No correct phone numbers', 13)

tests/unit/sms/fixtures/detailed_response.json

@@ -0,0 +1,14 @@
+{
+    "status_code": 201,
+    "response": {
+      "count": 1,
+      "message": "test",
+      "length": 4,
+      "parts": 1,
+      "list": [
+        {
+          "id": "1"
+        }
+      ]
+    }
+}