ruby_rabbitmq_janus 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6030e029ea0bd2a5679dcad05087626f714ff188
-  data.tar.gz: a58783ef89a8357ca40f1fbcb67caf83ec622d07
+  metadata.gz: a6cd4ddd4d531fad7d95ba9f66a16534d66cd35e
+  data.tar.gz: 5432f6b8bfa2ef968a03cf6cfd57e841f8965735
 SHA512:
-  metadata.gz: 9e8fc17ef4c1567c5e59080c6516661fb0f7300e77ccaaf2dd45d181f6111b736085ad58a56d6f2e3808a8e6adb518d18e5854980e4d49e7a75de3a2badcd75e
-  data.tar.gz: 0ef125e275f278881be03b53c194d81d7a1a562faad21b2aa88c571876c705776a401d9be961fc247974e2b77ec04fddbadbb6f22af10bdd148be7238796ccee
+  metadata.gz: cd17673a91b51bddc0cca8c0ab788e1bb6d4e5baf601942bcd3df79d23c6f703ed742921d92c5feeb34b47494dfbf0e17cb5cf45f4bfef43605d55f04c7928a6
+  data.tar.gz: 97e18cb653f2c45a86f06b99f4ec995265c525e23138c5cf79efdc73eb8a2070c1df5f37727a2b6bdf38632203b40e2338eb48d9bfaa62a6fd187fc4c94831e1

data/.gitignore

@@ -1,14 +1,71 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
+# Created by https://www.gitignore.io/api/ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
+/log/
 
-*.gem
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
 
-log
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### ruby-rabbitmq-janus ###
+
+## Configuration customize
 config/ruby-rabbitmq-janus.yml
+
+## Request customize
+config/requests/channel
+config/requests/videocast
+
+## Schema JSON response
+spec/support/schemas/request/channel
+spec/support/schemas/request/videocast
+
+## Unitaire test for request customize
+spec/request/channel
+spec/request/videocast

data/.reek

@@ -0,0 +1,7 @@
+---
+UtilityFunction:
+  public_methods_only: true
+
+DuplicateMethodCall:
+  allow_calls:
+    - 'Tools::Log.instance'

data/.rubocop.yml

@@ -8,8 +8,5 @@ AllCops:
 Style/Encoding:
   Enabled: true
 
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
-
 Metrics/LineLength:
   Max: 90

data/README.md

@@ -22,7 +22,7 @@ in a queue for gem. Once the received message is decoded and returned through th
 
 ### Installation
 
-Use bitbucket for installing gem in your Gemfile
+Use rubygem for installing gem in your application. Add in your Gemfile
 ```ruby
 gem 'ruby_rabbitmq_janus'
 ```
@@ -31,6 +31,29 @@ gem 'ruby_rabbitmq_janus'
 
 If you want used a customize configuration see [ruby-rabbitmq-janus.yml](config/default.md)
 
+Use generator for complete installation :
+```ruby
+rails g -h
+RubyRabbitmqJanus:
+  ruby_rabbitmq_janus:configuration
+  # Generate a custom configuration file.
+
+  ruby_rabbitmq_janus:default_request
+  # Copy base request file sending to janus in application. It's necessary if you want add your request.
+
+  ruby_rabbitmq_janus:initializer
+  # Generate a initializer to this gem for rails application.
+
+  ruby_rabbitmq_janus:create_request
+  # Create an request to json format for RubyRabbitmqJanus transaction.
+```
+
+For create an new request is simple. Use a command generator :
+```ruby
+rails g ruby_rabbitmq_janus:create_request test info 'transaction:<string>,body:{plugins:false}'
+      create  config/requests/test/info.json
+```
+
 ### Usage
 
 #### Usage with synchronous request
@@ -106,7 +129,22 @@ bundle exec rspec
 ```
 
 TIPS: for rspec install janus and rabbitmq server configured by default for user
- rabbitmq and use plugin echotest for janus server.
+rabbitmq and use plugin echotest for janus server.
+
+Use tags for rspec :
+
+| type            | name            |
+| --------------- | --------------- |
+| request         | attach          |
+|                 | create          |
+|                 | detach          |
+|                 | info            |
+|                 | test            |
+| level           | base            |
+|                 | admin           |
+| config          | rabbit          |
+|                 | log             |
+|                 | config          |
 
 ### Documentation
 

data/config/default.md

@@ -1,27 +1,43 @@
 # RabbitMQ server info
 
-The configuration file contains two parts.
-
-The RabbitMQ server information for connection, and the queue used by janus.
+The configuration file contains many parts.
 
 By default the configuration file look like this :
 
 ```yaml
-server:
+rabbit:
     host: 'localhost'
     port: 5672
     vhost: '/'
     user: 'guest'
-    password: 'guest'
+    pass: 'guest'
+    admin_pass: janusoverlord
 
 queues:
     queue_from: from-janus
     queue_to: to-janus
+    admin:
+      queue_from: from-janus
+      queue_to: to-janus
+
+janus:
+  plugins:
+    - janus.plugin.echotest
+
+gem:
+  log:
+    level: WARN
+  session:
+    keepalive: 45
+  thread:
+    enable: false
+    number: 1
 ```
 
 ## Customize
 For customizing a configuration add a yml file in your rails project in
-`config/ruby-rabbitmq-janus.yml`.
+`config/ruby-rabbitmq-janus.yml`, or use rails generator with command `rails generate
+ruby_rabbitmq_janus:configuration`.
 
 ## Ressources
 * [Configuration of RabbitMQ](https://www.rabbitmq.com/configure.html#config-items)

data/config/default.yml

@@ -1,15 +1,17 @@
-# Configuration file for gem
-server:
+# Rabbit information connection
+rabbit:
   # Precise RabbitMQ host - Default 'localhost'
   host: localhost
-  # Precise RabbitMQ port - Default 'port'
+  # Precise RabbitMQ port - Default '5672'
   port: 5672
   # Precise RabbitMQ vhost - Default '/'
   vhost: /
   # Precise RabbitMQ user - Default 'guest'
   user: guest
   # Precise RabbitMQ password - Default 'guest'
-  password: guest
+  pass: guest
+    # Password for admin request
+  admin_pass: janusoverlord
 
 # RabbitMQ Queue information
 queues:
@@ -17,6 +19,10 @@ queues:
   queue_from: from-janus
   # Queue sending a message for janus server
   queue_to: to-janus
+    # Queues for admin janus
+  admin:
+    queue_from: from-janus-admin
+    queue_to: to-janus-admin
 
 # Janus plugin used
 janus:
@@ -26,6 +32,18 @@ janus:
 
 # Options gem
 gem:
-  # Option for logging
+  # Option for logs
   log:
-    level: 'debug'
+    # Define level to log
+    # UNKNOW, FATAL, ERROR, WARN, INFO, DEBUG
+    level: INFO
+  # Option for sessions
+  session:
+    # Define time to send a keepalive message in seconds
+    keepalive: 45
+  # Option for used multi thread
+  thread:
+    # Boolean for activate options thread
+    enable: false
+    # Number of core
+    number: 1

data/config/requests/{test.json → admin/handle_info.json}

@@ -1,9 +1,7 @@
 {
-  "janus": "message",
+  "janus": "handle_info",
   "session_id": "<number>",
   "handle_id": "<number>",
   "transaction": "<string>",
-  "body": {
-    "audio": false
-  }
+  "admin_secret": "<string>"
 }

data/config/requests/admin/handles.json

@@ -0,0 +1,6 @@
+{
+  "janus": "list_handles",
+  "session_id": "<number>",
+  "transaction": "<string>",
+  "admin_secret": "<string>"
+}

data/config/requests/admin/log_level.json

@@ -0,0 +1,6 @@
+{
+  "janus": "set_log_level",
+  "level": "<integer>",
+  "transaction": "<string>",
+  "admin_secret": "<string>"
+}

data/config/requests/admin/sessions.json

@@ -0,0 +1,5 @@
+{
+  "janus": "list_sessions",
+  "transaction": "<string>",
+  "admin_secret": "<string>"
+}

data/config/requests/base/keepalive.json

@@ -0,0 +1,5 @@
+{
+  "janus": "keepalive",
+  "session_id": "<number>",
+  "transaction": "<string>"
+}

data/lib/generators/ruby_rabbitmq_janus/configuration_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Module contains all lib to this gem
+module RubyRabbitmqJanus
+  # Module for generators
+  module Generators
+    # Create an class for generate a custom configuration file
+    class ConfigurationGenerator < Rails::Generators::Base
+      desc 'Generate a custom configuration file.'
+
+      # Define root path for original file a copied
+      def self.source_root
+        root_path = File.realpath(File.join(File.dirname(__FILE__), '..', '..', '..'))
+        @_rrj_source_root ||= File.join(root_path, 'config')
+      end
+
+      # Copy a default configuration in config folder to Rails app
+      def copy_configuration
+        template 'default.yml', 'config/ruby-rabbitmq-janus.yml'
+      end
+    end
+  end
+end

data/lib/generators/ruby_rabbitmq_janus/create_request_generator.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Override String class
+class String
+  # Character used for delimited an line
+  SEPARATOR_LINE = ','
+  # Character used for delimited an key and this value
+  SEPARATOR_KEY_VALUE = ':'
+
+  # Converting a string with a format special to hash
+  def converting_to_hash
+    hash = {}
+    split(SEPARATOR_LINE).each do |couple_hash|
+      hash.merge! HashString.new(couple_hash.split(SEPARATOR_KEY_VALUE)).convert_in_hash
+    end
+    hash
+  end
+end
+
+# Create an hash with an array
+class HashString
+  # Initialize an array
+  def initialize(string_array)
+    @array = string_array
+    @hash = {}
+  end
+
+  # Create and return an hash
+  def convert_in_hash
+    @hash[@array[0]] = test_string_hash
+    @hash
+  end
+
+  private
+
+  # Test if string is hash
+  def test_string_hash
+    value.include?('{') ? HashString.new(format_hash_string).convert_in_hash : value
+  end
+
+  # Transform string to hash
+  def format_hash_string
+    @array.drop(1).join(':').sub('{', '').sub('}', '').split(String::SEPARATOR_KEY_VALUE)
+  end
+
+  # Return the value for hash object
+  def value
+    @array[1]
+  end
+end
+
+module RubyRabbitmqJanus
+  module Generators
+    # Create an class for generate a json request
+    class CreateRequestGenerator < Rails::Generators::Base
+      desc 'Create an request to json format for RubyRabbitmqJanus.'
+      argument :type_name, type: :string, default: ''
+      argument :janus_type, type: :string, default: ''
+      argument :content, type: :string, default: ''
+
+      # Create an file to json format in folder 'config/request/' to you Rails apps
+      def create_request
+        create_file file_json, write_json
+      end
+
+      private
+
+      # Create a path and name file
+      def file_json
+        base_file = type_name.empty? ? 'config/requests' : create_folder?(type_name)
+        "#{base_file}/#{janus_type}.json"
+      end
+
+      # Convert a string to hash and write in json file
+      def write_json
+        hash = {}
+        hash['janus'] = janus_type
+        hash.merge!(content.converting_to_hash)
+        JSON.pretty_generate(hash)
+      end
+
+      # Test if folder is exist and created if necessary
+      def create_folder?(folder_name)
+        path_folder = "config/requests/#{folder_name}"
+        Dir.mkdir path_folder unless File.exist?(path_folder)
+        path_folder
+      end
+    end
+  end
+end

data/lib/generators/ruby_rabbitmq_janus/default_request_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  module Generators
+    # Create an class for generate who copy a default request
+    class DefaultRequestGenerator < Rails::Generators::Base
+      desc 'Copy base request file sending to janus in application.'
+
+      # Define root path for original file a copied
+      def self.source_root
+        root_path = File.realpath(File.join(File.dirname(__FILE__), '..', '..', '..'))
+        @_rrj_source_root ||= File.join(root_path, 'config')
+      end
+
+      # Copy default request in Rails app
+      def copy_default_request
+        directory 'requests', 'config/requests'
+      end
+    end
+  end
+end

data/lib/generators/ruby_rabbitmq_janus/initializer_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  module Generators
+    # Create an class for generate a initializer
+    class InitializerGenerator < Rails::Generators::Base
+      desc 'Generate a initializer to this gem for rails application.'
+
+      # Create an initializer
+      def copy_initializer
+        initializer 'ruby_rabbitmq_janus.rb' do
+          "# frozen_string_literal: true\n\n::RRJ = RubyRabbitmqJanus::RRJ.new"
+        end
+      end
+    end
+  end
+end

data/lib/rrj/errors/config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  module Errors
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define an error if the configuration file is not here
+    class ConfigFileNotFound < Errors::RRJError
+      def initialize(file)
+        super "Error for configuration file (#{file}), does on exist.", :error
+      end
+    end
+
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define and error if rubrik level is not present
+    class LevelNotDefine < Errors::RRJError
+      def initialize
+        super 'Error in configuration file : option level is not present.', :warn
+      end
+    end
+  end
+end

data/lib/rrj/errors/error.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  # Define all error in gem
+  module Errors
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define errors to gems
+    class RRJError < StandardError
+      def initialize(message, level)
+        super(message)
+        Tools::Log.instance_method(level).bind(Tools::Log.instance).call(message)
+      end
+    end
+
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define an exception if gem dont initialize correctly
+    class RRJErrorInit < RRJError
+      def initialize(message)
+        super "Gem is not instanciate correctly : #{message}", :fatal
+      end
+    end
+
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define an error if method message_post given an exception
+    class RRJErrorPost < RRJError
+      def initialize(message)
+        super "Post message is failed : #{message}", :fatal
+      end
+    end
+
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define an error if method transation given an exception
+    class RRJErrorTransaction < RRJError
+      def initialize(message)
+        super "Transaction is failed : #{message}", :fatal
+      end
+    end
+
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define an error if method start_handle given an exception
+    class RRJErrorHandle < RRJError
+      def initialize(message)
+        super "Transaction handle is failed : #{message}", :fatal
+      end
+    end
+  end
+end
+
+require 'rrj/errors/janus'
+require 'rrj/errors/janus_message'
+require 'rrj/errors/janus_response'
+require 'rrj/errors/janus_transaction'
+
+require 'rrj/errors/config'
+require 'rrj/errors/rabbit'
+require 'rrj/errors/request'

data/lib/rrj/errors/janus.rb

@@ -0,0 +1,14 @@
+# 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
+      def initialize(message)
+        super "[JANUS] #{message}", :fatal
+      end
+    end
+  end
+end

data/lib/rrj/errors/janus_message.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  module Errors
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define an exception for janus message class
+    class JanusMessage < JanusError
+      def initialize(message)
+        super "[Message] Error create : #{message}"
+      end
+    end
+
+    # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+    # Define an exception for janus message to_json
+    class JanusMessageJson < JanusError
+      def initialize(message)
+        super "[Message] 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
+      def initialize(message)
+        super "[Message] 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
+      def initialize(message)
+        super "[Message] Error options to message : #{message}"
+      end
+    end
+  end
+end