nexmo 6.1.0 → 7.1.1

data/lib/nexmo/response.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Nexmo
   class Response
     def initialize(entity=nil, http_response=nil)

data/lib/nexmo/secrets.rb

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

data/lib/nexmo/secrets/list_response.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 class Nexmo::Secrets::ListResponse < Nexmo::Response
   include Enumerable
 

data/lib/nexmo/server_error.rb

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

data/lib/nexmo/signature.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 require 'openssl'
 require 'digest/md5'

data/lib/nexmo/sms.rb

@@ -1,21 +1,19 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class SMS < Namespace
+    extend T::Sig
     include Keys
 
-    self.host = 'rest.nexmo.com'
+    self.host = :rest_host
 
     # Send an outbound SMS from your Nexmo account.
     #
     # @example
     #   response = client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')
     #
-    #   if response.success?
-    #     puts "Sent message id=#{response.messages.first.message_id}"
-    #   else
-    #     puts "Error: #{response.messages.first.error_text}"
-    #   end
+    #   puts "Sent message id=#{response.messages.first.message_id}"
     #
     # @option params [required, String] :from
     #   The name or number the message should be sent from.
@@ -94,22 +92,30 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms#send-an-sms
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def send(params)
-      if unicode?(params[:text]) && params[:type] != 'unicode'
+      if unicode?(params.fetch(: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)
+        logger.warn(message)
       end
 
-      request('/sms/json', params: hyphenate(params), type: Post, response_class: Response)
+      response = request('/sms/json', params: hyphenate(params), type: Post)
+
+      unless response.messages.first.status == '0'
+        raise Error, response.messages.first[:error_text]
+      end
+
+      response
     end
 
     private
 
+    sig { params(text: String).returns(T::Boolean) }
     def unicode?(text)
-      !GSM7.encoded?(text)
+      !Nexmo::GSM7Test::GSM7.encoded?(text)
     end
   end
 end

data/lib/nexmo/tfa.rb

@@ -1,10 +1,11 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
   class TFA < Namespace
     include Keys
 
-    self.host = 'rest.nexmo.com'
+    self.host = :rest_host
 
     def send(params)
       request('/sc/us/2fa/json', params: hyphenate(params), type: Post)

data/lib/nexmo/user_agent.rb

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

data/lib/nexmo/verify.rb

@@ -1,13 +1,13 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Verify < Namespace
+    extend T::Sig
     alias_method :http_request, :request
 
     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.
@@ -15,11 +15,7 @@ module Nexmo
     # @example
     #   response = client.verify.request(number: '447700900000', brand: 'Acme Inc')
     #
-    #   if response.success?
-    #     puts "Started verification request_id=#{response.request_id}"
-    #   else
-    #     puts "Error: #{response.error_text}"
-    #   end
+    #   puts "Started verification request_id=#{response.request_id}"
     #
     # @option params [required, String] :number
     #   The mobile or landline phone number to verify.
@@ -64,8 +60,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyRequest
     #
-    def request(params)
-      http_request('/verify/json', params: params, type: Post)
+    sig { params(params: T.untyped, uri: T.untyped).returns(T.untyped) }
+    def request(params, uri = '/verify/json')
+      response = http_request(uri, params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Confirm that the PIN you received from your user matches the one sent by Nexmo in your verification request.
@@ -73,11 +74,7 @@ module Nexmo
     # @example
     #   response = client.verify.check(request_id: request_id, code: '1234')
     #
-    #   if response.success?
-    #     puts "Verification complete, event_id=#{response.event_id}"
-    #   else
-    #     puts "Error: #{response.error_text}"
-    #   end
+    #   puts "Verification complete, event_id=#{response.event_id}"
     #
     # @option params [required, String] :request_id
     #   The Verify request to check.
@@ -96,8 +93,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyCheck
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def check(params)
-      http_request('/verify/check/json', params: params, type: Post)
+      response = http_request('/verify/check/json', params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Check the status of past or current verification requests.
@@ -118,8 +120,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifySearch
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(T.any(T::Hash[Symbol, T.untyped], Nexmo::Response)) }
     def search(params)
-      http_request('/verify/search/json', params: params)
+      response = http_request('/verify/search/json', params: params)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Control the progress of your verification requests.
@@ -140,8 +147,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
     def control(params)
-      http_request('/verify/control/json', params: params, type: Post)
+      response = http_request('/verify/control/json', params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Cancel an existing verification request.
@@ -155,6 +167,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def cancel(id)
       control(request_id: id, cmd: 'cancel')
     end
@@ -170,8 +183,71 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def trigger_next_event(id)
       control(request_id: id, cmd: 'trigger_next_event')
     end
+
+    # Send a PSD2-compliant payment token to a user for payment authorization
+    #
+    # @example
+    #   response = client.verify.psd2(number: '447700900000', payee: 'Acme Inc', amount: 48.00)
+    #
+    # @option params [required, String] :number
+    #   The mobile or landline phone number to verify.
+    #   Unless you are setting **:country** explicitly, this number must be in E.164 format.
+    #
+    # @option params [String] :country
+    #   If you do not provide **:number** in international format or you are not sure if **:number** is correctly formatted, specify the two-character country code in **:country**.
+    #   Verify will then format the number for you.
+    #
+    # @option params [required, String] :payee
+    #   An alphanumeric string to indicate to the user the name of the recipient that they are confirming a payment to.
+    #
+    # @option params [required, Float] :amount
+    #   The decimal amount of the payment to be confirmed, in Euros
+    #
+    # @option params [Integer] :code_length
+    #   The length of the verification code.
+    #
+    # @option params [String] :lg
+    #   By default, the SMS or text-to-speech (TTS) message is generated in the locale that matches the **:number**.
+    #   For example, the text message or TTS message for a `33*` number is sent in French.
+    #   Use this parameter to explicitly control the language, accent and gender used for the Verify request.
+    #
+    # @option params [Integer] :pin_expiry
+    #   How log the generated verification code is valid for, in seconds.
+    #   When you specify both **:pin_expiry** and **:next_event_wait** then **:pin_expiry** must be an integer multiple of **:next_event_wait** otherwise **:pin_expiry** is defaulted to equal **:next_event_wait**.
+    #   See [changing the event timings](https://developer.nexmo.com/verify/guides/changing-default-timings).
+    #
+    # @option params [Integer] :next_event_wait
+    #   Specifies the wait time in seconds between attempts to deliver the verification code.
+    #
+    # @option params [Integer] :workflow_id
+    #   Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.
+    #   For example, an id of 1 identifies the workflow SMS - TTS - TTS.
+    #   For a list of all workflows and their associated ids, please visit the [developer portal](https://developer.nexmo.com/verify/guides/workflows-and-events).
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/verify#verifyRequestWithPSD2
+    #
+    sig { params(params: T.untyped, uri: T.untyped).returns(T.any(Nexmo::Error, Nexmo::Response)) }
+    def psd2(params, uri = '/verify/psd2/json')
+      response = http_request(uri, params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
+    end
+
+    private
+
+    sig { params(response: T.untyped).returns(T::Boolean) }
+    def error?(response)
+      response.respond_to?(:error_text)
+    end
   end
 end

data/lib/nexmo/version.rb

@@ -1,3 +1,5 @@
+# typed: strong
+
 module Nexmo
-  VERSION = '6.1.0'
+  VERSION = '7.1.1'
 end

data/lib/nexmo/{calls.rb → voice.rb}

@@ -1,7 +1,8 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls < Namespace
+  class Voice < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -9,7 +10,7 @@ module Nexmo
     # Create an outbound Call.
     #
     # @example
-    #   response = client.calls.create({
+    #   response = client.voice.create({
     #     to: [{type: 'phone', number: '14843331234'}],
     #     from: {type: 'phone', number: '14843335555'},
     #     answer_url: ['https://example.com/answer']
@@ -60,7 +61,7 @@ module Nexmo
     # Get details of your calls.
     #
     # @example
-    #   response = client.calls.list
+    #   response = client.voice.list
     #   response.each do |item|
     #     puts "#{item.uuid} #{item.direction} #{item.status}"
     #   end
@@ -99,7 +100,7 @@ module Nexmo
     # Get detail of a specific call.
     #
     # @example
-    #   response = client.calls.get(id)
+    #   response = client.voice.get(id)
     #
     # @param [String] id
     #
@@ -114,7 +115,7 @@ module Nexmo
     # Modify an in progress call.
     #
     # @example
-    #   response = client.calls.update(id, action: 'hangup')
+    #   response = client.voice.update(id, action: 'hangup')
     #
     # @option params [required, String] :action
     #
@@ -135,7 +136,7 @@ module Nexmo
     # Hangup an in progress call.
     #
     # @example
-    #   response = client.calls.hangup(id)
+    #   response = client.voice.hangup(id)
     #
     # @param [String] id
     #
@@ -150,7 +151,7 @@ module Nexmo
     # Mute an in progress call.
     #
     # @example
-    #   response = client.calls.mute(id)
+    #   response = client.voice.mute(id)
     #
     # @param [String] id
     #
@@ -165,7 +166,7 @@ module Nexmo
     # Unmute an in progress call.
     #
     # @example
-    #   response = client.calls.unmute(id)
+    #   response = client.voice.unmute(id)
     #
     # @param [String] id
     #
@@ -180,7 +181,7 @@ module Nexmo
     # Earmuff an in progress call.
     #
     # @example
-    #   response = client.calls.earmuff(id)
+    #   response = client.voice.earmuff(id)
     #
     # @param [String] id
     #
@@ -195,7 +196,7 @@ module Nexmo
     # Unearmuff an in progress call.
     #
     # @example
-    #   response = client.calls.unearmuff(id)
+    #   response = client.voice.unearmuff(id)
     #
     # @param [String] id
     #
@@ -215,7 +216,7 @@ module Nexmo
     #     url: ['https://example.com/ncco.json']
     #   }
     #
-    #   response = client.calls.transfer(id, destination: destination)
+    #   response = client.voice.transfer(id, destination: destination)
     #
     # @param [String] id
     # @param [Hash] destination

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

@@ -1,7 +1,8 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls::DTMF < Namespace
+  class Voice::DTMF < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON

data/lib/nexmo/{calls → voice}/list_response.rb

@@ -1,4 +1,6 @@
-class Nexmo::Calls::ListResponse < Nexmo::Response
+# typed: ignore
+
+class Nexmo::Voice::ListResponse < Nexmo::Response
   include Enumerable
 
   def each

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

@@ -1,7 +1,8 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls::Stream < Namespace
+  class Voice::Stream < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON

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

@@ -1,7 +1,8 @@
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls::Talk < Namespace
+  class Voice::Talk < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON

data/nexmo.gemspec

@@ -13,13 +13,8 @@ Gem::Specification.new do |s|
   s.files = Dir.glob('lib/**/*.rb') + %w(LICENSE.txt README.md nexmo.gemspec)
   s.required_ruby_version = '>= 2.5.0'
   s.add_dependency('jwt', '~> 2')
-  s.add_dependency('zeitwerk', '~> 2')
-  s.add_development_dependency('rake', '~> 13')
-  s.add_development_dependency('yard', '~> 0.9')
-  s.add_development_dependency('minitest', '~> 5.0')
-  s.add_development_dependency('webmock', '~> 3.0')
-  s.add_development_dependency('simplecov', '~> 0.16')
-  s.add_development_dependency('coveralls', '~> 0.8.15')
+  s.add_dependency('zeitwerk', '~> 2', '>= 2.2')
+  s.add_dependency('sorbet-runtime', '~> 0.5')
   s.require_path = 'lib'
   s.metadata = {
     'homepage' => 'https://github.com/Nexmo/nexmo-ruby',