pusher-client 0.1.0 → 0.1.1

data/README.rdoc

@@ -2,21 +2,44 @@
 
 pusher-client is a ruby gem for consuming WebSockets from the Pusher webservice[http://pusherapp.com]
 
-It is driven by event-machine and maintains a connection to Pusher in its own thread.
+It is driven by event-machine and maintains a connection to Pusher, optionally in its own thread.
 
 == Installation
   gem install pusher-client
-== Usage
+== Evented Usage
+The application will pause at socket.connect and handle events from Pusher as they happen.
 
-  # Configuration
   require 'pusher-client'
   PusherClient.logger = Logger.new(STDOUT)
   socket = PusherClient::Socket.new(YOUR_APPLICATION_KEY)
+
+  # Bind to a global event
+  socket.bind('globalevent') do |data|
+    puts data
+  end
+
+  # Subscribe to a channel
+  socket.subscribe('mychannel')
+
+  # Bind to a channel event
+  socket['mychannel'].bind('channelevent') do |data|
+    puts data
+  end
+
   socket.connect
 
+== Asynchronous Usage
+The socket 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.
+
+  require 'pusher-client'
+  PusherClient.logger = Logger.new(STDOUT)
+  socket = PusherClient::Socket.new(YOUR_APPLICATION_KEY)
+  socket.connect(true) # Connect asynchronously
+
   # Bind to a global event
   socket.bind('globalevent') do |data|
-    # Do something
+    puts data
   end
 
   # Subscribe to a channel
@@ -24,11 +47,12 @@ It is driven by event-machine and maintains a connection to Pusher in its own th
 
   # Bind to a channel event
   socket['mychannel'].bind('channelevent') do |data|
-    # Do something
+    puts data
   end
 
-  # Disconnect
-  socket.disconnect
+  loop do
+    sleep(1)
+  end
 
 For further documentation, read the source & test suite. Some features of the JavaScript client
 are not yet implemented.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/examples/hello_pusher.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'pusher-client'
+require 'pp'
+
+YOUR_APPLICATION_KEY = ''
+
+PusherClient.logger = Logger.new('/dev/null')
+socket = PusherClient::Socket.new(YOUR_APPLICATION_KEY)
+
+# Subscribe to a channel
+socket.subscribe('hellopusher')
+
+# Bind to a channel event
+socket['hellopusher'].bind('hello') do |data|
+  pp data
+end
+
+socket.connect

data/examples/hello_pusher_async.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'pusher-client'
+require 'pp'
+
+YOUR_APPLICATION_KEY = ''
+
+PusherClient.logger = Logger.new('/dev/null')
+socket = PusherClient::Socket.new(YOUR_APPLICATION_KEY)
+socket.connect(true)
+
+# Subscribe to a channel
+socket.subscribe('hellopusher')
+
+# Bind to a channel event
+socket['hellopusher'].bind('hello') do |data|
+  pp data
+end
+
+loop do
+  sleep 1
+end

data/lib/pusher-client/socket.rb

@@ -39,7 +39,7 @@ module PusherClient
       end
     end
 
-    def connect
+    def connect(async = false)
       @connection_thread = Thread.new do
         EventMachine.run {
           if @encrypted || @secure
@@ -77,12 +77,18 @@ module PusherClient
         }
       end
       @connection_thread.run
+      if async
+        sleep(1)
+      else
+        @connection_thread.join
+      end
+      return self
     end
 
     def disconnect
       if @connected
         PusherClient.logger.debug "Pusher : disconnecting"
-        @connection_thread.kill
+        @connection_thread.kill if @connection_thread
         @connected = false
       else
         PusherClient.logger.warn "Disconnect attempted... not connected"
@@ -93,7 +99,7 @@ module PusherClient
       channel = @channels << channel_name
       if @connected
         send_event('pusher:subscribe', {
-          'channel' => channel_name
+          'channel' => channel.name
         })
         channel.acknowledge_subscription(nil)
       end
@@ -124,7 +130,9 @@ module PusherClient
     end
 
     def subscribe_all
-      @channels.channels.each_with_index { |k,v| subscribe(k) }
+      @channels.channels.clone.each{ |k,v| 
+        subscribe(k)
+      }
     end
     
     # For compatibility with JavaScript client API

data/pusher-client.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pusher-client}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Logan Koester"]
+  s.date = %q{2010-12-29}
+  s.description = %q{Ruby client for consuming WebSockets from http://pusherapp.com}
+  s.email = %q{logan@logankoester.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".bundle/config",
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/pusher-client.rb",
+    "lib/pusher-client/channel.rb",
+    "lib/pusher-client/channels.rb",
+    "lib/pusher-client/socket.rb",
+    "test/pusherclient_test.rb",
+    "test/test.watchr",
+    "test/teststrap.rb"
+  ]
+  s.homepage = %q{http://github.com/logankoester/pusher-client}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby client for consuming WebSockets from http://pusherapp.com}
+  s.test_files = [
+    "test/pusherclient_test.rb",
+    "test/teststrap.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, ["~> 0.12.10"])
+      s.add_runtime_dependency(%q<em-http-request>, ["~> 0.2.15"])
+      s.add_development_dependency(%q<bacon>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, ["~> 0.12.10"])
+      s.add_dependency(%q<em-http-request>, ["~> 0.2.15"])
+      s.add_dependency(%q<bacon>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, ["~> 0.12.10"])
+    s.add_dependency(%q<em-http-request>, ["~> 0.2.15"])
+    s.add_dependency(%q<bacon>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/teststrap.rb

@@ -29,13 +29,15 @@ module PusherClient
 
   class Socket
     # Simulate a connection being established
-    def connect
+    def connect(async = false)
       @connection_thread = Thread.new do
         @connection = TestConnection.new
         @global_channel.dispatch('pusher:connection_established', {'socket_id' => '123abc'})
       end
       @connection_thread.run
+      @connection_thread.join unless async
       sleep(1)
+      return self
     end
 
     def simulate_received(event_name, event_data, channel_name)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Logan Koester
@@ -121,10 +121,15 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/hello_pusher.rb
+- examples/hello_pusher_async.rb
 - lib/pusher-client.rb
 - lib/pusher-client/channel.rb
 - lib/pusher-client/channels.rb
 - lib/pusher-client/socket.rb
+- pkg/pusher-client-0.1.0.gem
+- pkg/pusher-client-0.1.1.gem
+- pusher-client.gemspec
 - test/pusherclient_test.rb
 - test/test.watchr
 - test/teststrap.rb
@@ -142,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2534504559447735007
+      hash: -4529769101084018713
       segments: 
       - 0
       version: "0"
@@ -162,5 +167,7 @@ signing_key:
 specification_version: 3
 summary: Ruby client for consuming WebSockets from http://pusherapp.com
 test_files: 
+- examples/hello_pusher.rb
+- examples/hello_pusher_async.rb
 - test/pusherclient_test.rb
 - test/teststrap.rb