adafruit-io 2.0.0.beta.7 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d4e361c9a85392c933fe7c35fda6bfd98f6f80cd
-  data.tar.gz: 9a68f813bfff5fedee4511bb6fcd7b940ebfb1e4
+SHA256:
+  metadata.gz: 0d3a797bff9e66a705fc31f4572f9158dde61f9253e5e3bf501b8d59adb6df5c
+  data.tar.gz: 40ad6e3b91d36b1b977584224c7c62448aa924aa78a8dc46beda1d58368d98f4
 SHA512:
-  metadata.gz: 730d7000307a9569797d6904f7fa5fba72e7cf6ec507b753fdad266584b1fed8bfdfbe29ae569f2d8b00fe129cf42f93687d1d202816a2944f457121a94f65a2
-  data.tar.gz: a61eb95bc77ff2aaab6d5893f9d16779e4d60acf1ab9612ba186e395bb73ab93c2e98af86f2f4fcbe518a44fa5f44c863ca12ac2fa3ed8a64ffd99a81ff2d75b
+  metadata.gz: 56efae94520d3ba34ab840877dfa9e16c2a6fd852bba785adec2ab24ed5c0243ab7d2aefcef4f473caf218affe11cb1f1daf519cfb34407e3a1fb8248efb827c
+  data.tar.gz: a81845c9affa024284f07203d2c6dce47d442a531b216dcb139028c1b7e6ebf1918c75a2b89e813d58d95d17c8efa6a6934c6b6f803acc6afa7eed63fdb250c3

data/README.md

@@ -1,4 +1,4 @@
-![Build Status](https://travis-ci.org/adafruit/io-client-ruby.svg?branch=master)
+![CI](https://github.com/adafruit/io-client-ruby/workflows/CI/badge.svg)
 
 # adafruit-io
 
@@ -14,10 +14,11 @@ Older releases are available at these links:
 
 This is a near complete rewrite and strip-down of the library intended to support V2 of the Adafruit IO API with less code, maintenance, and stress.
 
-Why rewrite? This lets us the replace the existing, custom ActiveRecord-based interface with a flat, stateless API client returning plain hashes based on the JSON returned from API.Instead of writing a bunch of Ruby to make it feel like we're in a Rails app, we're just providing hooks into the API and a thin wrapper around Faraday.
+Why rewrite? This lets us the replace the existing, custom ActiveRecord-based interface with a flat, stateless API client returning plain hashes based on the JSON returned from API. Instead of writing a bunch of Ruby to make it feel like we're in a Rails app, we're just providing hooks into the API and a thin wrapper around Faraday.
 
 The API is not very complex, code that uses it shouldn't be either.
 
+
 ## Roadmap
 
 It is our goal to eventually support all API V2 methods, but that will happen in stages.
@@ -35,17 +36,9 @@ It is our goal to eventually support all API V2 methods, but that will happen in
 
 Still needing complete tests:
 
-- [x] Feeds
-- [x] Data
-- [x] Tokens
-- [x] Blocks
-- [ ] Dashboards *has pending*
-- [ ] Groups *has pending*
-- [ ] Activities
-- [ ] Permissions
-- [ ] Triggers
 - [ ] MQTT
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -60,9 +53,12 @@ Or install it yourself as:
 
     $ gem install adafruit-io
 
+
+
 ## Basic Usage
 
-Each time you use the library, you'll want to pass your [AIO Key][4] to the client.
+Each time you use the library, you'll have to pass your [Adafruit IO Key][4] to the client.
+
 
 ```ruby
 require 'adafruit/io'
@@ -73,6 +69,7 @@ aio = Adafruit::IO::Client.new key: 'KEY'
 
 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'
 
@@ -80,15 +77,50 @@ require 'adafruit/io'
 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. Feeds, Groups, and Dashboards all rely on the `key` value, other endpoints (Blocks, Permissions, Tokens, Triggers) use `id`.
+
+
+### Environment Variables
+
+Whenever possible, we recommend you keep your Adafruit IO API credentials out of your application code by using environment variables. All the examples
+
+[Others](http://blog.honeybadger.io/ruby-guide-environment-variables/) have written about using environment variables in Ruby, so we're not going to go into detail. We recommend the [dotenv](https://github.com/bkeepers/dotenv) gem if you're building a Ruby project.
+
+
+
+### API Response Values
+
+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`.
+
+You can find the current API documentation at [https://io.adafruit.com/api/docs/](https://io.adafruit.com/api/docs/). This library implements v2 of the Adafruit IO API.
+
+
+
+### API Error Responses
+
+As of **v2.0.0**, this library raises an `Adafruit::IO::RequestError` on any non HTTP 200 status responses. Generally, this means your code should wrap API calls in `begin...rescue...end` blocks.
+
+```ruby
+require 'adafruit/io'
+
+api_key = ENV['IO_KEY']
+username = ENV['IO_USER']
+
+api = Adafruit::IO::Client.new key: api_key, username: username
+
+
+
+```
+
+## Example
 
 Here's an example of creating, adding data to, and deleting a feed.
 
+
 ```ruby
 require 'adafruit/io'
 
-api_key = ENV['AIO_KEY']
-username = ENV['AIO_USER']
+api_key = ENV['IO_KEY']
+username = ENV['IO_USER']
 
 api = Adafruit::IO::Client.new key: api_key, username: username
 
@@ -120,19 +152,25 @@ puts "read?"
 puts api.feed(garbage['key']).inspect
 ```
 
+
+This code and more is available in [the examples/ directory](examples/).
+
 ## License
 
-Copyright (c) 2017 Adafruit Industries. Licensed under the MIT license.
+Copyright (c) 2018 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
 
 1. Fork it ( http://github.com/adafruit/io-client-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Write tests, write code, and run the tests (`bundle exec rspec`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
+
+If you'd like to contribute and don't know where to start, [reach out on the Adafruit IO forum](https://forums.adafruit.com/viewforum.php?f=56) or in the [adafruit-io channel on our Discord server](https://discord.gg/adafruit).
 
 [1]: https://www.ruby-lang.org
 [2]: https://io.adafruit.com

data/adafruit-io.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.licenses = ['MIT']
 
-  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_dependency "faraday", "~> 2.14"
+  spec.add_dependency "faraday-multipart", "~> 1.0"
+  spec.add_dependency "activesupport",  "~> 8.0"
+  spec.add_dependency "mqtt", "~> 0.7"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "bundler", "~> 2.7"
+  spec.add_development_dependency "rake", "~> 13.2"
 end

data/lib/adafruit/io/arguments.rb

@@ -46,7 +46,7 @@ module Adafruit
         record_or_id = arguments.shift
         return nil if record_or_id.nil?
 
-        if record_or_id.is_a?(String) || record_or_id.is_a?(Fixnum)
+        if record_or_id.is_a?(String) || record_or_id.is_a?(Integer)
           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]

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

@@ -40,6 +40,14 @@ module Adafruit
 
           put api_url(username, 'dashboards', dashboard_key), query
         end
+
+        def update_dashboard_layouts(*args)
+          username, arguments = extract_username(args)
+          dashboard_key = get_key_from_arguments(arguments)
+          query = get_query_from_arguments(arguments, %w(layouts))
+
+          post api_url(username, 'dashboards', dashboard_key, 'update_layouts'), query
+        end
       end
     end
   end

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

@@ -2,6 +2,7 @@ module Adafruit
   module IO
     class Client
       module Permissions
+        VALID_TYPES = %(feed group dashboard)
 
         # Get all permissions for a resource.
         #
@@ -9,40 +10,62 @@ module Adafruit
         def permissions(*args)
           username, arguments = extract_username(args)
 
-          if arguments.size < 2
-            raise 'permissions requires model type (string) and model key (string) values. valid types are feeds, groups, or dashboards'
-          end
+          assert_argument_size(arguments, 2)
+          assert_resource_type(arguments[0])
 
-          get api_url(username, arguments[0], arguments[1], 'acl')
+          get api_url(username, pluralize_type(arguments[0]), arguments[1], 'acl')
         end
 
         def permission(*args)
           username, arguments = extract_username(args)
 
-          if arguments.size < 3
-            raise 'permission requires model type (string), model key (string), and id (integer) values. valid types are feeds, groups, or dashboards'
-          end
+          assert_argument_size(arguments, 3)
+          assert_resource_type(arguments[0])
 
-          get api_url(username, arguments[0], arguments[1], 'acl', arguments[2])
+          get api_url(username, pluralize_type(arguments[0]), arguments[1], 'acl', arguments[2])
         end
 
         def create_permission(*args)
           username, arguments = extract_username(args)
-          if arguments.size < 3
-            raise 'permission requires model type (string), model key (string), and id (integer) values. valid types are feeds, groups, or dashboards'
-          end
+
+          assert_argument_size(arguments, 2)
+          assert_resource_type(arguments[0])
+
           permission_attrs = arguments.pop
-          post api_url(username, arguments[0], arguments[1], 'acl'), permission_attrs
+          post api_url(username, pluralize_type(arguments[0]), arguments[1], 'acl'), permission_attrs
         end
 
         def delete_permission(*args)
           username, arguments = extract_username(args)
 
-          if arguments.size < 3
-            raise 'permission requires model type (string), key (string), and id (integer) values. valid types are feeds, groups, or dashboards'
+          assert_argument_size(arguments, 3)
+          assert_resource_type(arguments[0])
+
+          delete api_url(username, pluralize_type(arguments[0]), arguments[1], 'acl', arguments[2])
+        end
+
+        private
+
+        def assert_resource_type(resource_type)
+          if !VALID_TYPES.include?(resource_type)
+            raise Adafruit::IO::Arguments::ArgumentError.new('permission resource type must be one of: feed, group, or dashboard')
+          end
+        end
+
+        def assert_argument_size(arguments, size)
+          if size === 3
+            if arguments.size < 3
+              raise Adafruit::IO::Arguments::ArgumentError.new('permission requires resource type (string), key (string), and permission id (integer) values. valid types are feeds, groups, or dashboards')
+            end
+          elsif size == 2
+            if arguments.size < size
+              raise Adafruit::IO::Arguments::ArgumentError.new('permissions requires resource type (string) and resource key (string) values. valid types are feed, group, or dashboard')
+            end
           end
+        end
 
-          delete api_url(username, arguments[0], arguments[1], 'acl', arguments[2])
+        def pluralize_type(resource_type)
+          "#{resource_type}s"
         end
       end
     end

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

@@ -38,7 +38,7 @@ module Adafruit
           trigger_id = get_id_from_arguments(arguments)
           attrs = valid_trigger_attrs(arguments)
 
-          put api_url(username, 'triggers', feed_key), query
+          put api_url(username, 'triggers', trigger_id), attrs
         end
 
         private

data/lib/adafruit/io/client.rb

@@ -1,8 +1,6 @@
 require 'json'
 
 require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/response/mashify'
 
 require 'adafruit/io/arguments'
 require 'adafruit/io/configurable'
@@ -78,8 +76,7 @@ module Adafruit
             c.response :logger
           end
 
-          c.use :instrumentation
-          c.adapter Faraday.default_adapter
+          c.response :json
         end
       end
 

data/lib/adafruit/io/mqtt.rb

@@ -95,11 +95,18 @@ module Adafruit
 
       # Subscribe to the feed with the given key. Use .get to retrieve messages
       # from subscribed feeds.
-      def subscribe(key)
+      #
+      # Include the { last_value: true } option if you'd like the feed to
+      # receive the last value immediately. (like MQTT retain)
+      def subscribe(key, options={})
         raise 'client is not connected' unless @client.connected?
 
         topic = key_to_feed_topic(key)
         @client.subscribe(topic)
+
+        if options[:last_value]
+          @client.publish(topic + '/get', '')
+        end
       end
 
       def unsubscribe(key)
@@ -143,15 +150,21 @@ module Adafruit
       #     # 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 encode_json(record)
+        begin
+          JSON.generate record
+        rescue JSON::GeneratorError => ex
+          puts "failed to generate JSON from record: #{record.inspect}"
+          raise ex
+        end
+      end
+
       def key_to_feed_topic(key)
         "%s/f/%s" % [@options[:username], key]
       end
@@ -169,7 +182,7 @@ module Adafruit
           end
         end
 
-        JSON.generate payload
+        encode_json payload
       end
 
       def payload_from_values_with_location(values, location)
@@ -183,7 +196,7 @@ module Adafruit
           end
         end
 
-        JSON.generate payload
+        encode_json payload
       end
 
       def indifferent_keys(hash)

data/lib/adafruit/io/request_handler.rb

@@ -2,6 +2,15 @@ require 'open-uri'
 
 module Adafruit
   module IO
+    class RequestError < StandardError
+      attr_reader :response
+
+      def initialize(message, response)
+        super(message)
+        @response = response
+      end
+    end
+
     module RequestHandler
 
       attr_reader :last_response, :pagination
@@ -61,7 +70,7 @@ module Adafruit
 
       def handle_get(url, options = {})
         response = conn.get do |req|
-          req.url URI::encode(url)
+          req.url url
           options.each do |k,v|
             req.params[k] = v
           end
@@ -70,11 +79,7 @@ module Adafruit
         update_pagination(response)
 
         if response.status < 200 || response.status > 299
-          if response.status === 404
-            nil
-          else
-            raise "GET error: #{ response.body }"
-          end
+          raise Adafruit::IO::RequestError.new("GET error: #{ response.body }", response)
         else
           parsed_response response
         end
@@ -82,12 +87,12 @@ module Adafruit
 
       def handle_post(url, data, options = {})
         response = conn.post do |req|
-          req.url URI::encode(url)
+          req.url url
           req.body = data
         end
 
         if response.status < 200 || response.status > 299
-          raise "POST error: #{ response.body }"
+          raise Adafruit::IO::RequestError.new("POST error: #{ response.body }", response)
         else
           parsed_response response
         end
@@ -95,12 +100,12 @@ module Adafruit
 
       def handle_put(url, data, options = {})
         response = conn.put do |req|
-          req.url URI::encode(url)
+          req.url url
           req.body = data
         end
 
         if response.status < 200 || response.status > 299
-          raise "PUT error: #{ response.body }"
+          raise Adafruit::IO::RequestError.new("PUT error: #{ response.body }", response)
         else
           parsed_response response
         end
@@ -108,14 +113,14 @@ module Adafruit
 
       def handle_delete(url, options = {})
         response = conn.delete do |req|
-          req.url URI::encode(url)
+          req.url url
         end
 
         if response.status < 200 || response.status > 299
           if response.status === 404
             nil
           else
-            raise "DELETE error: #{ response.body }"
+            raise Adafruit::IO::RequestError.new("DELETE error: #{ response.body }", response)
           end
         else
           parsed_response response

data/lib/adafruit/io/version.rb

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

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adafruit-io
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.7
+  version: 3.0.0
 platform: ruby
 authors:
 - Justin Cooper
 - Adam Bachman
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,84 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: mqtt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.2'
 description: API Client Library for the Adafruit IO product
 email:
 - justin@adafruit.com
@@ -127,7 +126,6 @@ homepage: https://github.com/adafruit/io-client-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,13 +136,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Adafruit IO API Client Library
 test_files: []