fritzbox-smarthome 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 430136a0736fded1a9e2cf308cdeb00129e94514259915306146fc65be4fb04a
-  data.tar.gz: 8755e3f921c2c815b1e6d38d3372bcfff068e6a8aa7a47785d07213585e67101
+  metadata.gz: b8e0195a6e63ff7455d046a2795abecb92cc7f90534f2e66780b7b55a36e867c
+  data.tar.gz: b3813af3a7b38b0fac17bb83bd24bea5d312cd7ab0db5c5adba39cb983599547
 SHA512:
-  metadata.gz: 94ac858e01f25649f9171df8cf685658b4a4e17f5c230a1394569c37d3052444ed1b155d8eb9a58d61fc056eb471347ee5c0c163b0a777651a8abceac4a3c76a
-  data.tar.gz: 198756b6e8a1d7d2cfcf886e26f5e2efd3d75eb655d2533e94074c936b42da531d58147ceba13e3a54b5e621f66fe99f56fe5652cbdd6c2b64294a095fa5e22e
+  metadata.gz: 0ba494fb0ba09894f97696a94c471f486cec8bc820fe1c02467f2071fc384bb94df6864e0f4d85e399e7851e6123061c036093048b7cde96369aa02352d38e92
+  data.tar.gz: f58785489fab952caa6a37c10a32385f7eb14d55f1712ea034f2fced9e98b480840c6277642e264a76e902aae4166fd87c84e11deacff4165b342cd27b50ec4b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v0.5.0
+
+* Unify on/off interface
+  * Provides `#active?` and `#toggle!` methods
+  * Adds new functionality to `Switch`
+  * Replacing own implementation in `Lightbulb`
+
 ## v0.4.0
 
 * Add support for Fritz!DECT lightbulbs

data/README.md

@@ -5,6 +5,7 @@ Ruby client library to interface with Smarthome features of your FritzBox.
 Currently implemented actor types:
 
 * Heater
+* Lightbulb
 * SmokeDetector
 * Switch
 

data/lib/fritzbox/smarthome/lightbulb.rb

@@ -4,32 +4,12 @@ module Fritzbox
   module Smarthome
     class Lightbulb < Actor
 
-      attr_accessor \
-        :simpleonoff_state
+      include Properties::SimpleOnOff
 
       class << self
         def match?(data)
           data.fetch('@productname', '') =~ /FRITZ!DECT 5\d{2}/i
         end
-
-        def new_from_api(data)
-          instance = super
-          instance.assign_attributes(
-            simpleonoff_state:   data.dig('simpleonoff', 'state').to_i,
-          )
-          instance
-        end
-      end
-
-      def active?
-        simpleonoff_state == 1
-      end
-
-      def toggle!
-        value = active? ? 0 : 1
-        response = self.class.get(command: 'setsimpleonoff', ain: ain, onoff: value)
-
-        response.ok? && @simpleonoff_state = value
       end
     end
   end

data/lib/fritzbox/smarthome/properties/simple_on_off.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Fritzbox
+  module Smarthome
+    module Properties
+      # Defines a common interface/behaviour for actors with the "simpleonoff" state.
+      # The including class is expected to have an `ain` attribute defined.
+      module SimpleOnOff
+        extend ActiveSupport::Concern
+
+        included do
+          attr_accessor :simpleonoff_state
+        end
+
+        module ClassMethods
+          def new_from_api(data)
+            instance = defined?(super) ? super : new
+            instance.simpleonoff_state = data.dig('simpleonoff', 'state').to_i
+            instance
+          end
+        end
+
+        # @return [Boolean]
+        def active?
+          simpleonoff_state.to_s == "1"
+        end
+
+        # Makes a request to the Fritzbox and set the current instance's active state.
+        #
+        # The instance state is kept in memory and not checked with the Fritzbox state. It is
+        # possible that the device is switched on/off through other means.
+        #
+        # @example
+        #     lightbulb.active?
+        #     # => true
+        #     lightbulb.toggle!
+        #     # => 0
+        #     lightbulb.active?
+        #     # => false
+        # @return [false, Integer] Returns the new on/off state or false when the request
+        #     was unsuccessful
+        # @raise [ArgumentError] if the including class does not respond to `#ain`
+        def toggle!
+          raise ArgumentError, "Attribute `ain` is missing on #{inspect}" unless respond_to?(:ain)
+          value = active? ? 0 : 1
+          response =
+            Fritzbox::Smarthome::Resource.get(command: 'setsimpleonoff', ain: ain, onoff: value)
+
+          response.ok? && @simpleonoff_state = value
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/properties.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'fritzbox/smarthome/properties/simple_on_off'
+
+module Fritzbox
+  module Smarthome
+    module Properties
+    end
+  end
+end

data/lib/fritzbox/smarthome/switch.rb

@@ -2,12 +2,13 @@ module Fritzbox
   module Smarthome
     class Switch < Actor
 
+      include Properties::SimpleOnOff
+
       attr_accessor \
         :switch_state,
         :switch_mode,
         :switch_lock,
         :switch_devicelock,
-        :simpleonoff_state,
         :powermeter_voltage,
         :powermeter_power,
         :powermeter_energy,
@@ -26,7 +27,6 @@ module Fritzbox
             switch_mode:         data.dig('switch', 'mode').to_s,
             switch_lock:         data.dig('switch', 'lock').to_i,
             switch_devicelock:   data.dig('switch', 'devicelock').to_i,
-            simpleonoff_state:   data.dig('simpleonoff', 'state').to_i,
             powermeter_voltage:  data.dig('powermeter', 'voltage').to_i,
             powermeter_power:    data.dig('powermeter', 'power').to_i,
             powermeter_energy:   data.dig('powermeter', 'energy').to_i,

data/lib/fritzbox/smarthome/version.rb

@@ -1,5 +1,5 @@
 module Fritzbox
   module Smarthome
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/lib/fritzbox/smarthome.rb

@@ -5,6 +5,7 @@ require 'nori'
 
 require 'fritzbox/smarthome/version'
 require 'fritzbox/smarthome/null_logger'
+require 'fritzbox/smarthome/properties'
 require 'fritzbox/smarthome/resource'
 require 'fritzbox/smarthome/actor'
 require 'fritzbox/smarthome/heater'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Klaus Meyer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -173,6 +173,8 @@ files:
 - lib/fritzbox/smarthome/heater.rb
 - lib/fritzbox/smarthome/lightbulb.rb
 - lib/fritzbox/smarthome/null_logger.rb
+- lib/fritzbox/smarthome/properties.rb
+- lib/fritzbox/smarthome/properties/simple_on_off.rb
 - lib/fritzbox/smarthome/resource.rb
 - lib/fritzbox/smarthome/smoke_detector.rb
 - lib/fritzbox/smarthome/switch.rb