pusher_listener 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c714600d331ba7746deb0734dd42bf0dfc8e8e80
+  data.tar.gz: 10ea54bf869c8aba8af9ca6ee1b426241231a3bc
+SHA512:
+  metadata.gz: d5282a469c315008b4b7ddebe2dfd2e3cfcafbf22001bd965ae114f5e5d92a5b48ab6cd865c1be5e6e99ee391b1ab8b341f83355cb157133699abdb3fe19a9c7
+  data.tar.gz: 3b702a69c644e58bb38daa595cd27d599569b845c063beda4b8ee18703dc4fa84ade0761896653c9d2836a48ffbc2227b854f7e91bf9a73d411f35d0f32231e0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pusher_listener.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ramon Tayag
+
+MIT License
+
+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,41 @@
+# PusherListener
+
+Wrapper around PusherClient that reconnects when there is an error
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pusher_listener'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pusher_listener
+
+## Usage
+
+```ruby
+client = PusherListener::Client.new(
+  key: 'pusher_key',
+  secret: 'pusher_secret',
+  encrypted: true
+)
+
+client.when('some_channel', 'some_event') do |data|
+  puts "do something with #{data}"
+end
+
+client.start # loops forever since this is meant to be run in a daemon
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/pusher_listener.rb

@@ -0,0 +1,21 @@
+require "logger"
+require "pusher-client"
+require "pusher_listener/version"
+require "pusher_listener/client"
+require "pusher_listener/handles_socket_error"
+require "pusher_listener/reconnects_socket"
+require "pusher_listener/disconnects_socket"
+
+module PusherListener
+
+  def self.logger= logger
+    @@logger = logger
+  end
+
+  def self.logger
+    return @@logger if defined? @@logger
+    $stdout.sync = true
+    @@logger = Logger.new($stdout)
+  end
+
+end

data/lib/pusher_listener/client.rb

@@ -0,0 +1,45 @@
+module PusherListener
+  class Client
+
+    extend Forwardable
+    def_delegator :PusherListener, :logger
+
+    def initialize(options)
+      @key = options.fetch(:key)
+      @secret = options.fetch(:secret)
+      @encrypted = options.fetch(:encrypted)
+    end
+
+    def when(channel_name, event_name, &block)
+      socket[channel_name].bind(event_name, &block)
+    end
+
+    def start(will_loop=true)
+      socket.bind('pusher:connection_established',
+                  &method(:log_connection_established))
+
+      socket.bind('pusher:error', &method(:handle_error))
+
+      socket.connect(true)
+
+      loop { sleep 1 } if will_loop
+    end
+
+    private
+
+    def log_connection_established(data)
+      logger.info "[#{Time.now}] - *** Waiting for events ***"
+    end
+
+    def handle_error(data)
+      HandlesSocketError.for(socket, data)
+    end
+
+    def socket
+      @socket ||= PusherClient::Socket.new(@key,
+                                           secret: @secret,
+                                           encrypted: @encrypted)
+    end
+
+  end
+end

data/lib/pusher_listener/disconnects_socket.rb

@@ -0,0 +1,10 @@
+module PusherListener
+  class DisconnectsSocket
+
+    def self.execute(socket)
+      socket.disconnect if socket.connected
+    end
+
+  end
+end
+

data/lib/pusher_listener/handles_socket_error.rb

@@ -0,0 +1,17 @@
+module PusherListener
+  class HandlesSocketError
+
+    def self.execute(socket, data)
+      message = data.fetch("message")
+      code = data.fetch("code")
+
+      case code
+      when 4100; ReconnectsSocket.execute(socket, 1)
+      when 4200, 4201, 4202; ReconnectsSocket.execute(socket)
+      else
+        raise ArgumentError, "Pusher error: #{message} (code: #{code})"
+      end
+    end
+
+  end
+end

data/lib/pusher_listener/reconnects_socket.rb

@@ -0,0 +1,12 @@
+module PusherListener
+  class ReconnectsSocket
+
+    def self.execute(socket, delay=nil)
+      DisconnectsSocket.execute(socket)
+      sleep delay if delay && delay > 0
+      socket.connect
+    end
+
+  end
+end
+

data/lib/pusher_listener/version.rb

@@ -0,0 +1,3 @@
+module PusherListener
+  VERSION = "0.0.1"
+end

data/pusher_listener.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pusher_listener/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pusher_listener"
+  spec.version       = PusherListener::VERSION
+  spec.authors       = ["Ramon Tayag", "Marc Ignacio"]
+  spec.email         = ["ramon@aelogica.com", "marc@aelogica.com"]
+  spec.description   = %q{Wrapper around PusherClient that reconnects when there is an error}
+  spec.summary       = %q{Wrapper around PusherClient that reconnects when there is an error}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pusher-client", "~> 0.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1.1"
+  spec.add_development_dependency "rspec", "~> 2.14.0"
+  spec.add_development_dependency "pry", "~> 0.9.12.4"
+end

data/spec/lib/pusher_listener/client_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+module PusherListener
+  describe Client do
+    let(:client) do
+      described_class.new(key: 'app_key',
+                          secret: 'secret',
+                          encrypted: false)
+    end
+
+    let(:logger) do
+      logger = Logger.new(STDOUT)
+      logger.level = 5
+      logger
+    end
+
+    before do
+      @socket = PusherClient::Socket.new('app_key',
+                                         secret: 'secret',
+                                         encrypted: false)
+      PusherClient.logger = logger
+    end
+
+    describe "#when" do
+      let(:block) { proc {|data| @block_called = true } }
+
+      before do
+        @block_called = false
+        PusherClient::Socket.stub(:new).
+          with('app_key', secret: 'secret', encrypted: false).
+          and_return(@socket)
+      end
+
+      it "creates a channel" do
+        client.when('channel_name', 'event_name', &block)
+        @socket.send(:send_local_event, 'event_name', 'data', 'channel_name')
+        expect(@block_called).to be_true
+      end
+    end
+
+    describe "#start" do
+      before do
+        PusherClient::Socket.stub(:new).
+          with('app_key', secret: 'secret', encrypted: false).
+          and_return(@socket)
+      end
+
+      it "handles connection issues and starts a socket connection" do
+        @socket.should_receive(:connect).with(true)
+
+        client.start(false)
+
+        HandlesSocketError.should_receive(:for).with(@socket, 'data')
+        @socket.send(:send_local_event, 'pusher:error', 'data', '')
+      end
+    end
+
+    describe "#logger" do
+      it "should be delegated to PusherListener module" do
+        PusherListener.should_receive(:logger)
+        client.logger
+      end
+    end
+
+  end
+end
+

data/spec/lib/pusher_listener/disconnects_socket_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+module PusherListener
+  describe DisconnectsSocket, ".execute" do
+
+    let(:socket) { double(connected: connected) }
+
+    context "socket is connected" do
+      let(:connected) { true }
+      it "disconnects the socket" do
+        socket.should_receive(:disconnect)
+        described_class.execute(socket)
+      end
+    end
+
+    context "socket is not connected" do
+      let(:connected) { false }
+      it "does not disconnect the socket" do
+        socket.should_not_receive(:disconnect)
+        described_class.execute(socket)
+      end
+    end
+
+  end
+end

data/spec/lib/pusher_listener/handles_socket_error_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+module PusherListener
+  describe HandlesSocketError, ".execute" do
+
+    let(:socket) { double }
+    let(:data) { {"code" => code, "message" => "Error message"} }
+
+    context "code is 4100" do
+      let(:code) { 4100 }
+      it "reconnects with a 1 second delay" do
+        ReconnectsSocket.should_receive(:execute).with(socket, 1)
+        described_class.execute(socket, data)
+      end
+    end
+
+    context "code is 4200" do
+      let(:code) { 4200 }
+      it "reconnects immediately" do
+        ReconnectsSocket.should_receive(:execute).with(socket)
+        described_class.execute(socket, data)
+      end
+    end
+
+    context "code is 4201" do
+      let(:code) { 4201 }
+      it "reconnects immediately" do
+        ReconnectsSocket.should_receive(:execute).with(socket)
+        described_class.execute(socket, data)
+      end
+    end
+
+    context "code is 4202" do
+      let(:code) { 4202 }
+      it "reconnects immediately" do
+        ReconnectsSocket.should_receive(:execute).with(socket)
+        described_class.execute(socket, data)
+      end
+    end
+
+    context "code is none of the above" do
+      let(:code) { 999 }
+      it "raises an error" do
+        expect { described_class.execute(socket, data) }.to raise_error
+      end
+    end
+
+  end
+end

data/spec/lib/pusher_listener/reconnects_socket_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+module PusherListener
+  describe ReconnectsSocket, ".execute" do
+
+    let(:socket) { double }
+
+    describe "delay is not set" do
+      it "disconnects then connects immediately" do
+        DisconnectsSocket.should_receive(:execute).with(socket).ordered
+        described_class.should_not_receive(:sleep)
+        socket.should_receive(:connect).ordered
+        described_class.execute(socket)
+      end
+    end
+
+    describe "delay is nil" do
+      it "disconnects then connects immediately" do
+        DisconnectsSocket.should_receive(:execute).with(socket).ordered
+        described_class.should_not_receive(:sleep)
+        socket.should_receive(:connect).ordered
+        described_class.execute(socket, nil)
+      end
+    end
+
+    describe "delay is 0" do
+      it "disconnects then connects immediately" do
+        DisconnectsSocket.should_receive(:execute).with(socket).ordered
+        described_class.should_not_receive(:sleep)
+        socket.should_receive(:connect).ordered
+        described_class.execute(socket, 0)
+      end
+    end
+
+    describe "delay is 3" do
+      it "disconnects, sleeps, and connects" do
+        DisconnectsSocket.should_receive(:execute).with(socket).ordered
+        described_class.should_receive(:sleep).with(3).ordered
+        socket.should_receive(:connect).ordered
+        described_class.execute(socket, 3)
+      end
+    end
+
+  end
+end

data/spec/lib/pusher_listener_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe PusherListener, ".logger" do
+  it "sets the logger to stdout by default" do
+    logger = double
+    Logger.stub(:new).with($stdout) { logger }
+    expect(PusherListener.logger).to eq(logger)
+  end
+
+  it "can set into a custom logger" do
+    custom_logger = double
+    PusherListener.logger = custom_logger
+    expect(PusherListener.logger).to eq(custom_logger)
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "pusher_listener"

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: pusher_listener
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ramon Tayag
+- Marc Ignacio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pusher-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.4
+description: Wrapper around PusherClient that reconnects when there is an error
+email:
+- ramon@aelogica.com
+- marc@aelogica.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pusher_listener.rb
+- lib/pusher_listener/client.rb
+- lib/pusher_listener/disconnects_socket.rb
+- lib/pusher_listener/handles_socket_error.rb
+- lib/pusher_listener/reconnects_socket.rb
+- lib/pusher_listener/version.rb
+- pusher_listener.gemspec
+- spec/lib/pusher_listener/client_spec.rb
+- spec/lib/pusher_listener/disconnects_socket_spec.rb
+- spec/lib/pusher_listener/handles_socket_error_spec.rb
+- spec/lib/pusher_listener/reconnects_socket_spec.rb
+- spec/lib/pusher_listener_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Wrapper around PusherClient that reconnects when there is an error
+test_files:
+- spec/lib/pusher_listener/client_spec.rb
+- spec/lib/pusher_listener/disconnects_socket_spec.rb
+- spec/lib/pusher_listener/handles_socket_error_spec.rb
+- spec/lib/pusher_listener/reconnects_socket_spec.rb
+- spec/lib/pusher_listener_spec.rb
+- spec/spec_helper.rb