adafruit-io 2.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9d6fead5f73917e3333bd69c70965d1e4d23c31
-  data.tar.gz: 1cef173f825142a4ca7c7c4c3eeaf44d11fc1b7d
+SHA256:
+  metadata.gz: a1d57d2998069e7dda6fd18ab4dac69cf1ce98d67e84568046118bda4bb14bf7
+  data.tar.gz: 6d31d21c4ff9186492d93202dc27a1359b935d5e33d8ee57d0f376c63a6ea33c
 SHA512:
-  metadata.gz: ea27ad2d2ef07fcbcbde215ace2d8e2e46960eb8f05d9fc5d26d0186f9ee10519e80b832237f7793b472e7e8f26a3d760a440613fed3f7b78d05d0c8e7c9d57c
-  data.tar.gz: fbf7c7ef1880a396ceb5aa2e54e1bea2b345a8b610482f35bf3afab6db2c97615fb5e14a8b0f04c8f141dce71d6474dd00d64559c0798be70140bfc2856f6924
+  metadata.gz: 61b089f5f60170a8e2133c66f6db86ab631ab2820d302ad905ec26e1a0d65b9954a02682b264063580bbd7400d6c693d0880c4b5627b7877c706c5440d0da3d3
+  data.tar.gz: f38e367aabdd8e5f86edf645aea9697dbb248e229b2f4adbb6427f984ea2da1ea837cdbc09fe935534cac505a8822b2581cbb3c2933caa15494726739b915fdf

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.
@@ -32,22 +33,12 @@ It is our goal to eventually support all API V2 methods, but that will happen in
 - [x] Activities `2.0.0.beta.5`
 - [x] Permissions `2.0.0.beta.5`
 - [x] Triggers `2.0.0.beta.6`
-- [x] Feeds `2.0.0`
-- [x] Data `2.0.0`
-- [x] Tokens `2.0.0`
-- [x] Blocks `2.0.0`
-- [x] Dashboards `2.0.0`
-- [x] Groups `2.0.0`
-- [x] Activities `2.0.0`
-- [x] Permissions `2.0.0`
-- [x] Triggers `2.0.0`
 
 Still needing complete tests:
 
 - [ ] MQTT
 
 
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/adafruit-io.gemspec

@@ -18,13 +18,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 3.3"
   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 "mqtt", "~> 0.7"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rake", "~> 13.2"
 end

data/lib/adafruit/io/arguments.rb

@@ -1,18 +1,20 @@
+require 'adafruit/io/errors'
+
 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)
         username = @username
 
         if args.last.is_a?(Hash) && args.last.has_key?(:username)
-          username = args.last.delete(:username)
+          options = args.last.dup
+          username = options.delete(:username)
+          args = args[0...-1] + [options]
         end
 
         if username.nil?
-          raise "cannot make request when username is nil"
+          raise ArgumentError.new("cannot make request when username is nil")
         end
 
         [ username, args ]
@@ -34,10 +36,11 @@ module Adafruit
           record_or_key
         elsif record_or_key.is_a?(Hash) && (record_or_key.has_key?('key') || record_or_key.has_key?(:key))
           record_or_key['key'] || record_or_key[:key]
-        elsif record_or_key.respond_to?(:key)
+        elsif !record_or_key.is_a?(Hash) && record_or_key.respond_to?(:key)
+          # Hash#key(value) exists, so plain hashes must not land here
           record_or_key.key
         else
-          raise 'unrecognized object or key value in arguments'
+          raise ArgumentError.new('unrecognized object or key value in arguments')
         end
       end
 
@@ -46,25 +49,30 @@ 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]
         elsif record_or_id.respond_to?(:id)
           record_or_id.id
         else
-          raise 'unrecognized object or id value in arguments'
+          raise ArgumentError.new('unrecognized object or id value in arguments')
         end
       end
 
-      # Get a filtered list of parameters from the next argument
+      # Get a filtered list of parameters from the next argument. Accepts
+      # either symbol or string keys.
       def get_query_from_arguments(arguments, params)
         query = {}
         options = arguments.shift
         return query if options.nil?
 
         params.each do |param|
-          query[param] = options[param.to_sym] if options.has_key?(param.to_sym)
+          if options.has_key?(param.to_sym)
+            query[param] = options[param.to_sym]
+          elsif options.has_key?(param.to_s)
+            query[param] = options[param.to_s]
+          end
         end
         query
       end

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

@@ -38,12 +38,17 @@ module Adafruit
           delete api_url(username, 'dashboards', dashboard_key, 'blocks', block_id)
         end
 
-        # Update a block
+        # Update a block. Attributes can be given in the same hash as
+        # dashboard_key and key, or as a separate second hash:
+        #
+        #   client.update_block(dashboard_key: 'db', key: 1, name: 'new')
+        #   client.update_block({ dashboard_key: 'db', key: 1 }, { name: 'new' })
         def update_block(*args)
           username, arguments = extract_username(args)
           dashboard_key = require_argument(arguments, :dashboard_key)
+          options = arguments.first
           block_id = get_key_from_arguments(arguments)
-          block_attrs = valid_block_attrs(arguments)
+          block_attrs = valid_block_attrs(arguments.empty? ? [options] : arguments)
 
           put api_url(username, 'dashboards', dashboard_key, 'blocks', block_id), block_attrs
         end

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

@@ -1,3 +1,5 @@
+require 'time'
+
 module Adafruit
   module IO
     class Client
@@ -53,7 +55,7 @@ module Adafruit
           values = arguments.shift
 
           if values.nil? || !values.is_a?(Array)
-            raise "expected batch values to be an array"
+            raise Adafruit::IO::Arguments::ArgumentError.new("expected batch values to be an array")
           end
 
           if !values.first.is_a?(Hash)

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

@@ -2,7 +2,7 @@ module Adafruit
   module IO
     class Client
       module Permissions
-        VALID_TYPES = %(feed group dashboard)
+        VALID_TYPES = %w(feed group dashboard).freeze
 
         # Get all permissions for a resource.
         #
@@ -25,13 +25,18 @@ module Adafruit
           get api_url(username, pluralize_type(arguments[0]), arguments[1], 'acl', arguments[2])
         end
 
+        #   client.create_permission(TYPE, KEY, { scope: 'public', mode: 'r' })
         def create_permission(*args)
           username, arguments = extract_username(args)
 
           assert_argument_size(arguments, 2)
           assert_resource_type(arguments[0])
 
-          permission_attrs = arguments.pop
+          permission_attrs = arguments[2]
+          if !permission_attrs.is_a?(Hash)
+            raise Adafruit::IO::Arguments::ArgumentError.new('create_permission requires resource type (string), resource key (string), and a Hash of permission attributes, e.g. { scope: "public", mode: "r" }')
+          end
+
           post api_url(username, pluralize_type(arguments[0]), arguments[1], 'acl'), permission_attrs
         end
 

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

@@ -20,9 +20,9 @@ module Adafruit
 
         # Create a token. No attributes need to be passed in.
         def create_token(*args)
-          username, arguments = extract_username(args)
+          username, _ = extract_username(args)
 
-          post api_url(username, 'tokens')
+          post api_url(username, 'tokens'), {}
         end
 
         def delete_token(*args)

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'
@@ -38,9 +36,7 @@ module Adafruit
       #
       # @return [String]
       def inspect
-        inspected = super
-        inspected = inspected.gsub! @key, "#{@key[0..3]}#{'*' * (@key.size - 3)}" if @key
-        inspected
+        "#<#{self.class.name} username=#{@username.inspect} api_endpoint=#{api_endpoint.inspect} key=#{masked_key.inspect}>"
       end
 
       def last_response
@@ -60,14 +56,19 @@ module Adafruit
 
       private
 
+      def masked_key
+        return nil if @key.nil?
+        return '*' * @key.size if @key.size <= 4
+
+        "#{@key[0..3]}#{'*' * (@key.size - 4)}"
+      end
+
       def conn
-        if api_endpoint
-          url = api_endpoint
-        else
-          url = 'https://io.adafruit.com'
-        end
+        settings = [api_endpoint, @key, @debug]
+        return @conn if @conn && @conn_settings == settings
 
-        Faraday.new(:url => url) do |c|
+        @conn_settings = settings
+        @conn = Faraday.new(:url => api_endpoint) do |c|
           c.headers['X-AIO-Key'] = @key
           c.headers['Accept'] = 'application/json'
           c.headers['User-Agent'] = "AdafruitIO-Ruby/#{VERSION} (#{RUBY_PLATFORM})"
@@ -78,8 +79,7 @@ module Adafruit
             c.response :logger
           end
 
-          c.use :instrumentation
-          c.adapter Faraday.default_adapter
+          c.response :json
         end
       end
 

data/lib/adafruit/io/errors.rb

@@ -0,0 +1,18 @@
+module Adafruit
+  module IO
+    class Error < StandardError; end
+
+    class RequestError < Error
+      attr_reader :response
+
+      def initialize(message, response)
+        super(message)
+        @response = response
+      end
+    end
+
+    module Arguments
+      class ArgumentError < Adafruit::IO::Error; end
+    end
+  end
+end

data/lib/adafruit/io/mqtt.rb

@@ -1,4 +1,5 @@
 require 'mqtt'
+require 'adafruit/io/errors'
 
 #
 # Adafruit::IO::MQTT provides a simple Adafruit IO aware wrapper around the
@@ -65,7 +66,7 @@ module Adafruit
 
       # Publish value to feed with given key
       def publish(key, value, location={})
-        raise 'client is not connected' unless @client.connected?
+        raise Adafruit::IO::Error.new('client is not connected') unless @client.connected?
 
         topic = key_to_feed_topic(key)
         location = indifferent_keys(location)
@@ -83,8 +84,8 @@ module Adafruit
       #   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)
+        raise Adafruit::IO::Error.new('client is not connected') unless @client.connected?
+        raise Adafruit::IO::Arguments::ArgumentError.new('values must be a hash') unless values.is_a?(Hash)
 
         topic = key_to_group_topic(key, false)
         location = indifferent_keys(location)
@@ -99,7 +100,7 @@ module Adafruit
       # 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?
+        raise Adafruit::IO::Error.new('client is not connected') unless @client.connected?
 
         topic = key_to_feed_topic(key)
         @client.subscribe(topic)
@@ -110,7 +111,7 @@ module Adafruit
       end
 
       def unsubscribe(key)
-        raise 'client is not connected' unless @client.connected?
+        raise Adafruit::IO::Error.new('client is not connected') unless @client.connected?
 
         topic = key_to_feed_topic(key)
         @client.unsubscribe(topic)
@@ -123,7 +124,7 @@ module Adafruit
       # 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?
+        raise Adafruit::IO::Error.new('client is not connected') unless @client.connected?
 
         topic = key_to_group_topic(key)
         @client.subscribe(topic)
@@ -176,7 +177,7 @@ module Adafruit
       def payload_from_value_with_location(value, location)
         payload = { value: value.to_s }
 
-        if location.has_key?('lat') && location.has_key?['lon']
+        if location.has_key?('lat') && location.has_key?('lon')
           %w(lat lon ele).each do |f|
             payload[f] = location[f]
           end
@@ -188,7 +189,7 @@ module Adafruit
       def payload_from_values_with_location(values, location)
         payload = { feeds: values }
 
-        if location.has_key?('lat') && location.has_key?['lon']
+        if location.has_key?('lat') && location.has_key?('lon')
           payload[:location] = {}
 
           %w(lat lon ele).each do |f|

data/lib/adafruit/io/request_handler.rb

@@ -1,21 +1,13 @@
-require 'open-uri'
+require 'adafruit/io/errors'
 
 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
 
-      def request(method, url, data = nil, options = nil)
+      def request(method, url, data = nil)
+        @pagination = nil
         @last_response = send(method, url, data)
       end
 
@@ -23,15 +15,15 @@ module Adafruit
         request(:handle_get, url, options)
       end
 
-      def post(url, data, options = {})
-        request :handle_post, url, data, options
+      def post(url, data)
+        request :handle_post, url, data
       end
 
-      def put(url, data, options = {})
-        request :handle_put, url, data, options
+      def put(url, data)
+        request :handle_put, url, data
       end
 
-      def delete(url, options = {})
+      def delete(url)
         request :handle_delete, url
       end
 
@@ -44,33 +36,31 @@ module Adafruit
       def update_pagination(response)
         @pagination = nil
 
-        if pagination_keys = response.headers.keys.grep(/x-pagination-/i)
-          @pagination = {}
-          pagination_keys.each do |k|
-            @pagination[k.gsub(/x-pagination-/i, '')] = response.headers[k]
-          end
+        pagination_keys = response.headers.keys.grep(/x-pagination-/i)
+        return if pagination_keys.empty?
+
+        @pagination = {}
+        pagination_keys.each do |k|
+          @pagination[k.gsub(/x-pagination-/i, '')] = response.headers[k]
         end
       end
 
+      # Faraday's :json middleware already parses responses with a JSON
+      # content type. Only try to parse bodies it left as strings.
       def parsed_response(response)
-        if response.respond_to?(:data)
-          response.data
-        else
-          begin
-            json = JSON.parse(response.body)
-          rescue => ex
-            if @debug
-              puts "ERROR PARSING JSON: #{ex.message}"
-              puts ex.backtrace[0..5].join("\n")
-            end
-            response.body
-          end
+        body = response.body
+        return body unless body.is_a?(String)
+
+        begin
+          JSON.parse(body)
+        rescue JSON::ParserError
+          body
         end
       end
 
       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
@@ -85,9 +75,9 @@ module Adafruit
         end
       end
 
-      def handle_post(url, data, options = {})
+      def handle_post(url, data)
         response = conn.post do |req|
-          req.url URI::encode(url)
+          req.url url
           req.body = data
         end
 
@@ -98,9 +88,9 @@ module Adafruit
         end
       end
 
-      def handle_put(url, data, options = {})
+      def handle_put(url, data)
         response = conn.put do |req|
-          req.url URI::encode(url)
+          req.url url
           req.body = data
         end
 
@@ -111,17 +101,13 @@ module Adafruit
         end
       end
 
-      def handle_delete(url, options = {})
+      def handle_delete(url, _data = nil)
         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 Adafruit::IO::RequestError.new("DELETE error: #{ response.body }", response)
-          end
+          raise Adafruit::IO::RequestError.new("DELETE error: #{ response.body }", response)
         else
           parsed_response response
         end

data/lib/adafruit/io/version.rb

@@ -1,5 +1,5 @@
 module Adafruit
   module IO
-    VERSION = "2.0.0"
+    VERSION = "4.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
+  version: 4.0.0
 platform: ruby
 authors:
 - Justin Cooper
 - Adam Bachman
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2026-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,84 +16,42 @@ 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'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '2.14'
 - !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'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0.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
@@ -120,6 +77,7 @@ files:
 - lib/adafruit/io/client/triggers.rb
 - lib/adafruit/io/client/user.rb
 - lib/adafruit/io/configurable.rb
+- lib/adafruit/io/errors.rb
 - lib/adafruit/io/mqtt.rb
 - lib/adafruit/io/request_handler.rb
 - lib/adafruit/io/version.rb
@@ -127,7 +85,6 @@ homepage: https://github.com/adafruit/io-client-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -135,16 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       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: []