switchbot 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5dbe643e1c26eafa1c841dcf3cffb4e42ec799bba387b139fdd9d72e630ec6f
-  data.tar.gz: 2e243ec43219aab5fdbaf3dd4f20291676d7bdfebd7ee0ccdaee32b6c7cd21a4
+  metadata.gz: be1e25f69c499cba70f375ebb2d95ba8603620f72a1c4288318a36f01f2ab7d1
+  data.tar.gz: ae15d1012b74b95b0e930a914201d3ba5bfcd62636894d5efb952d0af60b2452
 SHA512:
-  metadata.gz: '0468a22f7a997c01e036c473e81af30e6832a8e39fdfb0acbd0155904f19459b20d5944247de05eb165cf98b810844adaf554a6224113ad95a5b12f5b518b5ba'
-  data.tar.gz: 2a434cdcfd1956789526ad7f925871ccae53c7eb9c496b1a909a16cd2f6535b751e1d32abd5a79d3d1c9d4ba05d6306caf0c55d3c40c224bb3b988a227c093f0
+  metadata.gz: 842235f1b0db8564903ab0650d84a01a6312b9f1def3fbdce62c1ba2aee02c66ac1f8828f7144c565b1e2e63b045c311fc43a7068dc52e454426e7c6568c77ca
+  data.tar.gz: e59de5df165265cbbdab81c333c26196a193d3f1386413aa87375ae499235bd4ef6e212566326df2aafef349b6a101aec5ef1b113a7ea33ec54d85265a9bfdac

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @ytkg

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/main.yml

@@ -1,6 +1,6 @@
 name: Ruby
 
-on: [push,pull_request]
+on: push
 
 jobs:
   build:
@@ -8,16 +8,14 @@ jobs:
     strategy:
       matrix:
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.6, 2.7, '3.0', 3.1]
+        ruby: [2.6, 2.7, '3.0', 3.1, 3.2, 3.3]
     name: Ruby ${{ matrix.ruby }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
     - name: Run the default task
-      run: |
-        gem install bundler -v 2.2.4
-        bundle install
-        bundle exec rake
+      run: bundle exec rake

data/.rubocop.yml

@@ -9,3 +9,6 @@ Metrics/BlockLength:
   Exclude:
     - switchbot.gemspec
     - spec/**/*
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/CHANGELOG.md

@@ -1,66 +1,97 @@
-## Unreleased
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.7.0...main)
+# Changelog
 
-## v0.7.0
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.6.0...v0.7.0)
+All notable changes to this project will be documented in this file.
 
-* Add Lock
-  * https://github.com/ytkg/switchbot/pull/16
-* :bomb: **[BREAKING CHANGE]** Support SwitchBot API v1.1
-  * https://github.com/ytkg/switchbot/pull/15
-  * The authentication method has been changed.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-    ```ruby
-    client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')
-    ```
+## [Unreleased]
 
-    You must update the app to the latest version, V6.14 or later, in order to get the secret key.
+## [0.9.0] - 2026-02-23
 
-## v0.6.0
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.5.1...v0.6.0)
+### Added
+- Allow `Switchbot::Client.new` to read `SWITCHBOT_API_TOKEN` and `SWITCHBOT_API_SECRET` when arguments are omitted. ([#25](https://github.com/ytkg/switchbot/pull/25))
+  Usage:
 
-* Add ColorBulb
-  * https://github.com/ytkg/switchbot/pull/14
-* :bomb: **[BREAKING CHANGE]** Update faraday v2 and Drop support ruby 2.5
-  * https://github.com/ytkg/switchbot/pull/12
+  ```ruby
+  ENV['SWITCHBOT_API_TOKEN'] = 'YOUR_TOKEN'
+  ENV['SWITCHBOT_API_SECRET'] = 'YOUR_SECRET'
+  client = Switchbot::Client.new
+  ```
 
-## v0.5.1
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.5.0...v0.5.1)
+## [0.8.0] - 2023-03-21
 
-* Enable MFA requirement for gem releasing
-  * https://github.com/ytkg/switchbot/pull/11
+### Added
+- Add Plug Mini support. ([#21](https://github.com/ytkg/switchbot/pull/21))
 
-## v0.5.0
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.4.0...v0.5.0)
+## [0.7.0] - 2022-10-27
 
-* Add Bot
-  * https://github.com/ytkg/switchbot/pull/9
+### Added
+- Add Lock support. ([#16](https://github.com/ytkg/switchbot/pull/16))
 
-## v0.4.0
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.3.0...v0.4.0)
+### Changed
+- **BREAKING:** Support SwitchBot API v1.1. ([#15](https://github.com/ytkg/switchbot/pull/15))
+  The authentication method has changed:
 
-* Add Humidifier
-  * https://github.com/ytkg/switchbot/pull/7
-* Add Light
-  * https://github.com/ytkg/switchbot/pull/6
-* Add Device#on? and Device#off?
-  * https://github.com/ytkg/switchbot/pull/5
+  ```ruby
+  client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')
+  ```
 
-## v0.3.0
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.2.0...v0.3.0)
+  App version 6.14 or later is required to get the secret key.
 
-* Add `Device#on` and `Device#off`
-  * https://github.com/ytkg/switchbot/pull/4
-* Add Device#commands
-  * https://github.com/ytkg/switchbot/pull/3
+## [0.6.0] - 2022-05-25
 
-## v0.2.0
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.1.0...v0.2.0)
+### Added
+- Add ColorBulb support. ([#14](https://github.com/ytkg/switchbot/pull/14))
 
-* Add resource methods
-  * https://github.com/ytkg/switchbot/pull/2
-* Support scenes endpoint
-  * https://github.com/ytkg/switchbot/pull/1
+### Changed
+- Update Faraday to v2. ([#12](https://github.com/ytkg/switchbot/pull/12))
 
-## v0.1.0
-* first release
+### Removed
+- **BREAKING:** Drop support for Ruby 2.5. ([#12](https://github.com/ytkg/switchbot/pull/12))
+
+## [0.5.1] - 2022-01-04
+
+### Security
+- Enable MFA requirement for gem releasing. ([#11](https://github.com/ytkg/switchbot/pull/11))
+
+## [0.5.0] - 2021-06-25
+
+### Added
+- Add Bot support. ([#9](https://github.com/ytkg/switchbot/pull/9))
+
+## [0.4.0] - 2021-04-23
+
+### Added
+- Add Humidifier support. ([#7](https://github.com/ytkg/switchbot/pull/7))
+- Add Light support. ([#6](https://github.com/ytkg/switchbot/pull/6))
+- Add `Device#on?` and `Device#off?`. ([#5](https://github.com/ytkg/switchbot/pull/5))
+
+## [0.3.0] - 2021-03-07
+
+### Added
+- Add `Device#on` and `Device#off`. ([#4](https://github.com/ytkg/switchbot/pull/4))
+- Add `Device#commands`. ([#3](https://github.com/ytkg/switchbot/pull/3))
+
+## [0.2.0] - 2021-03-05
+
+### Added
+- Add resource methods. ([#2](https://github.com/ytkg/switchbot/pull/2))
+- Support scenes endpoint. ([#1](https://github.com/ytkg/switchbot/pull/1))
+
+## [0.1.0] - 2021-03-02
+
+### Added
+- First release.
+
+[Unreleased]: https://github.com/ytkg/switchbot/compare/v0.9.0...HEAD
+[0.9.0]: https://github.com/ytkg/switchbot/compare/v0.8.0...v0.9.0
+[0.8.0]: https://github.com/ytkg/switchbot/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/ytkg/switchbot/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/ytkg/switchbot/compare/v0.5.1...v0.6.0
+[0.5.1]: https://github.com/ytkg/switchbot/compare/v0.5.0...v0.5.1
+[0.5.0]: https://github.com/ytkg/switchbot/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/ytkg/switchbot/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/ytkg/switchbot/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/ytkg/switchbot/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/ytkg/switchbot/releases/tag/v0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Switchbot
 
-[SwichBot API](https://github.com/OpenWonderLabs/SwitchBotAPI) client for Ruby
+[SwitchBot API](https://github.com/OpenWonderLabs/SwitchBotAPI) client for Ruby
 
 ## Installation
 
@@ -22,10 +22,16 @@ Or install it yourself as:
 ```ruby
 require 'switchbot'
 
+# pass token and secret directly
 client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')
+
+# or use environment variables
+ENV['SWITCHBOT_API_TOKEN'] = 'YOUR_TOKEN'
+ENV['SWITCHBOT_API_SECRET'] = 'YOUR_SECRET'
+client = Switchbot::Client.new
 ```
 
-For v0.6.0 and below, refer to README-v0.6.0-and-below.md.
+For v0.6.0 and below, refer to [README-v0.6.0-and-below.md](https://github.com/ytkg/switchbot/blob/main/README-v0.6.0-and-below.md).
 
 ### Get device list
 GET https://api.switch-bot.com/v1.1/devices
@@ -114,7 +120,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/switchbot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/switchbot/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ytkg/switchbot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ytkg/switchbot/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -122,4 +128,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Switchbot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/switchbot/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Switchbot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ytkg/switchbot/blob/master/CODE_OF_CONDUCT.md).

data/lib/switchbot/bot.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 module Switchbot
-  class Bot < Device
+  class Bot
+    extend Forwardable
+
+    def_delegators :@device, :status, :commands, :on, :off, :on?, :off?
+
+    def initialize(client:, device_id:)
+      @device = Device.new(client: client, device_id: device_id)
+    end
+
     def press
       commands(command: 'press')
     end

data/lib/switchbot/client.rb

@@ -2,19 +2,15 @@
 
 module Switchbot
   class Client
-    API_ENDPOINT = 'https://api.switch-bot.com'
     API_VERSION = 'v1.1'
 
-    def initialize(token, secret)
-      @token = token
-      @secret = secret
+    def initialize(token = nil, secret = nil)
+      @token = token || ENV.fetch('SWITCHBOT_API_TOKEN', '')
+      @secret = secret || ENV.fetch('SWITCHBOT_API_SECRET', '')
     end
 
     def devices
-      request(
-        http_method: :get,
-        endpoint: "/#{API_VERSION}/devices"
-      )
+      request.get("/#{API_VERSION}/devices")
     end
 
     def device(device_id)
@@ -22,29 +18,16 @@ module Switchbot
     end
 
     def status(device_id:)
-      request(
-        http_method: :get,
-        endpoint: "/#{API_VERSION}/devices/#{device_id}/status"
-      )
+      request.get("/#{API_VERSION}/devices/#{device_id}/status")
     end
 
     def commands(device_id:, command:, parameter: 'default', command_type: 'command')
-      request(
-        http_method: :post,
-        endpoint: "/#{API_VERSION}/devices/#{device_id}/commands",
-        params: {
-          command: command,
-          parameter: parameter,
-          commandType: command_type
-        }
-      )
+      request.post("/#{API_VERSION}/devices/#{device_id}/commands",
+                   params: { command: command, parameter: parameter, commandType: command_type })
     end
 
     def scenes
-      request(
-        http_method: :get,
-        endpoint: "/#{API_VERSION}/scenes"
-      )
+      request.get("/#{API_VERSION}/scenes")
     end
 
     def scene(scene_id)
@@ -52,10 +35,7 @@ module Switchbot
     end
 
     def execute(scene_id:)
-      request(
-        http_method: :post,
-        endpoint: "/#{API_VERSION}/scenes/#{scene_id}/execute"
-      )
+      request.post("/#{API_VERSION}/scenes/#{scene_id}/execute")
     end
 
     def bot(device_id)
@@ -78,33 +58,14 @@ module Switchbot
       Lock.new(client: self, device_id: device_id)
     end
 
-    private
-
-    def headers
-      t = "#{Time.now.to_i}000"
-      nonce = SecureRandom.alphanumeric
-      sign = Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', @secret, "#{@token}#{t}#{nonce}"))
-
-      {
-        'User-Agent' => "Switchbot v#{Switchbot::VERSION} (https://github.com/ytkg/switchbot)",
-        'Authorization' => @token,
-        'T' => t,
-        'Sign' => sign,
-        'Nonce' => nonce
-      }
+    def plug_mini(device_id)
+      PlugMini.new(client: self, device_id: device_id)
     end
 
-    def connection
-      Faraday.new(url: API_ENDPOINT, headers: headers) do |conn|
-        conn.request :json
-        conn.response :json
-        conn.adapter :typhoeus, http_version: :httpv2_0 # rubocop:disable Naming/VariableNumber
-      end
-    end
+    private
 
-    def request(http_method:, endpoint:, params: {})
-      response = connection.public_send(http_method, endpoint, params)
-      response.body.deep_transform_keys(&:underscore).deep_symbolize_keys
+    def request
+      @request ||= Request.new(@token, @secret)
     end
   end
 end

data/lib/switchbot/color_bulb.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 module Switchbot
-  class ColorBulb < Device
+  class ColorBulb
+    extend Forwardable
+
+    def_delegators :@device, :status, :commands, :on, :off, :on?, :off?
+
+    def initialize(client:, device_id:)
+      @device = Device.new(client: client, device_id: device_id)
+    end
+
     def toggle
       commands(command: 'toggle')
     end

data/lib/switchbot/humidifier.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 module Switchbot
-  class Humidifier < Device
+  class Humidifier
+    extend Forwardable
+
+    def_delegators :@device, :status, :commands, :on, :off, :on?, :off?
+
+    def initialize(client:, device_id:)
+      @device = Device.new(client: client, device_id: device_id)
+    end
+
     def mode(value)
       commands(command: 'setMode', parameter: value.to_s)
     end

data/lib/switchbot/light.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 module Switchbot
-  class Light < Device
+  class Light
+    extend Forwardable
+
+    def_delegators :@device, :commands, :on, :off
+
+    def initialize(client:, device_id:)
+      @device = Device.new(client: client, device_id: device_id)
+    end
+
     def brightness_up
       commands(command: 'brightnessUp')
     end

data/lib/switchbot/lock.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 module Switchbot
-  class Lock < Device
+  class Lock
+    extend Forwardable
+
+    def_delegators :@device, :status, :commands
+
+    def initialize(client:, device_id:)
+      @device = Device.new(client: client, device_id: device_id)
+    end
+
     def lock
       commands(command: 'lock')
     end

data/lib/switchbot/plug_mini.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Switchbot
+  class PlugMini
+    extend Forwardable
+
+    def_delegators :@device, :status, :commands, :on, :off, :on?, :off?
+
+    def initialize(client:, device_id:)
+      @device = Device.new(client: client, device_id: device_id)
+    end
+
+    def toggle
+      commands(command: 'toggle')
+    end
+  end
+end

data/lib/switchbot/request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Switchbot
+  class Request
+    API_ENDPOINT = 'https://api.switch-bot.com'
+
+    def initialize(token, secret)
+      @token = token
+      @secret = secret
+    end
+
+    def get(endpoint)
+      request(http_method: :get, endpoint: endpoint)
+    end
+
+    def post(endpoint, params: {})
+      request(http_method: :post, endpoint: endpoint, params: params)
+    end
+
+    private
+
+    def headers
+      t = "#{Time.now.to_i}000"
+      nonce = SecureRandom.alphanumeric
+      sign = Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', @secret, "#{@token}#{t}#{nonce}"))
+
+      {
+        'User-Agent' => "Switchbot v#{Switchbot::VERSION} (https://github.com/ytkg/switchbot)",
+        'Authorization' => @token,
+        'T' => t,
+        'Sign' => sign,
+        'Nonce' => nonce
+      }
+    end
+
+    def connection
+      Faraday.new(url: API_ENDPOINT, headers: headers) do |conn|
+        conn.request :json
+        conn.response :json
+        conn.adapter :typhoeus, http_version: :httpv2_0 # rubocop:disable Naming/VariableNumber
+      end
+    end
+
+    def request(http_method:, endpoint:, params: {})
+      response = connection.public_send(http_method, endpoint, params)
+      response.body.deep_transform_keys(&:underscore).deep_symbolize_keys
+    end
+  end
+end

data/lib/switchbot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Switchbot
-  VERSION = '0.7.0'
+  VERSION = '0.9.0'
 end

data/lib/switchbot.rb

@@ -8,6 +8,7 @@ require 'faraday/typhoeus'
 require 'active_support/all'
 require_relative 'switchbot/version'
 require_relative 'switchbot/client'
+require_relative 'switchbot/request'
 require_relative 'switchbot/device'
 require_relative 'switchbot/scene'
 require_relative 'switchbot/bot'
@@ -15,6 +16,7 @@ require_relative 'switchbot/light'
 require_relative 'switchbot/humidifier'
 require_relative 'switchbot/color_bulb'
 require_relative 'switchbot/lock'
+require_relative 'switchbot/plug_mini'
 
 module Switchbot
   class Error < StandardError; end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: switchbot
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Yoshiki Takagi
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,6 +128,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/dependabot.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -150,6 +151,8 @@ files:
 - lib/switchbot/humidifier.rb
 - lib/switchbot/light.rb
 - lib/switchbot/lock.rb
+- lib/switchbot/plug_mini.rb
+- lib/switchbot/request.rb
 - lib/switchbot/scene.rb
 - lib/switchbot/version.rb
 - switchbot.gemspec
@@ -161,7 +164,6 @@ metadata:
   source_code_uri: https://github.com/ytkg/switchbot
   changelog_uri: https://github.com/ytkg/switchbot/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,8 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: SwitchBot API client for Ruby
 test_files: []