nexmo 6.3.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 431850b9568a3bacf15de1cf1f31883616451e0fdd49283e9f78deb76cf74ba9
-  data.tar.gz: 8d3c2e1314efd2235abb2e3b243367fa715eb9d568048178f8d86e7455ed2abd
+  metadata.gz: c11d202ac7a62f8ee5ae904f0a3c3edfd92d9d04899b747f8369811ca140d6d3
+  data.tar.gz: 595afbed12c7c0e2bda951059beac3f904ded148a229b2d1eec84996c5a9c736
 SHA512:
-  metadata.gz: c27cf8e95a1793a0c16f5787a9c9fe0063dfdd245e1bb8f162c8195f051f7b3ccbdec407f879e0ff7084c55f7a46ccf8932249255edfa4bb22c30384380cf587
-  data.tar.gz: e5d15599fb9f691337d053f76d2c74e498744787e98890256fab12bfa4f681105e9ca932397af14cb034b33cd379065a66d0f80f1ce23a4c2d1bc1fe4df63db3
+  metadata.gz: c0bb244ff331d3faa4eec0b79b173e8829aead849682ad508bb9c152be677276387db0d602a801f09c7c5237699d00c43ac65021ba2b9f8d8ee0f5c096c9b5d1
+  data.tar.gz: 527352b2f4a00c318a39f234182f240b7955018b75882ed084809ef5b3a245b202036d94dad8c210e50512f7a08b6b71fd41faec3fa9f8ee2b7e830ee9a4c265

data/README.md

@@ -2,15 +2,18 @@
 
 [![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) [![Coverage Status](https://coveralls.io/repos/github/Nexmo/nexmo-ruby/badge.svg?branch=coveralls)](https://coveralls.io/github/Nexmo/nexmo-ruby?branch=master)
 
+<img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" />
+
 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)
-* [Logging](#logging)
-* [JWT authentication](#jwt-authentication)
-* [Webhook signatures](#webhook-signatures)
+    * [Logging](#logging)
+    * [Overriding the default hosts](#overriding-the-default-hosts)
+    * [JWT authentication](#jwt-authentication)
+    * [Webhook signatures](#webhook-signatures)
 * [Documentation](#documentation)
 * [License](#license)
 
@@ -73,6 +76,21 @@ By default the library sets the logger to `Rails.logger` if it is defined.
 To disable logging set the logger to `nil`.
 
 
+## Overriding the default hosts
+
+To override the default hosts that the SDK uses for HTTP requests, you need to
+specify the `api_host`, `rest_host` or both in the client configuration. For example:
+
+```ruby
+client = Nexmo::Client.new(
+  api_host: 'api-sg-1.nexmo.com',
+  rest_host: 'rest-sg-1.nexmo.com'
+)
+```
+
+By default the hosts are set to `api.nexmo.com` and `rest.nexmo.com`, respectively.
+
+
 ## JWT authentication
 
 To call newer endpoints that support JWT authentication such as the Voice API you'll

data/lib/nexmo/account.rb

@@ -1,8 +1,9 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Account < Namespace
+    extend T::Sig
     include Keys
 
     self.host = :rest_host
@@ -13,6 +14,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/developer/account#get-balance
     #
+    sig { returns(Nexmo::Response) }
     def balance
       request('/account/get-balance')
     end
@@ -35,6 +37,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/developer/account#settings
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def update(params)
       request('/account/settings', params: camelcase(params), type: Post)
     end
@@ -50,6 +53,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/developer/account#top-up
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def topup(params)
       request('/account/top-up', params: params, type: Post)
     end

data/lib/nexmo/alerts.rb

@@ -1,8 +1,9 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Alerts < Namespace
+    extend T::Sig
     self.host = :rest_host
 
     # Request the list of phone numbers opted out from your campaign.
@@ -11,6 +12,7 @@ module Nexmo
     #
     # @return [Response]
     #
+    sig { returns(Nexmo::Response) }
     def list
       request('/sc/us/alert/opt-in/query/json')
     end
@@ -26,6 +28,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def remove(params)
       request('/sc/us/alert/opt-in/manage/json', params: params, type: Post)
     end
@@ -61,6 +64,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/sending
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def send(params)
       request('/sc/us/alert/json', params: params, type: Post)
     end

data/lib/nexmo/client.rb

@@ -32,12 +32,6 @@ module Nexmo
       @applications ||= Applications.new(config)
     end
 
-    # @return [Calls]
-    #
-    def calls
-      @calls ||= Calls.new(config)
-    end
-
     # @return [Conversations]
     #
     def conversations
@@ -109,5 +103,11 @@ module Nexmo
     def verify
       @verify ||= Verify.new(config)
     end
+
+    # @return [Voice]
+    #
+    def voice
+      @voice ||= Voice.new(config)
+    end
   end
 end

data/lib/nexmo/config.rb

@@ -8,9 +8,9 @@ module Nexmo
       self.api_host = 'api.nexmo.com'
       self.api_key = ENV['NEXMO_API_KEY']
       self.api_secret = ENV['NEXMO_API_SECRET']
-      self.application_id = nil
+      self.application_id = ENV['NEXMO_APPLICATION_ID']
       self.logger = (defined?(Rails.logger) && Rails.logger) || ::Logger.new(nil)
-      self.private_key = nil
+      self.private_key = ENV['NEXMO_PRIVATE_KEY_PATH'] ? File.read(ENV['NEXMO_PRIVATE_KEY_PATH']) : ENV['NEXMO_PRIVATE_KEY']
       self.rest_host = 'rest.nexmo.com'
       self.signature_secret = ENV['NEXMO_SIGNATURE_SECRET']
       self.signature_method = ENV['NEXMO_SIGNATURE_METHOD'] || 'md5hash'

data/lib/nexmo/errors.rb

@@ -21,6 +21,8 @@ module Nexmo
 
         if hash.key?('error_title')
           hash['error_title']
+        elsif hash.key?('error-code-label')
+          hash['error-code-label']
         elsif hash.key?('description')
           hash['description']
         elsif problem_details?(hash)

data/lib/nexmo/namespace.rb

@@ -46,14 +46,6 @@ module Nexmo
       @request_headers ||= {}
     end
 
-    def self.response_class
-      @response_class ||= Response
-    end
-
-    def self.response_class=(response_class)
-      @response_class = response_class
-    end
-
     protected
 
     Get = Net::HTTP::Get
@@ -61,7 +53,7 @@ module Nexmo
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def request(path, params: nil, type: Get, response_class: nil, &block)
+    def request(path, params: nil, type: Get, response_class: Response, &block)
       uri = URI('https://' + @host + path)
 
       params ||= {}
@@ -97,7 +89,7 @@ module Nexmo
 
       logger.debug(response.body) if response.body
 
-      parse(response, response_class || self.class.response_class)
+      parse(response, response_class)
     end
 
     def parse(response, response_class)

data/lib/nexmo/number_insight.rb

@@ -3,8 +3,6 @@
 
 module Nexmo
   class NumberInsight < Namespace
-    self.response_class = Response
-
     # Provides basic number insight information about a number.
     #
     # @example
@@ -25,7 +23,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightBasic
     #
     def basic(params)
-      request('/ni/basic/json', params: params)
+      response = request('/ni/basic/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
 
     # Provides standard number insight information about a number.
@@ -53,7 +55,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightStandard
     #
     def standard(params)
-      request('/ni/standard/json', params: params)
+      response = request('/ni/standard/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
 
     # Provides advanced number insight information about a number synchronously.
@@ -85,7 +91,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAdvanced
     #
     def advanced(params)
-      request('/ni/advanced/json', params: params)
+      response = request('/ni/advanced/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
 
     # Provides advanced number insight number information *asynchronously* using the URL specified in the callback parameter.
@@ -120,7 +130,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAsync
     #
     def advanced_async(params)
-      request('/ni/advanced/async/json', params: params)
+      response = request('/ni/advanced/async/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
   end
 end

data/lib/nexmo/sms.rb

@@ -13,11 +13,7 @@ module Nexmo
     # @example
     #   response = client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')
     #
-    #   if response.success?
-    #     puts "Sent message id=#{response.messages.first.message_id}"
-    #   else
-    #     puts "Error: #{response.messages.first.error_text}"
-    #   end
+    #   puts "Sent message id=#{response.messages.first.message_id}"
     #
     # @option params [required, String] :from
     #   The name or number the message should be sent from.
@@ -96,7 +92,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms#send-an-sms
     #
-    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::SMS::Response) }
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def send(params)
       if unicode?(params.fetch(:text)) && params[:type] != 'unicode'
         message = 'Sending unicode text SMS without setting the type parameter to "unicode". ' \
@@ -106,7 +102,13 @@ module Nexmo
         logger.warn(message)
       end
 
-      request('/sms/json', params: hyphenate(params), type: Post, response_class: Response)
+      response = request('/sms/json', params: hyphenate(params), type: Post)
+
+      unless response.messages.first.status == '0'
+        raise Error, response.messages.first[:error_text]
+      end
+
+      response
     end
 
     private

data/lib/nexmo/verify.rb

@@ -7,8 +7,6 @@ module Nexmo
 
     private :http_request
 
-    self.response_class = Response
-
     # Generate and send a PIN to your user.
     #
     # @note You can make a maximum of one Verify request per second.
@@ -16,11 +14,7 @@ module Nexmo
     # @example
     #   response = client.verify.request(number: '447700900000', brand: 'Acme Inc')
     #
-    #   if response.success?
-    #     puts "Started verification request_id=#{response.request_id}"
-    #   else
-    #     puts "Error: #{response.error_text}"
-    #   end
+    #   puts "Started verification request_id=#{response.request_id}"
     #
     # @option params [required, String] :number
     #   The mobile or landline phone number to verify.
@@ -66,7 +60,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/verify#verifyRequest
     #
     def request(params)
-      http_request('/verify/json', params: params, type: Post)
+      response = http_request('/verify/json', params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Confirm that the PIN you received from your user matches the one sent by Nexmo in your verification request.
@@ -74,11 +72,7 @@ module Nexmo
     # @example
     #   response = client.verify.check(request_id: request_id, code: '1234')
     #
-    #   if response.success?
-    #     puts "Verification complete, event_id=#{response.event_id}"
-    #   else
-    #     puts "Error: #{response.error_text}"
-    #   end
+    #   puts "Verification complete, event_id=#{response.event_id}"
     #
     # @option params [required, String] :request_id
     #   The Verify request to check.
@@ -98,7 +92,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/verify#verifyCheck
     #
     def check(params)
-      http_request('/verify/check/json', params: params, type: Post)
+      response = http_request('/verify/check/json', params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Check the status of past or current verification requests.
@@ -120,7 +118,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/verify#verifySearch
     #
     def search(params)
-      http_request('/verify/search/json', params: params)
+      response = http_request('/verify/search/json', params: params)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Control the progress of your verification requests.
@@ -142,7 +144,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
     def control(params)
-      http_request('/verify/control/json', params: params, type: Post)
+      response = http_request('/verify/control/json', params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Cancel an existing verification request.
@@ -174,5 +180,11 @@ module Nexmo
     def trigger_next_event(id)
       control(request_id: id, cmd: 'trigger_next_event')
     end
+
+    private
+
+    def error?(response)
+      response.respond_to?(:error_text)
+    end
   end
 end

data/lib/nexmo/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Nexmo
-  VERSION = '6.3.0'
+  VERSION = '7.0.0'
 end

data/lib/nexmo/{calls.rb → voice.rb}

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls < Namespace
+  class Voice < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -10,7 +10,7 @@ module Nexmo
     # Create an outbound Call.
     #
     # @example
-    #   response = client.calls.create({
+    #   response = client.voice.create({
     #     to: [{type: 'phone', number: '14843331234'}],
     #     from: {type: 'phone', number: '14843335555'},
     #     answer_url: ['https://example.com/answer']
@@ -61,7 +61,7 @@ module Nexmo
     # Get details of your calls.
     #
     # @example
-    #   response = client.calls.list
+    #   response = client.voice.list
     #   response.each do |item|
     #     puts "#{item.uuid} #{item.direction} #{item.status}"
     #   end
@@ -100,7 +100,7 @@ module Nexmo
     # Get detail of a specific call.
     #
     # @example
-    #   response = client.calls.get(id)
+    #   response = client.voice.get(id)
     #
     # @param [String] id
     #
@@ -115,7 +115,7 @@ module Nexmo
     # Modify an in progress call.
     #
     # @example
-    #   response = client.calls.update(id, action: 'hangup')
+    #   response = client.voice.update(id, action: 'hangup')
     #
     # @option params [required, String] :action
     #
@@ -136,7 +136,7 @@ module Nexmo
     # Hangup an in progress call.
     #
     # @example
-    #   response = client.calls.hangup(id)
+    #   response = client.voice.hangup(id)
     #
     # @param [String] id
     #
@@ -151,7 +151,7 @@ module Nexmo
     # Mute an in progress call.
     #
     # @example
-    #   response = client.calls.mute(id)
+    #   response = client.voice.mute(id)
     #
     # @param [String] id
     #
@@ -166,7 +166,7 @@ module Nexmo
     # Unmute an in progress call.
     #
     # @example
-    #   response = client.calls.unmute(id)
+    #   response = client.voice.unmute(id)
     #
     # @param [String] id
     #
@@ -181,7 +181,7 @@ module Nexmo
     # Earmuff an in progress call.
     #
     # @example
-    #   response = client.calls.earmuff(id)
+    #   response = client.voice.earmuff(id)
     #
     # @param [String] id
     #
@@ -196,7 +196,7 @@ module Nexmo
     # Unearmuff an in progress call.
     #
     # @example
-    #   response = client.calls.unearmuff(id)
+    #   response = client.voice.unearmuff(id)
     #
     # @param [String] id
     #
@@ -216,7 +216,7 @@ module Nexmo
     #     url: ['https://example.com/ncco.json']
     #   }
     #
-    #   response = client.calls.transfer(id, destination: destination)
+    #   response = client.voice.transfer(id, destination: destination)
     #
     # @param [String] id
     # @param [Hash] destination

data/lib/nexmo/{calls → voice}/dtmf.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls::DTMF < Namespace
+  class Voice::DTMF < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON

data/lib/nexmo/{calls → voice}/list_response.rb

@@ -1,6 +1,6 @@
 # typed: ignore
 
-class Nexmo::Calls::ListResponse < Nexmo::Response
+class Nexmo::Voice::ListResponse < Nexmo::Response
   include Enumerable
 
   def each

data/lib/nexmo/{calls → voice}/stream.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls::Stream < Namespace
+  class Voice::Stream < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON

data/lib/nexmo/{calls → voice}/talk.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls::Talk < Namespace
+  class Voice::Talk < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -76,11 +76,6 @@ files:
 - lib/nexmo/authentication_error.rb
 - lib/nexmo/basic.rb
 - lib/nexmo/bearer_token.rb
-- lib/nexmo/calls.rb
-- lib/nexmo/calls/dtmf.rb
-- lib/nexmo/calls/list_response.rb
-- lib/nexmo/calls/stream.rb
-- lib/nexmo/calls/talk.rb
 - lib/nexmo/client.rb
 - lib/nexmo/client_error.rb
 - lib/nexmo/config.rb
@@ -105,7 +100,6 @@ files:
 - lib/nexmo/messages.rb
 - lib/nexmo/namespace.rb
 - lib/nexmo/number_insight.rb
-- lib/nexmo/number_insight/response.rb
 - lib/nexmo/numbers.rb
 - lib/nexmo/numbers/list_response.rb
 - lib/nexmo/numbers/response.rb
@@ -119,12 +113,15 @@ files:
 - lib/nexmo/server_error.rb
 - lib/nexmo/signature.rb
 - lib/nexmo/sms.rb
-- lib/nexmo/sms/response.rb
 - lib/nexmo/tfa.rb
 - lib/nexmo/user_agent.rb
 - lib/nexmo/verify.rb
-- lib/nexmo/verify/response.rb
 - lib/nexmo/version.rb
+- lib/nexmo/voice.rb
+- lib/nexmo/voice/dtmf.rb
+- lib/nexmo/voice/list_response.rb
+- lib/nexmo/voice/stream.rb
+- lib/nexmo/voice/talk.rb
 - nexmo.gemspec
 homepage: https://github.com/Nexmo/nexmo-ruby
 licenses:
@@ -150,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
 summary: This is the Ruby client library for Nexmo's API. To use it you'll need a

data/lib/nexmo/number_insight/response.rb

@@ -1,7 +0,0 @@
-# typed: false
-
-class Nexmo::NumberInsight::Response < Nexmo::Response
-  def success?
-    status.zero?
-  end
-end

data/lib/nexmo/sms/response.rb

@@ -1,8 +0,0 @@
-# typed: false
-# frozen_string_literal: true
-
-class Nexmo::SMS::Response < Nexmo::Response
-  def success?
-    messages.all? { |item| item.status == '0' }
-  end
-end

data/lib/nexmo/verify/response.rb

@@ -1,7 +0,0 @@
-# typed: false
-
-class Nexmo::Verify::Response < Nexmo::Response
-  def success?
-    respond_to?(:status) && !respond_to?(:error_text)
-  end
-end