vonage 7.35.0 → 8.0.0.beta

data/lib/vonage/voice/actions/input.rb

@@ -3,7 +3,7 @@
 
 module Vonage
   class Voice::Actions::Input
-    attr_accessor :type, :dtmf, :speech, :eventUrl, :eventMethod, :mode
+    attr_accessor :type, :dtmf, :speech, :eventUrl, :eventMethod
 
     def initialize(attributes = {})
       @type = attributes.fetch(:type)
@@ -11,7 +11,6 @@ module Vonage
       @speech = attributes.fetch(:speech, nil)
       @eventUrl = attributes.fetch(:eventUrl, nil)
       @eventMethod = attributes.fetch(:eventMethod, nil)
-      @mode = attributes.fetch(:mode, nil)
 
       after_initialize!
     end
@@ -34,10 +33,6 @@ module Vonage
       if self.eventMethod
         validate_event_method
       end
-
-      if self.mode
-        validate_mode
-      end
     end
 
     def validate_type
@@ -85,23 +80,12 @@ module Vonage
       if self.speech[:maxDuration]
         raise ClientError.new("Expected 'maxDuration' to not be more than 60 seconds") unless self.speech[:maxDuration] <= 60 && self.speech[:maxDuration] >= 0
       end
-
-      if self.speech[:provider]
-        valid_providers = ['google']
-
-        raise ClientError.new("Invalid 'provider' value, must be one of: #{valid_providers.join(', ')}") unless valid_providers.include?(self.speech[:provider])
-        raise ClientError.new("The `providerOptions` parameter is required when specifying a `provider`") unless self.speech[:providerOptions]
-      end
     end
 
     def validate_event_url
-      unless self.eventUrl.is_a?(Array) && self.eventUrl.length == 1 && self.eventUrl[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(self.eventUrl[0])
+      uri = URI.parse(self.eventUrl)
 
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.eventUrl
     end
@@ -112,12 +96,6 @@ module Vonage
       raise ClientError.new("Invalid 'eventMethod' value. must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
     end
 
-    def validate_mode
-      valid_modes = ['asyncronous']
-
-      raise ClientError.new("Invalid 'mode' value, must be asyncronous'") unless valid_modes.include?(self.mode)
-    end
-
     def action
       create_input!(self)
     end
@@ -134,7 +112,6 @@ module Vonage
       ncco[0].merge!(speech: builder.speech) if builder.speech
       ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
       ncco[0].merge!(eventMethod: builder.eventMethod) if builder.eventMethod
-      ncco[0].merge!(mode: builder.mode) if builder.mode
 
       ncco
     end

data/lib/vonage/voice/actions/notify.rb

@@ -22,15 +22,10 @@ module Vonage
     end
 
     def validate_event_url
-      event_url = self.eventUrl
+      uri = URI.parse(self.eventUrl[0])
 
-      unless event_url.is_a?(Array) && event_url.length == 1 && event_url[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(event_url[0])
-
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Expected 'eventUrl' value to be an Array with a single string") unless self.eventUrl.is_a?(Array)
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.eventUrl
     end

data/lib/vonage/voice/actions/pay.rb

@@ -0,0 +1,107 @@
+# typed: true
+# frozen_string_literal: true
+module Vonage
+  class Voice::Actions::Pay
+    attr_accessor :amount, :currency, :eventUrl, :prompts, :voice
+
+    def initialize(attributes= {})
+      @amount = attributes.fetch(:amount)
+      @currency = attributes.fetch(:currency, nil)
+      @eventUrl = attributes.fetch(:eventUrl, nil)
+      @prompts = attributes.fetch(:prompts, nil)
+      @voice = attributes.fetch(:voice, nil)
+
+      after_initialize!
+    end
+
+    def action
+      create_pay!(self)
+    end
+
+    def create_pay!(builder)
+      ncco = [
+        {
+          action: 'pay',
+          amount: builder.amount
+        }
+      ]
+
+      ncco[0].merge!(currency: builder.currency) if builder.currency
+      ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
+      ncco[0].merge!(prompts: builder.prompts) if builder.prompts
+      ncco[0].merge!(voice: builder.voice) if builder.voice
+
+      ncco
+    end
+
+    private
+
+    def after_initialize!
+      verify_amount
+
+      if self.eventUrl
+        verify_event_url
+      end
+
+      if self.prompts
+        verify_prompts
+      end
+
+      if self.voice
+        verify_voice
+      end
+    end
+
+    def verify_amount
+      verify_amount_class
+      verify_amount_value
+    end
+
+    def verify_event_url
+      raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item") unless self.eventUrl.is_a?(Array)
+
+      uri = URI.parse(self.eventUrl[0])
+
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+    end
+
+    def verify_prompts
+      verify_prompts_structure
+      verify_prompts_values
+    end
+
+    def verify_voice
+      verify_voice_structure
+      verify_voice_style if self.voice[:style]
+    end
+
+    def verify_amount_class
+      raise ClientError.new("Invalid 'amount' value, must be a float") unless self.amount.is_a?(Float)
+    end
+
+    def verify_amount_value
+      raise ClientError.new("Invalid 'amount' value, must be greater than 0") unless self.amount > 0
+    end
+
+    def verify_prompts_structure
+      raise ClientError.new("Invalid 'prompt', must be an array of at least one hash") unless self.prompts.is_a?(Array) && !self.prompts.empty? && self.prompts.all?(Hash)
+    end
+
+    def verify_prompts_values
+      self.prompts.each do |prompt|
+        prompt_keys = prompt.keys
+        [:type, :text, :errors].each do |key|
+          raise ClientError.new("Invalid 'prompt', '#{key}' is required") unless prompt_keys.include?(key)
+        end
+      end
+    end
+
+    def verify_voice_structure
+      raise ClientError.new("Expected 'voice' value to be a Hash") unless self.voice.is_a?(Hash)
+    end
+
+    def verify_voice_style
+      raise ClientError.new("Expected 'style' value to be an Integer") unless self.voice[:style].is_a?(Integer)
+    end
+  end
+end

data/lib/vonage/voice/actions/record.rb

@@ -3,7 +3,7 @@
 
 module Vonage
   class Voice::Actions::Record
-    attr_accessor :format, :split, :channels, :endOnSilence, :endOnKey, :timeOut, :beepStart, :eventUrl, :eventMethod, :transcription
+    attr_accessor :format, :split, :channels, :endOnSilence, :endOnKey, :timeOut, :beepStart, :eventUrl, :eventMethod
 
     def initialize(attributes = {})
       @format = attributes.fetch(:format, nil)
@@ -15,7 +15,6 @@ module Vonage
       @beepStart = attributes.fetch(:beepStart, nil)
       @eventUrl = attributes.fetch(:eventUrl, nil)
       @eventMethod = attributes.fetch(:eventMethod, nil)
-      @transcription = attributes.fetch(:transcription, nil)
 
       after_initialize!
     end
@@ -56,10 +55,6 @@ module Vonage
       if self.eventMethod
         validate_event_method
       end
-
-      if self.transcription
-        validate_transcription
-      end
     end
 
     def validate_format
@@ -95,13 +90,9 @@ module Vonage
     end
 
     def validate_event_url
-      unless self.eventUrl.is_a?(Array) && self.eventUrl.length == 1 && self.eventUrl[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
+      uri = URI.parse(self.eventUrl)
 
-      uri = URI.parse(self.eventUrl[0])
-
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.eventUrl
     end
@@ -109,45 +100,7 @@ module Vonage
     def validate_event_method
       valid_methods = ['GET', 'POST']
 
-      raise ClientError.new("Invalid 'eventMethod' value. Must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
-    end
-
-    def validate_transcription
-      raise ClientError.new("Expected 'transcription' parameter to be a Hash") unless self.transcription.is_a?(Hash)
-
-      if self.transcription[:language]
-        raise ClientError.new("Invalid 'language' value, must be a String") unless self.transcription[:language].is_a?(String)
-      end
-
-      if self.transcription[:eventUrl]
-        event_url = self.transcription[:eventUrl]
-
-        unless event_url.is_a?(Array) && event_url.length == 1 && event_url[0].is_a?(String)
-          raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-        end
-
-        uri = URI.parse(event_url[0])
-
-        raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
-      end
-
-      if self.transcription[:eventMethod]
-        event_method = self.transcription[:eventMethod]
-        raise ClientError.new("Invalid 'eventMethod' value, must be either: 'GET' or 'POST'") unless ['GET', 'POST'].include?(event_method.upcase)
-      end
-
-      if self.transcription[:sentimentAnalysis]
-        sentiment_analysis = self.transcription[:sentimentAnalysis]
-        raise ClientError.new("Invalid 'sentimentAnalysis' value, must be a Boolean") unless sentiment_analysis == true || sentiment_analysis == false
-      end
-
-      # if self.dtmf[:maxDigits]
-      #   raise ClientError.new("Expected 'maxDigits' to not be more than 22") if self.dtmf[:maxDigits] > 22
-      # end
-
-      # if self.dtmf[:submitOnHash]
-      #   raise ClientError.new("Invalid 'submitOnHash' value, must be a Boolean") unless self.dtmf[:submitOnHash] == true || self.dtmf[:submitOnHash] == false
-      # end
+      raise ClientError.new("Invalid 'eventMethod' value. must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
     end
 
     def action
@@ -170,7 +123,6 @@ module Vonage
       ncco[0].merge!(beepStart: builder.beepStart) if builder.beepStart
       ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
       ncco[0].merge!(eventMethod: builder.eventMethod) if builder.eventMethod
-      ncco[0].merge!(transcription: builder.transcription) if builder.transcription
 
       ncco
     end

data/lib/vonage/voice/actions/stream.rb

@@ -31,13 +31,9 @@ module Vonage
     end
 
     def verify_stream_url
-      stream_url = self.streamUrl
+      raise ClientError.new("Expected 'streamUrl' parameter to be an Array containing a single string item") unless self.streamUrl.is_a?(Array)
 
-      unless stream_url.is_a?(Array) && stream_url.length == 1 && stream_url[0].is_a?(String)
-        raise ClientError.new("Expected 'streamUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(stream_url[0])
+      uri = URI.parse(self.streamUrl[0])
 
       raise ClientError.new("Invalid 'streamUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
     end
@@ -51,7 +47,7 @@ module Vonage
     end
 
     def verify_loop
-      raise ClientError.new("Expected 'loop' value to be either 0 or a positive integer") unless self.loop >= 0
+      raise ClientError.new("Expected 'loop' value to be either 1 or 0") unless self.loop == 1 || self.loop == 0
     end
 
     def action

data/lib/vonage/voice/actions/talk.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 module Vonage
   class Voice::Actions::Talk
-    attr_accessor :text, :bargeIn, :loop, :level, :language, :style, :premium, :provider, :providerOptions
+    attr_accessor :text, :bargeIn, :loop, :level, :language, :style
 
     def initialize(attributes= {})
       @text = attributes.fetch(:text)
@@ -11,15 +11,12 @@ module Vonage
       @level = attributes.fetch(:level, nil)
       @language = attributes.fetch(:language, nil)
       @style = attributes.fetch(:style, nil)
-      @premium = attributes.fetch(:premium, nil)
-      @provider = attributes.fetch(:provider, nil)
-      @providerOptions = attributes.fetch(:providerOptions, nil)
 
       after_initialize!
     end
 
     def after_initialize!
-      if self.bargeIn || self.bargeIn == false
+      if self.bargeIn
         verify_barge_in
       end
 
@@ -34,14 +31,6 @@ module Vonage
       if self.style
         verify_style
       end
-
-      if self.premium || self.premium == false
-        verify_premium
-      end
-
-      if self.provider
-        verify_provider
-      end
     end
 
     def verify_barge_in
@@ -49,7 +38,7 @@ module Vonage
     end
 
     def verify_loop
-      raise ClientError.new("Expected 'loop' value to be either 0 or a positive integer") unless self.loop >= 0
+      raise ClientError.new("Expected 'loop' value to be either 1 or 0") unless self.loop == 1 || self.loop == 0
     end
 
     def verify_level
@@ -60,17 +49,6 @@ module Vonage
       raise ClientError.new("Expected 'style' value to be an Integer") unless self.style.is_a?(Integer)
     end
 
-    def verify_premium
-      raise ClientError.new("Expected 'premium' value to be a Boolean") unless self.premium == true || self.premium == false
-    end
-
-    def verify_provider
-      valid_providers = ['google']
-
-      raise ClientError.new("Invalid 'provider' value, must be one of: #{valid_providers.join(', ')}") unless valid_providers.include?(self.provider)
-      raise ClientError.new("The `providerOptions` parameter is required when specifying a `provider`") unless self.providerOptions
-    end
-
     def action
       create_talk!(self)
     end
@@ -88,11 +66,8 @@ module Vonage
       ncco[0].merge!(level: builder.level) if builder.level
       ncco[0].merge!(language: builder.language) if builder.language
       ncco[0].merge!(style: builder.style) if builder.style
-      ncco[0].merge!(premium: builder.premium) if (builder.premium || builder.premium == false)
-      ncco[0].merge!(provider: builder.provider) if builder.provider
-      ncco[0].merge!(providerOptions: builder.providerOptions) if builder.providerOptions
 
       ncco
     end
   end
-end
+end

data/lib/vonage/voice/ncco.rb

@@ -10,9 +10,7 @@ module Vonage
       notify: Vonage::Voice::Actions::Notify,
       record: Vonage::Voice::Actions::Record,
       stream: Vonage::Voice::Actions::Stream,
-      talk: Vonage::Voice::Actions::Talk,
-      wait: Vonage::Voice::Actions::Wait,
-      transfer: Vonage::Voice::Actions::Transfer    
+      talk: Vonage::Voice::Actions::Talk
     }
 
     class << self

data/lib/vonage/voice/talk.rb

@@ -12,18 +12,8 @@ module Vonage
     # @option params [required, String] :text
     #   The text to read.
     #
-    # @option params [String] :language
-    #   The language to use. See {https://developer.vonage.com/en/api/voice#startTalk-req-body} for a list of valid language codes.
-    #
-    # @option params [Integer] :style
-    #   The vocal style, as identified by an assigned integer.
-    #     See {https://developer.vonage.com/en/voice/voice-api/concepts/text-to-speech#supported-languages} for a list of available styles.
-    #
-    # @option params [Boolean] :premium
-    #   Set to `true` to use the premium version of the specified style if available, otherwise the standard version will be used.
-    #
     # @option params [String] :voice_name
-    #   The voice & language to use. [DEPRECATED: use `language` and `style` instead].
+    #   The voice & language to use.
     #
     # @option params [Integer] :loop
     #   The number of times to repeat the text the file, 0 for infinite.

data/lib/vonage/voice.rb

@@ -18,8 +18,6 @@ module Vonage
     #
     # @option params [required, Array<Hash>] :to
     #   Connect to a Phone (PSTN) number, SIP Endpoint, Websocket, or VBC extension.
-    #   The `to` Hash can contain a number of different properties depending on the `type`.
-    #   See the API reference for specific details.
     #
     # @option params [Hash] :from
     #   Connect to a Phone (PSTN) number. Should not be set if **:random_from_number** is **true**
@@ -50,17 +48,6 @@ module Vonage
     # @option params [String] :machine_detection
     #   Configure the behavior when Vonage detects that the call is answered by voicemail.
     #
-    # @option params [Hash] :advanced_machine_detection
-    #   Configure the behavior of Vonage's advanced machine detection. Overrides machine_detection if both are set.
-    #   Hash with three possible properties:
-    #     - :behavior [String]: Must be one of `continue` or `hangup`. When hangup is used, the call will be terminated if a
-    #         machine is detected. When continue is used, the call will continue even if a machine is detected.
-    #     - :mode [String]: Must be one of `detect` or `detect_beep`. Detect if machine answered and sends a human or
-    #         machine status in the webhook payload. When set to `detect_beep`, the system also attempts to detect
-    #         voice mail beep and sends an additional parameter `sub_state` in the webhook with the value `beep_start`.
-    #     - :beep_timeout [Integer]: Min: 45, Max: 120. Maximum time in seconds Vonage should wait for a machine beep
-    #         to be detected. A machine event with `sub_state` set to `beep_timeout` will be sent if the timeout is exceeded.
-    #
     # @option params [Integer] :length_timer
     #   Set the number of seconds that elapse before Vonage hangs up after the call state changes to in_progress.
     #
@@ -281,16 +268,5 @@ module Vonage
     def dtmf
       @dtmf ||= DTMF.new(@config)
     end
-
-    # Validate a JSON Web Token from a Voice API Webhook.
-    #
-    # @param [String, required] :token The JWT from the Webhook's Authorization header
-    # @param [String, optional] :signature_secret The account signature secret. Required, unless `signature_secret`
-    #   is set in `Config`
-    #
-    # @return [Boolean] true, if the JWT is verified, false otherwise
-    def verify_webhook_token(token:, signature_secret: @config.signature_secret)
-      JWT.verify_hs256_signature(token: token, signature_secret: signature_secret)
-    end
   end
 end

data/lib/vonage.rb

@@ -7,16 +7,12 @@ module Vonage
   loader = Zeitwerk::Loader.new
   loader.tag = File.basename(__FILE__, '.rb')
   loader.inflector.inflect({
-    'api_error' => 'APIError',
     'dtmf' => 'DTMF',
     'gsm7' => 'GSM7',
     'http' => 'HTTP',
     'json' => 'JSON',
     'jwt' => 'JWT',
-    'rcs' => 'RCS',
-    'sip' => 'SIP',
     'sms' => 'SMS',
-    'network_sim_swap' => 'NetworkSIMSwap',
     'mms' => 'MMS',
     'tfa' => 'TFA',
     'version' => 'VERSION',

data/vonage.gemspec

@@ -12,11 +12,9 @@ Gem::Specification.new do |s|
   s.summary = 'This is the Ruby Server SDK for Vonage APIs. To use it you\'ll need a Vonage account. Sign up for free at https://www.vonage.com'
   s.files = Dir.glob('lib/**/*.rb') + %w(LICENSE.txt README.md vonage.gemspec)
   s.required_ruby_version = '>= 2.5.0'
-  s.add_dependency('vonage-jwt', '~> 0.2.0')
+  s.add_dependency('vonage-jwt', '~> 0.1.0')
   s.add_dependency('zeitwerk', '~> 2', '>= 2.2')
   s.add_dependency('sorbet-runtime', '~> 0.5')
-  s.add_dependency('multipart-post', '~> 2.0')
-  s.add_dependency('net-http-persistent', '~> 4.0', '>= 4.0.2')
   s.add_runtime_dependency('rexml')
   s.add_runtime_dependency('phonelib')
   s.require_path = 'lib'