pusher 0.10.0 → 0.11.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pusher (0.10.0)
+    pusher (0.11.0)
       multi_json (~> 1.0)
       signature (~> 0.1.4)
 

data/README.md

@@ -3,80 +3,151 @@ Pusher gem
 
 [![Build Status](https://secure.travis-ci.org/pusher/pusher-gem.png?branch=master)](http://travis-ci.org/pusher/pusher-gem)
 
-Getting started
----------------
+## Configuration
 
-After registering at <http://pusher.com> configure your app with the security credentials
+After registering at <http://pusher.com> configure your app with the security credentials.
+
+### Global
+
+The most standard way of configuring Pusher is to do it globally on the Pusher class. 
 
     Pusher.app_id = 'your-pusher-app-id'
     Pusher.key = 'your-pusher-key'
     Pusher.secret = 'your-pusher-secret'
 
-Trigger an event with {Pusher::Channel#trigger!}
+Global configuration will automatically be set from the `PUSHER_URL` environment variable if it exists. This should be in the form  `http://KEY:SECRET@api.pusherapp.com/apps/APP_ID`. On Heroku this environment variable will already be set.
+
+If you need to make requests via a HTTP proxy then it can be configured
+
+    Pusher.http_proxy = 'http://(user):(password)@(host):(port)'
+
+By default API requests are made over HTTP. HTTPS can be used by setting
+
+    Pusher.encrypted = true
+
+### Instantiating a Pusher client
+
+Sometimes you may have multiple sets of API keys, or want different configuration in different parts of your application. In these scenarios, a pusher `client` may be configured:
+
+    pusher_client = Pusher.new({
+      app_id: 'your-pusher-app-id',
+      key: 'your-pusher-key',
+      secret: 'your-pusher-secret'
+    })
+
+This `client` will have all the functionality listed on the main Pusher class (which proxies to a client internally).
 
-    Pusher['a_channel'].trigger!('an_event', {:some => 'data'})
 
-Handle errors by rescuing `Pusher::Error` (all Pusher errors are descendants of this error)
+
+## Interacting with the Pusher service
+
+The Pusher gem contains a number of helpers for interacting with the service. As a general rule, the library adheres to a set of conventions that we have aimed to make universal.
+
+### Handling errors
+
+Handle errors by rescuing `Pusher::Error` (all errors are descendants of this error)
 
     begin
-      Pusher['a_channel'].trigger!('an_event', {:some => 'data'})
+      Pusher.trigger('a_channel', 'an_event', {:some => 'data'})
     rescue Pusher::Error => e
       # (Pusher::AuthenticationError, Pusher::HTTPError, or Pusher::Error)
     end
 
-Optionally a socket id may be provided. This will exclude the event from being triggered on this socket id (see <http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients> for more info).
+### Logging
 
-    Pusher['a_channel'].trigger!('an_event', {:some => 'data'}, socket_id)
+Errors are logged to `Pusher.logger`. It will by default log at info level to STDOUT using `Logger` from the standard library, however you can assign any logger:
 
-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.logger = Rails.logger
+
+### Publishing events
+
+An event can be sent to Pusher in in the following ways:
+
+    # on the Pusher class
+    Pusher.trigger('channel_name', 'event_name', {some: 'data'})
+    Pusher.trigger(['channel_1', 'channel_2'], 'event_name', {some: 'data'})
+    
+    # or on a pusher_client
+    pusher_client.trigger(['your_channels'], 'your_event_name', {some: 'data'})
+
+Note: the first `channels` argument can contain multiple channels you'd like your event and data payload to go to. There is a limit of 100 on the number of channels this can contain.
+
+An optional fourth argument of this method can specify a `socket_id` that will be excluded from receiving the event (generally the user where the event originated -- see <http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients> for more info).
+
+#### Original publisher API
+
+Most examples and documentation will refer to the following syntax for triggering an event:
 
     Pusher['a_channel'].trigger('an_event', {:some => 'data'})
 
-Logging
--------
+This will continue to work, but will be replaced as the canonical version by `Pusher.trigger` which supports multiple channels.
 
-Errors are logged to `Pusher.logger`. It will by default use `Logger` from stdlib, however you can assign any logger:
+### Generic requests to the Pusher REST API
 
-    Pusher.logger = Rails.logger
+Aside from triggering events, the REST API also supports a number of operations for querying the state of the system. A reference of the available methods is available at <http://pusher.com/docs/rest_api>.
+
+All requests must be signed by using your secret key, which is handled automatically using these methods:
+
+    # using the Pusher class
+    Pusher.get('url_without_app_id', params)
+    
+    # using a client
+    pusher_client.post('url_without_app_id', params)
+
+Note that you don't need to specify your app_id in the URL, as this is inferred from your credentials. As with the trigger method above, `_async` can be suffixed to the method name to return a deferrable.
 
-Asynchronous triggering
------------------------
+### Asynchronous requests
 
-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.
+If you are running your application in an evented environment, you may want to use the asynchronous versions of the Pusher API methods to avoid blocking. The convention for this is to add the suffix `_async` to the method, e.g. `trigger_async` or `post_async`.
 
 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.
 
-    $ gem install em-http-request
+When using an asynchronous version of a method, it will return a deferrable.
 
-    deferrable = Pusher['a_channel'].trigger_async('an_event', {
+    Pusher.trigger_async(['a_channel'], 'an_event', {
       :some => 'data'
-    }, socket_id)
-    deferrable.callback {
+    }, socket_id).callback {
       # Do something on success
-    }
-    deferrable.errback { |error|
+    }.errback { |error|
       # error is a instance of Pusher::Error
     }
 
-Private channels
-----------------
 
-The Pusher Gem also deals with signing requests for authenticated private channels. A quick Rails controller example:
 
-    reponse = Pusher['private-my_channel'].authenticate(params[:socket_id])
-    render :json => response
-    
-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}.
+## Authenticating subscription requests
+
+It's possible to use the gem to authenticate subscription requests to private or presence channels. The `authenticate` method is available on a channel object for this purpose and returns a JSON object that can be returned to the client that made the request. More information on this authentication scheme can be found in the docs on <http://pusher.com>
+
+### Private channels
+
+    Pusher['private-my_channel'].authenticate(params[:socket_id])
 
-WebHooks
---------
+### Presence channels
 
-See {Pusher::WebHook}
+These work in a very similar way, but require a unique identifier for the user being authenticated, and optionally some attributes that are provided to clients via presence events:
 
-Developing
-----------
+    Pusher['presence-my_channel'].authenticate(params[:socket_id], {
+      user_id: 'user_id',
+      user_info: {} # optional
+    })
 
-Use bundler in order to run specs with the correct dependencies.
 
-    bundle
-    bundle exec rspec spec/*_spec.rb
+
+## Receiving WebHooks
+
+A WebHook object may be created to validate received WebHooks against your app credentials, and to extract events. It should be created with the `Rack::Request` object (available as `request` in Rails controllers or Sinatra handlers for example).
+
+    webhook = Pusher.webhook(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
+      render text: 'ok'
+    else
+      render text: 'invalid', status: 401
+    end

data/lib/pusher.rb

@@ -7,12 +7,11 @@ require 'pusher/client'
 # Used for configuring API credentials and creating Channel objects
 #
 module Pusher
-  # All Pusher errors descend from this class so you can easily rescue Pusher
-  # errors
+  # All errors descend from this class so they can be easily rescued
   #
   # @example
   #   begin
-  #     Pusher['a_channel'].trigger!('an_event', {:some => 'data'})
+  #     Pusher.trigger('channel_name', 'event_name, {:some => 'data'})
   #   rescue Pusher::Error => e
   #     # Do something on error
   #   end
@@ -24,31 +23,18 @@ module Pusher
   class << self
     extend Forwardable
 
-    def_delegators :default_client, :scheme, :host, :port, :app_id, :key, :secret
-    def_delegators :default_client, :scheme=, :host=, :port=, :app_id=, :key=, :secret=
+    def_delegators :default_client, :scheme, :host, :port, :app_id, :key, :secret, :http_proxy
+    def_delegators :default_client, :scheme=, :host=, :port=, :app_id=, :key=, :secret=, :http_proxy=
 
     def_delegators :default_client, :authentication_token, :url
     def_delegators :default_client, :encrypted=, :url=
 
-    def_delegators :default_client, :channels, :channel_info, :trigger
+    def_delegators :default_client, :get, :get_async, :post, :post_async
+    def_delegators :default_client, :channels, :channel_info, :trigger, :trigger_async
+    def_delegators :default_client, :webhook, :channel, :[]
 
     attr_writer :logger
 
-    # 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)
-      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
-
     def logger
       @logger ||= begin
         log = Logger.new($stdout)
@@ -70,5 +56,7 @@ module Pusher
 end
 
 require 'pusher/channel'
+require 'pusher/query_encoder'
 require 'pusher/request'
+require 'pusher/resource'
 require 'pusher/webhook'

data/lib/pusher/channel.rb

@@ -15,6 +15,9 @@ module Pusher
 
     # Trigger event asynchronously using EventMachine::HttpRequest
     #
+    # [Deprecated] This method will be removed in a future gem version. Please
+    # switch to Pusher.trigger_async or Pusher::Client#trigger_async instead
+    #
     # @param (see #trigger!)
     # @return [EM::DefaultDeferrable]
     #   Attach a callback to be notified of success (with no parameters).
@@ -24,13 +27,17 @@ module Pusher
     # @raise [Pusher::Error] unless the eventmachine reactor is running. You
     #   probably want to run your application inside a server such as thin
     #
-    def trigger_async(event_name, data, socket_id = nil, &block)
-      request = construct_event_request(event_name, data, socket_id)
-      request.send_async
+    def trigger_async(event_name, data, socket_id = nil)
+      params = {}
+      params[:socket_id] = socket_id if socket_id
+      @client.trigger_async(name, event_name, data, params)
     end
 
     # Trigger event
     #
+    # [Deprecated] This method will be removed in a future gem version. Please
+    # switch to Pusher.trigger or Pusher::Client#trigger instead
+    #
     # @example
     #   begin
     #     Pusher['my-channel'].trigger!('an_event', {:some => 'data'})
@@ -47,12 +54,16 @@ module Pusher
     # @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)
-      request = construct_event_request(event_name, data, socket_id)
-      request.send_sync
+      params = {}
+      params[:socket_id] = socket_id if socket_id
+      @client.trigger(name, event_name, data, params)
     end
 
     # Trigger event, catching and logging any errors.
     #
+    # [Deprecated] This method will be removed in a future gem version. Please
+    # switch to Pusher.trigger or Pusher::Client#trigger instead
+    #
     # @note CAUTION! No exceptions will be raised on failure
     # @param (see #trigger!)
     #
@@ -71,7 +82,7 @@ module Pusher
     # @raise [Pusher::HTTPError] on any error raised inside Net::HTTP - the original error is available in the original_error attribute
     #
     def info(attributes = [])
-      @client.channel_info(name, :info => attributes.join(','))
+      @client.get("/channels/#{name}", :info => attributes.join(','))
     end
 
     # Compute authentication string required as part of the authentication
@@ -132,28 +143,5 @@ module Pusher
       r[:channel_data] = custom_data if custom_data
       r
     end
-
-    private
-
-    def construct_event_request(event_name, data, socket_id)
-      params = {
-        :name => event_name,
-      }
-      params[:socket_id] = socket_id if socket_id
-
-      body = case data
-      when String
-        data
-      else
-        begin
-          MultiJson.encode(data)
-        rescue MultiJson::DecodeError => e
-          Pusher.logger.error("Could not convert #{data.inspect} into JSON")
-          raise e
-        end
-      end
-
-      request = Pusher::Request.new(:post, @uri + 'events', params, body, nil, @client)
-    end
   end
 end

data/lib/pusher/client.rb

@@ -2,9 +2,11 @@ require 'signature'
 
 module Pusher
   class Client
-    attr_accessor :scheme, :host, :port, :app_id, :key, :secret
+    attr_accessor :scheme, :host, :port, :app_id, :key, :secret, :http_proxy
+    attr_reader :proxy
+
+    ## CONFIGURATION ##
 
-    # Initializes the client object.
     def initialize(options = {})
       options = {
         :scheme => 'http',
@@ -14,6 +16,7 @@ module Pusher
       @scheme, @host, @port, @app_id, @key, @secret = options.values_at(
         :scheme, :host, :port, :app_id, :key, :secret
       )
+      self.http_proxy = options[:http_proxy] if options[:http_proxy]
     end
 
     # @private Returns the authentication token for the client
@@ -47,6 +50,19 @@ module Pusher
       @port   = uri.port
     end
 
+    def http_proxy=(http_proxy)
+      @http_proxy = http_proxy
+      uri = URI.parse(http_proxy)
+      @proxy = {
+        :scheme => uri.scheme,
+        :host => uri.host,
+        :port => uri.port,
+        :user => uri.user,
+        :password => uri.password
+      }
+      @http_proxy
+    end
+
     # Configure whether Pusher API calls should be made over SSL
     # (default false)
     #
@@ -59,6 +75,83 @@ module Pusher
       @port = boolean ? 443 : 80
     end
 
+    def encrypted?
+      @scheme == 'https'
+    end
+
+    ## INTERACE WITH THE API ##
+
+    def resource(path)
+      Resource.new(self, path)
+    end
+
+    # GET arbitrary REST API resource using a synchronous http client.
+    # All request signing is handled automatically.
+    #
+    # @example
+    #   begin
+    #     Pusher.get('/channels', filter_by_prefix: 'private-')
+    #   rescue Pusher::Error => e
+    #     # Handle error
+    #   end
+    #
+    # @param path [String] Path excluding /apps/APP_ID
+    # @param params [Hash] API params (see http://pusher.com/docs/rest_api)
+    #
+    # @return [Hash] See Pusher API docs
+    #
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside Net::HTTP. The original error is wrapped in error.original_error
+    #
+    def get(path, params = {})
+      Resource.new(self, path).get(params)
+    end
+
+    # GET arbitrary REST API resource using an asynchronous http client.
+    # All request signing is handled automatically.
+    #
+    # @example
+    #   Pusher.get_async('/channels', {
+    #     filter_by_prefix: 'private-'
+    #   }).callback { |response_hash|
+    #     # ...
+    #   }.errback { |error|
+    #     # error is a instance of Pusher::Error
+    #   }
+    #
+    # @param path [String] Path excluding /apps/APP_ID
+    # @param params [Hash] API params (see http://pusher.com/docs/rest_api)
+    #
+    # @return [EM::DefaultDeferrable]
+    #
+    def get_async(path, params = {})
+      Resource.new(self, path).get_async(params)
+    end
+
+    # POST arbitrary REST API resource using a synchronous http client.
+    # Works identially to get method, but posts params as JSON in post body.
+    def post(path, params = {})
+      Resource.new(self, path).post(params)
+    end
+
+    # POST arbitrary REST API resource using an asynchronous http client.
+    # Works identially to get_async method, but posts params as JSON in post
+    # body.
+    def post_async(path, params = {})
+      Resource.new(self, path).post_async(params)
+    end
+
+    ## HELPER METHODS ##
+
+    # Convenience method for creating a new WebHook instance for validating
+    # and extracting info from a received WebHook
+    #
+    # @param request [Rack::Request] Either a Rack::Request or a Hash containing :key, :signature, :body, and optionally :content_type.
+    #
+    def webhook(request)
+      WebHook.new(request, self)
+    end
+
     # Return a convenience channel object by name. No API request is made.
     #
     # @example
@@ -66,25 +159,26 @@ module Pusher
     # @return [Channel]
     # @raise [ConfigurationError] unless key, secret and app_id have been
     #   configured
-    def [](channel_name)
+    def channel(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)
+      Channel.new(url, channel_name, self)
     end
 
+    alias :[] :channel
+
     # Request a list of occupied channels from the API
     #
     # GET /apps/[id]/channels
     #
-    # @param options [Hash] Hash of options for the API - see Pusher API docs
+    # @param params [Hash] Hash of parameters for the API - see REST API docs
+    #
     # @return [Hash] See Pusher API docs
-    # @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 channels(options = {})
-      @_channels_url ||= url('/channels')
-      request = Request.new(:get, @_channels_url, options, nil, nil, self)
-      return request.send_sync
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside Net::HTTP. The original error is wrapped in error.original_error
+    #
+    def channels(params = {})
+      get('/channels', params)
     end
 
     # Request info for a specific channel
@@ -92,31 +186,98 @@ module Pusher
     # GET /apps/[id]/channels/[channel_name]
     #
     # @param channel_name [String] Channel name
-    # @param options [Hash] Hash of options for the API - see Pusher API docs
+    # @param params [Hash] Hash of parameters for the API - see REST API docs
+    #
     # @return [Hash] See Pusher API docs
-    # @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 channel_info(channel_name, options = {})
-      request = Request.new(:get, url("/channels/#{channel_name}"), options, nil, nil, self)
-      return request.send_sync
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside Net::HTTP. The original error is wrapped in error.original_error
+    #
+    def channel_info(channel_name, params = {})
+      get("/channels/#{channel_name}", params)
     end
 
     # Trigger an event on one or more channels
     #
     # POST /apps/[app_id]/events
     #
-    # @param channels [Array] One of more channel names
+    # @param channels [String or Array] One of more channel names
     # @param event_name [String]
     # @param data [Object] Event data to be triggered in javascript.
     #   Objects other than strings will be converted to JSON
-    # @param options [Hash] Additional options to send to api, e.g socket_id
+    # @param params [Hash] Additional parameters to send to api, e.g socket_id
+    #
     # @return [Hash] See Pusher API docs
-    # @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(channels, event_name, data, options = {})
-      @_trigger_url ||= url('/events')
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside Net::HTTP. The original error is wrapped in error.original_error
+    #
+    def trigger(channels, event_name, data, params = {})
+      post('/events', trigger_params(channels, event_name, data, params))
+    end
+
+    # Trigger an event on one or more channels asynchronously.
+    # For parameters see #trigger
+    #
+    def trigger_async(channels, event_name, data, params = {})
+      post_async('/events', trigger_params(channels, event_name, data, params))
+    end
+
+    # @private Construct a net/http http client
+    def net_http_client
+      @_http_sync ||= begin
+        if encrypted?
+          require 'net/https' unless defined?(Net::HTTPS)
+        else
+          require 'net/http' unless defined?(Net::HTTP)
+        end
+
+        http_klass = if (p = @proxy)
+          Net::HTTP.Proxy(p[:host], p[:port], p[:user], p[:password])
+        else
+          Net::HTTP
+        end
+
+        http = http_klass.new(@host, @port)
+
+        if encrypted?
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        http
+      end
+    end
+
+    # @private Construct an em-http-request http client
+    def em_http_client(uri)
+      begin
+        unless defined?(EventMachine) && EventMachine.reactor_running?
+          raise Error, "In order to use async calling you must be running inside an eventmachine loop"
+        end
+        require 'em-http' unless defined?(EventMachine::HttpRequest)
+
+        connection_opts = {}
+
+        if @proxy
+          proxy_opts = {
+            :host => @proxy[:host],
+            :port => @proxy[:port]
+          }
+          if @proxy[:user]
+            proxy_opts[:authorization] = [@proxy[:user], @proxy[:password]]
+          end
+          connection_opts[:proxy] = proxy_opts
+        end
+
+        EventMachine::HttpRequest.new(uri, connection_opts)
+      end
+    end
+
+    private
+
+    def trigger_params(channels, event_name, data, params)
+      channels = [channels] if channels.kind_of?(String)
 
       encoded_data = case data
       when String
@@ -130,18 +291,13 @@ module Pusher
         end
       end
 
-      options.merge!({
+      return params.merge({
         :name => event_name,
         :channels => channels,
         :data => encoded_data,
       })
-
-      request = Request.new(:post, @_trigger_url, {}, MultiJson.encode(options), nil, self)
-      return request.send_sync
     end
 
-    private
-
     def configured?
       host && scheme && key && secret && app_id
     end