Class: SelfSDK::MessagingClient

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

Constant Summary collapse

DEFAULT_DEVICE = 
"1"
DEFAULT_AUTO_RECONNECT = 
true
DEFAULT_STORAGE_DIR = 
"./.self_storage"
ON_DEMAND_CLOSE_CODE = 
3999

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, client, options = {}) ⇒ MessagingClient

RestClient initializer

Parameters:

  • url (string) —

    self-messaging url

  • opts (Hash) —

    a customizable set of options



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/messaging.rb', line 30

def initialize(url, client, options = {})
  @mon = Monitor.new
  @url = url
  @messages = {}
  @acks = {}
  @type_observer = {}
  @uuid_observer = {}
  @jwt = client.jwt
  @client = client
  @ack_timeout = 60 # seconds
  @timeout = 120 # seconds
  @device_id = options.fetch(:device_id, DEFAULT_DEVICE)
  @auto_reconnect = options.fetch(:auto_reconnect, DEFAULT_AUTO_RECONNECT)
  @storage_dir = options.fetch(:storage_dir, DEFAULT_STORAGE_DIR)
  @offset_file = "#{@storage_dir}/#{@jwt.id}:#{@device_id}.offset"
  @offset = read_offset

  FileUtils.mkdir_p @storage_dir unless File.exist? @storage_dir

  if options.include? :ws
    @ws = options[:ws]
  else
    start
  end
end

Instance Attribute Details

#ack_timeout ⇒ Object

Returns the value of attribute ack_timeout.



21
22
23
 
# File 'lib/messaging.rb', line 21

def ack_timeout
  @ack_timeout
end

#client ⇒ Object

Returns the value of attribute client.



21
22
23
 
# File 'lib/messaging.rb', line 21

def client
  @client
end

#device_id ⇒ Object

Returns the value of attribute device_id.



21
22
23
 
# File 'lib/messaging.rb', line 21

def device_id
  @device_id
end

#jwt ⇒ Object

Returns the value of attribute jwt.



21
22
23
 
# File 'lib/messaging.rb', line 21

def jwt
  @jwt
end

#timeout ⇒ Object

Returns the value of attribute timeout.



21
22
23
 
# File 'lib/messaging.rb', line 21

def timeout
  @timeout
end

#type_observer ⇒ Object

Returns the value of attribute type_observer.



21
22
23
 
# File 'lib/messaging.rb', line 21

def type_observer
  @type_observer
end

#uuid_observer ⇒ Object

Returns the value of attribute uuid_observer.



21
22
23
 
# File 'lib/messaging.rb', line 21

def uuid_observer
  @uuid_observer
end

Instance Method Details

#add_acl_rule(payload) ⇒ Object

Allows incomming messages from the given identity



104
105
106
107
108
109
110
111
 
# File 'lib/messaging.rb', line 104

def add_acl_rule(payload)
  send_message Msgproto::AccessControlList.new(
    type: Msgproto::MsgType::ACL,
    id: SecureRandom.uuid,
    command: Msgproto::ACLCommand::PERMIT,
    payload: payload,
  )
end

#clean_observers ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/messaging.rb', line 201

def clean_observers
  live = {}
  @uuid_observer.clone.each do |id, msg|
    if msg[:timeout] < SelfSDK::Time.now
      message = SelfSDK::Messages::Base.new(self)
      message.status = "errored"

      @uuid_observer[id][:block].call(message)
      @uuid_observer.delete(id)
    else
      live[id] = msg
    end
  end
  @uuid_observer = live
end

#close ⇒ Object 



66
67
68
 
# File 'lib/messaging.rb', line 66

def close
  @ws.close(ON_DEMAND_CLOSE_CODE, "connection closed by the client")
end

#list_acl_rules ⇒ Object

Lists acl rules



126
127
128
129
130
131
132
133
134
 
# File 'lib/messaging.rb', line 126

def list_acl_rules
  wait_for 'acl_list' do
    send_raw Msgproto::AccessControlList.new(
      type: Msgproto::MsgType::ACL,
      id: SecureRandom.uuid,
      command: Msgproto::ACLCommand::LIST,
    )
  end
end

#notify_observer(message) ⇒ Object

Notify the type observer for the given message



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/messaging.rb', line 218

def notify_observer(message)
  if @uuid_observer.include? message.id
    observer = @uuid_observer[message.id]
    message.validate!(observer[:original_message]) if observer.include?(:original_message)
    Thread.new do
      @uuid_observer[message.id][:block].call(message)
      @uuid_observer.delete(message.id)
    end
    return
  end

  # Return if there is no observer setup for this kind of message
  return unless @type_observer.include? message.typ

  Thread.new do
    @type_observer[message.typ][:block].call(message)
  end
end

#remove_acl_rule(payload) ⇒ Object

Blocks incoming messages from specified identities



116
117
118
119
120
121
122
123
 
# File 'lib/messaging.rb', line 116

def remove_acl_rule(payload)
  send_message Msgproto::AccessControlList.new(
    type: Msgproto::MsgType::ACL,
    id: SecureRandom.uuid,
    command: Msgproto::ACLCommand::REVOKE,
    payload: payload,
  )
end

#send_and_wait_for_response(msg, original) ⇒ Object

Sends a message and waits for the response



139
140
141
142
143
 
# File 'lib/messaging.rb', line 139

def send_and_wait_for_response(msg, original)
  wait_for msg.id, original do
    send_message msg
  end
end

#send_custom(recipient, request_body) ⇒ Object

Send custom mmessage

Parameters:

  • recipient (string) —

    selfID to be requested

  • type (string) —

    message type

  • request (hash) —

    original message requesing information



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/messaging.rb', line 90

def send_custom(recipient, request_body)
    @to_device = @client.devices(recipient).first
    send_message msg = Msgproto::Message.new(
      type: Msgproto::MsgType::MSG,
      id: SecureRandom.uuid,
      sender: "#{@jwt.id}:#{@device_id}",
      recipient: "#{recipient}:#{@to_device}",
      ciphertext: @jwt.prepare(request_body),
    )
end

#send_message(msg) ⇒ Object

Send a message through self network



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/messaging.rb', line 178

def send_message(msg)
  uuid = msg.id
  @mon.synchronize do
    @acks[uuid] = {
      waiting_cond: @mon.new_cond,
      waiting: true,
      timeout: SelfSDK::Time.now + @ack_timeout,
    }
  end
  send_raw(msg)
  SelfSDK.logger.info "waiting for acknowledgement #{uuid}"
  @mon.synchronize do
    @acks[uuid][:waiting_cond].wait_while do
      @acks[uuid][:waiting]
    end
  end
  SelfSDK.logger.info "acknowledged #{uuid}"
  true
ensure
  @acks.delete(uuid)
  false
end

#set_observer(original, options = {}, &block) ⇒ Object 



237
238
239
240
 
# File 'lib/messaging.rb', line 237

def set_observer(original, options = {}, &block)
  request_timeout = options.fetch(:timeout, @timeout)
  @uuid_observer[original.id] = { original_message: original, block: block, timeout: SelfSDK::Time.now + request_timeout }
end

#share_information(recipient, recipient_device, request) ⇒ Object

Responds a request information request

Parameters:

  • recipient (string) —

    selfID to be requested

  • recipient_device (string) —

    device id for the selfID to be requested

  • request (string) —

    original message requesing information



75
76
77
78
79
80
81
82
83
 
# File 'lib/messaging.rb', line 75

def share_information(recipient, recipient_device, request)
  send_message Msgproto::Message.new(
    type: Msgproto::MsgType::MSG,
    id: SecureRandom.uuid,
    sender: "#{@jwt.id}:#{@device_id}",
    recipient: "#{recipient}:#{recipient_device}",
    ciphertext: @jwt.prepare(request),
  )
end

#stop ⇒ Object 



56
57
58
59
60
61
62
63
64
 
# File 'lib/messaging.rb', line 56

def stop
  @acks.each do |k, _v|
    mark_as_acknowledged(k)
  end
  @messages.each do |k, _v|
    mark_as_acknowledged(k)
    mark_as_arrived(k)
  end
end

#subscribe(type, &block) ⇒ Object 



242
243
244
245
 
# File 'lib/messaging.rb', line 242

def subscribe(type, &block)
  type = SelfSDK::message_type(type) if type.is_a? Symbol
  @type_observer[type] = { block: block }
end

#wait_for(uuid, msg = nil) ⇒ Object

Executes the given block and waits for the message id specified on the uuid.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/messaging.rb', line 149

def wait_for(uuid, msg = nil)
  SelfSDK.logger.info "sending #{uuid}"
  @mon.synchronize do
    @messages[uuid] = {
      waiting_cond: @mon.new_cond,
      waiting: true,
      timeout: SelfSDK::Time.now + @timeout,
      original_message: msg,
    }
  end

  yield

  SelfSDK.logger.info "waiting for client to respond #{uuid}"
  @mon.synchronize do
    @messages[uuid][:waiting_cond].wait_while do
      @messages[uuid][:waiting]
    end
  end

  SelfSDK.logger.info "response received for #{uuid}"
  @messages[uuid][:response]
ensure
  @messages.delete(uuid)
end