Merge pull request #37 from MoceanAPI/add-token

koksianchong2 · web-flow · commit d40948fce971 · 2025-09-19T14:09:58.000+08:00
updated test case and added new checking
diff --git a/moceansdk/__init__.py b/moceansdk/__init__.py
@@ -20,7 +20,7 @@ def __init__(self, obj_auth, options=None):
         if obj_auth.get_auth_method().lower() == 'basic':
             if (not obj_auth.get_params()['mocean-api-key'] or not obj_auth.get_params()['mocean-api-secret']) and not obj_auth.get_params()['mocean-api-token']:
                 raise RequiredFieldException(
-                    "Api key or api secret and api token for client object can't be empty.")
+                    "Api key and api secret or api token for client object can't be empty.")
         else:
             raise MoceanErrorException("unsupported auth method")
 
diff --git a/moceansdk/modules/__init__.py b/moceansdk/modules/__init__.py
@@ -10,7 +10,7 @@ class AbstractClient(object):
     def __init__(self, obj_auth, transmitter):
         self._params = obj_auth.get_params()
         self._transmitter = transmitter
-        self._required_fields = ['mocean-api-key', 'mocean-api-secret']
+        self._required_fields = []
 
     def create(self, params):
         if isinstance(params, dict):
@@ -32,3 +32,17 @@ def is_required_field_set(self):
         for x in self._required_fields:
             if x not in self._params:
                 raise RequiredFieldException("%s is mandatory field" % x)
+                
+    def is_api_credentials_set(self):
+        if self._params['mocean-api-token'] == "":
+            has_api_key = 'mocean-api-key' in self._params
+            has_api_secret = 'mocean-api-secret' in self._params
+
+            if not has_api_key and not has_api_secret:
+                raise RequiredFieldException("Missing api token")
+
+            if not has_api_key:
+                raise RequiredFieldException("Missing api key")
+
+            if not has_api_secret:
+                raise RequiredFieldException("Missing api secret")
diff --git a/moceansdk/modules/account/balance.py b/moceansdk/modules/account/balance.py
@@ -5,7 +5,7 @@ class Balance(AbstractClient):
 
     def __init__(self, obj_auth, transmitter):
         super(Balance, self).__init__(obj_auth, transmitter)
-        self._required_fields = ['mocean-api-key', 'mocean-api-secret']
+        self._required_fields = []
 
     def set_resp_format(self, param):
         self._params['mocean-resp-format'] = param
@@ -17,6 +17,7 @@ def inquiry(self, params=None):
 
         super(Balance, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         return self._transmitter.get('/account/balance', self._params)
diff --git a/moceansdk/modules/account/pricing.py b/moceansdk/modules/account/pricing.py
@@ -5,7 +5,7 @@ class Pricing(AbstractClient):
 
     def __init__(self, obj_auth, transmitter):
         super(Pricing, self).__init__(obj_auth, transmitter)
-        self._required_fields = ['mocean-api-key', 'mocean-api-secret']
+        self._required_fields = []
 
     def set_mcc(self, param):
         self._params['mocean-mcc'] = param
@@ -29,6 +29,7 @@ def inquiry(self, params=None):
 
         super(Pricing, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         return self._transmitter.get('/account/pricing', self._params)
diff --git a/moceansdk/modules/command/command.py b/moceansdk/modules/command/command.py
@@ -10,8 +10,7 @@ class Command(AbstractClient):
     def __init__(self, obj_auth, transmitter):
         super(Command, self).__init__(obj_auth, transmitter)
         self.channel = channel.TELEGRAM
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-command']
+        self._required_fields = ['mocean-command']
 
     def set_event_url(self, event_url):
         self._params['mocean-event-url'] = event_url
@@ -44,7 +43,8 @@ def execute(self, params=None):
 
         super(Command, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.post('/send-message', self._params)
         return response
diff --git a/moceansdk/modules/message/message_status.py b/moceansdk/modules/message/message_status.py
@@ -5,8 +5,7 @@ class MessageStatus(AbstractClient):
 
     def __init__(self, obj_auth, transmitter):
         super(MessageStatus, self).__init__(obj_auth, transmitter)
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-msgid']
+        self._required_fields = ['mocean-msgid']
 
     def set_msgid(self, param):
         self._params['mocean-msgid'] = param
@@ -22,7 +21,8 @@ def inquiry(self, params=None):
 
         super(MessageStatus, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.get('/report/message', self._params)
         return response
diff --git a/moceansdk/modules/message/sms.py b/moceansdk/modules/message/sms.py
@@ -6,7 +6,7 @@ class Sms(AbstractClient):
     def __init__(self, obj_auth, transmitter):
         super(Sms, self).__init__(obj_auth, transmitter)
         self._required_fields = [
-            'mocean-api-key', 'mocean-api-secret', 'mocean-text', 'mocean-from', 'mocean-to']
+            'mocean-text', 'mocean-from', 'mocean-to']
 
     def set_from(self, param):
         self._params['mocean-from'] = param
@@ -80,7 +80,8 @@ def send(self, params=None):
 
         super(Sms, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.post('/sms', self._params)
         return response
diff --git a/moceansdk/modules/message/verify_request.py b/moceansdk/modules/message/verify_request.py
@@ -6,8 +6,7 @@ class VerifyRequest(AbstractClient):
 
     def __init__(self, obj_auth, transmitter):
         super(VerifyRequest, self).__init__(obj_auth, transmitter)
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-to', 'mocean-brand']
+        self._required_fields = ['mocean-to', 'mocean-brand']
         self._channel = Channel.AUTO
         self.__is_resend = False
 
@@ -53,7 +52,8 @@ def send(self, params=None):
 
         super(VerifyRequest, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         verify_request_url = "/verify"
         if self.__is_resend:
@@ -72,7 +72,6 @@ def send(self, params=None):
     def resend(self, params=None):
         self.send_as(Channel.SMS)
         self.__is_resend = True
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-reqid']
+        self._required_fields = ['mocean-reqid']
 
         return self.send(params)
diff --git a/moceansdk/modules/message/verify_validate.py b/moceansdk/modules/message/verify_validate.py
@@ -6,7 +6,7 @@ class VerifyValidate(AbstractClient):
     def __init__(self, obj_auth, transmitter):
         super(VerifyValidate, self).__init__(obj_auth, transmitter)
         self._required_fields = [
-            'mocean-api-key', 'mocean-api-secret', 'mocean-reqid', 'mocean-code']
+            'mocean-reqid', 'mocean-code']
 
     def set_reqid(self, param):
         self._params['mocean-reqid'] = param
@@ -26,7 +26,8 @@ def send(self, params=None):
 
         super(VerifyValidate, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.post('/verify/check', self._params)
         return response
diff --git a/moceansdk/modules/number_lookup/number_lookup.py b/moceansdk/modules/number_lookup/number_lookup.py
@@ -5,8 +5,7 @@ class NumberLookup(AbstractClient):
 
     def __init__(self, obj_auth, transmitter):
         super(NumberLookup, self).__init__(obj_auth, transmitter)
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-to']
+        self._required_fields = ['mocean-to']
 
     def set_to(self, param):
         self._params['mocean-to'] = param
@@ -26,7 +25,8 @@ def inquiry(self, params=None):
 
         super(NumberLookup, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.post('/nl', self._params)
         return response
diff --git a/moceansdk/modules/transmitter.py b/moceansdk/modules/transmitter.py
@@ -78,9 +78,18 @@ def format_response(self, response_text, uri=None, is_xml=False):
             .replace("</verify_check>", "")
         )
 
-        if 'status' in processed_response and processed_response['status'] != '0':
-            raise MoceanErrorException(
-                processed_response['err_msg'], processed_response.set_raw_response(raw_response))
+        if uri == '/sms':
+            if 'status' in processed_response.messages[0] and processed_response.messages[0]['status'] != '0':
+                raise MoceanErrorException(
+                    processed_response['err_msg'], processed_response.set_raw_response(raw_response))
+        elif uri == '/voice/dial':
+            if 'status' in processed_response.calls[0] and processed_response.calls[0]['status'] != '0':
+                raise MoceanErrorException(
+                    processed_response['err_msg'], processed_response.set_raw_response(raw_response))
+        else:
+            if 'status' in processed_response and processed_response['status'] != '0':
+                raise MoceanErrorException(
+                    processed_response['err_msg'], processed_response.set_raw_response(raw_response))
 
         # post process response
         if uri == '/account/pricing' and is_xml:
diff --git a/moceansdk/modules/voice/voice.py b/moceansdk/modules/voice/voice.py
@@ -10,8 +10,7 @@ class Voice(AbstractClient):
 
     def __init__(self, obj_auth, transmitter):
         super(Voice, self).__init__(obj_auth, transmitter)
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-to']
+        self._required_fields = ['mocean-to']
 
     def set_to(self, to):
         self._params['mocean-to'] = to
@@ -49,29 +48,30 @@ def call(self, params=None):
 
         super(Voice, self).create(params)
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.post('/voice/dial', self._params)
         return response
 
     def hangup(self, call_uuid):
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-call-uuid']
+        self._required_fields = ['mocean-call-uuid']
 
         super(Voice, self).create({'mocean-call-uuid': call_uuid})
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.post('/voice/hangup', self._params)
         return response
 
     def recording(self, call_uuid):
-        self._required_fields = ['mocean-api-key',
-                                 'mocean-api-secret', 'mocean-call-uuid']
+        self._required_fields = ['mocean-call-uuid']
 
         super(Voice, self).create({'mocean-call-uuid': call_uuid})
         self.create_final_params()
-        #self.is_required_field_set()
+        self.is_required_field_set()
+        self.is_api_credentials_set()
 
         response = self._transmitter.send('get', '/voice/rec', self._params)
 
diff --git a/tests/modules/command/test_command.py b/tests/modules/command/test_command.py
@@ -103,19 +103,19 @@ def request_callback(request, _context):
 
         self.assertTrue(m.called)
 
-    # @requests_mock.Mocker()
-    # def test_required_field_not_set(self, m):
-    #     def request_callback(_request, _context):
-    #         return self.get_response_string('comamnd.json')
-
-    #     client = TestingUtils.get_client_obj()
-    #     try:
-    #         client.command.execute()
-    #         self.fail()
-    #     except RequiredFieldException:
-    #         pass
-
-    #     self.assertFalse(m.called)
+    @requests_mock.Mocker()
+    def test_required_field_not_set(self, m):
+        def request_callback(_request, _context):
+            return self.get_response_string('comamnd.json')
+
+        client = TestingUtils.get_client_obj()
+        try:
+            client.command.execute()
+            self.fail()
+        except RequiredFieldException:
+            pass
+
+        self.assertFalse(m.called)
 
     def __test_object(self, command_response):
         self.assertIsInstance(command_response.toDict(), dict)
diff --git a/tests/modules/message/test_message_status.py b/tests/modules/message/test_message_status.py
@@ -53,21 +53,21 @@ def request_callback(_request, _context):
 
         self.assertTrue(m.called)
 
-    # @requests_mock.Mocker()
-    # def test_required_field_not_set(self, m):
-    #     def request_callback(_request, _context):
-    #         return self.get_response_string('message_status.json')
+    @requests_mock.Mocker()
+    def test_required_field_not_set(self, m):
+        def request_callback(_request, _context):
+            return self.get_response_string('message_status.json')
 
-    #     self.mock_http_request(m, '/report/message', request_callback)
+        self.mock_http_request(m, '/report/message', request_callback)
 
-    #     client = self.get_client_obj()
-    #     try:
-    #         client.message_status.inquiry()
-    #         self.fail()
-    #     except RequiredFieldException:
-    #         pass
+        client = self.get_client_obj()
+        try:
+            client.message_status.inquiry()
+            self.fail()
+        except RequiredFieldException:
+            pass
 
-    #     self.assertFalse(m.called)
+        self.assertFalse(m.called)
 
     def __test_object(self, message_status_response):
         self.assertIsInstance(message_status_response.toDict(), dict)
diff --git a/tests/modules/message/test_sms.py b/tests/modules/message/test_sms.py
@@ -145,21 +145,21 @@ def request_callback_v2(_request, _context):
 
         self.assertEqual(m.call_count, 2)
 
-    # @requests_mock.Mocker()
-    # def test_required_field_not_set(self, m):
-    #     def request_callback(_request, _context):
-    #         return self.get_response_string('message.json')
+    @requests_mock.Mocker()
+    def test_required_field_not_set(self, m):
+        def request_callback(_request, _context):
+            return self.get_response_string('message.json')
 
-    #     self.mock_http_request(m, '/sms', request_callback)
+        self.mock_http_request(m, '/sms', request_callback)
 
-    #     client = self.get_client_obj()
-    #     try:
-    #         client.sms.send()
-    #         self.fail()
-    #     except RequiredFieldException:
-    #         pass
+        client = self.get_client_obj()
+        try:
+            client.sms.send()
+            self.fail()
+        except RequiredFieldException:
+            pass
 
-    #     self.assertFalse(m.called)
+        self.assertFalse(m.called)
 
     def __test_object(self, sms_response):
         self.assertIsInstance(sms_response.toDict(), dict)
diff --git a/tests/modules/message/test_verify_request.py b/tests/modules/message/test_verify_request.py
diff --git a/tests/modules/message/test_verify_validate.py b/tests/modules/message/test_verify_validate.py
diff --git a/tests/modules/number_lookup/test_number_lookup.py b/tests/modules/number_lookup/test_number_lookup.py
diff --git a/tests/modules/voice/test_voice.py b/tests/modules/voice/test_voice.py
diff --git a/tests/test_client.py b/tests/test_client.py
diff --git a/tests/testing_utils.py b/tests/testing_utils.py
