ruby_rabbitmq_janus 1.1.12 → 1.2.0

data/lib/rrj/errors/janus.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
-# :reek:FeatureEnvy
 
 module RubyRabbitmqJanus
   module Errors
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
     # Define errors to message sending and response to janus
     class JanusError < RRJError
+      # Initialize a error standard for janus module
+      # @param [String] message Text returning in raise
       def initialize(message)
-        super "[JANUS] #{message}", :fatal
+        super "[JANUS]#{message}", :fatal
       end
     end
   end

data/lib/rrj/errors/janus_message.rb

@@ -3,42 +3,46 @@
 module RubyRabbitmqJanus
   module Errors
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
     # Define an exception for janus message class
     class JanusMessage < JanusError
+      # Initialize a error for janus message module
+      # @param [String] message Text returning in raise
       def initialize(message)
-        super "[Message] Error create : #{message}"
+        super "[Message] #{message}"
       end
     end
 
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
     # Define an exception for janus message to_json
-    class JanusMessageJson < JanusError
+    class JanusMessageJson < JanusMessage
+      # Initialize a error for janus message in to_json
+      # @param [String] message Text returning in raise
       def initialize(message)
-        super "[Message] Error transform to json : #{message}"
+        super "Error transform to json : #{message}"
       end
     end
 
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
     # Define an exception for janus message to_nice_json
-    class JanusMessagePrettyJson < JanusError
+    class JanusMessagePrettyJson < JanusMessage
+      # Initialize a error for janus message in to_nice_json
+      # @param [String] message Text returning in raise
       def initialize(message)
-        super "[Message] Error transform to pretty json : #{message}"
+        super "Error transform to pretty json : #{message}"
       end
     end
 
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define an exception for janus message to_hash
-    class JanusMessageHash < JanusError
-      def initialize(message)
-        super "[Message] Error transform to hash : #{message}"
-      end
-    end
 
-    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define an exception for janus message option
-    class JanusMessageOption < JanusError
+    # Define an exception for janus message to_hash
+    class JanusMessageHash < JanusMessage
+      # Initialize a error for janus message in to_hash
+      # @param [String] message Text returning in raise
       def initialize(message)
-        super "[Message] Error options to message : #{message}"
+        super "Error transform to hash : #{message}"
       end
     end
   end

data/lib/rrj/errors/janus_response.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
-# :reek:FeatureEnvy
 
 module RubyRabbitmqJanus
   module Errors
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    #
     # Define an error primary for response
     class JanusResponse < JanusError
+      # Initialize a error for janus response module
+      # @param [String] message Text returning in raise
       def initialize(message)
         super "[Response] #{message}"
       end
@@ -14,31 +16,18 @@ module RubyRabbitmqJanus
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define an error for response initalize
     class JanusResponseInit < JanusResponse
+      # Initialize a error for janus response module in initializer
+      # @param [String] message Text returning in raise
       def initialize(message)
         super "Error create object : #{message}"
       end
     end
 
-    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define an error for simple message
-    class JanusResponseSimple < JanusResponse
-      def initialize(message)
-        error = message['error']
-        super "[#{error['code']}] #{error['reason']} -- #{message}"
-      end
-    end
-
-    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define an error for plugin
-    class JanusResponsePlugin < JanusResponse
-      def initialize(message)
-        super "[#{message['error_code']}] #{message['error']}"
-      end
-    end
-
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define an exception for json
     class JanusResponseJson < JanusResponse
+      # Initialize a error for janus response module in to_json
+      # @param [String] message Text returning in raise
       def initialize(message)
         super \
           "Error transform to JSON : #{message[0]} -- message : #{message[1]}"
@@ -48,6 +37,8 @@ module RubyRabbitmqJanus
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define an exception for nice_json
     class JanusResponsePrettyJson < JanusResponse
+      # Initialize a error for janus response module in to_nice_json
+      # @param [String] message Text returning in raise
       def initialize(message)
         super "Error transform to Pretty JSON : #{message}"
       end
@@ -56,23 +47,19 @@ module RubyRabbitmqJanus
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define an exception for hash
     class JanusResponseHash < JanusResponse
+      # Initialize a error for janus response module in to_hash
+      # @param [String] message Text returning in raise
       def initialize(message)
         super \
           "Error transform to Hash : #{message[0]} -- message : #{message[1]}"
       end
     end
 
-    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define an error for response plugin
-    class JanusResponsePluginData < JanusResponse
-      def initialize(message)
-        super "Error data response : #{message}"
-      end
-    end
-
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define an error for response data
     class JanusResponseDataId < JanusResponse
+      # Initialize a error for janus response module in data_id
+      # @param [String] message Text returning in raise
       def initialize(message)
         super "Error Data : #{message}"
       end

data/lib/rrj/errors/janus_transaction.rb

@@ -3,10 +3,10 @@
 module RubyRabbitmqJanus
   module Errors
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define errors to message sending and response to janus
-    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define an exception for initaliser transaction
+    # Define an exception for initalizer transaction
     class JanusTransaction < JanusError
+      # Initialize a error for janus transaction class
+      # @param [String] message Text returning in raise
       def initialize(message)
         super "[Transaction] Error initialize : #{message}"
       end
@@ -14,17 +14,11 @@ module RubyRabbitmqJanus
 
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define an exception for running_handle
-    class JanusTransactionHandle
-      def initialize(message)
-        super "[Transaction] Error handle #{message}"
-      end
-    end
-
-    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define an exception for sending_message
-    class JanusTransactionPost < JanusError
+    class JanusTransactionHandle < JanusTransaction
+      # Initialize a error for janus transaction handle class
+      # @param [String] message Text returning in raise
       def initialize(message)
-        super "[Transaction] Error sending message : #{message}"
+        super "[Handle] #{message}"
       end
     end
   end

data/lib/rrj/errors/rabbit.rb

@@ -2,17 +2,11 @@
 
 module RubyRabbitmqJanus
   module Errors
-    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Define errors with Rabbitmq when request is not sending
-    class RequestNotExecuted < Errors::RRJError
-      def initialize(request)
-        super "Error in request executed : #{request}", :error
-      end
-    end
-
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define errors if connection to rabbitmq is failed
-    class ConnectionRabbitmqFailed < Errors::RRJError
+    class ConnectionRabbitmqFailed < RRJError
+      # Initialize a error for rabbit module. It's a fatal error
+      # @param [String] message Text returning in raise
       def initialize(message)
         super message, :fatal
       end

data/lib/rrj/info.rb

@@ -3,7 +3,7 @@
 # Define constant to gem.
 module RubyRabbitmqJanus
   # Define version to gem
-  VERSION = '1.1.12'
+  VERSION = '1.2.0'
 
   # Define a summary description to gem
   SUMMARY = 'Ruby RabbitMQ Janus'

data/lib/rrj/init.rb

@@ -8,24 +8,37 @@ require 'bunny'
 require 'logger'
 require 'key_path'
 require 'active_support'
+require 'erb'
 
+# Primary module for this gem
 module RubyRabbitmqJanus
   # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
+  # # RubyRabbitmqJanus - RRJ
+  #
   # Initialize RRJ gem and create automatically a session with janus and
   # sending a keepalive message. The Time To Live is configured in yaml
-  # configuration file 'config/default.yml' or
-  # 'config/ruby-rabbitmq-janus.yml'.
+  # configuration file `config/default.yml` or if you a customize config in
+  # `config/ruby-rabbitmq-janus.yml`.
+  #
   # @!attribute [r] session
-  #   @return [Fixnum] Return an session number created in instantiate this gem.
-  # :reek:BooleanParameter and :reek:ControlParameter and :reek:DataClump
-  # :reek:LongParameterList and :reek:TooManyStatements
+  #   @return [Fixnum] Return an session number created when this gem is
+  #     instanciate. It's janus who creates the number of the session.
+  #
+  # @see file:/config/requests.md For more information to type requests used.
+  # @see file:/config/default.md For more information to config file used.
   class RRJ
     attr_reader :session
 
-    # Returns a new instance of RubyRabbitmqJanus
+    # Return a new instance of RubyRabbitmqJanus.
+    #
+    # @example Create a instance to this gem
+    #   @rrj = RubyRabbitmqJanus::RRJ.new
+    #   => #<RubyRabbitmqJanus::RRJ:0x007 @session=123, @transaction=nil>
     def initialize
-      # Instanciate singleton tools
-      start_instances_tools
+      Tools::Log.instance
+      Tools::Config.instance
+      Tools::Requests.instance
 
       # Create an session while time opening
       @session = Janus::Concurrencies::Keepalive.instance.session
@@ -34,118 +47,157 @@ module RubyRabbitmqJanus
       @transaction = nil
     end
 
-    # Send an simple message to janus. No options in request with this method.
+    # Send an simple message to janus.
+    #
     # @param [String] type
     #   Given a type to request. JSON request writing in 'config/requests/'
     # @param [Bollean] exclusive
     #   Use an exclusive queue or not
+    # @param [Hash] options Options update in request
+    #
     # @example Sending an message info in queue 'to-janus'
     #   RubyRabbitmqJanus::RRJ.new.message_simple('base::info', true)
     #   #=> {}
     # @example Sending an message info in queue exclusive 'ampq.gen-xxxxx'
     #   RubyRabbitmqJanus::RRJ.new.message_simple('base::info')
     #   #=> {"janus":"server_info","name":"Janus WebRTC Gateway" ... }
+    #
     # @return [RubyRabbitmqJanus::Janus::Responses::Standard]
     #   Give an object response to janus server
-    def message_simple(type = 'base::info', exclusive = false, options = {})
-      Janus::Transactions::Transaction.new(@session).connect(exclusive) do
+    #
+    # @since 1.0.0
+    def message_simple(type = 'base::info', exclusive = false,
+                       options = { 'replace' => {}, 'add' => {} })
+      Janus::Transactions::Session.new(@session).connect(exclusive) do
         Janus::Messages::Standard.new(type, options)
       end
     end
 
     # Send an message simple in current session.
+    #
     # @param [String] type
     #   Given a type to request. JSON request writing in 'config/requests/'
     # @param [Hash] options Options update in request
     # @param [Bollean] exclusive
     #   Use an exclusive queue or not
+    #
     # @example Sending an message create
     #   RubyRabbitmqJanus::RRJ.new.message_session('base::create')
-    #   #=> {"janus":"server_info","name":"Janus WebRTC Gateway" ... }
+    #   n#=> {"janus":"server_info","name":"Janus WebRTC Gateway" ... }
+    #
     # @return [RubyRabbitmqJanus::Janus::Responses::Standard]
-    # Give an object response to janus server
-    def message_session(type, options = {}, exclusive = true)
-      Janus::Transactions::Session.new(@session).session_connect(exclusive) do
+    #   Give an object response to janus server
+    #
+    # @since 1.0.0
+    def message_session(type, options = { 'replace' => {}, 'add' => {} },
+                        exclusive = true)
+      Janus::Transactions::Session.new(@session).connect(exclusive) do
         Janus::Messages::Standard.new(type, use_current_session?(options))
       end
     rescue => error
       raise Errors::RRJErrorPost, error
     end
 
-    # Send a message simple for admin Janus
+    # Send a message simple for admin Janus.
+    # **Is used just for sending a message to Janus Monitor/Admin API**. The
+    # queue is exclusive for not transmitting data to anyone.
+    #
     # @param [String] type
-    #   Given a type to request. JSON request writing in 'config/requests/'
-    # @param [Hash] options Options update in request
+    #   Given a type to request. JSON request writing in `config/requests/`
+    # @param [Hash] options Fields updating in request sending to janus.
+    #   **This hash must imperatively contains the key `replace`**
+    # @option options [Hash] :replace Contains all fields who be replaced in
+    #   request sending to janus.
+    # @option options [Hash] :add Contains all fields adding to request.
+    #
     # @example Sending an message create
     #   RubyRabbitmqJanus::RRJ.new.message_admin('admin::sessions')
     #   #=> {"janus":"success","sessions": [12345, 8786567465465, ...] }
+    #
     # @return [RubyRabbitmqJanus::Janus::Responses::Standard]
-    # Give an object response to janus server
-    def message_admin(type, options = {})
-      Janus::Transactions::Admin.new(use_current_session?(options)).connect do
-        Janus::Messages::Admin.new(type, options)
-      end
+    #   Give an object response to janus server
+    #
+    # @since 1.0.0
+    def message_admin(type, options = { 'replace' => {}, 'add' => {} })
+      @transaction = Janus::Transactions::Admin.new(@session,
+                                                    true,
+                                                    handle?(options))
+      @transaction.connect { Janus::Messages::Admin.new(type, options) }
     end
 
     # Send an message in handle session in current session.
+    #
     # @param [String] type
     #   Given a type to request. JSON request writing in 'config/requests/'
-    # @param [Hash] replace Options update in request
-    # @param [Hash] add Elements adding to request
+    # @param [Hash] options Fields updating in request sending to janus.
+    #   **This hash must imperatively contains the key `replace`**
+    # @option options [Hash] :replace Contains all fields who be replaced in
+    #   request sending to janus.
+    # @option options [Hash] :add Contains all fields adding to request.
+    #
     # @example Sending an message create
     #   RubyRabbitmqJanus::RRJ.new.message_session('base::create')
     #   #=> {"janus":"server_info","name":"Janus WebRTC Gateway" ... }
+    #
     # @return [RubyRabbitmqJanus::Janus::Responses::Standard]
-    # Give an object response to janus server
-    def message_handle(type, replace = {}, add = {})
-      options = { 'replace' => replace, 'add' => add }
+    #   Give a object response to janus server
+    #
+    # @since 1.0.0
+    def message_handle(type, options = { 'replace' => {}, 'add' => {} })
       @transaction.publish_message_handle(type, options)
     end
 
     # Define an handle transaction and establish connection with janus
+    #
+    # @param [Bollean] exclusive
+    #   Use an exclusive queue or not
+    #
+    # @yield Sending requests to Janus.
+    #
+    # @example Start a transaction with janus with a exclusive queue
+    #   @rrj.start_handle(true) do
+    #     @rrj.message_handle('peer:trickle')
+    #   end
+    #
+    # @see #message_handle
+    #
+    # @since 1.0.0
     def start_handle(exclusive = false)
-      @transaction = Janus::Transactions::Handle.new(@session)
-      @transaction.handle_connect(exclusive) { yield }
+      @transaction = Janus::Transactions::Handle.new(@session, exclusive)
+      @transaction.connect { yield }
     rescue => error
       raise Errors::RRJErrorHandle, error
     end
 
-    # Define an handle admin transaction and establish connection with janus
-    def start_handle_admin
-      @transaction = Janus::Transactions::Admin.new(@session)
-      @transaction.handle_connect { yield }
-    rescue => error
-      raise Errors::RRJErrorHandle, error
-    end
-
-    # Stop an handle existing in session running
-    def stop_handle
-      @transaction.handle_running_stop
-    end
-
-    # Start an short transaction. Create an handle and send a message to queue.
-    # This queue is not exclusive, so this message is sending in queue
-    # 'to-janus' and a response is return in queue 'from-janus'
+    # Start an short transaction. Create an handle and send one message to
+    # queue. **This queue is not exclusive**, so this message is sending in
+    # queue 'to-janus' and a response is return in queue 'from-janus'.
+    #
+    # @param [String] type
+    #   Given a type to request. JSON request writing in 'config/requests/'
+    # @param [Hash] options Fields updating in request sending to janus.
+    #   **This hash must imperatively contains the key `replace`**
+    # @option options [Hash] :replace Contains all fields who be replaced in
+    #   request sending to janus.
+    # @option options [Hash] :add Contains all fields adding to request.
+    #
     # @example Send an request trickle
-    #   candidate = {
+    #   cdn = {
     #     'candidate' => {
     #       'sdpMid' => 'video',
     #       'sdpMLineIndex' => 1,
     #       'candidate' => '...'
     #     }
     #   }
-    #   RubyRabbitmqJanus::RRJ.new.handle_message_simple('peer::trickle',
-    #                                                    candidate)
-    #   #=> { 'janus' => 'trickle', ..., 'candidate' => {
-    #     'completed' : true
-    #     }
-    #   }
-    def handle_message_simple(type, replace = {}, add = {}, exclusive = false)
-      handle = replace.include?('handle_id') ? replace['handle_id'] : 0
-      @transaction = Janus::Transactions::Handle.new(@session)
-      @transaction.handle_connect_and_stop(exclusive, handle) do
-        message_handle(type, replace, add)
-      end
+    #   RubyRabbitmqJanus::RRJ.new.handle_message_simple('peer::trickle', cdn)
+    #   #=> { 'janus' => 'trickle', ..., 'candidate' => { ... } }
+    #
+    # @since 1.0.0
+    def handle_message_simple(type, options = { 'replace' => {}, 'add' => {} })
+      @transaction = Janus::Transactions::Handle.new(@session,
+                                                     false,
+                                                     handle?(options))
+      @transaction.connect { message_handle(type, options) }
     rescue => error
       raise Errors::RRJErrorHandle, error
     end
@@ -154,17 +206,15 @@ module RubyRabbitmqJanus
 
     attr_accessor :transaction
 
-    # Start singleton instances
-    def start_instances_tools
-      Tools::Env.instance
-      Tools::Log.instance
-      Tools::Config.instance
-      Tools::Requests.instance
-    end
-
-    # Return a current session if not specified
     def use_current_session?(option)
       { 'session_id' => @session } unless option.key?('session_id')
     end
+
+    def handle?(options)
+      # if options.key?('replace') && options['replace'].key?('handle_id')
+      #   options['replace'].key?('handle_id') ? replace['handle_id'] : 0
+      # end
+      options['replace'].key?('handle_id') ? replace['handle_id'] : 0
+    end
   end
 end