switchbot 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63cae60c41beb637fe0fea73a634a4ef3e4f4d32354fe3691d16e0e88a24f9fd
-  data.tar.gz: 9a2aa83c764d5595142d2c07e31c5fd8404ab6ceb4e2f9481801498eeb135f3f
+  metadata.gz: cc3479417cb8f17cdb727ce13981d7bca88163f75bc14419d7fcb1c446a355a0
+  data.tar.gz: a8fb35982f2b10684f89ad3a7bb20604198d24b2966cec99ca81aff5cfc51ce7
 SHA512:
-  metadata.gz: 90501fd6d95b927e0c2d4fb741c384777947765b305ce0e8672f2da72aa62158dc98179cb01f1924af71725cc0d5d2bcf3292e7990f293d543535ba38b16f3f5
-  data.tar.gz: faaf06892d72c0eaf1df45ad1091fcf05e30390d12bac1c3264932216742e2980606fb2b5f050978716b0eb40a0430f5af2f1d2f16c7905ac3b393902603c834
+  metadata.gz: a6f2df352088e371a871e10c8685139a33320c92254fd8ee9231dfc8927090e8fc3643d1dd706e09ca71ccce64646c0b5fceba7e2404e6c45bf38093dd7edef7
+  data.tar.gz: 725ea36d3fedf1f53d383e60dff9fd246865e920d023f98d4978a1f43f0ad68f8c977f28e839d8cc77002bfca9923cf0f7895eb5ff98f7dc8daaf264ca9b78f8

data/.github/workflows/main.yml

@@ -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]
     name: Ruby ${{ matrix.ruby }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - 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,5 +1,26 @@
 ## Unreleased
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.6.0...main)
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.8.0...main)
+
+## v0.8.0
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.7.0...v0.8.0)
+
+* Add Plug Mini
+  * https://github.com/ytkg/switchbot/pull/21
+
+## v0.7.0
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.6.0...v0.7.0)
+
+* 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.
+
+    ```ruby
+    client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')
+    ```
+
+    You must update the app to the latest version, V6.14 or later, in order to get the secret key.
 
 ## v0.6.0
 [full changelog](http://github.com/ytkg/switchbot/compare/v0.5.1...v0.6.0)

data/README-v0.6.0-and-below.md

@@ -0,0 +1,124 @@
+# Switchbot
+
+[SwichBot API](https://github.com/OpenWonderLabs/SwitchBotAPI) client for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'switchbot'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install switchbot
+
+## Usage
+
+```ruby
+require 'switchbot'
+
+client = Switchbot::Client.new('YOUR_TOKEN')
+```
+
+### Get device list
+GET https://api.switch-bot.com/v1.0/devices
+```ruby
+client.devices
+#=> {:status_code=>100,
+#    :body=>
+#     {:device_list=>
+#       [{:device_id=>"500291B269BE",
+#         :device_name=>"Living Room Humidifier",
+#         :device_type=>"Humidifier",
+#         :enable_cloud_service=>true,
+#         :hub_device_id=>"000000000000"}],
+#      :infrared_remote_list=>
+#       [{:device_id=>"02-202008110034-13",
+#         :device_name=>"Living Room TV",
+#         :remote_type=>"TV",
+#         :hub_device_id=>"FA7310762361"}]},
+#    :message=>"success"}
+```
+
+### Get device status
+GET https://api.switch-bot.com/v1.0/devices/C271111EC0AB/status
+```ruby
+client.status(device_id: 'C271111EC0AB')
+# or
+client.device('C271111EC0AB').status
+#=> {:status_code=>100,
+#    :body=>
+#     {:device_id=>"C271111EC0AB",
+#      :device_type=>"Meter",
+#      :hub_device_id=>"FA7310762361",
+#      :humidity=>52,
+#      :temperature=>26.1},
+#    :message=>"success"}
+```
+
+### Send device control commands
+POST https://api.switch-bot.com/v1.0/devices/210/commands
+```ruby
+client.commands(device_id: '210', command: 'turnOn')
+# or
+client.device('C271111EC0AB').commands(command: 'turnOn')
+# or
+client.device('C271111EC0AB').on
+#=> {:status_code=>100,
+#    :body=>{},
+#    :message=>"success"}
+```
+
+### Get scene list
+GET https://api.switch-bot.com/v1.0/scenes
+```ruby
+client.scenes
+#=> {:status_code=>100,
+#    :body=>
+#     [{:scene_id=>"T02-20200804130110",
+#       :scene_name=>"Close Office Devices"},
+#      {:scene_id=>"T02-202009221414-48924101",
+#       :scene_name=>"Set Office AC to 25"},
+#      {:scene_id=>"T02-202011051830-39363561",
+#       :scene_name=>"Set Bedroom to 24"},
+#      {:scene_id=>"T02-202011051831-82928991",
+#       :scene_name=>"Turn off home devices"},
+#      {:scene_id=>"T02-202011062059-26364981",
+#       :scene_name=>"Set Bedroom to 26 degree"}],
+#    :message=>"success"}
+```
+
+### Execute manual scenes
+POST https://api.switch-bot.com/v1.0/scenes/T02-202009221414-48924101/execute
+```ruby
+client.execute(scene_id: 'T02-202009221414-48924101')
+# or
+client.scene('T02-202009221414-48924101').execute
+#=> {:status_code=>100,
+#    :body=>{},
+#    :message=>"success"}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

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
 
@@ -19,15 +19,16 @@ Or install it yourself as:
     $ gem install switchbot
 
 ## Usage
-
 ```ruby
 require 'switchbot'
 
-client = Switchbot::Client.new('YOUR_TOKEN')
+client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')
 ```
 
+For v0.6.0 and below, refer to README-v0.6.0-and-below.md.
+
 ### Get device list
-GET https://api.switch-bot.com/v1.0/devices
+GET https://api.switch-bot.com/v1.1/devices
 ```ruby
 client.devices
 #=> {:status_code=>100,
@@ -47,7 +48,7 @@ client.devices
 ```
 
 ### Get device status
-GET https://api.switch-bot.com/v1.0/devices/C271111EC0AB/status
+GET https://api.switch-bot.com/v1.1/devices/C271111EC0AB/status
 ```ruby
 client.status(device_id: 'C271111EC0AB')
 # or
@@ -63,7 +64,7 @@ client.device('C271111EC0AB').status
 ```
 
 ### Send device control commands
-POST https://api.switch-bot.com/v1.0/devices/210/commands
+POST https://api.switch-bot.com/v1.1/devices/210/commands
 ```ruby
 client.commands(device_id: '210', command: 'turnOn')
 # or
@@ -76,7 +77,7 @@ client.device('C271111EC0AB').on
 ```
 
 ### Get scene list
-GET https://api.switch-bot.com/v1.0/scenes
+GET https://api.switch-bot.com/v1.1/scenes
 ```ruby
 client.scenes
 #=> {:status_code=>100,
@@ -95,7 +96,7 @@ client.scenes
 ```
 
 ### Execute manual scenes
-POST https://api.switch-bot.com/v1.0/scenes/T02-202009221414-48924101/execute
+POST https://api.switch-bot.com/v1.1/scenes/T02-202009221414-48924101/execute
 ```ruby
 client.execute(scene_id: 'T02-202009221414-48924101')
 # or

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

@@ -3,15 +3,17 @@
 module Switchbot
   class Client
     API_ENDPOINT = 'https://api.switch-bot.com'
+    API_VERSION = 'v1.1'
 
-    def initialize(token)
+    def initialize(token, secret)
       @token = token
+      @secret = secret
     end
 
     def devices
       request(
         http_method: :get,
-        endpoint: 'v1.0/devices'
+        endpoint: "/#{API_VERSION}/devices"
       )
     end
 
@@ -22,14 +24,14 @@ module Switchbot
     def status(device_id:)
       request(
         http_method: :get,
-        endpoint: "/v1.0/devices/#{device_id}/status"
+        endpoint: "/#{API_VERSION}/devices/#{device_id}/status"
       )
     end
 
     def commands(device_id:, command:, parameter: 'default', command_type: 'command')
       request(
         http_method: :post,
-        endpoint: "/v1.0/devices/#{device_id}/commands",
+        endpoint: "/#{API_VERSION}/devices/#{device_id}/commands",
         params: {
           command: command,
           parameter: parameter,
@@ -41,7 +43,7 @@ module Switchbot
     def scenes
       request(
         http_method: :get,
-        endpoint: 'v1.0/scenes'
+        endpoint: "/#{API_VERSION}/scenes"
       )
     end
 
@@ -52,7 +54,7 @@ module Switchbot
     def execute(scene_id:)
       request(
         http_method: :post,
-        endpoint: "/v1.0/scenes/#{scene_id}/execute"
+        endpoint: "/#{API_VERSION}/scenes/#{scene_id}/execute"
       )
     end
 
@@ -72,12 +74,27 @@ module Switchbot
       ColorBulb.new(client: self, device_id: device_id)
     end
 
+    def lock(device_id)
+      Lock.new(client: self, device_id: device_id)
+    end
+
+    def plug_mini(device_id)
+      PlugMini.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
+        'Authorization' => @token,
+        'T' => t,
+        'Sign' => sign,
+        'Nonce' => nonce
       }
     end
 
@@ -85,6 +102,7 @@ module Switchbot
       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
 

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Switchbot
+  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
+
+    def unlock
+      commands(command: 'unlock')
+    end
+  end
+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/version.rb

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

data/lib/switchbot.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+require 'base64'
+require 'openssl'
 require 'faraday'
+require 'faraday/typhoeus'
 require 'active_support/all'
 require_relative 'switchbot/version'
 require_relative 'switchbot/client'
@@ -10,6 +14,8 @@ require_relative 'switchbot/bot'
 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

data/switchbot.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'activesupport'
   spec.add_dependency 'faraday', '>= 2.0.0'
+  spec.add_dependency 'faraday-typhoeus'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switchbot
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Yoshiki Takagi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +137,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- README-v0.6.0-and-below.md
 - README.md
 - Rakefile
 - bin/console
@@ -134,6 +149,8 @@ files:
 - lib/switchbot/device.rb
 - lib/switchbot/humidifier.rb
 - lib/switchbot/light.rb
+- lib/switchbot/lock.rb
+- lib/switchbot/plug_mini.rb
 - lib/switchbot/scene.rb
 - lib/switchbot/version.rb
 - switchbot.gemspec
@@ -145,7 +162,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.22
+signing_key:
 specification_version: 4
 summary: SwitchBot API client for Ruby
 test_files: []