ruby_rabbitmq_janus 1.2.9 → 2.0.0.pre.42

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

@@ -5,8 +5,9 @@ module RubyRabbitmqJanus
     # Define an module for manipulate messages between apps and Janus
     module Transactions
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
+      #
       # # Manage a transactions
+      #
       # This class work with Janus and send a series of message
       class Transaction
         # Initialize a transaction

data/lib/rrj/rabbit/connect.rb

@@ -3,7 +3,8 @@
 module RubyRabbitmqJanus
   module Rabbit
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Class for manage connection with rabbitmq
+    #
+    # Class for manage connection with RabbitMQ
     class Connect
       # Initialize connection to server RabbitMQ
       def initialize
@@ -48,7 +49,6 @@ module RubyRabbitmqJanus
 
       private
 
-      # Read option for bunny instance (connection with rabbitmq)
       def read_options_server
         cfg = Tools::Config.instance.options['rabbit']
         opts = {}
@@ -58,7 +58,6 @@ module RubyRabbitmqJanus
         opts
       end
 
-      # Define option logs for bunny
       def option_log_rabbit
         if Tools::Log.instance.level.zero?
           {

data/lib/rrj/rabbit/publish/admin.rb

@@ -10,7 +10,7 @@ module RubyRabbitmqJanus
         #
         # @param [String] exchange Exchange used for the transaction
         def initialize(exchange)
-          @reply = exchange.queue(queue_from)
+          @reply = exchange.queue(Tools::Config.instance.queue_admin_from)
           super(exchange)
           subscribe_to_queue
         end
@@ -29,11 +29,6 @@ module RubyRabbitmqJanus
         private
 
         attr_reader :reply
-
-        # Define queue used for posting a message to API admin
-        def queue_from
-          Tools::Config.instance.queue_admin_from
-        end
       end
     end
   end

data/lib/rrj/rabbit/publish/base_publisher.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'semaphore'
 
 module RubyRabbitmqJanus
   module Rabbit
@@ -16,13 +15,13 @@ module RubyRabbitmqJanus
       #
       # @abstract Publish message in RabbitMQ
       class BasePublisher
-        attr_reader :responses
+        attr_reader :response
 
         # Define a base publisher
         def initialize
           Tools::Log.instance.debug 'Create an publisher'
-          @responses = []
-          @semaphore= Semaphore.new
+          @response = nil
+          @condition = ConditionVariable.new
           @lock = Mutex.new
         end
 
@@ -30,16 +29,12 @@ module RubyRabbitmqJanus
 
         attr_accessor :condition, :lock
 
-        # return an response when signal is trigger
         def return_response
-          Tools::Log.instance.debug 'Waiting response...'
-          @semaphore.wait
-          Tools::Log.instance.debug 'Response received'
-          response = nil
           @lock.synchronize do
-            response = @responses.shift
+            Tools::Log.instance.debug 'Response received'
+            @condition.wait(@lock)
+            @response
           end
-          response
         end
       end
     end

data/lib/rrj/rabbit/publish/exclusive.rb

@@ -4,6 +4,7 @@ module RubyRabbitmqJanus
   module Rabbit
     module Publisher
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+      #
       # # Publish message
       #
       # Publish message in queue exclusive. Bunny create automaticaly a name for

data/lib/rrj/rabbit/publish/listener.rb

@@ -4,6 +4,7 @@ module RubyRabbitmqJanus
   module Rabbit
     module Publisher
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+      #
       # This publisher don't post message. Is listen just an standard queue to
       # Janus. By default is "from-janus". It's a parameter in config to this
       # gem.
@@ -13,62 +14,44 @@ module RubyRabbitmqJanus
         # @param [String] rabbit Information connection to rabbitmq server
         def initialize(rabbit)
           super()
-          @responses = []
           @rabbit = rabbit.channel
+          @response = nil
           subscribe_queue
         end
 
         # Listen a queue and return a body response
         def listen_events
-          Tools::Log.instance.debug 'Waiting event...'
-          @semaphore.wait
-          Tools::Log.instance.info 'Janus event received .. treatment ..'
-          response = nil
           lock.synchronize do
-            response = @responses.shift
+            condition.wait(lock)
+            Tools::Log.instance.info 'Janus event received .. treatment ..'
+            yield @response.event, @response
           end
-          yield response.event, response
         end
 
         private
 
-        def queue_name
-          Tools::Config.instance.queue_from
-        end
-
-        # Subscribe queue
         def subscribe_queue
-          reply = @rabbit.queue(queue_name)
+          reply = @rabbit.queue(Tools::Config.instance.queue_from)
           @rabbit.prefetch(1)
           reply.bind(binding).subscribe(opts_subs) do |info, prop, payload|
-            log_message_id(prop)
+            Tools::Log.instance.info \
+              "[X] Message reading ##{prop['correlation_id']}"
             synchronize_response(info, payload)
           end
         end
 
-        # Define type binding used for subscriber
         def binding
           @rabbit.direct('amq.direct')
         end
 
-        # Options subscribe
         def opts_subs
           { block: false, manual_ack: true, arguments: { 'x-priority': 2 } }
         end
 
-        # Counts transmitted messages
-        def log_message_id(propertie)
-          message_id = propertie.message_id
-          Tools::Log.instance.info "[X] Message reading with ID #{message_id}"
-        end
-
-        # Sending an signal when an response is reading in queue
         def synchronize_response(info, payload)
-          lock.synchronize do
-            @responses.push(Janus::Responses::Event.new(JSON.parse(payload)))
-          end
+          @response = Janus::Responses::Event.new(JSON.parse(payload))
           @rabbit.acknowledge(info.delivery_tag, false)
-          @semaphore.signal
+          lock.synchronize { condition.signal }
         end
       end
     end

data/lib/rrj/rabbit/publish/non_exclusive.rb

@@ -4,12 +4,13 @@ module RubyRabbitmqJanus
   module Rabbit
     module Publisher
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+      #
       # Publish message in queue non exclusive. By default "to-janus".
       # This an option in config to this gem.
       class PublishNonExclusive < Publisher
         # Define an publisher for create non exclusive queue
         def initialize(exchange)
-          @reply = exchange.queue(queue_from)
+          @reply = exchange.queue(Tools::Config.instance.queue_from)
           super(exchange)
         end
 
@@ -23,11 +24,6 @@ module RubyRabbitmqJanus
         private
 
         attr_reader :reply
-
-        # Define queue used for posting a message to API public
-        def queue_from
-          Tools::Config.instance.queue_from
-        end
       end
     end
   end

data/lib/rrj/rabbit/publish/publisher.rb

@@ -4,7 +4,7 @@ module RubyRabbitmqJanus
   module Rabbit
     module Publisher
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
+      #
       # This publisher send and read an message in queues
       class Publisher < BasePublisher
         # Intialize a publisher for sending and reading a message
@@ -28,35 +28,22 @@ module RubyRabbitmqJanus
           Tools::Log.instance.info "Send request type : #{request.type}"
           @message = request
           @exchange.publish(@message.to_json,
-                            request.options.merge!(reply_to: queue_name))
+                            request.options.merge!(reply_to: reply.name))
         rescue => error
           raise Errors::RabbitPublishMessage, error, request
         end
 
         private
 
-        # Subscribe to queue selectd with a message
         def subscribe_to_queue
           reply.subscribe do |_delivery_info, propertie, payload|
             if @message.correlation.eql?(propertie.correlation_id)
-              Tools::Log.instance.debug "Parsing response payload......"
-              lock.synchronize do
-                @responses.push(JSON.parse payload)
-              end
-              Tools::Log.instance.debug "Response payload is: #{payload}"
-              @semaphore.signal
-            else
-              Tools::Log.instance.error "Response correlation ID mismatch (#{@message.correlation}!=#{propertie.correlation_id})"
+              @response = JSON.parse payload
+              lock.synchronize { condition.signal }
             end
           end
         end
 
-        # Name to queue used for this publisher
-        # @return [String] Name to queue used
-        def queue_name
-          reply.name
-        end
-
         attr_accessor :message
       end
     end

data/lib/rrj/tools/{config.rb → gem/config.rb}

@@ -32,8 +32,8 @@ module RubyRabbitmqJanus
       # Initialize configuration file default or customize if exist
       def initialize
         @options = @configuration = nil
-        conf_customize
-        conf_default
+        loading_configuration_customize
+        loading_configuration_default
         Tools::Log.instance.save_level(log_level)
       end
 
@@ -86,17 +86,17 @@ module RubyRabbitmqJanus
       def load_configuration
         log_message = "Loading configuration file : #{@configuration}"
         Tools::Log.instance.info(log_message)
-        YAML.load(ERB.new(File.read(@configuration)).result)
+        YAML.safe_load(ERB.new(File.read(@configuration)).result)
       rescue
         raise Errors::FileNotFound, @configuration
       end
 
-      def conf_customize
+      def loading_configuration_customize
         @configuration = File.join(Dir.pwd, CONF_CUSTOM)
         @options = load_configuration if File.exist?(@configuration)
       end
 
-      def conf_default
+      def loading_configuration_default
         @configuration = PATH_DEFAULT
         @options ||= load_configuration
       end

data/lib/rrj/tools/{log.rb → gem/log.rb}

@@ -23,6 +23,9 @@ module RubyRabbitmqJanus
         UNKNOWN: Logger::UNKNOWN
       }.freeze
 
+      # Sensitive data
+      SENSITIVES = %i(admin_secret apisecret).freeze
+
       attr_reader :level
 
       # Returns a new instance to Log and use `Tag` element for each line
@@ -43,41 +46,41 @@ module RubyRabbitmqJanus
       #
       # @param message [String] Message writing in warning level in log
       def unknown(message)
-        write_tag { @logs.unknown(message) }
+        write_tag { @logs.unknown(filter(message)) }
       end
 
       # Write a message in log with a `FATAL` level
       #
       # @param message [String] Message writing in warning level in log
       def fatal(message)
-        write_tag { @logs.fatal(message) } if test_level?(Logger::FATAL)
+        write_tag { @logs.fatal(filter(message)) } if test_level?(Logger::FATAL)
       end
 
       # Write a message in log with a `ERROR` level
       #
       # @param message [String] Message writing in warning level in log
       def error(message)
-        write_tag { @logs.error(message) } if test_level?(Logger::ERROR)
+        write_tag { @logs.error(filter(message)) } if test_level?(Logger::ERROR)
       end
 
       # Write a message in log with a `WARN` level
       # @param message [String] Message writing in warning level in log
       def warn(message)
-        write_tag { @logs.warn(message) } if test_level?(Logger::WARN)
+        write_tag { @logs.warn(filter(message)) } if test_level?(Logger::WARN)
       end
 
       # Write a message in log with a `INFO` level
       #
       # @param message [String] Message writing in info level in log
       def info(message)
-        write_tag { @logs.info(message) } if test_level?(Logger::INFO)
+        write_tag { @logs.info(filter(message)) } if test_level?(Logger::INFO)
       end
 
       # Write a message in log with a `DEBUG` level
       #
       # @param message [String] Message writing in debug level in log
       def debug(message)
-        write_tag { @logs.debug(message) } if test_level?(Logger::DEBUG)
+        write_tag { @logs.debug(filter(message)) } if test_level?(Logger::DEBUG)
       end
 
       # @return [RubyRabbitmqJanus::Tools::Log] the instance to logger
@@ -118,6 +121,18 @@ module RubyRabbitmqJanus
       def write_tag
         @logs.tagged(@logs.progname) { yield }
       end
+
+      # @todo fix replace
+      def filter_sensitive_data(log)
+        msg = log
+        SENSITIVES.each do |word|
+          msg = log.gsub(/\"#{word}\".*\".*\"/, "\"#{word}\":\"[FILTERED]\"") \
+            if log.include?(word.to_s)
+        end
+        msg
+      end
+
+      alias filter filter_sensitive_data
     end
   end
 end

data/lib/rrj/tools/gem/option.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# :reek:FeatureEnvy :reek:UtilityFunction
+
+module RubyRabbitmqJanus
+  module Tools
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
+    # # Utility for manage option to this gem.
+    #
+    # This class start all singleton, Log, Config, Request and Keepalice
+    # instance. It's alos used for testing session/handle used in request.
+    class Option
+      def initialize
+        Log.instance
+        Config.instance
+        Requests.instance
+        @session = Janus::Concurrencies::Keepalive.instance.session
+      end
+
+      # Give number session to keepalive
+      #
+      # @return [Fixnum] Session ID
+      #
+      # @since 2.0.0
+      def keepalive
+        @session
+      end
+
+      # Determine session_id used
+      #
+      # @param [Hash] options Read options used in request
+      #
+      # @return [Fixnum] Session ID
+      #
+      # @since 2.0.0
+      def use_current_session?(options)
+        hash = options
+        hash['session_id'] = @session unless hash.key?('session_id')
+        hash['session_id']
+      end
+
+      # Determine handle_id used
+      #
+      # @param [Hash] options Read options used in request
+      #
+      # @return [Fixnum] Handle ID
+      #
+      # @since 2.0.0
+      def use_current_handle?(options)
+        hash = options
+        hash['handle_id'] = 0 unless hash.key?('handle_id')
+        hash['handle_id']
+      end
+    end
+  end
+end

data/lib/rrj/tools/replaces/admin.rb

@@ -3,54 +3,48 @@
 module RubyRabbitmqJanus
   module Tools
     module Replaces
-      # Format message request with good data to HASH format for Admin request
+      # Format message request with good data to HASH format for Admin request.
+      # Manage level, debug and admin_secret
+      #
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-      class Admin < Standard
+      class Admin < Handle
         private
 
-        # Replace classic elements and for admin elements
-        def replace_classic
+        def replace_element_classic
           super
           replace_admins if request.key?('admin_secret')
           add_secret if opts.key?('add')
         end
 
-        # Add string secret for admin request
         def add_secret
           values = opts['add']
-          Tools::Log.instance.debug "Values add : #{values}"
           request.merge!(values)
         end
 
-        # Replace elements admins if present
         def replace_admins
           replace_admin
           replace_level if request.key?('level')
           replace_debug if request.key?('debug')
         end
 
-        # Replace admin secret in request
         def replace_admin
           request['admin_secret'] = admin_pass
         rescue => message
           Tools::Log.instance.warn "Error replace admin_secret : #{message}"
         end
 
-        # Replace level element
         def replace_level
-          request['level'] = opts['level']
+          request['level'] = type.convert('level', opts)
         rescue => message
           Tools::Log.instance.warn "Error replace level : #{message}"
         end
 
-        # Replace debug element
         def replace_debug
-          request['debug'] = opts['debug']
+          request['debug'] = type.convert('debug', opts)
         rescue => message
           Tools::Log.instance.warn "Error replace debug : #{message}"
         end
 
-        # Given a admin pass for request
         def admin_pass
           Tools::Config.instance.options['rabbit']['admin_pass']
         end