fritzbox-smarthome 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 294b43e027f43ddf8c0b3e162c2c4ce5584a11ae6d05c280e5cfadc20e02a165
+  data.tar.gz: c2cb16ea1b9c819e3db06f283d256a24410ac3c8609f0c4a5a9eb68a13be90d9
+SHA512:
+  metadata.gz: b3bcc1d1b6e925823fe7c307f5bc1a040caba8ad00b416e24d228573b38d49237f69c3f7201c7fa72c6c3b1bbd3c8f3b111f8ed7458f825369e04315ca6c1e48
+  data.tar.gz: e1c4af48265f7f3969199040dfc7c3a7f10e98861238f932a94a2511f33b677ee983ea896199da04247794811e4bedc35fec51e1156b50371217e138febef67e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+fritzbox-smarthome

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fritzbox-smarthome.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    fritzbox-smarthome (0.1.0)
+      activemodel (~> 5.1)
+      activesupport (~> 5.1)
+      httparty (~> 0.16)
+      nokogiri (~> 1.8)
+      nori (~> 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (10.0.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    nori (2.6.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  fritzbox-smarthome!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Klaus Meyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Fritzbox::Smarthome
+
+Ruby client library to interface with Smarthome features of your FritzBox.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fritzbox-smarthome'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fritzbox-smarthome
+
+## Usage
+
+```ruby
+Fritzbox::Smarthome.configure do |config|
+  config.endpoint   = 'https://fritz.box'
+  config.username   = 'smarthome'
+  config.password   = 'verysmart'
+  config.verify_ssl = false
+end
+
+actors = Fritzbox::Smarthome::Actor.all
+
+actor = actors.last
+actor.update_hkr_temp_set(BigDecimal.new('21.5'))
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klausmeyer/fritzbox-smarthome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fritzbox/smarthome"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fritzbox-smarthome.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fritzbox/smarthome/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fritzbox-smarthome'
+  spec.version       = Fritzbox::Smarthome::VERSION
+  spec.authors       = ['Klaus Meyer']
+  spec.email         = ['spam@klaus-meyer.net']
+
+  spec.summary       = 'Client library to interface with Smarthome features of your FritzBox'
+  spec.description   = spec.description
+  spec.homepage      = 'https://github.com/klausmeyer/fritzbox-smarthome'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'activemodel', '~> 5.1'
+  spec.add_dependency 'httparty', '~> 0.16'
+  spec.add_dependency 'nori', '~> 2.6'
+  spec.add_dependency 'nokogiri', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.3'
+  spec.add_development_dependency 'byebug', '~> 10.0'
+end

data/lib/fritzbox/smarthome.rb

@@ -0,0 +1,39 @@
+require 'active_model'
+require 'active_support/all'
+require 'httparty'
+require 'nori'
+
+require 'fritzbox/smarthome/version'
+require "fritzbox/smarthome/resource"
+require 'fritzbox/smarthome/actor'
+
+module Fritzbox
+  module Smarthome
+    class Configuration
+      include ActiveModel::Model
+
+      attr_accessor \
+        :endpoint, \
+        :username, \
+        :password,
+        :verify_ssl,
+        :logger
+    end
+
+    @config = Configuration.new.tap do |defaults|
+      defaults.endpoint   = 'https://fritz.box'
+      defaults.username   = 'smarthome'
+      defaults.password   = 'verysmart'
+      defaults.verify_ssl = true
+      defaults.logger     = nil
+    end
+
+    class << self
+      def configure(&block)
+        block.yield(@config)
+      end
+
+      attr_reader :config
+    end
+  end
+end

data/lib/fritzbox/smarthome/actor.rb

@@ -0,0 +1,55 @@
+module Fritzbox
+  module Smarthome
+    class Actor < Resource
+      include ActiveModel::Model
+
+      attr_accessor \
+        :id,
+        :type,
+        :ain,
+        :present,
+        :name,
+        :hkr_temp_is,
+        :hkr_temp_set,
+        :hkr_next_change_period,
+        :hkr_next_change_temp
+
+      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? }
+        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,
+          )
+        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/resource.rb

@@ -0,0 +1,50 @@
+module Fritzbox
+  module Smarthome
+    class Resource
+      class << self
+        def get(command:, ain: nil, param: nil)
+          url = "#{config.endpoint}/webservices/homeautoswitch.lua?switchcmd=#{command}&sid=#{authenticate}"
+          url = "#{url}&ain=#{ain}"     if ain.present?
+          url = "#{url}&param=#{param}" if param.present?
+
+          HTTParty.get(url, **httparty_options)
+        end
+
+        private
+
+        delegate :config, to: Smarthome
+
+        def authenticate
+          response = HTTParty.get(login_endpoint, **httparty_options)
+          xml = nori.parse(response.body)
+          challenge = xml.dig('SessionInfo', 'Challenge')
+
+          md5 = Digest::MD5.hexdigest("#{challenge}-#{config.password}".encode('UTF-16LE'))
+
+          url = "#{login_endpoint}?response=#{challenge}-#{md5}"
+          url = "#{url}&username=#{config.username}" if config.username.present?
+
+          response = HTTParty.get(url, **httparty_options)
+
+          xml = nori.parse(response.body)
+          xml.dig('SessionInfo', 'SID')
+        end
+
+        def login_endpoint
+          "#{config.endpoint}/login_sid.lua"
+        end
+
+        def httparty_options
+          {
+            verify: config.verify_ssl,
+            logger: config.logger
+          }.compact
+        end
+
+        def nori
+          @nori ||= Nori.new
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/version.rb

@@ -0,0 +1,5 @@
+module Fritzbox
+  module Smarthome
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: fritzbox-smarthome
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Klaus Meyer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- spam@klaus-meyer.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fritzbox-smarthome.gemspec
+- lib/fritzbox/smarthome.rb
+- lib/fritzbox/smarthome/actor.rb
+- lib/fritzbox/smarthome/resource.rb
+- lib/fritzbox/smarthome/version.rb
+homepage: https://github.com/klausmeyer/fritzbox-smarthome
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Client library to interface with Smarthome features of your FritzBox
+test_files: []