nexmo 5.9.0 → 6.0.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class CallDTMF < Namespace
+  class Calls::DTMF < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -14,7 +14,7 @@ module Nexmo
     # @param [String] id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#startDTMF
     #

data/lib/nexmo/calls/list_response.rb

@@ -0,0 +1,9 @@
+class Nexmo::Calls::ListResponse < Nexmo::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.calls.each { |item| yield item }
+  end
+end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class CallStream < Namespace
+  class Calls::Stream < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -20,7 +20,7 @@ module Nexmo
     # @param [String] id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#startStream
     #
@@ -32,7 +32,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#stopStream
     #

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class CallTalk < Namespace
+  class Calls::Talk < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -24,7 +24,7 @@ module Nexmo
     # @param [String] id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#startTalk
     #
@@ -36,7 +36,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#stopTalk
     #

data/lib/nexmo/client.rb

@@ -1,260 +1,111 @@
-# frozen_string_literal: true
-
 module Nexmo
   class Client
-    attr_writer :api_key
-    attr_writer :api_secret
-    attr_writer :signature_secret
-    attr_writer :application_id
-    attr_writer :private_key
-    attr_writer :token
-    attr_accessor :user_agent
-
-    def initialize(options = {})
-      @api_key = options[:api_key] || ENV['NEXMO_API_KEY']
-
-      @api_secret = options[:api_secret] || ENV['NEXMO_API_SECRET']
-
-      @signature_secret = options[:signature_secret] || ENV['NEXMO_SIGNATURE_SECRET']
-
-      @application_id = options[:application_id]
-
-      @private_key = options[:private_key]
-
-      @token = nil
-
-      @user_agent = UserAgent.string(options[:app_name], options[:app_version])
-
-      self.http_options = options[:http]
-
-      self.logger = options[:logger] || (defined?(Rails.logger) && Rails.logger)
-    end
-
-    attr_reader :http_options
-
-    def http_options=(hash)
-      @http_options = HTTP::Options.new(hash)
-    end
-
-    # @return [Nexmo::Logger]
-    #
-    def logger
-      @logger
-    end
-
-    # @return [Nexmo::Logger]
-    #
-    def logger=(logger)
-      @logger = Logger.new(logger)
-    end
+    attr_reader :config
 
-    # Returns the value of attribute token, or a temporary short lived token.
-    #
-    # @return [String]
-    #
-    def token
-      @token || JWT.generate({application_id: application_id}, private_key)
-    end
-
-    # @deprecated Use {#token=} instead.
-    #
-    def auth_token=(auth_token)
-      Kernel.warn "#{self.class}##{__method__} is deprecated (use #token= instead)"
-
-      @token = auth_token
-    end
-
-    # Returns the value of attribute api_key.
-    #
-    # @return [String]
-    #
-    # @raise [AuthenticationError]
-    #
-    def api_key
-      unless @api_key
-        raise AuthenticationError.new('No API key provided. ' \
-          'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
-          'or email support@nexmo.com if you have any questions.')
-      end
-
-      @api_key
-    end
-
-    # Returns the value of attribute api_secret.
-    #
-    # @return [String]
-    #
-    # @raise [AuthenticationError]
-    #
-    def api_secret
-      unless @api_secret
-        raise AuthenticationError.new('No API secret provided. ' \
-          'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
-          'or email support@nexmo.com if you have any questions.')
-      end
-
-      @api_secret
-    end
-
-    # Returns the value of attribute signature_secret.
-    #
-    # @return [String]
-    #
-    # @raise [AuthenticationError]
-    #
-    def signature_secret
-      unless @signature_secret
-        raise AuthenticationError.new('No signature_secret provided. ' \
-          'You can find your signature secret in the Nexmo dashboard. ' \
-          'See https://developer.nexmo.com/concepts/guides/signing-messages for details, ' \
-          'or email support@nexmo.com if you have any questions.')
-      end
-
-      @signature_secret
-    end
-
-    # Returns the value of attribute application_id.
-    #
-    # @return [String]
-    #
-    # @raise [AuthenticationError]
-    #
-    def application_id
-      unless @application_id
-        raise AuthenticationError.new('No application_id provided. ' \
-          'Either provide an application_id, or set an auth token. ' \
-          'You can add new applications from the Nexmo dashboard. ' \
-          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
-          'or email support@nexmo.com if you have any questions.')
-      end
-
-      @application_id
-    end
-
-    # Returns the value of attribute private_key.
-    #
-    # @return [String]
-    #
-    # @raise [AuthenticationError]
-    #
-    def private_key
-      unless @private_key
-        raise AuthenticationError.new('No private_key provided. ' \
-          'Either provide a private_key, or set an auth token. ' \
-          'You can add new applications from the Nexmo dashboard. ' \
-          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
-          'or email support@nexmo.com if you have any questions.')
-      end
-
-      @private_key
+    def initialize(options = nil)
+      @config = Nexmo.config.merge(options)
     end
 
     # @return [Signature]
     #
     def signature
-      @signature ||= Signature.new(signature_secret)
+      @signature ||= Signature.new(config.signature_secret)
     end
 
     # @return [Account]
     #
     def account
-      @account ||= Account.new(self)
+      @account ||= Account.new(config)
     end
 
     # @return [Alerts]
     #
     def alerts
-      @alerts ||= Alerts.new(self)
+      @alerts ||= Alerts.new(config)
     end
 
     # @return [Applications]
     #
     def applications
-      @applications ||= Applications.new(self)
-    end
-
-    # @return [ApplicationsV2]
-    #
-    def applications_v2
-      @applications_v2 ||= ApplicationsV2.new(self)
+      @applications ||= Applications.new(config)
     end
 
     # @return [Calls]
     #
     def calls
-      @calls ||= Calls.new(self)
+      @calls ||= Calls.new(config)
     end
 
     # @return [Conversations]
     #
     def conversations
-      @conversations ||= Conversations.new(self)
+      @conversations ||= Conversations.new(config)
     end
 
     # @return [Conversions]
     #
     def conversions
-      @conversions ||= Conversions.new(self)
+      @conversions ||= Conversions.new(config)
     end
 
     # @return [Files]
     #
     def files
-      @files ||= Files.new(self)
+      @files ||= Files.new(config)
     end
 
     # @return [Messages]
     #
     def messages
-      @messages ||= Messages.new(self)
+      @messages ||= Messages.new(config)
     end
 
     # @return [NumberInsight]
     #
     def number_insight
-      @number_insight ||= NumberInsight.new(self)
+      @number_insight ||= NumberInsight.new(config)
     end
 
     # @return [Numbers]
     #
     def numbers
-      @numbers ||= Numbers.new(self)
+      @numbers ||= Numbers.new(config)
     end
 
     # @return [PricingTypes]
     #
     def pricing
-      @pricing ||= PricingTypes.new(self)
+      @pricing ||= PricingTypes.new(config)
     end
 
     # @return [Redact]
     #
     def redact
-      @redact ||= Redact.new(self)
+      @redact ||= Redact.new(config)
     end
 
     # @return [Secrets]
     #
     def secrets
-      @secrets ||= Secrets.new(self)
+      @secrets ||= Secrets.new(config)
     end
 
     # @return [SMS]
     #
     def sms
-      @sms ||= SMS.new(self)
+      @sms ||= SMS.new(config)
     end
 
     # @return [TFA]
     #
     def tfa
-      @tfa ||= TFA.new(self)
+      @tfa ||= TFA.new(config)
     end
 
     # @return [Verify]
     #
     def verify
-      @verify ||= Verify.new(self)
+      @verify ||= Verify.new(config)
     end
   end
 end

data/lib/nexmo/config.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+require 'logger'
+
+module Nexmo
+  class Config
+    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.signature_secret = ENV['NEXMO_SIGNATURE_SECRET']
+      self.token = nil
+    end
+
+    # Merges the config with the given options hash.
+    #
+    # @return [Nexmo::Config]
+    #
+    def merge(options)
+      return self if options.nil? || options.empty?
+
+      options.each_with_object(dup) do |(name, value), config|
+        config.write_attribute(name, value)
+      end
+    end
+
+    # Returns the value of attribute api_key.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    def api_key
+      unless @api_key
+        raise AuthenticationError.new('No API key provided. ' \
+          'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @api_key
+    end
+
+    attr_writer :api_key
+
+    # Returns the value of attribute api_secret.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    def api_secret
+      unless @api_secret
+        raise AuthenticationError.new('No API secret provided. ' \
+          'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @api_secret
+    end
+
+    attr_writer :api_secret
+
+    # Returns the value of attribute application_id.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    def application_id
+      unless @application_id
+        raise AuthenticationError.new('No application_id provided. ' \
+          'Either provide an application_id, or set an auth token. ' \
+          'You can add new applications from the Nexmo dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @application_id
+    end
+
+    attr_writer :application_id
+
+    attr_accessor :app_name
+
+    attr_accessor :app_version
+
+    # Returns the value of attribute http.
+    #
+    # @return [Nexmo::HTTP::Options]
+    #
+    attr_reader :http
+
+    def http=(hash)
+      @http = HTTP::Options.new(hash)
+    end
+
+    # Returns the value of attribute logger.
+    #
+    # @return [Nexmo::Logger]
+    #
+    attr_reader :logger
+
+    # @return [Nexmo::Logger]
+    #
+    def logger=(logger)
+      @logger = Logger.new(logger)
+    end
+
+    # Returns the value of attribute private_key.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    def private_key
+      unless @private_key
+        raise AuthenticationError.new('No private_key provided. ' \
+          'Either provide a private_key, or set an auth token. ' \
+          'You can add new applications from the Nexmo dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @private_key
+    end
+
+    attr_writer :private_key
+
+    # Returns the value of attribute signature_secret.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    def signature_secret
+      unless @signature_secret
+        raise AuthenticationError.new('No signature_secret provided. ' \
+          'You can find your signature secret in the Nexmo dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/signing-messages for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @signature_secret
+    end
+
+    attr_writer :signature_secret
+
+    # Returns the value of attribute token, or a temporary short lived token.
+    #
+    # @return [String]
+    #
+    def token
+      @token || JWT.generate({application_id: application_id}, private_key)
+    end
+
+    attr_writer :token
+
+    protected
+
+    def write_attribute(name, value)
+      public_send(:"#{name}=", value)
+    end
+  end
+end