nexmo 5.9.0 → 6.0.0

data/lib/nexmo.rb

@@ -1,48 +1,31 @@
-require 'nexmo/version'
-require 'nexmo/params'
-require 'nexmo/form_data'
-require 'nexmo/http'
-require 'nexmo/json'
-require 'nexmo/jwt'
-require 'nexmo/signature'
-require 'nexmo/user_agent'
-require 'nexmo/keys'
-require 'nexmo/entity'
-require 'nexmo/errors'
-require 'nexmo/errors/error'
-require 'nexmo/errors/client_error'
-require 'nexmo/errors/server_error'
-require 'nexmo/errors/authentication_error'
-require 'nexmo/authentication/abstract'
-require 'nexmo/authentication/basic'
-require 'nexmo/authentication/bearer_token'
-require 'nexmo/authentication/key_secret_params'
-require 'nexmo/authentication/key_secret_query'
-require 'nexmo/logger'
-require 'nexmo/namespace'
-require 'nexmo/client'
-require 'nexmo/account'
-require 'nexmo/alerts'
-require 'nexmo/applications'
-require 'nexmo/applications_v2'
-require 'nexmo/call_dtmf'
-require 'nexmo/call_stream'
-require 'nexmo/call_talk'
-require 'nexmo/calls'
-require 'nexmo/conversation_events'
-require 'nexmo/conversation_legs'
-require 'nexmo/conversation_members'
-require 'nexmo/conversation_users'
-require 'nexmo/conversations'
-require 'nexmo/conversions'
-require 'nexmo/files'
-require 'nexmo/messages'
-require 'nexmo/number_insight'
-require 'nexmo/numbers'
-require 'nexmo/pricing_types'
-require 'nexmo/pricing'
-require 'nexmo/redact'
-require 'nexmo/secrets'
-require 'nexmo/sms'
-require 'nexmo/tfa'
-require 'nexmo/verify'
+# frozen_string_literal: true
+require 'zeitwerk'
+
+module Nexmo
+  class ZeitwerkInflector < Zeitwerk::Inflector
+    def camelize(basename, _abspath)
+      case basename
+      when 'http', 'json', 'jwt', 'sms', 'tfa', 'gsm7', 'dtmf', 'version'
+        basename.upcase
+      else
+        super
+      end
+    end
+  end
+
+  private_constant :ZeitwerkInflector
+
+  loader = Zeitwerk::Loader.new
+  loader.tag = File.basename(__FILE__, '.rb')
+  loader.inflector = ZeitwerkInflector.new
+  loader.push_dir(__dir__)
+  loader.setup
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure(&block)
+    block.call(config)
+  end
+end

data/lib/nexmo/{authentication/abstract.rb → abstract_authentication.rb}

@@ -1,7 +1,7 @@
 module Nexmo
   class AbstractAuthentication
-    def initialize(client)
-      @client = client
+    def initialize(config)
+      @config = config
     end
   end
 

data/lib/nexmo/account.rb

@@ -8,7 +8,7 @@ module Nexmo
 
     # Retrieve your account balance.
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/account#get-balance
     #
@@ -30,7 +30,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/account#settings
     #
@@ -45,6 +45,8 @@ module Nexmo
     #
     # @param [Hash] params
     #
+    # @return [Response]
+    #
     # @see https://developer.nexmo.com/api/developer/account#top-up
     #
     def topup(params)

data/lib/nexmo/alerts.rb

@@ -8,7 +8,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
     #
-    # @return [Entity]
+    # @return [Response]
     #
     def list
       request('/sc/us/alert/opt-in/query/json')
@@ -21,7 +21,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
     #
@@ -56,7 +56,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/sending
     #

data/lib/nexmo/applications.rb

@@ -2,9 +2,13 @@
 
 module Nexmo
   class Applications < Namespace
+    self.authentication = Basic
+
     self.request_body = JSON
 
-    # Create a new application.
+    self.request_headers['Content-Type'] = 'application/json'
+
+    # Create an application.
     #
     # @example
     #   params = {
@@ -17,129 +21,107 @@ module Nexmo
     #   response = client.applications.create(params)
     #
     # @option params [required, String] :name
-    #   The name of your application.
-    #
-    # @option params [required, String] :type
-    #   The Nexmo product or products that you access with this application.
-    #   Currently only `voice` and `messages` are supported.
-    #
-    # @option params [required, String] :answer_url
-    #   The URL where your webhook delivers the Nexmo Call Control Object that governs this call.
-    #   As soon as your user answers a call Nexmo makes a request to answer_url.
-    #
-    # @option params [String] :answer_method
-    #   The HTTP method used to make the request to answer_url.
-    #   The default value is GET.
+    #   Application name.
     #
-    # @option params [required, String] :event_url
-    #   Nexmo sends event information asynchronously to this URL when status changes.
+    # @option params [Hash] :keys
+    #   - **:public_key** (String) Public key
     #
-    # @option params [String] :event_method
-    #   The HTTP method used to send event information to event_url.
-    #   The default value is POST.
+    # @option params [Hash] :capabilities
+    #   Your application can use multiple products.
+    #   This contains the configuration for each product.
+    #   This replaces the application `type` from version 1 of the Application API.
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
-    # @see https://developer.nexmo.com/api/application#create-an-application
+    # @see https://developer.nexmo.com/api/application.v2#createApplication
     #
     def create(params)
-      request('/v1/applications', params: params, type: Post)
+      request('/v2/applications', params: params, type: Post)
     end
 
-    # Retrieve details of all applications associated with your account.
+    # List available applications.
     #
     # @example
     #   response = client.applications.list
-    #   response._embedded.applications.each do |item|
+    #   response.each do |item|
     #     puts "#{item.id} #{item.name}"
     #   end
     #
     # @option params [Integer] :page_size
-    #   Set the number of items returned on each call to this endpoint.
-    #   The default is 10 records.
+    #   The number of applications per page.
     #
-    # @option params [Integer] :page_index
-    #   Set the offset from the first page.
-    #   The default value is 0.
+    # @option params [Integer] :page
+    #   The current page number (starts at 1).
     #
-    # @param [Hash, nil] params
+    # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [ListResponse]
     #
-    # @see https://developer.nexmo.com/api/application#retrieve-your-applications
+    # @see https://developer.nexmo.com/api/application.v2#listApplication
     #
     def list(params = nil)
-      request('/v1/applications', params: params)
+      request('/v2/applications', params: params, response_class: ListResponse)
     end
 
-    # Retrieve details about a single application.
+    # Get an application.
     #
     # @example
     #   response = client.applications.get(id)
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
-    # @see https://developer.nexmo.com/api/application#retrieve-an-application
+    # @see https://developer.nexmo.com/api/application.v2#getApplication
     #
     def get(id)
-      request('/v1/applications/' + id)
+      request('/v2/applications/' + id)
     end
 
-    # Update an existing application.
+    # Update an application.
     #
     # @example
     #   response = client.applications.update(id, answer_method: 'POST')
     #
     # @option params [required, String] :name
-    #   The name of your application.
-    #
-    # @option params [required, String] :type
-    #   The Nexmo product or products that you access with this application.
-    #   Currently only `voice` and `messages` are supported.
-    #
-    # @option params [required, String] :answer_url
-    #   The URL where your webhook delivers the Nexmo Call Control Object that governs this call.
-    #   As soon as your user answers a call Nexmo makes a request to answer_url.
+    #   Application name.
     #
-    # @option params [String] :answer_method
-    #   The HTTP method used to make the request to answer_url.
-    #   The default value is GET.
+    # @option params [Hash] :keys
+    #   - **:public_key** (String) Public key
     #
-    # @option params [required, String] :event_url
-    #   Nexmo sends event information asynchronously to this URL when status changes.
-    #
-    # @option params [String] :event_method
-    #   The HTTP method used to send event information to event_url.
-    #   The default value is POST.
+    # @option params [Hash] :capabilities
+    #   Your application can use multiple products.
+    #   This contains the configuration for each product.
+    #   This replaces the application `type` from version 1 of the Application API.
     #
     # @param [String] id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
-    # @see https://developer.nexmo.com/api/application#update-an-application
+    # @see https://developer.nexmo.com/api/application.v2#updateApplication
     #
     def update(id, params)
-      request('/v1/applications/' + id, params: params, type: Put)
+      request('/v2/applications/' + id, params: params, type: Put)
     end
 
-    # Delete a single application.
+    # Delete an application.
     #
     # @example
     #   response = client.applications.delete(id)
     #
+    # @note Deleting an application cannot be undone.
+    #
     # @param [String] id
     #
-    # @return [:no_content]
+    # @return [Response]
     #
-    # @see https://developer.nexmo.com/api/application#destroy-an-application
+    # @see https://developer.nexmo.com/api/application.v2#deleteApplication
     #
     def delete(id)
-      request('/v1/applications/' + id, type: Delete)
+      request('/v2/applications/' + id, type: Delete)
     end
   end
 end

data/lib/nexmo/applications/list_response.rb

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

data/lib/nexmo/{authentication/basic.rb → basic.rb}

@@ -3,7 +3,7 @@ module Nexmo
     def update(object)
       return unless object.is_a?(Net::HTTPRequest)
 
-      object.basic_auth(@client.api_key, @client.api_secret)
+      object.basic_auth(@config.api_key, @config.api_secret)
     end
   end
 

data/lib/nexmo/{authentication/bearer_token.rb → bearer_token.rb}

@@ -5,7 +5,7 @@ module Nexmo
     def update(object)
       return unless object.is_a?(Net::HTTPRequest)
 
-      object['Authorization'] = 'Bearer ' + @client.token
+      object['Authorization'] = 'Bearer ' + @config.token
     end
   end
 

data/lib/nexmo/calls.rb

@@ -49,7 +49,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#createCall
     #
@@ -61,7 +61,7 @@ module Nexmo
     #
     # @example
     #   response = client.calls.list
-    #   response._embedded.calls.each do |item|
+    #   response.each do |item|
     #     puts "#{item.uuid} #{item.direction} #{item.status}"
     #   end
     #
@@ -88,12 +88,12 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/voice#getCalls
     #
     def list(params = nil)
-      request('/v1/calls', params: params)
+      request('/v1/calls', params: params, response_class: ListResponse)
     end
 
     # Get detail of a specific call.
@@ -103,7 +103,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#getCall
     #
@@ -124,7 +124,7 @@ module Nexmo
     # @param [String] id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#updateCall
     #
@@ -139,7 +139,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#updateCall
     #
@@ -154,7 +154,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#updateCall
     #
@@ -169,7 +169,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#updateCall
     #
@@ -184,7 +184,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#updateCall
     #
@@ -199,7 +199,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#updateCall
     #
@@ -220,7 +220,7 @@ module Nexmo
     # @param [String] id
     # @param [Hash] destination
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/voice#updateCall
     #
@@ -228,22 +228,22 @@ module Nexmo
       update(id, action: 'transfer', destination: destination)
     end
 
-    # @return [CallStream]
+    # @return [Stream]
     #
     def stream
-      @stream ||= CallStream.new(@client)
+      @stream ||= Stream.new(@config)
     end
 
-    # @return [CallTalk]
+    # @return [Talk]
     #
     def talk
-      @talk ||= CallTalk.new(@client)
+      @talk ||= Talk.new(@config)
     end
 
-    # @return [CallDTMF]
+    # @return [DTMF]
     #
     def dtmf
-      @dtmf ||= CallDTMF.new(@client)
+      @dtmf ||= DTMF.new(@config)
     end
   end
 end