nexmo 6.1.0 → 7.1.1

data/lib/nexmo/client_error.rb

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

data/lib/nexmo/config.rb

@@ -1,23 +1,30 @@
+# typed: false
 # frozen_string_literal: true
 require 'logger'
 
 module Nexmo
   class Config
+    extend T::Sig
+
+    sig { void }
     def initialize
-      self.api_key = ENV['NEXMO_API_KEY']
-      self.api_secret = ENV['NEXMO_API_SECRET']
-      self.application_id = nil
-      self.logger = (defined?(Rails.logger) && Rails.logger) || ::Logger.new(nil)
-      self.private_key = nil
+      self.api_host = 'api.nexmo.com'
+      self.api_key = T.let(ENV['NEXMO_API_KEY'], T.nilable(String))
+      self.api_secret = T.let(ENV['NEXMO_API_SECRET'], T.nilable(String))
+      self.application_id = ENV['NEXMO_APPLICATION_ID']
+      self.logger = (defined?(Rails.logger) && Rails.logger) || Nexmo::Logger.new(nil)
+      self.private_key = ENV['NEXMO_PRIVATE_KEY_PATH'] ? File.read(T.must(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'
-      self.token = nil
+      self.token = T.let(nil, T.nilable(String))
     end
 
     # Merges the config with the given options hash.
     #
     # @return [Nexmo::Config]
     #
+    sig { params(options: T.nilable(T::Hash[Symbol, T.untyped])).returns(Nexmo::Config) }
     def merge(options)
       return self if options.nil? || options.empty?
 
@@ -26,13 +33,18 @@ module Nexmo
       end
     end
 
+    sig { returns(String) }
+    attr_accessor :api_host
+
     # Returns the value of attribute api_key.
     #
     # @return [String]
     #
     # @raise [AuthenticationError]
     #
+    sig { returns(T.nilable(String)) }
     def api_key
+      @api_key = T.let(@api_key, T.nilable(String))
       unless @api_key
         raise AuthenticationError.new('No API key provided. ' \
           'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
@@ -42,6 +54,7 @@ module Nexmo
       @api_key
     end
 
+    sig { params(api_key: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :api_key
 
     # Returns the value of attribute api_secret.
@@ -50,7 +63,9 @@ module Nexmo
     #
     # @raise [AuthenticationError]
     #
+    sig { returns(T.nilable(String)) }
     def api_secret
+      @api_secret = T.let(@api_secret, T.nilable(String))
       unless @api_secret
         raise AuthenticationError.new('No API secret provided. ' \
           'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
@@ -60,6 +75,7 @@ module Nexmo
       @api_secret
     end
 
+    sig { params(api_secret: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :api_secret
 
     # Returns the value of attribute application_id.
@@ -68,7 +84,9 @@ module Nexmo
     #
     # @raise [AuthenticationError]
     #
+    sig { returns(T.nilable(String)) }
     def application_id
+      @application_id = T.let(@application_id, T.nilable(String))
       unless @application_id
         raise AuthenticationError.new('No application_id provided. ' \
           'Either provide an application_id, or set an auth token. ' \
@@ -80,32 +98,40 @@ module Nexmo
       @application_id
     end
 
+    sig { params(application_id: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :application_id
 
+    sig { returns(T.nilable(String)) }
     attr_accessor :app_name
 
+    sig { returns(T.nilable(String)) }
     attr_accessor :app_version
 
     # Returns the value of attribute http.
     #
     # @return [Nexmo::HTTP::Options]
     #
+    sig { returns(T.nilable(Nexmo::HTTP::Options)) }
     attr_reader :http
 
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T.nilable(Nexmo::HTTP::Options)) }
     def http=(hash)
-      @http = HTTP::Options.new(hash)
+      @http = T.let(nil, T.nilable(Nexmo::HTTP::Options))
+      @http = Nexmo::HTTP::Options.new(hash)
     end
 
     # Returns the value of attribute logger.
     #
     # @return [Nexmo::Logger]
     #
+    sig { returns(T.nilable(Nexmo::Logger)) }
     attr_reader :logger
 
     # @return [Nexmo::Logger]
     #
+    sig { params(logger: T.nilable(T.any(::Logger, Nexmo::Logger))).returns(T.nilable(Nexmo::Logger)) }
     def logger=(logger)
-      @logger = Logger.new(logger)
+      @logger = T.let(Logger.new(logger), T.nilable(Nexmo::Logger))
     end
 
     # Returns the value of attribute private_key.
@@ -114,7 +140,9 @@ module Nexmo
     #
     # @raise [AuthenticationError]
     #
+    sig { returns(T.nilable(String)) }
     def private_key
+      @private_key = T.let(@private_key, T.nilable(String))
       unless @private_key
         raise AuthenticationError.new('No private_key provided. ' \
           'Either provide a private_key, or set an auth token. ' \
@@ -126,15 +154,21 @@ module Nexmo
       @private_key
     end
 
+    sig { params(private_key: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :private_key
 
+    sig { returns(String) }
+    attr_accessor :rest_host
+
     # Returns the value of attribute signature_secret.
     #
     # @return [String]
     #
     # @raise [AuthenticationError]
     #
+    sig { returns(T.nilable(String)) }
     def signature_secret
+      @signature_secret = T.let(@signature_secret, T.nilable(String))
       unless @signature_secret
         raise AuthenticationError.new('No signature_secret provided. ' \
           'You can find your signature secret in the Nexmo dashboard. ' \
@@ -145,22 +179,28 @@ module Nexmo
       @signature_secret
     end
 
+    sig { params(signature_secret: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :signature_secret
 
+    sig { returns(String) }
     attr_accessor :signature_method
 
     # Returns the value of attribute token, or a temporary short lived token.
     #
     # @return [String]
     #
+    sig { returns(T.nilable(String)) }
     def token
-      @token || JWT.generate({application_id: application_id}, private_key)
+      @token = T.let(nil, T.nilable(String))
+      @token || JWT.generate({application_id: application_id}, T.must(private_key))
     end
 
+    sig { params(token: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :token
 
     protected
 
+    sig { params(name: Symbol, value: T.nilable(T.untyped)).void }
     def write_attribute(name, value)
       public_send(:"#{name}=", value)
     end

data/lib/nexmo/conversations.rb

@@ -1,7 +1,10 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Conversations < Namespace
+    extend T::Sig
+
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -32,6 +35,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/conversation#createConversation
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def create(params)
       request('/beta/conversations', params: params, type: Post)
     end
@@ -62,6 +66,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/conversation#replaceConversation
     #
+    sig { params(params: T.nilable(T::Hash[Symbol, T.untyped])).returns(Nexmo::Response) }
     def list(params = nil)
       request('/beta/conversations', params: params)
     end
@@ -77,6 +82,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/conversation#retrieveConversation
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def get(id)
       request('/beta/conversations/' + id)
     end
@@ -109,6 +115,10 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/conversation#replaceConversation
     #
+    sig { params(
+      id: String,
+      params: T::Hash[Symbol, T.untyped]
+    ).returns(Nexmo::Response) }
     def update(id, params)
       request('/beta/conversations/' + id, params: params, type: Put)
     end
@@ -124,6 +134,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/conversation#deleteConversation
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def delete(id)
       request('/beta/conversations/' + id, type: Delete)
     end
@@ -155,31 +166,44 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/conversation#recordConversation
     #
+    sig { params(
+      id: String,
+      params: T::Hash[Symbol, T.untyped]
+    ).returns(Nexmo::Response) }
     def record(id, params)
       request('/v1/conversations/' + id + '/record', params: params, type: Put)
     end
 
     # @return [Events]
     #
+    sig { returns(T.nilable(Nexmo::Conversations::Events)) }
     def events
+      @events = T.let(@events, T.nilable(Nexmo::Conversations::Events))
+      @config = T.let(@config, T.nilable(Nexmo::Config))
       @events ||= Events.new(@config)
     end
 
     # @return [Legs]
     #
+    sig { returns(T.nilable(Nexmo::Conversations::Legs)) }
     def legs
+      @legs = T.let(@legs, T.nilable(Nexmo::Conversations::Legs))
       @legs ||= Legs.new(@config)
     end
 
     # @return [Members]
     #
+    sig { returns(T.nilable(Nexmo::Conversations::Members)) }
     def members
+      @members = T.let(@members, T.nilable(Nexmo::Conversations::Members))
       @members ||= Members.new(@config)
     end
 
     # @return [Users]
     #
+    sig { returns(T.nilable(Nexmo::Conversations::Users)) }
     def users
+      @users = T.let(@users, T.nilable(Nexmo::Conversations::Users))
       @users ||= Users.new(@config)
     end
   end

data/lib/nexmo/conversations/events.rb

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

data/lib/nexmo/conversations/legs.rb

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

data/lib/nexmo/conversations/members.rb

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

data/lib/nexmo/conversations/users.rb

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

data/lib/nexmo/conversions.rb

@@ -1,13 +1,17 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Conversions < Namespace
+    extend T::Sig
     include Keys
 
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def track_sms(params)
       request('/conversions/sms', params: hyphenate(params), type: Post)
     end
 
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def track_voice(params)
       request('/conversions/voice', params: hyphenate(params), type: Post)
     end

data/lib/nexmo/entity.rb

@@ -1,9 +1,11 @@
+# typed: true
+
 module Nexmo
   class Entity
     include Keys
 
-    def initialize(**kwargs)
-      @attributes = kwargs
+    def initialize(attributes = nil)
+      @attributes = attributes || {}
     end
 
     def [](key)
@@ -46,4 +48,4 @@ module Nexmo
 
     include Enumerable
   end
-end
+end

data/lib/nexmo/error.rb

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

data/lib/nexmo/errors.rb

@@ -1,8 +1,12 @@
+# typed: strict
 # frozen_string_literal: true
 require 'json'
 
 module Nexmo
   module Errors
+    extend T::Sig
+
+    sig {params(response: T.any(Net::HTTPUnauthorized, Net::HTTPClientError, Net::HTTPServerError, T.untyped)).returns(Nexmo::Error)}
     def self.parse(response)
       exception_class = case response
         when Net::HTTPUnauthorized
@@ -20,6 +24,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)
@@ -30,10 +36,12 @@ module Nexmo
       exception_class.new(message)
     end
 
+    sig { params(hash: T::Hash[String, T.untyped]).returns(T::Boolean) }
     def self.problem_details?(hash)
       hash.key?('title') && hash.key?('detail') && hash.key?('type')
     end
 
+    sig { params(hash: T::Hash[String, T.untyped]).returns(String) }
     def self.problem_details_message(hash)
       "#{hash['title']}. #{hash['detail']} See #{hash['type']} for more info, or email support@nexmo.com if you have any questions."
     end

data/lib/nexmo/files.rb

@@ -1,15 +1,20 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Files < Namespace
+    extend T::Sig
+
     self.authentication = BearerToken
 
+    sig { params(id: String).returns(T.nilable(Nexmo::Response)) }
     def get(id)
-      request('/v1/files/' + id.split('/').last)
+      request('/v1/files/' + T.must(id.split('/').last))
     end
 
+    sig { params(id: String, filename: String).returns(T.nilable(Nexmo::Response)) }
     def save(id, filename)
-      request('/v1/files/' + id.split('/').last) do |response|
+      request('/v1/files/' + T.must(id.split('/').last)) do |response|
         File.open(filename, 'wb') do |file|
           response.read_body do |chunk|
             file.write(chunk)

data/lib/nexmo/form_data.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 module Nexmo
   module FormData
     def self.update(http_request, params)

data/lib/nexmo/gsm7.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 module Nexmo
   module GSM7
     CHARACTERS = "\n\f\r !\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~ ¡£¤¥§¿ÄÅÆÉÑÖØÜßàäåæçèéìñòöøùüΓΔΘΛΞΠΣΦΨΩ€"

data/lib/nexmo/http.rb

@@ -1,11 +1,18 @@
+# typed: strict
 # frozen_string_literal: true
 require 'net/http'
 
 module Nexmo
   module HTTP
     class Options
+      extend T::Sig
+
+      sig { params(hash: T::Hash[Symbol, T.untyped]).void }
       def initialize(hash)
-        @hash = hash || {}
+        raise ArgumentError, 'hash parameter cannot be empty or nil' if hash == {} || hash.nil?
+
+        @hash = T.let(@hash, T::Hash[Symbol, T.untyped]) if defined? @hash
+        @hash = hash
 
         @hash.each_key do |name|
           next if defined_options.key?(name)
@@ -14,6 +21,7 @@ module Nexmo
         end
       end
 
+      sig { params(http: Net::HTTP).returns(T::Hash[Symbol, T.untyped]) }
       def set(http)
         @hash.each do |name, value|
           http.public_send(defined_options.fetch(name), value)
@@ -22,13 +30,14 @@ module Nexmo
 
       private
 
+      sig { returns(T::Hash[Symbol, T.untyped]) }
       def defined_options
+        @defined_options = T.let(@defined_options, T.nilable(T::Hash[Symbol, T.untyped]))
+
         @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
-
-  private_constant :HTTP
 end