nexmo 6.1.0 → 7.1.1

data/lib/nexmo/json.rb

@@ -1,8 +1,12 @@
+# typed: strict
 # frozen_string_literal: true
 require 'json'
 
 module Nexmo
   module JSON
+    extend T::Sig
+
+    sig { params(http_request: T.any(Net::HTTP::Put, Net::HTTP::Post), params: T::Hash[Symbol, T.untyped]).void }
     def self.update(http_request, params)
       http_request['Content-Type'] = 'application/json'
       http_request.body = ::JSON.generate(params)

data/lib/nexmo/jwt.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 require 'securerandom'
 require 'openssl'
@@ -5,6 +6,8 @@ require 'jwt'
 
 module Nexmo
   module JWT
+    extend T::Sig
+
     # Generate an encoded JSON Web Token.
     #
     # By default the Nexmo Ruby SDK generates a short lived JWT per request.
@@ -30,9 +33,10 @@ module Nexmo
     #
     # @return [String]
     #
+    sig { params(payload: T::Hash[T.any(Symbol, String), T.any(String, Integer)], private_key: T.any(OpenSSL::PKey::RSA, String)).returns(String) }
     def self.generate(payload, private_key)
       payload[:iat] = iat = Time.now.to_i unless payload.key?(:iat) || payload.key?('iat')
-      payload[:exp] = iat + 60 unless payload.key?(:exp) || payload.key?('exp')
+      payload[:exp] = T.must(iat) + 60 unless payload.key?(:exp) || payload.key?('exp')
       payload[:jti] = SecureRandom.uuid unless payload.key?(:jti) || payload.key?('jti')
 
       private_key = OpenSSL::PKey::RSA.new(private_key) unless private_key.respond_to?(:sign)

data/lib/nexmo/key_secret_params.rb

@@ -1,10 +1,18 @@
+# typed: strict
+
 module Nexmo
   class KeySecretParams < AbstractAuthentication
+    extend T::Sig
+
+    sig { params(
+      object: T.any(T::Hash[T.untyped, T.untyped], URI::HTTPS, Net::HTTP::Post, Net::HTTP::Get)
+    ).void }
     def update(object)
       return unless object.is_a?(Hash)
 
-      object[:api_key] = @config.api_key
-      object[:api_secret] = @config.api_secret
+      @config = T.let(@config, T.nilable(Nexmo::Config))
+      object[:api_key] = T.must(@config).api_key
+      object[:api_secret] = T.must(@config).api_secret
     end
   end
 

data/lib/nexmo/keys.rb

@@ -1,16 +1,21 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   module Keys
+    extend T::Sig
+
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T::Hash[String, T.untyped]) }
     def hyphenate(hash)
       hash.transform_keys { |k| k.to_s.tr('_', '-') }
     end
 
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T::Hash[String, T.untyped]) }
     def camelcase(hash)
       hash.transform_keys { |k| k.to_s.gsub(/_(\w)/) { $1.upcase } }
     end
 
-    ATTRIBUTE_KEYS = Hash.new { |h, k| h[k] = k.split(PATTERN).join('_').downcase.to_sym }
+    ATTRIBUTE_KEYS = T.let(Hash.new { |h, k| h[k] = k.split(PATTERN).join('_').downcase.to_sym }, T::Hash[T.untyped, T.untyped])
 
     PATTERN = /[\-_]|(?<=\w)(?=[A-Z])/
 
@@ -18,6 +23,7 @@ module Nexmo
 
     private_constant :PATTERN
 
+    sig { params(k: T.any(Symbol, String)).returns(Symbol) }
     def attribute_key(k)
       return k if k.is_a?(Symbol)
 

data/lib/nexmo/logger.rb

@@ -1,9 +1,13 @@
+# typed: false
 # frozen_string_literal: true
 require 'logger'
 require 'forwardable'
 
 module Nexmo
   class Logger
+    extend T::Sig
+
+    sig { params(logger: T.nilable(T.any(::Logger, Nexmo::Logger))).void }
     def initialize(logger)
       @logger = logger || ::Logger.new(nil)
     end
@@ -14,8 +18,11 @@ module Nexmo
       def_delegator :@logger, name, name
     end
 
+    sig { params(request: T.any(Net::HTTP::Post, Net::HTTP::Get, Net::HTTP::Delete, Net::HTTP::Put)).void }
     def log_request_info(request)
-      info do
+      @logger = T.let(@logger, T.nilable(T.any(::Logger, Nexmo::Logger)))
+
+      T.must(@logger).info do
         format('Nexmo API request', {
           method: request.method,
           path: request.uri.path
@@ -23,8 +30,12 @@ module Nexmo
       end
     end
 
+    sig { params(
+      response: T.any(Net::HTTPOK, Net::HTTPNoContent, Net::HTTPBadRequest, Net::HTTPInternalServerError, Net::HTTPResponse),
+      host: String
+    ).void }
     def log_response_info(response, host)
-      info do
+      T.must(@logger).info do
         format('Nexmo API response', {
           host: host,
           status: response.code,
@@ -37,6 +48,7 @@ module Nexmo
 
     private
 
+    sig { params(message: String, hash: T::Hash[Symbol, T.untyped]).returns(String) }
     def format(message, hash)
       return message if hash.nil?
 
@@ -45,6 +57,4 @@ module Nexmo
       fields.join(' ')
     end
   end
-
-  private_constant :Logger
 end

data/lib/nexmo/messages.rb

@@ -1,17 +1,23 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Messages < Namespace
-    self.host = 'rest.nexmo.com'
+    extend T::Sig
 
+    self.host = :rest_host
+
+    sig { params(id: String).returns(Nexmo::Response) }
     def get(id)
       request('/search/message', params: {id: id})
     end
 
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def search(params)
       request('/search/messages', params: params)
     end
 
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def rejections(params)
       request('/search/rejections', params: params)
     end

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.
     #
@@ -14,11 +15,16 @@ module Nexmo
     #     puts "#{item.msisdn} #{item.country} #{item.type}"
     #   end
     #
-    # @option params [Integer] :index
-    #   Page index.
+    # @option params [String] :application_id
+    #   The application that you want to return the numbers for.
     #
-    # @option params [Integer] :size
-    #   Page size.
+    # @option params [Boolean] :has_application
+    #   Set this optional field to `true` to restrict your results to numbers associated with an application (any application).
+    #   Set to `false` to find all numbers not associated with any application.
+    #   Omit the field to avoid filtering on whether or not the number is assigned to an application.
+    #
+    # @option params [String] :country
+    #   The two character country code to filter on (in ISO 3166-1 alpha-2 format).
     #
     # @option params [String] :pattern
     #   The number pattern you want to search for. Use in conjunction with **:search_pattern**.
@@ -29,13 +35,11 @@ module Nexmo
     #   - `1` - Search for numbers that contain **:pattern**
     #   - `2` - Search for numbers that end with **:pattern**
     #
-    # @option params [Boolean] :has_application
-    #   Set this optional field to `true` to restrict your results to numbers associated with an application (any application).
-    #   Set to `false` to find all numbers not associated with any application.
-    #   Omit the field to avoid filtering on whether or not the number is assigned to an application.
+    # @option params [Integer] :size
+    #   Page size.
     #
-    # @option params [String] :application_id
-    #   The application that you want to return the numbers for.
+    # @option params [Integer] :index
+    #   Page index.
     #
     # @param [Hash] params
     #
@@ -102,6 +106,10 @@ module Nexmo
     # @option params [required, String] :msisdn
     #   An available inbound virtual number.
     #
+    # @option params [String] :target_api_key
+    #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
+    #   If you'd like to perform an action on your own account, you do not need to provide this field.
+    #
     # @param [Hash] params
     #
     # @return [Response]
@@ -123,6 +131,10 @@ module Nexmo
     # @option params [required, String] :msisdn
     #   An available inbound virtual number.
     #
+    # @option params [String] :target_api_key
+    #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
+    #   If you'd like to perform an action on your own account, you do not need to provide this field.
+    #
     # @param [Hash] params
     #
     # @return [Response]
@@ -160,16 +172,8 @@ module Nexmo
     # @option params [String] :mo_smpp_sys_type
     #   The associated system type for your SMPP client.
     #
-    # @option params [String] :messages_callback_type
-    #   The SMS webhook type (always `app`).
-    #   Must be used with the **:messages_callback_value** option.
-    #
-    # @option params [String] :messages_callback_value
-    #   A Nexmo Application ID.
-    #   Must be used with the **:messages_callback_type** option.
-    #
     # @option params [String] :voice_callback_type
-    #   The voice webhook type.
+    #   Specify whether inbound voice calls on your number are handled by your Application configuration, or forwarded to a SIP or a telephone number.
     #   Must be used with the **:voice_callback_value** option.
     #
     # @option params [String] :voice_callback_value

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,8 +1,9 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
   class Redact < Namespace
-    self.authentication = KeySecretQuery
+    self.authentication = Basic
 
     self.request_body = JSON