additional namespace changes

Author: alphacentauri82

README.md

@@ -52,7 +52,7 @@ Then construct a client object with your key and secret:
 client = vonage.Client(key=api_key, secret=api_secret)
 ```
 
-For production, you can specify the `NEXMO_API_KEY` and `NEXMO_API_SECRET`
+For production, you can specify the `VONAGE_API_KEY` and `VONAGE_API_SECRET`
 environment variables instead of specifying the key and secret explicitly.
 
 For newer endpoints that support JWT authentication such as the Voice API,
@@ -63,7 +63,7 @@ client = vonage.Client(application_id=application_id, private_key=private_key)
 ```
 
 To check signatures for incoming webhook requests, you'll also need
-to specify the `signature_secret` argument (or the `NEXMO_SIGNATURE_SECRET`
+to specify the `signature_secret` argument (or the `VONAGE_SIGNATURE_SECRET`
 environment variable).
 
 ## SMS API
@@ -91,20 +91,20 @@ import vonage #then you can use vonage.Sms() to create an instance
 
 ```python
 #Option 1 - pass key and secret to the constructor
-sms = Sms(key=NEXMO_API_KEY, secret=NEXMO_API_SECRET)
+sms = Sms(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
 
 #Option 2 - Create a client instance and then pass the client to the Sms instance
-client = Client(key=NEXMO_API_KEY, secret=NEXMO_API_SECRET)
+client = Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
 sms = Sms(client)
 ```
 
 ### Send an SMS
 
 ```python
 from vonage import Sms
-sms = Sms(key=NEXMO_API_KEY, secret=NEXMO_API_SECRET)
+sms = Sms(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
 sms.send_message({
-            "from": NEXMO_BRAND_NAME,
+            "from": VONAGE_BRAND_NAME,
             "to": TO_NUMBER,
             "text": "A text message sent using the Vonage SMS API",
 })
@@ -114,7 +114,7 @@ sms.send_message({
 
 ```python
 sms.send_message({
-    'from': NEXMO_BRAND_NAME,
+    'from': VONAGE_BRAND_NAME,
     'to': TO_NUMBER,
     'text': 'こんにちは世界',
     'type': 'unicode',
@@ -125,10 +125,10 @@ sms.send_message({
 
 ```python
 from vonage import Client, Sms
-client = Client(key=NEXMO_API_KEY, secret=NEXMO_SECRET)
+client = Client(key=VONAGE_API_KEY, secret=VONAGE_SECRET)
 sms = Sms(client)
 response = sms.send_message({
-    'from': NEXMO_BRAND_NAME,
+    'from': VONAGE_BRAND_NAME,
     'to': TO_NUMBER,
     'text': 'Hi from Vonage'
 })
@@ -289,10 +289,10 @@ import vonage #then you can use vonage.Verify() to create an instance
 
 ```python
 #First way - pass key and secret to the constructor
-verify = Verify(key=NEXMO_API_KEY, secret=NEXMO_API_SECRET)
+verify = Verify(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
 ​
 #Second way - Create a client instance and then pass the client to the Verify contructor
-client = Client(key=NEXMO_API_KEY, secret=NEXMO_API_SECRET)
+client = Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
 verify = Verify(client)
 ```
 

docs/quickstart.rst

@@ -46,8 +46,8 @@ Then construct a client object with your key and secret:
 
     client = vonage.Client(key=api_key, secret=api_secret)
 
-For production, you can specify the ``NEXMO_API_KEY`` and
-``NEXMO_API_SECRET`` environment variables instead of specifying the key
+For production, you can specify the ``VONAGE_API_KEY`` and
+``VONAGE_API_SECRET`` environment variables instead of specifying the key
 and secret explicitly.
 
 For newer endpoints that support JWT authentication such as the Voice
@@ -60,7 +60,7 @@ arguments:
 
 In order to check signatures for incoming webhook requests, you'll also
 need to specify the ``signature_secret`` argument (or the
-``NEXMO_SIGNATURE_SECRET`` environment variable).
+``VONAGE_SIGNATURE_SECRET`` environment variable).
 
 If the argument ``signature_method`` is omitted, it will default to the md5 hash
 algorithm. Otherwise, it will use the selected method as in md5, sha1, sha256 or

src/vonage/__init__.py

@@ -77,16 +77,16 @@ def __init__(
         app_name=None,
         app_version=None,
     ):
-        self.api_key = key or os.environ.get("NEXMO_API_KEY", None)
+        self.api_key = key or os.environ.get("VONAGE_API_KEY", None)
 
-        self.api_secret = secret or os.environ.get("NEXMO_API_SECRET", None)
+        self.api_secret = secret or os.environ.get("VONAGE_API_SECRET", None)
 
         self.signature_secret = signature_secret or os.environ.get(
-            "NEXMO_SIGNATURE_SECRET", None
+            "VONAGE_SIGNATURE_SECRET", None
         )
 
         self.signature_method = signature_method or os.environ.get(
-            "NEXMO_SIGNATURE_METHOD", None
+            "VONAGE_SIGNATURE_METHOD", None
         )
 
         if self.signature_method in {"md5", "sha1", "sha256", "sha512"}:
@@ -99,8 +99,8 @@ def __init__(
         if isinstance(self.private_key, string_types) and "\n" not in self.private_key:
             with open(self.private_key, "rb") as key_file:
                 self.private_key = key_file.read()
-        
-        self.__host_pattern = '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)+([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$'
+
+        self.__host_pattern = "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)+([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$"
 
         self.__host = "rest.nexmo.com"
 
@@ -128,37 +128,39 @@ def __init__(
         self.application_v2 = ApplicationV2(api_server)
 
         self.session = requests.Session()
-    
+
     # Get and Set __host attribute
     def host(self, value=None):
         if value is None:
             return self.__host
-        elif not re.match(self.__host_pattern,value):
-            raise Exception('Error: Invalid format for host')
+        elif not re.match(self.__host_pattern, value):
+            raise Exception("Error: Invalid format for host")
         else:
             self.__host = value
-    
+
     # Gets And sets __api_host attribute
     def api_host(self, value=None):
         if value is None:
             return self.__api_host
-        elif not re.match(self.__host_pattern,value):
-            raise Exception('Error: Invalid format for api_host')
+        elif not re.match(self.__host_pattern, value):
+            raise Exception("Error: Invalid format for api_host")
         else:
             self.__api_host = value
 
     def auth(self, params=None, **kwargs):
         self.auth_params = params or kwargs
 
-    @deprecated(reason="vonage.Client#send_message is deprecated. Use Sms#send_message instead")
+    @deprecated(
+        reason="vonage.Client#send_message is deprecated. Use Sms#send_message instead"
+    )
     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,
+                "from": MY_VONAGE_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>`_
@@ -257,7 +259,9 @@ def get_event_alert_numbers(self):
         return self.get(self.host(), "/sc/us/alert/opt-in/query/json")
 
     def resubscribe_event_alert_number(self, params=None, **kwargs):
-        return self.post(self.host(), "/sc/us/alert/opt-in/manage/json", params or 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)
@@ -268,7 +272,9 @@ def initiate_tts_call(self, params=None, **kwargs):
     def initiate_tts_prompt_call(self, params=None, **kwargs):
         return self.post(self.api_host(), "/tts-prompt/json", params or kwargs)
 
-    @deprecated(reason="vonage.Client#start_verification is deprecated. Use Verify#start_verification instead")
+    @deprecated(
+        reason="vonage.Client#start_verification is deprecated. Use Verify#start_verification instead"
+    )
     def start_verification(self, params=None, **kwargs):
         return self.post(self.api_host(), "/verify/json", params or kwargs)
 
@@ -281,7 +287,9 @@ def send_verification_request(self, params=None, **kwargs):
 
         return self.post(self.api_host(), "/verify/json", params or kwargs)
 
-    @deprecated(reason="vonage.Client#check_verification is deprecated. Use Verify#check instead")
+    @deprecated(
+        reason="vonage.Client#check_verification is deprecated. Use Verify#check instead"
+    )
     def check_verification(self, request_id, params=None, **kwargs):
         return self.post(
             self.api_host(),
@@ -297,12 +305,16 @@ def check_verification_request(self, params=None, **kwargs):
         )
 
         return self.post(self.api_host(), "/verify/check/json", params or kwargs)
-    
-    @deprecated(reason="vonage.Client#start_psd2_verification_request is deprecated. Use Verify#psd2 instead")
+
+    @deprecated(
+        reason="vonage.Client#start_psd2_verification_request is deprecated. Use Verify#psd2 instead"
+    )
     def start_psd2_verification_request(self, params=None, **kwargs):
         return self.post(self.api_host(), "/verify/psd2/json", params or kwargs)
 
-    @deprecated(reason="vonage.Client#get_verification is deprecated. Use Verify#search instead")
+    @deprecated(
+        reason="vonage.Client#get_verification is deprecated. Use Verify#search instead"
+    )
     def get_verification(self, request_id):
         return self.get(
             self.api_host(), "/verify/search/json", {"request_id": request_id}
@@ -319,15 +331,19 @@ def get_verification_request(self, request_id):
             self.api_host(), "/verify/search/json", {"request_id": request_id}
         )
 
-    @deprecated(reason="vonage.Client#cancel_verification is deprecated. Use Verify#cancel instead")
+    @deprecated(
+        reason="vonage.Client#cancel_verification is deprecated. Use Verify#cancel instead"
+    )
     def cancel_verification(self, request_id):
         return self.post(
             self.api_host(),
             "/verify/control/json",
             {"request_id": request_id, "cmd": "cancel"},
         )
 
-    @deprecated(reason="vonage.Client#trigger_next_verification_event is deprecated. Use Verify#trigger_next_event instead")
+    @deprecated(
+        reason="vonage.Client#trigger_next_verification_event is deprecated. Use Verify#trigger_next_event instead"
+    )
     def trigger_next_verification_event(self, request_id):
         return self.post(
             self.api_host(),
@@ -362,9 +378,13 @@ def get_number_insight(self, params=None, **kwargs):
     def get_async_advanced_number_insight(self, params=None, **kwargs):
         argoparams = params or kwargs
         if "callback" in argoparams:
-            return self.get(self.api_host(), "/ni/advanced/async/json", params or kwargs)
+            return self.get(
+                self.api_host(), "/ni/advanced/async/json", params or kwargs
+            )
         else:
-            raise ClientError("Error: Callback needed for async advanced number insight")
+            raise ClientError(
+                "Error: Callback needed for async advanced number insight"
+            )
 
     def get_advanced_number_insight(self, params=None, **kwargs):
         return self.get(self.api_host(), "/ni/advanced/json", params or kwargs)
@@ -422,45 +442,63 @@ def delete_application(self, application_id):
             "/v1/applications/{application_id}".format(application_id=application_id),
         )
 
-    @deprecated(reason="vonage.Client#create_call is deprecated. Use Voice#create_call instead")
+    @deprecated(
+        reason="vonage.Client#create_call is deprecated. Use Voice#create_call instead"
+    )
     def create_call(self, params=None, **kwargs):
         return self._jwt_signed_post("/v1/calls", params or kwargs)
 
-    @deprecated(reason="vonage.Client#get_calls is deprecated. Use Voice#get_calls instead")
+    @deprecated(
+        reason="vonage.Client#get_calls is deprecated. Use Voice#get_calls instead"
+    )
     def get_calls(self, params=None, **kwargs):
         return self._jwt_signed_get("/v1/calls", params or kwargs)
 
-    @deprecated(reason="vonage.Client#get_call is deprecated. Use Voice#get_call instead")
+    @deprecated(
+        reason="vonage.Client#get_call is deprecated. Use Voice#get_call instead"
+    )
     def get_call(self, uuid):
         return self._jwt_signed_get("/v1/calls/{uuid}".format(uuid=uuid))
 
-    @deprecated(reason="vonage.Client#update_call is deprecated. Use Voice#update_call instead")
+    @deprecated(
+        reason="vonage.Client#update_call is deprecated. Use Voice#update_call instead"
+    )
     def update_call(self, uuid, params=None, **kwargs):
         return self._jwt_signed_put(
             "/v1/calls/{uuid}".format(uuid=uuid), params or kwargs
         )
 
-    @deprecated(reason="vonage.Client#send_audio is deprecated. Use Voice#send_audio instead")
+    @deprecated(
+        reason="vonage.Client#send_audio is deprecated. Use Voice#send_audio instead"
+    )
     def send_audio(self, uuid, params=None, **kwargs):
         return self._jwt_signed_put(
             "/v1/calls/{uuid}/stream".format(uuid=uuid), params or kwargs
         )
 
-    @deprecated(reason="vonage.Client#stop_audio is deprecated. Use Voice#stop_audio instead")
+    @deprecated(
+        reason="vonage.Client#stop_audio is deprecated. Use Voice#stop_audio instead"
+    )
     def stop_audio(self, uuid):
         return self._jwt_signed_delete("/v1/calls/{uuid}/stream".format(uuid=uuid))
 
-    @deprecated(reason="vonage.Client#send_speech is deprecated. Use Voice#send_speech instead")
+    @deprecated(
+        reason="vonage.Client#send_speech is deprecated. Use Voice#send_speech instead"
+    )
     def send_speech(self, uuid, params=None, **kwargs):
         return self._jwt_signed_put(
             "/v1/calls/{uuid}/talk".format(uuid=uuid), params or kwargs
         )
 
-    @deprecated(reason="vonage.Client#stop_speech is deprecated. Use Voice#stop_speech instead")
+    @deprecated(
+        reason="vonage.Client#stop_speech is deprecated. Use Voice#stop_speech instead"
+    )
     def stop_speech(self, uuid):
         return self._jwt_signed_delete("/v1/calls/{uuid}/talk".format(uuid=uuid))
 
-    @deprecated(reason="vonage.Client#send_dtmf is deprecated. Use Voice#send_dtmf instead")
+    @deprecated(
+        reason="vonage.Client#send_dtmf is deprecated. Use Voice#send_dtmf instead"
+    )
     def send_dtmf(self, uuid, params=None, **kwargs):
         return self._jwt_signed_put(
             "/v1/calls/{uuid}/dtmf".format(uuid=uuid), params or kwargs
@@ -716,7 +754,8 @@ def _jwt_signed_post(self, request_uri, params):
         )
 
         return self.parse(
-            self.api_host(), self.session.post(uri, json=params, headers=self._headers())
+            self.api_host(),
+            self.session.post(uri, json=params, headers=self._headers()),
         )
 
     def _jwt_signed_put(self, request_uri, params):