vonage 7.8.1 → 8.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16cb2584a98415fd28d34ff48e122bba7e74dc3274f3ccbce54e573bb5639d75
-  data.tar.gz: 4dde646ce5357983ac61bd80981e758875f0289e535afdb1b961c230895489b8
+  metadata.gz: e003a6ed3211d3eace84884bf3fb03d21b81f097b13aba079f1906daf95380ff
+  data.tar.gz: 956c6921b50df45aaf2f1901b08ccd3cb164c2553b23d8e45570f63dcdf6f960
 SHA512:
-  metadata.gz: ce5cc6037fcc81f6ce5cd99ec6b61a0a237fd94502dd85bd5a7e98bbc768834b8108babc3d4f81ff1f85fc9668d41165b3464f20f1218295b3a462d5343d4482
-  data.tar.gz: 464c94d4e284b83c68796f6324ec54a8e0c70d93537b800f8b140d5425db14f575369b1a500e2595cce0559371d363033508cce9c49737bbb6a20be238b0a10e
+  metadata.gz: 1500879cd4a974009f6510cf12ea15b4ce60a9163f916b8a5e07fe785323c24c6909134163b21e29afc9c251550fd36a9e348c2ff7eac3b18b45f0e4ef7e1be1
+  data.tar.gz: fe368d23b897a7f1b2b9ba473c993a351ffb1233ef80304c16ec69ed28692c93e422c7a453f8d0da14b6e038424c215026a945d7ccee9b4a26412e3ecbe5435f

data/lib/vonage/client.rb

@@ -131,6 +131,13 @@ module Vonage
       @verify ||= T.let(Verify.new(config), T.nilable(Vonage::Verify))
     end
 
+    # @return [Video]
+    #
+    sig { returns(T.nilable(Vonage::Video)) }
+    def video
+      @video ||= T.let(Video.new(config), T.nilable(Vonage::Video))
+    end
+
     # @return [Voice]
     #
     sig { returns(T.nilable(Vonage::Voice)) }

data/lib/vonage/config.rb

@@ -18,6 +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.video_host = 'video.api.vonage.com'
     end
 
     # Merges the config with the given options hash.
@@ -198,6 +199,9 @@ module Vonage
     sig { params(token: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :token
 
+    sig { returns(String) }
+    attr_accessor :video_host
+
     protected
 
     sig { params(name: Symbol, value: T.untyped).void }

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/namespace.rb

@@ -8,7 +8,7 @@ module Vonage
     def initialize(config)
       @config = config
 
-      @host = self.class.host == :api_host ? @config.api_host : @config.rest_host
+      @host = set_host
 
       @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
       @http.use_ssl = true
@@ -21,7 +21,7 @@ module Vonage
     end
 
     def self.host=(host)
-      raise ArgumentError unless host == :rest_host
+      raise ArgumentError unless host == :rest_host || host == :video_host
 
       @host = host
     end
@@ -51,6 +51,7 @@ module Vonage
 
     Get = Net::HTTP::Get
     Put = Net::HTTP::Put
+    Patch = Net::HTTP::Patch
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
@@ -217,6 +218,19 @@ module Vonage
     def logger
       @config.logger
     end
+
+    private
+
+    def set_host
+      case self.class.host
+      when :rest_host
+        @config.rest_host
+      when :video_host
+        @config.video_host
+      else
+        @config.api_host
+      end
+    end
   end
 
   private_constant :Namespace

data/lib/vonage/version.rb

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

data/lib/vonage/video/archives.rb

@@ -0,0 +1,187 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Archives < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # 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
+    #
+    # @param [optional, String] :session_id
+    #
+    # TODO: add auto_advance option
+    #
+    # @return [ListResponse]
+    #
+    # @see TODO: add docs link
+    #
+    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(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
+    #
+    # @param [optional, String] :hasVideo
+    #
+    # @param [optional, String] :name
+    #
+    # @param [optional, String] :outputMode
+    #
+    # @param [optional, String] :resolution
+    #
+    # @param [optional, String] :streamMode
+    #
+    # @param [optional, String] :multiArchiveTag
+    #
+    # @param [optional, Hash] :layout
+    #
+    # @option layout [optional, String] :type
+    #
+    # @option layout [optional, String] :stylesheet
+    #
+    # @option layout [optional, String] :screenshareType
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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(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(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] add_stream The ID of the stream to be added
+    #
+    # @param [optional, Boolean] has_audio
+    #
+    # @param [optional, Boolean] has_video
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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] remove_stream The ID of the stream to be removed
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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
+    #
+    # @param [optional, String] stylesheet
+    #
+    # @param [optional, String] screenshare_type
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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

@@ -0,0 +1,73 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Moderation < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # 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.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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 
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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

@@ -0,0 +1,55 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Signals < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Send a signal to a specific participant in an active Vonage Video 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.
+    #
+    # @param [required, String] :type Type of data that is being sent to the client.
+    #
+    # @param [required, String] :data Payload that is being sent to the client.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :type Type of data that is being sent to the client.
+    #
+    # @param [required, String] :data Payload that is being sent to the client.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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

@@ -0,0 +1,76 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Streams < Namespace
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of streams for a specified session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # TODO: add auto_advance option
+    #
+    # @return [ListResponse]
+    #
+    # @see TODO: add docs link
+    #
+    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.
+    #
+    # @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
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [optional, Array<Hash>] :items An array of hashes representing streams and the layout classes for those streams
+    #
+    # @option items [required, String] :id The stream ID
+    #
+    # @option items [required, Array<String>] :layoutClassList Array of CSS class names as strings
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    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/' + application_id + '/session/' + session_id + '/stream', params: params, type: Put)
+    end
+  end
+end
+  

data/lib/vonage/video.rb

@@ -0,0 +1,91 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video < Namespace
+    include Keys
+    
+    self.authentication = BearerToken
+
+    self.host = :video_host
+
+    # Generate a new session.
+    #
+    # @example
+    #   session = client.video.create_session({
+    #     archive_mode: 'always',
+    #     location: '10.1.200.30',
+    #     media_mode: 'routed'
+    #   })
+    #
+    # @params [optional, String] :archive_mode (either 'always' or 'manual')
+    #
+    # @param [optional, String] :location
+    #
+    # @params [optional, String] :media_mode (either 'routed' or 'relayed')
+    #
+    # @return [Response]
+    #
+    # @see TODO: Add document link here
+    #
+    def create_session(**params)
+      request_params = params.clone
+      request_params[:archive_mode] ||= 'manual' 
+      media_mode = request_params.delete(:media_mode) || 'routed'
+
+      if media_mode == 'relayed' && request_params[:archive_mode] == 'manual'
+        request_params['p2p.preference'] = 'enabled'
+      else
+        request_params['p2p.preference'] = 'disabled'
+      end
+
+      response = request('/session/create', params: camelcase(request_params), type: Post)
+
+      public_response_data = {
+        session_id: response.entity[:session_id],
+        archive_mode: request_params[:archive_mode],
+        media_mode: media_mode,
+        location: request_params[:location]
+      }
+
+      entity = Entity.new(public_response_data)
+
+      response.class.new(entity, response.http_response)
+    end
+
+    def generate_client_token(session_id:, scope: 'session.connect', role: 'publisher', **params)
+      claims = {session_id: session_id, application_id: @config.application_id, scope: scope, role: role}
+      claims[:data] = params[:data] if params[:data]
+      claims[:initial_layout_class_list] = params[:initial_layout_class_list].join(' ') if params[:initial_layout_class_list]
+      claims[:exp] = params[:expire_time].to_i if params[:expire_time]
+
+      JWT.generate(claims, @config.private_key)
+    end
+
+    # @return [Streams]
+    #
+    def streams
+      @streams ||= Streams.new(@config)
+    end
+
+    # @return [Archives]
+    #
+    def archives
+      @archives ||= Archives.new(@config)
+    end
+
+    # @return [Archives]
+    #
+    def moderation
+      @moderation ||= Moderation.new(@config)
+    end
+
+    # @return [Archives]
+    #
+    def signals
+      @signals ||= Signals.new(@config)
+    end
+
+    # TODO: add token generator
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.8.1
+  version: 8.0.0.beta
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -153,6 +153,12 @@ files:
 - lib/vonage/user_agent.rb
 - lib/vonage/verify.rb
 - lib/vonage/version.rb
+- lib/vonage/video.rb
+- lib/vonage/video/archives.rb
+- lib/vonage/video/list_response.rb
+- lib/vonage/video/moderation.rb
+- lib/vonage/video/signals.rb
+- lib/vonage/video/streams.rb
 - lib/vonage/voice.rb
 - lib/vonage/voice/actions/connect.rb
 - lib/vonage/voice/actions/conversation.rb
@@ -188,9 +194,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.26
 signing_key: