Class: Pusher::Channel

Inherits:
Object
  • Object
show all
Defined in:
lib/pusher/channel.rb

Overview

Trigger events on Channels

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url, name, client = Pusher) ⇒ Channel

Returns a new instance of Channel.



9
10
11
12
13
14
 
# File 'lib/pusher/channel.rb', line 9

def initialize(base_url, name, client = Pusher)
  @uri = base_url.dup
  @uri.path = @uri.path + "/channels/#{name}/"
  @name = name
  @client = client
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/pusher/channel.rb', line 7

def name
  @name
end

Instance Method Details

#authenticate(socket_id, custom_data = nil) ⇒ Hash

Generate an authentication endpoint response

Examples:

Private channels

render :json => Pusher['private-my_channel'].authenticate(params[:socket_id])

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
  }
})

Parameters:

  • socket_id (String)
  • custom_data (Hash) (defaults to: nil) —

    used for example by private channels

Returns:

  • (Hash) 


124
125
126
127
128
129
130
 
# File 'lib/pusher/channel.rb', line 124

def authenticate(socket_id, custom_data = nil)
  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
  r
end

#authentication_string(socket_id, custom_string = nil) ⇒ String Also known as: socket_auth

Compute authentication string required to subscribe to this channel.

See pusher.com/docs/auth_signatures for more details.

Parameters:

  • socket_id (String) —

    Each Pusher socket connection receives a unique socket_id. This is sent from pusher.js to your server when channel authentication is required.

  • custom_string (String) (defaults to: nil) —

    Allows signing additional data

Returns:

  • (String) 


87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/pusher/channel.rb', line 87

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)

  string_to_sign = [socket_id, name, custom_string].compact.map{|e|e.to_s}.join(':')
  Pusher.logger.debug "Signing #{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

#stats ⇒ Hash

Request channel stats

Returns:

  • (Hash) —

    See Pusher api docs for reported stats

Raises:

  • (Pusher::Error) —

    on invalid Pusher response - see the error message for more details

  • (Pusher::HTTPError) —

    on any error raised inside Net::HTTP - the original error is available in the original_error attribute



72
73
74
75
 
# File 'lib/pusher/channel.rb', line 72

def stats
  request = Pusher::Request.new(:get, @uri + 'stats', {}, nil, nil, @client)
  return request.send_sync
end

#trigger(event_name, data, socket_id = nil) ⇒ Object

Note:

CAUTION! No exceptions will be raised on failure

Trigger event, catching and logging any errors.

Parameters:



59
60
61
62
63
64
 
# File 'lib/pusher/channel.rb', line 59

def trigger(event_name, data, socket_id = nil)
  trigger!(event_name, data, socket_id)
rescue Pusher::Error => e
  Pusher.logger.error("#{e.message} (#{e.class})")
  Pusher.logger.debug(e.backtrace.join("\n"))
end

#trigger!(event_name, data, socket_id = nil) ⇒ Object

Trigger event

Examples:

begin
  Pusher['my-channel'].trigger!('an_event', {:some => 'data'})
rescue Pusher::Error => e
  # Do something on error
end

Parameters:

Raises:

  • (Pusher::Error) —

    on invalid Pusher response - see the error message for more details

  • (Pusher::HTTPError) —

    on any error raised inside Net::HTTP - the original error is available in the original_error attribute



49
50
51
52
 
# File 'lib/pusher/channel.rb', line 49

def trigger!(event_name, data, socket_id = nil)
  request = construct_event_request(event_name, data, socket_id)
  request.send_sync
end

#trigger_async(event_name, data, socket_id = nil, &block) ⇒ EM::DefaultDeferrable

Trigger event asynchronously using EventMachine::HttpRequest

Parameters:

Returns:

  • (EM::DefaultDeferrable) —

    Attach a callback to be notified of success (with no parameters). Attach an errback to be notified of failure (with an error parameter which includes the HTTP status code returned)

Raises:

  • (LoadError) —

    unless em-http-request gem is available

  • (Pusher::Error) —

    unless the eventmachine reactor is running. You probably want to run your application inside a server such as thin



27
28
29
30
 
# File 'lib/pusher/channel.rb', line 27

def trigger_async(event_name, data, socket_id = nil, &block)
  request = construct_event_request(event_name, data, socket_id)
  request.send_async
end