Merge pull request #40 from victormb84/GROW-1082-add-view-call-method

added view call method, test and example

Author: dysosmus

examples/call.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+
+import sys, os 
+sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
+
+import messagebird
+
+#ACCESS_KEY = ''
+#CALL_ID = ''
+
+try:
+  ACCESS_KEY
+except NameError:
+  print('You need to set an ACCESS_KEY constant in this file')
+  sys.exit(1)
+
+try:
+  CALL_ID
+except NameError:
+  print('You need to set a CALL_ID constant in this file')
+  sys.exit(1)
+
+try:
+  # Create a MessageBird client with the specified ACCESS_KEY.
+  client = messagebird.Client(ACCESS_KEY)
+
+  # Fetch the Message object for the specified MESSAGE_ID.
+  call = client.call(CALL_ID)
+
+  # Print the object information.
+  print('\nThe following information was returned as a Message object:\n')
+  print('  id                : %s' % call.data.id)
+  print('  status            : %s' % call.data.status)
+  print('  source            : %s' % call.data.source)
+  print('  destination       : %s' % call.data.destination)
+  print('  createdAt         : %s' % call.data.createdAt)
+  print('  updatedAt         : %s' % call.data.updatedAt)
+  print('  endedAt           : %s' % call.data.endedAt)
+  
+except messagebird.client.ErrorException as e:
+  print('\nAn error occured while requesting a Message object:\n')
+
+  for error in e.errors:
+    print('  code        : %d' % error.code)
+    print('  description : %s' % error.description)
+    print('  parameter   : %s\n' % error.parameter)

messagebird/call.py

@@ -0,0 +1,21 @@
+from messagebird.base import Base
+from messagebird.call_data import CallData
+
+CALL_STATUS_STARTING = "starting"
+CALL_STATUS_ONGOING = "ongoing"
+CALL_STATUS_ENDED = "ended"
+
+
+class Call(Base):
+
+    def __init__(self):
+        self.id = None
+        self._data = None
+
+    @property
+    def data(self):
+        return self._data
+     
+    @data.setter
+    def data(self, value):
+        self._data = CallData().load(value[0])

messagebird/call_data.py

@@ -0,0 +1,47 @@
+from messagebird.base import Base
+from messagebird.webhook import Webhook
+
+class CallData(Base):
+    
+    def __init__(self):
+        self.id = None
+        self.status = None
+        self.source = None
+        self.destination = None
+        self._createdAt = None
+        self._updatedAt = None
+        self._endedAt = None
+        self._webhook = None
+
+
+    @property
+    def updatedAt(self):
+        return self._updatedAt
+     
+    @updatedAt.setter
+    def updatedAt(self, value):
+        self._updatedAt = self.value_to_time(value, '%Y-%m-%dT%H:%M:%SZ')
+
+    @property
+    def createdAt(self):
+        return self._createdAt
+     
+    @createdAt.setter
+    def createdAt(self, value):
+        self._createdAt = self.value_to_time(value, '%Y-%m-%dT%H:%M:%SZ')
+
+    @property
+    def endedAt(self):
+        return self._endedAt
+     
+    @endedAt.setter
+    def endedAt(self, value):
+        self._endedAt = self.value_to_time(value, '%Y-%m-%dT%H:%M:%SZ')
+
+    @property
+    def webhook(self):
+        return self._webhook
+
+    @webhook.setter
+    def webhook(self, value):
+        self._webhook = Webhook.load(value)

messagebird/client.py

@@ -3,6 +3,7 @@
 import io
 
 from messagebird.balance import Balance
+from messagebird.call import Call
 from messagebird.contact import Contact, ContactList
 from messagebird.error import Error
 from messagebird.group import Group, GroupList
@@ -31,6 +32,7 @@
 CONVERSATION_TYPE = 'conversation'
 
 VOICE_API_ROOT = 'https://voice.messagebird.com'
+VOICE_TYPE = 'voice'
 VOICE_PATH = 'calls'
 VOICE_LEGS_PATH = 'legs'
 VOICE_RECORDINGS_PATH = 'recordings'
@@ -55,6 +57,9 @@ def _get_http_client(self, type=REST_TYPE):
         if type == REST_TYPE:
             return HttpClient(ENDPOINT, self.access_key, USER_AGENT)
 
+        if type == VOICE_TYPE:
+            return HttpClient(VOICE_API_ROOT, self.access_key, USER_AGENT)
+
         return HttpClient(CONVERSATION_API_ROOT, self.access_key, USER_AGENT)
 
     def request(self, path, method='GET', params=None, type=REST_TYPE):
@@ -104,6 +109,10 @@ def balance(self):
         """Retrieve your balance."""
         return Balance().load(self.request('balance'))
 
+    def call(self,id):
+        """Retrieve the information of a specific call"""
+        return Call().load(self.request('calls/' + str(id), 'GET', None, VOICE_TYPE))
+
     def hlr(self, id):
         """Retrieve the information of a specific HLR lookup."""
         return HLR().load(self.request('hlr/' + str(id)))

messagebird/http_client.py

@@ -26,7 +26,6 @@ def request(self, path, method='GET', params=None, format=ResponseFormat.text):
         """Builds a request and gets a response."""
         if params is None: params = {}
         url = urljoin(self.endpoint, path)
-
         headers = {
             'Accept': 'application/json',
             'Authorization': 'AccessKey ' + self.access_key,

messagebird/webhook.py

@@ -0,0 +1,8 @@
+from messagebird.base import Base
+
+
+class Webhook(Base):
+
+    def __init__(self):
+        self.url = None
+        self.token = None

tests/test_call.py

@@ -0,0 +1,22 @@
+import unittest
+from messagebird import Client, ErrorException
+
+try:
+    from unittest.mock import Mock
+except ImportError:
+    # mock was added to unittest in Python 3.3, but was an external library
+    # before.
+    from mock import Mock
+
+
+class TestCall(unittest.TestCase):
+
+    def test_call(self):
+        http_client = Mock()
+        http_client.request.return_value = '{"data":[{"id":"call-id","status":"ended","source":"16479311111","destination":"1416555555","createdAt":"2019-08-06T13:17:06Z","updatedAt":"2019-08-06T13:17:39Z","endedAt":"2019-08-06T13:17:39Z"}],"_links":{"legs":"/calls/66bd9f08-a8af-40fe-a830-652d8dabc057/legs","self":"/calls/66bd9f08-a8af-40fe-a830-652d8bca357"},"pagination":{"totalCount":0,"pageCount":0,"currentPage":0,"perPage":0}}'
+
+        call = Client('', http_client).call('call-id')
+
+        http_client.request.assert_called_once_with('calls/call-id', 'GET', None)
+
+        self.assertEqual('ended', call.data.status)