pusher 0.8.0 → 0.8.1

data/.gitignore

@@ -18,6 +18,7 @@ coverage
 rdoc
 pkg
 .yardoc
+Gemfile.lock
 
 ## PROJECT::SPECIFIC
 .bundle

data/README.md

@@ -10,7 +10,7 @@ After registering at <http://pusherapp.com> configure your app with the security
     Pusher.key = 'your-pusher-key'
     Pusher.secret = 'your-pusher-secret'
 
-Trigger an event
+Trigger an event with {Pusher::Channel#trigger!}
 
     Pusher['a_channel'].trigger!('an_event', {:some => 'data'})
 
@@ -26,7 +26,7 @@ Optionally a socket id may be provided. This will exclude the event from being t
 
     Pusher['a_channel'].trigger!('an_event', {:some => 'data'}, socket_id)
 
-If you don't need to handle failure cases, then you can simply use the `trigger` method, which will rescue and log any errors for you
+If you don't need to handle failure cases, then you can simply use the {Pusher::Channel#trigger} method, which will rescue and log any errors for you
 
     Pusher['a_channel'].trigger('an_event', {:some => 'data'})
 
@@ -40,7 +40,7 @@ Errors are logged to `Pusher.logger`. It will by default use `Logger` from stdli
 Asynchronous triggering
 -----------------------
 
-To avoid blocking in a typical web application, you may wish to use the `trigger_async` method which uses the makes asynchronous API requests to Pusher. `trigger_async` returns a deferrable which you can optionally bind to with success and failure callbacks.
+To avoid blocking in a typical web application, you may wish to use the {Pusher::Channel#trigger_async} method which makes asynchronous API requests. `trigger_async` returns a deferrable which you can optionally bind to with success and failure callbacks.
 
 You need to be running eventmachine to make use of this functionality. This is already the case if, for example, you're deploying to Heroku or using the Thin web server. You will also need to add `em-http-request` to your Gemfile.
 
@@ -64,7 +64,7 @@ The Pusher Gem also deals with signing requests for authenticated private channe
     reponse = Pusher['private-my_channel'].authenticate(params[:socket_id])
     render :json => response
     
-Read more about private channels in [the docs](http://pusherapp.com/docs/private_channels).
+Read more about private channels in [the docs](http://pusherapp.com/docs/private_channels) and under {Pusher::Channel#authenticate}.
 
 Developing
 ----------

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |s|
+  s.pattern = 'spec/**/*.rb'
+end
+
+task :default => :spec
+task :test => :spec

data/lib/pusher.rb

@@ -26,12 +26,12 @@ module Pusher
     # @private
     def logger
       @logger ||= begin
-        log = Logger.new(STDOUT)
+        log = Logger.new($stdout)
         log.level = Logger::INFO
         log
       end
     end
-    
+
     # @private
     def authentication_token
       Signature::Token.new(@key, @secret)
@@ -103,6 +103,5 @@ module Pusher
   end
 end
 
-require 'pusher/json'
 require 'pusher/channel'
-require 'pusher/request'
+require 'pusher/request'

data/lib/pusher/channel.rb

@@ -1,5 +1,6 @@
 require 'crack/core_extensions' # Used for Hash#to_params
 require 'hmac-sha2'
+require 'multi_json'
 
 module Pusher
   # Trigger events on Channels
@@ -69,8 +70,8 @@ module Pusher
     # @param socket_id Allows excluding a given socket_id from receiving the
     #   event - see http://pusherapp.com/docs/duplicates for more info
     #
-    # @raise [Pusher::Error] on invalid Pusher response
-    # @raise any Net::HTTP related errors
+    # @raise [Pusher::Error] on invalid Pusher response - see the error message for more details
+    # @raise [Pusher::HTTPError] on any error raised inside Net::HTTP - the original error is available in the original_error attribute
     #
     def trigger!(event_name, data, socket_id = nil)
       require 'net/http' unless defined?(Net::HTTP)
@@ -139,15 +140,27 @@ module Pusher
 
     # Generate an authentication endpoint response
     #
-    # @example
+    # @example Private channels
     #   render :json => Pusher['private-my_channel'].authenticate(params[:socket_id])
     #
+    # @example Presence channels
+    #   render :json => Pusher['private-my_channel'].authenticate(params[:socket_id], {
+    #     :user_id => current_user.id, # => required
+    #     :user_info => { # => optional - for example
+    #       :name => current_user.name,
+    #       :email => current_user.email
+    #     }
+    #   })
+    #
+    # @param socket_id [String]
+    # @param custom_data [Hash] used for example by private channels
+    #
     # @return [Hash]
     #
     # @private Custom data is sent to server as JSON-encoded string
     #
     def authenticate(socket_id, custom_data = nil)
-      custom_data = Pusher::JSON.generate(custom_data) if custom_data
+      custom_data = MultiJson.encode(custom_data) if custom_data
       auth = socket_auth(socket_id, custom_data)
       r = {:auth => auth}
       r[:channel_data] = custom_data if custom_data

data/lib/pusher/request.rb

@@ -1,5 +1,6 @@
 require 'signature'
 require 'digest/md5'
+require 'multi_json'
 
 module Pusher
   class Request
@@ -16,8 +17,8 @@ module Pusher
         data
       else
         begin
-          Pusher::JSON.generate(data)
-        rescue => e
+          MultiJson.encode(data)
+        rescue MultiJson::DecodeError => e
           Pusher.logger.error("Could not convert #{data.inspect} into JSON")
           raise e
         end

data/pusher.gemspec

@@ -3,19 +3,19 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "pusher"
-  s.version     = "0.8.0"
+  s.version     = "0.8.1"
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["New Bamboo"]
-  s.email       = ["support@pusherapp.com"]
+  s.authors     = ["Pusher"]
+  s.email       = ["support@pusher.com"]
   s.homepage    = "http://github.com/newbamboo/pusher-gem"
-  s.summary     = %q{Pusherapp client}
-  s.description = %q{Wrapper for pusherapp.com REST api}
-  
-  s.add_dependency "json", "~> 1.4.0"
-  s.add_dependency "crack", "~> 0.1.0"
+  s.summary     = %q{Pusher API client}
+  s.description = %q{Wrapper for pusher.com REST api}
+
+  s.add_dependency "multi_json", "~> 1.0"
+  s.add_dependency "crack",     "~> 0.1.0"
   s.add_dependency "ruby-hmac", "~> 0.4.0"
   s.add_dependency 'signature', "~> 0.1.2"
-  
+
   s.add_development_dependency "rspec", "~> 2.0"
   s.add_development_dependency "webmock"
   s.add_development_dependency "em-http-request", "~> 0.2.7"

data/spec/channel_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require 'spec_helper'
 
 describe Pusher::Channel do
   before do
@@ -20,7 +20,7 @@ describe Pusher::Channel do
     Pusher.key = nil
     Pusher.secret = nil
   end
-  
+
   describe 'trigger!' do
     before :each do
       WebMock.stub_request(:post, @pusher_url_regexp).
@@ -50,7 +50,7 @@ describe Pusher::Channel do
         query_hash["auth_key"].should == Pusher.key
         query_hash["auth_timestamp"].should_not be_nil
 
-        parsed = JSON.parse(req.body)
+        parsed = MultiJson.decode(req.body)
         parsed.should == {
           "name" => 'Pusher',
           "last_name" => 'App'
@@ -68,12 +68,6 @@ describe Pusher::Channel do
       end
     end
 
-    it "should raise error on non string values with cannot be jsonified" do
-      lambda {
-        @channel.trigger!('new_event', Object.new)
-      }.should raise_error(JSON::GeneratorError)
-    end
-
     it "should catch all Net::HTTP exceptions and raise a Pusher::HTTPError, exposing the original error if required" do
       WebMock.stub_request(
         :post, %r{/apps/20/channels/test_channel/events}
@@ -92,7 +86,7 @@ describe Pusher::Channel do
 
     it "should raise AuthenticationError if pusher returns 401" do
       WebMock.stub_request(
-        :post, 
+        :post,
         %r{/apps/20/channels/test_channel/events}
       ).to_return(:status => 401)
       lambda {
@@ -211,48 +205,48 @@ describe Pusher::Channel do
         }.should raise_error
       end
     end
-    
+
     describe 'with extra string argument' do
-      
+
       it 'should be a string or nil' do
         lambda {
           @channel.socket_auth('socketid', 'boom')
         }.should_not raise_error
-        
+
         lambda {
           @channel.socket_auth('socketid', 123)
         }.should raise_error
-        
+
         lambda {
           @channel.socket_auth('socketid', nil)
         }.should_not raise_error
-        
+
         lambda {
           @channel.socket_auth('socketid', {})
         }.should raise_error
       end
-      
+
       it "should return an authentication string given a socket id and custom args" do
         auth = @channel.socket_auth('socketid', 'foobar')
 
         auth.should == "12345678900000001:#{HMAC::SHA256.hexdigest(Pusher.secret, "socketid:test_channel:foobar")}"
       end
-      
+
     end
   end
-  
+
   describe '#authenticate' do
-    
+
     before :each do
       @channel = Pusher['test_channel']
       @custom_data = {:uid => 123, :info => {:name => 'Foo'}}
     end
-    
+
     it 'should return a hash with signature including custom data and data as json string' do
-      Pusher::JSON.stub!(:generate).with(@custom_data).and_return 'a json string'
-      
+      MultiJson.stub!(:encode).with(@custom_data).and_return 'a json string'
+
       response = @channel.authenticate('socketid', @custom_data)
-      
+
       response.should == {
         :auth => "12345678900000001:#{HMAC::SHA256.hexdigest(Pusher.secret, "socketid:test_channel:a json string")}",
         :channel_data => 'a json string'

data/spec/pusher_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require 'spec_helper'
 
 require 'em-http'
 

data/spec/spec_helper.rb

@@ -1,16 +1,13 @@
-require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'although not required, it is recommended that you use bundler when running the tests'
+end
 
 require 'rspec'
 require 'rspec/autorun'
 require 'em-http' # As of webmock 1.4.0, em-http must be loaded first
 require 'webmock/rspec'
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
 require 'pusher'
 require 'eventmachine'
-
-RSpec.configure do |config|
-  config.include WebMock::API
-end

metadata

@@ -1,35 +1,27 @@
 --- !ruby/object:Gem::Specification 
 name: pusher
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 8
-  - 0
-  version: 0.8.0
+  prerelease: 
+  version: 0.8.1
 platform: ruby
 authors: 
-- New Bamboo
+- Pusher
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 +00:00
+date: 2011-05-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: multi_json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 0
-        version: 1.4.0
+        version: "1.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,10 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 0
         version: 0.1.0
   type: :runtime
   version_requirements: *id002
@@ -55,10 +43,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 0
         version: 0.4.0
   type: :runtime
   version_requirements: *id003
@@ -70,10 +54,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 2
         version: 0.1.2
   type: :runtime
   version_requirements: *id004
@@ -85,9 +65,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
         version: "2.0"
   type: :development
   version_requirements: *id005
@@ -99,8 +76,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id006
@@ -112,16 +87,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 2
-        - 7
         version: 0.2.7
   type: :development
   version_requirements: *id007
-description: Wrapper for pusherapp.com REST api
+description: Wrapper for pusher.com REST api
 email: 
-- support@pusherapp.com
+- support@pusher.com
 executables: []
 
 extensions: []
@@ -130,16 +101,15 @@ extra_rdoc_files: []
 
 files: 
 - .document
+- .gemtest
 - .gitignore
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/pusher.rb
 - lib/pusher/channel.rb
-- lib/pusher/json.rb
 - lib/pusher/request.rb
 - pusher.gemspec
 - spec/channel_spec.rb
@@ -159,24 +129,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Pusherapp client
+summary: Pusher API client
 test_files: 
 - spec/channel_spec.rb
 - spec/pusher_spec.rb

data/Gemfile.lock

@@ -1,43 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pusher (0.7.0)
-      crack (~> 0.1.0)
-      json (~> 1.4.0)
-      ruby-hmac (~> 0.4.0)
-      signature (~> 0.1.2)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.2.4)
-    crack (0.1.8)
-    diff-lcs (1.1.2)
-    em-http-request (0.2.15)
-      addressable (>= 2.0.0)
-      eventmachine (>= 0.12.9)
-    eventmachine (0.12.10)
-    json (1.4.6)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    ruby-hmac (0.4.0)
-    signature (0.1.2)
-      ruby-hmac
-    webmock (1.6.2)
-      addressable (>= 2.2.2)
-      crack (>= 0.1.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  em-http-request (~> 0.2.7)
-  pusher!
-  rspec (~> 2.0)
-  webmock

data/lib/pusher/json.rb

@@ -1,15 +0,0 @@
-require 'json'
-
-module Pusher
-  module JSON
-    
-    def self.generate(data)
-      if Object.const_defined?('ActiveSupport')
-        ActiveSupport::JSON.encode(data)
-      else
-        ::JSON.generate(data)
-      end
-    end
-    
-  end
-end