janus_gateway 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1c223b56a2536ca40478bedafffd54a112a5241
-  data.tar.gz: 237bfe5ea272325d3adf04154546d89ec7b82c64
+  metadata.gz: 6ea317eec80f95f86608e0dfbefd20daf539ca93
+  data.tar.gz: 1f71d212cee640fba2e50565c7101e0f49d935fa
 SHA512:
-  metadata.gz: fdf055d236fd6f6729c2df0ea3d57b3d10c05e87a32ee56127dbf8398542ffd34af38d3b53afcef731aee8cf7096beb3be22c3b40e560c8e2c4ebf42c02839a6
-  data.tar.gz: 943df4c7904262727e92fab0a3d2ad38f3e4be7d202c20d8d049c8d86ac9ab918c18a1f90be898adc449c1ef725a72ca1bc6dd216c5652326cdd4c481c7449ab
+  metadata.gz: f02c94833d104e2fdc74b4d108e7b34883865d222df26d46810ba255f994f7272f6dae43ec4234db2d3d5d6f11db825ca6ebc1540d577d7f02b0f256c4b8c6e9
+  data.tar.gz: 3d9245725745520b7e400e4e837ebbe4d81578c6679de4769231c9a3867dff17625745ad5f4e014409f75d24a8229c147646eea9a4b8c2e111ec51d9fd50b3c3

data/README.md

@@ -28,7 +28,20 @@ ws = JanusGateway::Transport::WebSocket.new('ws://localhost:8188/janus')
 client = JanusGateway::Client.new(ws)
 ```
 
-This client is used by all other classes connecting to api no matter if it's Resource or helper class like Agent.
+The client's `connect` method should be called in an [EventMachine](https://github.com/eventmachine/eventmachine) context, for events to be emitted etc.
+You can call the `run` method to start an EventMachine (which will block the execution of the program):
+```ruby
+ws = JanusGateway::Transport::WebSocket.new('ws://localhost:8188/janus')
+client = JanusGateway::Client.new(ws)
+
+client.on(:open) do
+  # We can start sending commands to the server now
+end
+
+client.run
+```
+
+Refer to the [Examples](#examples) section for a complete example of connecting to a server.
 
 ### Transports
 Client allows to use multiple, supported by Janus transportation layers. Currently the `WebSocket` transport is implemented and is the default.
@@ -132,6 +145,26 @@ Plugin resource supports `events` and `chaining` in the same way like `Janus` re
 ##### List
 Endpoint allows to retrieve the list of current audio rooms.
 
+Examples
+--------
+
+Connect to the server using the WebSocket transport and create a session:
+```ruby
+ws = JanusGateway::Transport::WebSocket.new('ws://localhost:8188/janus')
+client = JanusGateway::Client.new(ws)
+client.on(:open) { puts 'client connected' }
+client.on(:close) { puts 'client disconnected' }
+
+client.on(:open) do
+  session = JanusGateway::Resource::Session.new(client)
+  session.on(:create) { puts 'session created' }
+  session.on(:destroy) { puts 'session destroyed' }
+  session.create
+end
+
+client.run
+```
+
 Development
 -----------
 

data/lib/janus_gateway/transport/websocket.rb

@@ -64,6 +64,7 @@ module JanusGateway
 
     # @param [Hash] data
     def send(data)
+      raise 'WebSocket transport not connected' unless connected?
       client.send(JSON.generate(data))
     end
 

data/lib/janus_gateway/version.rb

@@ -1,3 +1,3 @@
 module JanusGateway
-  VERSION = '0.0.14'.freeze
+  VERSION = '0.0.15'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: janus_gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Cargo Media
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2016-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: janus-gateway client