Add some more clearly named methods for the Verify API

Author: timcraft

nexmo/__init__.py

@@ -112,15 +112,30 @@ 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)
 
+  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):
     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):
     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):
     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):
     return self.post(self.api_host, '/verify/control/json', params or kwargs)
 

test_nexmo.py

@@ -260,6 +260,15 @@ def test_initiate_tts_prompt_call(self):
     self.assertOK(self.client.initiate_tts_prompt_call(params))
     self.assertRequestBodyIncludes(params)
 
+  @responses.activate
+  def test_start_verification(self):
+    self.stub(responses.POST, 'https://api.nexmo.com/verify/json')
+
+    params = {'number': '447525856424', 'brand': 'MyApp'}
+
+    self.assertOK(self.client.start_verification(params))
+    self.assertRequestBodyIncludes(params)
+
   @responses.activate
   def test_send_verification_request(self):
     self.stub(responses.POST, 'https://api.nexmo.com/verify/json')
@@ -269,6 +278,13 @@ def test_send_verification_request(self):
     self.assertOK(self.client.send_verification_request(params))
     self.assertRequestBodyIncludes(params)
 
+  @responses.activate
+  def test_check_verification(self):
+    self.stub(responses.POST, 'https://api.nexmo.com/verify/check/json')
+
+    self.assertOK(self.client.check_verification('8g88g88eg8g8gg9g90', code='123445'))
+    self.assertRequestBodyIncludes({'code': '123445', 'request_id': '8g88g88eg8g8gg9g90'})
+
   @responses.activate
   def test_check_verification_request(self):
     self.stub(responses.POST, 'https://api.nexmo.com/verify/check/json')
@@ -278,13 +294,34 @@ def test_check_verification_request(self):
     self.assertOK(self.client.check_verification_request(params))
     self.assertRequestBodyIncludes(params)
 
+  @responses.activate
+  def test_get_verification(self):
+    self.stub(responses.GET, 'https://api.nexmo.com/verify/search/json')
+
+    self.assertOK(self.client.get_verification('xxx'))
+    self.assertRequestQueryIncludes('request_id=xxx')
+
   @responses.activate
   def test_get_verification_request(self):
     self.stub(responses.GET, 'https://api.nexmo.com/verify/search/json')
 
     self.assertOK(self.client.get_verification_request('xxx'))
     self.assertRequestQueryIncludes('request_id=xxx')
 
+  @responses.activate
+  def test_cancel_verification(self):
+    self.stub(responses.POST, 'https://api.nexmo.com/verify/control/json')
+
+    self.assertOK(self.client.cancel_verification('8g88g88eg8g8gg9g90'))
+    self.assertRequestBodyIncludes({'cmd': 'cancel', 'request_id': '8g88g88eg8g8gg9g90'})
+
+  @responses.activate
+  def test_trigger_next_verification_event(self):
+    self.stub(responses.POST, 'https://api.nexmo.com/verify/control/json')
+
+    self.assertOK(self.client.trigger_next_verification_event('8g88g88eg8g8gg9g90'))
+    self.assertRequestBodyIncludes({'cmd': 'trigger_next_event', 'request_id': '8g88g88eg8g8gg9g90'})
+
   @responses.activate
   def test_control_verification_request(self):
     self.stub(responses.POST, 'https://api.nexmo.com/verify/control/json')