Ruby RabbitMQ Janus |
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
Menu
How to use
Installation
Use rubygem for installing gem in your application. Add in your Gemfile :
gem 'ruby_rabbitmq_janus'
And then execute :
bundle
Or install it yourself as :
gem install ruby_rabbitmq_janus
Install basic configuration :
rails g ruby_rabbitmq_janus:install
Configuration
If you want used a customize configuration see ruby-rabbitmq-janus.yml
Janus
Configure one (or many) Janus server. See janus gateway documentation.
Configure the queue with rabbit with incremental number. So the first instance
take a name to-janus-1
and all queues from
sending in same queue.
Generators
Use generator for complete installation :
rails g -h
RubyRabbitmqJanus:
ruby_rabbitmq_janus:configuration # Generate a custom configuration file.
ruby_rabbitmq_janus:create_request # Create an request to json format for RubyRabbitmqJanus transaction.
ruby_rabbitmq_janus:default_request # Copy base request file sending to janus in application.
ruby_rabbitmq_janus:initializer # Generate a initializer to this gem for rails application.
ruby_rabbitmq_janus:install # Install RubyRabbitmqJanus in your Rails application
Requests
For create an new request is simple. Use a command generator :
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.
Usage
Usage information
This gem use rabbitmq for manage request sending to Janus, so see documentation Janus and documentation Rabbitmq. This gem use bunny gem for create connection with rabbitmq. See many guide : bunny documentation.
Standard Request
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
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
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.new.run(@actions)
Upgrade
For upgrade your application read CHANGELOG.md
Development
RSpec test
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 :
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 :
rspec --tag --name:config --tag level:base
Documentation
Read documentation
The documentation is accessible in rubydoc
Generate developer documentation
This doc is generated with yard.
# Genereate doc
yard
# Launch server
yard server
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 code of conduct.
Plus
Janus Admin Monitor project use this gem for manage data in Janus Meetecho with Admin/Monitor API.