vonage 7.16.1 → 8.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c55251a1296c1c7e13ef6a3f491868be1d21c3b43905f21f3042c1901b2bef23
-  data.tar.gz: d9ed23ef4f8b1e8a6a25bc4c72e904b9ffa7b2b622b60a1afd8369f1268b253f
+  metadata.gz: e003a6ed3211d3eace84884bf3fb03d21b81f097b13aba079f1906daf95380ff
+  data.tar.gz: 956c6921b50df45aaf2f1901b08ccd3cb164c2553b23d8e45570f63dcdf6f960
 SHA512:
-  metadata.gz: 5ee43b28d5fad08043d51e30b4093939717dd3786e5ed1a85086d16bd3b88aec2535d957fdef93801ede173ec4b447d96ef504ed95f5dff6a1d2f3425f0dd013
-  data.tar.gz: ac4727ee0577c863d4f2cb181003b0b67b3bc78e6b9b43e66da89a402d401e2459198ba336ace27e1588b9d2f7ecf67f157b30918fd56ab8b6a48cc63581e0d7
+  metadata.gz: 1500879cd4a974009f6510cf12ea15b4ce60a9163f916b8a5e07fe785323c24c6909134163b21e29afc9c251550fd36a9e348c2ff7eac3b18b45f0e4ef7e1be1
+  data.tar.gz: fe368d23b897a7f1b2b9ba473c993a351ffb1233ef80304c16ec69ed28692c93e422c7a453f8d0da14b6e038424c215026a945d7ccee9b4a26412e3ecbe5435f

data/README.md

@@ -12,14 +12,11 @@ need a Vonage account. Sign up [for free at vonage.com][signup].
 * [Installation](#installation)
 * [Usage](#usage)
     * [Logging](#logging)
-    * [Exceptions](#exceptions)
     * [Overriding the default hosts](#overriding-the-default-hosts)
     * [JWT authentication](#jwt-authentication)
     * [Webhook signatures](#webhook-signatures)
     * [Pagination](#pagination)
     * [NCCO Builder](#ncco-builder)
-    * [Messages API](#messages-api)
-    * [Verify API v2](#verify-api-v2)
 * [Documentation](#documentation)
 * [Frequently Asked Questions](#frequently-asked-questions)
     * [Supported APIs](#supported-apis)
@@ -83,46 +80,6 @@ By default the library sets the logger to `Rails.logger` if it is defined.
 
 To disable logging set the logger to `nil`.
 
-## Exceptions
-
-Where exceptions result from an error response from the Vonage API (HTTP responses that aren't ion the range `2xx` or `3xx`), the `Net::HTTPResponse` object will be available as a property of the `Exception` object via a `http_response` getter method (where there is no `Net::HTTPResponse` object associated with the exception, the value of `http_response` will be `nil`).
-
-You can rescue the the exception to access the `http_response`, as well as use other getters provided for specific parts of the response. For example:
-
-```ruby
-begin
-  verification_request = client.verify2.start_verification(
-    brand: 'Acme',
-    workflow: [{channel: 'sms', to: '44700000000'}]
-  )
-rescue Vonage::APIError => error
-  if error.http_response
-    error.http_response # => #<Net::HTTPUnauthorized 401 Unauthorized readbody=true>
-    error.http_response_code # => "401"
-    error.http_response_headers # => {"date"=>["Sun, 24 Sep 2023 11:08:47 GMT"], ...rest of headers}
-    error.http_response_body # => {"title"=>"Unauthorized", ...rest of body}
-  end
-end
-```
-
-For certain legacy API products, such as the [SMS API](https://developer.vonage.com/en/messaging/sms/overview), [Verify v1 API](https://developer.vonage.com/en/verify/verify-v1/overview) and [Number Insight v1 API](https://developer.vonage.com/en/number-insight/overview), a `200` response is received even in situations where there is an API-related error. For exceptions raised in these situation, rather than a `Net::HTTPResponse` object, a `Vonage::Response` object will be made available as a property of the exception via a `response` getter method. The properties on this object will depend on the response data provided by the API endpoint. For example:
-
-```ruby
-begin
-  sms = client.sms.send(
-    from: 'Vonage',
-    to: '44700000000',
-    text: 'Hello World!'
-  )
-rescue Vonage::Error => error
-  if error.is_a? Vonage::ServiceError
-    error.response # => #<Vonage::Response:0x0000555b2e49d4f8>
-    error.response.messages.first.status # => "4"
-    error.response.messages.first.error_text # => "Bad Credentials"
-    error.response.http_response # => #<Net::HTTPOK 200 OK readbody=true>
-  end
-end
-```
 
 ## Overriding the default hosts
 
@@ -263,136 +220,11 @@ Once the message data is created, you can then send the message.
 response = client.messaging.send(to: "447700900000", from: "447700900001", **message)
 ```
 
-## Verify API v2
-
-The [Vonage Verify API v2](https://developer.vonage.com/en/verify/verify-v2/overview) allows you to manage 2FA verification workflows over a number of different channels such as SMS, WhatsApp, WhatsApp Interactive, Voice, Email, and Silent Authentication, either individually or in combination with each other. See the Vonage Developer Documentation for a [complete API reference](https://developer.vonage.com/en/api/verify.v2) listing all the channels, verification options, and callback types.
-
-The Ruby SDK provides two methods for interacting with the Verify v2 API:
-
-- `Verify2#start_verification`: starts a new verification request. Here you can specify options for the request and the workflow to be used.
-- `Verify2#check_code`: for channels where the end-user is sent a one-time code, this method is used to verify the code against the `request_id` of the verification request created by the `start_verification` method.
-
-### Creating a Verify2 Object
-
-```ruby
-verify = client.verify2
-```
-
-### Making a verification request
-
-For simple requests, you may prefer to manually set the value for `workflow` (an array of one or more hashes containing the settings for a particular channel) and any optional params.
-
-Example with the required `:brand` and `:workflow` arguments:
-
-```ruby
-verification_request = verify.start_verification(
-  brand: 'Acme',
-  workflow: [{channel: 'sms', to: '447000000000'}]
-)
-```
-
-Example with the required `:brand` and `:workflow` arguments, and an optional `code_length`:
-
-```ruby
-verification_request = verify.start_verification(
-  brand: 'Acme',
-  workflow: [{channel: 'sms', to: '447000000000'}],
-  code_length: 6
-)
-```
-
-For more complex requests (e.g. with mutliple workflow channels or addtional options), or to take advantage of built-in input validation, you can use the `StartVerificationOptions` object and the `Workflow` and various channel objects or the `WorkflowBuilder`:
-
-#### Create options using StartVerificationOptions object
-
-```ruby
-opts = verify.start_verification_options(
-  locale: 'fr-fr',
-  code_length: 6,
-  client_ref: 'abc-123'
-).to_h
-
-verification_request = verify.start_verification(
-  brand: 'Acme',
-  workflow: [{channel: 'email', to: 'alice.example.com'}],
-  **opts
-)
-```
-
-#### Create workflow using Workflow and Channel objects
-
-```ruby
-# Instantiate a Workflow object
-workflow = verify.workflow
-
-# Add channels to the workflow
-workflow << workflow.sms(to: '447000000000')
-workflow << workflow.email(to: 'alice.example.com')
-
-# Channel data is encpsulated in channel objects stored in the Workflow list array
-workflow.list
-# => [ #<Vonage::Verify2::Channels::SMS:0x0000561474a74778 @channel="sms", @to="447000000000">,
-  #<Vonage::Verify2::Channels::Email:0x0000561474c51a28 @channel="email", @to="alice.example.com">]
-
-# To use the list as the value for `:workflow` in a `start_verification` request call,
-# the objects must be hashified
-workflow_list = workflow.hashified_list
-# => [{:channel=>"sms", :to=>"447000000000"}, {:channel=>"email", :to=>"alice.example.com"}]
-
-verification_request = verify.start_verification(brand: 'Acme', workflow: workflow_list)
-```
-
-#### Create a workflow using the WorkflowBuilder
-
-```ruby
-workflow = verify.workflow_builder.build do |builder|
-  builder.add_voice(to: '447000000001')
-  builder.add_whatsapp(to: '447000000000')
-end
-
-workflow_list = workflow.hashified_list
-# => [{:channel=>"voice", :to=>"447000000001"}, {:channel=>"whatsapp", :to=>"447000000000"}]
-
-verification_request = verify.start_verification(brand: 'Acme', workflow: workflow_list)
-```
-
-### Cancelling a request
-
-You can cancel in in-progress verification request
-
-```ruby
-# Get the `request_id` from the Vonage#Response object returned by the `start_verification` method call
-request_id = verification_request.request_id
-
-verify.cancel_verification_request(request_id: request_id)
-```
-
-### Checking a code
-
-```ruby
-# Get the `request_id` from the Vonage#Response object returned by the `start_verification` method call
-request_id = verification_request.request_id
-
-# Get the one-time code via user input
-# e.g. from params in a route handler or controller action for a form input
-code = params[:code]
-
-begin
-  code_check = verify.check_code(request_id: request_id, code: code)
-rescue => error
-  # an invalid code will raise an exception of type Vonage::ClientError
-end
-
-if code_check.http_response.code == '200'
-  # code is valid
-end
-```
-
 ## Documentation
 
 Vonage Ruby documentation: https://www.rubydoc.info/github/Vonage/vonage-ruby-sdk
 
-Vonage Ruby code examples: https://github.com/Vonage/vonage-ruby-code-snippets
+Vonage Ruby code examples: https://github.com/Nexmo/nexmo-ruby-code-snippets
 
 Vonage APIs API reference: https://developer.nexmo.com/api
 
@@ -420,7 +252,6 @@ The following is a list of Vonage APIs and whether the Ruby SDK provides support
 | Reports API | Beta |❌|
 | SMS API | General Availability |✅|
 | Verify API | General Availability |✅|
-| Verify API v2 | General Availability |✅|
 | Voice API | General Availability |✅|
 
 ## License

data/lib/vonage/client.rb

@@ -61,13 +61,6 @@ module Vonage
       @files ||= T.let(Files.new(config), T.nilable(Vonage::Files))
     end
 
-    # @return [Meetings]
-    #
-    sig { returns(T.nilable(Vonage::Meetings)) }
-    def meetings
-      @meetings ||= T.let(Meetings.new(config), T.nilable(Vonage::Meetings))
-    end
-
     # @return [Messages]
     #
     sig { returns(T.nilable(Vonage::Messages)) }
@@ -103,13 +96,6 @@ module Vonage
       @pricing ||= T.let(PricingTypes.new(config), T.nilable(Vonage::PricingTypes))
     end
 
-    # @return [ProactiveConnect]
-    #
-    sig { returns(T.nilable(Vonage::ProactiveConnect)) }
-    def proactive_connect
-      @proactive_connect ||= T.let(ProactiveConnect.new(config), T.nilable(Vonage::ProactiveConnect))
-    end
-
     # @return [Redact]
     #
     sig { returns(T.nilable(Vonage::Redact)) }
@@ -131,13 +117,6 @@ module Vonage
       @sms ||= T.let(SMS.new(config), T.nilable(Vonage::SMS))
     end
 
-    # @return [Subaccounts]
-    #
-    sig { returns(T.nilable(Vonage::Subaccounts)) }
-    def subaccounts
-      @subaccounts ||= T.let(Subaccounts.new(config), T.nilable(Vonage::Subaccounts))
-    end
-
     # @return [TFA]
     #
     sig { returns(T.nilable(Vonage::TFA)) }
@@ -145,13 +124,6 @@ module Vonage
       @tfa ||= T.let(TFA.new(config), T.nilable(Vonage::TFA))
     end
 
-    # @return [Users]
-    #
-    sig { returns(T.nilable(Vonage::Users)) }
-    def users
-      @users ||= T.let(Users.new(config), T.nilable(Vonage::Users))
-    end
-
     # @return [Verify]
     #
     sig { returns(T.nilable(Vonage::Verify)) }
@@ -159,11 +131,11 @@ module Vonage
       @verify ||= T.let(Verify.new(config), T.nilable(Vonage::Verify))
     end
 
-    # @return [Verify2]
+    # @return [Video]
     #
-    sig { returns(T.nilable(Vonage::Verify2)) }
-    def verify2
-      @verify2 ||= T.let(Verify2.new(config), T.nilable(Vonage::Verify2))
+    sig { returns(T.nilable(Vonage::Video)) }
+    def video
+      @video ||= T.let(Video.new(config), T.nilable(Vonage::Video))
     end
 
     # @return [Voice]

data/lib/vonage/client_error.rb

@@ -1,6 +1,6 @@
 # typed: strong
 
 module Vonage
-  class ClientError < APIError
+  class ClientError < Error
   end
 end

data/lib/vonage/config.rb

@@ -18,7 +18,7 @@ module Vonage
       self.signature_secret = ENV['VONAGE_SIGNATURE_SECRET']
       self.signature_method = ENV['VONAGE_SIGNATURE_METHOD'] || 'md5hash'
       self.token = T.let(nil, T.nilable(String))
-      self.vonage_host = 'api-eu.vonage.com'
+      self.video_host = 'video.api.vonage.com'
     end
 
     # Merges the config with the given options hash.
@@ -130,11 +130,7 @@ module Vonage
 
     # @return [Vonage::Logger]
     #
-    sig { params(logger: T.nilable(
-      defined?(ActiveSupport::BroadcastLogger) ?
-        T.any(::Logger, Vonage::Logger, ActiveSupport::BroadcastLogger)
-      : T.any(::Logger, Vonage::Logger)
-    )).returns(T.nilable(Vonage::Logger)) }
+    sig { params(logger: T.nilable(T.any(::Logger, Vonage::Logger))).returns(T.nilable(Vonage::Logger)) }
     def logger=(logger)
       @logger = T.let(Logger.new(logger), T.nilable(Vonage::Logger))
     end
@@ -204,7 +200,7 @@ module Vonage
     attr_writer :token
 
     sig { returns(String) }
-    attr_accessor :vonage_host
+    attr_accessor :video_host
 
     protected
 

data/lib/vonage/errors.rb

@@ -1,25 +1,14 @@
 # typed: strict
 # frozen_string_literal: true
-require "json"
+require 'json'
 
 module Vonage
   module Errors
     extend T::Sig
 
-    sig do
-      params(
-        response:
-          T.any(
-            Net::HTTPUnauthorized,
-            Net::HTTPClientError,
-            Net::HTTPServerError,
-            T.untyped
-          )
-      ).returns(Vonage::Error)
-    end
+    sig {params(response: T.any(Net::HTTPUnauthorized, Net::HTTPClientError, Net::HTTPServerError, T.untyped)).returns(Vonage::Error)}
     def self.parse(response)
-      exception_class =
-        case response
+      exception_class = case response
         when Net::HTTPUnauthorized
           AuthenticationError
         when Net::HTTPClientError
@@ -27,40 +16,34 @@ module Vonage
         when Net::HTTPServerError
           ServerError
         else
-          APIError
+          Error
         end
 
-      message = response.content_type.to_s.include?("json") ? set_message(response) : ""
-
-      exception_class.new(message, http_response: response)
-    end
-
-    def self.set_message(response)
-      hash = ::JSON.parse(response.body)
-
-      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 hash.key?("message")
-        hash["message"]
-      elsif problem_details?(hash)
-        problem_details_message(hash)
-      else
-        ""
+      message = if response.content_type == 'application/json'
+        hash = ::JSON.parse(response.body)
+
+        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)
+          problem_details_message(hash)
+        end
       end
+
+      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")
+      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@vonage.com if you have any questions."
+      "#{hash['title']}. #{hash['detail']} See #{hash['type']} for more info, or email support@nexmo.com if you have any questions."
     end
   end
 

data/lib/vonage/gsm7.rb

@@ -4,7 +4,7 @@ module Vonage
   module GSM7
     extend T::Sig
     
-    CHARACTERS = "\n\f\r !\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~ ¡£¤¥§¿ÄÅÆÇÉÑÖØÜßàäåæèéìñòöøùüΓΔΘΛΞΠΣΦΨΩ€"
+    CHARACTERS = "\n\f\r !\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~ ¡£¤¥§¿ÄÅÆÉÑÖØÜßàäåæçèéìñòöøùüΓΔΘΛΞΠΣΦΨΩ€"
 
     REGEXP = /\A[#{Regexp.escape(CHARACTERS)}]*\z/
 

data/lib/vonage/keys.rb

@@ -21,7 +21,13 @@ module Vonage
         'voice_callback_value',
         'voice_status_callback',
         'messages_callback_value',
-        'messages_callback_type'
+        'messages_callback_type',
+        'add_stream',
+        'has_audio',
+        'has_video',
+        'remove_stream',
+        'screenshare_type',
+        'archive_mode'
       ]
       hash.transform_keys do |k|
         if exceptions.include?(k.to_s)

data/lib/vonage/logger.rb

@@ -7,11 +7,7 @@ module Vonage
   class Logger
     extend T::Sig
 
-    sig { params(logger: T.nilable(
-      defined?(ActiveSupport::BroadcastLogger) ?
-        T.any(::Logger, Vonage::Logger, ActiveSupport::BroadcastLogger)
-      : T.any(::Logger, Vonage::Logger)
-    )).void }
+    sig { params(logger: T.nilable(T.any(::Logger, Vonage::Logger))).void }
     def initialize(logger)
       @logger = logger || ::Logger.new(nil)
     end
@@ -24,6 +20,8 @@ module Vonage
 
     sig { params(request: T.any(Net::HTTP::Post, Net::HTTP::Get, Net::HTTP::Delete, Net::HTTP::Put, Net::HTTP::Patch)).void }
     def log_request_info(request)
+      @logger = T.let(@logger, T.nilable(T.any(::Logger, Vonage::Logger)))
+
       T.must(@logger).info do
         format('Vonage API request', {
           method: request.method,

data/lib/vonage/messaging/channels/viber.rb

@@ -2,7 +2,7 @@
 
 module Vonage
   class Messaging::Channels::Viber  < Messaging::Message
-    MESSAGE_TYPES = ['text', 'image', 'video', 'file']
+    MESSAGE_TYPES = ['text', 'image']
 
     attr_reader :data
 
@@ -33,13 +33,6 @@ module Vonage
       when 'image'
         raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
         raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
-      when 'video'
-        raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
-        raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
-        raise Vonage::ClientError.new(":thumb_url is required in :message") unless message[:thumb_url]
-      when 'file'
-        raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
-        raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
       end
     end
   end

data/lib/vonage/messaging/channels/whats_app.rb

@@ -2,7 +2,7 @@
 
 module Vonage
   class Messaging::Channels::WhatsApp < Messaging::Message
-    MESSAGE_TYPES = ['text', 'image', 'audio', 'video', 'file', 'template', 'sticker', 'custom']
+    MESSAGE_TYPES = ['text', 'image', 'audio', 'video', 'file', 'template', 'custom']
 
     attr_reader :data
 
@@ -35,8 +35,6 @@ module Vonage
         raise Vonage::ClientError.new(":name is required in :template") unless message[:name]
         raise Vonage::ClientError.new(":whatsapp is required in :opts") unless opts[:whatsapp]
         raise Vonage::ClientError.new(":locale is required in :whatsapp") unless opts[:whatsapp][:locale]
-      when 'sticker'
-        raise Vonage::ClientError.new(":message must contain either :id or :url") unless message.has_key?(:id) ^ message.has_key?(:url)
       when 'custom'
         raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
       else