switchbot 0.2.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 990f1f755928da1c7b552986461ef23fe759e174fa3bfac50e71c302a1602769
-  data.tar.gz: cf07e66ff95980862c53a24cda08c930d0e5b51f4c3b08bf17b663198294a5af
+  metadata.gz: b35104bc79a51e707f6a2295423a135e5ee06380eb4f5b2ad14b1fea15a72288
+  data.tar.gz: d01885018b1ff8759a6ac2c8b1e2c14704d2e15105b282e74c24cc2a937a8f84
 SHA512:
-  metadata.gz: c1aadb12d0af5102103b9304aeae71300ca75e7828552bb43ed778a91c39e6b38999a00717e1e090cc7f388dd7ce024f7ca5b6bb0aa3af562be05b1598c6cf04
-  data.tar.gz: 774fbf9e8bb38df81d15af448c29aa0b0b1b10a1523f24b545e1181736f2b6692dc0d44a4d34f82e2e3c452aeab34218a63564e3423a1c020384cdf10c83774f
+  metadata.gz: a3ecbbc03b18cbf6e7650f0171b645055a25eb541f1115b689fb7cde2a34a622f2f6ee898944fd45dacbd6cc6ebbbb0b0478bcdfb0e9e6703938fe24716c76e9
+  data.tar.gz: 6c0fcb55db5bb61d78ed247dc2dc9c40a269dc4bed68a27832b1a22f74a718d68055f1fa40483603fc33c771be6f77ff0cd4980deee43f89b9928703162ac7bd

data/.github/workflows/main.yml

@@ -5,12 +5,17 @@ on: [push,pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1]
+    name: Ruby ${{ matrix.ruby }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.5.7
+        ruby-version: ${{ matrix.ruby }}
     - name: Run the default task
       run: |
         gem install bundler -v 2.2.4

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.5
   NewCops: enable
 
 Style/Documentation:

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 ## Unreleased
-[full changelog](http://github.com/ytkg/switchbot/compare/v0.2.0...main)
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.5.1...main)
+
+## v0.5.1
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.5.0...v0.5.1)
+
+* Enable MFA requirement for gem releasing
+  * https://github.com/ytkg/switchbot/pull/11
+
+## v0.5.0
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.4.0...v0.5.0)
+
+* Add Bot
+  * https://github.com/ytkg/switchbot/pull/9
+
+## v0.4.0
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.3.0...v0.4.0)
+
+* 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
+
+## v0.3.0
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.2.0...v0.3.0)
+
+* Add `Device#on` and `Device#off`
+  * https://github.com/ytkg/switchbot/pull/4
+* Add Device#commands
+  * https://github.com/ytkg/switchbot/pull/3
 
 ## v0.2.0
 [full changelog](http://github.com/ytkg/switchbot/compare/v0.1.0...v0.2.0)

data/README.md

@@ -20,13 +20,15 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```ruby
 require 'switchbot'
 
 client = Switchbot::Client.new('YOUR_TOKEN')
+```
 
-# Get device list
-#   GET https://api.switch-bot.com/v1.0/devices
+### Get device list
+GET https://api.switch-bot.com/v1.0/devices
+```ruby
 client.devices
 #=> {:status_code=>100,
 #    :body=>
@@ -42,9 +44,11 @@ client.devices
 #         :remote_type=>"TV",
 #         :hub_device_id=>"FA7310762361"}]},
 #    :message=>"success"}
+```
 
-# Get device status
-#   GET https://api.switch-bot.com/v1.0/devices/C271111EC0AB/status
+### 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
@@ -56,16 +60,24 @@ client.device('C271111EC0AB').status
 #      :humidity=>52,
 #      :temperature=>26.1},
 #    :message=>"success"}
+```
 
-# Send device control commands
-#   POST https://api.switch-bot.com/v1.0/devices/210/commands
+### 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
+### Get scene list
+GET https://api.switch-bot.com/v1.0/scenes
+```ruby
 client.scenes
 #=> {:status_code=>100,
 #    :body=>
@@ -80,9 +92,11 @@ client.scenes
 #      {: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
+### 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

data/lib/switchbot/bot.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Switchbot
+  class Bot < Device
+    def press
+      commands(command: 'press')
+    end
+  end
+end

data/lib/switchbot/client.rb

@@ -56,6 +56,18 @@ module Switchbot
       )
     end
 
+    def bot(device_id)
+      Bot.new(client: self, device_id: device_id)
+    end
+
+    def light(device_id)
+      Light.new(client: self, device_id: device_id)
+    end
+
+    def humidifier(device_id)
+      Humidifier.new(client: self, device_id: device_id)
+    end
+
     private
 
     def headers

data/lib/switchbot/device.rb

@@ -12,5 +12,25 @@ module Switchbot
     def status
       client.status(device_id: device_id)
     end
+
+    def commands(command:, parameter: 'default', command_type: 'command')
+      client.commands(device_id: device_id, command: command, parameter: parameter, command_type: command_type)
+    end
+
+    def on
+      client.commands(device_id: device_id, command: 'turnOn')
+    end
+
+    def off
+      client.commands(device_id: device_id, command: 'turnOff')
+    end
+
+    def on?
+      status[:body][:power] == 'on'
+    end
+
+    def off?
+      !on?
+    end
   end
 end

data/lib/switchbot/humidifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Switchbot
+  class Humidifier < Device
+    def mode(value)
+      commands(command: 'setMode', parameter: value.to_s)
+    end
+
+    def auto
+      mode(:auto)
+    end
+
+    def low
+      mode(101)
+    end
+
+    def medium
+      mode(102)
+    end
+
+    def high
+      mode(103)
+    end
+  end
+end

data/lib/switchbot/light.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Switchbot
+  class Light < Device
+    def brightness_up
+      commands(command: 'brightnessUp')
+    end
+
+    def brightness_down
+      commands(command: 'brightnessDown')
+    end
+  end
+end

data/lib/switchbot/version.rb

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

data/lib/switchbot.rb

@@ -8,6 +8,9 @@ require_relative 'switchbot/version'
 require_relative 'switchbot/client'
 require_relative 'switchbot/device'
 require_relative 'switchbot/scene'
+require_relative 'switchbot/bot'
+require_relative 'switchbot/light'
+require_relative 'switchbot/humidifier'
 
 module Switchbot
   class Error < StandardError; end

data/switchbot.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/ytkg/switchbot'
   spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -37,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'rubocop', '~> 0.80'
+  spec.add_development_dependency 'rubocop', '>= 1.24.1'
   spec.add_development_dependency 'webmock'
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switchbot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Yoshiki Takagi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,16 +98,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 1.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.80'
+        version: 1.24.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -142,8 +142,11 @@ files:
 - bin/console
 - bin/setup
 - lib/switchbot.rb
+- lib/switchbot/bot.rb
 - lib/switchbot/client.rb
 - lib/switchbot/device.rb
+- lib/switchbot/humidifier.rb
+- lib/switchbot/light.rb
 - lib/switchbot/scene.rb
 - lib/switchbot/version.rb
 - switchbot.gemspec
@@ -154,7 +157,8 @@ metadata:
   homepage_uri: https://github.com/ytkg/switchbot
   source_code_uri: https://github.com/ytkg/switchbot
   changelog_uri: https://github.com/ytkg/switchbot/blob/main/CHANGELOG.md
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: SwitchBot API client for Ruby
 test_files: []