Class: PusherClient::Socket

Inherits:
Object
  • Object
show all
Defined in:
lib/pusher-client/socket.rb

Constant Summary collapse

CLIENT_ID = 
'pusher-ruby-client'
PROTOCOL = 
'5'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_key, options = {}) ⇒ Socket

Returns a new instance of Socket.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/pusher-client/socket.rb', line 13

def initialize(app_key, options={})
  raise "Missing app_key" unless app_key && !app_key.empty?

  @path = "#{options[:ws_path]}/app/#{app_key}?client=#{CLIENT_ID}&version=#{PusherClient::VERSION}&protocol=#{PROTOCOL}"
  @key = app_key
  @secret = options[:secret]
  @socket_id = nil
  @channels = Channels.new
  @global_channel = Channel.new('pusher_global_channel')
  @global_channel.global = true
  @connected = false
  @encrypted = options[:encrypted] || false
  @private_auth_method = options[:private_auth_method]
  @cert_file = options[:cert_file]
  @ws_host = options[:ws_host] || HOST
  @ws_port = options[:ws_port] || WS_PORT
  @wss_port = options[:wss_port] || WSS_PORT
  @ssl_verify = options.fetch(:ssl_verify) { true }

  bind('pusher:connection_established') do |data|
    socket = parser(data)
    @connected = true
    @socket_id = socket['socket_id']
    subscribe_all
  end

  bind('pusher:connection_disconnected') do |data|
    @channels.channels.each { |c| c.disconnect }
  end

  bind('pusher:error') do |data|
    PusherClient.logger.fatal("Pusher : error : #{data.inspect}")
  end

  # Keep this in case we're using a websocket protocol that doesn't
  # implement ping/pong
  bind('pusher:ping') do
    send_event('pusher:pong', nil)
  end
end

Instance Attribute Details

#channels ⇒ Object (readonly)

Returns the value of attribute channels.



11
12
13
 
# File 'lib/pusher-client/socket.rb', line 11

def channels
  @channels
end

#connected ⇒ Object (readonly)

Returns the value of attribute connected.



11
12
13
 
# File 'lib/pusher-client/socket.rb', line 11

def connected
  @connected
end

#global_channel ⇒ Object (readonly)

Returns the value of attribute global_channel.



11
12
13
 
# File 'lib/pusher-client/socket.rb', line 11

def global_channel
  @global_channel
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



11
12
13
 
# File 'lib/pusher-client/socket.rb', line 11

def path
  @path
end

#socket_id ⇒ Object (readonly)

Returns the value of attribute socket_id.



11
12
13
 
# File 'lib/pusher-client/socket.rb', line 11

def socket_id
  @socket_id
end

Instance Method Details

#[](channel_name) ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/pusher-client/socket.rb', line 122

def [](channel_name)
  if @channels[channel_name]
    @channels[channel_name]
  else
    @channels << channel_name
  end
end

#authorize(channel, callback) ⇒ Object

auth for private and presence



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/pusher-client/socket.rb', line 137

def authorize(channel, callback)
  if is_private_channel(channel.name)
    auth_data = get_private_auth(channel)
  elsif is_presence_channel(channel.name)
    auth_data = get_presence_auth(channel)
    channel_data = @user_data
  end
  # could both be nil if didn't require auth
  callback.call(channel, auth_data, channel_data)
end

#authorize_callback(channel, auth_data, channel_data) ⇒ Object 



148
149
150
151
152
153
154
155
 
# File 'lib/pusher-client/socket.rb', line 148

def authorize_callback(channel, auth_data, channel_data)
  send_event('pusher:subscribe', {
    'channel' => channel.name,
    'auth' => auth_data,
    'channel_data' => channel_data
  })
  channel.acknowledge_subscription(nil)
end

#bind(event_name, &callback) ⇒ Object 



117
118
119
120
 
# File 'lib/pusher-client/socket.rb', line 117

def bind(event_name, &callback)
  @global_channel.bind(event_name, &callback)
  return self
end

#connect(async = false) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/pusher-client/socket.rb', line 54

def connect(async = false)
  if @encrypted
    url = "wss://#{@ws_host}:#{@wss_port}#{@path}"
  else
    url = "ws://#{@ws_host}:#{@ws_port}#{@path}"
  end
  PusherClient.logger.debug("Pusher : connecting : #{url}")

  @connection_thread = Thread.new {
    options     = {:ssl => @encrypted, :cert_file => @cert_file, :ssl_verify => @ssl_verify}
    @connection = PusherWebSocket.new(url, options)
    PusherClient.logger.debug "Websocket connected"

    loop do
      msg    = @connection.receive[0]
      next if msg.nil?
      params = parser(msg)
      next if params['socket_id'] && params['socket_id'] == self.socket_id

      send_local_event params['event'], params['data'], params['channel']
    end
  }

  @connection_thread.run
  @connection_thread.join unless async
  self
end

#disconnect ⇒ Object 



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/pusher-client/socket.rb', line 82

def disconnect
  if @connected
    PusherClient.logger.debug "Pusher : disconnecting"
    @connection.close
    @connection_thread.kill if @connection_thread
    @connected = false
  else
    PusherClient.logger.warn "Disconnect attempted... not connected"
  end
end

#get_presence_auth(channel) ⇒ Object 



175
176
177
178
179
 
# File 'lib/pusher-client/socket.rb', line 175

def get_presence_auth(channel)
  string_to_sign = @socket_id + ':' + channel.name + ':' + @user_data
  signature = hmac(@secret, string_to_sign)
  return "#{@key}:#{signature}"
end

#get_private_auth(channel) ⇒ Object 



165
166
167
168
169
170
171
172
173
 
# File 'lib/pusher-client/socket.rb', line 165

def get_private_auth(channel)
  if (@private_auth_method.nil?)
    string_to_sign = @socket_id + ':' + channel.name
    signature = hmac(@secret, string_to_sign)
    return "#{@key}:#{signature}"
  else
    return @private_auth_method.call(@socket_id, channel)
  end
end

#is_presence_channel(channel_name) ⇒ Object 



161
162
163
 
# File 'lib/pusher-client/socket.rb', line 161

def is_presence_channel(channel_name)
  channel_name.match(/^presence-/)
end

#is_private_channel(channel_name) ⇒ Object 



157
158
159
 
# File 'lib/pusher-client/socket.rb', line 157

def is_private_channel(channel_name)
  channel_name.match(/^private-/)
end

#send_event(event_name, data) ⇒ Object 



185
186
187
188
189
 
# File 'lib/pusher-client/socket.rb', line 185

def send_event(event_name, data)
  payload = {'event' => event_name, 'data' => data}.to_json
  @connection.send(payload)
  PusherClient.logger.debug("Pusher : sending event : #{payload}")
end

#subscribe(channel_name, user_data = nil) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/pusher-client/socket.rb', line 93

def subscribe(channel_name, user_data = nil)
  if user_data.is_a? Hash
    @user_data = user_data.to_json
  elsif not user_data.nil?
    @user_data = {:user_id => user_data}.to_json
  end

  channel = @channels << channel_name
  if @connected
    authorize(channel, method(:authorize_callback))
  end
  return channel
end

#subscribe_all ⇒ Object Also known as: subscribeAll 



130
131
132
133
134
 
# File 'lib/pusher-client/socket.rb', line 130

def subscribe_all
  @channels.channels.clone.each{ |k,v|
    subscribe(k)
  }
end

#unsubscribe(channel_name) ⇒ Object 



107
108
109
110
111
112
113
114
115
 
# File 'lib/pusher-client/socket.rb', line 107

def unsubscribe(channel_name)
  channel = @channels.remove channel_name
  if @connected
    send_event('pusher:unsubscribe', {
      'channel' => channel_name
    })
  end
  return channel
end