README.md in ruby_rabbitmq_janus-1.2.2 vs README.md in ruby_rabbitmq_janus-1.2.3.pre.53
- old
+ new
@@ -4,16 +4,16 @@
# 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 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)
@@ -46,21 +46,15 @@
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.
+ 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 :
@@ -88,21 +82,30 @@
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 |
+| 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 |
+
+Example usage rspec with tags :
+```ruby
+rspec --tag --name:config --tag level:base
+```
## Upgrade
For upgrade your application read [CHANGELOG.md](CHANGELOG.md)