pusher-client-nc 0.2.1

data/lib/pusher-client/subscription.rb

@@ -0,0 +1,54 @@
+module PusherClient
+  class Subscription
+    attr_accessor :global, :subscribed
+    attr_reader :channel, :user_data, :callbacks, :global_callbacks
+
+    def initialize(channel_name, user_data)
+      @channel = channel_name
+      @user_data = user_data
+      @global = false
+      @callbacks = {}
+      @global_callbacks = {}
+      @subscribed = false
+    end
+
+    def bind(event_name, &callback)
+      @callbacks[event_name] = callbacks[event_name] || []
+      @callbacks[event_name] << callback
+      return self
+    end
+
+    def dispatch_with_all(event_name, data)
+      dispatch(event_name, data)
+      dispatch_global_callbacks(event_name, data)
+    end
+
+    def dispatch(event_name, data)
+      PusherClient.logger.debug "Dispatching callbacks for #{event_name}"
+      if @callbacks[event_name]
+        @callbacks[event_name].each do |callback|
+          callback.call(data)
+        end
+      else
+        PusherClient.logger.debug "No callbacks to dispatch for #{event_name}"
+      end
+    end
+
+    def dispatch_global_callbacks(event_name, data)
+      if @global_callbacks[event_name]
+        PusherClient.logger.debug "Dispatching global callbacks for #{event_name}"
+        @global_callbacks[event_name].each do |callback|
+          callback.call(data)
+        end
+      else
+        PusherClient.logger.debug "No global callbacks to dispatch for #{event_name}"
+      end
+    end
+
+    def acknowledge_subscription(data)
+      @subscribed = true
+    end
+
+  end
+
+end

data/lib/pusher-client/subscriptions.rb

@@ -0,0 +1,46 @@
+module PusherClient
+  class Subscriptions
+    attr_reader :subscriptions
+
+    def initialize
+      @subscriptions = []
+    end
+
+    def add(channel_name, user_data)
+      unless find(channel_name, user_data)
+        @subscriptions << Subscription.new(channel_name, user_data)
+      end
+      find(channel_name, user_data)
+    end
+
+    def find_all(channel_name)
+      @subscriptions.select {|s| s.channel == channel_name }
+    end
+
+    def find_for_bind(channel_name)
+      @subscriptions.detect {|s| s.channel == channel_name }
+    end
+
+    def find(channel_name, user_data)
+      @subscriptions.detect { |s| s.channel == channel_name && s.user_data == user_data }
+    end
+
+    def remove(channel_name, user_data)
+      subscription = find(channel_name, user_data)
+      @subscriptions.delete(subscription)
+      @subscriptions
+    end
+
+    def empty?
+      @subscriptions.empty?
+    end
+
+    def size
+      @subscriptions.size
+    end
+
+    alias :<< :add
+    alias :[] :find_for_bind
+
+  end
+end

data/lib/pusher-client/websocket.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'socket'
+require 'libwebsocket'
+
+module PusherClient
+  class WebSocket
+
+    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)
+
+      @socket.write(@hs.to_s)
+      @socket.flush
+
+      loop do
+        data = @socket.getc
+        next if data.nil?
+
+        result = @hs.parse(data.chr)
+
+        raise @hs.error unless result
+
+        if @hs.done?
+          @handshaked = true
+          break
+        end
+      end
+    end
+
+    def send(data)
+      raise "no handshake!" unless @handshaked
+
+      data = @frame.new(data).to_s
+      @socket.write data
+      @socket.flush
+    end
+
+    def receive
+      raise "no handshake!" unless @handshaked
+
+      data = @socket.gets("\xff")
+      @frame.append(data)
+
+      messages = []
+      while message = @frame.next
+        messages << message
+      end
+      messages
+    end
+
+    def socket
+      @socket
+    end
+
+    def close
+      @socket.close
+    end
+
+  end
+end

data/pusher-client-nc.gemspec

@@ -0,0 +1,85 @@
+# 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-nc}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Logan Koester, Neil Cauldwell"]
+  s.date = %q{2012-05-28}
+  s.description = %q{Ruby client for consuming WebSockets from http://pusherapp.com}
+  s.email = %q{support@nur.ph}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/subscribe.rb",
+    "examples/subscribe_async.rb",
+    "lib/pusher-client.rb",
+    "lib/pusher-client/channel.rb",
+    "lib/pusher-client/channels.rb",
+    "lib/pusher-client/socket.rb",
+    "lib/pusher-client/subscription.rb",
+    "lib/pusher-client/subscriptions.rb",
+    "lib/pusher-client/websocket.rb",
+    "pusher-client-nc.gemspec",
+    "pusher-client.gemspec",
+    "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 = [
+    "examples/subscribe.rb",
+    "examples/subscribe_async.rb",
+    "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<libwebsocket>, ["~> 0.1.3"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<ruby-hmac>, [">= 0"])
+      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<libwebsocket>, ["~> 0.1.3"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<ruby-hmac>, [">= 0"])
+      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<libwebsocket>, ["~> 0.1.3"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<ruby-hmac>, [">= 0"])
+    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/pusher-client.gemspec

@@ -0,0 +1,84 @@
+# 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.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Logan Koester"]
+  s.date = %q{2012-05-28}
+  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 = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/subscribe.rb",
+    "examples/subscribe_async.rb",
+    "lib/pusher-client.rb",
+    "lib/pusher-client/channel.rb",
+    "lib/pusher-client/channels.rb",
+    "lib/pusher-client/socket.rb",
+    "lib/pusher-client/subscription.rb",
+    "lib/pusher-client/subscriptions.rb",
+    "lib/pusher-client/websocket.rb",
+    "pusher-client.gemspec",
+    "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 = [
+    "examples/subscribe.rb",
+    "examples/subscribe_async.rb",
+    "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<libwebsocket>, ["~> 0.1.3"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<ruby-hmac>, [">= 0"])
+      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<libwebsocket>, ["~> 0.1.3"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<ruby-hmac>, [">= 0"])
+      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<libwebsocket>, ["~> 0.1.3"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<ruby-hmac>, [">= 0"])
+    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/pusherclient_test.rb

@@ -0,0 +1,246 @@
+require File.dirname(File.expand_path(__FILE__)) + '/teststrap.rb'
+require 'logger'
+
+describe "A PusherClient::Channels collection" do
+  before do
+    @channels = PusherClient::Channels.new
+  end
+
+  it "should initialize empty" do
+    @channels.empty?.should.equal(true)
+    @channels.size.should.equal 0
+  end
+
+  it "should instantiate new channels added to it by name" do
+    @channels << 'TestChannel'
+    @channels.find('TestChannel').class.should.equal(PusherClient::Channel)
+  end
+
+  it "should allow removal of channels by name" do
+    @channels << 'TestChannel'
+    @channels['TestChannel'].class.should.equal(PusherClient::Channel)
+    @channels.remove('TestChannel')
+    @channels.empty?.should.equal(true)
+  end
+
+  it "should not allow two channels of the same name" do
+    @channels << 'TestChannel'
+    @channels << 'TestChannel'
+    @channels.size.should.equal 1
+  end
+
+end
+
+describe "A PusherClient::Channel" do
+  before do
+    @channels = PusherClient::Channels.new
+    @channel = @channels << "TestChannel"
+  end
+
+  it 'should not be subscribed by default' do
+    @channel.subscribed.should.equal false
+  end
+
+  it 'should not be global by default' do
+    @channel.global.should.equal false
+  end
+
+  it 'can have procs bound to an event' do
+    @channel.bind('TestEvent') {}
+    @channel.callbacks.size.should.equal 1
+  end
+
+  it 'should run callbacks when an event is dispatched' do
+    @channel.bind('TestEvent') do
+      PusherClient.logger.test "Local callback running"
+    end
+
+    @channel.dispatch('TestEvent', {})
+    PusherClient.logger.test_messages.should.include?("Local callback running")
+  end
+end
+
+describe "A PusherClient::Subscriptions collection" do
+  before do
+    @subscriptions = PusherClient::Subscriptions.new
+  end
+
+  it "should initialize empty" do
+    @subscriptions.empty?.should.equal(true)
+    @subscriptions.size.should.equal 0
+  end
+
+  it "should instantiate new subscriptions added to it by channel and user_data" do
+    @subscriptions.add('TestChannel', 'user_id_1')
+    @subscription = @subscriptions.find('TestChannel', 'user_id_1')
+    @subscription.class.should.equal(PusherClient::Subscription)
+  end
+
+  it "should be able to find all subscriptions with a channel_name" do
+    @subscriptions.add('TestChannel', 'user_id_1')
+    @subscriptions.add('TestChannel', 'user_id_2')
+    @subs = @subscriptions.find_all('TestChannel')
+    @subs.size.should.equal 2
+    @subs.each { |s| s.channel.should.equal('TestChannel') }
+  end
+
+  it "should be able to find a unique subscription by channel_name and user_data" do
+    @subscriptions.add('TestChannel', 'user_id_1')
+    @subscription = @subscriptions.find('TestChannel', 'user_id_1')
+    @subscription.channel.should.equal('TestChannel')
+    @subscription.user_data.should.equal('user_id_1')
+  end
+
+  it "should allow removal of subscriptions by channel and user_data" do
+    @subscriptions.add('TestChannel', 'user_id_1')
+    @subscription = @subscriptions.find('TestChannel', 'user_id_1')
+    @subscription.class.should.equal(PusherClient::Subscription)
+    @subscriptions.remove('TestChannel', 'user_id_1')
+    @subscriptions.empty?.should.equal(true)
+  end
+
+  it "should not allow two subscriptions of the same channel and user" do
+    @subscriptions.add('TestChannel', 'user_id_1')
+    @subscriptions.add('TestChannel', 'user_id_1')
+    @subscriptions.add('TestChannel', 'user_id_2')
+    @subscriptions.size.should.equal 2
+  end
+end
+
+describe "A PusherClient::Subscription" do
+  before do
+    @subscriptions = PusherClient::Subscriptions.new
+    @subscription = @subscriptions.add("TestChannel", "user_id_1")
+  end
+
+  it 'should have a channel and a channel_name' do
+    @subscription.channel.should.equal "TestChannel"
+  end
+
+  it 'should have user_data' do
+    @subscription.user_data.should.equal "user_id_1"
+  end
+
+  it 'should not be subscribed by default' do
+    @subscription.subscribed.should.equal false
+  end
+
+  it 'should not be global by default' do
+    @subscription.global.should.equal false
+  end
+
+  it 'can have procs bound to an event' do
+    @subscription.bind('TestEvent') {}
+    @subscription.callbacks.size.should.equal 1
+  end
+
+  it 'should run callbacks when an event is dispatched' do
+    @subscription.bind('TestEvent') do
+      PusherClient.logger.test "Local callback running"
+    end
+
+    @subscription.dispatch('TestEvent', {})
+    PusherClient.logger.test_messages.should.include?("Local callback running")
+  end
+end
+
+describe "A PusherClient::Socket" do
+  before do
+    @socket = PusherClient::Socket.new(TEST_APP_KEY)
+  end
+
+  it 'should not connect when instantiated' do
+    @socket.connected.should.equal false
+  end
+
+  it 'should raise ArgumentError if TEST_APP_KEY is not a nonempty string' do
+    lambda {
+      @broken_socket = PusherClient::Socket.new('')
+    }.should.raise(ArgumentError)
+    lambda {
+      @broken_socket = PusherClient::Socket.new(555)
+    }.should.raise(ArgumentError)
+  end
+
+  describe "...when connected" do
+    before do
+      @socket.connect
+    end
+
+    it 'should know its connected' do
+      @socket.connected.should.equal true
+    end
+
+    it 'should know its socket_id' do
+      @socket.socket_id.should.equal '123abc'
+    end
+
+    it 'should not be subscribed to its global channel' do
+      @socket.global_channel.subscribed.should.equal false
+    end
+
+    it 'should create a subscription to a Public channel' do
+      @socket.subscriptions.size.should.equal 0
+      @subscription = @socket.subscribe('TestChannel')
+      @socket.subscriptions.size.should.equal 1
+      @subscription.subscribed.should.equal true
+    end
+
+    it 'should create a subscription to a Presence channel' do
+      @socket.subscriptions.size.should.equal 0
+      @subscription = @socket.subscribe('presence-TestChannel', 'user_id_1')
+      @socket.subscriptions.size.should.equal 1
+      @subscription.subscribed.should.equal true
+    end
+
+    it 'should create a subscription to a Private channel' do
+      @socket.subscriptions.size.should.equal 0
+      @subscription = @socket.subscribe('private-TestChannel', 'user_id_1')
+      @socket.subscriptions.size.should.equal 1
+      @subscription.subscribed.should.equal true
+    end
+
+    it 'should trigger callbacks for global events' do
+      @socket.bind('globalevent') { |data| PusherClient.logger.test("Global event!") }
+      @socket.global_channel.callbacks.has_key?('globalevent').should.equal true
+
+      @socket.simulate_received('globalevent', 'some data', '')
+      PusherClient.logger.test_messages.last.should.include?('Global event!')
+    end
+
+    it 'should kill the connection thread when disconnect is called' do
+      @socket.disconnect
+      Thread.list.size.should.equal 1
+    end
+
+    it 'should not be connected after disconnecting' do
+      @socket.disconnect
+      @socket.connected.should.equal false
+    end
+
+    describe "...when subscribed to a subscription" do
+      before do
+        @subscription = @socket.subscribe('TestChannel')
+      end
+
+      it 'should allow binding of callbacks for the subscribed subscription' do
+        @socket['TestChannel'].bind('TestEvent') { |data| PusherClient.logger.test(data) }
+        @socket['TestChannel'].callbacks.has_key?('TestEvent').should.equal true
+      end
+
+     it "should trigger channel callbacks when a message is received" do
+       # Bind 2 events for the channel
+       @socket['TestChannel'].bind('coming') { |data| PusherClient.logger.test(data) }
+       @socket['TestChannel'].bind('going')  { |data| PusherClient.logger.test(data) }
+
+       # Simulate the first event
+       @socket.simulate_received('coming', 'Hello!', 'TestChannel')
+       PusherClient.logger.test_messages.last.should.include?('Hello!')
+
+       # Simulate the second event
+       @socket.simulate_received('going', 'Goodbye!', 'TestChannel')
+       PusherClient.logger.test_messages.last.should.include?('Goodbye!')
+     end
+    end
+  end
+end