vonage 7.28.0 → 8.0.0.beta

data/lib/vonage/numbers.rb

@@ -5,8 +5,6 @@ module Vonage
   class Numbers < Namespace
     include Keys
 
-    self.authentication = Basic
-
     self.host = :rest_host
 
     # Retrieve all the inbound numbers associated with your Vonage account.
@@ -17,8 +15,6 @@ module Vonage
     #     puts "#{item.msisdn} #{item.country} #{item.type}"
     #   end
     #
-    # @param [Hash] params
-    #
     # @option params [String] :application_id
     #   The application that you want to return the numbers for.
     #
@@ -49,12 +45,14 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
+    # @param [Hash] params
+    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getOwnedNumbers
     #
     def list(params = nil)
-      request("/account/numbers", params: params, response_class: ListResponse)
+      request('/account/numbers', params: params, response_class: ListResponse)
     end
 
     # Retrieve inbound numbers that are available for the specified country.
@@ -65,8 +63,6 @@ module Vonage
     #     puts "#{item.msisdn} #{item.type} #{item.cost}"
     #   end
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -84,7 +80,7 @@ module Vonage
     #   - `2` - Search for numbers that end with **:pattern**
     #
     # @option params [String] :features
-    #   Available features are `SMS`, `MMS`, and `VOICE`.
+    #   Available features are `SMS` and `VOICE`.
     #   To look for numbers that support both, use a comma-separated value: `SMS,VOICE`.
     #
     # @option params [Integer] :size
@@ -97,12 +93,14 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
+    # @param [Hash] params
+    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getAvailableNumbers
     #
     def search(params)
-      request("/number/search", params: params, response_class: ListResponse)
+      request('/number/search', params: params, response_class: ListResponse)
     end
 
     # Request to purchase a specific inbound number.
@@ -110,8 +108,6 @@ module Vonage
     # @example
     #   response = client.numbers.buy(country: 'GB', msisdn: '447700900000')
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -122,17 +118,14 @@ module Vonage
     #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
     #   If you'd like to perform an action on your own account, you do not need to provide this field.
     #
+    # @param [Hash] params
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#buyANumber
     #
     def buy(params)
-      request(
-        "/number/buy",
-        params: params,
-        type: Post,
-        response_class: Response
-      )
+      request('/number/buy', params: params, type: Post, response_class: Response)
     end
 
     # Cancel your subscription for a specific inbound number.
@@ -140,8 +133,6 @@ module Vonage
     # @example
     #   response = client.numbers.cancel(country: 'GB', msisdn: '447700900000')
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -152,17 +143,14 @@ module Vonage
     #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
     #   If you'd like to perform an action on your own account, you do not need to provide this field.
     #
+    # @param [Hash] params
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#cancelANumber
     #
     def cancel(params)
-      request(
-        "/number/cancel",
-        params: params,
-        type: Post,
-        response_class: Response
-      )
+      request('/number/cancel', params: params, type: Post, response_class: Response)
     end
 
     # Change the behaviour of a number that you own.
@@ -177,8 +165,6 @@ module Vonage
     #
     #   response = client.numbers.update(params)
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -205,30 +191,21 @@ module Vonage
     # @option params [String] :voice_status_callback
     #   A webhook URI for Vonage to send a request to when a call ends.
     #
+    # @param [Hash] params
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#updateANumber
     #
     def update(params)
-      request(
-        "/number/update",
-        params: camelcase(params),
-        type: Post,
-        response_class: Response
-      )
+      request('/number/update', params: camelcase(params), type: Post, response_class: Response)
     end
 
     private
 
     # A specific implementation of iterable_request for Numbers, because the Numbers API
     # handles pagination differently to other Vonage APIs
-    def iterable_request(
-      path,
-      response: nil,
-      response_class: nil,
-      params: {},
-      &block
-    )
+    def iterable_request(path, response: nil, response_class: nil, params: {}, &block)
       response = parse(response, response_class)
       params[:index] = 1 unless params.has_key?(:index)
       size = params.fetch(:size, 10)

data/lib/vonage/server_error.rb

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

data/lib/vonage/signature.rb

@@ -27,24 +27,24 @@ module Vonage
     #
     # @see https://developer.nexmo.com/concepts/guides/signing-messages
     #
-    def check(params, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
+    def check(params, signature_method: @config.signature_method)
       params = params.dup
 
       signature = params.delete('sig')
 
-      ::JWT::JWA::Hmac::SecurityUtils.secure_compare(signature, digest(params, signature_secret, signature_method))
+      ::JWT::SecurityUtils.secure_compare(signature, digest(params, signature_method))
     end
 
     private
 
-    def digest(params, signature_secret, signature_method)
+    def digest(params, signature_method)
       digest_string = params.sort.map { |k, v| "&#{k}=#{v.tr('&=', '_')}" }.join
 
       case signature_method
       when 'md5', 'sha1', 'sha256', 'sha512'
-        OpenSSL::HMAC.hexdigest(signature_method, signature_secret, digest_string).upcase
+        OpenSSL::HMAC.hexdigest(signature_method, @config.signature_secret, digest_string).upcase
       when 'md5hash'
-        Digest::MD5.hexdigest("#{digest_string}#{signature_secret}")
+        Digest::MD5.hexdigest("#{digest_string}#{@config.signature_secret}")
       else
         raise ArgumentError, "Unknown signature algorithm: #{signature_method}. Expected: md5hash, md5, sha1, sha256, or sha512."
       end

data/lib/vonage/sms.rb

@@ -47,6 +47,14 @@ module Vonage
     # @option params [String] :type
     #   The format of the message body.
     #
+    # @option params [String] :vcard
+    #   A business card in [vCard format](https://en.wikipedia.org/wiki/VCard).
+    #   Depends on **:type** option having the value `vcard`.
+    #
+    # @option params [String] :vcal
+    #   A calendar event in [vCal format](https://en.wikipedia.org/wiki/VCal).
+    #   Depends on **:type** option having the value `vcal`.
+    #
     # @option params [String] :body
     #   Hex encoded binary data.
     #   Depends on **:type** option having the value `binary`.
@@ -59,6 +67,18 @@ module Vonage
     #   The value of the [protocol identifier](https://en.wikipedia.org/wiki/GSM_03.40#Protocol_Identifier) to use.
     #   Ensure that the value is aligned with **:udh**.
     #
+    # @option params [String] :title
+    #   The title for a wappush SMS.
+    #   Depends on **:type** option having the value `wappush`.
+    #
+    # @option params [String] :url
+    #   The URL of your website.
+    #   Depends on **:type** option having the value `wappush`.
+    #
+    # @option params [String] :validity
+    #   The availability for an SMS in milliseconds.
+    #   Depends on **:type** option having the value `wappush`.
+    #
     # @option params [String] :client_ref
     #   You can optionally include your own reference of up to 40 characters.
     #
@@ -91,31 +111,11 @@ module Vonage
       response
     end
 
-    # Validate a Signature from an SMS API Webhook.
-    #
-    # @param [Hash, required] :webhook_params The parameters from the webhook request body
-    # @param [String, optional] :signature_secret The account signature secret. Required, unless `signature_secret`
-    #   is set in `Config`
-    # @param [String, optional] :signature_method The account signature method. Required, unless `signature_method`
-    #   is set in `Config`
-    #
-    # @return [Boolean] true, if the JWT is verified, false otherwise
-    def verify_webhook_sig(webhook_params:, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
-      signature.check(webhook_params, signature_secret: signature_secret, signature_method: signature_method)
-    end
-
     private
 
     sig { params(text: String).returns(T::Boolean) }
     def unicode?(text)
       !Vonage::GSM7.encoded?(text)
     end
-
-    # @return [Signature]
-    #
-    sig { returns(T.nilable(Vonage::Signature)) }
-    def signature
-      @signature ||= T.let(Signature.new(@config), T.nilable(Vonage::Signature))
-    end
   end
 end

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = '7.28.0'
+  VERSION = '8.0.0.beta'
 end

data/lib/vonage/video/archives.rb

@@ -13,6 +13,8 @@ module Vonage
 
     # Get a list of archives for a specified Vonage application.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [optional, Integer] :offset
     #
     # @param [optional, Integer] :count
@@ -25,24 +27,32 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def list(**params)
-      request('/v2/project/' + @config.application_id + '/archive', params: params, response_class: ListResponse)
+    def list(application_id: @config.application_id, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive', params: params, response_class: Video::ListResponse)
     end
 
     # Return information for specified archive.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] archive_id
     #
     # @return [Response]
     #
     # @see TODO: add docs link
     #
-    def info(archive_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id)
+    def info(application_id: @config.application_id, archive_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id)
     end
 
     # Create a new archive.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] :session_id
     #
     # @param [optional, String] :hasAudio
@@ -71,39 +81,52 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def start(session_id:, **params)
-      request('/v2/project/' + @config.application_id + '/archive', params: camelcase(params.merge(session_id: session_id)), type: Post)
+    def start(application_id: @config.application_id, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: raise error if session_id is nil
+
+      request('/v2/project/' + application_id + '/archive', params: params, type: Post)
     end
 
     # Stop recording a specified archive.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] archive_id
     #
     # @return [Response]
     #
     # @see TODO: add docs link
     #
-    def stop(archive_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/stop', type: Post)
+    def stop(application_id: @config.application_id, archive_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/stop', type: Post)
     end
 
     # Delete a specified archive.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] archive_id
     #
     # @return [Response]
     #
     # @see TODO: add docs link
     #
-    def delete(archive_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id, type: Delete)
+    def delete(application_id: @config.application_id, archive_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id, type: Delete)
     end
 
     # Add a stream to a composed archive that was started with the streamMode set to "manual".
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] archive_id
     #
-    # @param [required, String] stream_id The ID of the stream to be added
+    # @param [required, String] add_stream The ID of the stream to be added
     #
     # @param [optional, Boolean] has_audio
     #
@@ -113,26 +136,36 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def add_stream(archive_id:, stream_id:, **params)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/streams', params: camelcase(params.merge(addStream: stream_id)), type: Patch)
+    def add_stream(application_id: @config.application_id, archive_id:, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: raise error if add_stream is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/streams', params: camelcase(params), type: Patch)
     end
 
     # Remove a stream from a composed archive that was started with the streamMode set to "manual".
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] archive_id
     #
-    # @param [required, String] stream_id The ID of the stream to be removed
+    # @param [required, String] remove_stream The ID of the stream to be removed
     #
     # @return [Response]
     #
     # @see TODO: add docs link
     #
-    def remove_stream(archive_id:, stream_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/streams', params: {removeStream: stream_id}, type: Patch)
+    def remove_stream(application_id: @config.application_id, archive_id:, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: raise error if remove_stream is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/streams', params: camelcase(params), type: Patch)
     end
 
     # Change the layout of a composed archive while it is being recorded.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] archive_id
     #
     # @param [optional, String] type
@@ -145,8 +178,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def change_layout(archive_id:, **params)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/layout', params: camelcase(params), type: Put)
+    def change_layout(application_id: @config.application_id, archive_id:, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/layout', params: camelcase(params), type: Put)
     end
   end
 end

data/lib/vonage/video/list_response.rb

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Video::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.calls.each { |item| yield item }
+  end
+end

data/lib/vonage/video/moderation.rb

@@ -11,6 +11,8 @@ module Vonage
 
     # Force a client to disconnect from a session.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] :session_id
     #
     # @param [required, String] :connection_id The connection ID of the specific participant to be disconnected from the session.
@@ -19,12 +21,16 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def force_disconnect(session_id:, connection_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id, type: Delete)
+    def force_disconnect(application_id: @config.application_id, session_id:, connection_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/connection/' + connection_id, type: Delete)
     end
 
     # Force mute a specific publisher stream in a session.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] :session_id
     #
     # @param [required, String] :stream_id The stream ID of the specific stream to be muted.
@@ -33,26 +39,35 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def mute_single_stream(session_id:, stream_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream/' + stream_id + '/mute', type: Post)
+    def mute_single_stream(application_id: @config.application_id, session_id:, stream_id:)
+      application_id ||= @config.application_id
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream/' + stream_id + '/mute', type: Post)
     end
 
     # Force mute all publisher stream for a specific session.
     #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
     # @param [required, String] :session_id
     #
     # @param [required, String] :active
     #
-    # @param [required, Array<String>] :excludedStreamIds
+    # @param [required, Array<String>] :excludedStreamIds 
     #
     # @return [Response]
     #
     # @see TODO: add docs link
     #
-    def mute_multiple_streams(session_id:, **params)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/mute', params: params, type: Post)
+    def mute_multiple_streams(application_id: @config.application_id, session_id:, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: camelcase params
+      
+      request('/v2/project/' + application_id + '/session/' + session_id + '/mute', params: params, type: Post)
     end
 
     # TODO: add disable_force_mute ??
   end
 end
+  

data/lib/vonage/video/signals.rb

@@ -25,8 +25,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def send_to_one(session_id:, connection_id:, **params)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id + '/signal', params: params, type: Post)
+    def send_to_one(application_id: @config.application_id, session_id:, connection_id:, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/connection/' + connection_id + '/signal', params: params, type: Post)
     end
 
     # Send a signal to all participants in an active Vonage Video session.
@@ -43,8 +45,11 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def send_to_all(session_id:, **params)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/signal', params: params, type: Post)
+    def send_to_all(application_id: @config.application_id, session_id:, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/signal', params: params, type: Post)
     end
   end
 end
+  

data/lib/vonage/video/streams.rb

@@ -22,8 +22,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def list(session_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream', response_class: ListResponse)
+    def list(application_id: @config.application_id, session_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream', response_class: Video::ListResponse)
     end
 
     # Get information about a specified stream.
@@ -38,8 +40,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def info(session_id:, stream_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream/' + stream_id)
+    def info(application_id: @config.application_id, session_id:, stream_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream/' + stream_id)
     end
 
     # Change the layout for a list of specified streams.
@@ -58,13 +62,15 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def change_layout(session_id:, **params)
+    def change_layout(application_id: @config.application_id, session_id:, **params)
+      # TODO: raise error if application_id is nil
       # TODO camelcase layout_class_list
       # if params[:items]
       #   params[:items] = params[:items].map {|item| camelcase(item)}
       # end
 
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream', params: params, type: Put)
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream', params: params, type: Put)
     end
   end
 end
+