nexmo 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a75b2e071168d3e90be330542e75ef9ec3169f45
-  data.tar.gz: ee5a64fa8f7249c8d07664fd8edec0165e722c8b
+SHA256:
+  metadata.gz: 9af851979d214537f3ff6b20fa11f051b848d05b0a5d8fee7a7691f6b3e708d8
+  data.tar.gz: cdf846e2d27f25daf2e911107c4b4e5e0f351a2d561b3c8522798a0a716f96e8
 SHA512:
-  metadata.gz: ddf564d5563ef4f9f29603c2932ed50bc336efdc4526fdf169ba4c2dcf4b569d5a7a27df77ce0064b6e4b5d6c45266d6eac815e770aba8f200b3794cc21b4753
-  data.tar.gz: 72cbc7f778f491e88fd1991afb66932fb40efd4eddb1215ddcfcf3fe48c677a9dba5871bb89ce0681c52e6340308c822cca5cad3bb219dd22edf33017c90dc17
+  metadata.gz: 546a5945d546ab3382ef76f3c91543aaec2fb26f98ac361ce58be747b47ec8b8c83f3ad4ed20722ba50fa85a70bcaf05f25545437735b9830711e59f430ae812
+  data.tar.gz: 83fcd3552be7a52eebf7a9fbbb034b74cde86fa9a112d53325b43784311140ab25acebeae3029734c4e71ddd97dbde69ad8a0ca645eb6985434468776a90d1d1

data/README.md

@@ -24,7 +24,7 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 
 ## Requirements
 
-Nexmo Ruby supports CRuby 2.0.0+ and JRuby 9k.
+Nexmo Ruby supports CRuby 2.1.0+ and JRuby 9k.
 
 
 ## Installation
@@ -144,7 +144,7 @@ Docs: [https://developer.nexmo.com/api/voice#modify-an-existing-call](https://de
 ```ruby
 stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_audio_streaming.mp3'
 
-response = client.stream.start(uuid, stream_url: stream_url)
+response = client.calls.stream.start(uuid, stream_url: [stream_url])
 ```
 
 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)
@@ -176,7 +176,7 @@ Docs: [https://developer.nexmo.com/api/voice#stop-sending-a-synthesized-speech-m
 ### Send DTMF tones to a call
 
 ```ruby
-response = client.dtmf.send(uuid, digits: '1234')
+response = client.calls.dtmf.send(uuid, digits: '1234')
 ```
 
 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)
@@ -391,7 +391,7 @@ To disable logging set the logger to `nil`.
 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.generate` to generate a token, and set the auth_token
+directly call `Nexmo::JWT.generate` to generate a token, and set the token
 attribute on the client object. For example:
 
 ```ruby
@@ -404,9 +404,7 @@ claims = {
 
 private_key = File.read('path/to/private.key')
 
-auth_token = Nexmo::JWT.generate(claims, private_key)
-
-client.auth_token = auth_token
+client.token = Nexmo::JWT.generate(claims, private_key)
 ````
 
 

data/lib/nexmo.rb

@@ -1,5 +1,7 @@
 require 'nexmo/version'
 require 'nexmo/params'
+require 'nexmo/form_data'
+require 'nexmo/json'
 require 'nexmo/jwt'
 require 'nexmo/signature'
 require 'nexmo/user_agent'

data/lib/nexmo/account.rb

@@ -2,6 +2,8 @@
 
 module Nexmo
   class Account < Namespace
+    self.host = 'rest.nexmo.com'
+
     def balance
       request('/account/get-balance')
     end
@@ -13,11 +15,5 @@ module Nexmo
     def topup(params)
       request('/account/top-up', params: params, type: Post)
     end
-
-    private
-
-    def host
-      'rest.nexmo.com'
-    end
   end
 end

data/lib/nexmo/alerts.rb

@@ -2,6 +2,8 @@
 
 module Nexmo
   class Alerts < Namespace
+    self.host = 'rest.nexmo.com'
+
     def list
       request('/sc/us/alert/opt-in/query/json')
     end
@@ -15,11 +17,5 @@ module Nexmo
     def send(params)
       request('/sc/us/alert/json', params: params, type: Post)
     end
-
-    private
-
-    def host
-      'rest.nexmo.com'
-    end
   end
 end

data/lib/nexmo/applications.rb

@@ -2,6 +2,8 @@
 
 module Nexmo
   class Applications < Namespace
+    self.request_body = JSON
+
     def create(params)
       request('/v1/applications', params: params, type: Post)
     end
@@ -21,11 +23,5 @@ module Nexmo
     def delete(id)
       request('/v1/applications/' + id, type: Delete)
     end
-
-    private
-
-    def json_body?
-      true
-    end
   end
 end

data/lib/nexmo/authentication/bearer_token.rb

@@ -5,7 +5,7 @@ module Nexmo
     def update(object)
       return unless object.is_a?(Net::HTTPRequest)
 
-      object['Authorization'] = @client.authorization
+      object['Authorization'] = 'Bearer ' + @client.token
     end
   end
 end

data/lib/nexmo/call_dtmf.rb

@@ -2,18 +2,12 @@
 
 module Nexmo
   class CallDTMF < Namespace
-    def send(id, params)
-      request('/v1/calls/' + id + '/dtmf', params: params, type: Put)
-    end
+    self.authentication = BearerToken
 
-    private
+    self.request_body = JSON
 
-    def authentication
-      @authentication ||= BearerToken.new(@client)
-    end
-
-    def json_body?
-      true
+    def send(id, params)
+      request('/v1/calls/' + id + '/dtmf', params: params, type: Put)
     end
   end
 end

data/lib/nexmo/call_stream.rb

@@ -2,6 +2,10 @@
 
 module Nexmo
   class CallStream < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
     def start(id, params)
       request('/v1/calls/' + id + '/stream', params: params, type: Put)
     end
@@ -9,15 +13,5 @@ module Nexmo
     def stop(id)
       request('/v1/calls/' + id + '/stream', type: Delete)
     end
-
-    private
-
-    def authentication
-      @authentication ||= BearerToken.new(@client)
-    end
-
-    def json_body?
-      true
-    end
   end
 end

data/lib/nexmo/call_talk.rb

@@ -2,6 +2,10 @@
 
 module Nexmo
   class CallTalk < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
     def start(id, params)
       request('/v1/calls/' + id + '/talk', params: params, type: Put)
     end
@@ -9,15 +13,5 @@ module Nexmo
     def stop(id)
       request('/v1/calls/' + id + '/talk', type: Delete)
     end
-
-    private
-
-    def authentication
-      @authentication ||= BearerToken.new(@client)
-    end
-
-    def json_body?
-      true
-    end
   end
 end

data/lib/nexmo/calls.rb

@@ -2,6 +2,10 @@
 
 module Nexmo
   class Calls < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
     def create(params)
       request('/v1/calls', params: params, type: Post)
     end
@@ -38,12 +42,7 @@ module Nexmo
       update(id, action: 'unearmuff')
     end
 
-    def transfer(id, destination: nil)
-      # Ruby 2.0.0 does not support the syntax for required keyword arguments
-      # that was introduced in Ruby 2.1. The following line and the nil default
-      # can be removed when dropping support for Ruby 2.0.0.
-      raise ArgumentError, 'missing keyword: destination' if destination.nil?
-
+    def transfer(id, destination:)
       update(id, action: 'transfer', destination: destination)
     end
 
@@ -58,15 +57,5 @@ module Nexmo
     def dtmf
       @dtmf ||= CallDTMF.new(@client)
     end
-
-    private
-
-    def authentication
-      @authentication ||= BearerToken.new(@client)
-    end
-
-    def json_body?
-      true
-    end
   end
 end

data/lib/nexmo/client.rb

@@ -7,8 +7,8 @@ module Nexmo
     attr_writer :signature_secret
     attr_writer :application_id
     attr_writer :private_key
+    attr_writer :token
     attr_accessor :user_agent
-    attr_accessor :auth_token
 
     def initialize(options = {})
       @api_key = options[:api_key] || ENV['NEXMO_API_KEY']
@@ -21,6 +21,8 @@ module Nexmo
 
       @private_key = options[:private_key]
 
+      @token = nil
+
       @user_agent = UserAgent.string(options[:app_name], options[:app_version])
 
       self.logger = options[:logger] || (defined?(Rails.logger) && Rails.logger)
@@ -34,10 +36,14 @@ module Nexmo
       @logger = Nexmo::KeyValueLogger.new(logger)
     end
 
-    def authorization
-      token = auth_token || JWT.generate({application_id: application_id}, private_key)
+    def token
+      @token || JWT.generate({application_id: application_id}, private_key)
+    end
+
+    def auth_token=(auth_token)
+      Kernel.warn "#{self.class}##{__method__} is deprecated (use #token= instead)"
 
-      'Bearer ' + token
+      @token = auth_token
     end
 
     def api_key

data/lib/nexmo/files.rb

@@ -2,8 +2,11 @@
 
 module Nexmo
   class Files < Namespace
+    self.authentication = BearerToken
+
     def get(id)
-      request('/v1/files/' + id.split('/').last)
+      response = request('/v1/files/' + id.split('/').last)
+      response.body
     end
 
     def save(id, filename)
@@ -15,11 +18,5 @@ module Nexmo
         end
       end
     end
-
-    private
-
-    def authentication
-      @authentication ||= BearerToken.new(@client)
-    end
   end
 end

data/lib/nexmo/form_data.rb

@@ -0,0 +1,7 @@
+module Nexmo
+  module FormData
+    def self.update(http_request, params)
+      http_request.form_data = params
+    end
+  end
+end

data/lib/nexmo/json.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'json'
+
+module Nexmo
+  module JSON
+    def self.update(http_request, params)
+      http_request['Content-Type'] = 'application/json'
+      http_request.body = ::JSON.generate(params)
+    end
+  end
+end

data/lib/nexmo/messages.rb

@@ -2,6 +2,8 @@
 
 module Nexmo
   class Messages < Namespace
+    self.host = 'rest.nexmo.com'
+
     def get(id)
       request('/search/message', params: {id: id})
     end
@@ -13,11 +15,5 @@ module Nexmo
     def rejections(params)
       request('/search/rejections', params: params)
     end
-
-    private
-
-    def host
-      'rest.nexmo.com'
-    end
   end
 end

data/lib/nexmo/namespace.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'net/http'
 require 'json'
 
@@ -6,38 +7,53 @@ module Nexmo
     def initialize(client)
       @client = client
 
-      @http = Net::HTTP.new(host, Net::HTTP.https_default_port)
+      @host = self.class.host
+
+      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port)
       @http.use_ssl = true
     end
 
-    private
+    def self.host
+      @host ||= 'api.nexmo.com'
+    end
 
-    Get = Net::HTTP::Get
-    Put = Net::HTTP::Put
-    Post = Net::HTTP::Post
-    Delete = Net::HTTP::Delete
+    def self.host=(host)
+      @host = host
+    end
+
+    def self.authentication
+      @authentication ||= KeySecretParams
+    end
 
-    def host
-      'api.nexmo.com'
+    def self.authentication=(authentication)
+      @authentication = authentication
     end
 
-    def authentication
-      @authentication ||= KeySecretParams.new(@client)
+    def self.request_body
+      @request_body ||= FormData
     end
 
-    def json_body?
-      false
+    def self.request_body=(request_body)
+      @request_body = request_body
     end
 
+    private
+
+    Get = Net::HTTP::Get
+    Put = Net::HTTP::Put
+    Post = Net::HTTP::Post
+    Delete = Net::HTTP::Delete
+
     def logger
       @client.logger
     end
 
     def request(path, params: nil, type: Get, &block)
-      uri = URI('https://' + host + path)
+      uri = URI('https://' + @host + path)
 
       params ||= {}
 
+      authentication = self.class.authentication.new(@client)
       authentication.update(params)
 
       unless type::REQUEST_HAS_BODY || params.empty?
@@ -52,56 +68,31 @@ module Nexmo
 
       authentication.update(message)
 
-      encode_body(params, message) if type::REQUEST_HAS_BODY
+      self.class.request_body.update(message, params) if type::REQUEST_HAS_BODY
 
       logger.info('Nexmo API request', method: message.method, path: uri.path)
 
-      response = @http.request(message)
+      response = @http.request(message, &block)
 
-      parse(response, &block)
-    end
+      log_response_info(response)
 
-    def encode_body(params, message)
-      if json_body?
-        message['Content-Type'] = 'application/json'
-        message.body = JSON.generate(params)
-      else
-        message.form_data = params
-      end
-    end
+      return if block
 
-    def parse(response, &block)
-      logger.info('Nexmo API response',
-        host: host,
-        status: response.code,
-        type: response.content_type,
-        length: response.content_length,
-        trace_id: response['x-nexmo-trace-id'])
+      logger.debug(response.body)
 
+      parse(response)
+    end
+
+    def parse(response)
       case response
       when Net::HTTPNoContent
         :no_content
       when Net::HTTPSuccess
-        parse_success(response, &block)
-      else
-        handle_error(response)
-      end
-    end
-
-    def parse_success(response)
-      if response['Content-Type'].split(';').first == 'application/json'
-        JSON.parse(response.body, object_class: Nexmo::Entity)
-      elsif block_given?
-        yield response
-      else
-        response.body
-      end
-    end
-
-    def handle_error(response)
-      logger.debug(response.body)
-
-      case response
+        if response['Content-Type'].split(';').first == 'application/json'
+          ::JSON.parse(response.body, object_class: Nexmo::Entity)
+        else
+          response
+        end
       when Net::HTTPUnauthorized
         raise AuthenticationError
       when Net::HTTPClientError
@@ -112,5 +103,14 @@ module Nexmo
         raise Error
       end
     end
+
+    def log_response_info(response)
+      logger.info('Nexmo API response',
+        host: @host,
+        status: response.code,
+        type: response.content_type,
+        length: response.content_length,
+        trace_id: response['x-nexmo-trace-id'])
+    end
   end
 end

data/lib/nexmo/numbers.rb

@@ -4,6 +4,8 @@ module Nexmo
   class Numbers < Namespace
     include Keys
 
+    self.host = 'rest.nexmo.com'
+
     def list(params = nil)
       request('/account/numbers', params: params)
     end
@@ -23,11 +25,5 @@ module Nexmo
     def update(params)
       request('/number/update', params: camelcase(params), type: Post)
     end
-
-    private
-
-    def host
-      'rest.nexmo.com'
-    end
   end
 end

data/lib/nexmo/pricing.rb

@@ -2,6 +2,8 @@
 
 module Nexmo
   class Pricing < Namespace
+    self.host = 'rest.nexmo.com'
+
     def initialize(client, type: nil)
       raise ArgumentError if type.nil?
 
@@ -23,11 +25,5 @@ module Nexmo
     def prefix(prefix)
       request('/account/get-prefix-pricing/outbound/' + @type, params: {prefix: prefix})
     end
-
-    private
-
-    def host
-      'rest.nexmo.com'
-    end
   end
 end

data/lib/nexmo/redact.rb

@@ -2,18 +2,12 @@
 
 module Nexmo
   class Redact < Namespace
-    def transaction(params)
-      request('/v1/redact/transaction', params: params, type: Post)
-    end
+    self.authentication = KeySecretQuery
 
-    private
+    self.request_body = JSON
 
-    def authentication
-      @authentication ||= KeySecretQuery.new(@client)
-    end
-
-    def json_body?
-      true
+    def transaction(params)
+      request('/v1/redact/transaction', params: params, type: Post)
     end
   end
 end

data/lib/nexmo/signature.rb

@@ -8,7 +8,7 @@ module Nexmo
 
       signature = params.delete('sig')
 
-      secure_compare(signature, digest(params, secret))
+      ::JWT::SecurityUtils.secure_compare(signature, digest(params, secret))
     end
 
     def initialize(client)
@@ -21,16 +21,6 @@ module Nexmo
 
     private
 
-    if defined?(::JWT::SecurityUtils) # ruby-jwt v2
-      def self.secure_compare(left, right)
-        ::JWT::SecurityUtils.secure_compare(left, right)
-      end
-    else
-      def self.secure_compare(left, right)
-        ::JWT.secure_compare(left, right)
-      end
-    end
-
     def self.digest(params, secret)
       md5 = Digest::MD5.new
 

data/lib/nexmo/sms.rb

@@ -4,14 +4,10 @@ module Nexmo
   class SMS < Namespace
     include Keys
 
+    self.host = 'rest.nexmo.com'
+
     def send(params)
       request('/sms/json', params: hyphenate(params), type: Post)
     end
-
-    private
-
-    def host
-      'rest.nexmo.com'
-    end
   end
 end

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '5.2.0'
+  VERSION = '5.3.0'
 end

data/nexmo.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.description = 'Nexmo Client Library for Ruby'
   s.summary = 'This is the Ruby client library for Nexmo\'s API. To use it you\'ll need a Nexmo account. Sign up for free at https://www.nexmo.com'
   s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md nexmo.gemspec)
-  s.required_ruby_version = '>= 2.0.0'
-  s.add_dependency('jwt')
+  s.required_ruby_version = '>= 2.1.0'
+  s.add_dependency('jwt', '~> 2')
   s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('minitest', '~> 5.0')
   s.add_development_dependency('webmock', '~> 3.0')

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,8 @@ files:
 - lib/nexmo/errors/error.rb
 - lib/nexmo/errors/server_error.rb
 - lib/nexmo/files.rb
+- lib/nexmo/form_data.rb
+- lib/nexmo/json.rb
 - lib/nexmo/jwt.rb
 - lib/nexmo/key_value_logger.rb
 - lib/nexmo/keys.rb
@@ -124,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -132,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This is the Ruby client library for Nexmo's API. To use it you'll need a