pusher-client 0.2.2 → 0.3.0

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_pusher_playground.rb
+Gemfile.lock

data/Gemfile

@@ -1,2 +1,7 @@
-source :rubygems
+source 'https://www.rubygems.org'
+
 gemspec
+
+gem 'json',             :platform => :ruby_18
+gem 'openssl-nonblock', :platform => :ruby_18
+gem 'ruby-debug19',     :platform => :ruby_19

data/README.rdoc

@@ -11,6 +11,11 @@ may be sent on. You can't just bind a global event without subscribing to any ch
 
 == Installation
   gem install pusher-client
+  
+If you're using Ruby 1.8.7, then you'll also need the openssl-nonblock gem:
+
+  gem install openssl-nonblock
+
 == Single-Threaded Usage
 The application will pause at socket.connect and handle events from Pusher as they happen.
 
@@ -71,6 +76,14 @@ and you can continue to subscribe/unsubscribe to channels and bind new events.
 For further documentation, read the source & test suite. Some features of the JavaScript client
 are not yet implemented.
 
+== Native extension
+Pusher depends on the websocket[https://github.com/imanel/websocket-ruby] gem
+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[https://github.com/imanel/websocket-ruby-native]
+gem in your Gemfile.
+
 == Contributing to pusher-client
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/examples/hello_pusher_ssl.rb

@@ -0,0 +1,20 @@
+# Usage: $ PUSHER_KEY=YOURKEY ruby examples/hello_pusher.rb
+
+require 'rubygems'
+require './lib/pusher-client.rb'
+require 'pp'
+
+APP_KEY = ENV['PUSHER_KEY'] # || "YOUR_APPLICATION_KEY"
+
+PusherClient.logger = Logger.new(STDOUT)
+socket = PusherClient::Socket.new(APP_KEY, { :encrypted => true } )
+
+# 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/subscribe_private.rb

@@ -0,0 +1,21 @@
+# Usage: $ PUSHER_KEY=YOURKEY ruby examples/hello_pusher.rb
+
+require 'rubygems'
+require './lib/pusher-client.rb'
+require 'pp'
+
+APP_KEY = ENV['PUSHER_KEY'] # || "YOUR_APPLICATION_KEY"
+APP_SECRET = ENV['PUSHER_SECRET'] # || "YOUR_APPLICATION_SECRET"
+
+PusherClient.logger = Logger.new(STDOUT)
+socket = PusherClient::Socket.new(APP_KEY, { :encrypted => true, :secret => APP_SECRET } )
+
+# Subscribe to a channel
+socket.subscribe('private-hellopusher')
+
+# Bind to a channel event
+socket['hellopusher'].bind('hello') do |data|
+  pp data
+end
+
+socket.connect

data/lib/pusher-client/socket.rb

@@ -5,9 +5,8 @@ require 'digest/md5'
 module PusherClient
   class Socket
 
-    # Mimick the JavaScript client
     CLIENT_ID = 'pusher-ruby-client'
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
     PROTOCOL = '5'
 
     attr_accessor :encrypted, :secure
@@ -41,6 +40,12 @@ module PusherClient
       bind('pusher:error') do |data|
         PusherClient.logger.fatal("Pusher : error : #{data.inspect}")
       end
+
+      # Keep this in case we're using a websocket protocol that doesn't
+      # implement ping/pong
+      bind('pusher:ping') do
+        send_event('pusher:pong', nil)
+      end
     end
 
     def connect(async = false)
@@ -52,23 +57,23 @@ module PusherClient
       PusherClient.logger.debug("Pusher : connecting : #{url}")
 
       @connection_thread = Thread.new {
-        options = {:ssl => @encrypted || @secure}
-        @connection = WebSocket.new(url, options)
+        options     = {:ssl => @encrypted || @secure}
+        @connection = PusherWebSocket.new(url, options)
         PusherClient.logger.debug "Websocket connected"
+
         loop do
-          msg = @connection.receive[0]
-          params  = parser(msg)
-          next if (params['socket_id'] && params['socket_id'] == self.socket_id)
-          event_name   = params['event']
-          event_data   = params['data']
-          channel_name = params['channel']
-          send_local_event(event_name, event_data, channel_name)
+          msg    = @connection.receive[0]
+          next if msg.nil?
+          params = parser(msg)
+          next if params['socket_id'] && params['socket_id'] == self.socket_id
+
+          send_local_event params['event'], params['data'], params['channel']
         end
       }
 
       @connection_thread.run
       @connection_thread.join unless async
-      return self
+      self
     end
 
     def disconnect

data/lib/pusher-client/websocket.rb

@@ -1,19 +1,22 @@
 require 'rubygems'
 require 'socket'
-require 'libwebsocket'
+require 'websocket'
 require 'openssl'
+require 'openssl/nonblock' if RUBY_VERSION == '1.8.7'
 
 module PusherClient
-  class WebSocket
+  class PusherWebSocket
+    WAIT_EXCEPTIONS  = [Errno::EAGAIN, Errno::EWOULDBLOCK]
+    WAIT_EXCEPTIONS << IO::WaitReadable if defined?(IO::WaitReadable)
+    
+    attr_accessor :socket
 
     def initialize(url, params = {})
-      @hs ||= LibWebSocket::OpeningHandshake::Client.new(:url => url, :version => params[:version])
-      @frame ||= LibWebSocket::Frame.new
-
-      @socket = TCPSocket.new(@hs.url.host, @hs.url.port || 80)
+      @hs ||= WebSocket::Handshake::Client.new(:url => url, :version => params[:version])
+      @frame ||= WebSocket::Frame::Incoming::Server.new(:version => @hs.version)
+      @socket = TCPSocket.new(@hs.host, @hs.port || 80)
 
       if params[:ssl] == true
-
         ctx = OpenSSL::SSL::SSLContext.new
         ctx.verify_mode = OpenSSL::SSL::VERIFY_PEER|OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
         # http://curl.haxx.se/ca/cacert.pem
@@ -24,7 +27,6 @@ module PusherClient
         ssl_sock.connect
 
         @socket = ssl_sock
-
       end
 
       @socket.write(@hs.to_s)
@@ -34,11 +36,10 @@ module PusherClient
         data = @socket.getc
         next if data.nil?
 
-        result = @hs.parse(data.chr)
+        @hs << data
 
-        raise @hs.error unless result
-
-        if @hs.done?
+        if @hs.finished?
+          raise Exception unless @hs.valid?
           @handshaked = true
           break
         end
@@ -49,10 +50,10 @@ module PusherClient
       File.join(File.dirname(File.expand_path(__FILE__)), '../../certs/cacert.pem')
     end
 
-    def send(data)
+    def send(data, type = :text)
       raise "no handshake!" unless @handshaked
 
-      data = @frame.new(data).to_s
+      data = WebSocket::Frame::Outgoing::Server.new(:version => @hs.version, :data => data, :type => type).to_s
       @socket.write data
       @socket.flush
     end
@@ -60,25 +61,32 @@ module PusherClient
     def receive
       raise "no handshake!" unless @handshaked
 
-      data = @socket.gets("\xff")
-      @frame.append(data)
+      begin
+        data = @socket.read_nonblock(1024)
+      rescue *WAIT_EXCEPTIONS
+        IO.select([@socket])
+        retry
+      end
+      @frame << data
 
       messages = []
       while message = @frame.next
-        messages << message
+        if message.type === :ping
+          send(message.data, :pong)
+          return messages
+        end
+        messages << message.to_s
       end
       messages
-    end
-
-    def socket
-      @socket
+    rescue IOError, Errno::EBADF => error
+      PusherClient.logger.debug error.message
+      []
     end
 
     def close
       @socket.close
+    rescue IOError => error
+      PusherClient.logger.debug error.message
     end
-
   end
 end
-
-

data/pusher-client.gemspec

@@ -1,56 +1,25 @@
 # -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
-  s.name = %q{pusher-client}
-  s.version = "0.2.2"
+  s.name             = 'pusher-client'
+  s.version          = "0.3.0"
+  s.authors          = ["Logan Koester", "Phil Leggetter"]
+  s.email            = ['support@pusher.com']
+  s.homepage         = 'http://github.com/pusher/pusher-ruby-client'
+  s.summary          = 'Client for consuming WebSockets from http://pusher.com'
+  s.description      = 'Client for consuming WebSockets from http://pusher.com'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Logan Koester", "Phil Leggetter"]
-  s.date = %q{2011-01-07}
-  s.description = %q{Ruby client for consuming WebSockets from http://pusher.com}
-  s.email = %q{support@pusher.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "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",
-    "lib/pusher-client/websocket.rb",
-    "certs/cacert.pem",
-    "pusher-client.gemspec",
-    "test/pusherclient_test.rb",
-    "test/test.watchr",
-    "test/teststrap.rb"
-  ]
-  s.homepage = %q{http://github.com/pusher/pusher-ruby-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://pusher.com}
-  s.test_files = [
-    "examples/hello_pusher.rb",
-    "examples/hello_pusher_async.rb",
-    "test/pusherclient_test.rb",
-    "test/teststrap.rb"
-  ]
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f|
+    File.basename(f)
+  }
+  s.extra_rdoc_files = %w(LICENSE.txt README.rdoc)
+  s.require_paths    = ['lib']
+  s.licenses         = ['MIT']
 
-  s.add_runtime_dependency(%q<libwebsocket>, ["0.1.5"])
-  s.add_runtime_dependency(%q<ruby-hmac>, ["~> 0.4.0"])
-  s.add_runtime_dependency(%q<addressable>, ["~> 2.3.1"])
-  s.add_development_dependency(%q<bacon>, [">= 0"])
-  s.add_development_dependency(%q<rake>, [">= 0"])
-  s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+  s.add_runtime_dependency 'websocket', '~> 1.0.0'
+  s.add_runtime_dependency 'ruby-hmac', '~> 0.4.0'
 
+  s.add_development_dependency 'bacon', '>= 0'
+  s.add_development_dependency 'rake',  '>= 0'
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pusher-client
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,59 +10,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-01-07 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: libwebsocket
-  requirement: !ruby/object:Gem::Requirement
+  name: websocket
+  requirement: &70212587581360 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.5
+  version_requirements: *70212587581360
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &70212587580880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.3.1
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.3.1
+  version_requirements: *70212587580880
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70212587580420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -70,31 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70212587580420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70212587579960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -102,14 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Ruby client for consuming WebSockets from http://pusher.com
-email: support@pusher.com
+  version_requirements: *70212587579960
+description: Client for consuming WebSockets from http://pusher.com
+email:
+- support@pusher.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -117,19 +66,21 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- certs/cacert.pem
 - examples/hello_pusher.rb
 - examples/hello_pusher_async.rb
+- examples/hello_pusher_ssl.rb
+- examples/subscribe_private.rb
 - lib/pusher-client.rb
 - lib/pusher-client/channel.rb
 - lib/pusher-client/channels.rb
 - lib/pusher-client/socket.rb
 - lib/pusher-client/websocket.rb
-- certs/cacert.pem
 - pusher-client.gemspec
 - test/pusherclient_test.rb
 - test/test.watchr
@@ -155,12 +106,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Ruby client for consuming WebSockets from http://pusher.com
+summary: Client for consuming WebSockets from http://pusher.com
 test_files:
-- examples/hello_pusher.rb
-- examples/hello_pusher_async.rb
 - test/pusherclient_test.rb
+- test/test.watchr
 - test/teststrap.rb

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pusher-client (0.2.2)
-      addressable (~> 2.3.1)
-      libwebsocket (= 0.1.5)
-      ruby-hmac (~> 0.4.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.3.2)
-    archive-tar-minitar (0.5.2)
-    bacon (1.2.0)
-    columnize (0.3.6)
-    libwebsocket (0.1.5)
-      addressable
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
-    rake (10.0.3)
-    ruby-debug-base19 (0.11.25)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby-hmac (0.4.0)
-    ruby_core_source (0.1.5)
-      archive-tar-minitar (>= 0.5.2)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  bacon
-  pusher-client!
-  rake
-  ruby-debug19