Class: PusherClient::Socket

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

Constant Summary collapse

CLIENT_ID =

Mimick the JavaScript client

'pusher-ruby-client'
VERSION = 
'1.7.1'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Socket.

Raises:

  • (ArgumentError) 


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
 
# File 'lib/pusher-client/socket.rb', line 15

def initialize(application_key, options={})
  raise ArgumentError if (!application_key.is_a?(String) || application_key.size < 1)

  @path = "/app/#{application_key}?client=#{CLIENT_ID}&version=#{VERSION}"
  @key = application_key
  @secret = options[:secret]
  @socket_id = nil
  @channels = Channels.new
  @global_channel = Channel.new('pusher_global_channel')
  @global_channel.global = true
  @secure = false
  @connected = false
  @encrypted = options[:encrypted] || false

  bind('pusher:connection_established') do |data|
    socket = JSON.parse(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
end

Instance Attribute Details

#channels ⇒ Object (readonly)

Returns the value of attribute channels.



13
14
15
 
# File 'lib/pusher-client/socket.rb', line 13

def channels
  @channels
end

#connected ⇒ Object (readonly)

Returns the value of attribute connected.



13
14
15
 
# File 'lib/pusher-client/socket.rb', line 13

def connected
  @connected
end

#encrypted ⇒ Object

Returns the value of attribute encrypted.



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

def encrypted
  @encrypted
end

#global_channel ⇒ Object (readonly)

Returns the value of attribute global_channel.



13
14
15
 
# File 'lib/pusher-client/socket.rb', line 13

def global_channel
  @global_channel
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



13
14
15
 
# File 'lib/pusher-client/socket.rb', line 13

def path
  @path
end

#secure ⇒ Object

Returns the value of attribute secure.



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

def secure
  @secure
end

#socket_id ⇒ Object (readonly)

Returns the value of attribute socket_id.



13
14
15
 
# File 'lib/pusher-client/socket.rb', line 13

def socket_id
  @socket_id
end

Instance Method Details

#[](channel_name) ⇒ Object 



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

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



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/pusher-client/socket.rb', line 124

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 



135
136
137
138
139
140
141
142
 
# File 'lib/pusher-client/socket.rb', line 135

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 



104
105
106
107
 
# File 'lib/pusher-client/socket.rb', line 104

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

#connect(async = false) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/pusher-client/socket.rb', line 45

def connect(async = false)
  if @encrypted || @secure
    url = "wss://#{HOST}:#{WSS_PORT}#{@path}"
  else
    url = "ws://#{HOST}:#{WS_PORT}#{@path}"
  end
  PusherClient.logger.debug("Pusher : connecting : #{url}")

  @connection_thread = Thread.new {
    options = {:ssl => @encrypted || @secure}
    @connection = WebSocket.new(url, options)
    PusherClient.logger.debug "Websocket connected"
    loop do
      msg = @connection.receive[0]
      params  = parser(msg)
      next if (params['socket_id'] && params['socket_id'] == self.socket_id)
      event_name   = params['event']
      event_data   = params['data']
      channel_name = params['channel']
      send_local_event(event_name, event_data, channel_name)
    end
  }

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

#disconnect ⇒ Object 



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/pusher-client/socket.rb', line 73

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 



158
159
160
161
162
 
# File 'lib/pusher-client/socket.rb', line 158

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

#get_private_auth(channel) ⇒ Object 



152
153
154
155
156
 
# File 'lib/pusher-client/socket.rb', line 152

def get_private_auth(channel)
  string_to_sign = @socket_id + ':' + channel.name
  signature = HMAC::SHA256.hexdigest(@secret, string_to_sign)
  return "#{@key}:#{signature}"
end

#is_presence_channel(channel_name) ⇒ Object 



148
149
150
 
# File 'lib/pusher-client/socket.rb', line 148

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

#is_private_channel(channel_name) ⇒ Object 



144
145
146
 
# File 'lib/pusher-client/socket.rb', line 144

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

#send_event(event_name, data) ⇒ Object 



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

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_id = nil) ⇒ Object 



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

def subscribe(channel_name, user_id = nil)
  @user_data = {:user_id => user_id}.to_json unless user_id.nil?

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

#subscribe_all ⇒ Object Also known as: subscribeAll 



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

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

#unsubscribe(channel_name) ⇒ Object 



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

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