nexmo 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcd725644e13c80c7c86b80e347c0bef98c8805d
-  data.tar.gz: 7c0eafc7558cb0d68c9faa93d1f3e9776ddf221c
+  metadata.gz: b8c6620dc24f8cb8e4260f28df8d33775a796624
+  data.tar.gz: f19674fb59e52953d0c690edba86fccc2e29a793
 SHA512:
-  metadata.gz: 29d45a64e0aeaec4c647c54d1db995b9c22a58b071a815f3e46d52648eff3a216c73dfb72e67777a19c9ae6499957a7e6d3900ae641a829fcef174884071d196
-  data.tar.gz: da8b6ec8aaaa5b55645940e2d6b0b59260c17bf717cf8191bf430687636a147e26b885a23ccdcff82fbfd1cbee20c084a553ed217be82ae42582fe6f36e481e9
+  metadata.gz: 441b7447fbe1e1a0452ed3f82cb531376b09e97e1c6241bfb5db59f2374f755db299ee56b41f475fa0d1f6ce13469c52a50c891a59e558d4818d4632764ec8f2
+  data.tar.gz: c085d5cae72f90a22c6d8e7912d52e2e43a910b658282c770d9cb44e15e2586bc9fab6258ede4f2daa943458e2efa88aa1961bcc50c64bc34226fa9c09dc238c

data/README.md

@@ -10,7 +10,9 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 * [SMS API](#sms-api)
 * [Voice API](#voice-api)
 * [Verify API](#verify-api)
+* [Number Insight API](#number-insight-api)
 * [Application API](#application-api)
+* [Numbers API](#numbers-api)
 * [Coverage](#api-coverage)
 * [License](#license)
 
@@ -40,19 +42,36 @@ Then construct a client object with your key and secret:
 client = Nexmo::Client.new(key: 'YOUR-API-KEY', secret: 'YOUR-API-SECRET')
 ```
 
+You can now use the client object to [send a text message](#send-a-text-message),
+[start a verification](#start-a-verification), or [create an application](#create-an-application).
+
 For production you can specify the `NEXMO_API_KEY` and `NEXMO_API_SECRET`
-environment variables instead of specifying the key and secret explicitly.
+environment variables instead of specifying the key and secret explicitly,
+keeping your credentials out of source control.
+
 
-For newer endpoints that support JWT authentication such as the Voice API,
-you can also specify the `application_id` and `private_key` arguments:
+## Credentials
+
+To check signatures for incoming webhook requests you'll also need to specify
+the `signature_secret` argument:
+
+```ruby
+client = Nexmo::Client.new(signature_secret: 'secret')
+```
+
+Alternatively you can set the `NEXMO_SIGNATURE_SECRET` environment variable.
+
+To call newer endpoints that support JWT authentication such as the Voice API you'll
+also need to specify the `application_id` and `private_key` arguments. For example:
 
 ```ruby
 client = Nexmo::Client.new(application_id: application_id, private_key: private_key)
 ```
 
-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).
+Both arguments should have string values corresponding to the `id` and `private_key`
+values returned in a ["create an application"](#create-an-application) response. These
+credentials can be stored in a datastore, in environment variables, on disk outside
+of source control, or in some kind of key management infrastructure.
 
 
 ## SMS API
@@ -69,7 +88,7 @@ else
 end
 ```
 
-Docs: [https://docs.nexmo.com/messaging/sms-api/api-reference#request](https://docs.nexmo.com/messaging/sms-api/api-reference#request?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/sms#request](https://developer.nexmo.com/api/sms?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
 
 
 ## Voice API
@@ -84,7 +103,7 @@ response = client.create_call({
 })
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#call_create](https://docs.nexmo.com/voice/voice-api/api-reference#call_create?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#create-an-outbound-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#create-an-outbound-call)
 
 ### Retrieve a list of calls
 
@@ -92,7 +111,7 @@ Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#call_create](https:/
 response = client.get_calls
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#call_retrieve](https://docs.nexmo.com/voice/voice-api/api-reference#call_retrieve?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#retrieve-information-about-all-your-calls](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-information-about-all-your-calls)
 
 ### Retrieve a single call
 
@@ -100,7 +119,7 @@ Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#call_retrieve](https
 response = client.get_call(uuid)
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#call_retrieve_single](https://docs.nexmo.com/voice/voice-api/api-reference#call_retrieve_single?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#retrieve-information-about-a-single-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-information-about-a-single-call)
 
 ### Update a call
 
@@ -108,7 +127,7 @@ Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#call_retrieve_single
 response = client.update_call(uuid, action: 'hangup')
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#call_modify_single](https://docs.nexmo.com/voice/voice-api/api-reference#call_modify_single?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#modify-an-existing-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#modify-an-existing-call)
 
 ### Stream audio to a call
 
@@ -118,7 +137,7 @@ stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_a
 response = client.send_audio(uuid, stream_url: stream_url)
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#stream_put](https://docs.nexmo.com/voice/voice-api/api-reference#stream_put?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#stream-an-audio-file-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stream-an-audio-file-to-an-active-call)
 
 ### Stop streaming audio to a call
 
@@ -126,7 +145,7 @@ Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#stream_put](https://
 response = client.stop_audio(uuid)
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#stream_delete](https://docs.nexmo.com/voice/voice-api/api-reference#stream_delete?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#stop-streaming-an-audio-file-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stop-streaming-an-audio-file-to-an-active-call)
 
 ### Send a synthesized speech message to a call
 
@@ -134,7 +153,7 @@ Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#stream_delete](https
 response = client.send_speech(uuid, text: 'Hello')
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#talk_put](https://docs.nexmo.com/voice/voice-api/api-reference#talk_put?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#send-a-synthesized-speech-message-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#send-a-synthesized-speech-message-to-an-active-call)
 
 ### Stop sending a synthesized speech message to a call
 
@@ -142,7 +161,7 @@ Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#talk_put](https://do
 response = client.stop_speech(uuid)
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#talk_delete](https://docs.nexmo.com/voice/voice-api/api-reference#talk_delete?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#stop-sending-a-synthesized-speech-message-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stop-sending-a-synthesized-speech-message-to-an-active-call)
 
 ### Send DTMF tones to a call
 
@@ -150,7 +169,7 @@ Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#talk_delete](https:/
 response = client.send_dtmf(uuid, digits: '1234')
 ```
 
-Docs: [https://docs.nexmo.com/voice/voice-api/api-reference#dtmf_put](https://docs.nexmo.com/voice/voice-api/api-reference#dtmf_put?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/voice#send-dual-tone-multi-frequency-dtmf-tones-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#send-dual-tone-multi-frequency-dtmf-tones-to-an-active-call)
 
 
 ## Verify API
@@ -167,7 +186,7 @@ else
 end
 ```
 
-Docs: [https://docs.nexmo.com/verify/api-reference/api-reference#vrequest](https://docs.nexmo.com/verify/api-reference/api-reference#vrequest?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/verify#verify-request](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-request)
 
 The response contains a verification request id which you will need to store temporarily.
 
@@ -183,7 +202,7 @@ else
 end
 ```
 
-Docs: [https://docs.nexmo.com/verify/api-reference/api-reference#check](https://docs.nexmo.com/verify/api-reference/api-reference#check?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/verify#verify-check](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-check)
 
 The verification request id comes from the call to the start_verification method.
 
@@ -195,7 +214,7 @@ The PIN code is entered into your application by the user.
 client.cancel_verification('00e6c3377e5348cdaf567e1417c707a5')
 ```
 
-Docs: [https://docs.nexmo.com/verify/api-reference/api-reference#control](https://docs.nexmo.com/verify/api-reference/api-reference#control?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/verify#verify-control](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-control)
 
 ### Trigger next verification step
 
@@ -203,7 +222,43 @@ Docs: [https://docs.nexmo.com/verify/api-reference/api-reference#control](https:
 client.trigger_next_verification_event('00e6c3377e5348cdaf567e1417c707a5')
 ```
 
-Docs: [https://docs.nexmo.com/verify/api-reference/api-reference#control](https://docs.nexmo.com/verify/api-reference/api-reference#control?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/verify#verify-control](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-control)
+
+## Number Insight API
+
+### Basic Number Insight
+
+```ruby
+client.get_basic_number_insight(number: '447700900000')
+```
+
+Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
+
+### Standard Number Insight
+
+```ruby
+client.get_standard_number_insight(number: '447700900000')
+```
+
+Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
+
+### Advanced Number Insight
+
+```ruby
+client.get_advanced_number_insight(number: '447700900000')
+```
+
+Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
+
+### Advanced Number Insight Async
+
+```ruby
+client.get_advanced_number_insight(number: '447700900000', callback: webhook_url)
+```
+
+The results of the API call will be sent via HTTP POST to the webhook URL specified in the callback parameter.
+
+Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
 
 
 ## Application API
@@ -211,10 +266,10 @@ Docs: [https://docs.nexmo.com/verify/api-reference/api-reference#control](https:
 ### Create an application
 
 ```ruby
-response = client.create_application(name: 'Example App', type: 'voice', answer_url: answer_url)
+response = client.create_application(name: 'Example App', type: 'voice', answer_url: answer_url, event_url: event_url)
 ```
 
-Docs: [https://docs.nexmo.com/tools/application-api/api-reference#create](https://docs.nexmo.com/tools/application-api/api-reference#create?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/application#create-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#create-an-application)
 
 ### Retrieve a list of applications
 
@@ -222,7 +277,7 @@ Docs: [https://docs.nexmo.com/tools/application-api/api-reference#create](https:
 response = client.get_applications
 ```
 
-Docs: [https://docs.nexmo.com/tools/application-api/api-reference#list](https://docs.nexmo.com/tools/application-api/api-reference#list?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/application#retrieve-your-applications](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-your-applications)
 
 ### Retrieve a single application
 
@@ -230,7 +285,7 @@ Docs: [https://docs.nexmo.com/tools/application-api/api-reference#list](https://
 response = client.get_application(uuid)
 ```
 
-Docs: [https://docs.nexmo.com/tools/application-api/api-reference#retrieve](https://docs.nexmo.com/tools/application-api/api-reference#retrieve?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/application#retrieve-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-an-application)
 
 ### Update an application
 
@@ -238,7 +293,7 @@ Docs: [https://docs.nexmo.com/tools/application-api/api-reference#retrieve](http
 response = client.update_application(uuid, answer_method: 'POST')
 ```
 
-Docs: [https://docs.nexmo.com/tools/application-api/api-reference#update](https://docs.nexmo.com/tools/application-api/api-reference#update?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/application#update-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#update-an-application)
 
 ### Delete an application
 
@@ -246,7 +301,50 @@ Docs: [https://docs.nexmo.com/tools/application-api/api-reference#update](https:
 response = client.delete_application(uuid)
 ```
 
-Docs: [https://docs.nexmo.com/tools/application-api/api-reference#delete](https://docs.nexmo.com/tools/application-api/api-reference#delete?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/api/application#destroy-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#destroy-an-application)
+
+
+## Numbers API
+
+### List owned numbers
+
+```ruby
+client.get_account_numbers
+```
+
+Docs: [https://developer.nexmo.com/api/developer/numbers#list-owned-numbers](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#list-owned-numbers)
+
+### Search available numbers
+
+```ruby
+client.get_available_numbers('GB')
+```
+
+Docs: [https://developer.nexmo.com/api/developer/numbers#search-available-numbers](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#search-available-numbers)
+
+### Buy a number
+
+```ruby
+client.buy_number(country: 'GB', msisdn: '447700900000')
+```
+
+Docs: [https://developer.nexmo.com/api/developer/numbers#buy-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#buy-a-number)
+
+### Cancel a number
+
+```ruby
+client.cancel_number(country: 'GB', msisdn: '447700900000')
+```
+
+Docs: [https://developer.nexmo.com/api/developer/numbers#cancel-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#cancel-a-number)
+
+### Update a number
+
+```ruby
+client.update_number(country: 'GB', msisdn: '447700900000', voiceCallbackType: 'app', voiceCallbackValue: application_id)
+```
+
+Docs: [https://developer.nexmo.com/api/developer/numbers#update-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#update-a-number)
 
 
 ## JWT authentication
@@ -285,7 +383,7 @@ else
 end
 ```
 
-Docs: [https://docs.nexmo.com/messaging/signing-messages](https://docs.nexmo.com/messaging/signing-messages?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Docs: [https://developer.nexmo.com/concepts/guides/signing-messages](https://developer.nexmo.com/concepts/guides/signing-messages?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
 
 Note: you'll need to contact support@nexmo.com to enable message signing on
 your account before you can validate webhook signatures.

data/lib/nexmo/client.rb

@@ -255,7 +255,24 @@ module Nexmo
       api_request(Net::HTTP::Get, "/v1/files/#{id.split('/').last}")
     end
 
+    def save_file(id, filename)
+      api_request(Net::HTTP::Get, "/v1/files/#{id.split('/').last}") do |response|
+        File.open(filename, 'wb') do |file|
+          response.read_body do |chunk|
+            file.write(chunk)
+          end
+        end
+      end
+    end
+
     def check_signature(params)
+      unless @signature_secret
+        raise AuthenticationError.new('No signature_secret provided. ' \
+          'You can find your signature secret in the Nexmo dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/signing-messages for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
       Signature.check(params, @signature_secret)
     end
 
@@ -298,7 +315,7 @@ module Nexmo
       request(uri, message)
     end
 
-    def api_request(message_class, path, params = nil)
+    def api_request(message_class, path, params = nil, &block)
       uri = URI('https://' + @api_host + path)
 
       unless message_class::REQUEST_HAS_BODY || params.nil? || params.empty?
@@ -312,11 +329,11 @@ module Nexmo
         message.body = JSON.generate(params)
       end
 
-      token = auth_token || JWT.auth_token({application_id: @application_id}, @private_key)
+      token = auth_token || generate_auth_token
 
       message['Authorization'] = "Bearer #{token}"
 
-      request(uri, message)
+      request(uri, message, &block)
     end
 
     def request(uri, message)
@@ -331,6 +348,8 @@ module Nexmo
       when Net::HTTPNoContent
         :no_content
       when Net::HTTPSuccess
+        return (yield http_response) if block_given?
+
         if http_response['Content-Type'].split(';').first == 'application/json'
           JSON.parse(http_response.body)
         else
@@ -346,5 +365,25 @@ module Nexmo
         raise Error, "#{http_response.code} response from #{uri.host}"
       end
     end
+
+    def generate_auth_token
+      unless @application_id
+        raise AuthenticationError.new('No application_id provided. ' \
+          'Either provide an application_id, or set an auth token. ' \
+          'You can add new applications from the Nexmo dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      unless @private_key
+        raise AuthenticationError.new('No private_key provided. ' \
+          'Either provide a private_key, or set an auth token. ' \
+          'You can add new applications from the Nexmo dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      JWT.auth_token({application_id: @application_id}, @private_key)
+    end
   end
 end

data/lib/nexmo/params.rb

@@ -6,6 +6,8 @@ module Nexmo
       params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
     end
 
+    private
+
     def self.escape(component)
       CGI.escape(component.to_s)
     end

data/lib/nexmo/signature.rb

@@ -11,6 +11,8 @@ module Nexmo
       ::JWT.secure_compare(signature, digest(params, secret))
     end
 
+    private
+
     def self.digest(params, secret)
       md5 = Digest::MD5.new
 

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '4.6.0'
+  VERSION = '4.7.0'
 end

data/spec/nexmo/client_spec.rb

@@ -25,6 +25,18 @@ describe 'Nexmo::Client' do
     @client = Nexmo::Client.new(key: @api_key, secret: @api_secret, application_id: @application_id, private_key: @private_key)
   end
 
+  let(:authorization_header) { {'Authorization' => /\ABearer (.+)\.(.+)\.(.+)\z/} }
+
+  let(:recording_id) { 'xx-xx-xx-xx' }
+
+  let(:recording_url) { "#@api_base_url/v1/files/xx-xx-xx-xx" }
+
+  let(:recording_content) { 'BODY' }
+
+  let(:recording_response) { {body: recording_content, headers: {'Content-Type' => 'application/octet-stream'}} }
+
+  let(:recording_filename) { 'test/file.mp3' }
+
   describe 'send_message method' do
     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"
@@ -325,7 +337,7 @@ describe 'Nexmo::Client' do
     end
   end
 
-  describe 'get_standard_insight method' do
+  describe 'get_standard_number_insight method' do
     it 'fetches the number lookup resource and returns the response object' do
       expect_get "#@api_base_url/ni/standard/json?api_key=#@api_key&api_secret=#@api_secret&number=447525856424"
 
@@ -476,26 +488,36 @@ describe 'Nexmo::Client' do
   end
 
   describe 'get_file method' do
-    before do
-      @url = "#@api_base_url/v1/files/xx-xx-xx-xx"
+    it 'fetches the file resource with the given id and returns the response body' do
+      @request = stub_request(:get, recording_url).with(headers: authorization_header).to_return(recording_response)
 
-      @request_headers = {'Authorization' => /\ABearer (.+)\.(.+)\.(.+)\z/}
+      @client.get_file(recording_id).must_equal(recording_content)
+    end
 
-      @response_body = 'BODY'
+    it 'fetches the file resource with the given url and returns the response body' do
+      @request = stub_request(:get, recording_url).with(headers: authorization_header).to_return(recording_response)
 
-      @response = {body: @response_body, headers: {'Content-Type' => 'application/octet-stream'}}
+      @client.get_file(recording_url).must_equal(recording_content)
     end
+  end
 
-    it 'fetches the file resource with the given id and returns the response body' do
-      @request = stub_request(:get, @url).with(headers: @request_headers).to_return(@response)
+  describe 'save_file method' do
+    after { File.unlink(recording_filename) if File.exist?(recording_filename) }
 
-      @client.get_file('xx-xx-xx-xx').must_equal(@response_body)
+    it 'fetches the file resource with the given id and streams the response body to the given filename' do
+      @request = stub_request(:get, recording_url).with(headers: authorization_header).to_return(recording_response)
+
+      @client.save_file(recording_id, recording_filename)
+
+      File.read(recording_filename).must_equal(recording_content)
     end
 
-    it 'fetches the file resource with the given url and returns the response body' do
-      @request = stub_request(:get, @url).with(headers: @request_headers).to_return(@response)
+    it 'fetches the file resource with the given url and streams the response body to the given filename' do
+      @request = stub_request(:get, recording_url).with(headers: authorization_header).to_return(recording_response)
 
-      @client.get_file(@url).must_equal(@response_body)
+      @client.save_file(recording_url, recording_filename)
+
+      File.read(recording_filename).must_equal(recording_content)
     end
   end
 
@@ -507,6 +529,30 @@ describe 'Nexmo::Client' do
 
       client.check_signature(params).must_equal(true)
     end
+
+    it 'raises an authentication error exception if the signature secret was not provided' do
+      client = Nexmo::Client.new(key: @api_key, secret: @api_secret)
+
+      exception = proc { @client.check_signature({}) }.must_raise(Nexmo::AuthenticationError)
+
+      exception.message.must_include('No signature_secret provided.')
+    end
+  end
+
+  it 'raises an authentication error exception if the application id was not provided' do
+    @client = Nexmo::Client.new(key: @api_key, secret: @api_secret, private_key: @private_key)
+
+    exception = proc { @client.get_calls }.must_raise(Nexmo::AuthenticationError)
+
+    exception.message.must_include('No application_id provided.')
+  end
+
+  it 'raises an authentication error exception if the private key was not provided' do
+    @client = Nexmo::Client.new(key: @api_key, secret: @api_secret, application_id: @application_id)
+
+    exception = proc { @client.get_calls }.must_raise(Nexmo::AuthenticationError)
+
+    exception.message.must_include('No private_key provided.')
   end
 
   it 'raises an authentication error exception if the response code is 401' do

data/spec/nexmo/params_spec.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'nexmo'
+
+describe 'Nexmo::Params' do
+  describe 'encode method' do
+    it 'returns a url encoded string containing the given params' do
+      params = {'name' => 'Example App', 'type' => 'voice'}
+
+      Nexmo::Params.encode(params).must_equal('name=Example+App&type=voice')
+    end
+
+    it 'flattens array values into multiple key value pairs' do
+      params = {'ids' => %w[00A0B0C0 00A0B0C1 00A0B0C2]}
+
+      Nexmo::Params.encode(params).must_equal('ids=00A0B0C0&ids=00A0B0C1&ids=00A0B0C2')
+    end
+  end
+end

data/spec/nexmo/signature_spec.rb

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'nexmo'
+
+describe 'Nexmo::Signature' do
+  let(:secret) { 'secret' }
+
+  describe 'check method' do
+    it 'returns true if the given params has the correct sig value' do
+      params = {'a' => '1', 'b' => '2', 'timestamp' => '1461605396', 'sig' => '6af838ef94998832dbfc29020b564830'}
+
+      Nexmo::Signature.check(params, secret).must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      params = {'a' => '1', 'b' => '2', 'timestamp' => '1461605396', 'sig' => 'xxx'}
+
+      Nexmo::Signature.check(params, secret).must_equal(false)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -88,6 +88,8 @@ files:
 - nexmo.gemspec
 - spec/nexmo/client_spec.rb
 - spec/nexmo/jwt_spec.rb
+- spec/nexmo/params_spec.rb
+- spec/nexmo/signature_spec.rb
 homepage: https://github.com/Nexmo/nexmo-ruby
 licenses:
 - MIT
@@ -108,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: This is the Ruby client library for Nexmo's API. To use it you'll need a