nexmo 5.0.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5167882ec4a5aa4053e97dee2d7251f6b3667b28
-  data.tar.gz: 4fb6a105aec379f9b3dff7498bbc9b33bae38435
+  metadata.gz: f4155d7a6a67606fc9bc5a9d43fe530585a4d160
+  data.tar.gz: 4be1b6e5b4bf2043b10a4f2c238ea283c60ceb85
 SHA512:
-  metadata.gz: 9dcfa140d4139b36a04088f6ff459708fc4cb1196c8706ba595695163ac3e39c761218da0e2dea3c7835c59b25e1fb48ff67a29f74cd031aea0b68b1c004035b
-  data.tar.gz: 375895395424f0e5c25b8eed5c07e69e0abed1a5a465f58dd23657f09fb2bc290cacafba6c0b10984eaafc08c2ec0e88296f7c06cc1c2df216611290b4a1dbf9
+  metadata.gz: bd048ba74997b9900fc7ec2697478f6e5b2b6de7cebcd3849b12371e360770d2fd7f3f33939ce1af8e21a7d000ee558e71f2b44b9f139f3d576a00a6803d5067
+  data.tar.gz: fa30b6e1059ed7de07825e94f4e348245a3c6c007175d11fb95dc0be4519b3a682fe3adcde71c3196d6f5236db440cb9469ca3b9efd16ea79895e02fb10e401d

data/README.md

@@ -5,6 +5,7 @@
 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].
 
+* [Requirements](#requirements)
 * [Installation](#installation)
 * [Usage](#usage)
 * [SMS API](#sms-api)
@@ -13,7 +14,10 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 * [Number Insight API](#number-insight-api)
 * [Application API](#application-api)
 * [Numbers API](#numbers-api)
-* [Coverage](#api-coverage)
+* [Logging](#logging)
+* [JWT authentication](#jwt-authentication)
+* [Webhook signatures](#webhook-signatures)
+* [API coverage](#api-coverage)
 * [License](#license)
 
 
@@ -353,6 +357,23 @@ client.numbers.update(country: 'GB', msisdn: '447700900000', voice_callback_type
 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)
 
 
+## Logging
+
+Use the logger option or attribute writer method to specify a logger. For example:
+
+```ruby
+require 'logger'
+
+logger = Logger.new(STDOUT)
+
+client = Nexmo::Client.new(logger: logger)
+```
+
+By default the library sets the logger to `Rails.logger` if it is defined.
+
+To disable logging set the logger to `nil`.
+
+
 ## JWT authentication
 
 By default the library generates a short lived JWT per request.
@@ -377,7 +398,7 @@ client.auth_token = auth_token
 ````
 
 
-## Validate webhook signatures
+## Webhook signatures
 
 ```ruby
 client = Nexmo::Client.new(signature_secret: 'secret')
@@ -391,11 +412,10 @@ end
 
 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.
+Note: you'll need to contact support@nexmo.com to enable message signing on your account.
 
 
-## API Coverage
+## API coverage
 
 * Account
     * [X] Balance

data/lib/nexmo.rb

@@ -9,6 +9,7 @@ require 'nexmo/errors/error'
 require 'nexmo/errors/client_error'
 require 'nexmo/errors/server_error'
 require 'nexmo/errors/authentication_error'
+require 'nexmo/key_value_logger'
 require 'nexmo/namespace'
 require 'nexmo/client'
 require 'nexmo/account'

data/lib/nexmo/client.rb

@@ -2,7 +2,13 @@
 
 module Nexmo
   class Client
-    attr_accessor :auth_token, :user_agent
+    attr_writer :api_key
+    attr_writer :api_secret
+    attr_writer :signature_secret
+    attr_writer :application_id
+    attr_writer :private_key
+    attr_accessor :user_agent
+    attr_accessor :auth_token
 
     def initialize(options = {})
       @api_key = options[:api_key] || ENV['NEXMO_API_KEY']
@@ -15,11 +21,17 @@ module Nexmo
 
       @private_key = options[:private_key]
 
-      @host = options.fetch(:host) { 'rest.nexmo.com' }
+      @user_agent = UserAgent.string(options[:app_name], options[:app_version])
 
-      @api_host = options.fetch(:api_host) { 'api.nexmo.com' }
+      self.logger = options[:logger] || (defined?(Rails.logger) && Rails.logger)
+    end
 
-      @user_agent = UserAgent.string(options[:app_name], options[:app_version])
+    def logger
+      @logger
+    end
+
+    def logger=(logger)
+      @logger = Nexmo::KeyValueLogger.new(logger)
     end
 
     def authorization

data/lib/nexmo/key_value_logger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class KeyValueLogger
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def debug(message, data = nil)
+      @logger.debug(format(message, data)) if @logger
+    end
+
+    def info(message, data = nil)
+      @logger.info(format(message, data)) if @logger
+    end
+
+    def warning(message, data = nil)
+      @logger.warning(format(message, data)) if @logger
+    end
+
+    def error(message, data = nil)
+      @logger.error(format(message, data)) if @logger
+    end
+
+    private
+
+    def format(message, hash)
+      return message if hash.nil?
+
+      fields = hash.map { |key, value| "#{key}=#{value}" if value }.compact
+      fields.unshift(message)
+      fields.join(' ')
+    end
+  end
+end

data/lib/nexmo/namespace.rb

@@ -5,6 +5,9 @@ module Nexmo
   class Namespace
     def initialize(client)
       @client = client
+
+      @http = Net::HTTP.new(host, Net::HTTP.https_default_port)
+      @http.use_ssl = true
     end
 
     private
@@ -26,6 +29,10 @@ module Nexmo
       false
     end
 
+    def logger
+      @client.logger
+    end
+
     def request(path, params: nil, type: Get, &block)
       uri = URI('https://' + host + path)
 
@@ -40,41 +47,42 @@ module Nexmo
       end
 
       message = type.new(uri.request_uri)
-
-      if type::REQUEST_HAS_BODY
-        if json_body?
-          message['Content-Type'] = 'application/json'
-          message.body = JSON.generate(params)
-        else
-          message.form_data = params
-        end
-      end
-
       message['Authorization'] = @client.authorization if authorization_header?
       message['User-Agent'] = @client.user_agent
 
-      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
-      http.use_ssl = true
+      encode_body(params, message) if type::REQUEST_HAS_BODY
 
-      response = http.request(message)
+      logger.info('Nexmo API request', method: message.method, path: uri.path)
+
+      response = @http.request(message)
 
       parse(response, &block)
     end
 
+    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
+
     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'])
+
       case response
       when Net::HTTPNoContent
         :no_content
       when Net::HTTPSuccess
         parse_success(response, &block)
-      when Net::HTTPUnauthorized
-        raise AuthenticationError, "#{response.code} response from #{host}"
-      when Net::HTTPClientError
-        raise ClientError, "#{response.code} response from #{host}"
-      when Net::HTTPServerError
-        raise ServerError, "#{response.code} response from #{host}"
       else
-        raise Error, "#{response.code} response from #{host}"
+        handle_error(response)
       end
     end
 
@@ -87,5 +95,20 @@ module Nexmo
         response.body
       end
     end
+
+    def handle_error(response)
+      logger.debug(response.body)
+
+      case response
+      when Net::HTTPUnauthorized
+        raise AuthenticationError
+      when Net::HTTPClientError
+        raise ClientError
+      when Net::HTTPServerError
+        raise ServerError
+      else
+        raise Error
+      end
+    end
   end
 end

data/lib/nexmo/pricing.rb

@@ -5,7 +5,9 @@ module Nexmo
     def initialize(client, type: nil)
       raise ArgumentError if type.nil?
 
-      @client, @type = client, type
+      @type = type
+
+      super client
     end
 
     attr_reader :type

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '5.0.2'
+  VERSION = '5.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -92,6 +92,7 @@ files:
 - lib/nexmo/errors/server_error.rb
 - lib/nexmo/files.rb
 - lib/nexmo/jwt.rb
+- lib/nexmo/key_value_logger.rb
 - lib/nexmo/keys.rb
 - lib/nexmo/messages.rb
 - lib/nexmo/namespace.rb
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: This is the Ruby client library for Nexmo's API. To use it you'll need a