adafruit-io 2.0.0.beta.5 → 2.0.0.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ed2fec0eb82155a7ad3f23f7ec4551688a58ea6
-  data.tar.gz: 6b4bd9d8f0aa88935e1027567699c2b073585c61
+  metadata.gz: 1eaa78ed8fc5921d2af4d16d7fa1defb321eecb2
+  data.tar.gz: 7ee9adca6975f86882faea7f6c40bcba3c91b74f
 SHA512:
-  metadata.gz: ec2ca90fccb200ca93be9de61fab6bf2b4f4cec7677d6ec84296c10f85c711627c30fca427bfcfc656da00d3e80aff8837698cc7b4c2f59e18b9184ce67efec3
-  data.tar.gz: 292aa24ca1b0313b54a1228c8bdaf8ab639cfa2860559c9f4c974f67e3ea79ed4b7b5b99f3b7d44e58f5061b2dc350f5343f069d47defb98687082c6fc8cad06
+  metadata.gz: c58dedbafaae234314a9e0dcddcb67fad758479fed2ad141a2956d247ff83ef037bc5f25805adbbd6110026611521c08fa326236183b9ea45d4eacd6f22a3a6f
+  data.tar.gz: 0fe5158a4d1a5523b4e4638ad29f3c194918171f1ae814285221f2328a4f9a1270678c86b181d19797e6e300666d5d2bfc663a2a8670f9bab0352fe5f520a725

data/README.md

@@ -31,7 +31,7 @@ It is our goal to eventually support all API V2 methods, but that will happen in
 - [x] Dashboards `2.0.0.beta.4`
 - [x] Activities `2.0.0.beta.5`
 - [x] Permissions `2.0.0.beta.5`
-- [] Triggers
+- [x] Triggers `2.0.0.beta.6`
 
 ## Installation
 
@@ -52,24 +52,22 @@ Or install it yourself as:
 Each time you use the library, you'll want to pass your [AIO Key][4] to the client.
 
 ```ruby
-
 require 'adafruit/io'
 
 # create an instance
 aio = Adafruit::IO::Client.new key: 'KEY'
 ```
 
-Since every API request requires a username, you can also pass a username to the client initializer.
+Since every API request requires a username, you can also pass a username to the client initializer to use it for every request.
 
 ```ruby
-
 require 'adafruit/io'
 
 # create an instance
 aio = Adafruit::IO::Client.new key: 'KEY', username: 'USERNAME'
 ```
 
-All return values are plain Ruby hashes based on the JSON response returned by the API. Most basic requests should get back a Hash with a `key` field. The key can be used in subsequent requests. API requests that return a list of objects will return a simple array of hashes.
+All return values are plain Ruby hashes based on the JSON response returned by the API. Most basic requests should get back a Hash with a `key` field. The key can be used in subsequent requests. API requests that return a list of objects will return a simple array of hashes. Feeds, Groups, and Dashboards all rely on the `key` value, other endpoints (Blocks, Permissions, Tokens, Triggers) use `id`.
 
 Here's an example of creating, adding data to, and deleting a feed.
 

data/lib/adafruit/io/client.rb

@@ -16,7 +16,7 @@ require 'adafruit/io/client/feeds'
 require 'adafruit/io/client/groups'
 require 'adafruit/io/client/permissions'
 require 'adafruit/io/client/tokens'
-
+require 'adafruit/io/client/triggers'
 require 'adafruit/io/client/user'
 
 module Adafruit
@@ -55,7 +55,7 @@ module Adafruit
       include Adafruit::IO::Client::Groups
       include Adafruit::IO::Client::Permissions
       include Adafruit::IO::Client::Tokens
-
+      include Adafruit::IO::Client::Triggers
       include Adafruit::IO::Client::User
 
       private

data/lib/adafruit/io/client/feeds.rb

@@ -30,7 +30,7 @@ module Adafruit
 
         def create_feed(*args)
           username, arguments = extract_username(args)
-          feed_attrs = arguments.shift
+          feed_attrs = valid_feed_attrs(arguments)
 
           post api_url(username, 'feeds'), feed_attrs
         end
@@ -45,13 +45,19 @@ module Adafruit
         def update_feed(*args)
           username, arguments = extract_username(args)
           feed_key = get_key_from_arguments(arguments)
+          feed_attrs = valid_feed_attrs(arguments)
+
+          put api_url(username, 'feeds', feed_key), feed_attrs
+        end
+
+        private
+
+        def valid_feed_attrs(arguments)
           query = get_query_from_arguments(
             arguments,
             %w(name key description unit_type unit_symbol history visibility
                license status_notify status_timeout)
           )
-
-          put api_url(username, 'feeds', feed_key), query
         end
 
       end

data/lib/adafruit/io/client/triggers.rb

@@ -0,0 +1,58 @@
+module Adafruit
+  module IO
+    class Client
+      module Triggers
+
+        # Get all triggers.
+        def triggers(*args)
+          username, _ = extract_username(args)
+
+          get api_url(username, 'triggers')
+        end
+
+        # Get a trigger specified by key
+        def trigger(*args)
+          username, arguments = extract_username(args)
+          trigger_id = get_id_from_arguments(arguments)
+
+          get api_url(username, 'triggers', trigger_id)
+        end
+
+        # Create a trigger. No attributes need to be passed in.
+        def create_trigger(*args)
+          username, arguments = extract_username(args)
+          attrs = valid_trigger_attrs(arguments)
+
+          post api_url(username, 'triggers'), attrs
+        end
+
+        def delete_trigger(*args)
+          username, arguments = extract_username(args)
+          trigger_id = get_id_from_arguments(arguments)
+
+          delete api_url(username, 'triggers', trigger_id)
+        end
+
+        def update_trigger(*args)
+          username, arguments = extract_username(args)
+          trigger_id = get_id_from_arguments(arguments)
+          attrs = valid_trigger_attrs(arguments)
+
+          put api_url(username, 'triggers', feed_key), query
+        end
+
+        private
+
+        def valid_trigger_attrs(arguments)
+          get_query_from_arguments(
+            arguments,
+            %w(feed_id operator value action to_feed_id action_feed_id
+               action_value enabled trigger_type)
+          )
+        end
+
+      end
+    end
+  end
+end
+

data/lib/adafruit/io/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adafruit-io
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.5
+  version: 2.0.0.beta.6
 platform: ruby
 authors:
 - Justin Cooper
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -117,6 +117,7 @@ files:
 - lib/adafruit/io/client/groups.rb
 - lib/adafruit/io/client/permissions.rb
 - lib/adafruit/io/client/tokens.rb
+- lib/adafruit/io/client/triggers.rb
 - lib/adafruit/io/client/user.rb
 - lib/adafruit/io/configurable.rb
 - lib/adafruit/io/mqtt.rb