ulms_client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba52d6503b8fac72ae0ccba8658904532c4c8cc768c9cab9d1fefa74636fb87d
-  data.tar.gz: feeaa8f3fa97611df57d9659c6cbdad15bc889f17b8efdd21dc7b8662b698170
+  metadata.gz: cce99c2fc29978656d0357a1b8f21ab17d9435b0acfd5405a6c49fac3d68ebf1
+  data.tar.gz: b0cce196c058ca68e613bde9a1d518bd021cdfcfccf5d4ece99cea8083e1b2d2
 SHA512:
-  metadata.gz: e036739ad4c4b6e3892d7e568c155daa52aaa993b450c2212327e868105839b4eafea90c18fd1b6ded174e5beafaf70dd92d6a735822d3279a09bac10f97b07d
-  data.tar.gz: 8914c2686be4477532d8a082c375e250d7034522ea012c3ec927c6da6e98949eb17bbc591d84b8fee3381d7c06855897db044024ec62cf65334d1d89f31ff482
+  metadata.gz: 44c9e62cc5a055bff6a5ce546f40dceca0b3884565cd60f15aea70dc544ff64d3149fdecb39627fccbefb2ccd4dfa1262c9f77726e46126369837aded5351f0a
+  data.tar.gz: a497e761a64ea4205cd7d276581ef85651843c99d233c1d41eec75c2d5bd6c114d2ac097d2dc1089e718796695bdb623acfb8605f6cbebee4695f2b176bdb512

data/lib/ulms_client.rb

@@ -39,30 +39,17 @@ class Agent
   end
 end
 
-class Client
-  attr_reader :version, :mode, :agent
-
-  def initialize(version:, mode:, agent:)
-    @version = version
-    @mode = mode
-    @agent = agent
-  end
-
-  def to_s
-    "#{@version}/#{@mode}/#{@agent}"
-  end
-end
-
 class Connection
-  OPTIONS = [:username, :password, :clean_session, :keep_alive]
+  OPTIONS = [:password, :clean_session, :keep_alive]
 
-  def initialize(host:, port:, client:, **kwargs)
-    @client = client
+  def initialize(host:, port:, mode:, agent:, **kwargs)
+    @agent = agent
 
     @mqtt = MQTT::Client.new
     @mqtt.host = host
     @mqtt.port = port
-    @mqtt.client_id = client.to_s
+    @mqtt.username = "v2::#{mode}"
+    @mqtt.client_id = agent.to_s
 
     OPTIONS.each do |option|
         @mqtt.send("#{option}=", kwargs[option]) if kwargs[option] != nil
@@ -72,13 +59,13 @@ class Connection
   # Establish the connection.
   def connect
     @mqtt.connect
-    LOG.info("#{@client} connected")
+    LOG.info("#{@agent} connected")
   end
 
   # Disconnect from the broker.
   def disconnect
     @mqtt.disconnect
-    LOG.info("#{@client} disconnected")
+    LOG.info("#{@agent} disconnected")
   end
 
   # Publish a message to the `topic`.
@@ -97,7 +84,7 @@ class Connection
     @mqtt.publish(topic, JSON.dump(envelope), retain, qos)
 
     LOG.info <<~EOF
-      #{@client.agent} published to #{topic} (q#{qos}, r#{retain ? 1 : 0}):
+      #{@agent} published to #{topic} (q#{qos}, r#{retain ? 1 : 0}):
       Payload: #{JSON.pretty_generate(payload)}
       Properties: #{JSON.pretty_generate(properties)}
     EOF
@@ -109,7 +96,7 @@ class Connection
   #   - `qos`: Subscriptions QoS. An interger 0..2.
   def subscribe(topic, qos: 0)
     @mqtt.subscribe([topic, qos])
-    LOG.info("#{@client.agent} subscribed to #{topic} (q#{qos})")
+    LOG.info("#{@agent} subscribed to #{topic} (q#{qos})")
   end
 
   # Waits for an incoming message.
@@ -126,7 +113,7 @@ class Connection
         message = IncomingMessage.new(topic, payload, envelope['properties'])
 
         LOG.info <<~EOF
-          #{@client.agent} received a message from topic #{topic}:
+          #{@agent} received a message from topic #{topic}:
           Payload: #{JSON.pretty_generate(message.payload)}
           Properties: #{JSON.pretty_generate(message.properties)}
         EOF
@@ -148,20 +135,21 @@ class Connection
   # Options:
   #   - `to`: the destination service `Account` (required).
   #   - `payload`: the publish message payload (required).
+  #   - `api_version`: service API version.
   #   - `properties`: additional MQTT properties hash.
   #   - `qos`: Publish QoS. An integer 0..2.
   #   - `timeout`: Timeout for the response awaiting.
-  def make_request(method, to:, payload:, properties: {}, qos: 0, timeout: DEFAULT_TIMEOUT)
+  def make_request(method, to:, payload:, api_version: 'v1', properties: {}, qos: 0, timeout: DEFAULT_TIMEOUT)
     correlation_data = SecureRandom.hex
 
     properties.merge!({
       type: 'request',
       method: method,
       correlation_data: correlation_data,
-      response_topic: "agents/#{@client.agent}/api/v1/in/#{to}"
+      response_topic: "agents/#{@agent}/api/#{api_version}/in/#{to}"
     })
 
-    topic = "agents/#{@client.agent}/api/v1/out/#{to}"
+    topic = "agents/#{@agent}/api/#{api_version}/out/#{to}"
     publish(topic, payload: payload, properties: properties, qos: qos)
 
     receive(timeout) do |msg|
@@ -203,28 +191,20 @@ def account(label, audience)
   Account.new(label, audience)
 end
 
-# Builds a `Client` instance.
-#
-# Options:
-#  - `mode`: Connection mode (required). Available values: `agents`, `service-agents`, `bridge-agents`, `observer-agents`.
-#  - `version`: Always `v1` for now.
-def client(agent, mode:, version: 'v1')
-  Client.new(version: version, mode: mode, agent: agent)
-end
-
 # Connects to the broker and subscribes to the client's inbox topics.
 #
 # Options:
 #   - `host`: The broker's host (required).
 #   - `port`: The broker's TCP port for MQTT connections (required).
-#   - `client`: The `Client` object (required).
-#   - `username`: If the broker has authn enabled this requires any non-empty string.
-#   - `password`: If the broker has authn enalbed this requires the password for the `client`'s account.
+#   - `agent`: The `Agent` object (required).
+#   - `mode`: Connection mode: default | service | bridge | observer.
+#   - `api_version`: agent's API version.
+#   - `password`: If the broker has authn enalbed this requires the password for the `agent`'s account.
 #   - `clean_session`: A boolean indicating whether the broker has to clean the previos session.
 #   - `keep_alive`: Keep alive time in seconds.
-def connect(host: 'localhost', port: 1883, client:, **kwargs)
-  conn = Connection.new(host: host, port: port, client: client, **kwargs)
+def connect(host: 'localhost', port: 1883, mode: 'default', agent:, api_version: 'v1', **kwargs)
+  conn = Connection.new(host: host, port: port, mode: mode, agent: agent, **kwargs)
   conn.connect
-  conn.subscribe("agents/#{client.agent}/api/v1/in/#")
+  conn.subscribe("agents/#{agent}/api/#{api_version}/in/#")
   conn
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ulms_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Timofey Martynov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2019-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt