nexmo 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acbd01437020690fe8cfd847124290e384ea7ad151f373aafb7cb043197941a7
-  data.tar.gz: a12a717b8dacd66dc993c237120a1a54dee43305fdf6f5ed93565eb4d4a6a517
+  metadata.gz: 7339e40c57dc348e205411f04ffdb1d5f96bd0bb41fd481a4781c6a91b9c06c0
+  data.tar.gz: cb033f687f94529c18faf2b9bee41f7e9383fdc7954e9cf38f3cf15642d1bbeb
 SHA512:
-  metadata.gz: 5a6540019a076be34194d8185b77417155cd00bc295fbc6983f7b6b58cd9b7ae68a0abad6001f4af202afbaeb5e94296b17558f31461508dd9f33ff5647f040e
-  data.tar.gz: 761584429c830e57c493f78292fe17842c4a327305b480144e91bbe2cbb263e27f7d1394e876a9d4552822dcb84f22ff38e4317c2f74e47d35639a65adec551b
+  metadata.gz: bbddc5433b0356fc806c999dbfc1185b5e5d90989cb1e1742812713e0624d3b7ed07fb21e333c55d0c774e44aec42e00c7bcc3e15f1b5079b4e3b1f626441c57
+  data.tar.gz: c56b00b6a05d095268289cb2238ee4d38f05b8da67f2d4c0d839f4ae89f09462fd44138b9e880187e75b01dbd356ed74dfad5038aefcf7588f93776a1ff408b5

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Nexmo Inc
+Copyright (c) 2016-2018 Nexmo Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -53,7 +53,7 @@ Then construct a client object with your key and secret:
 client = Nexmo::Client.new(api_key: 'YOUR-API-KEY', api_secret: 'YOUR-API-SECRET')
 ```
 
-You can now use the client object to [send a text message](#send-a-text-message),
+You can now use the client object to [send an SMS](#send-an-sms),
 [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`
@@ -153,7 +153,7 @@ Docs: [https://developer.nexmo.com/api/voice#startStream](https://developer.nexm
 ### Stop playing an audio file into a call
 
 ```ruby
-response = client.stream.stop(uuid)
+response = client.calls.stream.stop(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#stopStream](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stopStream)
@@ -161,7 +161,7 @@ Docs: [https://developer.nexmo.com/api/voice#stopStream](https://developer.nexmo
 ### Play text to speech into a call
 
 ```ruby
-response = client.talk.start(uuid, text: 'Hello')
+response = client.calls.talk.start(uuid, text: 'Hello')
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#startTalk](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#startTalk)
@@ -169,7 +169,7 @@ Docs: [https://developer.nexmo.com/api/voice#startTalk](https://developer.nexmo.
 ### Stop text to speech in a call
 
 ```ruby
-response = client.talk.stop(uuid)
+response = client.calls.talk.stop(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#stopTalk](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stopTalk)

data/lib/nexmo.rb

@@ -1,12 +1,14 @@
 require 'nexmo/version'
 require 'nexmo/params'
 require 'nexmo/form_data'
+require 'nexmo/http'
 require 'nexmo/json'
 require 'nexmo/jwt'
 require 'nexmo/signature'
 require 'nexmo/user_agent'
 require 'nexmo/entity'
 require 'nexmo/keys'
+require 'nexmo/problem'
 require 'nexmo/errors/error'
 require 'nexmo/errors/client_error'
 require 'nexmo/errors/server_error'

data/lib/nexmo/authentication/abstract.rb

@@ -1,5 +1,5 @@
 module Nexmo
-  class AbstractAuthentication
+  class AbstractAuthentication # :nodoc:
     def initialize(client)
       @client = client
     end

data/lib/nexmo/authentication/basic.rb

@@ -1,5 +1,5 @@
 module Nexmo
-  class Basic < AbstractAuthentication
+  class Basic < AbstractAuthentication # :nodoc:
     def update(object)
       return unless object.is_a?(Net::HTTPRequest)
 

data/lib/nexmo/authentication/bearer_token.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class BearerToken < AbstractAuthentication
+  class BearerToken < AbstractAuthentication # :nodoc:
     def update(object)
       return unless object.is_a?(Net::HTTPRequest)
 

data/lib/nexmo/authentication/key_secret_params.rb

@@ -1,5 +1,5 @@
 module Nexmo
-  class KeySecretParams < AbstractAuthentication
+  class KeySecretParams < AbstractAuthentication # :nodoc:
     def update(object)
       return unless object.is_a?(Hash)
 

data/lib/nexmo/authentication/key_secret_query.rb

@@ -1,5 +1,5 @@
 module Nexmo
-  class KeySecretQuery < AbstractAuthentication
+  class KeySecretQuery < AbstractAuthentication # :nodoc:
     def update(object)
       return unless object.is_a?(URI)
 

data/lib/nexmo/client.rb

@@ -25,9 +25,17 @@ module Nexmo
 
       @user_agent = UserAgent.string(options[:app_name], options[:app_version])
 
+      self.http_options = options[:http]
+
       self.logger = options[:logger] || (defined?(Rails.logger) && Rails.logger)
     end
 
+    attr_reader :http_options
+
+    def http_options=(hash)
+      @http_options = HTTP::Options.new(hash)
+    end
+
     def logger
       @logger
     end

data/lib/nexmo/errors/error.rb

@@ -1,4 +1,31 @@
+# frozen_string_literal: true
+require 'json'
+
 module Nexmo
   class Error < StandardError
+    def self.parse(response) # :nodoc:
+      exception_class = case response
+        when Net::HTTPUnauthorized
+          AuthenticationError
+        when Net::HTTPClientError
+          ClientError
+        when Net::HTTPServerError
+          ServerError
+        else
+          Error
+        end
+
+      message = if content_type = response['Content-Type']
+        case content_type.split(';').first
+        when 'application/problem+json'
+          Problem.parse(response.body)
+        when 'application/json'
+          hash = ::JSON.parse(response.body)
+          hash['error_title']
+        end
+      end
+
+      exception_class.new(message)
+    end
   end
 end

data/lib/nexmo/form_data.rb

@@ -1,5 +1,5 @@
 module Nexmo
-  module FormData
+  module FormData # :nodoc:
     def self.update(http_request, params)
       http_request.form_data = params
     end

data/lib/nexmo/http.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'net/http'
+
+module Nexmo
+  module HTTP # :nodoc:
+    class Options
+      def initialize(hash)
+        @hash = hash || {}
+
+        @hash.each_key do |name|
+          next if defined_options.key?(name)
+
+          raise ArgumentError, "#{name.inspect} is not a valid option"
+        end
+      end
+
+      def set(http)
+        @hash.each do |name, value|
+          http.public_send(defined_options.fetch(name), value)
+        end
+      end
+
+      private
+
+      def defined_options
+        @defined_options ||= Net::HTTP.instance_methods.grep(/\w=\z/).each_with_object({}) do |name, hash|
+          hash[name.to_s.chomp('=').to_sym] = name
+        end
+      end
+    end
+  end
+end

data/lib/nexmo/json.rb

@@ -2,7 +2,7 @@
 require 'json'
 
 module Nexmo
-  module JSON
+  module JSON # :nodoc:
     def self.update(http_request, params)
       http_request['Content-Type'] = 'application/json'
       http_request.body = ::JSON.generate(params)

data/lib/nexmo/keys.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  module Keys
+  module Keys # :nodoc:
     if {}.respond_to?(:transform_keys)
       def hyphenate(hash)
         hash.transform_keys { |k| hyphenate_key(k) }

data/lib/nexmo/logger.rb

@@ -3,7 +3,7 @@ require 'logger'
 require 'forwardable'
 
 module Nexmo
-  class Logger
+  class Logger # :nodoc:
     def initialize(logger)
       @logger = logger || ::Logger.new(nil)
     end

data/lib/nexmo/namespace.rb

@@ -3,7 +3,7 @@ require 'net/http'
 require 'json'
 
 module Nexmo
-  class Namespace
+  class Namespace # :nodoc:
     def initialize(client)
       @client = client
 
@@ -11,8 +11,10 @@ module Nexmo
 
       @host = self.class.host
 
-      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port)
+      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
       @http.use_ssl = true
+
+      @client.http_options.set(@http)
     end
 
     def self.host
@@ -91,14 +93,8 @@ module Nexmo
         else
           response
         end
-      when Net::HTTPUnauthorized
-        raise AuthenticationError
-      when Net::HTTPClientError
-        raise ClientError
-      when Net::HTTPServerError
-        raise ServerError
       else
-        raise Error
+        Error.parse(response)
       end
     end
   end

data/lib/nexmo/params.rb

@@ -2,7 +2,7 @@
 require 'cgi'
 
 module Nexmo
-  module Params
+  module Params # :nodoc:
     def self.encode(params)
       params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
     end

data/lib/nexmo/problem.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'json'
+
+module Nexmo
+  module Problem # :nodoc:
+    extend self
+
+    def parse(body)
+      problem = ::JSON.parse(body)
+
+      title = problem['title']
+
+      detail = problem['detail']
+
+      url = problem['type']
+
+      "#{title}. #{detail} See #{url} for more info, or email support@nexmo.com if you have any questions."
+    end
+  end
+end

data/lib/nexmo/user_agent.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  module UserAgent
+  module UserAgent # :nodoc:
     def self.string(app_name, app_version)
       identifiers = []
       identifiers << 'nexmo-ruby/' + VERSION

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '5.4.0'
+  VERSION = '5.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -97,6 +97,7 @@ files:
 - lib/nexmo/errors/server_error.rb
 - lib/nexmo/files.rb
 - lib/nexmo/form_data.rb
+- lib/nexmo/http.rb
 - lib/nexmo/json.rb
 - lib/nexmo/jwt.rb
 - lib/nexmo/keys.rb
@@ -108,6 +109,7 @@ files:
 - lib/nexmo/params.rb
 - lib/nexmo/pricing.rb
 - lib/nexmo/pricing_types.rb
+- lib/nexmo/problem.rb
 - lib/nexmo/redact.rb
 - lib/nexmo/secrets.rb
 - lib/nexmo/signature.rb