ruby_rabbitmq_janus 1.2.9 → 2.0.0.pre.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e7097b3084bdf28a6ca3d98594bf42b6ec88a11
-  data.tar.gz: 12039167df87de0454f6b47f81764392e0b5cb92
+  metadata.gz: e1558392e819c90c47f344453a5cb2c3a35a736e
+  data.tar.gz: ea73603197dbeaa4a66cc9944878bda5a87f0f65
 SHA512:
-  metadata.gz: 515d7007165d7a1e53485b27bb75265aa5522ebf876655c07945c789efef28cd3ec99071543d8c7062df8c62fe4611d2aa30107ccbd66bf84e74f0b5e7c341da
-  data.tar.gz: 58611d01139e576079557531897b65c24b80e275cce625e519358c263c91432d09cfbd45d6acac4542cd8e862ba96fe6c6c42356e4a25192d60a483e67e92efb
+  metadata.gz: c17fddb071389955d91bff722fa07724789ccc4442e7867408a5311b6e718b02fcb6893b44ca365856be06706d8597c1cbbf85ae8b1f8bc3b1a1cf6ee1532ce9
+  data.tar.gz: 0daeb4638c093421bda626bc56cb70e4f1985753010d78a559838875df816796333486c58500f3b767f5bc4e0a1c72334ada87a677b1b9026e24b9cc208386df

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rrj.gemspec

data/README.md

@@ -1,8 +1,4 @@
-[![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 RabbitMQ Janus | [![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 Gem for Janus WebRTC Gateway integration using RabbitMQ message queue
 
@@ -14,29 +10,73 @@ RabbitMQ server in a queue for janus server. janus processes a message and send
 
 This gem is product by [Dazzl.tv](http://dazzl.tv)
 
+```linux
+------------                        ----------                      -------
+|Rails Apps|                        |RabbitMQ|                      |Janus|
+------------                        ----------                      -------
+  |                                   |                                |
+  | Request : { "janus": "info" }     |                                |
+  | --------------------------------> |                                |
+  | Create request json.              |                                |
+  | Sending in queue.                 |                                |
+  |                                   | -----------------------------> |
+  |                                   | Read a message in queue        | ----- |
+  |                                   |                                |       | Return a response
+  |                                   |                                |       | to treatment executed.
+  |                                   |                                | <---- |
+  |                                   |                                |
+  |                                   |                                |
+  |                                   | <----------------------------  |
+  | <-------------------------------- |                                |
+  |                                   |                                |
+  |                                   |                                |
+  |                                   |                                |
+  |                                   |                                |
+```
+
 ## Menu
+
 * [How to use](#how-to-use)
- * [Installation](#installation)
- * [Configuration](#configuration)
+  * [Installation](#installation)
+  * [Configuration](#configuration)
     * [Generators](#generators)
     * [Requests](#requests)
- * [Usage](#usage)
+  * [Usage](#usage)
+    * [Information](#usage-information)
+    * [Standard request](#standard-request)
+    * [Admin request](#admin-request)
+    * [Listen Janus Event](#listen-janus-event)
 * [Upgrade](#upgrade)
 * [Development](#development)
- * [RSpec](#rspec-test)
- * [Documentation](#documentation)
+  * [RSpec](#rspec-test)
+  * [Documentation](#documentation)
     * [Read documentation](#read-documentation)
     * [Generate developer documentation](#generate-developer-documentation)
+* [Contributing](#contributing)
+* [Plus](#plus)
 
 ## How to use
 
 ### Installation
 
-Use rubygem for installing gem in your application. Add in your Gemfile
+Use rubygem for installing gem in your application. Add in your Gemfile :
+
 ```ruby
 gem 'ruby_rabbitmq_janus'
 ```
 
+And then execute :
+
+```linux
+bundle
+```
+
+Or install it yourself as :
+
+```linux
+gem install evostream-event
+```
+
 ### Configuration
 
 If you want used a customize configuration see [ruby-rabbitmq-janus.yml](config/default.md)
@@ -68,8 +108,61 @@ For more explain in requests files see [default requests](config/requests.md).
 
 ### Usage
 
+#### Usage information
+
+This gem use rabbitmq for manage request sending to Janus, so see
+[documentation Janus](https://janus.conf.meetecho.com/docs/pages.html) and
+[documentation Rabbitmq](http://www.rabbitmq.com/documentation.html). This gem
+use bunny gem for create connection with rabbitmq. See many guide :
+[bunny documentation](http://rubybunny.info/articles/guides.html).
+
+#### Standard Request
+
+```ruby
+require 'ruby_rabbitmq_janus'
+
+# Initialize standard object
+t = RubyRabbitmqJanus::RRJ.new
+
+# Ask info Janus Instance
+t.start_transaction do |transaction|
+  transaction.publish_message('base::info')
+end
+
+=> @request={"janus"=>"server_info" ... }
+```
+
+#### Admin Request
 
-TODO ...
+```ruby
+require 'ruby_rabbitmq_janus'
+
+# Initialize admin object
+t = RubyRabbitmqJanus::RRJAdmin.new
+
+# Ask info sessions in Janus Instance
+t.start_transaction_admin do |transaction|
+  transaction.publish_message('admin::sessions')
+end
+
+=> @request={"janus"=>"success" ... "sessions"=>[123, 456, 789]}
+```
+
+#### Listen Janus Event
+
+```ruby
+require 'ruby_rabbitmq_janus'
+
+# Create a class in your Rails application
+actions = RubyRabbitmqJanus::ActionEvents.new.action
+
+# Initialize a thread for listen public queue and send class to thread
+RubyRabbitmqJanus::Janus::Concurrencies::Event.instance.run(@actions)
+```
+
+## Upgrade
+
+For upgrade your application read [CHANGELOG.md](CHANGELOG.md)
 
 ## Development
 
@@ -84,32 +177,40 @@ rabbitmq and use plugin echotest for janus server.
 
 Use tags for rspec :
 
-| Describe                                                          | Type            | Name            |
-| -------------------------------------------------------------     | --------------- | --------------- |
-| **Internaly function**                                            | config          |                 |
-| Use bunny gem                                                     |                 | rabbit          |
-| Test log functions                                                |                 | log             |
-| Test configuration function                                       |                 | config          |
-| Test Gem contains CONSTANTS                                       |                 | describe        |
-| **Level request sending to janus (admin monitor API or classic)** | level           |                 |
-| Request with no admin right.                                      |                 | base            |
-| Request with admin right in Janus application.                    |                 | admin           |
-| **Request JSON sending to Rabbitmq -> Janus**                     | request         |                 |
-| Test request attach type                                          |                 | attach          |
-| Test request type create                                          |                 | create          |
-| Test request type detach                                          |                 | detach          |
-| Test request type info                                            |                 | info            |
-| Test request type test                                            |                 | test            |
+| Describe                                                          | Type            | Name              |
+| -------------------------------------------------------------     | --------------- | ---------------   |
+| **Internaly function**                                            | config          |                   |
+| Use bunny gem                                                     |                 | rabbit            |
+| Test log functions                                                |                 | log               |
+| Test configuration function                                       |                 | config            |
+| Test Gem contains CONSTANTS                                       |                 | describe          |
+| **Level request sending to janus (admin monitor API or classic)** | level           |                   |
+| Request with no admin right.                                      |                 | base              |
+| Request with admin right in Janus application.                    |                 | admin             |
+| Request candidate/jsep                                            |                 | peer              |
+| **Request JSON sending to Rabbitmq -> Janus**                     | request         |                   |
+| Test request attach type                                          |                 | attach            |
+| Test request type create                                          |                 | create            |
+| Test request type detach                                          |                 | detach            |
+| Test request type janus info                                      |                 | info              |
+| Test request type test                                            |                 | test              |
+| Test request type handle list                                     |                 | handles           |
+| Test request type sesssion list                                   |                 | sessions          |
+| Test request type handle information                              |                 | handle_info       |
+| Test request type (un)locking debug                               |                 | set_locking_debug |
+| Test request type change log level                                |                 | set_log_level     |
+| ~~Test request type tokens list~~                                 |                 | tokens            |
+| Test request type destroy session                                 |                 | destroy           |
+| Test request keepalive                                            |                 | keepalive         |
+| ~~Test request type sdp offer~~                                   |                 | offer             |
+| Test request type trickle, send on candidate                      |                 | trickle           |
+| Test request type trickles, send array candidate                  |                 | trickles          |
 
 Example usage rspec with tags :
 ```ruby
 rspec --tag --name:config --tag level:base
 ```
 
-## Upgrade
-
-For upgrade your application read [CHANGELOG.md](CHANGELOG.md)
-
 ### Documentation
 
 #### Read documentation
@@ -128,3 +229,15 @@ yard server
 ```
 
 [See Yard Getting Started](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/dazzl-tv/ruby-rabbitmq-janus This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Plus
+
+Janus Admin Monitor project use this gem for manage data in Janus Meetecho with
+Admin/Monitor API.

data/config/default.yml

@@ -35,6 +35,8 @@ janus:
   # Create an array to plugin
   plugins:
     - janus.plugin.echotest
+    - janus.plugin.videoroom
+    - janus.plugin.sip
 
 # Options gem
 gem:

data/config/requests.md

@@ -53,7 +53,8 @@ Some fields are customizables. For this fields is a gem to apply a transformatio
 
 Each fields use an type :
 
-* "\<number\>" - Is an integer
+* "\<number\>" - Is a integer
+* "\<number\>" - Is a 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.

data/config/requests/admin/add_token.json

@@ -0,0 +1,6 @@
+{
+  "janus": "add_token",
+  "token": "<string>",
+  "transaction": "<transaction>",
+  "admin_secret": "<string>"
+}

data/config/requests/admin/allow_token.json

@@ -0,0 +1,6 @@
+{
+  "janus": "allow_token",
+  "token": "<string>",
+  "transaction": "<transaction>",
+  "admin_secret": "<string>"
+}

data/config/requests/admin/disallow_token.json

@@ -0,0 +1,6 @@
+{
+  "janus": "disallow_token",
+  "token": "<string>",
+  "transaction": "<transaction>",
+  "admin_secret": "<string>"
+}

data/config/requests/admin/handle_info.json

@@ -2,6 +2,6 @@
   "janus": "handle_info",
   "session_id": "<number>",
   "handle_id": "<number>",
-  "transaction": "<string>",
+  "transaction": "<transaction>",
   "admin_secret": "<string>"
 }

data/config/requests/admin/handles.json

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

data/config/requests/admin/remove_token.json

@@ -0,0 +1,6 @@
+{
+  "janus": "remove_token",
+  "token": "<string>",
+  "transaction": "<transaction>",
+  "admin_secret": "<string>"
+}

data/config/requests/admin/sessions.json

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

data/config/requests/admin/set_locking_debug.json

@@ -0,0 +1,6 @@
+{
+  "janus" : "set_locking_debug",
+  "debug" : "<boolean>",
+  "transaction": "<transaction>",
+  "admin_secret": "<string>"
+}

data/config/requests/admin/{log_level.json → set_log_level.json}

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

data/config/requests/admin/tokens.json

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

data/config/requests/base/attach.json

@@ -1,6 +1,6 @@
 {
   "janus": "attach",
   "session_id": "<number>",
-  "transaction": "<string>",
+  "transaction": "<transaction>",
   "plugin": "<plugin[0]>"
 }

data/config/requests/base/create.json

@@ -1,4 +1,4 @@
 {
   "janus": "create",
-  "transaction": "<string>"
+  "transaction": "<transaction>"
 }

data/config/requests/base/destroy.json

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

data/config/requests/base/detach.json

@@ -2,5 +2,5 @@
   "janus": "detach",
   "session_id": "<number>",
   "handle_id": "<number>",
-  "transaction": "<string>"
+  "transaction": "<transaction>"
 }

data/config/requests/base/info.json

@@ -1,4 +1,4 @@
 {
   "janus": "info",
-  "transaction": "<string>"
+  "transaction": "<transaction>"
 }

data/config/requests/base/keepalive.json

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

data/config/requests/peer/answer.json

@@ -2,7 +2,7 @@
   "janus": "message",
   "session_id": "<number>",
   "handle_id": "<number>",
-  "transaction": "<string>",
+  "transaction": "<transaction>",
   "body": {
     "request": "configure"
   },

data/config/requests/peer/offer.json

@@ -2,7 +2,7 @@
   "janus": "message",
   "session_id": "<number>",
   "handle_id": "<number>",
-  "transaction": "<string>",
+  "transaction": "<transaction>",
   "body": {
     "audio": true,
     "video": true

data/config/requests/peer/trickle.json

@@ -2,6 +2,6 @@
   "janus": "trickle",
   "session_id": "<number>",
   "handle_id": "<number>",
-  "transaction": "<string>",
+  "transaction": "<transaction>",
   "candidate": "<array>"
 }

data/lib/generators/ruby_rabbitmq_janus/initializer_generator.rb

@@ -13,6 +13,9 @@ require 'actions'
 # Initialize a gem and create an session with a keepalive
 ::RRJ = RubyRabbitmqJanus::RRJ.new
 
+# For admin management
+# ::RRJ = RubyRabbitmqJanus::RRJAdmin.new
+
 # This test disable this gems execution when you running an task with rake
 unless File.basename($PROGRAM_NAME) == 'rake'
   Rails.configuration.after_initialize do

data/lib/rrj/admin.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
+
+  # # RubyRabbitmqJanus - RRJAdmin
+  #
+  # This class inherite to a classic initializer but it's used for
+  # admin request sending to janus (Admin/Monitor API).
+  #
+  # **Is used just for sending a message to Janus Monitor/Admin API.**.
+  # **The queue is always ***exclusive*** for not transmitting data to
+  # anyone.**
+  #
+  # @see https://janus.conf.meetecho.com/docs/admin.html
+  class RRJAdmin < RRJ
+    # Create a transaction between apps and Janus for request without handle
+    #
+    # @param [Hash] options
+    #   Give a session number for use another session in Janus
+    #
+    # @example Get Janus session
+    #   @rrj.start_transaction_admin do |transaction|
+    #     response = transaction.publish_message('admin:sessions').sessions
+    #   end
+    #
+    # @since 2.0.0
+    def start_transaction_admin(options = {})
+      session = option.use_current_session?(options)
+      transaction = Janus::Transactions::Admin.new(session)
+      transaction.connect { yield(transaction) }
+    end
+  end
+end