ruby_rabbitmq_janus 1.1.12 → 1.2.0

data/lib/rrj/rabbit/propertie.rb

@@ -3,6 +3,10 @@
 module RubyRabbitmqJanus
   module Rabbit
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
+    # @!attribute [r] correlation
+    #   @return [String] Is a string uniq generated by SecureRandom
+    #
     # Manage properties to message sending in rabbitmq queue
     class Propertie
       attr_reader :correlation
@@ -17,7 +21,7 @@ module RubyRabbitmqJanus
       def options
         Tools::Log.instance.debug 'Add options to propertie to message'
         {
-          routing_key: Tools::Config.instance.options['queues']['queue_to'],
+          routing_key: Tools::Config.instance.queue_to,
           correlation_id: @correlation,
           content_type: 'application/json'
         }
@@ -27,18 +31,11 @@ module RubyRabbitmqJanus
       def options_admin
         Tools::Log.instance.debug 'Add options to propertie to message'
         {
-          routing_key: routing_key,
+          routing_key: Tools::Config.instance.queue_admin_to,
           correlation_id: @correlation,
           content_type: 'application/json'
         }
       end
-
-      private
-
-      # Read configuration file to gem for reading a admin queue name
-      def routing_key
-        Tools::Config.instance.options['queues']['admin']['queue_to']
-      end
     end
   end
 end

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

@@ -25,7 +25,7 @@ module RubyRabbitmqJanus
 
         # Define queue used for posting a message to API admin
         def queue_from
-          Tools::Config.instance.options['queues']['admin']['queue_from']
+          Tools::Config.instance.queue_admin_from
         end
       end
     end

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

@@ -5,6 +5,11 @@ module RubyRabbitmqJanus
     # Define an module for create an publisher
     module Publisher
       # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
+      # @!attribute [r] response
+      #   @return [RubyRabbitmqJanus::Janus::Responses::Response]
+      #     Given a Janus response
+      #
       # @abstract Publish message in RabbitMQ
       class BasePublisher
         attr_reader :response

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

@@ -28,7 +28,7 @@ module RubyRabbitmqJanus
         private
 
         def queue_name
-          Tools::Config.instance.options['queues']['queue_from']
+          Tools::Config.instance.queue_from
         end
 
         # Subscribe queue

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

@@ -24,7 +24,7 @@ module RubyRabbitmqJanus
 
         # Define queue used for posting a message to API public
         def queue_from
-          Tools::Config.instance.options['queues']['queue_from']
+          Tools::Config.instance.queue_from
         end
       end
     end

data/lib/rrj/tools/config.rb

@@ -3,13 +3,18 @@
 module RubyRabbitmqJanus
   module Tools
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Loading a yaml file for apply a configuration to gem.
+
+    # # Manage configuration file
+    # Singleton object for reading configuration file
+    #
+    # @!attribute [r] options
+    #   @return [Hash] Return all options to configured in config file.
     class Config
       include Singleton
 
       attr_reader :options
 
-      # Define HOME RRJ
+      # Define HOME RRJ gem
       RRJ_HOME = File.realpath(File.join(File.dirname(__FILE__),
                                          '..', '..', '..'))
 
@@ -19,7 +24,7 @@ module RubyRabbitmqJanus
       # Define a default override file configuration
       CONF_CUSTOM = 'config/ruby-rabbitmq-janus.yml'
 
-      # Define a default path to file configuration
+      # Define a default path to file configuration to gem
       PATH_DEFAULT = File.join(RRJ_HOME, CONF_DEFAULT)
 
       # Initialize configuration file default or customize if exist
@@ -27,40 +32,61 @@ module RubyRabbitmqJanus
         @options = nil
         conf_customize
         conf_default
-        define_log_level_used
+        Tools::Log.instance.save_level(log_level)
+      end
+
+      # @return [String] read configuration for queue `from`
+      def queue_from
+        @options['queues']['standard']['from']
+      end
+
+      # @return [String] read configuration for queue `to`
+      def queue_to
+        @options['queues']['standard']['to']
+      end
+
+      # @return [String] read configuration for queue admin `from`
+      def queue_admin_from
+        @options['queues']['admin']['from']
+      end
+
+      # @return [String] read configuration for queue admin `to`
+      def queue_admin_to
+        @options['queues']['admin']['to']
+      end
+
+      # @return [Symbol] read configuration for log level used in this gem
+      def log_level
+        @options['gem']['log']['level'].upcase.to_sym
+      rescue
+        raise Errors::LevelNotDefine
+      end
+
+      # @param [Fixnum] index determine what field is readint in array plugins
+      #   in configuration file
+      # @return [String] read configuration for plugin with index
+      def plugin_at(index = 0)
+        @options['janus']['plugins'][index].to_s
       end
 
       private
 
-      # Load configuration file yaml
-      # @return [Yaml] Configuration file
-      # @param file [String] Path to configuration file (with name)
       def load_configuration(file)
         Tools::Log.instance.info("Loading configuration file : #{file}")
-        YAML.load(File.read(file))
+        YAML.load(ERB.new(File.read(file)).result)
       rescue
         raise Errors::ConfigFileNotFound, file
       end
 
-      # Load customize configuration file if exist
       def conf_customize
         file = File.join(Dir.pwd, CONF_CUSTOM)
         @options = load_configuration(file) if File.exist?(file)
       end
 
-      # Load default configuration if customize configuration doesn't exist
       def conf_default
         file = PATH_DEFAULT
         @options ||= load_configuration(file)
       end
-
-      # Define log lvel used in this gem
-      def define_log_level_used
-        Tools::Log.instance.level = \
-          Tools::Log::LEVELS[@options['gem']['log']['level'].upcase.to_sym]
-      rescue
-        raise Errors::LevelNotDefine
-      end
     end
   end
 end

data/lib/rrj/tools/log.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
-# :reek:Attribute and :reek:UtilityFunction
 
 module RubyRabbitmqJanus
   module Tools
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Class for wrtting logs.
+
+    # # Manage log in this gem
+    #
+    # Singleton object for manipulate logs in this gem
+    #
+    # @!attribute [r] level
+    #   @return [Fixnum] Return a number to log level.
     class Log
       include Singleton
 
@@ -18,9 +23,12 @@ module RubyRabbitmqJanus
         UNKNOWN: Logger::UNKNOWN
       }.freeze
 
-      attr_accessor :level, :progname
+      attr_reader :level
 
-      # Returns a new instance to Log
+      # Returns a new instance to Log and use `Tag` element for each line
+      # writing in log with name to gem.
+      #
+      # @see http://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html
       def initialize
         logs = defined?(Rails) ? logger_rails : logger_develop
         logs.progname = RubyRabbitmqJanus.name
@@ -31,60 +39,68 @@ module RubyRabbitmqJanus
         @logs = ActiveSupport::TaggedLogging.new(logs)
       end
 
-      # Write a message in log with a UNKNOWN level
+      # Write a message in log with a `UNKNOWN` level
+      #
       # @param message [String] Message writing in warning level in log
       def unknown(message)
         write_tag { @logs.unknown(message) }
       end
 
-      # Write a message in log with a FATAL level
+      # 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)
       end
 
-      # Write a message in log with a ERROR level
+      # 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)
       end
 
-      # Write a message in log with a warn level
+      # 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)
       end
 
-      # Write a message in log with a info level
+      # 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)
       end
 
-      # Write a message in log with a debug level
+      # 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)
       end
 
-      # Return instance logger
+      # @return [RubyRabbitmqJanus::Tools::Log] the instance to logger
       def logger
         @logs
       end
 
-      # Return device to log is writing
+      # @return [String] name of file to lgger used
       def logdev
         @logs.instance_variable_get(:'@logdev').filename
       end
 
+      # Save log level used in this gem
+      def save_level(gem_level)
+        @level = LEVELS[gem_level]
+      end
+
       private
 
-      # Define instance logger with rails
       def logger_rails
         Rails.logger
       end
 
-      # Define instance logger wiptout rails
       def logger_develop
         log = Logger.new('log/rails-rabbit-janus.log')
         log.formatter = proc do |severity, _datetime, _progname, msg|
@@ -97,7 +113,6 @@ module RubyRabbitmqJanus
         this_level >= Log.instance.level ? true : false
       end
 
-      # Write a log with an tag
       def write_tag
         @logs.tagged(@logs.progname) { yield }
       end

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

@@ -52,9 +52,7 @@ module RubyRabbitmqJanus
 
         # Given a admin pass for request
         def admin_pass
-          cfg = Tools::Config.instance.options['rabbit']
-          key = 'admin_pass'
-          Tools::Env.instance.test_env_var(cfg, key)
+          Tools::Config.instance.options['rabbit']['admin_pass']
         end
       end
     end

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

@@ -56,15 +56,10 @@ module RubyRabbitmqJanus
 
         # Replace plugin string
         def replace_plugin
-          @request['plugin'] = plugin
+          @request['plugin'] = Tools::Config.instance.plugin_at
         rescue => message
           Tools::Log.instance.warn "Error plugin replace : #{message}"
         end
-
-        # Return a first plugin to array in config gem
-        def plugin
-          Tools::Config.instance.options['janus']['plugins'][0]
-        end
       end
     end
   end

data/lib/rrj/tools/requests.rb

@@ -3,9 +3,15 @@
 module RubyRabbitmqJanus
   module Tools
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-    # Load files json in config/request.
-    # This file is used for sending a request to RabbitMQ
+
+    # # Load files json in `config/request/**/*`.
+    #
+    # This file is used for sending a request to Janus
+    #
     # @!attribute [r] requests
+    #   @return [Hash] It's a hash with name and path to request.
+    #
+    # @see file:/config/requests.md For more information to type requests used.
     class Requests
       include Singleton
 
@@ -29,7 +35,6 @@ module RubyRabbitmqJanus
 
       private
 
-      # Run folder contains templates json
       def each_folder(subfolder)
         Dir[File.join(PATH_REQUEST + subfolder, '*')].count do |file|
           if File.file?(file)
@@ -40,15 +45,10 @@ module RubyRabbitmqJanus
         end
       end
 
-      # Add template json to requests array
-      # @param file [File]
       def read_file(file)
         @requests[File.basename(file, '.json').to_s] = File.path(file)
       end
 
-      # Add template json to requests array with a path
-      # @param folder [Dir]
-      # @param file [File]
       def read_folder(folder, file)
         @requests[folder + File.basename(file, '.json').to_s] = File.path(file)
       end

data/lib/rrj/tools/tools.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rrj/tools/log'
-require 'rrj/tools/env'
 require 'rrj/tools/config'
 require 'rrj/tools/requests'
 require 'rrj/tools/replaces/type'

data/lib/ruby_rabbitmq_janus.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Load all tools necessary to good functionlaty to this gem
 require 'rrj/init'
 
 # Define tools for this gems

data/spec/request/admin/request_handle_info_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 describe 'RubyRabbitmqJanus::RRJ -- message type handle_info' do
   before(:example) { @type = 'admin::handle_info' }
 
-  describe '#message_admin', type: :request,
-                             level: :admin, name: :handle_info do
+  describe '#message_admin', type: :request, level: :admin,
+                             name: :handle_info, broken: true do
     include_examples 'message_handle_admin should match json schema'
   end
 
-  # after(:example) { @gateway.stop_handle }
+  # after(:example) { @gateway.handle_message_simple('base::detach') }
 end

data/spec/request/base/request_attach_spec.rb

@@ -3,23 +3,20 @@
 require 'spec_helper'
 
 describe 'RubyRabbitmqJanus::RRJ -- message type attach' do
-  before(:example) { @type = 'base::attach' }
+  before(:example) do
+    @type = 'base::attach'
+    @options = { 'replace' => {}, 'add' => {} }
+  end
 
   describe '#message_handle', type: :request, level: :base, name: :attach do
     context 'when queue is exclusive' do
-      it_behaves_like 'message_handle should match json schema' do
-        let(:replace) { {} }
-        let(:add) { {} }
-      end
+      it_behaves_like 'message_handle should match json schema'
     end
 
     context 'when queue is not exclusive' do
-      it_behaves_like 'message_handle should match json empty' do
-        let(:replace) { {} }
-        let(:add) { {} }
-      end
+      it_behaves_like 'message_handle should match json empty'
     end
   end
 
-  after(:example) { @gateway.stop_handle }
+  after(:example) { @gateway.handle_message_simple('base::detach') }
 end

data/spec/request/base/request_detach_spec.rb

@@ -3,21 +3,18 @@
 require 'spec_helper'
 
 describe 'RubyRabbitmqJanus::RRJ -- mesage type detach' do
-  before(:example) { @type = 'base::detach' }
+  before(:example) do
+    @type = 'base::detach'
+    @options = { 'replace' => {}, 'add' => {} }
+  end
 
   describe '#message_handle', type: :request, level: :base, name: :detach do
     context 'when queue is exclusive' do
-      it_behaves_like 'message_handle should match json schema' do
-        let(:replace) { {} }
-        let(:add) { {} }
-      end
+      it_behaves_like 'message_handle should match json schema'
     end
 
     context 'when queue is not exclusive' do
-      it_behaves_like 'message_handle should match json empty' do
-        let(:replace) { {} }
-        let(:add) { {} }
-      end
+      it_behaves_like 'message_handle should match json empty'
     end
   end
 end