nexmo 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 706d683032b1928b5139d95e402e77497b0da9b2
-  data.tar.gz: f41681589bcc0a827b08fd521f80dbf2a52ee15c
+  metadata.gz: 49b51d133374ce76a15e6a597f0f9946651185b4
+  data.tar.gz: 94d0243ccf112419f3ebf62cb9c532d775de26ff
 SHA512:
-  metadata.gz: ec1f6d2a5d131f4174407276992e54b00ddc99c87081d277a67c798cc8b4e2ac737c1c5b248deee1d697357409d241a469a9ca9c6fbf8a7b2695ea94f6bca6ad
-  data.tar.gz: d057d84301e06e758b389724d3526cba8c34986118c40fbc4e14ea302bf15bf00542947941298f9361c1e205f146803a469ce59c6653fabf00ee32938a2919ef
+  metadata.gz: e3a0b6310e548f87fa93ab582cfe25ed4afdec5264ffeb3cee6988bbe14883112dcd8a31682dd45ee6470d17e9e7ca1ab83fe96b4b30a244e3a962ba3b9ac42c
+  data.tar.gz: a07ad566361244c9062a7e4b35fb825b468197f6a5b62c870297f252a584a7c5155cf88675474dfee2f58a6e6633c8ccf518360d5826dc581d65e2f7adc95264

data/README.md

@@ -1,20 +1,28 @@
 Nexmo Client Library for Ruby
 =============================
 
-[Installation](#installation) | [Usage](#usage) | [Examples](#examples) | [License](#license)
+[![Gem Version](https://badge.fury.io/rb/nexmo.svg)](https://badge.fury.io/rb/nexmo) [![Build Status](https://api.travis-ci.org/Nexmo/nexmo-ruby.svg?branch=master)](https://travis-ci.org/Nexmo/nexmo-ruby)
 
 This is the Ruby client library for Nexmo's API. To use it you'll
 need a Nexmo account. Sign up [for free at nexmo.com][signup].
 
+* [Installation](#installation)
+* [Usage](#usage)
+* [Examples](#examples)
+* [Coverage](#api-coverage)
+* [License](#license)
+
 
 Installation
 ------------
 
 To install the Ruby client library using Rubygems:
 
-    $ gem install nexmo
+    gem install nexmo
+
+Alternatively you can clone the repository:
 
-Alternatively you can clone the repo or download the source.
+    git clone git@github.com:Nexmo/nexmo-ruby.git
 
 
 Usage
@@ -27,7 +35,7 @@ For example:
 ```ruby
 require 'nexmo'
 
-nexmo = Nexmo::Client.new
+client = Nexmo::Client.new
 ```
 
 Alternatively you can specify your credentials directly using the `key`
@@ -36,39 +44,148 @@ and `secret` options:
 ```ruby
 require 'nexmo'
 
-nexmo = Nexmo::Client.new(key: 'YOUR-API-KEY', secret: 'YOUR-API-SECRET')
+client = Nexmo::Client.new(key: 'YOUR-API-KEY', secret: 'YOUR-API-SECRET')
 ```
 
 
 Examples
 --------
 
-### Sending A Message
+### Sending a message
+
+To use [Nexmo's SMS API][doc_sms] to send an SMS message, call the Nexmo::Client#send_message
+method with a hash containing the API parameters. For example:
+
+```ruby
+response = client.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
+
+response = response['messages'].first
+
+if response['status'] == '0'
+  puts "Sent message #{response['message-id']}"
+
+  puts "Remaining balance is #{response['remaining-balance']}"
+else
+  puts "Error: #{response['error-text']}"
+end
+```
 
-Use [Nexmo's SMS API][doc_sms] to send an SMS message. 
+### Fetching a message
 
-Call the send_message method with a hash containing the message parameters. For example:
+You can retrieve a message log from the API using the ID of the message:
 
 ```ruby
-require 'nexmo'
+message = client.get_message('02000000DA7C52E7')
+
+puts "The body of the message was: #{message['body']}"
+```
+
+### Starting a verification
+
+Nexmo's [Verify API][doc_verify] makes it easy to prove that a user has provided their
+own phone number during signup, or implement second factor authentication during signin.
 
-nexmo = Nexmo::Client.new(key: 'YOUR API KEY', secret: 'YOUR API SECRET')
+You can start the verification process by calling the start_verification method:
 
-response = nexmo.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
+```ruby
+response = client.start_verification(number: '441632960960', brand: 'MyApp')
 
-if response['messages'][0]['status'].zero?
-  # success!
+if response['status'] == '0'
+  puts "Started verification request_id=#{response['request_id']}"
 else
-  # error response
+  puts "Error: #{response['error_text']}"
 end
 ```
 
+The response contains a verification request id which you will need to
+store temporarily (in the session, database, url etc).
+
+### Controlling a verification
+
+Call the cancel_verification method with the verification request id
+to cancel an in-progress verification:
+
+```ruby
+client.cancel_verification('00e6c3377e5348cdaf567e1417c707a5')
+```
+
+Call the trigger_next_verification_event method with the verification
+request id to trigger the next attempt to send the confirmation code:
+
+```ruby
+client.trigger_next_verification_event('00e6c3377e5348cdaf567e1417c707a5')
+```
+
+The verification request id comes from the call to the start_verification method.
+
+### Checking a verification
+
+Call the check_verification method with the verification request id and the
+PIN code to complete the verification process:
+
+```ruby
+response = client.check_verification('00e6c3377e5348cdaf567e1417c707a5', code: '1234')
+
+if response['status'] == '0'
+  puts "Verification complete, event_id=#{response['event_id']}"
+else
+  puts "Error: #{response['error_text']}"
+end
+```
+
+The verification request id comes from the call to the start_verification method.
+The PIN code is entered into your application by the user.
+
+
+API Coverage
+------------
+
+* Account
+    * [X] Balance
+    * [X] Pricing
+    * [X] Settings
+    * [X] Top Up
+    * [X] Numbers
+        * [X] Search
+        * [X] Buy
+        * [X] Cancel
+        * [X] Update
+* Number Insight
+    * [X] Basic
+    * [X] Standard
+    * [X] Advanced
+    * [ ] Webhook Notification
+* Verify
+    * [X] Verify
+    * [X] Check
+    * [X] Search
+    * [X] Control
+* Messaging 
+    * [X] Send
+    * [ ] Delivery Receipt
+    * [ ] Inbound Messages
+    * [X] Search
+        * [X] Message
+        * [X] Messages
+        * [X] Rejections
+    * [X] US Short Codes
+        * [X] Two-Factor Authentication
+        * [X] Event Based Alerts
+            * [X] Sending Alerts
+            * [X] Campaign Subscription Management
+* Voice
+    * [X] Outbound Calls
+    * [ ] Inbound Call
+    * [X] Text-To-Speech Call
+    * [X] Text-To-Speech Prompt
+
 
 License
 -------
 
 This library is released under the [MIT License][license]
 
-[signup]: http://nexmo.com?src=ruby-client-library
-[doc_sms]: https://docs.nexmo.com/messaging/sms-api
+[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library
+[doc_sms]: https://docs.nexmo.com/messaging/sms-api?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library
+[doc_verify]: https://docs.nexmo.com/verify/api-reference?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library
 [license]: LICENSE.txt

data/lib/nexmo.rb

@@ -26,143 +26,179 @@ module Nexmo
     end
 
     def send_message(params)
-      post("https://#@host/sms/json", params)
+      post(@host, '/sms/json', params)
     end
 
     def get_balance
-      get("https://#@host/account/get-balance")
+      get(@host, '/account/get-balance')
     end
 
     def get_country_pricing(country_code)
-      get("https://#@host/account/get-pricing/outbound", country: country_code)
+      get(@host, '/account/get-pricing/outbound', country: country_code)
     end
 
     def get_prefix_pricing(prefix)
-      get("https://#@host/account/get-prefix-pricing/outbound", prefix: prefix)
+      get(@host, '/account/get-prefix-pricing/outbound', prefix: prefix)
+    end
+
+    def get_sms_pricing(number)
+      get(@host, '/account/get-phone-pricing/outbound/sms', phone: number)
+    end
+
+    def get_voice_pricing(number)
+      get(@host, '/account/get-phone-pricing/outbound/voice', phone: number)
     end
 
     def update_settings(params)
-      post("https://#@host/account/settings", params)
+      post(@host, '/account/settings', params)
     end
 
     def topup(params)
-      post("https://#@host/account/top-up", params)
+      post(@host, '/account/top-up', params)
     end
 
     def get_account_numbers(params)
-      get("https://#@host/account/numbers", params)
+      get(@host, '/account/numbers', params)
     end
 
     def get_available_numbers(country_code, params = {})
-      get("https://#@host/number/search", {country: country_code}.merge(params))
+      get(@host, '/number/search', {country: country_code}.merge(params))
     end
 
     def buy_number(params)
-      post("https://#@host/number/buy", params)
+      post(@host, '/number/buy', params)
     end
 
     def cancel_number(params)
-      post("https://#@host/number/cancel", params)
+      post(@host, '/number/cancel', params)
     end
 
     def update_number(params)
-      post("https://#@host/number/update", params)
+      post(@host, '/number/update', params)
     end
 
     def get_message(id)
-      get("https://#@host/search/message", id: id)
+      get(@host, '/search/message', id: id)
     end
 
     def get_message_rejections(params)
-      get("https://#@host/search/rejections", params)
+      get(@host, '/search/rejections', params)
     end
 
     def search_messages(params)
-      get("https://#@host/search/messages", Hash === params ? params : {ids: Array(params)})
+      get(@host, '/search/messages', Hash === params ? params : {ids: Array(params)})
     end
 
     def send_ussd_push_message(params)
-      post("https://#@host/ussd/json", params)
+      post(@host, '/ussd/json', params)
     end
 
     def send_ussd_prompt_message(params)
-      post("https://#@host/ussd-prompt/json", params)
+      post(@host, '/ussd-prompt/json', params)
     end
 
     def send_2fa_message(params)
-      post("https://#@host/sc/us/2fa/json", params)
+      post(@host, '/sc/us/2fa/json', params)
     end
 
     def send_event_alert_message(params)
-      post("https://#@host/sc/us/alert/json", params)
+      post(@host, '/sc/us/alert/json', params)
     end
 
     def send_marketing_message(params)
-      post("https://#@host/sc/us/marketing/json", params)
+      post(@host, '/sc/us/marketing/json', params)
+    end
+
+    def get_event_alert_numbers
+      get(@host, '/sc/us/alert/opt-in/query/json')
+    end
+
+    def resubscribe_event_alert_number(params)
+      post(@host, '/sc/us/alert/opt-in/manage/json', params)
     end
 
     def initiate_call(params)
-      post("https://#@host/call/json", params)
+      post(@host, '/call/json', params)
     end
 
     def initiate_tts_call(params)
-      post("https://#@api_host/tts/json", params)
+      post(@api_host, '/tts/json', params)
     end
 
     def initiate_tts_prompt_call(params)
-      post("https://#@api_host/tts-prompt/json", params)
+      post(@api_host, '/tts-prompt/json', params)
+    end
+
+    def start_verification(params)
+      post(@api_host, '/verify/json', params)
     end
 
     def send_verification_request(params)
-      post("https://#@api_host/verify/json", params)
+      post(@api_host, '/verify/json', params)
+    end
+
+    def check_verification(request_id, params)
+      post(@api_host, '/verify/check/json', params.merge(request_id: request_id))
     end
 
     def check_verification_request(params)
-      post("https://#@api_host/verify/check/json", params)
+      post(@api_host, '/verify/check/json', params)
+    end
+
+    def get_verification(request_id)
+      get(@api_host, '/verify/search/json', request_id: request_id)
     end
 
     def get_verification_request(id)
-      get("https://#@api_host/verify/search/json", request_id: id)
+      get(@api_host, '/verify/search/json', request_id: id)
+    end
+
+    def cancel_verification(request_id)
+      post(@api_host, '/verify/control/json', request_id: request_id, cmd: 'cancel')
+    end
+
+    def trigger_next_verification_event(request_id)
+      post(@api_host, '/verify/control/json', request_id: request_id, cmd: 'trigger_next_event')
     end
 
     def control_verification_request(params)
-      post("https://#@api_host/verify/control/json", params)
+      post(@api_host, '/verify/control/json', params)
     end
 
     def get_basic_number_insight(params)
-      get("https://#@api_host/number/format/json", params)
+      get(@api_host, '/number/format/json', params)
     end
 
     def get_number_insight(params)
-      get("https://#@api_host/number/lookup/json", params)
+      get(@api_host, '/number/lookup/json', params)
     end
 
     def request_number_insight(params)
-      post("https://#@host/ni/json", params)
+      post(@host, '/ni/json', params)
     end
 
     private
 
     USER_AGENT = "ruby-nexmo/#{VERSION}/#{RUBY_VERSION}"
 
-    def get(uri, params = {})
-      uri = URI(uri)
+    def get(host, request_uri, params = {})
+      uri = URI('https://' + host + request_uri)
       uri.query = query_string(params.merge(api_key: @key, api_secret: @secret))
 
       message = Net::HTTP::Get.new(uri.request_uri)
       message['User-Agent'] = USER_AGENT
 
-      parse(request(uri, message), uri.host)
+      parse(request(uri, message), host)
     end
 
-    def post(uri, params)
-      uri = URI(uri)
+    def post(host, request_uri, params)
+      uri = URI('https://' + host + request_uri)
 
       message = Net::HTTP::Post.new(uri.request_uri)
       message.form_data = params.merge(api_key: @key, api_secret: @secret)
       message['User-Agent'] = USER_AGENT
 
-      parse(request(uri, message), uri.host)
+      parse(request(uri, message), host)
     end
 
     def request(uri, message)

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end

data/spec/nexmo_spec.rb

@@ -3,299 +3,313 @@ require 'webmock/minitest'
 require 'nexmo'
 
 describe 'Nexmo::Client' do
-  def json_response_body(content)
-    {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: content}
-  end
-
   before do
+    @api_key = 'api_key_xxx'
+
+    @api_secret = 'api_secret_xxx'
+
     @base_url = 'https://rest.nexmo.com'
 
     @api_base_url = 'https://api.nexmo.com'
 
-    @form_urlencoded_data = {body: /(.+?)=(.+?)(&(.+?)=(.+?))+/, headers: {'Content-Type' => 'application/x-www-form-urlencoded'}}
-
-    @json_response_body = json_response_body('{"key":"value"}')
+    @response_body = {body: '{"key":"value"}', headers: {'Content-Type' => 'application/json;charset=utf-8'}}
 
-    @json_response_object = {'key' => 'value'}
+    @response_object = {'key' => 'value'}
 
     @example_message_hash = {from: 'ruby', to: 'number', text: 'Hey!'}
 
-    @client = Nexmo::Client.new(key: 'key', secret: 'secret')
+    @client = Nexmo::Client.new(key: @api_key, secret: @api_secret)
   end
 
   describe 'send_message method' do
-    it 'posts to the sms json resource and returns the response message object' do
-      response_body = json_response_body('{"messages":[{"status":0,"message-id":"id"}]}')
-
-      stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(response_body)
+    it 'posts to the sms resource and returns the response object' do
+      expect_post "#@base_url/sms/json", "from=ruby&to=number&text=Hey!&api_key=#@api_key&api_secret=#@api_secret"
 
-      @client.send_message(@example_message_hash).must_equal({'messages' => [{'status' => 0, 'message-id' => 'id'}]})
+      @client.send_message(@example_message_hash).must_equal(@response_object)
     end
   end
 
   describe 'get_balance method' do
     it 'fetches the account balance resource and returns the response object' do
-      url = "#@base_url/account/get-balance?api_key=key&api_secret=secret"
+      expect_get "#@base_url/account/get-balance?api_key=#@api_key&api_secret=#@api_secret"
 
-      stub_request(:get, url).to_return(@json_response_body)
-
-      @client.get_balance.must_equal(@json_response_object)
+      @client.get_balance.must_equal(@response_object)
     end
   end
 
   describe 'get_country_pricing method' do
     it 'fetches the outbound pricing resource for the given country and returns the response object' do
-      url = "#@base_url/account/get-pricing/outbound?api_key=key&api_secret=secret&country=CA"
-
-      stub_request(:get, url).to_return(@json_response_body)
+      expect_get "#@base_url/account/get-pricing/outbound?api_key=#@api_key&api_secret=#@api_secret&country=CA"
 
-      @client.get_country_pricing(:CA).must_equal(@json_response_object)
+      @client.get_country_pricing(:CA).must_equal(@response_object)
     end
   end
 
   describe 'get_prefix_pricing method' do
     it 'fetches the outbound pricing resource for the given prefix and returns the response object' do
-      url = "#@base_url/account/get-prefix-pricing/outbound?api_key=key&api_secret=secret&prefix=44"
+      expect_get "#@base_url/account/get-prefix-pricing/outbound?api_key=#@api_key&api_secret=#@api_secret&prefix=44"
+
+      @client.get_prefix_pricing(44).must_equal(@response_object)
+    end
+  end
 
-      stub_request(:get, url).to_return(@json_response_body)
+  describe 'get_sms_pricing method' do
+    it 'fetches the outbound sms pricing resource for the given phone number and returns the response object' do
+      expect_get "#@base_url/account/get-phone-pricing/outbound/sms?api_key=#@api_key&api_secret=#@api_secret&phone=447525856424"
 
-      @client.get_prefix_pricing(44).must_equal(@json_response_object)
+      @client.get_sms_pricing('447525856424').must_equal(@response_object)
+    end
+  end
+
+  describe 'get_voice_pricing method' do
+    it 'fetches the outbound voice pricing resource for the given phone number and returns the response object' do
+      expect_get "#@base_url/account/get-phone-pricing/outbound/voice?api_key=#@api_key&api_secret=#@api_secret&phone=447525856424"
+
+      @client.get_voice_pricing('447525856424').must_equal(@response_object)
     end
   end
 
   describe 'update_settings method' do
     it 'updates the account settings resource with the given parameters and returns the response object' do
-      url = "#@base_url/account/settings"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+      expect_post "#@base_url/account/settings", "api_key=#@api_key&api_secret=#@api_secret&moCallBackUrl=http://example.com/callback"
 
-      @client.update_settings(moCallBackUrl: 'http://example.com/callback').must_equal(@json_response_object)
+      @client.update_settings(moCallBackUrl: 'http://example.com/callback').must_equal(@response_object)
     end
   end
 
   describe 'topup method' do
     it 'updates the account top-up resource with the given parameters and returns the response object' do
-      url = "#@base_url/account/top-up"
+      expect_post "#@base_url/account/top-up", "api_key=#@api_key&api_secret=#@api_secret&trx=00X123456Y7890123Z"
 
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
-
-      @client.topup(trx: '00X123456Y7890123Z').must_equal(@json_response_object)
+      @client.topup(trx: '00X123456Y7890123Z').must_equal(@response_object)
     end
   end
 
   describe 'get_account_numbers method' do
     it 'fetches the account numbers resource with the given parameters and returns the response object' do
-      url = "#@base_url/account/numbers?api_key=key&api_secret=secret&size=25&pattern=33"
-
-      stub_request(:get, url).to_return(@json_response_body)
+      expect_get "#@base_url/account/numbers?api_key=#@api_key&api_secret=#@api_secret&size=25&pattern=33"
 
-      @client.get_account_numbers(size: 25, pattern: 33).must_equal(@json_response_object)
+      @client.get_account_numbers(size: 25, pattern: 33).must_equal(@response_object)
     end
   end
 
   describe 'buy_number method' do
     it 'purchases the number requested with the given parameters and returns the response object' do
-      url = "#@base_url/number/buy"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+      expect_post "#@base_url/number/buy", "api_key=#@api_key&api_secret=#@api_secret&country=US&msisdn=number"
 
-      @client.buy_number(country: 'US', msisdn: 'number').must_equal(@json_response_object)
+      @client.buy_number(country: 'US', msisdn: 'number').must_equal(@response_object)
     end
   end
 
   describe 'cancel_number method' do
     it 'cancels the number requested with the given parameters and returns the response object' do
-      url = "#@base_url/number/cancel"
+      expect_post "#@base_url/number/cancel", "api_key=#@api_key&api_secret=#@api_secret&country=US&msisdn=number"
 
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
-
-      @client.cancel_number(country: 'US', msisdn: 'number').must_equal(@json_response_object)
+      @client.cancel_number(country: 'US', msisdn: 'number').must_equal(@response_object)
     end
   end
 
   describe 'update_number method' do
     it 'updates the number requested with the given parameters and returns the response object' do
-      url = "#@base_url/number/update"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+      expect_post "#@base_url/number/update", "api_key=#@api_key&api_secret=#@api_secret&country=US&msisdn=number&moHttpUrl=callback"
 
-      @client.update_number(country: 'US', msisdn: 'number', moHttpUrl: 'callback').must_equal(@json_response_object)
+      @client.update_number(country: 'US', msisdn: 'number', moHttpUrl: 'callback').must_equal(@response_object)
     end
   end
 
   describe 'get_message method' do
     it 'fetches the message search resource for the given message id and returns the response object' do
-      url = "#@base_url/search/message?api_key=key&api_secret=secret&id=00A0B0C0"
+      expect_get "#@base_url/search/message?api_key=#@api_key&api_secret=#@api_secret&id=00A0B0C0"
 
-      stub_request(:get, url).to_return(@json_response_body)
-
-      @client.get_message('00A0B0C0').must_equal(@json_response_object)
+      @client.get_message('00A0B0C0').must_equal(@response_object)
     end
   end
 
   describe 'get_message_rejections method' do
     it 'fetches the message rejections resource with the given parameters and returns the response object' do
-      url = "#@base_url/search/rejections?api_key=key&api_secret=secret&date=YYYY-MM-DD"
-
-      stub_request(:get, url).to_return(@json_response_body)
+      expect_get "#@base_url/search/rejections?api_key=#@api_key&api_secret=#@api_secret&date=YYYY-MM-DD"
 
-      @client.get_message_rejections(date: 'YYYY-MM-DD').must_equal(@json_response_object)
+      @client.get_message_rejections(date: 'YYYY-MM-DD').must_equal(@response_object)
     end
   end
 
   describe 'search_messages method' do
     it 'fetches the search messages resource with the given parameters and returns the response object' do
-      url = "#@base_url/search/messages?api_key=key&api_secret=secret&date=YYYY-MM-DD&to=1234567890"
-
-      stub_request(:get, url).to_return(@json_response_body)
+      expect_get "#@base_url/search/messages?api_key=#@api_key&api_secret=#@api_secret&date=YYYY-MM-DD&to=1234567890"
 
-      @client.search_messages(date: 'YYYY-MM-DD', to: 1234567890).must_equal(@json_response_object)
+      @client.search_messages(date: 'YYYY-MM-DD', to: 1234567890).must_equal(@response_object)
     end
 
     it 'should encode a non hash argument as a list of ids' do
-      url = "#@base_url/search/messages?api_key=key&api_secret=secret&ids=id1&ids=id2"
-
-      stub_request(:get, url).to_return(@json_response_body)
+      expect_get "#@base_url/search/messages?api_key=#@api_key&api_secret=#@api_secret&ids=id1&ids=id2"
 
       @client.search_messages(%w(id1 id2))
     end
   end
 
   describe 'send_ussd_push_message method' do
-    it 'posts to the ussd json resource and returns the response object' do
-      url = "#@base_url/ussd/json"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+    it 'posts to the ussd resource and returns the response object' do
+      expect_post "#@base_url/ussd/json", "api_key=#@api_key&api_secret=#@api_secret&from=MyCompany20&to=447525856424&text=Hello"
 
       @client.send_ussd_push_message(from: 'MyCompany20', to: '447525856424', text: 'Hello')
     end
   end
 
   describe 'send_ussd_prompt_message method' do
-    it 'posts to the ussd prompt json resource and returns the response object' do
-      url = "#@base_url/ussd-prompt/json"
+    it 'posts to the ussd prompt resource and returns the response object' do
+      expect_post "#@base_url/ussd-prompt/json", "api_key=#@api_key&api_secret=#@api_secret&from=virtual-number&to=447525856424&text=Hello"
 
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
-
-      @client.send_ussd_prompt_message(from: 'Nexmo long virtual number', to: '447525856424', text: 'Hello')
+      @client.send_ussd_prompt_message(from: 'virtual-number', to: '447525856424', text: 'Hello')
     end
   end
 
   describe 'send_2fa_message method' do
-    it 'posts to the short code two factor authentication json resource and returns the response object' do
-      url = "#@base_url/sc/us/2fa/json"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+    it 'posts to the short code two factor authentication resource and returns the response object' do
+      expect_post "#@base_url/sc/us/2fa/json", "api_key=#@api_key&api_secret=#@api_secret&to=16365553226&pin=1234"
 
       @client.send_2fa_message(to: '16365553226', pin: 1234)
     end
   end
 
   describe 'send_event_alert_message method' do
-    it 'posts to the short code alert json resource and returns the response object' do
-      url = "#@base_url/sc/us/alert/json"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+    it 'posts to the short code alert resource and returns the response object' do
+      expect_post "#@base_url/sc/us/alert/json", "api_key=#@api_key&api_secret=#@api_secret&to=16365553226&server=host&link=http://example.com/"
 
       @client.send_event_alert_message(to: '16365553226', server: 'host', link: 'http://example.com/')
     end
   end
 
   describe 'send_marketing_message method' do
-    it 'posts to the short code marketing json resource and returns the response object' do
-      url = "#@base_url/sc/us/marketing/json"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+    it 'posts to the short code marketing resource and returns the response object' do
+      expect_post "#@base_url/sc/us/marketing/json", "api_key=#@api_key&api_secret=#@api_secret&from=666&to=16365553226&keyword=NEXMO&text=Hello"
 
       @client.send_marketing_message(from: '666', to: '16365553226', keyword: 'NEXMO', text: 'Hello')
     end
   end
 
-  describe 'initiate_call method' do
-    it 'posts to the call json resource and returns the response object' do
-      url = "#@base_url/call/json"
+  describe 'get_event_alert_numbers method' do
+    it 'fetches the short code alert opt-in query resource and returns the response object' do
+      expect_get "#@base_url/sc/us/alert/opt-in/query/json?api_key=#@api_key&api_secret=#@api_secret"
 
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+      @client.get_event_alert_numbers
+    end
+  end
+
+  describe 'resubscribe_event_alert_number method' do
+    it 'posts to the short code alert opt-in manage resource and returns the response object' do
+      expect_post "#@base_url/sc/us/alert/opt-in/manage/json", "api_key=#@api_key&api_secret=#@api_secret&msisdn=441632960960"
+
+      @client.resubscribe_event_alert_number(msisdn: '441632960960')
+    end
+  end
+
+  describe 'initiate_call method' do
+    it 'posts to the call resource and returns the response object' do
+      expect_post "#@base_url/call/json", "api_key=#@api_key&api_secret=#@api_secret&to=16365553226&answer_url=http://example.com/answer"
 
       @client.initiate_call(to: '16365553226', answer_url: 'http://example.com/answer')
     end
   end
 
   describe 'initiate_tts_call method' do
-    it 'posts to the tts json resource and returns the response object' do
-      url = "#@api_base_url/tts/json"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+    it 'posts to the tts resource and returns the response object' do
+      expect_post "#@api_base_url/tts/json", "api_key=#@api_key&api_secret=#@api_secret&to=16365553226&text=Hello"
 
       @client.initiate_tts_call(to: '16365553226', text: 'Hello')
     end
   end
 
   describe 'initiate_tts_prompt_call method' do
-    it 'posts to the tts prompt json resource and returns the response object' do
-      url = "#@api_base_url/tts-prompt/json"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+    it 'posts to the tts prompt resource and returns the response object' do
+      expect_post "#@api_base_url/tts-prompt/json", "api_key=#@api_key&api_secret=#@api_secret&to=16365553226&text=Hello&max_digits=4&bye_text=Goodbye"
 
       @client.initiate_tts_prompt_call(to: '16365553226', text: 'Hello', max_digits: 4, bye_text: 'Goodbye')
     end
   end
 
-  describe 'send_verification_request method' do
+  describe 'start_verification method' do
     it 'posts to the verify json resource and returns the response object' do
-      url = "#@api_base_url/verify/json"
+      expect_post "#@api_base_url/verify/json", "api_key=#@api_key&api_secret=#@api_secret&number=447525856424&brand=MyApp"
 
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+      @client.start_verification(number: '447525856424', brand: 'MyApp')
+    end
+  end
+
+  describe 'send_verification_request method' do
+    it 'posts to the verify resource and returns the response object' do
+      expect_post "#@api_base_url/verify/json", "api_key=#@api_key&api_secret=#@api_secret&number=447525856424&brand=MyApp"
 
       @client.send_verification_request(number: '447525856424', brand: 'MyApp')
     end
   end
 
-  describe 'check_verification_request method' do
-    it 'posts to the verify json resource and returns the response object' do
-      url = "#@api_base_url/verify/check/json"
+  describe 'check_verification method' do
+    it 'posts to the verify check resource and returns the response object' do
+      expect_post "#@api_base_url/verify/check/json", "api_key=#@api_key&api_secret=#@api_secret&request_id=8g88g88eg8g8gg9g90&code=123445"
+
+      @client.check_verification('8g88g88eg8g8gg9g90', code: '123445')
+    end
+  end
 
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+  describe 'check_verification_request method' do
+    it 'posts to the verify check resource and returns the response object' do
+      expect_post "#@api_base_url/verify/check/json", "api_key=#@api_key&api_secret=#@api_secret&request_id=8g88g88eg8g8gg9g90&code=123445"
 
       @client.check_verification_request(request_id: '8g88g88eg8g8gg9g90', code: '123445')
     end
   end
 
-  describe 'get_verification_request method' do
+  describe 'get_verification method' do
     it 'fetches the verify search resource with the given request id and returns the response object' do
-      url = "#@api_base_url/verify/search/json?api_key=key&api_secret=secret&request_id=8g88g88eg8g8gg9g90"
+      expect_get "#@api_base_url/verify/search/json?api_key=#@api_key&api_secret=#@api_secret&request_id=8g88g88eg8g8gg9g90"
+
+      @client.get_verification('8g88g88eg8g8gg9g90')
+    end
+  end
 
-      stub_request(:get, url).to_return(@json_response_body)
+  describe 'get_verification_request method' do
+    it 'fetches the verify search resource with the given request id and returns the response object' do
+      expect_get "#@api_base_url/verify/search/json?api_key=#@api_key&api_secret=#@api_secret&request_id=8g88g88eg8g8gg9g90"
 
       @client.get_verification_request('8g88g88eg8g8gg9g90')
     end
   end
 
-  describe 'control_verification_request method' do
-    it 'posts to the control json resource and returns the response object' do
-      url = "#@api_base_url/verify/control/json"
+  describe 'cancel_verification method' do
+    it 'posts to the verify control resource and returns the response object' do
+      expect_post "#@api_base_url/verify/control/json", "api_key=#@api_key&api_secret=#@api_secret&request_id=8g88g88eg8g8gg9g90&cmd=cancel"
+
+      @client.cancel_verification('8g88g88eg8g8gg9g90')
+    end
+  end
+
+  describe 'trigger_next_verification_event method' do
+    it 'posts to the verify control resource and returns the response object' do
+      expect_post "#@api_base_url/verify/control/json", "api_key=#@api_key&api_secret=#@api_secret&request_id=8g88g88eg8g8gg9g90&cmd=trigger_next_event"
+
+      @client.trigger_next_verification_event('8g88g88eg8g8gg9g90')
+    end
+  end
 
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+  describe 'control_verification_request method' do
+    it 'posts to the verify control resource and returns the response object' do
+      expect_post "#@api_base_url/verify/control/json", "api_key=#@api_key&api_secret=#@api_secret&request_id=8g88g88eg8g8gg9g90&cmd=cancel"
 
       @client.control_verification_request(request_id: '8g88g88eg8g8gg9g90', cmd: 'cancel')
     end
   end
 
   describe 'get_basic_number_insight method' do
-    it 'fetches the number format json resource and returns the response object' do
-      url = "#@api_base_url/number/format/json?api_key=key&api_secret=secret&number=447525856424"
-
-      stub_request(:get, url).to_return(@json_response_body)
+    it 'fetches the number format resource and returns the response object' do
+      expect_get "#@api_base_url/number/format/json?api_key=#@api_key&api_secret=#@api_secret&number=447525856424"
 
       @client.get_basic_number_insight(number: '447525856424')
     end
   end
 
   describe 'get_number_insight method' do
-    it 'fetches the number lookup json resource and returns the response object' do
-      url = "#@api_base_url/number/lookup/json?api_key=key&api_secret=secret&number=447525856424"
-
-      stub_request(:get, url).to_return(@json_response_body)
+    it 'fetches the number lookup resource and returns the response object' do
+      expect_get "#@api_base_url/number/lookup/json?api_key=#@api_key&api_secret=#@api_secret&number=447525856424"
 
       @client.get_number_insight(number: '447525856424')
     end
@@ -303,9 +317,7 @@ describe 'Nexmo::Client' do
 
   describe 'request_number_insight method' do
     it 'posts to the number insight resource and returns the response object' do
-      url = "#@base_url/ni/json"
-
-      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+      expect_post "#@base_url/ni/json", "api_key=#@api_key&api_secret=#@api_secret&number=447525856424&callback=https://example.com"
 
       @client.request_number_insight(number: '447525856424', callback: 'https://example.com')
     end
@@ -314,50 +326,60 @@ describe 'Nexmo::Client' do
   it 'includes a user-agent header with the library version number and ruby version number' do
     headers = {'User-Agent' => "ruby-nexmo/#{Nexmo::VERSION}/#{RUBY_VERSION}"}
 
-    stub_request(:post, "#@base_url/sms/json").with(headers: headers).to_return(@json_response_body)
+    stub_request(:post, "#@base_url/sms/json").with(headers: headers).to_return(@response_body)
 
     @client.send_message(@example_message_hash)
   end
 
   it 'raises an authentication error exception if the response code is 401' do
-    stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(status: 401)
+    stub_request(:post, "#@base_url/sms/json").to_return(status: 401)
 
     proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::AuthenticationError)
   end
 
   it 'raises a client error exception if the response code is 4xx' do
-    stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(status: 400)
+    stub_request(:post, "#@base_url/sms/json").to_return(status: 400)
 
     proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::ClientError)
   end
 
   it 'raises a server error exception if the response code is 5xx' do
-    stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(status: 500)
+    stub_request(:post, "#@base_url/sms/json").to_return(status: 500)
 
     proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::ServerError)
   end
 
   it 'provides an option for specifying a different hostname to connect to' do
-    url = "https://rest-sandbox.nexmo.com/account/get-balance?api_key=key&api_secret=secret"
-
-    request = stub_request(:get, url).to_return(@json_response_body)
+    expect_get "https://rest-sandbox.nexmo.com/account/get-balance?api_key=#@api_key&api_secret=#@api_secret"
 
-    @client = Nexmo::Client.new(key: 'key', secret: 'secret', host: 'rest-sandbox.nexmo.com')
+    @client = Nexmo::Client.new(key: @api_key, secret: @api_secret, host: 'rest-sandbox.nexmo.com')
 
     @client.get_balance
-
-    assert_requested(request)
   end
 
   it 'provides an option for specifying a different api hostname to connect to' do
-    url = "https://debug.example.com/number/format/json?api_key=key&api_secret=secret&number=447525856424"
-
-    request = stub_request(:get, url).to_return(@json_response_body)
+    expect_get "https://debug.example.com/number/format/json?api_key=#@api_key&api_secret=#@api_secret&number=447525856424"
 
-    @client = Nexmo::Client.new(key: 'key', secret: 'secret', api_host: 'debug.example.com')
+    @client = Nexmo::Client.new(key: @api_key, secret: @api_secret, api_host: 'debug.example.com')
 
     @client.get_basic_number_insight(number: '447525856424')
+  end
+
+  private
+
+  def expect_get(url)
+    @request = stub_request(:get, url).to_return(@response_body)
+  end
+
+  def expect_post(url, data)
+    body = WebMock::Util::QueryMapper.query_to_values(data)
+
+    headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
+
+    @request = stub_request(:post, url).with(body: body, headers: headers).to_return(@response_body)
+  end
 
-    assert_requested(request)
+  after do
+    assert_requested(@request) if defined?(@request)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-05 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake