pusher 0.8.5 → 0.9.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 New Bamboo
+Copyright (c) 2010-2011 Pusher
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -66,6 +66,11 @@ The Pusher Gem also deals with signing requests for authenticated private channe
     
 Read more about private channels in [the docs](http://pusher.com/docs/client_api_guide/client_channels#subscribe-private-channels) and under {Pusher::Channel#authenticate}.
 
+WebHooks
+--------
+
+See {Pusher::WebHook}
+
 Developing
 ----------
 
@@ -73,8 +78,3 @@ Use bundler in order to run specs with the correct dependencies.
 
     bundle
     bundle exec rspec spec/*_spec.rb
-
-Copyright
----------
-
-Copyright (c) 2010 New Bamboo. See LICENSE for details.

data/lib/pusher.rb

@@ -1,5 +1,6 @@
 autoload 'Logger', 'logger'
 require 'uri'
+require 'pusher/client'
 
 # Used for configuring API credentials and creating Channel objects
 #
@@ -19,89 +20,51 @@ module Pusher
   class HTTPError < Error; attr_accessor :original_error; end
 
   class << self
-    attr_accessor :scheme, :host, :port
-    attr_writer :logger
-    attr_accessor :app_id, :key, :secret
+    extend Forwardable
 
-    # @private
-    def logger
-      @logger ||= begin
-        log = Logger.new($stdout)
-        log.level = Logger::INFO
-        log
-      end
-    end
+    def_delegators :default_client, :scheme, :host, :port, :app_id, :key, :secret
+    def_delegators :default_client, :scheme, :host=, :port=, :app_id=, :key=, :secret=
 
-    # @private
-    def authentication_token
-      Signature::Token.new(@key, @secret)
-    end
+    def_delegators :default_client, :authentication_token, :url
+    def_delegators :default_client, :encrypted=, :url=
 
-    # @private Builds a connection url for Pusherapp
-    def url
-      URI::Generic.build({
-        :scheme => self.scheme,
-        :host => self.host,
-        :port => self.port,
-        :path => "/apps/#{self.app_id}"
-      })
-    end
+    attr_writer :logger
 
-    # Configure Pusher connection by providing a url rather than specifying
-    # scheme, key, secret, and app_id separately.
+    # Return a channel by name
     #
     # @example
-    #   Pusher.url = http://KEY:SECRET@api.pusherapp.com/apps/APP_ID
-    #
-    def url=(url)
-      uri = URI.parse(url)
-      self.app_id = uri.path.split('/').last
-      self.key    = uri.user
-      self.secret = uri.password
-      self.host   = uri.host
-      self.port   = uri.port
+    #   Pusher['my-channel']
+    # @return [Channel]
+    # @raise [ConfigurationError] unless key, secret and app_id have been
+    #   configured
+    def [](channel_name)
+      begin
+        default_client[channel_name]
+      rescue ConfigurationError
+        raise ConfigurationError, 'Missing configuration: please check that Pusher.key, Pusher.secret and Pusher.app_id are configured.'
+      end
     end
 
-    # Configure whether Pusher API calls should be made over SSL
-    # (default false)
-    #
-    # @example
-    #   Pusher.encrypted = true
-    #
-    def encrypted=(boolean)
-      Pusher.scheme = boolean ? 'https' : 'http'
-      # Configure port if it hasn't already been configured
-      Pusher.port ||= boolean ? 443 : 80
+    def logger
+      @logger ||= begin
+        log = Logger.new($stdout)
+        log.level = Logger::INFO
+        log
+      end
     end
 
     private
 
-    def configured?
-      host && scheme && key && secret && app_id
+    def default_client
+      @default_client ||= Pusher::Client.new
     end
   end
 
-  # Defaults
-  self.scheme = 'http'
-  self.host = 'api.pusherapp.com'
-
   if ENV['PUSHER_URL']
     self.url = ENV['PUSHER_URL']
   end
-
-  # Return a channel by name
-  #
-  # @example
-  #   Pusher['my-channel']
-  # @return [Channel]
-  # @raise [ConfigurationError] unless key, secret and app_id have been
-  #   configured
-  def self.[](channel_name)
-    raise ConfigurationError, 'Missing configuration: please check that Pusher.key, Pusher.secret and Pusher.app_id are configured.' unless configured?
-    @channels ||= {}
-    @channels[channel_name.to_s] ||= Channel.new(url, channel_name)
-  end
 end
 
 require 'pusher/channel'
-require 'pusher/request'
+require 'pusher/request'
+require 'pusher/webhook'

data/lib/pusher/channel.rb

@@ -6,10 +6,11 @@ module Pusher
   class Channel
     attr_reader :name
 
-    def initialize(base_url, name)
+    def initialize(base_url, name, client = Pusher)
       @uri = base_url.dup
       @uri.path = @uri.path + "/channels/#{name}/"
       @name = name
+      @client = client
     end
 
     # Trigger event asynchronously using EventMachine::HttpRequest
@@ -69,7 +70,7 @@ module Pusher
     # @raise [Pusher::HTTPError] on any error raised inside Net::HTTP - the original error is available in the original_error attribute
     #
     def stats
-      request = Pusher::Request.new(:get, @uri + 'stats', {})
+      request = Pusher::Request.new(:get, @uri + 'stats', {}, nil, nil, @client)
       return request.send_sync
     end
 
@@ -89,7 +90,7 @@ module Pusher
 
       string_to_sign = [socket_id, name, custom_string].compact.map{|e|e.to_s}.join(':')
       Pusher.logger.debug "Signing #{string_to_sign}"
-      token = Pusher.authentication_token
+      token = @client.authentication_token
       signature = HMAC::SHA256.hexdigest(token.secret, string_to_sign)
 
       return "#{token.key}:#{signature}"
@@ -147,7 +148,7 @@ module Pusher
         end
       end
 
-      request = Pusher::Request.new(:post, @uri + 'events', params, body)
+      request = Pusher::Request.new(:post, @uri + 'events', params, body, nil, @client)
     end
   end
 end

data/lib/pusher/client.rb

@@ -0,0 +1,81 @@
+require 'signature'
+
+module Pusher
+  class Client
+    attr_accessor :scheme, :host, :port, :app_id, :key, :secret
+
+    # Initializes the client object.
+    def initialize(options = {})
+      options = {
+        scheme: 'http',
+        host: 'api.pusherapp.com',
+        port: 80,
+      }.merge(options)
+      @scheme, @host, @port, @app_id, @key, @secret = options.values_at(
+        :scheme, :host, :port, :app_id, :key, :secret
+      )
+    end
+
+    # @private Returns the authentication token for the client
+    def authentication_token
+      Signature::Token.new(@key, @secret)
+    end
+
+    # @private Builds a connection url for Pusherapp
+    def url
+      URI::Generic.build({
+        :scheme => @scheme,
+        :host => @host,
+        :port => @port,
+        :path => "/apps/#{@app_id}"
+      })
+    end
+
+    # Configure Pusher connection by providing a url rather than specifying
+    # scheme, key, secret, and app_id separately.
+    #
+    # @example
+    #   Pusher.url = http://KEY:SECRET@api.pusherapp.com/apps/APP_ID
+    #
+    def url=(url)
+      uri = URI.parse(url)
+      @scheme = uri.scheme
+      @app_id = uri.path.split('/').last
+      @key    = uri.user
+      @secret = uri.password
+      @host   = uri.host
+      @port   = uri.port
+    end
+
+    # Configure whether Pusher API calls should be made over SSL
+    # (default false)
+    #
+    # @example
+    #   Pusher.encrypted = true
+    #
+    def encrypted=(boolean)
+      @scheme = boolean ? 'https' : 'http'
+      # Configure port if it hasn't already been configured
+      @port = boolean ? 443 : 80
+    end
+
+    # Return a channel by name
+    #
+    # @example
+    #   Pusher['my-channel']
+    # @return [Channel]
+    # @raise [ConfigurationError] unless key, secret and app_id have been
+    #   configured
+    def [](channel_name)
+      raise ConfigurationError, 'Missing client configuration: please check that key, secret and app_id are configured.' unless configured?
+      @channels ||= {}
+      @channels[channel_name.to_s] ||= Channel.new(url, channel_name, self)
+    end
+
+    private
+
+    def configured?
+      host && scheme && key && secret && app_id
+    end
+  end
+end

data/lib/pusher/request.rb

@@ -52,9 +52,12 @@ module Pusher
 
     include QueryEncoder
 
-    def initialize(verb, uri, params, body = nil, token = nil)
+    attr_reader :body, :params
+
+    def initialize(verb, uri, params, body = nil, token = nil, client = Pusher)
       @verb = verb
       @uri = uri
+      @client = client
 
       if body
         @body = body
@@ -62,7 +65,7 @@ module Pusher
       end
 
       request = Signature::Request.new(verb.to_s.upcase, uri.path, params)
-      auth_hash = request.sign(token || Pusher.authentication_token)
+      auth_hash = request.sign(token || @client.authentication_token)
       @params = params.merge(auth_hash)
     end
 

data/lib/pusher/webhook.rb

@@ -0,0 +1,110 @@
+require 'multi_json'
+require 'hmac-sha2'
+
+module Pusher
+  # Used to parse and authenticate WebHooks
+  #
+  # @example
+  #   post '/webhooks' do
+  #     webhook = Pusher::WebHook.new(request)
+  #     if webhook.valid?
+  #       webhook.events.each do |event|
+  #         case event["name"]
+  #         when 'channel_occupied'
+  #           puts "Channel occupied: #{event["channel"]}"
+  #         when 'channel_vacated'
+  #           puts "Channel vacated: #{event["channel"]}"
+  #         end
+  #       end
+  #     else
+  #       status 401
+  #     end
+  #     return
+  #   end
+  #
+  class WebHook
+    attr_reader :key, :signature
+
+    # Provide either a Rack::Request or a Hash containing :key, :signature,
+    # :body, and :content_type (optional)
+    #
+    def initialize(request, client = Pusher)
+      @client = client
+      if request.kind_of?(Rack::Request)
+        @key = request.env['HTTP_X_PUSHER_KEY']
+        @signature = request.env["HTTP_X_PUSHER_SIGNATURE"]
+        @content_type = request.content_type
+
+        request.body.rewind
+        @body = request.body.read
+        request.body.rewind
+      else
+        @key, @signature, @body = request.values_at(:key, :signature, :body)
+        @content_type = request[:content_type] || 'application/json'
+      end
+    end
+
+    # Returns whether the WebHook is valid by checking that the signature
+    # matches the configured key & secret. In the case that the webhook is
+    # invalid, the reason is logged
+    #
+    # @param extra_tokens [Hash] If you have extra tokens for your Pusher
+    # app, you can specify them here so that they're used to attempt
+    # validation.
+    #
+    def valid?(extra_tokens = nil)
+      extra_tokens = [extra_tokens] if extra_tokens.kind_of?(Hash)
+      if @key == @client.key
+        return check_signature(@client.secret)
+      elsif extra_tokens
+        extra_tokens.each do |token|
+          return check_signature(token[:secret]) if @key == token[:key]
+        end
+      end
+      Pusher.logger.warn "Received webhook with unknown key: #{key}"
+      return false
+    end
+
+    # Array of events (as Hashes) contained inside the webhook
+    #
+    def events
+      data["events"]
+    end
+
+    # The time at which the WebHook was initially triggered by Pusher, i.e.
+    # when the event occurred
+    #
+    # @return [Time]
+    #
+    def time
+      Time.at(data["time_ms"].to_f/1000)
+    end
+
+    # Access the parsed WebHook body
+    #
+    def data
+      @data ||= begin
+        case @content_type
+        when 'application/json'
+          MultiJson.decode(@body)
+        else
+          raise "Unknown Content-Type (#{@content_type})"
+        end
+      end
+    end
+
+    private
+
+    # Checks signature against secret and returns boolean
+    #
+    def check_signature(secret)
+      expected = HMAC::SHA256.hexdigest(secret, @body)
+      if @signature == expected
+        return true
+      else
+        Pusher.logger.warn "Received WebHook with invalid signature: got #{@signature}, expected #{expected}"
+        return false
+      end
+    end
+  end
+end

data/pusher.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "pusher"
-  s.version     = "0.8.5"
+  s.version     = "0.9.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Pusher"]
   s.email       = ["support@pusher.com"]
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "webmock"
   s.add_development_dependency "em-http-request", "~> 1.0.0"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rack"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/channel_spec.rb

@@ -2,12 +2,14 @@ require 'spec_helper'
 
 describe Pusher::Channel do
   before do
-    Pusher.app_id = '20'
-    Pusher.key    = '12345678900000001'
-    Pusher.secret = '12345678900000001'
-    Pusher.host = 'api.pusherapp.com'
-    Pusher.port = 80
-    Pusher.encrypted = false
+    @client = Pusher::Client.new(
+      app_id: '20',
+      key: '12345678900000001',
+      secret: '12345678900000001',
+      host: 'api.pusherapp.com',
+      port: 80,
+    )
+    @client.encrypted = false
 
     WebMock.reset!
     WebMock.disable_net_connect!
@@ -15,17 +17,11 @@ describe Pusher::Channel do
     @pusher_url_regexp = %r{/apps/20/channels/test_channel/events}
   end
 
-  after do
-    Pusher.app_id = nil
-    Pusher.key = nil
-    Pusher.secret = nil
-  end
-
   describe 'trigger!' do
     before :each do
       WebMock.stub_request(:post, @pusher_url_regexp).
         to_return(:status => 202)
-      @channel = Pusher['test_channel']
+      @channel = @client['test_channel']
     end
 
     it 'should configure HTTP library to talk to pusher API' do
@@ -34,8 +30,9 @@ describe Pusher::Channel do
     end
 
     it "should POST to https api if ssl enabled" do
-      Pusher.encrypted = true
-      Pusher::Channel.new(Pusher.url, 'test_channel').trigger('new_event', 'Some data')
+      @client.encrypted = true
+      encrypted_channel = Pusher::Channel.new(@client.url, 'test_channel', @client)
+      encrypted_channel.trigger('new_event', 'Some data')
       WebMock.should have_requested(:post, %r{https://api.pusherapp.com})
     end
 
@@ -47,7 +44,7 @@ describe Pusher::Channel do
       WebMock.should have_requested(:post, %r{/apps/20/channels/test_channel/events}).with do |req|
         query_hash = req.uri.query_values
         query_hash["name"].should == 'new_event'
-        query_hash["auth_key"].should == Pusher.key
+        query_hash["auth_key"].should == @client.key
         query_hash["auth_timestamp"].should_not be_nil
 
         parsed = MultiJson.decode(req.body)
@@ -75,7 +72,7 @@ describe Pusher::Channel do
 
       error_raised = nil
       begin
-        Pusher['test_channel'].trigger!('new_event', 'Some data')
+        @client['test_channel'].trigger!('new_event', 'Some data')
       rescue => e
         error_raised = e
       end
@@ -90,7 +87,7 @@ describe Pusher::Channel do
         %r{/apps/20/channels/test_channel/events}
       ).to_return(:status => 401)
       lambda {
-        Pusher['test_channel'].trigger!('new_event', 'Some data')
+        @client['test_channel'].trigger!('new_event', 'Some data')
       }.should raise_error(Pusher::AuthenticationError)
     end
 
@@ -99,7 +96,7 @@ describe Pusher::Channel do
         :post, %r{/apps/20/channels/test_channel/events}
       ).to_return(:status => 404)
       lambda {
-        Pusher['test_channel'].trigger!('new_event', 'Some data')
+        @client['test_channel'].trigger!('new_event', 'Some data')
       }.should raise_error(Pusher::Error, 'Resource not found: app_id is probably invalid')
     end
 
@@ -108,7 +105,7 @@ describe Pusher::Channel do
         :post, %r{/apps/20/channels/test_channel/events}
       ).to_return(:status => 500, :body => "some error")
       lambda {
-        Pusher['test_channel'].trigger!('new_event', 'Some data')
+        @client['test_channel'].trigger!('new_event', 'Some data')
       }.should raise_error(Pusher::Error, 'Unknown error (status code 500): some error')
     end
   end
@@ -118,7 +115,8 @@ describe Pusher::Channel do
       stub_request(:post, @pusher_url_regexp).to_raise(Net::HTTPBadResponse)
       Pusher.logger.should_receive(:error).with("Exception from WebMock (Net::HTTPBadResponse) (Pusher::HTTPError)")
       Pusher.logger.should_receive(:debug) #backtrace
-      Pusher::Channel.new(Pusher.url, 'test_channel').trigger('new_event', 'Some data')
+      channel = Pusher::Channel.new(@client.url, 'test_channel', @client)
+      channel.trigger('new_event', 'Some data')
     end
 
     it "should log failure if Pusher returns an error response" do
@@ -126,7 +124,8 @@ describe Pusher::Channel do
       # @http.should_receive(:post).and_raise(Net::HTTPBadResponse)
       Pusher.logger.should_receive(:error).with(" (Pusher::AuthenticationError)")
       Pusher.logger.should_receive(:debug) #backtrace
-      Pusher::Channel.new(Pusher.url, 'test_channel').trigger('new_event', 'Some data')
+      channel = Pusher::Channel.new(@client.url, 'test_channel', @client)
+      channel.trigger('new_event', 'Some data')
     end
   end
 
@@ -134,7 +133,7 @@ describe Pusher::Channel do
     it "should by default POST to http api" do
       EM.run {
         stub_request(:post, @pusher_url_regexp).to_return(:status => 202)
-        channel = Pusher::Channel.new(Pusher.url, 'test_channel')
+        channel = Pusher::Channel.new(@client.url, 'test_channel', @client)
         channel.trigger_async('new_event', 'Some data').callback {
           WebMock.should have_requested(:post, %r{http://api.pusherapp.com})
           EM.stop
@@ -143,10 +142,10 @@ describe Pusher::Channel do
     end
 
     it "should POST to https api if ssl enabled" do
-      Pusher.encrypted = true
+      @client.encrypted = true
       EM.run {
         stub_request(:post, @pusher_url_regexp).to_return(:status => 202)
-        channel = Pusher::Channel.new(Pusher.url, 'test_channel')
+        channel = Pusher::Channel.new(@client.url, 'test_channel', @client)
         channel.trigger_async('new_event', 'Some data').callback {
           WebMock.should have_requested(:post, %r{https://api.pusherapp.com})
           EM.stop
@@ -158,7 +157,7 @@ describe Pusher::Channel do
       stub_request(:post, @pusher_url_regexp).to_return(:status => 202)
 
       EM.run {
-        d = Pusher['test_channel'].trigger_async('new_event', 'Some data')
+        d = @client['test_channel'].trigger_async('new_event', 'Some data')
         d.callback {
           WebMock.should have_requested(:post, @pusher_url_regexp)
           EM.stop
@@ -174,7 +173,7 @@ describe Pusher::Channel do
       stub_request(:post, @pusher_url_regexp).to_return(:status => 401)
 
       EM.run {
-        d = Pusher['test_channel'].trigger_async('new_event', 'Some data')
+        d = @client['test_channel'].trigger_async('new_event', 'Some data')
         d.callback {
           fail
         }
@@ -197,7 +196,7 @@ describe Pusher::Channel do
         :status => 200,
         :body => JSON.generate(:user_count => 1)
       })
-      @channel = Pusher['presence-test_channel']
+      @channel = @client['presence-test_channel']
 
       @channel.stats.should == {
         :user_count => 1
@@ -207,7 +206,7 @@ describe Pusher::Channel do
 
   describe "socket_auth" do
     before :each do
-      @channel = Pusher['test_channel']
+      @channel = @client['test_channel']
     end
 
     it "should return an authentication string given a socket id" do
@@ -247,7 +246,7 @@ describe Pusher::Channel do
       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")}"
+        auth.should == "12345678900000001:#{HMAC::SHA256.hexdigest(@client.secret, "socketid:test_channel:foobar")}"
       end
 
     end
@@ -256,7 +255,7 @@ describe Pusher::Channel do
   describe '#authenticate' do
 
     before :each do
-      @channel = Pusher['test_channel']
+      @channel = @client['test_channel']
       @custom_data = {:uid => 123, :info => {:name => 'Foo'}}
     end
 
@@ -266,7 +265,7 @@ describe Pusher::Channel do
       response = @channel.authenticate('socketid', @custom_data)
 
       response.should == {
-        :auth => "12345678900000001:#{HMAC::SHA256.hexdigest(Pusher.secret, "socketid:test_channel:a json string")}",
+        :auth => "12345678900000001:#{HMAC::SHA256.hexdigest(@client.secret, "socketid:test_channel:a json string")}",
         :channel_data => 'a json string'
       }
     end

data/spec/client_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+require 'em-http'
+
+describe Pusher do
+  describe 'different clients' do
+    before :each do
+      @client1 = Pusher::Client.new
+      @client2 = Pusher::Client.new
+
+      @client1.scheme = 'ws'
+      @client2.scheme = 'wss'
+      @client1.host = 'one'
+      @client2.host = 'two'
+      @client1.port = 81
+      @client2.port = 82
+      @client1.app_id = '1111'
+      @client2.app_id = '2222'
+      @client1.key = 'AAAA'
+      @client2.key = 'BBBB'
+      @client1.secret = 'aaaaaaaa'
+      @client2.secret = 'bbbbbbbb'
+    end
+
+    it "should send scheme messages to different objects" do
+      @client1.scheme.should_not == @client2.scheme
+    end
+
+    it "should send host messages to different objects" do
+      @client1.host.should_not == @client2.host
+    end
+
+    it "should send port messages to different objects" do
+      @client1.port.should_not == @client2.port
+    end
+
+    it "should send app_id messages to different objects" do
+      @client1.app_id.should_not == @client2.app_id
+    end
+
+    it "should send app_id messages to different objects" do
+      @client1.key.should_not == @client2.key
+    end
+
+    it "should send app_id messages to different objects" do
+      @client1.secret.should_not == @client2.secret
+    end
+
+    it "should send app_id messages to different objects" do
+      @client1.authentication_token.key.should_not == @client2.authentication_token.key
+      @client1.authentication_token.secret.should_not == @client2.authentication_token.secret
+    end
+
+    it "should send url messages to different objects" do
+      @client1.url.to_s.should_not == @client2.url.to_s
+      @client1.url = 'ws://one/apps/111'
+      @client2.url = 'wss://two/apps/222'
+      @client1.scheme.should_not == @client2.scheme
+      @client1.host.should_not == @client2.host
+      @client1.app_id.should_not == @client2.app_id
+    end
+
+    it "should send encrypted messages to different objects" do
+      @client1.encrypted = false
+      @client2.encrypted = true
+      @client1.scheme.should_not == @client2.scheme
+      @client1.port.should_not == @client2.port
+    end
+
+    it "should send [] messages to different objects" do
+      @client1['test'].should_not == @client2['test']
+    end
+  end
+
+  [lambda { Pusher }, lambda { Pusher::Client.new }].each do |client_gen|
+    before :each do
+      @client = client_gen.call
+    end
+
+    describe 'default configuration' do
+      it 'should be preconfigured for api host' do
+        @client.host.should == 'api.pusherapp.com'
+      end
+
+      it 'should be preconfigured for port 80' do
+        @client.port.should == 80
+      end
+
+      it 'should use standard logger if no other logger if defined' do
+        Pusher.logger.debug('foo')
+        Pusher.logger.should be_kind_of(Logger)
+      end
+    end
+
+    describe 'logging configuration' do
+      it "can be configured to use any logger" do
+        logger = mock("ALogger")
+        logger.should_receive(:debug).with('foo')
+        Pusher.logger = logger
+        Pusher.logger.debug('foo')
+        Pusher.logger = nil
+      end
+    end
+
+    describe "configuration using url" do
+      it "should be possible to configure everything by setting the url" do
+        @client.url = "test://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
+
+        @client.scheme.should == 'test'
+        @client.host.should == 'api.staging.pusherapp.com'
+        @client.port.should == 8080
+        @client.key.should == 'somekey'
+        @client.secret.should == 'somesecret'
+        @client.app_id.should == '87'
+      end
+
+      it "should override scheme and port when setting encrypted=true after url" do
+        @client.url = "http://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
+        @client.encrypted = true
+
+        @client.scheme.should == 'https'
+        @client.port.should == 443
+      end
+    end
+
+    describe 'when configured' do
+      before :each do
+        @client.app_id = '20'
+        @client.key    = '12345678900000001'
+        @client.secret = '12345678900000001'
+      end
+
+      describe '.[]' do
+        before do
+          @channel = @client['test_channel']
+        end
+
+        it 'should return a channel' do
+          @channel.should be_kind_of(Pusher::Channel)
+        end
+
+        it "should reuse the same channel objects" do
+          channel1, channel2 = @client['test_channel'], @client['test_channel']
+
+          channel1.object_id.should == channel2.object_id
+        end
+
+        %w{app_id key secret}.each do |config|
+          it "should raise exception if #{config} not configured" do
+            @client.send("#{config}=", nil)
+            lambda {
+              @client['test_channel']
+            }.should raise_error(Pusher::ConfigurationError)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/web_hook_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+require 'rack'
+require 'stringio'
+
+describe Pusher::WebHook do
+  before :each do
+    @hook_data = {
+      "time_ms" => 123456,
+      "events" => [
+        {"name" => 'foo'}
+      ]
+    }
+  end
+
+  describe "initialization" do
+    it "can be initialized with Rack::Request" do
+      request = Rack::Request.new({
+        'HTTP_X_PUSHER_KEY' => '1234',
+        'HTTP_X_PUSHER_SIGNATURE' => 'asdf',
+        'CONTENT_TYPE' => 'application/json',
+        'rack.input' => StringIO.new(MultiJson.encode(@hook_data))
+      })
+      wh = Pusher::WebHook.new(request)
+      wh.key.should == '1234'
+      wh.signature.should == 'asdf'
+      wh.data.should == @hook_data
+    end
+
+    it "can be initialized with a hash" do
+      request = {
+        key: '1234',
+        signature: 'asdf',
+        content_type: 'application/json',
+        body: MultiJson.encode(@hook_data),
+      }
+      wh = Pusher::WebHook.new(request)
+      wh.key.should == '1234'
+      wh.signature.should == 'asdf'
+      wh.data.should == @hook_data
+    end
+  end
+
+  describe "after initialization" do
+    before :each do
+      body = MultiJson.encode(@hook_data)
+      request = {
+        key: '1234',
+        signature: HMAC::SHA256.hexdigest('asdf', body),
+        content_type: 'application/json',
+        body: body
+      }
+
+      @client = Pusher::Client.new
+      @wh = Pusher::WebHook.new(request, @client)
+    end
+
+    it "should validate" do
+      @client.key = '1234'
+      @client.secret = 'asdf'
+      @wh.should be_valid
+    end
+
+    it "should not validate if key is wrong" do
+      @client.key = '12345'
+      @client.secret = 'asdf'
+      Pusher.logger.should_receive(:warn).with("Received webhook with unknown key: 1234")
+      @wh.should_not be_valid
+    end
+
+    it "should not validate if secret is wrong" do
+      @client.key = '1234'
+      @client.secret = 'asdfxxx'
+      Pusher.logger.should_receive(:warn).with("Received WebHook with invalid signature: got a18bd1374b3b198ec457fb11d636ee2024d8077fc542829443729988bd1e4aa4, expected bb81a112a46dee1e4154ee4f328621f32558192c7af12adfc0395082cfcd3c6c")
+      @wh.should_not be_valid
+    end
+
+    it "should validate with an extra token" do
+      @client.key = '12345'
+      @client.secret = 'xxx'
+      @wh.valid?({key: '1234', secret: 'asdf'}).should be_true
+    end
+
+    it "should validate with an array of extra tokens" do
+      @client.key = '123456'
+      @client.secret = 'xxx'
+      @wh.valid?([
+        {key: '12345', secret: 'wtf'},
+        {key: '1234', secret: 'asdf'}
+      ]).should be_true
+    end
+
+    it "should not validate if all keys are wrong with extra tokens" do
+      @client.key = '123456'
+      @client.secret = 'asdf'
+      Pusher.logger.should_receive(:warn).with("Received webhook with unknown key: 1234")
+      @wh.valid?({key: '12345', secret: 'asdf'}).should be_false
+    end
+
+    it "should not validate if secret is wrong with extra tokens" do
+      @client.key = '123456'
+      @client.secret = 'asdfxxx'
+      Pusher.logger.should_receive(:warn).with(/Received WebHook with invalid signature/)
+      @wh.valid?({key: '1234', secret: 'wtf'}).should be_false
+    end
+
+    it "should expose events" do
+      @wh.events.should == @hook_data["events"]
+    end
+
+    it "should expose time" do
+      @wh.time.should == Time.at(123.456)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pusher
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000Z
+date: 2012-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70170954250900 !ruby/object:Gem::Requirement
+  requirement: &70115752741600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70170954250900
+  version_requirements: *70115752741600
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
-  requirement: &70170954250400 !ruby/object:Gem::Requirement
+  requirement: &70115752779060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70170954250400
+  version_requirements: *70115752779060
 - !ruby/object:Gem::Dependency
   name: signature
-  requirement: &70170954249520 !ruby/object:Gem::Requirement
+  requirement: &70115752776600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70170954249520
+  version_requirements: *70115752776600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70170954248040 !ruby/object:Gem::Requirement
+  requirement: &70115752774560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70170954248040
+  version_requirements: *70115752774560
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70170954246460 !ruby/object:Gem::Requirement
+  requirement: &70115752772240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170954246460
+  version_requirements: *70115752772240
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70170954244800 !ruby/object:Gem::Requirement
+  requirement: &70115752784600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70170954244800
+  version_requirements: *70115752784600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70170954244120 !ruby/object:Gem::Requirement
+  requirement: &70115752779980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170954244120
+  version_requirements: *70115752779980
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70115752793240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70115752793240
 description: Wrapper for pusher.com REST api
 email:
 - support@pusher.com
@@ -106,11 +117,14 @@ files:
 - examples/async_message.rb
 - lib/pusher.rb
 - lib/pusher/channel.rb
+- lib/pusher/client.rb
 - lib/pusher/request.rb
+- lib/pusher/webhook.rb
 - pusher.gemspec
 - spec/channel_spec.rb
-- spec/pusher_spec.rb
+- spec/client_spec.rb
 - spec/spec_helper.rb
+- spec/web_hook_spec.rb
 homepage: http://github.com/pusher/pusher-gem
 licenses: []
 post_install_message: 
@@ -131,11 +145,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Pusher API client
 test_files:
 - spec/channel_spec.rb
-- spec/pusher_spec.rb
+- spec/client_spec.rb
 - spec/spec_helper.rb
+- spec/web_hook_spec.rb

data/spec/pusher_spec.rb

@@ -1,87 +0,0 @@
-require 'spec_helper'
-
-require 'em-http'
-
-describe Pusher do
-  describe 'configuration' do
-    it 'should be preconfigured for api host' do
-      Pusher.host.should == 'api.pusherapp.com'
-    end
-
-    it 'should be preconfigured for port 80' do
-      Pusher.port.should == 80
-    end
-
-    it 'should use standard logger if no other logger if defined' do
-      Pusher.logger.debug('foo')
-      Pusher.logger.should be_kind_of(Logger)
-    end
-
-    it "can be configured to use any logger" do
-      logger = mock("ALogger")
-      logger.should_receive(:debug).with('foo')
-      Pusher.logger = logger
-      Pusher.logger.debug('foo')
-      Pusher.logger = nil
-    end
-  end
-
-  describe "configuration using url" do
-    after do
-      Pusher.app_id = nil
-      Pusher.key = nil
-      Pusher.secret = nil
-      Pusher.host = 'api.pusherapp.com'
-      Pusher.port = 80
-    end
-
-    it "should be possible to configure everything by setting the url" do
-      Pusher.url = "http://somekey:somesecret@api.staging.pusherapp.com:8080/apps/87"
-
-      Pusher.host.should == 'api.staging.pusherapp.com'
-      Pusher.port.should == 8080
-      Pusher.key.should == 'somekey'
-      Pusher.secret.should == 'somesecret'
-      Pusher.app_id.should == '87'
-    end
-  end
-
-  describe 'when configured' do
-    before do
-      Pusher.app_id = '20'
-      Pusher.key    = '12345678900000001'
-      Pusher.secret = '12345678900000001'
-    end
-
-    after do
-      Pusher.app_id = nil
-      Pusher.key = nil
-      Pusher.secret = nil
-    end
-
-    describe '.[]' do
-      before do
-        @channel = Pusher['test_channel']
-      end
-
-      it 'should return a channel' do
-        @channel.should be_kind_of(Pusher::Channel)
-      end
-
-      it "should reuse the same channel objects" do
-        channel1, channel2 = Pusher['test_channel'], Pusher['test_channel']
-
-        channel1.object_id.should == channel2.object_id
-      end
-
-      %w{app_id key secret}.each do |config|
-        it "should raise exception if #{config} not configured" do
-          Pusher.send("#{config}=", nil)
-          lambda {
-            Pusher['test_channel']
-          }.should raise_error(Pusher::ConfigurationError)
-        end
-      end
-    end
-  end
-end