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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82354463cf584413ee421f62dc087fa182b191a3
-  data.tar.gz: 7569063a8a78d7c97189a66bf89894f8c0f089dd
+  metadata.gz: 967481a3470b1c2b5c71f10d52aa0d0a11c3502c
+  data.tar.gz: 7d3fa8e6f776d95523763e4c7f0497bc071097df
 SHA512:
-  metadata.gz: d3dd1a6feec6e1804a08c0b5a805fb2053d35a4854acd354e018dc5f2815cb57454c7fb433eaf01be3ce1578f4e65a60b5b531aec8bcc69b6811d327c466fc23
-  data.tar.gz: 69e5cdb283b4d8d615fc3c575d0df498f82ecd04c1933b90f3d507a1cdd4c6983fcef7506040d226f60d788f3c2f10195351ce77ab31a877c678a838ab6e0db3
+  metadata.gz: 1fc64bb0cb2d05d80cab90bb7af67462c116ae333ae7ecbdce5f5e34e777c0c53fbdbc0be3cd2305d09772fedd8f2516e149aabe2e5e961bb52f165a14b61962
+  data.tar.gz: 547aef766d609a9d3f65b89d51577964f9692e42d471f98128e86967b0e02d91e9e7fe3314194cf7361bb26818d4157cfd6eb1f19257850589e931bc200961ea

data/README.md

@@ -26,12 +26,12 @@ It is our goal to eventually support all API V2 methods, but that will happen in
 - [x] Data `2.0.0.beta.1`
 - [x] Groups `2.0.0.beta.1`
 - [x] MQTT `2.0.0.beta.3`
+- [x] Tokens `2.0.0.beta.4`
+- [x] Blocks `2.0.0.beta.4`
+- [x] Dashboards `2.0.0.beta.4`
 - [] Activities
-- [] Blocks
-- [] Dashboards
 - [] Permissions
 - [] Sessions
-- [] Tokens
 - [] Triggers
 
 ## Installation
@@ -110,40 +110,11 @@ puts "read?"
 puts api.feed(garbage['key']).inspect
 ```
 
-## Table of Contents
-
-* [Feeds](#feeds)
-* [Data](#data)
-* [Groups](#groups)
-* [Dashboards](#dashboards)
-* [Blocks](#blocks)
-* [Activities](#activities)
-* [Triggers](#triggers)
-* [Permissions](#permissions)
-* [Tokens](#tokens)
-
-### Feeds
-
-Create
-
-
-
-
-
-### Data
-### Groups
-### Dashboards
-### Blocks
-### Activities
-### Triggers
-### Permissions
-### Tokens
-
-## Pagination
+## License
 
+Copyright (c) 2017 Adafruit Industries. Licensed under the MIT license.
 
-## License
-Copyright (c) 2014 Adafruit Industries. Licensed under the MIT license.
+[Adafruit](https://adafruit.com) invests time and resources providing this open source code. Please support Adafruit and open-source hardware by purchasing products from [Adafruit](https://adafruit.com).
 
 ## Contributing
 

data/lib/adafruit/io/arguments.rb

@@ -1,6 +1,7 @@
 module Adafruit
   module IO
     module Arguments
+      class ArgumentError < StandardError; end
 
       # Allows us to give a username during client initialization or with a specific method.
       def extract_username(args)
@@ -45,7 +46,7 @@ module Adafruit
         record_or_id = arguments.shift
         return nil if record_or_id.nil?
 
-        if record_or_id.is_a?(String)
+        if record_or_id.is_a?(String) || record_or_id.is_a?(Fixnum)
           record_or_id
         elsif record_or_id.is_a?(Hash) && (record_or_id.has_key?('id') || record_or_id.has_key?(:id))
           record_or_id['id'] || record_or_id[:id]
@@ -68,6 +69,19 @@ module Adafruit
         query
       end
 
+      def require_argument(arguments, argument_name)
+        arg = arguments.first
+        if !arg.is_a?(Hash)
+          raise ArgumentError.new("This request requires arguments to be a Hash containing the key: :#{argument_name}")
+        end
+
+        if !(arg.has_key?(argument_name) || arg.has_key?(argument_name.to_s))
+          raise ArgumentError.new("Missing required parameter, make sure to include #{argument_name}")
+        end
+
+        arg[argument_name] || arg[argument_name.to_s]
+      end
+
     end
   end
 end

data/lib/adafruit/io/client.rb

@@ -11,6 +11,10 @@ require 'adafruit/io/request_handler'
 require 'adafruit/io/client/feeds'
 require 'adafruit/io/client/data'
 require 'adafruit/io/client/groups'
+require 'adafruit/io/client/tokens'
+require 'adafruit/io/client/dashboards'
+require 'adafruit/io/client/blocks'
+require 'adafruit/io/client/user'
 
 module Adafruit
   module IO
@@ -43,6 +47,11 @@ module Adafruit
       include Adafruit::IO::Client::Feeds
       include Adafruit::IO::Client::Data
       include Adafruit::IO::Client::Groups
+      include Adafruit::IO::Client::Tokens
+      include Adafruit::IO::Client::Blocks
+      include Adafruit::IO::Client::Dashboards
+
+      include Adafruit::IO::Client::User
 
       private
 
@@ -75,7 +84,7 @@ module Adafruit
 
       # safely build URL paths from segments
       def safe_path_join(*paths)
-        paths = paths.compact.reject(&:empty?)
+        paths = paths.compact.map(&:to_s).reject(&:empty?)
         last = paths.length - 1
         paths.each_with_index.map { |path, index|
           safe_path_expand(path, index, last)

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

@@ -0,0 +1,53 @@
+module Adafruit
+  module IO
+    class Client
+      module Blocks
+
+        # Get all blocks for a dashboard. Requires dashboard_key.
+        def blocks(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = require_argument(arguments, :dashboard_key)
+
+          get api_url(username, 'dashboards', dashboard_key, 'blocks')
+        end
+
+        # Get a block specified by ID
+        def block(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = require_argument(arguments, :dashboard_key)
+          block_id = get_id_from_arguments(arguments)
+
+          get api_url(username, 'dashboards', dashboard_key, 'blocks', block_id)
+        end
+
+        def create_block(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = require_argument(arguments, :dashboard_key)
+          block_attrs = arguments.shift
+
+          post api_url(username, 'groups'), group_attrs
+        end
+
+        def delete_block(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = require_argument(arguments, :dashboard_key)
+          block_id = get_id_from_arguments(arguments)
+
+          delete api_url(username, 'dashboards', dashboard_key, 'blocks', block_id)
+        end
+
+        def update_block(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = require_argument(arguments, :dashboard_key)
+          block_id = get_id_from_arguments(arguments)
+
+          query = get_query_from_arguments(arguments, %w(name properties visual_type column row size_x size_y block_feeds))
+
+          put api_url(username, 'dashboards', dashboard_key, 'blocks', block_id), query
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,48 @@
+module Adafruit
+  module IO
+    class Client
+      module Dashboards
+
+        # Get all dashboards.
+        def dashboards(*args)
+          username, _ = extract_username(args)
+
+          get api_url(username, 'dashboards')
+        end
+
+        # Get a dashboard specified by key
+        def dashboard(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = get_key_from_arguments(arguments)
+
+          get api_url(username, 'dashboards', dashboard_key)
+        end
+
+        # Create a dashboard. No attributes need to be passed in.
+        def create_dashboard(*args)
+          username, arguments = extract_username(args)
+          attrs = arguments.shift
+
+          post api_url(username, 'dashboards'), attrs
+        end
+
+        def delete_dashboard(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = get_key_from_arguments(arguments)
+
+          delete api_url(username, 'dashboards', dashboard_key)
+        end
+
+        def update_dashboard(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = get_key_from_arguments(arguments)
+          query = get_query_from_arguments(arguments, %w(name key))
+
+          put api_url(username, 'dashboards', dashboard_key), query
+        end
+      end
+    end
+  end
+end
+
+

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

@@ -13,32 +13,23 @@ module Adafruit
         # Get a token specified by key
         def token(*args)
           username, arguments = extract_username(args)
-          token_key = get_key_from_arguments(arguments)
+          token_id = get_id_from_arguments(arguments)
 
-          get api_url(username, 'tokens', token_key)
-        end
-
-        # Get a token along with additional details about the token. This method
-        # has more to lookup and so is slower than `token`
-        def token_details(*args)
-          username, arguments = extract_username(args)
-          token_key = get_id_from_arguments(arguments)
-
-          get api_url(username, 'tokens', token_key, 'details')
+          get api_url(username, 'tokens', token_id)
         end
 
+        # Create a token. No attributes need to be passed in.
         def create_token(*args)
           username, arguments = extract_username(args)
-          token_attrs = arguments.shift
 
-          post api_url(username, 'tokens'), token_attrs
+          post api_url(username, 'tokens')
         end
 
         def delete_token(*args)
           username, arguments = extract_username(args)
-          token_key = get_id_from_arguments(arguments)
+          token_id = get_id_from_arguments(arguments)
 
-          delete api_url(username, 'tokens', token_key)
+          delete api_url(username, 'tokens', token_id)
         end
 
       end

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

@@ -0,0 +1,17 @@
+
+module Adafruit
+  module IO
+    class Client
+      module User
+
+        # Get user associated with the current key. If this method returns nil
+        # it means you have a bad key.
+        def user(*args)
+          get '/api/v2/user'
+        end
+
+      end
+    end
+  end
+end
+

data/lib/adafruit/io/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adafruit-io
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.3
+  version: 2.0.0.beta.4
 platform: ruby
 authors:
 - Justin Cooper
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -109,10 +109,13 @@ files:
 - lib/adafruit/io.rb
 - lib/adafruit/io/arguments.rb
 - lib/adafruit/io/client.rb
+- lib/adafruit/io/client/blocks.rb
+- lib/adafruit/io/client/dashboards.rb
 - lib/adafruit/io/client/data.rb
 - lib/adafruit/io/client/feeds.rb
 - lib/adafruit/io/client/groups.rb
 - lib/adafruit/io/client/tokens.rb
+- lib/adafruit/io/client/user.rb
 - lib/adafruit/io/configurable.rb
 - lib/adafruit/io/mqtt.rb
 - lib/adafruit/io/request_handler.rb
@@ -142,4 +145,3 @@ signing_key:
 specification_version: 4
 summary: Adafruit IO API Client Library
 test_files: []
-has_rdoc: