scout 5.7.1 → 5.7.2.pre

data/vendor/pusher/lib/pusher.rb

@@ -0,0 +1,60 @@
+autoload 'Logger', 'logger'
+require 'uri'
+require 'forwardable'
+
+require 'pusher/client'
+
+# Used for configuring API credentials and creating Channel objects
+#
+module Pusher
+  # All errors descend from this class so they can be easily rescued
+  #
+  # @example
+  #   begin
+  #     Pusher.trigger('channel_name', 'event_name, {:some => 'data'})
+  #   rescue Pusher::Error => e
+  #     # Do something on error
+  #   end
+  class Error < RuntimeError; end
+  class AuthenticationError < Error; end
+  class ConfigurationError < Error; end
+  class HTTPError < Error; attr_accessor :original_error; end
+
+  class << self
+    extend Forwardable
+
+    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, :timeout=, :connect_timeout=, :send_timeout=, :receive_timeout=, :keep_alive_timeout=
+
+    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
+
+    def logger
+      @logger ||= begin
+        log = Logger.new($stdout)
+        log.level = Logger::INFO
+        log
+      end
+    end
+
+    def default_client
+      @default_client ||= Pusher::Client.new
+    end
+  end
+
+  if ENV['PUSHER_URL']
+    self.url = ENV['PUSHER_URL']
+  end
+end
+
+require 'pusher/channel'
+require 'pusher/request'
+require 'pusher/resource'
+require 'pusher/webhook'

data/vendor/{pusher-gem → pusher}/lib/pusher/channel.rb

@@ -1,20 +1,23 @@
-require 'core_extensions'
-require 'hmac-sha2'
-require 'json'
+require 'openssl'
+require 'multi_json'
 
 module Pusher
   # Trigger events on Channels
   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
     #
+    # [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'})
@@ -44,15 +51,19 @@ module Pusher
     #   event - see http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients for more info
     #
     # @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
+    # @raise [Pusher::HTTPError] on any error raised inside http client - 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!)
     #
@@ -62,21 +73,21 @@ module Pusher
       Pusher.logger.error("#{e.message} (#{e.class})")
       Pusher.logger.debug(e.backtrace.join("\n"))
     end
-    
-    # Request channel stats
+
+    # Request info for a channel
     #
-    # @return [Hash] See Pusher api docs for reported stats
+    # @param info [Array] Array of attributes required (as lowercase strings)
+    # @return [Hash] Hash of requested attributes for this channel
     # @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
+    # @raise [Pusher::HTTPError] on any error raised inside http client - the original error is available in the original_error attribute
     #
-    def stats
-      request = Pusher::Request.new(:get, @uri + 'stats', {})
-      return request.send_sync
+    def info(attributes = [])
+      @client.get("/channels/#{name}", :info => attributes.join(','))
     end
 
-    # Compute authentication string required to subscribe to this channel.
-    #
-    # See http://pusher.com/docs/auth_signatures for more details.
+    # Compute authentication string required as part of the authentication
+    # endpoint response. Generally the authenticate method should be used in
+    # preference to this one
     #
     # @param socket_id [String] Each Pusher socket connection receives a
     #   unique socket_id. This is sent from pusher.js to your server when
@@ -85,21 +96,26 @@ module Pusher
     # @return [String]
     #
     def authentication_string(socket_id, custom_string = nil)
-      raise "Invalid socket_id" if socket_id.nil? || socket_id.empty?
-      raise 'Custom argument must be a string' unless custom_string.nil? || custom_string.kind_of?(String)
+      if socket_id.nil? || socket_id.empty?
+        raise Error, "Invalid socket_id #{socket_id}"
+      end
 
-      string_to_sign = [socket_id, name, custom_string].compact.map{|e|e.to_s}.join(':')
+      unless custom_string.nil? || custom_string.kind_of?(String)
+        raise Error, 'Custom argument must be a string'
+      end
+
+      string_to_sign = [socket_id, name, custom_string].
+        compact.map(&:to_s).join(':')
       Pusher.logger.debug "Signing #{string_to_sign}"
-      token = Pusher.authentication_token
-      signature = HMAC::SHA256.hexdigest(token.secret, string_to_sign)
+      token = @client.authentication_token
+      digest = OpenSSL::Digest::SHA256.new
+      signature = OpenSSL::HMAC.hexdigest(digest, token.secret, string_to_sign)
 
       return "#{token.key}:#{signature}"
     end
-    
-    # Deprecated - for backward compatibility
-    alias :socket_auth :authentication_string
 
-    # Generate an authentication endpoint response
+    # Generate the expected response for an authentication endpoint.
+    # See http://pusher.com/docs/authenticating_users for details.
     #
     # @example Private channels
     #   render :json => Pusher['private-my_channel'].authenticate(params[:socket_id])
@@ -121,34 +137,11 @@ module Pusher
     # @private Custom data is sent to server as JSON-encoded string
     #
     def authenticate(socket_id, custom_data = nil)
-      custom_data = custom_data.to_json if custom_data
-      auth = socket_auth(socket_id, custom_data)
+      custom_data = MultiJson.encode(custom_data) if custom_data
+      auth = authentication_string(socket_id, custom_data)
       r = {:auth => auth}
       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
-          data.to_json
-        rescue Exception => e
-          Pusher.logger.error("Could not convert #{data.inspect} into JSON")
-          raise e
-        end
-      end
-
-      Pusher::Request.new(:post, @uri + 'events', params, body)
-    end
   end
 end

data/vendor/pusher/lib/pusher/client.rb

@@ -0,0 +1,306 @@
+require 'signature'
+
+module Pusher
+  class Client
+    attr_accessor :scheme, :host, :port, :app_id, :key, :secret
+    attr_reader :http_proxy, :proxy
+    attr_writer :connect_timeout, :send_timeout, :receive_timeout,
+                :keep_alive_timeout
+
+    ## CONFIGURATION ##
+
+    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
+      )
+      @http_proxy = nil
+      self.http_proxy = options[:http_proxy] if options[:http_proxy]
+
+      # Default timeouts
+      @connect_timeout = 5
+      @send_timeout = 5
+      @receive_timeout = 5
+      @keep_alive_timeout = 30
+    end
+
+    # @private Returns the authentication token for the client
+    def authentication_token
+      Signature::Token.new(@key, @secret)
+    end
+
+    # @private Builds a url for this app, optionally appending a path
+    def url(path = nil)
+      URI::Generic.build({
+        :scheme => @scheme,
+        :host => @host,
+        :port => @port,
+        :path => "/apps/#{@app_id}#{path}"
+      })
+    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
+
+    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)
+    #
+    # @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
+
+    def encrypted?
+      @scheme == 'https'
+    end
+
+    # Convenience method to set all timeouts to the same value (in seconds).
+    # For more control, use the individual writers.
+    def timeout=(value)
+      @connect_timeout, @send_timeout, @receive_timeout = value, value, value
+    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 http client. 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.
+    #
+    # When the eventmachine reactor is running, the em-http-request gem is used;
+    # otherwise an async request is made using httpclient. See README for
+    # details and examples.
+    #
+    # @param path [String] Path excluding /apps/APP_ID
+    # @param params [Hash] API params (see http://pusher.com/docs/rest_api)
+    #
+    # @return Either an EM::DefaultDeferrable or a HTTPClient::Connection
+    #
+    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
+    #   Pusher['my-channel']
+    # @return [Channel]
+    # @raise [ConfigurationError] unless key, secret and app_id have been
+    #   configured
+    def channel(channel_name)
+      raise ConfigurationError, 'Missing client configuration: please check that key, secret and app_id are configured.' unless configured?
+      Channel.new(url, channel_name, self)
+    end
+
+    alias :[] :channel
+
+    # Request a list of occupied channels from the API
+    #
+    # GET /apps/[id]/channels
+    #
+    # @param params [Hash] Hash of parameters for the API - see REST API docs
+    #
+    # @return [Hash] See Pusher API docs
+    #
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside http client. The original error is wrapped in error.original_error
+    #
+    def channels(params = {})
+      get('/channels', params)
+    end
+
+    # Request info for a specific channel
+    #
+    # GET /apps/[id]/channels/[channel_name]
+    #
+    # @param channel_name [String] Channel name
+    # @param params [Hash] Hash of parameters for the API - see REST API docs
+    #
+    # @return [Hash] See Pusher API docs
+    #
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside http client. 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 [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 params [Hash] Additional parameters to send to api, e.g socket_id
+    #
+    # @return [Hash] See Pusher API docs
+    #
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside http client. 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 sync_http_client
+      @client ||= begin
+        require 'httpclient'
+
+        HTTPClient.new(@http_proxy).tap do |c|
+          c.connect_timeout = @connect_timeout
+          c.send_timeout = @send_timeout
+          c.receive_timeout = @receive_timeout
+          c.keep_alive_timeout = @keep_alive_timeout
+        end
+      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 = {
+          :connect_timeout => @connect_timeout,
+          :inactivity_timeout => @receive_timeout,
+        }
+
+        if defined?(@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 = Array(channels).map(&:to_s)
+
+      encoded_data = 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
+
+      return params.merge({
+        :name => event_name,
+        :channels => channels,
+        :data => encoded_data,
+      })
+    end
+
+    def configured?
+      host && scheme && key && secret && app_id
+    end
+  end
+end