ruby_rabbitmq_janus 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f021ba350f01ec31ec3a312852fba9aad13bc3d
-  data.tar.gz: 4c02fb1a5cd2bb555744412432a858cb427c19b2
+  metadata.gz: ffd08f2f0ae315d6330ae87407c249c8de25bb55
+  data.tar.gz: 12a22014d95a64e3231d1ac9de1c36b4eb4d263a
 SHA512:
-  metadata.gz: 8e06d5e9d0fa8918e3fb05418591a1359cd745a2b5b6115131aa1065bbc58a24b9738064d107790820a688d90d858cabf4ed5fcc3ce754900141d0a0458c4eb0
-  data.tar.gz: 34b60a33db21da0d73fd20f850af13d0a8974d69e7ce34c2f449f2f17d8a63c565180bc51659a4fd2af5c572d7ce283fad93e646618a4d6ec833712fa2455ca7
+  metadata.gz: 619529b2da03ed8582cb91b4009894dbfbf5cf4f4d45f8d91fda3b7e392326ac33285dbf4df3b2bb45988695875085945ce9322ddcd77760a6cd0536c93499ca
+  data.tar.gz: 4e15f89cb74a0b0574ec06bc518fe5e8c6393d3c68b5aefaaeaee501369f2dc0c37ccbd9a0b6204d928aaa4aa24cfc21e10da5ff1498beb448a88a0b4ee56078

data/.rubocop.yml

@@ -9,4 +9,4 @@ Style/Encoding:
   Enabled: true
 
 Metrics/LineLength:
-  Max: 90
+  Max: 80

data/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+
+## [1.1.8] - 2016-11-29
+### Changed
+- Return handle created with start_handle method
+- Complete info in README.md
+- Change metrics length
+### Deleted
+- Delete a test script `listen.rb`
+
 ## [1.1.7] - 2016-11-28
 ### Changed
 - Use handle if is given in arguments for handle_message_simple

data/README.md

@@ -1,4 +1,4 @@
-# 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 (
@@ -6,6 +6,9 @@ Message-oriented middleware). It waiting a messages to Rails API who send to Rab
 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)
@@ -14,9 +17,12 @@ in a queue for gem. Once the received message is decoded and returned through th
     * [Usage Synchrounous](#usage-with-synchronous-request)
     * [Usage Asynchrounous](#usage-with-asynchronous-request)
     * [Aliases](#aliases)
+* [Upgrade](#upgrade)
 * [Development](#development)
  * [RSpec](#rspec-test)
  * [Documentation](#documentation)
+    * [Read documentation](#read-documentation)
+    * [Generate developer documentation](#generate-developer-documentation)
 
 ## How to use
 
@@ -122,6 +128,7 @@ message_template_ask_async => ask_async
 ```
 
 ## Development
+
 ### RSpec test
 
 ```linux
@@ -146,8 +153,18 @@ Use tags for rspec :
 |                 | 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.
 
 ```
@@ -157,4 +174,4 @@ yard
 yard server
 ```
 
-see [Yard Getting Started](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
+[See Yard Getting Started](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)

data/lib/rrj/info.rb

@@ -3,17 +3,19 @@
 # Define constant to gem.
 module RubyRabbitmqJanus
   # Define version to gem
-  VERSION = '1.1.7'
+  VERSION = '1.1.8'
 
   # Define a summary description to gem
   SUMMARY = 'Ruby RabbitMQ Janus'
 
   # Define a long description to gem
-  DESCRIPTION = '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.'
+  DESCRIPTION = <<-DESC
+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.
+    DESC
 
   # Define homepage
   HOMEPAGE = 'https://github.com/dazzl-tv/ruby-rabbitmq-janus'

data/lib/rrj/init.rb

@@ -13,9 +13,12 @@ require 'colorize'
 
 module RubyRabbitmqJanus
   # @author VAILLANT Jeremy <jeremy.vaillant@dazzl.tv>
-  # Initialize gem and create automatically an session with Janus
+  # Initialize RRJ gem and create automatically a session with janus and
+  # sending a keepalive message. The Time To Live is configured in yaml
+  # configuration file 'config/default.yml' or
+  # 'config/ruby-rabbitmq-janus.yml'.
   # @!attribute [r] session
-  #   @return [Fixnum] Renturn an session number created in instanciate gem
+  #   @return [Fixnum] Return an session number created in instantiate this gem.
   # :reek:BooleanParameter and :reek:ControlParameter and :reek:DataClump
   # :reek:LongParameterList and :reek:TooManyStatements
   class RRJ
@@ -81,7 +84,8 @@ module RubyRabbitmqJanus
     # Give an object response to janus server
     def message_admin(type, options = {})
       Janus::Transactions::Admin.new(@session).connect do
-        Janus::Messages::Admin.new(type, options.merge!('session_id' => @session))
+        Janus::Messages::Admin.new(type,
+                                   options.merge!('session_id' => @session))
       end
     end
 
@@ -122,8 +126,8 @@ module RubyRabbitmqJanus
     end
 
     # Start an short transaction. Create an handle and send a message to queue.
-    # This queue is not exclusive, so this message is sending in queue 'to-janus' and a
-    # response is return in queue 'from-janus'
+    # This queue is not exclusive, so this message is sending in queue
+    # 'to-janus' and a response is return in queue 'from-janus'
     # @example Send an request trickle
     #   candidate = {
     #     'candidate' => {
@@ -132,8 +136,12 @@ module RubyRabbitmqJanus
     #       'candidate' => '...'
     #     }
     #   }
-    #   RubyRabbitmqJanus::RRJ.new.handle_message_simple('peer::trickle', candidate)
-    #   #=> { 'janus' => 'trickle', ..., 'candidate' => { 'completed' : true } } }
+    #   RubyRabbitmqJanus::RRJ.new.handle_message_simple('peer::trickle',
+    #                                                    candidate)
+    #   #=> { 'janus' => 'trickle', ..., 'candidate' => {
+    #     'completed' : true
+    #     }
+    #   }
     def handle_message_simple(type, replace = {}, add = {}, exclusive = false)
       handle = replace.include?('handle_id') ? replace['handle_id'] : 0
       @transaction = Janus::Transactions::Handle.new(@session)

data/lib/rrj/janus/transactions/handle.rb

@@ -21,10 +21,11 @@ module RubyRabbitmqJanus
             create_handle
             yield
           end
+          handle
         end
 
-        # Initialize connection to Rabbit and Janus and close after sending an received
-        # a response
+        # Initialize connection to Rabbit and Janus and close after sending an
+        # received a response
         def handle_connect_and_stop(exclusive, sender)
           @exclusive = exclusive
           rabbit.transaction_short do
@@ -52,7 +53,8 @@ module RubyRabbitmqJanus
         # Create an handle for transaction
         def create_handle
           Tools::Log.instance.info 'Create an handle'
-          msg = Janus::Messages::Standard.new('base::attach', 'session_id' => session)
+          opt = { 'session_id' => session }
+          msg = Janus::Messages::Standard.new('base::attach', opt)
           @handle = send_a_message_exclusive { msg }
         end
 
@@ -64,7 +66,9 @@ module RubyRabbitmqJanus
 
         # Send a messaeg in exclusive queue
         def send_a_message_exclusive
-          Janus::Responses::Standard.new(read_response_exclusive { yield }).sender
+          Janus::Responses::Standard.new(read_response_exclusive do
+            yield
+          end).sender
         end
 
         # Read an response in queue exclusive

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_rabbitmq_janus
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.8
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -292,11 +292,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
-description: 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.
+description: |
+  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.
 email:
 - jeremy.vaillant@dazzl.tv
 executables: []
@@ -373,7 +374,6 @@ files:
 - lib/rrj/tools/requests.rb
 - lib/rrj/tools/tools.rb
 - lib/ruby_rabbitmq_janus.rb
-- listen.rb
 - rrj.gemspec
 homepage: https://github.com/dazzl-tv/ruby-rabbitmq-janus
 licenses:

data/listen.rb

@@ -1,45 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'ruby_rabbitmq_janus'
-
-@t = RubyRabbitmqJanus::RRJ.new
-@e = RubyRabbitmqJanus::Janus::Concurrencies::Event.instance
-
-def case_event(response)
-  puts "REASON : Event : #{response.to_hash}"
-end
-
-def case_hangup(data)
-  puts "REASON : Hangup : #{data}"
-end
-
-def case_error(data)
-  puts "REASON : Error : #{data}"
-end
-
-def case_stop
-  puts 'REASON : Stop'
-  Thread.current.stop
-end
-
-events = lambda do |reason, response|
-  puts "Execute block code with reason : #{reason}"
-  case reason
-  when 'event' then case_event(response)
-  when 'hangup' then case_hangup(response)
-  when 'error' then case_error(response)
-  when 'stop' then case_stop
-  else
-    puts 'REASON default'
-  end
-  puts " --\n\r"
-end
-
-puts '## Start listen Block'
-@e.run(&events)
-puts '## End listen block'
-
-puts '## APPS RUNNING'
-loop do
-end