eventflit-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c629865a4ea4d81e365d7637ab79526d6f8c78ed
+  data.tar.gz: 4a834cd1604769efecbfc728ebb5f2a7d932f494
+SHA512:
+  metadata.gz: 2e0aa4cc3a4beb0e71315d000f4c52bd271a99aa0291ffd4695807da1eedc0b029db80097851382b2b45cc221d6fe2afead20f1819cb8486cf1a21fcf0c77cb3
+  data.tar.gz: 426e1e6d7f4f0f6a8755d78888245a8e6f793dc22c85dbc24cbe17570948aad3406c98d02c3597e499ed7d008365e1aef28bc9aa9eaab7f26e043f613b859ae7

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,15 @@
+*.log
+.DS_Store
+coverage
+*.swp
+*.swn
+*.swm
+*.swo
+mkmf.log
+test/rcov/*
+.project
+.bundle
+pkg/*
+run_example_playground
+examples/hello_eventflit_playground.rb
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+bundler_args: --without debug
+rvm:
+- 1.8.7
+- 1.9.2
+- 1.9.3
+- 2.0.0
+- 2.1.0
+- jruby-18mode
+- jruby-19mode

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://www.rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Logan Koester
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# eventflit-client: Ruby WebSocket client for Eventflit Channels
+
+`eventflit-client` is a Ruby gem for consuming WebSockets from Eventflit service.
+
+## Installation
+
+```sh
+gem install eventflit-client
+```
+
+This gem is compatible with jruby
+
+## Single-Threaded Usage
+
+The application will pause at `eventflit.connect` and handle events from Eventflit Channels as they happen.
+
+```ruby
+require 'eventflit-client'
+cluster = 'cus1'  # take this from your app's config in the dashboard
+eventflit = EventflitClient::Socket.new(YOUR_APPLICATION_KEY, {
+  secure: true,
+  ws_host: "ws-#{cluster}.eventflit.com"
+})
+
+# Subscribe to two channels
+eventflit.subscribe('channel1')
+eventflit.subscribe('channel2')
+
+# Subscribe to presence channel
+eventflit.subscribe('presence-channel3', USER_ID)
+
+# Subscribe to private channel
+eventflit.subscribe('private-channel4', USER_ID)
+
+# Subscribe to presence channel with custom data (user_id is mandatory)
+eventflit.subscribe('presence-channel5', :user_id => USER_ID, :user_name => 'john')
+
+# Bind to a global event (can occur on either channel1 or channel2)
+eventflit.bind('globalevent') do |data|
+  puts data
+end
+
+# Bind to a channel event (can only occur on channel1)
+eventflit['channel1'].bind('channelevent') do |data|
+  puts data
+end
+
+eventflit.connect
+```
+
+## Asynchronous Usage
+
+With `eventflit.connect(true)`,
+the connection to Eventflit Channels will be maintained in its own thread.
+The connection will remain open in the background as long as your main application thread is running,
+and you can continue to subscribe/unsubscribe to channels and bind new events.
+
+```ruby
+require 'eventflit-client'
+eventflit = EventflitClient::Socket.new(YOUR_APPLICATION_KEY)
+eventflit.connect(true) # Connect asynchronously
+
+# Subscribe to two channels
+eventflit.subscribe('channel1')
+eventflit.subscribe('channel2')
+
+# Bind to a global event (can occur on either channel1 or channel2)
+eventflit.bind('globalevent') do |data|
+  puts data
+end
+
+# Bind to a channel event (can only occur on channel1)
+eventflit['channel1'].bind('channelevent') do |data|
+  puts data
+end
+
+loop do
+  sleep(1) # Keep your main thread running
+end
+```
+
+## Using native WebSocket implementation
+
+This gem depends on [the `websocket` gem](https://github.com/imanel/websocket-ruby)
+which is a pure Ruby implementation of websockets.
+
+However it can optionally use a native C or Java implementation for a 25% speed
+increase by including [the `websocket-native` gem](https://github.com/imanel/websocket-ruby-native) in your Gemfile.
+
+## Copyright and license
+
+See `LICENSE.txt`.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec