Merge pull request #159 from Nexmo/cleanup-verify-class

client cleanup and adding verify class

Author: superdiana

src/nexmo/__init__.py

@@ -2,6 +2,7 @@
 from .errors import *
 from .voice import *
 from .sms import *
+from .verify import *
 from datetime import datetime
 import logging
 from platform import python_version
@@ -126,6 +127,9 @@ def __init__(
         self.application_v2 = ApplicationV2(api_server)
 
         self.session = requests.Session()
+
+        # Internal Verify Object - a method that return a verify instance, just for cool definitions
+        self.Verify = Verify(self)
 
     # Get and Set __host attribute
     def host(self, value=None):
@@ -148,20 +152,6 @@ def api_host(self, value=None):
     def auth(self, params=None, **kwargs):
         self.auth_params = params or kwargs
 
-    def send_message(self, params):
-        """
-        Send an SMS message.
-        Requires a client initialized with `key` and either `secret` or `signature_secret`.
-        ::
-            client.send_message({
-                "to": MY_CELLPHONE,
-                "from": MY_NEXMO_NUMBER,
-                "text": "Hello From Nexmo!",
-            })
-        :param dict params: A dict of values described at `Send an SMS <https://developer.nexmo.com/api/sms#send-an-sms>`_
-        """
-        return self.post(self.host(), "/sms/json", params, supports_signature_auth=True)
-
     def get_balance(self):
         return self.get(self.host(), "/account/get-balance")
 
@@ -226,24 +216,6 @@ def send_ussd_prompt_message(self, params=None, **kwargs):
     def send_2fa_message(self, params=None, **kwargs):
         return self.post(self.host(), "/sc/us/2fa/json", params or kwargs)
 
-    def submit_sms_conversion(self, message_id, delivered=True, timestamp=None):
-        """
-        Notify Nexmo that an SMS was successfully received.
-
-        :param message_id: The `message-id` str returned by the send_message call.
-        :param delivered: A `bool` indicating that the message was or was not successfully delivered.
-        :param timestamp: A `datetime` object containing the time the SMS arrived.
-        :return: The parsed response from the server. On success, the bytestring b'OK'
-        """
-        params = {
-            "message-id": message_id,
-            "delivered": delivered,
-            "timestamp": timestamp or datetime.now(pytz.utc),
-        }
-        # Ensure timestamp is a string:
-        _format_date_param(params, "timestamp")
-        return self.post(self.api_host(), "/conversions/sms", params)
-
     def send_event_alert_message(self, params=None, **kwargs):
         return self.post(self.host(), "/sc/us/alert/json", params or kwargs)
 
@@ -256,82 +228,6 @@ def get_event_alert_numbers(self):
     def resubscribe_event_alert_number(self, params=None, **kwargs):
         return self.post(self.host(), "/sc/us/alert/opt-in/manage/json", params or kwargs)
 
-    def initiate_call(self, params=None, **kwargs):
-        return self.post(self.host(), "/call/json", params or kwargs)
-
-    def initiate_tts_call(self, params=None, **kwargs):
-        return self.post(self.api_host(), "/tts/json", params or kwargs)
-
-    def initiate_tts_prompt_call(self, params=None, **kwargs):
-        return self.post(self.api_host(), "/tts-prompt/json", params or kwargs)
-
-    def start_verification(self, params=None, **kwargs):
-        return self.post(self.api_host(), "/verify/json", params or kwargs)
-
-    def send_verification_request(self, params=None, **kwargs):
-        warnings.warn(
-            "nexmo.Client#send_verification_request is deprecated (use #start_verification instead)",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        return self.post(self.api_host(), "/verify/json", params or kwargs)
-
-    def check_verification(self, request_id, params=None, **kwargs):
-        return self.post(
-            self.api_host(),
-            "/verify/check/json",
-            dict(params or kwargs, request_id=request_id),
-        )
-
-    def check_verification_request(self, params=None, **kwargs):
-        warnings.warn(
-            "nexmo.Client#check_verification_request is deprecated (use #check_verification instead)",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        return self.post(self.api_host(), "/verify/check/json", params or kwargs)
-
-    def get_verification(self, request_id):
-        return self.get(
-            self.api_host(), "/verify/search/json", {"request_id": request_id}
-        )
-
-    def get_verification_request(self, request_id):
-        warnings.warn(
-            "nexmo.Client#get_verification_request is deprecated (use #get_verification instead)",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        return self.get(
-            self.api_host(), "/verify/search/json", {"request_id": request_id}
-        )
-
-    def cancel_verification(self, request_id):
-        return self.post(
-            self.api_host(),
-            "/verify/control/json",
-            {"request_id": request_id, "cmd": "cancel"},
-        )
-
-    def trigger_next_verification_event(self, request_id):
-        return self.post(
-            self.api_host(),
-            "/verify/control/json",
-            {"request_id": request_id, "cmd": "trigger_next_event"},
-        )
-
-    def control_verification_request(self, params=None, **kwargs):
-        warnings.warn(
-            "nexmo.Client#control_verification_request is deprecated",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        return self.post(self.api_host(), "/verify/control/json", params or kwargs)
-
     def get_basic_number_insight(self, params=None, **kwargs):
         return self.get(self.api_host(), "/ni/basic/json", params or kwargs)
 
@@ -410,41 +306,6 @@ def delete_application(self, application_id):
             "/v1/applications/{application_id}".format(application_id=application_id),
         )
 
-    def create_call(self, params=None, **kwargs):
-        return self._jwt_signed_post("/v1/calls", params or kwargs)
-
-    def get_calls(self, params=None, **kwargs):
-        return self._jwt_signed_get("/v1/calls", params or kwargs)
-
-    def get_call(self, uuid):
-        return self._jwt_signed_get("/v1/calls/{uuid}".format(uuid=uuid))
-
-    def update_call(self, uuid, params=None, **kwargs):
-        return self._jwt_signed_put(
-            "/v1/calls/{uuid}".format(uuid=uuid), params or kwargs
-        )
-
-    def send_audio(self, uuid, params=None, **kwargs):
-        return self._jwt_signed_put(
-            "/v1/calls/{uuid}/stream".format(uuid=uuid), params or kwargs
-        )
-
-    def stop_audio(self, uuid):
-        return self._jwt_signed_delete("/v1/calls/{uuid}/stream".format(uuid=uuid))
-
-    def send_speech(self, uuid, params=None, **kwargs):
-        return self._jwt_signed_put(
-            "/v1/calls/{uuid}/talk".format(uuid=uuid), params or kwargs
-        )
-
-    def stop_speech(self, uuid):
-        return self._jwt_signed_delete("/v1/calls/{uuid}/talk".format(uuid=uuid))
-
-    def send_dtmf(self, uuid, params=None, **kwargs):
-        return self._jwt_signed_put(
-            "/v1/calls/{uuid}/dtmf".format(uuid=uuid), params or kwargs
-        )
-
     def get_recording(self, url):
         hostname = urlparse(url).hostname
         return self.parse(hostname, self.session.get(url, headers=self._headers()))
@@ -679,43 +540,6 @@ def parse(self, host, response):
             )
             raise ServerError(message)
 
-    def _jwt_signed_get(self, request_uri, params=None):
-        uri = "https://{api_host}{request_uri}".format(
-            api_host=self.api_host(), request_uri=request_uri
-        )
-
-        return self.parse(
-            self.api_host(),
-            self.session.get(uri, params=params or {}, headers=self._headers()),
-        )
-
-    def _jwt_signed_post(self, request_uri, params):
-        uri = "https://{api_host}{request_uri}".format(
-            api_host=self.api_host(), request_uri=request_uri
-        )
-
-        return self.parse(
-            self.api_host(), self.session.post(uri, json=params, headers=self._headers())
-        )
-
-    def _jwt_signed_put(self, request_uri, params):
-        uri = "https://{api_host}{request_uri}".format(
-            api_host=self.api_host(), request_uri=request_uri
-        )
-
-        return self.parse(
-            self.api_host(), self.session.put(uri, json=params, headers=self._headers())
-        )
-
-    def _jwt_signed_delete(self, request_uri):
-        uri = "https://{api_host}{request_uri}".format(
-            api_host=self.api_host(), request_uri=request_uri
-        )
-
-        return self.parse(
-            self.api_host(), self.session.delete(uri, headers=self._headers())
-        )
-
     def _headers(self):
         token = self.generate_application_jwt()
         return dict(self.headers, Authorization=b"Bearer " + token)

src/nexmo/verify.py

@@ -0,0 +1,51 @@
+import nexmo
+import warnings
+
+class Verify:
+    def __init__(
+        self,
+        client=None,
+        key=None,
+        secret=None
+    ):
+        try:
+            self._client = client
+            if self._client is None:
+                self._client = nexmo.Client(
+                    key=key,
+                    secret=secret
+                )
+        except Exception as e:
+            print('Error: {error_message}'.format(error_message=str(e)))
+    
+    def start_verification(self, params=None, **kwargs):
+        return self._client.post(self._client.api_host(), "/verify/json", params or kwargs)
+    
+    def check(self, request_id, params=None, **kwargs):
+        return self._client.post(
+            self._client.api_host(),
+            "/verify/check/json",
+            dict(params or kwargs, request_id=request_id),
+        )
+
+    def search(self, request_id):
+        return self._client.get(
+            self._client.api_host(), "/verify/search/json", {"request_id": request_id}
+        )
+    
+    def cancel(self, request_id):
+        return self._client.post(
+            self._client.api_host(),
+            "/verify/control/json",
+            {"request_id": request_id, "cmd": "cancel"},
+        )
+    
+    def trigger_next_event(self, request_id):
+        return self._client.post(
+            self._client.api_host(),
+            "/verify/control/json",
+            {"request_id": request_id, "cmd": "trigger_next_event"},
+        )
+    
+    def psd2(self, params=None, **kwargs):
+        return self._client.post(self._client.api_host(), "/verify/psd2/json", params or kwargs)

tests/conftest.py

@@ -63,4 +63,13 @@ def sms(client, dummy_data):
 
     return nexmo.Sms(
         client
+    )
+
+#Represents an instance of the Verify class for testing
+@pytest.fixture
+def verify(client, dummy_data):
+    import nexmo
+
+    return nexmo.Verify(
+        client
     )