nexmo 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 439a33a2772242ae8bd36c38485dba3e993c0e7e
-  data.tar.gz: da75c2646fc649aa480d5fbf1a22765e59e8bfe6
+  metadata.gz: fcd725644e13c80c7c86b80e347c0bef98c8805d
+  data.tar.gz: 7c0eafc7558cb0d68c9faa93d1f3e9776ddf221c
 SHA512:
-  metadata.gz: e3d829a39cf396a2ce3186abae44ce8b1ebc4037fcf29c9a3fee212a1b17373d8970e2ab83002a000c23c146141c49b7244fc675cf6a6530f33f63c67a3bfaf7
-  data.tar.gz: 828c598a241f0a02e2ffe762dd2f20f575fc7ebb870a4ec58a1685d24220b41c72e0ea20ce71304bd337d3bb17bf96679a71f4ad9cfed17c5fea4e86c803710f
+  metadata.gz: 29d45a64e0aeaec4c647c54d1db995b9c22a58b071a815f3e46d52648eff3a216c73dfb72e67777a19c9ae6499957a7e6d3900ae641a829fcef174884071d196
+  data.tar.gz: da8b6ec8aaaa5b55645940e2d6b0b59260c17bf717cf8191bf430687636a147e26b885a23ccdcff82fbfd1cbee20c084a553ed217be82ae42582fe6f36e481e9

data/README.md

@@ -1,5 +1,4 @@
-Nexmo Client Library for Ruby
-=============================
+# Nexmo Client Library for Ruby
 
 [![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)
 
@@ -16,8 +15,7 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 * [License](#license)
 
 
-Installation
-------------
+## Installation
 
 To install the Ruby client library using Rubygems:
 
@@ -28,8 +26,7 @@ Alternatively you can clone the repository:
     git clone git@github.com:Nexmo/nexmo-ruby.git
 
 
-Usage
------
+## Usage
 
 Begin by requiring the nexmo library:
 
@@ -252,6 +249,30 @@ 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)
 
 
+## JWT authentication
+
+By default the library generates a short lived JWT per request.
+
+To generate a long lived JWT for multiple requests or to specify JWT claims
+directly call Nexmo::JWT.auth_token to generate a token, and set the auth_token
+attribute on the client object. For example:
+
+```ruby
+claims = {
+  application_id: application_id,
+  nbf: 1483315200,
+  exp: 1514764800,
+  iat: 1483228800
+}
+
+private_key = File.read('path/to/private.key')
+
+auth_token = Nexmo::JWT.auth_token(claims, private_key)
+
+client.auth_token = auth_token
+````
+
+
 ## Validate webhook signatures
 
 ```ruby
@@ -270,8 +291,7 @@ Note: you'll need to contact support@nexmo.com to enable message signing on
 your account before you can validate webhook signatures.
 
 
-API Coverage
-------------
+## API Coverage
 
 * Account
     * [X] Balance
@@ -313,8 +333,7 @@ API Coverage
     * [X] Text-To-Speech Prompt
 
 
-License
--------
+## License
 
 This library is released under the [MIT License][license]
 

data/lib/nexmo.rb

@@ -6,354 +6,4 @@ require 'nexmo/errors/error'
 require 'nexmo/errors/client_error'
 require 'nexmo/errors/server_error'
 require 'nexmo/errors/authentication_error'
-require 'net/http'
-require 'json'
-
-module Nexmo
-  class Client
-    attr_accessor :key, :secret
-
-    def initialize(options = {})
-      @key = options.fetch(:key) { ENV.fetch('NEXMO_API_KEY') }
-
-      @secret = options.fetch(:secret) { ENV.fetch('NEXMO_API_SECRET') }
-
-      @signature_secret = options.fetch(:signature_secret) { ENV['NEXMO_SIGNATURE_SECRET'] }
-
-      @application_id = options[:application_id]
-
-      @private_key = options[:private_key]
-
-      @host = options.fetch(:host) { 'rest.nexmo.com' }
-
-      @api_host = options.fetch(:api_host) { 'api.nexmo.com' }
-
-      @sns_host = options.fetch(:sns_host) { 'sns.nexmo.com' }
-
-      @user_agent = "nexmo-ruby/#{VERSION} ruby/#{RUBY_VERSION}"
-
-      if options.key?(:app_name) && options.key?(:app_version)
-        @user_agent << " #{options[:app_name]}/#{options[:app_version]}"
-      end
-    end
-
-    def send_message(params)
-      post(@host, '/sms/json', params)
-    end
-
-    def track_message_conversion(message_id, params = {})
-      post(@api_host, '/conversions/sms', {'message-id' => message_id}.merge(params))
-    end
-
-    def track_voice_conversion(message_id, params = {})
-      post(@api_host, '/conversions/voice', {'message-id' => message_id}.merge(params))
-    end
-
-    def get_balance
-      get(@host, '/account/get-balance')
-    end
-
-    def get_country_pricing(country_code)
-      get(@host, '/account/get-pricing/outbound', country: country_code)
-    end
-
-    def get_prefix_pricing(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(@host, '/account/settings', params)
-    end
-
-    def topup(params)
-      post(@host, '/account/top-up', params)
-    end
-
-    def get_account_numbers(params)
-      get(@host, '/account/numbers', params)
-    end
-
-    def get_available_numbers(country_code, params = {})
-      get(@host, '/number/search', {country: country_code}.merge(params))
-    end
-
-    def buy_number(params)
-      post(@host, '/number/buy', params)
-    end
-
-    def cancel_number(params)
-      post(@host, '/number/cancel', params)
-    end
-
-    def update_number(params)
-      post(@host, '/number/update', params)
-    end
-
-    def get_message(id)
-      get(@host, '/search/message', id: id)
-    end
-
-    def get_message_rejections(params)
-      get(@host, '/search/rejections', params)
-    end
-
-    def search_messages(params)
-      get(@host, '/search/messages', Hash === params ? params : {ids: Array(params)})
-    end
-
-    def send_ussd_push_message(params)
-      post(@host, '/ussd/json', params)
-    end
-
-    def send_ussd_prompt_message(params)
-      post(@host, '/ussd-prompt/json', params)
-    end
-
-    def send_2fa_message(params)
-      post(@host, '/sc/us/2fa/json', params)
-    end
-
-    def send_event_alert_message(params)
-      post(@host, '/sc/us/alert/json', params)
-    end
-
-    def send_marketing_message(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 sns_publish(message, params)
-      post(@sns_host, '/sns/json', {cmd: 'publish', message: message}.merge(params))
-    end
-
-    def sns_subscribe(recipient, params)
-      post(@sns_host, '/sns/json', {cmd: 'subscribe', to: recipient}.merge(params))
-    end
-
-    def initiate_call(params)
-      Kernel.warn "#{self.class}##{__method__} is deprecated (use the Voice API instead)."
-
-      post(@host, '/call/json', params)
-    end
-
-    def initiate_tts_call(params)
-      Kernel.warn "#{self.class}##{__method__} is deprecated (use the Voice API instead)."
-
-      post(@api_host, '/tts/json', params)
-    end
-
-    def initiate_tts_prompt_call(params)
-      Kernel.warn "#{self.class}##{__method__} is deprecated (use the Voice API instead)."
-
-      post(@api_host, '/tts-prompt/json', params)
-    end
-
-    def start_verification(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 get_verification(request_id)
-      get(@api_host, '/verify/search/json', request_id: request_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 get_basic_number_insight(params)
-      get(@api_host, '/ni/basic/json', params)
-    end
-
-    def get_standard_number_insight(params)
-      get(@api_host, '/ni/standard/json', params)
-    end
-
-    def get_number_insight(params)
-      Kernel.warn "#{self.class}##{__method__} is deprecated (use #get_standard_number_insight instead)."
-
-      get(@api_host, '/number/lookup/json', params)
-    end
-
-    def get_advanced_number_insight(params)
-      get(@api_host, '/ni/advanced/json', params)
-    end
-
-    def get_advanced_async_number_insight(params)
-      get(@api_host, '/ni/advanced/async/json', params)
-    end
-
-    def request_number_insight(params)
-      post(@host, '/ni/json', params)
-    end
-
-    def get_applications(params = {})
-      get(@api_host, '/v1/applications', params)
-    end
-
-    def get_application(id)
-      get(@api_host, "/v1/applications/#{id}")
-    end
-
-    def create_application(params)
-      post(@api_host, '/v1/applications', params)
-    end
-
-    def update_application(id, params)
-      put(@api_host, "/v1/applications/#{id}", params)
-    end
-
-    def delete_application(id)
-      delete(@api_host, "/v1/applications/#{id}")
-    end
-
-    def create_call(params)
-      api_request(Net::HTTP::Post, '/v1/calls', params)
-    end
-
-    def get_calls(params = nil)
-      api_request(Net::HTTP::Get, '/v1/calls', params)
-    end
-
-    def get_call(uuid)
-      api_request(Net::HTTP::Get, "/v1/calls/#{uuid}")
-    end
-
-    def update_call(uuid, params)
-      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}", params)
-    end
-
-    def send_audio(uuid, params)
-      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}/stream", params)
-    end
-
-    def stop_audio(uuid)
-      api_request(Net::HTTP::Delete, "/v1/calls/#{uuid}/stream")
-    end
-
-    def send_speech(uuid, params)
-      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}/talk", params)
-    end
-
-    def stop_speech(uuid)
-      api_request(Net::HTTP::Delete, "/v1/calls/#{uuid}/talk")
-    end
-
-    def send_dtmf(uuid, params)
-      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}/dtmf", params)
-    end
-
-    def check_signature(params)
-      Signature.check(params, @signature_secret)
-    end
-
-    private
-
-    def get(host, request_uri, params = {})
-      uri = URI('https://' + host + request_uri)
-      uri.query = Params.encode(params.merge(api_key: @key, api_secret: @secret))
-
-      message = Net::HTTP::Get.new(uri.request_uri)
-
-      request(uri, message)
-    end
-
-    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)
-
-      request(uri, message)
-    end
-
-    def put(host, request_uri, params)
-      uri = URI('https://' + host + request_uri)
-
-      message = Net::HTTP::Put.new(uri.request_uri)
-      message.form_data = params.merge(api_key: @key, api_secret: @secret)
-
-      request(uri, message)
-    end
-
-    def delete(host, request_uri)
-      uri = URI('https://' + host + request_uri)
-      uri.query = Params.encode({api_key: @key, api_secret: @secret})
-
-      message = Net::HTTP::Delete.new(uri.request_uri)
-
-      request(uri, message)
-    end
-
-    def api_request(message_class, path, params = nil)
-      uri = URI('https://' + @api_host + path)
-
-      unless message_class::REQUEST_HAS_BODY || params.nil? || params.empty?
-        uri.query = Params.encode(params)
-      end
-
-      message = message_class.new(uri.request_uri)
-
-      if message_class::REQUEST_HAS_BODY
-        message['Content-Type'] = 'application/json'
-        message.body = JSON.generate(params)
-      end
-
-      auth_payload = {application_id: @application_id}
-
-      message['Authorization'] = JWT.auth_header(auth_payload, @private_key)
-
-      request(uri, message)
-    end
-
-    def request(uri, message)
-      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
-      http.use_ssl = true
-
-      message['User-Agent'] = @user_agent
-
-      http_response = http.request(message)
-
-      case http_response
-      when Net::HTTPNoContent
-        :no_content
-      when Net::HTTPSuccess
-        if http_response['Content-Type'].split(';').first == 'application/json'
-          JSON.parse(http_response.body)
-        else
-          http_response.body
-        end
-      when Net::HTTPUnauthorized
-        raise AuthenticationError, "#{http_response.code} response from #{uri.host}"
-      when Net::HTTPClientError
-        raise ClientError, "#{http_response.code} response from #{uri.host}"
-      when Net::HTTPServerError
-        raise ServerError, "#{http_response.code} response from #{uri.host}"
-      else
-        raise Error, "#{http_response.code} response from #{uri.host}"
-      end
-    end
-  end
-end
+require 'nexmo/client'

data/lib/nexmo/client.rb

@@ -0,0 +1,350 @@
+require 'net/http'
+require 'json'
+
+module Nexmo
+  class Client
+    attr_accessor :key, :secret, :auth_token
+
+    def initialize(options = {})
+      @key = options.fetch(:key) { ENV.fetch('NEXMO_API_KEY') }
+
+      @secret = options.fetch(:secret) { ENV.fetch('NEXMO_API_SECRET') }
+
+      @signature_secret = options.fetch(:signature_secret) { ENV['NEXMO_SIGNATURE_SECRET'] }
+
+      @application_id = options[:application_id]
+
+      @private_key = options[:private_key]
+
+      @host = options.fetch(:host) { 'rest.nexmo.com' }
+
+      @api_host = options.fetch(:api_host) { 'api.nexmo.com' }
+
+      @sns_host = options.fetch(:sns_host) { 'sns.nexmo.com' }
+
+      @user_agent = "nexmo-ruby/#{VERSION} ruby/#{RUBY_VERSION}"
+
+      if options.key?(:app_name) && options.key?(:app_version)
+        @user_agent << " #{options[:app_name]}/#{options[:app_version]}"
+      end
+    end
+
+    def send_message(params)
+      post(@host, '/sms/json', params)
+    end
+
+    def track_message_conversion(message_id, params = {})
+      post(@api_host, '/conversions/sms', {'message-id' => message_id}.merge(params))
+    end
+
+    def track_voice_conversion(message_id, params = {})
+      post(@api_host, '/conversions/voice', {'message-id' => message_id}.merge(params))
+    end
+
+    def get_balance
+      get(@host, '/account/get-balance')
+    end
+
+    def get_country_pricing(country_code)
+      get(@host, '/account/get-pricing/outbound', country: country_code)
+    end
+
+    def get_prefix_pricing(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(@host, '/account/settings', params)
+    end
+
+    def topup(params)
+      post(@host, '/account/top-up', params)
+    end
+
+    def get_account_numbers(params)
+      get(@host, '/account/numbers', params)
+    end
+
+    def get_available_numbers(country_code, params = {})
+      get(@host, '/number/search', {country: country_code}.merge(params))
+    end
+
+    def buy_number(params)
+      post(@host, '/number/buy', params)
+    end
+
+    def cancel_number(params)
+      post(@host, '/number/cancel', params)
+    end
+
+    def update_number(params)
+      post(@host, '/number/update', params)
+    end
+
+    def get_message(id)
+      get(@host, '/search/message', id: id)
+    end
+
+    def get_message_rejections(params)
+      get(@host, '/search/rejections', params)
+    end
+
+    def search_messages(params)
+      get(@host, '/search/messages', Hash === params ? params : {ids: Array(params)})
+    end
+
+    def send_ussd_push_message(params)
+      post(@host, '/ussd/json', params)
+    end
+
+    def send_ussd_prompt_message(params)
+      post(@host, '/ussd-prompt/json', params)
+    end
+
+    def send_2fa_message(params)
+      post(@host, '/sc/us/2fa/json', params)
+    end
+
+    def send_event_alert_message(params)
+      post(@host, '/sc/us/alert/json', params)
+    end
+
+    def send_marketing_message(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 sns_publish(message, params)
+      post(@sns_host, '/sns/json', {cmd: 'publish', message: message}.merge(params))
+    end
+
+    def sns_subscribe(recipient, params)
+      post(@sns_host, '/sns/json', {cmd: 'subscribe', to: recipient}.merge(params))
+    end
+
+    def initiate_call(params)
+      Kernel.warn "#{self.class}##{__method__} is deprecated (use the Voice API instead)."
+
+      post(@host, '/call/json', params)
+    end
+
+    def initiate_tts_call(params)
+      Kernel.warn "#{self.class}##{__method__} is deprecated (use the Voice API instead)."
+
+      post(@api_host, '/tts/json', params)
+    end
+
+    def initiate_tts_prompt_call(params)
+      Kernel.warn "#{self.class}##{__method__} is deprecated (use the Voice API instead)."
+
+      post(@api_host, '/tts-prompt/json', params)
+    end
+
+    def start_verification(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 get_verification(request_id)
+      get(@api_host, '/verify/search/json', request_id: request_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 get_basic_number_insight(params)
+      get(@api_host, '/ni/basic/json', params)
+    end
+
+    def get_standard_number_insight(params)
+      get(@api_host, '/ni/standard/json', params)
+    end
+
+    def get_advanced_number_insight(params)
+      get(@api_host, '/ni/advanced/json', params)
+    end
+
+    def get_advanced_async_number_insight(params)
+      get(@api_host, '/ni/advanced/async/json', params)
+    end
+
+    def request_number_insight(params)
+      post(@host, '/ni/json', params)
+    end
+
+    def get_applications(params = {})
+      get(@api_host, '/v1/applications', params)
+    end
+
+    def get_application(id)
+      get(@api_host, "/v1/applications/#{id}")
+    end
+
+    def create_application(params)
+      post(@api_host, '/v1/applications', params)
+    end
+
+    def update_application(id, params)
+      put(@api_host, "/v1/applications/#{id}", params)
+    end
+
+    def delete_application(id)
+      delete(@api_host, "/v1/applications/#{id}")
+    end
+
+    def create_call(params)
+      api_request(Net::HTTP::Post, '/v1/calls', params)
+    end
+
+    def get_calls(params = nil)
+      api_request(Net::HTTP::Get, '/v1/calls', params)
+    end
+
+    def get_call(uuid)
+      api_request(Net::HTTP::Get, "/v1/calls/#{uuid}")
+    end
+
+    def update_call(uuid, params)
+      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}", params)
+    end
+
+    def send_audio(uuid, params)
+      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}/stream", params)
+    end
+
+    def stop_audio(uuid)
+      api_request(Net::HTTP::Delete, "/v1/calls/#{uuid}/stream")
+    end
+
+    def send_speech(uuid, params)
+      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}/talk", params)
+    end
+
+    def stop_speech(uuid)
+      api_request(Net::HTTP::Delete, "/v1/calls/#{uuid}/talk")
+    end
+
+    def send_dtmf(uuid, params)
+      api_request(Net::HTTP::Put, "/v1/calls/#{uuid}/dtmf", params)
+    end
+
+    def get_file(id)
+      api_request(Net::HTTP::Get, "/v1/files/#{id.split('/').last}")
+    end
+
+    def check_signature(params)
+      Signature.check(params, @signature_secret)
+    end
+
+    private
+
+    def get(host, request_uri, params = {})
+      uri = URI('https://' + host + request_uri)
+      uri.query = Params.encode(params.merge(api_key: @key, api_secret: @secret))
+
+      message = Net::HTTP::Get.new(uri.request_uri)
+
+      request(uri, message)
+    end
+
+    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)
+
+      request(uri, message)
+    end
+
+    def put(host, request_uri, params)
+      uri = URI('https://' + host + request_uri)
+
+      message = Net::HTTP::Put.new(uri.request_uri)
+      message['Content-Type'] = 'application/json'
+      message.body = JSON.generate(params.merge(api_key: @key, api_secret: @secret))
+
+      request(uri, message)
+    end
+
+    def delete(host, request_uri)
+      uri = URI('https://' + host + request_uri)
+      uri.query = Params.encode({api_key: @key, api_secret: @secret})
+
+      message = Net::HTTP::Delete.new(uri.request_uri)
+
+      request(uri, message)
+    end
+
+    def api_request(message_class, path, params = nil)
+      uri = URI('https://' + @api_host + path)
+
+      unless message_class::REQUEST_HAS_BODY || params.nil? || params.empty?
+        uri.query = Params.encode(params)
+      end
+
+      message = message_class.new(uri.request_uri)
+
+      if message_class::REQUEST_HAS_BODY
+        message['Content-Type'] = 'application/json'
+        message.body = JSON.generate(params)
+      end
+
+      token = auth_token || JWT.auth_token({application_id: @application_id}, @private_key)
+
+      message['Authorization'] = "Bearer #{token}"
+
+      request(uri, message)
+    end
+
+    def request(uri, message)
+      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
+      http.use_ssl = true
+
+      message['User-Agent'] = @user_agent
+
+      http_response = http.request(message)
+
+      case http_response
+      when Net::HTTPNoContent
+        :no_content
+      when Net::HTTPSuccess
+        if http_response['Content-Type'].split(';').first == 'application/json'
+          JSON.parse(http_response.body)
+        else
+          http_response.body
+        end
+      when Net::HTTPUnauthorized
+        raise AuthenticationError, "#{http_response.code} response from #{uri.host}"
+      when Net::HTTPClientError
+        raise ClientError, "#{http_response.code} response from #{uri.host}"
+      when Net::HTTPServerError
+        raise ServerError, "#{http_response.code} response from #{uri.host}"
+      else
+        raise Error, "#{http_response.code} response from #{uri.host}"
+      end
+    end
+  end
+end

data/lib/nexmo/jwt.rb

@@ -4,16 +4,14 @@ require 'jwt'
 
 module Nexmo
   module JWT
-    def self.auth_header(payload, private_key)
-      payload[:iat] = iat = Time.now.to_i
-      payload[:exp] = iat + 60
-      payload[:jti] = SecureRandom.uuid
+    def self.auth_token(payload, private_key)
+      payload[:iat] = iat = Time.now.to_i unless payload.key?(:iat) || payload.key?('iat')
+      payload[:exp] = iat + 60 unless payload.key?(:exp) || payload.key?('exp')
+      payload[:jti] = SecureRandom.uuid unless payload.key?(:jti) || payload.key?('jti')
 
       private_key = OpenSSL::PKey::RSA.new(private_key) unless private_key.respond_to?(:sign)
 
-      token = ::JWT.encode(payload, private_key, 'RS256')
-
-      "Bearer #{token}"
+      ::JWT.encode(payload, private_key, 'RS256')
     end
   end
 end

data/lib/nexmo/version.rb

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

data/spec/{nexmo_spec.rb → nexmo/client_spec.rb}

@@ -333,16 +333,6 @@ describe 'Nexmo::Client' do
     end
   end
 
-  describe 'get_number_insight method' do
-    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"
-
-      Kernel.stub :warn, proc { |message| message.must_match(/get_number_insight is deprecated/) } do
-        @client.get_number_insight(number: '447525856424').must_equal(@response_object)
-      end
-    end
-  end
-
   describe 'get_advanced_number_insight method' do
     it 'fetches the ni advanced resource and returns the response object' do
       expect_get "#@api_base_url/ni/advanced/json?api_key=#@api_key&api_secret=#@api_secret&number=447525856424"
@@ -485,6 +475,30 @@ describe 'Nexmo::Client' do
     end
   end
 
+  describe 'get_file method' do
+    before do
+      @url = "#@api_base_url/v1/files/xx-xx-xx-xx"
+
+      @request_headers = {'Authorization' => /\ABearer (.+)\.(.+)\.(.+)\z/}
+
+      @response_body = 'BODY'
+
+      @response = {body: @response_body, headers: {'Content-Type' => 'application/octet-stream'}}
+    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)
+
+      @client.get_file('xx-xx-xx-xx').must_equal(@response_body)
+    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)
+
+      @client.get_file(@url).must_equal(@response_body)
+    end
+  end
+
   describe 'check_signature method' do
     it 'returns true if the signature in the given params is correct' do
       params = {'a' => '1', 'b' => '2', 'timestamp' => '1461605396', 'sig' => '6af838ef94998832dbfc29020b564830'}
@@ -513,6 +527,18 @@ describe 'Nexmo::Client' do
     proc { @client.get_balance }.must_raise(Nexmo::ServerError)
   end
 
+  it 'provides an accessor to set the authorization token' do
+    auth_token = 'auth_token_xxx'
+
+    headers = {'Authorization' => "Bearer #{auth_token}"}
+
+    @request = stub_request(:get, "#@api_base_url/v1/calls").with(headers: headers).to_return(@response_body)
+
+    @client.auth_token = auth_token
+
+    @client.get_calls
+  end
+
   it 'includes a user-agent header with the library version number and ruby version number' do
     headers = {'User-Agent' => "nexmo-ruby/#{Nexmo::VERSION} ruby/#{RUBY_VERSION}"}
 
@@ -582,7 +608,7 @@ describe 'Nexmo::Client' do
   def expect_put(url, data)
     body = WebMock::Util::QueryMapper.query_to_values(data)
 
-    headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
+    headers = {'Content-Type' => 'application/json'}
 
     @request = stub_request(:put, url).with(body: body, headers: headers).to_return(@response_body)
   end

data/spec/nexmo/jwt_spec.rb

@@ -0,0 +1,53 @@
+require 'minitest/autorun'
+require 'nexmo'
+
+describe 'Nexmo::JWT' do
+  describe 'auth_token method' do
+    it 'returns the payload encoded with the private key' do
+      time = Time.now.to_i
+
+      payload = {
+        'application_id' => application_id,
+        'iat' => time,
+        'exp' => time + 3600,
+        'jti' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+      }
+
+      encoded_token = Nexmo::JWT.auth_token(payload, private_key)
+
+      decode(encoded_token).must_equal(payload)
+    end
+
+    it 'sets a default value for the iat parameter' do
+      encoded_token = Nexmo::JWT.auth_token({}, private_key)
+
+      decode(encoded_token).fetch('iat').must_be_kind_of(Integer)
+    end
+
+    it 'sets a default value for the exp parameter' do
+      encoded_token = Nexmo::JWT.auth_token({}, private_key)
+
+      decode(encoded_token).fetch('exp').must_be_kind_of(Integer)
+    end
+
+    it 'sets a default value for the jti parameter' do
+      encoded_token = Nexmo::JWT.auth_token({}, private_key)
+
+      decode(encoded_token).fetch('jti').must_match(/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/)
+    end
+  end
+
+  private
+
+  def decode(encoded_token)
+    JWT.decode(encoded_token, private_key, 'RS256').first
+  end
+
+  def application_id
+    @application_id ||= SecureRandom.uuid
+  end
+
+  def private_key
+    @private_key ||= OpenSSL::PKey::RSA.new(1024)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -76,6 +76,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/nexmo.rb
+- lib/nexmo/client.rb
 - lib/nexmo/errors/authentication_error.rb
 - lib/nexmo/errors/client_error.rb
 - lib/nexmo/errors/error.rb
@@ -85,7 +86,8 @@ files:
 - lib/nexmo/signature.rb
 - lib/nexmo/version.rb
 - nexmo.gemspec
-- spec/nexmo_spec.rb
+- spec/nexmo/client_spec.rb
+- spec/nexmo/jwt_spec.rb
 homepage: https://github.com/Nexmo/nexmo-ruby
 licenses:
 - MIT