fritzbox-smarthome 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d754754bef500b80a9c564a254f1df9104e69ba518484a6e1cbecea64332e2b0
-  data.tar.gz: 21b050b1a1e3fbb4810a3b7e6fea598eb877d08588073aa63af6043f75ca87ba
+  metadata.gz: b8e0195a6e63ff7455d046a2795abecb92cc7f90534f2e66780b7b55a36e867c
+  data.tar.gz: b3813af3a7b38b0fac17bb83bd24bea5d312cd7ab0db5c5adba39cb983599547
 SHA512:
-  metadata.gz: c5df4e76d262a3d441e68c73abb48f5bda3ad3b588756f2344f1a8dd174e16ccaf98d4858d87beb45bebf96a99dca6e1a434c9c3b0db078b1474ff2264a81dba
-  data.tar.gz: 13637177a564bead4b2a331fd18fd2ec90677b3aa117b4be69d3bcda6b5f9f574763b178c88e5bd2fe6e166d087380ca963c0df6b3aea3561ffec855980d4f2c
+  metadata.gz: 0ba494fb0ba09894f97696a94c471f486cec8bc820fe1c02467f2071fc384bb94df6864e0f4d85e399e7851e6123061c036093048b7cde96369aa02352d38e92
+  data.tar.gz: f58785489fab952caa6a37c10a32385f7eb14d55f1712ea034f2fced9e98b480840c6277642e264a76e902aae4166fd87c84e11deacff4165b342cd27b50ec4b

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.1.2

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # 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
+
+## v0.3.0
+
+* Use generic Actor class for unrecognised device
+* Allow usage in rails up to 7.1.x
+* Use ruby 3.1.x in development
+* Update a other dependencies
+
 ## v0.2.0
 
 **Attention**: This release contains breaking changes! Check [README](README.md) for new interface.

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
 
@@ -38,7 +39,7 @@ end
 actors = Fritzbox::Smarthome::Actor.all
 
 # Get all actors of type Heater
-heaters = Fritzbox::Smarthome::Heaters.all
+heaters = Fritzbox::Smarthome::Heater.all
 heaters.last.update_hkr_temp_set(BigDecimal('21.5'))
 ```
 

data/fritzbox-smarthome.gemspec

@@ -20,14 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 5.1', '< 6.2'
-  spec.add_dependency 'activemodel', '>= 5.1', '< 6.2'
-  spec.add_dependency 'httparty', '~> 0.16'
+  spec.add_dependency 'activesupport', '>= 5.1', '<= 7.1'
+  spec.add_dependency 'activemodel', '>= 5.1', '<= 7.1'
+  spec.add_dependency 'httparty', '~> 0.20'
   spec.add_dependency 'nori', '~> 2.6'
-  spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'nokogiri', '~> 1.13'
 
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.3'
-  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.add_development_dependency 'webmock', '~> 3.14'
+  spec.add_development_dependency 'byebug', '~> 11.1'
 end

data/lib/fritzbox/smarthome/actor.rb

@@ -17,7 +17,7 @@ module Fritzbox
           response = get(command: 'getdevicelistinfos')
           xml = nori.parse(response.body)
           Array.wrap(types.map { |type| xml.dig('devicelist', type) }.flatten).compact.map do |data|
-            klass = Actor.descendants.find { |k| k.match?(data) }
+            klass = Actor.descendants.find { |k| k.match?(data) } || Actor
             self.in?([klass, Actor]) ? klass.new_from_api(data) : nil
           end.compact
         end
@@ -28,8 +28,8 @@ module Fritzbox
             type:          data.dig('groupinfo').present? ? :group : :device,
             ain:           data.dig('@identifier').to_s,
             present:       data.dig('present') == '1',
-            name:          data.dig('name').to_s,
-            manufacturer:  data.dig('manufacturer').to_s,
+            name:          (data.dig('name') || data.dig('@productname')).to_s,
+            manufacturer:  (data.dig('manufacturer') || data.dig('@manufacturer')).to_s,
             group_members: data.dig('groupinfo', 'members').to_s.split(',').presence
           )
         end

data/lib/fritzbox/smarthome/lightbulb.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Fritzbox
+  module Smarthome
+    class Lightbulb < Actor
+
+      include Properties::SimpleOnOff
+
+      class << self
+        def match?(data)
+          data.fetch('@productname', '') =~ /FRITZ!DECT 5\d{2}/i
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/null_logger.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Fritzbox
+  module Smarthome
+    class NullLogger < Logger
+      def initialize(*_args)
+        super(File::NULL)
+      end
+    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/resource.rb

@@ -2,11 +2,18 @@ module Fritzbox
   module Smarthome
     class Resource
       class << self
-        def get(command:, ain: nil, param: nil)
+        # @param params [Hash] key/value pairs that will be appended to the switchcmd query string
+        def get(command:, ain: nil, param: nil, **params)
           url = "#{config.endpoint}/webservices/homeautoswitch.lua?switchcmd=#{command}&sid=#{authenticate}"
           url = "#{url}&ain=#{ain}"     if ain.present?
           url = "#{url}&param=#{param}" if param.present?
 
+          params.each_with_object(url) do |(key, value)|
+            url = "#{url}&#{key}=#{value}"
+          end
+
+          config.logger.debug(url)
+
           HTTParty.get(url, **httparty_options)
         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.2.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/lib/fritzbox/smarthome.rb

@@ -4,11 +4,14 @@ require 'httparty'
 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'
 require 'fritzbox/smarthome/switch'
 require 'fritzbox/smarthome/smoke_detector'
+require 'fritzbox/smarthome/lightbulb'
 
 module Fritzbox
   module Smarthome
@@ -28,7 +31,7 @@ module Fritzbox
       defaults.username   = 'smarthome'
       defaults.password   = 'verysmart'
       defaults.verify_ssl = true
-      defaults.logger     = nil
+      defaults.logger     = NullLogger.new
     end
 
     class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Klaus Meyer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,23 +47,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,42 +112,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11.1'
 description: ''
 email:
 - spam@klaus-meyer.net
@@ -171,6 +171,10 @@ files:
 - lib/fritzbox/smarthome.rb
 - lib/fritzbox/smarthome/actor.rb
 - 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
@@ -179,7 +183,7 @@ homepage: https://github.com/klausmeyer/fritzbox-smarthome
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,8 +198,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Client library to interface with Smarthome features of your FritzBox
 test_files: []