nexmo 6.2.0 → 7.1.2

data/lib/nexmo/namespace.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 # frozen_string_literal: true
 require 'net/http'
 require 'json'
@@ -7,9 +8,7 @@ module Nexmo
     def initialize(config)
       @config = config
 
-      @logger = config.logger
-
-      @host = self.class.host
+      @host = self.class.host == :api_host ? @config.api_host : @config.rest_host
 
       @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
       @http.use_ssl = true
@@ -18,10 +17,12 @@ module Nexmo
     end
 
     def self.host
-      @host ||= 'api.nexmo.com'
+      @host ||= :api_host
     end
 
     def self.host=(host)
+      raise ArgumentError unless host == :rest_host
+
       @host = host
     end
 
@@ -45,22 +46,14 @@ module Nexmo
       @request_headers ||= {}
     end
 
-    def self.response_class
-      @response_class ||= Response
-    end
-
-    def self.response_class=(response_class)
-      @response_class = response_class
-    end
-
-    private
+    protected
 
     Get = Net::HTTP::Get
     Put = Net::HTTP::Put
     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 ||= {}
@@ -86,17 +79,17 @@ module Nexmo
 
       self.class.request_body.update(message, params) if type::REQUEST_HAS_BODY
 
-      @logger.log_request_info(message)
+      logger.log_request_info(message)
 
       response = @http.request(message, &block)
 
-      @logger.log_response_info(response, @host)
+      logger.log_response_info(response, @host)
 
       return if block
 
-      @logger.debug(response.body) if response.body
+      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)
@@ -115,6 +108,10 @@ module Nexmo
         raise Errors.parse(response)
       end
     end
+
+    def logger
+      @config.logger
+    end
   end
 
   private_constant :Namespace

data/lib/nexmo/number_insight.rb

@@ -1,9 +1,8 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
   class NumberInsight < Namespace
-    self.response_class = Response
-
     # Provides basic number insight information about a number.
     #
     # @example
@@ -24,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.
@@ -52,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.
@@ -84,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.
@@ -119,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/numbers.rb

@@ -1,10 +1,11 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
   class Numbers < Namespace
     include Keys
 
-    self.host = 'rest.nexmo.com'
+    self.host = :rest_host
 
     # Retrieve all the inbound numbers associated with your Nexmo account.
     #

data/lib/nexmo/numbers/list_response.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 class Nexmo::Numbers::ListResponse < Nexmo::Response
   include Enumerable
 

data/lib/nexmo/numbers/response.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 class Nexmo::Numbers::Response < Nexmo::Response

data/lib/nexmo/params.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 # frozen_string_literal: true
 require 'cgi'
 

data/lib/nexmo/pricing.rb

@@ -1,8 +1,9 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
   class Pricing < Namespace
-    self.host = 'rest.nexmo.com'
+    self.host = :rest_host
 
     def initialize(config, type: nil)
       raise ArgumentError if type.nil?

data/lib/nexmo/pricing_types.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/redact.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/response.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Nexmo
   class Response
     def initialize(entity=nil, http_response=nil)

data/lib/nexmo/secrets.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/secrets/list_response.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 class Nexmo::Secrets::ListResponse < Nexmo::Response
   include Enumerable
 

data/lib/nexmo/server_error.rb

@@ -1,3 +1,5 @@
+# typed: strong
+
 module Nexmo
   class ServerError < Error
   end

data/lib/nexmo/signature.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 require 'openssl'
 require 'digest/md5'

data/lib/nexmo/sms.rb

@@ -1,21 +1,19 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class SMS < Namespace
+    extend T::Sig
     include Keys
 
-    self.host = 'rest.nexmo.com'
+    self.host = :rest_host
 
     # Send an outbound SMS from your Nexmo account.
     #
     # @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.
@@ -94,22 +92,30 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms#send-an-sms
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def send(params)
-      if unicode?(params[:text]) && params[:type] != 'unicode'
+      if unicode?(params.fetch(:text)) && params[:type] != 'unicode'
         message = 'Sending unicode text SMS without setting the type parameter to "unicode". ' \
           'See https://developer.nexmo.com/messaging/sms for details, ' \
           'or email support@nexmo.com if you have any questions.'
 
-        @logger.warn(message)
+        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
 
+    sig { params(text: String).returns(T::Boolean) }
     def unicode?(text)
-      !GSM7.encoded?(text)
+      !Nexmo::GSM7.encoded?(text)
     end
   end
 end

data/lib/nexmo/tfa.rb

@@ -1,10 +1,11 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
   class TFA < Namespace
     include Keys
 
-    self.host = 'rest.nexmo.com'
+    self.host = :rest_host
 
     def send(params)
       request('/sc/us/2fa/json', params: hyphenate(params), type: Post)

data/lib/nexmo/user_agent.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/verify.rb

@@ -1,13 +1,13 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Verify < Namespace
+    extend T::Sig
     alias_method :http_request, :request
 
     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.
@@ -15,11 +15,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.
@@ -64,8 +60,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyRequest
     #
-    def request(params)
-      http_request('/verify/json', params: params, type: Post)
+    sig { params(params: T.untyped, uri: T.untyped).returns(T.untyped) }
+    def request(params, uri = '/verify/json')
+      response = http_request(uri, 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.
@@ -73,11 +74,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.
@@ -96,8 +93,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyCheck
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     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.
@@ -118,8 +120,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifySearch
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(T.any(T::Hash[Symbol, T.untyped], Nexmo::Response)) }
     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.
@@ -140,8 +147,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
     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.
@@ -155,6 +167,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def cancel(id)
       control(request_id: id, cmd: 'cancel')
     end
@@ -170,8 +183,71 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def trigger_next_event(id)
       control(request_id: id, cmd: 'trigger_next_event')
     end
+
+    # Send a PSD2-compliant payment token to a user for payment authorization
+    #
+    # @example
+    #   response = client.verify.psd2(number: '447700900000', payee: 'Acme Inc', amount: 48.00)
+    #
+    # @option params [required, String] :number
+    #   The mobile or landline phone number to verify.
+    #   Unless you are setting **:country** explicitly, this number must be in E.164 format.
+    #
+    # @option params [String] :country
+    #   If you do not provide **:number** in international format or you are not sure if **:number** is correctly formatted, specify the two-character country code in **:country**.
+    #   Verify will then format the number for you.
+    #
+    # @option params [required, String] :payee
+    #   An alphanumeric string to indicate to the user the name of the recipient that they are confirming a payment to.
+    #
+    # @option params [required, Float] :amount
+    #   The decimal amount of the payment to be confirmed, in Euros
+    #
+    # @option params [Integer] :code_length
+    #   The length of the verification code.
+    #
+    # @option params [String] :lg
+    #   By default, the SMS or text-to-speech (TTS) message is generated in the locale that matches the **:number**.
+    #   For example, the text message or TTS message for a `33*` number is sent in French.
+    #   Use this parameter to explicitly control the language, accent and gender used for the Verify request.
+    #
+    # @option params [Integer] :pin_expiry
+    #   How log the generated verification code is valid for, in seconds.
+    #   When you specify both **:pin_expiry** and **:next_event_wait** then **:pin_expiry** must be an integer multiple of **:next_event_wait** otherwise **:pin_expiry** is defaulted to equal **:next_event_wait**.
+    #   See [changing the event timings](https://developer.nexmo.com/verify/guides/changing-default-timings).
+    #
+    # @option params [Integer] :next_event_wait
+    #   Specifies the wait time in seconds between attempts to deliver the verification code.
+    #
+    # @option params [Integer] :workflow_id
+    #   Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.
+    #   For example, an id of 1 identifies the workflow SMS - TTS - TTS.
+    #   For a list of all workflows and their associated ids, please visit the [developer portal](https://developer.nexmo.com/verify/guides/workflows-and-events).
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/verify#verifyRequestWithPSD2
+    #
+    sig { params(params: T.untyped, uri: T.untyped).returns(T.any(Nexmo::Error, Nexmo::Response)) }
+    def psd2(params, uri = '/verify/psd2/json')
+      response = http_request(uri, params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
+    end
+
+    private
+
+    sig { params(response: T.untyped).returns(T::Boolean) }
+    def error?(response)
+      response.respond_to?(:error_text)
+    end
   end
 end