nexmo 5.9.0 → 6.0.0

data/lib/nexmo/number_insight.rb

@@ -2,6 +2,8 @@
 
 module Nexmo
   class NumberInsight < Namespace
+    self.response_class = Response
+
     # Provides basic number insight information about a number.
     #
     # @example
@@ -17,7 +19,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightBasic
     #
@@ -45,7 +47,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightStandard
     #
@@ -77,7 +79,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAdvanced
     #
@@ -112,7 +114,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAsync
     #

data/lib/nexmo/number_insight/response.rb

@@ -0,0 +1,5 @@
+class Nexmo::NumberInsight::Response < Nexmo::Response
+  def success?
+    status.zero?
+  end
+end

data/lib/nexmo/numbers.rb

@@ -10,7 +10,7 @@ module Nexmo
     #
     # @example
     #   response = client.numbers.list
-    #   response.numbers.each do |item|
+    #   response.each do |item|
     #     puts "#{item.msisdn} #{item.country} #{item.type}"
     #   end
     #
@@ -29,21 +29,29 @@ 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 [String] :application_id
+    #   The application that you want to return the numbers for.
+    #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getOwnedNumbers
     #
     def list(params = nil)
-      request('/account/numbers', params: params)
+      request('/account/numbers', params: params, response_class: ListResponse)
     end
 
     # Retrieve inbound numbers that are available for the specified country.
     #
     # @example
     #   response = client.numbers.search(country: 'GB')
-    #   response.numbers.each do |item|
+    #   response.each do |item|
     #     puts "#{item.msisdn} #{item.type} #{item.cost}"
     #   end
     #
@@ -75,12 +83,12 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getAvailableNumbers
     #
     def search(params)
-      request('/number/search', params: params)
+      request('/number/search', params: params, response_class: ListResponse)
     end
 
     # Request to purchase a specific inbound number.
@@ -96,12 +104,12 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#buyANumber
     #
     def buy(params)
-      request('/number/buy', params: params, type: Post)
+      request('/number/buy', params: params, type: Post, response_class: Response)
     end
 
     # Cancel your subscription for a specific inbound number.
@@ -117,12 +125,12 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#cancelANumber
     #
     def cancel(params)
-      request('/number/cancel', params: params, type: Post)
+      request('/number/cancel', params: params, type: Post, response_class: Response)
     end
 
     # Change the behaviour of a number that you own.
@@ -173,12 +181,12 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#updateANumber
     #
     def update(params)
-      request('/number/update', params: camelcase(params), type: Post)
+      request('/number/update', params: camelcase(params), type: Post, response_class: Response)
     end
   end
 end

data/lib/nexmo/numbers/list_response.rb

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

data/lib/nexmo/numbers/response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Nexmo::Numbers::Response < Nexmo::Response
+  def success?
+    error_code == '200'
+  end
+end

data/lib/nexmo/pricing.rb

@@ -4,12 +4,12 @@ module Nexmo
   class Pricing < Namespace
     self.host = 'rest.nexmo.com'
 
-    def initialize(client, type: nil)
+    def initialize(config, type: nil)
       raise ArgumentError if type.nil?
 
       @type = type
 
-      super client
+      super config
     end
 
     attr_reader :type

data/lib/nexmo/pricing_types.rb

@@ -2,16 +2,16 @@
 
 module Nexmo
   class PricingTypes
-    def initialize(client)
-      @client = client
+    def initialize(config)
+      @config = config
     end
 
     def sms
-      @sms ||= Pricing.new(@client, type: 'sms')
+      @sms ||= Pricing.new(@config, type: 'sms')
     end
 
     def voice
-      @voice ||= Pricing.new(@client, type: 'voice')
+      @voice ||= Pricing.new(@config, type: 'voice')
     end
   end
 end

data/lib/nexmo/redact.rb

@@ -22,7 +22,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/redact#redact-message
     #

data/lib/nexmo/response.rb

@@ -0,0 +1,23 @@
+module Nexmo
+  class Response
+    def initialize(entity=nil, http_response=nil)
+      @entity = entity
+
+      @http_response = http_response
+    end
+
+    attr_reader :http_response
+
+    def respond_to_missing?(name, include_private = false)
+      return super if @entity.nil?
+
+      @entity.respond_to?(name)
+    end
+
+    def method_missing(name, *args)
+      return super if @entity.nil?
+
+      @entity.public_send(name, *args)
+    end
+  end
+end

data/lib/nexmo/secrets.rb

@@ -21,7 +21,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/account#createAPISecret
     #
@@ -33,16 +33,16 @@ module Nexmo
     #
     # @example
     #   response = client.secrets.list
-    #   response._embedded.secrets.each do |item|
+    #   response.each do |item|
     #     puts "#{item.created_at} #{item.id}"
     #   end
     #
-    # @return [Entity]
+    # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/account#retrieveAPISecrets
     #
     def list
-      request('/accounts/' + account_id + '/secrets')
+      request('/accounts/' + account_id + '/secrets', response_class: ListResponse)
     end
 
     # Retrieve one API Secret.
@@ -52,7 +52,7 @@ module Nexmo
     #
     # @param [String] secret_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/account#retrieveAPISecret
     #
@@ -67,7 +67,7 @@ module Nexmo
     #
     # @param [String] secret_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/account#revokeAPISecret
     #
@@ -78,7 +78,7 @@ module Nexmo
     private
 
     def account_id
-      @client.api_key
+      @config.api_key
     end
   end
 end

data/lib/nexmo/secrets/list_response.rb

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

data/lib/nexmo/sms.rb

@@ -11,7 +11,7 @@ module Nexmo
     # @example
     #   response = client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')
     #
-    #   if response.messages.first.status == '0'
+    #   if response.success?
     #     puts "Sent message id=#{response.messages.first.message_id}"
     #   else
     #     puts "Error: #{response.messages.first.error_text}"
@@ -90,12 +90,26 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/sms#send-an-sms
     #
     def send(params)
-      request('/sms/json', params: hyphenate(params), type: Post)
+      if unicode?(params[:text]) && params[:type] != 'unicode'
+        message = 'Sending unicode text SMS without setting the type parameter to "unicode". ' \
+          'See https://developer.nexmo.com/messaging/sms for details, ' \
+          'or email support@nexmo.com if you have any questions.'
+
+        @logger.warn(message)
+      end
+
+      request('/sms/json', params: hyphenate(params), type: Post, response_class: Response)
+    end
+
+    private
+
+    def unicode?(text)
+      !GSM7.encoded?(text)
     end
   end
 end

data/lib/nexmo/sms/response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Nexmo::SMS::Response < Nexmo::Response
+  def success?
+    messages.all? { |item| item.status == '0' }
+  end
+end

data/lib/nexmo/verify.rb

@@ -6,6 +6,8 @@ module Nexmo
 
     private :http_request
 
+    self.response_class = Response
+
     # Generate and send a PIN to your user.
     #
     # @note You can make a maximum of one Verify request per second.
@@ -13,7 +15,7 @@ module Nexmo
     # @example
     #   response = client.verify.request(number: '447700900000', brand: 'Acme Inc')
     #
-    #   if response.status == '0'
+    #   if response.success?
     #     puts "Started verification request_id=#{response.request_id}"
     #   else
     #     puts "Error: #{response.error_text}"
@@ -58,7 +60,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/verify#verifyRequest
     #
@@ -71,7 +73,7 @@ module Nexmo
     # @example
     #   response = client.verify.check(request_id: request_id, code: '1234')
     #
-    #   if response.status == '0'
+    #   if response.success?
     #     puts "Verification complete, event_id=#{response.event_id}"
     #   else
     #     puts "Error: #{response.error_text}"
@@ -90,7 +92,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/verify#verifyCheck
     #
@@ -112,7 +114,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/verify#verifySearch
     #
@@ -134,7 +136,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
@@ -149,7 +151,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
@@ -164,7 +166,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #

data/lib/nexmo/verify/response.rb

@@ -0,0 +1,5 @@
+class Nexmo::Verify::Response < Nexmo::Response
+  def success?
+    respond_to?(:status) && !respond_to?(:error_text)
+  end
+end

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '5.9.0'
+  VERSION = '6.0.0'
 end

data/nexmo.gemspec

@@ -11,8 +11,9 @@ Gem::Specification.new do |s|
   s.description = 'Nexmo Client Library for Ruby'
   s.summary = 'This is the Ruby client library for Nexmo\'s API. To use it you\'ll need a Nexmo account. Sign up for free at https://www.nexmo.com'
   s.files = Dir.glob('lib/**/*.rb') + %w(LICENSE.txt README.md nexmo.gemspec)
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.5.0'
   s.add_dependency('jwt', '~> 2')
+  s.add_dependency('zeitwerk', '~> 2')
   s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('yard', '~> 0.9')
   s.add_development_dependency('minitest', '~> 5.0')
@@ -24,6 +25,7 @@ Gem::Specification.new do |s|
     'homepage' => 'https://github.com/Nexmo/nexmo-ruby',
     'source_code_uri' => 'https://github.com/Nexmo/nexmo-ruby',
     'bug_tracker_uri' => 'https://github.com/Nexmo/nexmo-ruby/issues',
-    'changelog_uri' => 'https://github.com/Nexmo/nexmo-ruby/blob/master/CHANGES.md'
+    'changelog_uri' => 'https://github.com/Nexmo/nexmo-ruby/blob/master/CHANGES.md',
+    'documentation_uri' => 'https://www.rubydoc.info/github/nexmo/nexmo-ruby'
   }
 end