homewizard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf2be37844f8ebf7f1f75f5101f82880a7b42bd6459775205c8116a2a7f3e301
+  data.tar.gz: 9337540f203e196510e389e8fc92ef144793e944b02d64fdac2aac09758cf42c
+SHA512:
+  metadata.gz: 9f9207c361c6af79b868518870fedba224b11553a05d5d2fa8ee14f3095c8ae47f99da34925805c296c56c02125649ddf5e568a0817d7d806847a84115c2df23
+  data.tar.gz: 4c171b7732cdd144cfa44ae2873d22c9dfb40fc3fa6e7dc839d2adc627dda164d07b4bab3246e5680e5323d8c6c1a7be56c195b0dda447343304b40a06ed8d40

data/.env.template

@@ -0,0 +1,2 @@
+HOMEWIZARD_P1_API_HOST=http://192.1.2.3
+HOMEWIZARD_ENERGY_METER=http://192.1.2.4

data/.gitignore

@@ -0,0 +1,45 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/data/
+*.log
+*.txt
+*.json
+*.yml
+.DS_Store
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-24
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hudu.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+# Hudu API
+[![Version](https://img.shields.io/gem/v/homewizard.svg)](https://rubygems.org/gems/hudu)
+
+This is a wrapper for the HomeWizard rest API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'homewizard'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install homewizard
+
+## Usage
+
+Before you start making the requests to API provide the endpoint using the configuration wrapping.
+
+```ruby
+require 'homewizard'
+require 'logger'
+
+# use do block
+HomeWizard.configure do |config|
+  config.endpoint = ENV['HOMEWIZARD_P1_API_HOST'].downcase
+end
+
+# or configure with options hash
+client = HomeWizard.client({ logger: Logger.new('debug.log) })
+
+# check api version
+return unless if client.device_info.api_version.eql? 'v1'
+
+# get last data
+data = client.recent_data
+
+if data.active_power_w < 0
+  # do something to use energy
+
+end
+```
+
+## Resources
+Endpoint for data related requests
+
+|Resource|API endpoint|
+|:--|:--|
+|.recent_data                      | /api/v1/data|
+|.socket_state                     | /api/v1/state|
+|.telegram                         | /api/v1/telegram|
+|.identify                         | /api/v1/identify|
+
+## Publishing
+
+1. Update version in [version.rb](lib/homewizard/version.rb).
+2. Add release to [CHANGELOG.md](CHANGELOG.md)
+3. Commit.
+4. Test build.
+```
+> rake build
+
+```
+5. Release
+```
+> rake release
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/homewizard.
+
+## 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,19 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'dotenv'
+require 'rake/testtask'
+
+Dotenv.load
+
+#system './bin/cc-test-reporter before-build'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+task default: %i[test rubocop]
+#system './bin/cc-test-reporter after-build'

data/homewizard.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/homewizard/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'homewizard'
+  s.version     = HomeWizard::VERSION
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
+
+  s.summary     = 'A Ruby wrapper for the HomeWizard APIs (readonly)'
+  s.homepage    = 'https://rubygems.org/gems/homewizard'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/homewizard'
+
+  # 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.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.platform = Gem::Platform::RUBY
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'wrapi', ">= 0.3.0"
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop'
+end

data/lib/homewizard/api.rb

@@ -0,0 +1,34 @@
+require "wrapi"
+#require File.expand_path('authentication', __dir__)
+#require File.expand_path('configuration', __dir__)
+
+module HomeWizard
+  # @private
+  class API
+
+    # @private
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = HomeWizard.options.merge(options)
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+#    include Configuration
+    include WrAPI::Connection
+    include WrAPI::Request
+#    include WrAPI::Authentication
+#    include Authentication
+  end
+end

data/lib/homewizard/client.rb

@@ -0,0 +1,56 @@
+require File.expand_path('api', __dir__)
+require File.expand_path('error', __dir__)
+
+module HomeWizard
+  # Wrapper for the HomeWizard REST API
+  #
+  # @see https://api-documentation.homewizard.com/docs/introduction/
+  class Client < API
+    attr_reader :device_info
+    # get client to access P1 meter
+    # @return [P1Client]
+    def initialize(options = {})
+      # create client and copy access_token and set default headers
+      super(options)
+      @device_info = product_info
+      puts "* probably incompatible api version" unless 'v1'.eql? product_info.api_version
+    rescue Faraday::ForbiddenError => e
+      raise APInotEnabledError.new e.response[:body]['error']
+    end
+    # return api path
+    def self.url(method)
+      path = method ? "v1/#{method}" : ''
+      "/api/#{path}"
+    end
+
+
+  private
+    def self.api_endpoint(method, path = nil, valid_devices = nil)
+
+      _url = self.url(path)
+      # all records
+      self.send(:define_method, method) do |params = {}|
+        if valid_devices && !valid_devices.include?(@device_info.product_type)
+          raise DeviceTypeError.new "Method #{method} not available for this device #{@device_info.product_name}"
+        end
+        r = get(_url, params)
+      end
+    end
+
+  public
+    # return device information
+    # product_type
+    # product_name
+    # serial
+    # firmware_version
+    # api_version
+    # devices: HWE-P1, HWE-SKT,	HWE-WTR, HWE-KWH1 and SDM230-wifi,	HWE-KWH3 and SDM630-wifi
+    api_endpoint :product_info
+    # devices: HWE-P1, HWE-SKT,	HWE-WTR, HWE-KWH1 and SDM230-wifi,	HWE-KWH3 and SDM630-wifi
+    api_endpoint :recent_measurement, 'data', ['HWE-P1', 'HWE-SKT']
+    api_endpoint :socket_state, 'state', ['HWE-SKT']
+    api_endpoint :telegram, 'telegram', ['HWE-P1']
+    api_endpoint :identify, 'identify', ['HWE-P1', 'HWE-SKT']
+
+  end
+end

data/lib/homewizard/error.rb

@@ -0,0 +1,11 @@
+module HomeWizard
+
+  # Generic error to be able to rescue all Hudu errors
+  class HomeWizardError < StandardError; end
+
+  # Wrong api for given device
+  class APInotEnabledError < HomeWizardError; end
+
+  # Wrong api for given device
+  class DeviceTypeError < HomeWizardError; end
+end

data/lib/homewizard/version.rb

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

data/lib/homewizard.rb

@@ -0,0 +1,20 @@
+require "wrapi"
+require File.expand_path('homewizard/client', __dir__)
+
+module HomeWizard
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  DEFAULT_UA = 'Ruby HomeWizard API client'
+  #
+  # @return [Hudu::Client]
+  def self.client(options = {})
+    HomeWizard::Client.new({ user_agent: DEFAULT_UA }.merge(options))
+  end
+
+  def self.reset
+    super
+    self.endpoint = nil
+    self.user_agent = DEFAULT_UA
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: homewizard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janco Tanis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wrapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: gems@jancology.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- homewizard.gemspec
+- lib/homewizard.rb
+- lib/homewizard/api.rb
+- lib/homewizard/client.rb
+- lib/homewizard/error.rb
+- lib/homewizard/version.rb
+homepage: https://rubygems.org/gems/homewizard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/homewizard
+  source_code_uri: https://github.com/jancotanis/homewizard
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.12
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the HomeWizard APIs (readonly)
+test_files: []