ruby_rabbitmq_janus 1.1.12 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5916d357d819d815ed544afa0335e1ba5a38239
-  data.tar.gz: 0f8410f6753375fcaf62b08232f3d46c6e53955f
+  metadata.gz: 319f21f0c9819cad786787a0d4d3959d81136ff9
+  data.tar.gz: 04309841a1a11d5e43e1a5869fd4b87e74e2763b
 SHA512:
-  metadata.gz: 03698c63eac40e145e24d5b47ac39a62da35e337f805902b36e230658e706866177caca09de4b3df73f42f7020ae7f1c2135932420dc5593b18b1279a197776e
-  data.tar.gz: f3326f8f7cad19087f97c3c2d4170d21de8f31a12e7c1d07add308a7ecc1f7210c76bcc696325106c7a160fa6b29bbfd40411086e14537a6812f7941ddd18939
+  metadata.gz: f1a66b42070c411b11c6c83c94db4ba3e738d990fdefc404b04ff540ff36e17b816ddec79cdacd1a54c8e861a38fc8a8c5a25b2354619e55c326047d6b218114
+  data.tar.gz: bb9d2e51ba0c821a17d1463a4add055c0479bb395fd41d533e2a35e33e49cefd9f925a612887ebb23acdfe36ba047f984d34bbd7f8e8f8c22ca797143c3cd69d

data/README.md

@@ -0,0 +1,127 @@
+[![Build Status](https://travis-ci.org/dazzl-tv/ruby-rabbitmq-janus.svg?branch=master)](https://travis-ci.org/dazzl-tv/ruby-rabbitmq-janus)
+[![Gem Version](https://badge.fury.io/rb/ruby_rabbitmq_janus.svg)](https://badge.fury.io/rb/ruby_rabbitmq_janus)
+[![inline docs](http://inch-ci.org/github/dazzl-tv/ruby-rabbitmq-janus.svg)](http://inch-ci.org/github/dazzl-tv/ruby-rabbitmq-janus)
+
+# ruby-rabbitmq-janus -- RRJ
+
+Ruby Gem for Janus WebRTC Gateway integration using RabbitMQ message queue
+
+This gem is used to communicate to a server Janus through RabbitMQ software (
+Message-oriented middleware). It waiting a messages to Rails API who send to RabbitMQ
+server in a queue for janus server. janus processes a message and send to RabbitMQ server
+in a queue for gem. Once the received message is decoded and returned through the Rails API.
+
+
+This gem is product by [Dazzl.tv](http://dazzl.tv)
+
+## Menu
+* [How to use](#how-to-use)
+ * [Installation](#installation)
+ * [Configuration](#configuration)
+    * [Generators](#generators)
+    * [Requests](#requests)
+ * [Usage](#usage)
+* [Upgrade](#upgrade)
+* [Development](#development)
+ * [RSpec](#rspec-test)
+ * [Documentation](#documentation)
+    * [Read documentation](#read-documentation)
+    * [Generate developer documentation](#generate-developer-documentation)
+
+## How to use
+
+### Installation
+
+Use rubygem for installing gem in your application. Add in your Gemfile
+```ruby
+gem 'ruby_rabbitmq_janus'
+```
+
+### Configuration
+
+If you want used a customize configuration see [ruby-rabbitmq-janus.yml](config/default.md)
+
+#### Generators
+
+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.
+```
+
+#### Requests
+
+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
+```
+
+For more explain in requests files see [default requests](config/requests.md).
+
+### Usage
+
+
+TODO ...
+
+## Development
+
+### RSpec test
+
+```linux
+bundle exec rspec
+```
+
+TIPS: for rspec install janus and rabbitmq server configured by default for user
+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          |
+
+## Upgrade
+
+For upgrade your application read [CHANGELOG.md](CHANGELOG.md)
+
+### Documentation
+
+#### Read documentation
+
+The documentation is accessible in [rubydoc](http://www.rubydoc.info/gems/ruby_rabbitmq_janus/)
+
+#### Generate developer documentation
+
+This doc is generated with yard.
+
+```
+# Genereate doc
+yard
+# Launch server
+yard server
+```
+
+[See Yard Getting Started](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)

data/Rakefile

@@ -3,9 +3,7 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = '--tag ~level:admin'
-end
+RSpec::Core::RakeTask.new(:spec)
 
 RSpec::Core::RakeTask.new(:no_request_spec) do |t|
   t.rspec_opts = '--tag ~type:request'

data/config/default.md

@@ -6,39 +6,39 @@ By default the configuration file look like this :
 
 ```yaml
 rabbit:
-    host: 'localhost'
+    host: localhost
     port: 5672
-    vhost: '/'
-    user: 'guest'
-    pass: 'guest'
+    vhost: /
+    user: guest
+    pass: guest
     admin_pass: janusoverlord
 
 queues:
-    queue_from: from-janus
-    queue_to: to-janus
+  standard:
+    from: from-janus
+    to: to-janus
     admin:
-      queue_from: from-janus
-      queue_to: to-janus
+      from: from-janus-admin
+      to: to-janus-admin
 
 janus:
+  session:
+    keepalive: 45
   plugins:
     - janus.plugin.echotest
 
 gem:
   log:
-    level: WARN
-  session:
-    keepalive: 45
-  thread:
-    enable: false
-    number: 1
+    level: info
 ```
 
 ## Customize
+
 For customizing a configuration add a yml file in your rails project in
 `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)
 * [Configuration of Janus queue](https://janus.conf.meetecho.com/docs/rest.html#rabbit)

data/config/default.yml

@@ -1,7 +1,7 @@
 # Rabbit information connection
 rabbit:
   # Precise RabbitMQ host - Default 'localhost'
-  host: rabbit
+  host: localhost
   # Precise RabbitMQ port - Default '5672'
   port: 5672
   # Precise RabbitMQ vhost - Default '/'
@@ -15,19 +15,23 @@ rabbit:
 
 # RabbitMQ Queue information
 queues:
-  # Queue sending response to janus server
-  queue_from: from-janus
-  # Queue sending a message for janus server
-  queue_to: to-janus
-  # Queues for admin janus
+  standard:
+    # Queue sending response to janus server
+    from: from-janus
+    # Queue sending a message for janus server
+    to: to-janus
   admin:
     # Queue sending response to admin API janus
-    queue_from: from-janus-admin
+    from: from-janus-admin
     # Queue sending a message for admin API janus
-    queue_to: to-janus-admin
+    to: to-janus-admin
 
 # Janus plugin used
 janus:
+  # Option for sessions
+  session:
+    # Define time to send a keepalive message in seconds
+    keepalive: 55
   # Create an array to plugin
   plugins:
     - janus.plugin.echotest
@@ -39,13 +43,3 @@ gem:
     # 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.md

@@ -0,0 +1,80 @@
+# Requests
+
+## Defaults request
+
+By default this gem contains many request :
+
+```linux
+├── admin
+│   ├── handle_info.json
+│   ├── handles.json
+│   ├── log_level.json
+│   └── sessions.json
+├── base
+│   ├── attach.json
+│   ├── create.json
+│   ├── destroy.json
+│   ├── detach.json
+│   ├── info.json
+│   └── keepalive.json
+├── peer
+│   ├── answer.json
+│   ├── offer.json
+│   ├── trickle.json
+```
+
+* Folder `admin` contains admin requests for interact with Janus Admin/Monitor
+ API. [See official docs.](https://janus.conf.meetecho.com/docs/admin.html)
+* Folder `base` contains base requests for interact with Janus.
+
+## Request files
+
+All request is writing in JSON format and contains many informations.
+
+Example base request with type `'base::info'` :
+
+```json
+{
+  "janus": "info",
+  "transaction": "<string>"
+}
+```
+
+For more explain to construct request sending to Janus [see official documentation](https://janus.conf.meetecho.com/docs/rest.html).
+
+Some fields are customizables. For this fields is a gem to apply a transformation :
+
+* session_id
+* handle_id
+* transaction
+* candidate
+* admin_secret  -  *just for admin secret*
+* level -  *just for admin secret*
+
+Each fields use an type :
+
+* "\<number\>" - Is an integer
+* "\<string\>" - Is a string
+* "\<plugin[X]\>" - Is a plugin with X is a key to array in config file
+* "\<array\>" - Is a array. If array contains a single value is transform to string format.
+
+## Complex request
+
+Example peer request with type `'peer:offer'` :
+
+```json
+{
+  "janus": "message",
+  "session_id": "<number>",
+  "handle_id": "<number>",
+  "transaction": "<string>",
+  "body": {
+    "audio": "true",
+    "video": "true"
+  },
+  "jsep": {
+    "type": "offer",
+    "sdp": "<string>"
+  }
+}
+```

data/config/requests/{channel → peer}/answer.json

@@ -4,7 +4,7 @@
   "handle_id": "<number>",
   "transaction": "<string>",
   "body": {
-    "request": "configure",
+    "request": "configure"
   },
   "jsep": {
     "type": "answer",

data/lib/generators/ruby_rabbitmq_janus/install_generator.rb

@@ -32,6 +32,7 @@ end
 config.autoload_paths += Dir[Rails.root.join('app', 'ruby_rabbitmq_janus')]
       AUTOLOAD
 
+      # Generate initializer with default code
       def add_actions
         # Create an class
         create_file 'app/ruby_rabbitmq_janus/actions.rb', ACTION_CLASS

data/lib/rrj/errors/config.rb

@@ -3,17 +3,24 @@
 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
+      # Initialize a error for Config class if file don't exist.
+      # It's a fatal error
+      # @param [String] file Is a file path
       def initialize(file)
         super \
-          "Error for configuration file (#{file}), does on exist.", :error
+          "Error for configuration file (#{file}), does on exist.", :fatal
       end
     end
 
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
     # Define and error if rubrik level is not present
     class LevelNotDefine < Errors::RRJError
+      # Initialize a error for config class if log level option is not present.
+      # It's a warning error
       def initialize
         super \
           'Error in configuration file : option level is not present.', :warn

data/lib/rrj/errors/error.rb

@@ -1,37 +1,50 @@
 # frozen_string_literal: true
-# rubocop:disable Metrics/LineLength
 
 module RubyRabbitmqJanus
   # Define all error in gem
   module Errors
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
     # Define errors to gems
     class RRJError < StandardError
+      # Initialize a error standard in this gem
+      # @param [String] message Text returning in raise
+      # @param [Symbol] level Important to error
       def initialize(message, level)
         super(message)
-        Tools::Log.instance_method(level).bind(Tools::Log.instance).call(message)
+        log = Tools::Log.instance
+        Tools::Log.instance_method(level).bind(log).call(message)
       end
     end
 
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
     # Define an exception if gem dont initialize correctly
     class RRJErrorInit < RRJError
+      # Initialize a error for instanciate class. It's a fatal error
+      # @param [String] message Text returning in raise
       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
+      # Initialize a error for message posting. It's a fatal error
+      # @param [String] message Text returning in raise
       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
+
+    # Define an error if method transaction given an exception
     class RRJErrorTransaction < RRJError
+      # Initialize a error for transaction failed. It's a fatal error
+      # @param [String] message Text returning in raise
       def initialize(message)
         super "Transaction is failed : #{message}", :fatal
       end
@@ -40,13 +53,14 @@ module RubyRabbitmqJanus
     # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
     # Define an error if method start_handle given an exception
     class RRJErrorHandle < RRJError
+      # Initialize a error for transaction with a handle. It's a fatal error
+      # @param [String] message Text returning in raise
       def initialize(message)
         super "Transaction handle is failed : #{message}", :fatal
       end
     end
   end
 end
-# rubocop:enable Metrics/LineLength
 
 require 'rrj/errors/janus'
 require 'rrj/errors/janus_message'
@@ -55,4 +69,3 @@ require 'rrj/errors/janus_transaction'
 
 require 'rrj/errors/config'
 require 'rrj/errors/rabbit'
-require 'rrj/errors/request'