ruby_rabbitmq_janus 3.0.0.pre.336 → 3.0.0.pre.351

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7eb3308fd4b4101d40215b0a2f3bbd390aa66886f6c11b958a629a13a850070
-  data.tar.gz: 0a4857a37cbfa0d8c36339299464ea235d940a20f9e80ce3555319c6b447ec2e
+  metadata.gz: 26081e2dcef6062935a89a824e2545e00303be4ea41272496692a5be73745a4b
+  data.tar.gz: d84fc9d5f8f597cb4d8306f2e81c596df72687cbdb42ff05e80a1036d9d54363
 SHA512:
-  metadata.gz: 2129db9760da0dac75a6ff6a85589217c5c3e6ccceeef1170e06df2d96fc9ad3855e586a2890d6018275ec9b538a0a6b8ac9a0d81f8f0abb889c8e60d52585f9
-  data.tar.gz: a927e49794cbbaab7743ed85992f26083bb029f6a9398793de011ff484505fb5b585c8f49deaa9b8e70b1783fb7c79ebb4a584804ce43810b00d6f33b2892b68
+  metadata.gz: 51f97d6b078e8b371138dc14cef095c120a9de8cea32c7d665adc539aa83525e4dfcb833b7834a088d75dff80e819c7e480ad1434750cc0ec06e437ed5aae49e
+  data.tar.gz: 233929c96f3f83c4ed996868a4c2b826234970ba75271441bac569c36a7cc2c396a79ad3586d368cb3b8eefb4df7bd680129024c32cc037a23b529f851d3dcf0

data/README.md

@@ -16,6 +16,7 @@ This gem is product by [Dazzl.tv](http://dazzl.tv)
 
 * [How to use](#how-to-use)
   * [Installation](#installation)
+  * [Requirements](#requirements)
   * [Configuration](#configuration)
     * [Janus](#janus)
     * [Generators](#generators)
@@ -62,6 +63,11 @@ Install basic configuration :
 rails g ruby_rabbitmq_janus:install
 ```
 
+### Requirements
+
+* Janus Gateway : minimum version `0.7.4` [Source Code](https://github.com/meetecho/janus-gateway) - [Documentation](https://janus.conf.meetecho.com/docs/)
+* RabbitMQ server
+
 ### Configuration
 
 If you want used a customize configuration see [ruby-rabbitmq-janus.yml](config/default.md)
@@ -127,6 +133,8 @@ end
 
 #### Admin Request
 
+__NOTE: The request authentication `HMAC-Signed token authentication` is not available.__
+
 ```ruby
 require 'ruby_rabbitmq_janus'
 
@@ -154,6 +162,18 @@ actions = RubyRabbitmqJanus::ActionEvents.new.action
 RubyRabbitmqJanus::Janus::Concurrencies::Event.new.run(@actions)
 ```
 
+#### Listen Janus Admin Event
+
+```ruby
+require 'ruby_rabbitmq_janus'
+
+# Create a class in your Rails application
+actions = RubyRabbitmqJanus::ActionAdminEvents.new.action
+
+# Initialize a thread for listen public admin queue and send class to thread
+RubyRabbitmqJanus::Janus::Concurrencies::EventAdmin.new.run(@actions)
+```
+
 ## Upgrade
 
 For upgrade your application read [CHANGELOG.md](CHANGELOG.md)
@@ -162,43 +182,74 @@ For upgrade your application read [CHANGELOG.md](CHANGELOG.md)
 
 ### RSpec test
 
+__Use docker for running SPEC__
+
 ```linux
-bundle exec rspec
+# Prepare images
+docker-compose build
+
+# Launch tiers service RabbitMQ
+docker-compose up -d rabbit
+
+# Launch tiers service Janus (ensure rabbit is started before and READY)
+docker-compose up -d janus janus_token
+
+## Excute ##
+
+# Start for MongoID database
+docker-compose run gem env MONGO=true bundle exec rake classic
+docker-compose run gem env MONGO=true bundle exec rake concurrency
+
+# Start for SQlite3 database
+docker-compose run gem env MONGO=false bundle exec rake classic
+docker-compose run gem env MONGO=false bundle exec rake concurrency
+
+## OR ##
+
+# Navigate in container an
+docker-compose run gem ash
+export MONGO=true
+bundle exec rake classic
 ```
 
+NOTE : Use `SPEC_DEBUG=true bundle exec rake classic` for stopping rspec execution when first test fail.
+
 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 :
 
-| 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          |
+| 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 basic.                                                |                 | 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          |
+| Event(s) thread                                               | event           |                   |
+| Test thread public queue                                      |                 | event             |
+| Test thread admin queue                                       |                 | event_admin       |
 
 Example usage rspec with tags :
 ```ruby

data/bin/ruby_rabbitmq_janus

@@ -13,7 +13,7 @@
 # for writing in another logger instead rails logs.
 
 require 'rrj/tools/bin/config'
-require 'rrj/tools/gem/log'
+require 'rrj/tools/gem/logger'
 
 Log = RubyRabbitmqJanus::Tools::Logger.create
 RubyRabbitmqJanus::Tools::Logger.start

data/config/default.yml

@@ -27,8 +27,6 @@ queues:
     from: from-janus-admin
     # Queue sending a message for admin API janus
     to: to-janus-admin
-  # Name to queue for managing instances
-  instance: janus-instance-thread
 
 # Janus plugin used
 janus:
@@ -78,5 +76,5 @@ gem:
   orm: 'mongoid'
   # Read response json for RSpec
   response_path: 'spec/supports/rrj/responses'
-  # Number ofprocess read public queue
+  # Number of process read public queue
   process: 1

data/config/requests/admin/allow_token.json

@@ -2,5 +2,6 @@
   "janus": "allow_token",
   "token": "<string>",
   "transaction": "<transaction>",
-  "admin_secret": "<string>"
+  "admin_secret": "<string>",
+  "plugins": "<plugins>"
 }

data/config/requests/admin/disallow_token.json

@@ -2,5 +2,6 @@
   "janus": "disallow_token",
   "token": "<string>",
   "transaction": "<transaction>",
-  "admin_secret": "<string>"
+  "admin_secret": "<string>",
+  "plugins": "<plugins>"
 }

data/config/requests/admin/set_session_timeout.json

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

data/config/requests/peer/trickles.json

@@ -0,0 +1,7 @@
+{
+  "janus": "trickle",
+  "session_id": "<number>",
+  "handle_id": "<number>",
+  "transaction": "<transaction>",
+  "candidates": "<array>"
+}

data/lib/rrj/admin.rb

@@ -38,8 +38,6 @@ module RubyRabbitmqJanus
     def admin_endpoint(options = {})
       transaction = Janus::Transactions::Admin.new(options)
       transaction.connect { yield(transaction) }
-    rescue
-      raise Errors::RRJAdmin::StartTransactionAdmin, options
     end
   end
 end

data/lib/rrj/errors/error.rb

@@ -12,19 +12,24 @@ module RubyRabbitmqJanus
       # @param [String] message Text returning in raise
       # @param [Symbol] level Important to error
       def initialize(message, level)
-        super(message)
         write_error(message, level)
+        super(message)
       end
 
       private
 
       def write_error(message, level = :unknown)
         if defined?(::Log)
-          ::Log.add(level, message)
+          ::Log.send(level.class.eql?(Symbol) ? level : int_to_level(level),
+                     message)
         else
           p "#{level}, #{message}"
         end
       end
+
+      def int_to_level(sym_level)
+        %I[debug info warn error fatal unknown].index(sym_level)
+      end
     end
   end
 end

data/lib/rrj/errors/janus/janus.rb

@@ -1,26 +1,12 @@
 # frozen_string_literal: true
 
-# @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
-module RubyRabbitmqJanus
-  module Errors
-    # Define errors to message sending and response to janus
-    class BaseJanus < RRJError
-      # Initialize a error standard for janus module
-      #
-      # @param [String] message Text returning in raise
-      def initialize(message, level)
-        super "[JANUS]#{message}", level
-      end
-    end
-  end
-end
-
 require 'rrj/errors/janus/messages/message'
 require 'rrj/errors/janus/messages/admin'
 require 'rrj/errors/janus/messages/standard'
 
-require 'rrj/errors/janus/responses/response'
+require 'rrj/errors/janus/responses/base'
+
+require 'rrj/errors/janus/responses/code'
 require 'rrj/errors/janus/responses/admin'
 require 'rrj/errors/janus/responses/event'
 require 'rrj/errors/janus/responses/standard'

data/lib/rrj/errors/janus/messages/message.rb

@@ -4,7 +4,7 @@ module RubyRabbitmqJanus
   module Errors
     module Janus
       # Define a super class for all error in Janus::Message
-      class BaseMessage < BaseJanus
+      class BaseMessage < RubyRabbitmqJanus::Errors::RRJError
         def initialize(message, level)
           super "[Message]#{message}", level
         end

data/lib/rrj/errors/janus/responses/admin.rb

@@ -1,36 +1,80 @@
 # frozen_string_literal: true
 
-# @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-
 module RubyRabbitmqJanus
   module Errors
     module Janus
-      # Define a super class for all error in Janus::Responses::ResponseAdmin
-      class BaseResponseAdmin < RubyRabbitmqJanus::Errors::Janus::BaseResponse
-        def initialize(message)
-          super "[Admin] #{message}"
-        end
-      end
+      module Responses
+        module Admin
+          class Base < RubyRabbitmqJanus::Errors::Janus::Responses::Base
+            def initialize(message)
+              super 'Admin', message
+            end
+          end
 
-      module ResponseAdmin
-        # Error for Janus::Responses::ResponseAdmin#sessions
-        class Sessions < RubyRabbitmqJanus::Errors::Janus::BaseResponseAdmin
-          def initializer
-            super 'Error sessions information reading'
+          class Sessions < Base
+            def initialize
+              super "Missing key 'sessions'"
+            end
           end
-        end
 
-        # Error for Janus::Responses::ResponseAdmin#handles
-        class Handles < RubyRabbitmqJanus::Errors::Janus::BaseResponseAdmin
-          def initializer
-            super 'Error handles information reading'
+          class Handles < Base
+            def initialize
+              super "Missing key 'handles'"
+            end
+          end
+
+          class Info < Base
+            def initialize
+              super "Missing key 'info'"
+            end
+          end
+
+          class LibniceDebug < Base
+            def initialize
+              super "Missing key 'libnice_debug'"
+            end
+          end
+
+          class LockingDebug < Base
+            def initialize
+              super "Missing key 'locking_debug'"
+            end
+          end
+
+          class LogColors < Base
+            def initialize
+              super "Missing key 'log_color'"
+            end
+          end
+
+          class Level < Base
+            def initialize
+              super "Missing key 'log_level'"
+            end
+          end
+
+          class LogTimestamps < Base
+            def initialize
+              super "Missing key 'log_timestamps'"
+            end
+          end
+
+          class MaxNackQueue < Base
+            def initialize
+              super "Missing key 'max_nack_queue'"
+            end
+          end
+
+          class NoMediaTimer < Base
+            def initialize
+              super "Missing key 'no_media_timer'"
+            end
           end
-        end
 
-        # Error for Janus::Responses::ResponseAdmin#info
-        class Info < RubyRabbitmqJanus::Errors::Janus::BaseResponseAdmin
-          def initializer
-            super 'Error info information reading'
+          class Timeout < Base
+            def initialize
+              super "Missing key 'session_timeout'"
+            end
           end
         end
       end

data/lib/rrj/errors/janus/responses/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  module Errors
+    module Janus
+      module Responses
+        class Base < RubyRabbitmqJanus::Errors::RRJError
+          def initialize(klass, message, level = :warn)
+            super "[Response][#{klass}] #{message}", level
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rrj/errors/janus/responses/code.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubyRabbitmqJanus
+  module Errors
+    module Janus
+      module Responses
+        class Nok < RubyRabbitmqJanus::Errors::RRJError
+          def initialize(request)
+            super "[#{request.error_code}] Reason : #{request.error_reason}", :error
+          end
+        end
+
+        Unknown = Nok
+        NotAcceptingSession = Nok
+        WebRTCState = Nok
+        TokenNotFound = Nok
+        UnexpectedAnswer = Nok
+        SessionConflit = Nok
+        InvalidElementType = Nok
+        TrickleInvalidStream = Nok
+        JSEPInvalidSDP = Nok
+        JSEPUnknownType = Nok
+        PluginDetach = Nok
+        PluginMessage = Nok
+        PluginAttach = Nok
+        PluginNotFound = Nok
+        HandleNotFound = Nok
+        SessionNotFound = Nok
+        InvalidRequestPath = Nok
+        MissingMandatoryElement = Nok
+        InvalidJSONObject = Nok
+        InvalidJSON = Nok
+        UnknownRequest = Nok
+        MissingRequest = Nok
+        TransportSpecific = Nok
+        UnauthorizedPlugin = Nok
+        Unauthorized = Nok
+      end
+    end
+  end
+end