ruby_rabbitmq_janus 1.2.9 → 2.0.0.pre.42

data/lib/rrj/janus/messages/admin.rb

@@ -4,6 +4,7 @@ module RubyRabbitmqJanus
   module Janus
     module Messages
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+      #
       # Create an message for janus
       class Admin < Message
         # Return options to message for rabbitmq
@@ -16,8 +17,6 @@ module RubyRabbitmqJanus
 
         private
 
-        # Transform raw request in request to janus, so replace element
-        # <string>, <number> and other with real value
         def prepare_request(options)
           @request = Tools::Replaces::Admin.new(request,
                                                 options).transform_request

data/lib/rrj/janus/messages/message.rb

@@ -5,8 +5,9 @@ module RubyRabbitmqJanus
     # Modules for create message for Janus
     module Messages
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
+      #
       # # Create a message for janus.
+      #
       # Create a message, in hash format, and sending to json format.
       # It's loading file base and change elements and configure message for
       # used in rabbitmq.
@@ -21,11 +22,13 @@ module RubyRabbitmqJanus
         attr_reader :type
 
         # Instanciate an message
+        #
         # @param template_request [String] Name of request prepare
         # @param [Hash] options Options to request
         # @option options [String] :session_id Identifier to session
         # @option options [String] :handle_id Identifier to session manipulate
         # @option options [Hash] :other Element contains in request sending
+        #
         # @example Initialize a message
         #   Message.new('test', {
         #     "session_id": 42,
@@ -77,18 +80,15 @@ module RubyRabbitmqJanus
 
         attr_accessor :properties, :request
 
-        # Load raw request
         def load_request_file
           @request = request_instance
           Tools::Log.instance.debug "Opening request : #{to_json}"
         end
 
-        # Transform JSON request with elements necessary
         def prepare_request(_options)
           Tools::Log.instance.debug "Prepare request for janus : #{to_json}"
         end
 
-        # Return request to json format
         def request_instance
           JSON.parse File.read Tools::Requests.instance.requests[@type]
         end

data/lib/rrj/janus/messages/standard.rb

@@ -4,6 +4,7 @@ module RubyRabbitmqJanus
   module Janus
     module Messages
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+      #
       # # Create an standard message
       class Standard < Message
         # Return options to message for rabbitmq
@@ -15,12 +16,9 @@ module RubyRabbitmqJanus
 
         private
 
-        # Transform raw request in request to janus, so replace element
-        # <string>, <number>
-        # and other with real value
         def prepare_request(options)
-          @request = Tools::Replaces::Standard.new(request,
-                                                   options).transform_request
+          @request = Tools::Replaces::Handle.new(request,
+                                                 options).transform_request
           super
         end
       end

data/lib/rrj/janus/processus/concurrency.rb

@@ -5,7 +5,7 @@ module RubyRabbitmqJanus
     # Modules for create autonomous processus
     module Concurrencies
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
+      #
       # # Class for manage threads
       #
       # @abstract Manage thread in this gem for keepalive message and listen

data/lib/rrj/janus/processus/keepalive.rb

@@ -4,7 +4,7 @@ module RubyRabbitmqJanus
   module Janus
     module Concurrencies
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
+      #
       # # Manage keepalive message
       #
       # Create a thread for sending a message with type keepalive to session
@@ -26,6 +26,7 @@ module RubyRabbitmqJanus
         # @example Ask session
         #   Keepalive.instance.session
         #   => 852803383803249
+        #
         # @return [Fixnum] Identifier to session created by Janus
         def session
           lock.synchronize do
@@ -56,6 +57,8 @@ module RubyRabbitmqJanus
           sleep time_to_live
           @pub.publish(message_keepalive)
           Tools::Log.instance.info "Keepalive for #{@session}"
+        rescue => error
+          raise Errors::KeepaliveMessage, error
         end
 
         def create_session
@@ -66,14 +69,17 @@ module RubyRabbitmqJanus
         end
 
         def message_keepalive
-          opt = { 'session_id' => @session }
-          Janus::Messages::Standard.new('base::keepalive', opt)
+          Janus::Messages::Standard.new('base::keepalive', param_session)
         rescue => error
           raise Errors::KeepaliveMessage, error
         end
 
         def find_session
-          Janus::Responses::Standard.new(create_session).to_hash['data']['id']
+          Janus::Responses::Standard.new(create_session).session
+        end
+
+        def param_session
+          { 'session_id' => @session }
         end
       end
     end

data/lib/rrj/janus/responses/admin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  module Janus
+    module Responses
+      # Response for admin request
+      class Admin < Standard
+        # List of sessions running in Janus Instance.
+        #
+        # @return [Array] List of sessions
+        def sessions
+          request['sessions']
+        end
+
+        # List of handles running in one session in Janus Instance.
+        #
+        # @return [Array] List of handles
+        def handles
+          request['handles']
+        end
+
+        # Info to session or handle in Janus Instance
+        #
+        # @return [Hash] Information to session/handle
+        def info
+          request['info']
+        end
+      end
+    end
+  end
+end

data/lib/rrj/janus/responses/event.rb

@@ -7,33 +7,51 @@ module RubyRabbitmqJanus
       # Response for events message
       class Event < Standard
         # Return event to message
+        #
+        # @example Januse response
+        #   request.event #=> 'success'
+        #
+        # @return [String] result to request
         def event
           request['janus']
         end
 
-        # Return body data
+        # Read plugindata data
+        #
+        # @example Plugindata data
+        #   request.data #=> { 'data': { 'audio': false } }
+        #
+        # @return [Hash] body data
         def data
           request['plugindata']['data'] if plugin_response?
         end
 
-        # Return jsep data
+        # Read jsep data
+        #
+        # @example Data to jsep
+        #   request.jsep #=> { 'jsep': { 'type': '...', 'sdp': '...' } }
+        #
+        # @return [Hash] jsep data
         def jsep
           request['jsep'] if contains_jsep?
         end
 
-        # Return a couple session_id and handle_id
+        # session_id and handle_id
+        #
+        # @example Data to any request
+        #   request.keys #=> [123456789, 987654321]
+        #
+        # @return [Array] Contains session_id and handle_id
         def keys
           [request['session_id'], request['sender']]
         end
 
         private
 
-        # Test if response contains jsep data
         def contains_jsep?
           request.key?('jsep')
         end
 
-        # Test if response is returning by plugin
         def plugin_response?
           request.key?('plugindata') && request['plugindata'].key?('data')
         end

data/lib/rrj/janus/responses/response.rb

@@ -5,6 +5,7 @@ module RubyRabbitmqJanus
     # Modules for manipulate responses sending by Janus
     module Responses
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+      #
       # Read and decryt a response to janus
       class Response
         # Instanciate a response
@@ -54,4 +55,5 @@ module RubyRabbitmqJanus
 end
 
 require 'rrj/janus/responses/standard'
+require 'rrj/janus/responses/admin'
 require 'rrj/janus/responses/event'

data/lib/rrj/janus/responses/standard.rb

@@ -11,16 +11,37 @@ module RubyRabbitmqJanus
           data_id
         end
 
-        # Return a integer to handle
-        def sender
-          data_id
+        alias sender session
+
+        # Return session used in request
+        def session_id
+          request['session_id']
+        end
+
+        # Read response for plugin request
+        def plugin
+          request['plugindata']
+        end
+
+        # Read data response for plugin request
+        def plugin_data
+          plugin['data']
+        end
+
+        # Read data response for normal request
+        def data
+          request['data']
+        end
+
+        # Read SDP response
+        def sdp
+          request['jsep']['sdp']
         end
 
         private
 
-        # Read a hash and return an identifier
         def data_id
-          request['data']['id'].to_i
+          data['id'].to_i
         rescue => error
           raise Errors::JanusResponseDataId, error
         end

data/lib/rrj/janus/transactions/admin.rb

@@ -6,43 +6,39 @@ module RubyRabbitmqJanus
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
 
       # This class work with janus and send a series of message
-      class Admin < Handle
-        # Publish an message in handle
-        #
-        # @param [String] type
-        #   Given a type to request. JSON request writing in 'config/requests/'
-        # @param [Hash] options Replace/add element to request
-        #
-        # @return [Janus::Response::Standard] a response to message pusblishing
-        #   in queue Admin API
-        def publish_message_handle(type, options)
-          opts = {
-            'session_id' => session,
-            'handle_id' => handle,
-            'admin_secret' => admin_secret
-          }
-          msg = Janus::Messages::Admin.new(type, opts.merge!(options))
-          Janus::Responses::Standard.new(read_response(publisher.publish(msg)))
+      class Admin < Session
+        def initialize(session)
+          super(true, session)
         end
 
-        private
+        # Begin connection with RabbitMQ
+        def connect
+          rabbit.transaction_short do
+            @publisher = Rabbit::Publisher::PublisherAdmin.new(rabbit.channel)
+            yield
+          end
+        end
 
-        # Define queue used for admin message
-        def choose_queue
-          chan = rabbit.channel
-          @publisher = Rabbit::Publisher::PublisherAdmin.new(chan)
+        # Write a message in queue in RabbitMQ
+        def publish_message(type, options = {})
+          msg = Janus::Messages::Admin.new(type, opts.merge(options))
+          response = read_response(publisher.publish(msg))
+          Janus::Responses::Admin.new(response)
         end
 
-        # Override method for publishing an message and reading a response
+        private
+
         def send_a_message
-          Tools::Log.instance.info 'Publish a message ...'
-          Janus::Responses::Standard.new(publisher.publish(yield))
+          Janus::Responses::Admin.new(publisher.publish(yield))
         end
 
-        # Read a admin pass in configuration file to this gem
         def admin_secret
           Tools::Config.instance.options['rabbit']['admin_pass']
         end
+
+        def opts
+          { 'session_id' => session, 'admin_secret' => admin_secret }
+        end
       end
     end
   end

data/lib/rrj/janus/transactions/handle.rb

@@ -4,14 +4,14 @@ module RubyRabbitmqJanus
   module Janus
     module Transactions
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
+      #
       # This class work with janus and send a series of message
-      class Handle < Session
+      class Handle < Transaction
         # Initialize a transaction with handle
         #
         # @param [Fixnum] session
         #   Use a session identifier for created message
-        def initialize(session, exclusive, handle = 0)
+        def initialize(exclusive, session, handle = 0)
           super(session)
           @exclusive = exclusive
           @handle = handle
@@ -38,16 +38,19 @@ module RubyRabbitmqJanus
         # @param [Hash] options Replace/add element in request
         #
         # @return [Janus::Responses::Standard] Response to message sending
-        def publish_message_handle(type, options)
-          opts = { 'session_id' => session, 'handle_id' => handle }
+        def publish_message(type, options = {})
           msg = Janus::Messages::Standard.new(type, opts.merge!(options))
           response = read_response(publisher.publish(msg))
           Janus::Responses::Standard.new(response)
         end
 
+        # Send a message detach
+        def detach
+          publisher.publish(Janus::Messages::Standard.new('base::detach', opts))
+        end
+
         private
 
-        # Create an handle for transaction
         def create_handle
           Tools::Log.instance.info 'Create an handle'
           opt = { 'session_id' => session }
@@ -55,19 +58,21 @@ module RubyRabbitmqJanus
           @handle = send_a_message_exclusive { msg }
         end
 
-        # Send a messaeg in exclusive queue
         def send_a_message_exclusive
           Janus::Responses::Standard.new(read_response_exclusive do
             yield
           end).sender
         end
 
-        # Read an response in queue exclusive
         def read_response_exclusive
           chan = rabbit.channel
           tmp_publish = Rabbit::Publisher::PublishExclusive.new(chan, '')
           tmp_publish.publish(yield)
         end
+
+        def opts
+          { 'session_id' => session, 'handle_id' => @handle }
+        end
       end
     end
   end

data/lib/rrj/janus/transactions/session.rb

@@ -4,23 +4,41 @@ module RubyRabbitmqJanus
   module Janus
     module Transactions
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
+      #
       # # Manage a transaction
+      #
       # Manage a transaction with message if contains a session identifier
       class Session < Transaction
-        # Opening a short transaction with rabbitmq and close when is ending
+        # Initialize a transaction with handle
         #
-        # @param [Boolean] exclusive
-        #   Determine if the message is sending to a exclusive queue or not
+        # @param [Fixnum] session
+        #   Use a session identifier for created message
+        def initialize(exclusive, session)
+          super(session)
+          @exclusive = exclusive
+        end
+
+        # Opening a short transaction with rabbitmq and close when is ending
         #
         # @yield Send a message to Janus
-        def connect(exclusive)
-          @exclusive = exclusive
+        def connect
           rabbit.transaction_short do
             choose_queue
-            send_a_message { yield }
+            yield
           end
         end
+
+        def publish_message(type, options = {})
+          msg = Janus::Messages::Standard.new(type, opts.merge!(options))
+          response = read_response(publisher.publish(msg))
+          Janus::Responses::Standard.new(response)
+        end
+
+        private
+
+        def opts
+          { 'session_id' => session }
+        end
       end
     end
   end