switchbot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb3387bfe82f6fc5c092ba2f6b668c0480715cfc3e581ffd2999440aaab6998
-  data.tar.gz: a4968d05dd35cbfe7e744a3cbfcde6d48a9c1cc3881ec7ef5d55c1027a6a408b
+  metadata.gz: 990f1f755928da1c7b552986461ef23fe759e174fa3bfac50e71c302a1602769
+  data.tar.gz: cf07e66ff95980862c53a24cda08c930d0e5b51f4c3b08bf17b663198294a5af
 SHA512:
-  metadata.gz: f27d2fc65ac8c77f98d4fc0cc3d8b629acb703a73132e02c8452397ee9fd619b57d0731f83b743a43e3190f79292647d70d55e7775f20490393816133b859494
-  data.tar.gz: 58752367da471d48b7c8b0e5f743600d2c83b69b079005791168e927906cda137626fa5e50a826eb05da5cc123349ffa577d455c82b76508b60ac0223016138b
+  metadata.gz: c1aadb12d0af5102103b9304aeae71300ca75e7828552bb43ed778a91c39e6b38999a00717e1e090cc7f388dd7ce024f7ca5b6bb0aa3af562be05b1598c6cf04
+  data.tar.gz: 774fbf9e8bb38df81d15af448c29aa0b0b1b10a1523f24b545e1181736f2b6692dc0d44a4d34f82e2e3c452aeab34218a63564e3423a1c020384cdf10c83774f

data/.rubocop.yml

@@ -3,3 +3,8 @@ AllCops:
 
 Style/Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - switchbot.gemspec
+    - spec/**/*

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## Unreleased
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.2.0...main)
+
+## v0.2.0
+[full changelog](http://github.com/ytkg/switchbot/compare/v0.1.0...v0.2.0)
+
+* Add resource methods
+  * https://github.com/ytkg/switchbot/pull/2
+* Support scenes endpoint
+  * https://github.com/ytkg/switchbot/pull/1
+
+## v0.1.0
+* first release

data/README.md

@@ -46,6 +46,8 @@ client.devices
 # Get device status
 #   GET https://api.switch-bot.com/v1.0/devices/C271111EC0AB/status
 client.status(device_id: 'C271111EC0AB')
+# or
+client.device('C271111EC0AB').status
 #=> {:status_code=>100,
 #    :body=>
 #     {:device_id=>"C271111EC0AB",
@@ -61,6 +63,32 @@ client.commands(device_id: '210', command: 'turnOn')
 #=> {:status_code=>100,
 #    :body=>{},
 #    :message=>"success"}
+
+# Get scene list
+#   GET https://api.switch-bot.com/v1.0/scenes
+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
+client.execute(scene_id: 'T02-202009221414-48924101')
+# or
+client.scene('T02-202009221414-48924101').execute
+#=> {:status_code=>100,
+#    :body=>{},
+#    :message=>"success"}
 ```
 
 ## Development

data/lib/switchbot.rb

@@ -6,6 +6,8 @@ require 'json'
 require 'active_support/all'
 require_relative 'switchbot/version'
 require_relative 'switchbot/client'
+require_relative 'switchbot/device'
+require_relative 'switchbot/scene'
 
 module Switchbot
   class Error < StandardError; end

data/lib/switchbot/client.rb

@@ -15,6 +15,10 @@ module Switchbot
       )
     end
 
+    def device(device_id)
+      Device.new(client: self, device_id: device_id)
+    end
+
     def status(device_id:)
       request(
         http_method: :get,
@@ -34,6 +38,24 @@ module Switchbot
       )
     end
 
+    def scenes
+      request(
+        http_method: :get,
+        endpoint: 'v1.0/scenes'
+      )
+    end
+
+    def scene(scene_id)
+      Scene.new(client: self, scene_id: scene_id)
+    end
+
+    def execute(scene_id:)
+      request(
+        http_method: :post,
+        endpoint: "/v1.0/scenes/#{scene_id}/execute"
+      )
+    end
+
     private
 
     def headers
@@ -44,7 +66,7 @@ module Switchbot
     end
 
     def connection
-      @connection ||= Faraday.new(url: API_ENDPOINT, headers: headers) do |conn|
+      Faraday.new(url: API_ENDPOINT, headers: headers) do |conn|
         conn.request :json
       end
     end

data/lib/switchbot/device.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Switchbot
+  class Device
+    attr_reader :client, :device_id
+
+    def initialize(client:, device_id:)
+      @client = client
+      @device_id = device_id
+    end
+
+    def status
+      client.status(device_id: device_id)
+    end
+  end
+end

data/lib/switchbot/scene.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Switchbot
+  class Scene
+    attr_reader :client, :scene_id
+
+    def initialize(client:, scene_id:)
+      @client = client
+      @scene_id = scene_id
+    end
+
+    def execute
+      client.execute(scene_id: scene_id)
+    end
+  end
+end

data/lib/switchbot/version.rb

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

data/switchbot.gemspec

@@ -18,7 +18,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"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switchbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yoshiki Takagi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -142,6 +143,8 @@ files:
 - bin/setup
 - lib/switchbot.rb
 - lib/switchbot/client.rb
+- lib/switchbot/device.rb
+- lib/switchbot/scene.rb
 - lib/switchbot/version.rb
 - switchbot.gemspec
 homepage: https://github.com/ytkg/switchbot
@@ -150,6 +153,7 @@ licenses:
 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: 
 rdoc_options: []
 require_paths: