adafruit-io 2.0.0.beta.2 → 2.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4297937d68a3bd1575e457d6b9c9f4d6ed5eb70
-  data.tar.gz: e65ddd98403a46d3ef723644a46a6d8cdc3a620d
+  metadata.gz: 82354463cf584413ee421f62dc087fa182b191a3
+  data.tar.gz: 7569063a8a78d7c97189a66bf89894f8c0f089dd
 SHA512:
-  metadata.gz: e2a5fa45df7fb98c03a306c9aa4b7c9258fdd4fbe0797aa237dda61db075ffbcf389e2e40c9da075a1db099b0e87fdc6f4e5804caada82813b96f8e07782266b
-  data.tar.gz: 82d5d3d829434e7c108b155cc6c8d573b62d76d8b48267d85c559e0695098380ce2138b32e0772ab381258a10077fead91597cbef8f3dfd6bc60f35d8d62eb09
+  metadata.gz: d3dd1a6feec6e1804a08c0b5a805fb2053d35a4854acd354e018dc5f2815cb57454c7fb433eaf01be3ce1578f4e65a60b5b531aec8bcc69b6811d327c466fc23
+  data.tar.gz: 69e5cdb283b4d8d615fc3c575d0df498f82ecd04c1933b90f3d507a1cdd4c6983fcef7506040d226f60d788f3c2f10195351ce77ab31a877c678a838ab6e0db3

data/README.md

@@ -25,14 +25,14 @@ It is our goal to eventually support all API V2 methods, but that will happen in
 - [x] Feeds `2.0.0.beta.1`
 - [x] Data `2.0.0.beta.1`
 - [x] Groups `2.0.0.beta.1`
-- Activities
-- Blocks
-- Dashboards
-- MQTT
-- Permissions
-- Sessions
-- Tokens
-- Triggers
+- [x] MQTT `2.0.0.beta.3`
+- [] Activities
+- [] Blocks
+- [] Dashboards
+- [] Permissions
+- [] Sessions
+- [] Tokens
+- [] Triggers
 
 ## Installation
 

data/adafruit-io.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday", "~> 0.8"
   spec.add_dependency "faraday_middleware", "~> 0.9"
   spec.add_dependency "activesupport",  "~> 4.2"
+  spec.add_dependency "mqtt", "~> 0.4"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.4"

data/lib/adafruit/io.rb

@@ -1,4 +1,5 @@
 require "adafruit/io/client"
+require "adafruit/io/mqtt"
 require "adafruit/io/version"
 
 module Adafruit

data/lib/adafruit/io/client.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'uri'
 
 require 'faraday'
 require 'faraday_middleware'
@@ -71,10 +70,30 @@ module Adafruit
       end
 
       def api_url(username, *args)
-        to_join = ['api', 'v2', username].concat(args)
+        safe_path_join *['api', 'v2', username].concat(args)
+      end
+
+      # safely build URL paths from segments
+      def safe_path_join(*paths)
+        paths = paths.compact.reject(&:empty?)
+        last = paths.length - 1
+        paths.each_with_index.map { |path, index|
+          safe_path_expand(path, index, last)
+        }.join
+      end
+
+      def safe_path_expand(path, current, last)
+        if path[0] === '/' && current != 0
+          path = path[1..-1]
+        end
+
+        unless path[-1] === '/' || current == last
+          path = [path, '/']
+        end
 
-        File.join(*to_join)
+        path
       end
+
     end
   end
 end

data/lib/adafruit/io/mqtt.rb

@@ -0,0 +1,199 @@
+require 'mqtt'
+
+#
+# Adafruit::IO::MQTT provides a simple Adafruit IO aware wrapper around the
+# Ruby MQTT library at https://github.com/njh/ruby-mqtt.
+#
+# Our primary goal is to provide basic MQTT access to feeds.
+#
+# For example, publishing to a feed is as simple as:
+#
+#     mqtt = Adafruit::IO::MQTT.new user, key
+#     mqtt.publish('feed-key', 1)
+#
+# And subscribing to a feed is just as easy:
+#
+#     mqtt = Adafruit::IO::MQTT.new user, key
+#     mqtt.subscribe('feed-key')
+#     mqtt.get do |topic, value|
+#       puts "GOT VALUE FROM #{topic}: #{value}"
+#     end
+#
+# If you need to access different MQTT endpoints or data formats (JSON, CSV)
+# you can use the MQTT library directly:
+#
+#     mqtt = Adafruit::IO::MQTT.new user, key
+#     mqtt.client.get("#{user}/groups/group-key/json") do |topic, message|
+#       payload = JSON.parse(message)
+#       # etc...
+#     end
+#
+# Documentation for Ruby MQTT is available at http://www.rubydoc.info/gems/mqtt/MQTT/Client
+#
+module Adafruit
+  module IO
+    class MQTT
+
+      # provide access to the raw MQTT library client
+      attr_reader :client
+
+      def initialize(username, key, opts={})
+        @options = {
+          uri: 'io.adafruit.com',
+          protocol: 'mqtts',
+          port: 8883,
+          username: username,
+          key: key
+        }.merge(opts)
+
+        @connect_uri = "%{protocol}://%{username}:%{key}@%{uri}" % @options
+
+        connect
+      end
+
+      def connect
+        if @client.nil? || !@client.connected?
+          @client = ::MQTT::Client.connect @connect_uri, @options[:port], ack_timeout: 10
+        end
+      end
+
+      def disconnect
+        if @client && @client.connected?
+          @client.disconnect
+        end
+      end
+
+      # Publish value to feed with given key
+      def publish(key, value, location={})
+        raise 'client is not connected' unless @client.connected?
+
+        topic = key_to_feed_topic(key)
+        location = indifferent_keys(location)
+        payload = payload_from_value_with_location(value, location)
+
+        @client.publish(topic, payload)
+      end
+
+      # Publish to multiple feeds within a group.
+      #
+      # - `key` is a group key
+      # - `values` is a hash where keys are feed keys and values are the
+      #   published value.
+      # - `location` is the optional { :lat, :lon, :ele } hash specifying the
+      #   location data for this publish event.
+      #
+      def publish_group(key, values, location={})
+        raise 'client is not connected' unless @client.connected?
+        raise 'values must be a hash' unless values.is_a?(Hash)
+
+        topic = key_to_group_topic(key, false)
+        location = indifferent_keys(location)
+        payload = payload_from_values_with_location(values, location)
+
+        @client.publish(topic, payload)
+      end
+
+      # Subscribe to the feed with the given key. Use .get to retrieve messages
+      # from subscribed feeds.
+      def subscribe(key)
+        raise 'client is not connected' unless @client.connected?
+
+        topic = key_to_feed_topic(key)
+        @client.subscribe(topic)
+      end
+
+      def unsubscribe(key)
+        raise 'client is not connected' unless @client.connected?
+
+        topic = key_to_feed_topic(key)
+        @client.unsubscribe(topic)
+      end
+
+      # Subscribe to a group with the given key.
+      #
+      # NOTE: Unlike feed subscriptions, group subscriptions return a JSON
+      # representation of the group record with a 'feeds' property containing a
+      # JSON object whose keys are feed keys and whose values are the last
+      # value received for that feed.
+      def subscribe_group(key)
+        raise 'client is not connected' unless @client.connected?
+
+        topic = key_to_group_topic(key)
+        @client.subscribe(topic)
+      end
+
+      # Retrieve the last value received from the MQTT connection for any
+      # subscribed feeds or groups. This is a blocking method, which means it
+      # won't return until a message is retrieved.
+      #
+      # Returns [topic, message] or yields it into the given block.
+      #
+      # With no block:
+      #
+      #   mqtt_client.subscribe('feed-key')
+      #   loop do
+      #     topic, message = mqtt_client.get
+      #     # do something
+      #   end
+      #
+      # With a block:
+      #
+      #   mqtt_client.subscribe('feed-key')
+      #   mqtt_client.get do |topic, message|
+      #     # do something
+      #   end
+      #
+      # NOTE: if a feed already has a value, subscribing and calling get will
+      # immediately return the most recent value for the subscription,
+      # regardless of when it was received by IO.
+      def get(&block)
+        @client.get(&block)
+      end
+
+      private
+
+      def key_to_feed_topic(key)
+        "%s/f/%s" % [@options[:username], key]
+      end
+
+      def key_to_group_topic(key, json=true)
+        "%s/g/%s%s" % [@options[:username], key, (json ? '/json' : '')]
+      end
+
+      def payload_from_value_with_location(value, location)
+        payload = { value: value.to_s }
+
+        if location.has_key?('lat') && location.has_key?['lon']
+          %w(lat lon ele).each do |f|
+            payload[f] = location[f]
+          end
+        end
+
+        JSON.generate payload
+      end
+
+      def payload_from_values_with_location(values, location)
+        payload = { feeds: values }
+
+        if location.has_key?('lat') && location.has_key?['lon']
+          payload[:location] = {}
+
+          %w(lat lon ele).each do |f|
+            payload[:location][f] = location[f]
+          end
+        end
+
+        JSON.generate payload
+      end
+
+      def indifferent_keys(hash)
+        hash.keys.inject({}) {|new_hash, key|
+          new_hash[key.to_s]   = hash[key]
+          new_hash[key.to_sym] = hash[key]
+
+          new_hash
+        }
+      end
+    end
+  end
+end

data/lib/adafruit/io/version.rb

@@ -1,5 +1,5 @@
 module Adafruit
   module IO
-    VERSION = "2.0.0.beta.2"
+    VERSION = "2.0.0.beta.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adafruit-io
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.2
+  version: 2.0.0.beta.3
 platform: ruby
 authors:
 - Justin Cooper
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +114,7 @@ files:
 - lib/adafruit/io/client/groups.rb
 - lib/adafruit/io/client/tokens.rb
 - lib/adafruit/io/configurable.rb
+- lib/adafruit/io/mqtt.rb
 - lib/adafruit/io/request_handler.rb
 - lib/adafruit/io/version.rb
 homepage: https://github.com/adafruit/io-client-ruby