fritzbox-smarthome 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c7ffbac57c90de11ee5a6c3419bbd09f175d056c3c770a18f7547a2c9f0c577
-  data.tar.gz: 4dc4fe0984f0cad54c825201c9626d30ed0d7bb9a2a6317f3dcd4bc5933b1943
+  metadata.gz: 37cd022a30a2468d0e2fd1c21ef92435eb43327791d5b946fcf5cde3d3dfeab3
+  data.tar.gz: 21e8a2ff7d347b99e8c865caaa594f56de3356fcd5d0c73dbea65eebb8d8d05b
 SHA512:
-  metadata.gz: f8275eb98a644654fd53a9551340786dd656ff70c1bfe6a5ee07008026ea6a6d9901c18715e7ebb8a6fc3cf5ddb00a7d98296ca99d42782c03073e4f3d9d8086
-  data.tar.gz: ef8dab21f3da0fa823d80ca847e972d7d12b6e8e8d82ee729bce253978902311f21446fe1a9ad2804bfd9cbc3a2495956685edb8127c67a6e7c33aa65b524ad7
+  metadata.gz: 9ae9f2ae8acc810dd26d9f6a0ee4c3372a3ce3bd38db87c13145bd7f5aeedfb384f8df6e5a6109ef7ca57f0cc9bc2521dcac01460b67fa90b268f90ff14246bb
+  data.tar.gz: e2dcc816dd0110f36ce60cfe26ea4a1183b2f8358d8ccf459be84ac3ae2501d8fd7c7f321f750926ba3dd8afec063b95c0f06324a9340d81182959ff14314812

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## 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.
+
+* Add support for more actors types: switches and smoke detector
+* Extract heater specific attributes and logic to own class
+
+## v0.1.3
+
+* avoid nil error in actors:all smart devices request
+
+## v0.1.2
+
+* support rails 6.1
+
+## v0.1.1
+
+* support rails 6.0
+
+## v0.1.0
+
+* Initial release

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in fritzbox-smarthome.gemspec
 gemspec
+
+gem 'rexml' # required by webmock via crack gem

data/README.md

@@ -2,6 +2,12 @@
 
 Ruby client library to interface with Smarthome features of your FritzBox.
 
+Currently implemented actor types:
+
+* Heater
+* SmokeDetector
+* Switch
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,10 +34,12 @@ Fritzbox::Smarthome.configure do |config|
   config.verify_ssl = false
 end
 
+# Get all actors of any type
 actors = Fritzbox::Smarthome::Actor.all
 
-actor = actors.last
-actor.update_hkr_temp_set(BigDecimal.new('21.5'))
+# Get all actors of type Heater
+heaters = Fritzbox::Smarthome::Heater.all
+heaters.last.update_hkr_temp_set(BigDecimal('21.5'))
 ```
 
 ## Development

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

@@ -9,49 +9,31 @@ module Fritzbox
         :ain,
         :present,
         :name,
-        :hkr_temp_is,
-        :hkr_temp_set,
-        :hkr_next_change_period,
-        :hkr_next_change_temp,
+        :manufacturer,
         :group_members
 
       class << self
         def all(types: ['group', 'device'])
           response = get(command: 'getdevicelistinfos')
           xml = nori.parse(response.body)
-
-          Array.wrap(types.map { |type| xml.dig('devicelist', type) }.flatten).map do |data|
-            new_from_api(data)
-          end
-        end
-
-        def only_heaters
-          all.select { |record| record.hkr_temp_is.present? }
+          Array.wrap(types.map { |type| xml.dig('devicelist', type) }.flatten).compact.map do |data|
+            klass = Actor.descendants.find { |k| k.match?(data) } || Actor
+            self.in?([klass, Actor]) ? klass.new_from_api(data) : nil
+          end.compact
         end
 
         def new_from_api(data)
           new(
-            id:                     data.dig('@id').to_s,
-            type:                   data.dig('groupinfo').present? ? :group : :device,
-            ain:                    data.dig('@identifier').to_s,
-            present:                data.dig('present') == '1',
-            name:                   data.dig('name').to_s,
-            hkr_temp_is:            data.dig('hkr', 'tist').to_i * 0.5,
-            hkr_temp_set:           data.dig('hkr', 'tsoll').to_i * 0.5,
-            hkr_next_change_period: Time.at(data.dig('hkr', 'nextchange', 'endperiod').to_i),
-            hkr_next_change_temp:   data.dig('hkr', 'nextchange', 'tchange').to_i * 0.5,
-            group_members:          data.dig('groupinfo', 'members').to_s.split(',').presence
+            id:            data.dig('@id').to_s,
+            type:          data.dig('groupinfo').present? ? :group : :device,
+            ain:           data.dig('@identifier').to_s,
+            present:       data.dig('present') == '1',
+            name:          (data.dig('name') || data.dig('@productname')).to_s,
+            manufacturer:  data.dig('manufacturer').to_s,
+            group_members: data.dig('groupinfo', 'members').to_s.split(',').presence
           )
         end
       end
-
-      def update_hkr_temp_set(value)
-        raise ArgumentError unless value.is_a? BigDecimal
-        value = (value / 0.5).to_i
-        response = self.class.get(command: 'sethkrtsoll', ain: ain, param: value)
-        raise 'Could not set temperature' unless response.body == "#{value}\n"
-        true
-      end
     end
   end
 end

data/lib/fritzbox/smarthome/heater.rb

@@ -0,0 +1,41 @@
+module Fritzbox
+  module Smarthome
+    class Heater < Actor
+
+      attr_accessor \
+        :battery,
+        :batterylow,
+        :hkr_temp_is,
+        :hkr_temp_set,
+        :hkr_next_change_period,
+        :hkr_next_change_temp
+
+      class << self
+        def match?(data)
+          data.key?('hkr')
+        end
+
+        def new_from_api(data)
+          instance = super
+          instance.assign_attributes(
+            battery:                data.dig('battery').to_i,
+            batterylow:             data.dig('batterylow').to_i,
+            hkr_temp_is:            data.dig('hkr', 'tist').to_i * 0.5,
+            hkr_temp_set:           data.dig('hkr', 'tsoll').to_i * 0.5,
+            hkr_next_change_period: Time.at(data.dig('hkr', 'nextchange', 'endperiod').to_i),
+            hkr_next_change_temp:   data.dig('hkr', 'nextchange', 'tchange').to_i * 0.5
+          )
+          instance
+        end
+      end
+
+      def update_hkr_temp_set(value)
+        raise ArgumentError unless value.is_a? BigDecimal
+        value = (value / 0.5).to_i
+        response = self.class.get(command: 'sethkrtsoll', ain: ain, param: value)
+        raise 'Could not set temperature' unless response.body == "#{value}\n"
+        true
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/smoke_detector.rb

@@ -0,0 +1,25 @@
+module Fritzbox
+  module Smarthome
+    class SmokeDetector < Actor
+
+      attr_accessor \
+        :alert_state,
+        :last_alert
+
+      class << self
+        def match?(data)
+          data.key?('alert')
+        end
+
+        def new_from_api(data)
+          instance = super
+          instance.assign_attributes(
+             alert_state: data.dig('alert', 'state').to_i,
+             last_alert:  Time.at(data.dig('alert', 'lastalertchgtimestamp').to_i)
+          )
+          instance
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/switch.rb

@@ -0,0 +1,41 @@
+module Fritzbox
+  module Smarthome
+    class Switch < Actor
+
+      attr_accessor \
+        :switch_state,
+        :switch_mode,
+        :switch_lock,
+        :switch_devicelock,
+        :simpleonoff_state,
+        :powermeter_voltage,
+        :powermeter_power,
+        :powermeter_energy,
+        :temperature_celsius,
+        :temperature_offset
+
+      class << self
+        def match?(data)
+          data.key?('switch')
+        end
+
+        def new_from_api(data)
+          instance = super
+          instance.assign_attributes(
+            switch_state:        data.dig('switch', 'state').to_i,
+            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,
+            temperature_celsius: data.dig('temperature', 'celsius').to_i,
+            temperature_offset:  data.dig('temperature', 'offset').to_i
+          )
+          instance
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/version.rb

@@ -1,5 +1,5 @@
 module Fritzbox
   module Smarthome
-    VERSION = '0.1.2'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/fritzbox/smarthome.rb

@@ -4,8 +4,11 @@ require 'httparty'
 require 'nori'
 
 require 'fritzbox/smarthome/version'
-require "fritzbox/smarthome/resource"
+require 'fritzbox/smarthome/resource'
 require 'fritzbox/smarthome/actor'
+require 'fritzbox/smarthome/heater'
+require 'fritzbox/smarthome/switch'
+require 'fritzbox/smarthome/smoke_detector'
 
 module Fritzbox
   module Smarthome

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Klaus Meyer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-20 00:00:00.000000000 Z
+date: 2022-04-25 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
@@ -160,6 +160,7 @@ files:
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -169,13 +170,16 @@ files:
 - fritzbox-smarthome.gemspec
 - lib/fritzbox/smarthome.rb
 - lib/fritzbox/smarthome/actor.rb
+- lib/fritzbox/smarthome/heater.rb
 - lib/fritzbox/smarthome/resource.rb
+- lib/fritzbox/smarthome/smoke_detector.rb
+- lib/fritzbox/smarthome/switch.rb
 - lib/fritzbox/smarthome/version.rb
 homepage: https://github.com/klausmeyer/fritzbox-smarthome
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,8 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-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: []