nexmo 6.3.0 → 7.2.0

data/lib/nexmo/conversations.rb

@@ -1,8 +1,10 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Conversations < Namespace
+    extend T::Sig
+
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -33,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
@@ -63,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
@@ -78,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
@@ -110,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
@@ -125,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
@@ -156,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,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/conversations/legs.rb

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

data/lib/nexmo/conversations/members.rb

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

data/lib/nexmo/conversations/users.rb

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

data/lib/nexmo/conversions.rb

@@ -1,14 +1,17 @@
-# typed: false
+# 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,4 +1,4 @@
-# typed: false
+# typed: true
 
 module Nexmo
   class Entity
@@ -48,4 +48,4 @@ module Nexmo
 
     include Enumerable
   end
-end
+end

data/lib/nexmo/errors.rb

@@ -1,9 +1,12 @@
-# typed: ignore
+# 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
@@ -21,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)
@@ -31,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,16 +1,20 @@
-# typed: false
+# 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/gsm7.rb

@@ -10,6 +10,4 @@ module Nexmo
       REGEXP =~ string
     end
   end
-
-  private_constant :GSM7
 end

data/lib/nexmo/http.rb

@@ -1,12 +1,18 @@
-# typed: ignore
+# 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)
@@ -15,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)
@@ -23,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

data/lib/nexmo/json.rb

@@ -1,9 +1,12 @@
-# typed: ignore
+# 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

@@ -2,10 +2,10 @@
 # frozen_string_literal: true
 require 'securerandom'
 require 'openssl'
-require 'jwt'
+require 'nexmo-jwt'
 
 module Nexmo
-  module JWT
+  class JWT
     # Generate an encoded JSON Web Token.
     #
     # By default the Nexmo Ruby SDK generates a short lived JWT per request.
@@ -14,12 +14,14 @@ module Nexmo
     # directly call {Nexmo::JWT.generate} to generate a token, and set the token
     # attribute on the client object.
     #
+    # Documentation for the Nexmo Ruby JWT generator gem can be found at
+    # https://www.rubydoc.info/github/nexmo/nexmo-jwt-ruby
+    #
     # @example
     #   claims = {
     #     application_id: application_id,
-    #     nbf: 1483315200,
-    #     exp: 1514764800,
-    #     iat: 1483228800
+    #     ttl: 800,
+    #     subject: 'My_Subject'
     #   }
     #
     #   private_key = File.read('path/to/private.key')
@@ -31,14 +33,11 @@ module Nexmo
     #
     # @return [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[:jti] = SecureRandom.uuid unless payload.key?(:jti) || payload.key?('jti')
-
-      private_key = OpenSSL::PKey::RSA.new(private_key) unless private_key.respond_to?(:sign)
+    def self.generate(payload, private_key = nil)
+      raise "Expecting 'private_key' in either the payload or as a separate parameter" if !payload[:private_key] && !private_key
 
-      ::JWT.encode(payload, private_key, 'RS256')
+      payload[:private_key] = private_key if private_key && !payload[:private_key]
+      @token = Nexmo::JWTBuilder.new(payload).jwt.generate
     end
   end
 end

data/lib/nexmo/key_secret_params.rb

@@ -1,12 +1,18 @@
-# typed: ignore
+# 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,17 +1,37 @@
-# typed: ignore
+# 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[T.untyped, T.untyped]) }
     def camelcase(hash)
-      hash.transform_keys { |k| k.to_s.gsub(/_(\w)/) { $1.upcase } }
+      exceptions = [
+        'dr_call_back_url',
+        'mo_http_url',
+        'mo_smpp_sys_type',
+        'mo_call_back_url',
+        'voice_callback_type',
+        'voice_callback_value',
+        'voice_status_callback',
+        'messages_callback_value',
+        'messages_callback_type'
+      ]
+      hash.transform_keys do |k|
+        if exceptions.include?(k.to_s)
+          next k.to_s.gsub(/_(\w)/) { $1.upcase.to_s }
+        end
+          k
+      end
     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])/
 
@@ -19,6 +39,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,10 +1,13 @@
-# typed: ignore
+# 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
@@ -15,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)
-      @logger.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
@@ -24,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)
-      @logger.info do
+      T.must(@logger).info do
         format('Nexmo API response', {
           host: host,
           status: response.code,
@@ -38,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?
 
@@ -46,6 +57,4 @@ module Nexmo
       fields.join(' ')
     end
   end
-
-  private_constant :Logger
 end