RubyGems - stekker_zaptec - Versions diffs - 1.1.1 → 1.2.1 - Mend

stekker_zaptec 1.1.1 → 1.2.1

Files changed (21) hide show

checksums.yaml +4 -4
data/.github/workflows/ruby.yml +1 -1
data/.rubocop.yml +201 -238
data/.ruby-version +1 -1
data/Gemfile +1 -0
data/Gemfile.lock +41 -30
data/README.md +12 -0
data/bin/release +28 -0
data/lib/stekker_zaptec.rb +4 -0
data/lib/zaptec/charger.rb +8 -32
data/lib/zaptec/circuit.rb +14 -0
data/lib/zaptec/client.rb +114 -37
data/lib/zaptec/constants.rb +16 -0
data/lib/zaptec/credentials.rb +11 -0
data/lib/zaptec/errors.rb +8 -1
data/lib/zaptec/installation.rb +15 -0
data/lib/zaptec/installation_hierarchy.rb +15 -0
data/lib/zaptec/null_encryptor.rb +17 -0
data/lib/zaptec/state.rb +1 -1
data/lib/zaptec/version.rb +1 -1
metadata +9 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b93472771162eced218695ad47612b8d001d0b562669077af092de5ac5733d81
-  data.tar.gz: 78d184fb7979d966be2944c575a70444372555ea78101163f78c8565b5a90cec
+  metadata.gz: 91b9631174d32dc32bd0844c8fa0d96bf6b484a39c9318cf25b31fc8f76956a8
+  data.tar.gz: ab0ac00f5cc38aca2e70a8a4ad2f954e31e4796a30dac919c8a849862d471bda
 SHA512:
-  metadata.gz: d9930219d2b59aea5968498626b3289e40762a83afdfbd177605e4909ec9424cf588ca62f29b6162bce63803f4a4dd4a1ee06631451251cc547fb8678712bfc4
-  data.tar.gz: 5674b39478d6d644036f4ea5e85794e5331ef0440775d83ee21c46e36fd98e0f77e5b09d5e112f9c0238a7269fbf784a52449f08a55a05c9e8738bf870af2b07
+  metadata.gz: 16c452cd49022e999f5e3250804a75359296088a573de565fcc7b8d2e27358c5308fba53eed8d3859efcee0dd0d5202c0224a52f0ea01f2c272d14a439425b9a
+  data.tar.gz: 5ef016998af407c8edf1fb1364af5e7a88e0cf2ceea241f4f8e9228308ec63e874a547991ebd3feb4caa8fff46144f72058accde785abba8a3d84902d129d308

data/.github/workflows/ruby.yml CHANGED Viewed

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v3
       - name: Install Ruby and gems
-        uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4
+        uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true

data/.rubocop.yml CHANGED Viewed

@@ -1,383 +1,346 @@
 require:
-  - rubocop-rails
   - rubocop-rspec
 AllCops:
   NewCops: enable
-  Exclude:
-    - "vendor/**/*"
-    - "bin/**/*"
-    - "node_modules/**/*"
-    - "db/schema.rb"
-    - "db/sequent_schema.rb"
-    - "db/seeds.rb"
-    - "db/seed/**/*"
-    - "db/migrate/**/*"
-Rails/EnvironmentVariableAccess:
-  AllowReads: true
-Rails/HasAndBelongsToMany:
-  Enabled: false
-RSpec/VerifiedDoubles:
+Layout/BeginEndAlignment:
   Enabled: true
-  Exclude:
-    - "spec/components/previews/**/*"
-Style/MultilineBlockChain:
-  Enabled: false
+Layout/BlockAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_block
-RSpec/NoExpectationExample:
-  Exclude:
-    - "spec/domain/**/*"
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
-Style/SymbolArray:
-  EnforcedStyle: brackets
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
-Metrics/ParameterLists:
+Layout/FirstArgumentIndentation:
   Enabled: true
-  CountKeywordArgs: false
+  EnforcedStyle: consistent
-Style/NumericLiterals:
-  Enabled: false
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: never
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
-Style/GuardClause:
-  Enabled: false
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
-Style/ClassAndModuleChildren:
-  Enabled: false
+Layout/FirstHashElementLineBreak:
+  Enabled: true
-Lint/DuplicateBranch:
-  Enabled: false
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
-Lint/RaiseException:
+Layout/FirstParameterIndentation:
   Enabled: true
+  EnforcedStyle: consistent
-Rails/SkipsModelValidations:
-  Enabled: false
+Layout/LineLength:
+  Enabled: true
+  Max: 115
-Lint/StructNewOverride:
+Layout/MultilineArrayBraceLayout:
   Enabled: true
+  EnforcedStyle: new_line
-Rails:
+Layout/MultilineArrayLineBreaks:
   Enabled: true
-Style/AccessorGrouping:
+Layout/MultilineHashBraceLayout:
   Enabled: true
+  EnforcedStyle: new_line
-Style/IfInsideElse:
-  Enabled: false
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
-Rails/LexicallyScopedActionFilter:
-  Enabled: false
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
-Style/BisectedAttrAccessor:
+Layout/MultilineMethodCallBraceLayout:
   Enabled: true
-Style/RedundantAssignment:
+  EnforcedStyle: new_line
+Layout/MultilineMethodCallIndentation:
   Enabled: true
-Rails/ActiveRecordCallbacksOrder:
+  EnforcedStyle: indented
+Layout/SpaceAroundMethodCallOperator:
   Enabled: true
-Rails/FindById:
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
   Enabled: true
-Rails/Inquiry:
-  Enabled: false
-Rails/MailerName:
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
-Rails/MatchRoute:
+Lint/ConstantDefinitionInBlock:
   Enabled: true
-Rails/NegateInclude:
+Lint/DeprecatedOpenSSLConstant:
   Enabled: true
-Rails/Pluck:
+Lint/DuplicateBranch:
+  Enabled: false
+Lint/DuplicateElsifCondition:
   Enabled: true
-Rails/PluckInWhere:
+Lint/DuplicateRequire:
   Enabled: true
-Rails/RenderInline:
+Lint/DuplicateRescueException:
   Enabled: true
-Rails/RenderPlainText:
+Lint/EmptyConditionalBody:
   Enabled: true
-Rails/ShortI18n:
+Lint/EmptyFile:
   Enabled: true
-Rails/WhereExists:
+Lint/FloatComparison:
   Enabled: true
-Lint/DuplicateElsifCondition:
+Lint/IdentityComparison:
   Enabled: true
-Style/ArrayCoercion:
+Lint/MissingSuper:
   Enabled: true
-Style/CaseLikeIf:
+Lint/MixedRegexpCaptureTypes:
   Enabled: true
-Style/HashAsLastArrayItem:
+Lint/OutOfRangeRegexpRef:
   Enabled: true
-Style/HashLikeCase:
+Lint/RaiseException:
   Enabled: true
-Style/RedundantFileExtensionInRequire:
+Lint/SelfAssignment:
   Enabled: true
-# Allow emoji in comments
-Style/AsciiComments:
-  Enabled: false
+Lint/StructNewOverride:
+  Enabled: true
-Naming/PredicateName:
+Lint/TopLevelReturnWithArgument:
   Enabled: true
-  ForbiddenPrefixes:
-    is_
-Naming/VariableNumber:
+Lint/TrailingCommaInAttributeDeclaration:
   Enabled: true
-  Exclude:
-    - "spec/**/*"
-    - "gems/we_connect/spec//**/*"
-Style/EmptyMethod:
-  EnforcedStyle: expanded
+Lint/UnreachableLoop:
+  Enabled: true
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+Lint/UselessAssignment:
+  Enabled: true
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-  Exclude:
-    - "spec/**/*"
+Lint/UselessMethodDefinition:
+  Enabled: true
-Layout/TrailingWhitespace:
+Lint/UselessTimes:
   Enabled: true
-  AllowInHeredoc: true
-Metrics/ClassLength:
+Metrics/AbcSize:
   Enabled: false
-Layout/LineLength:
+Metrics/BlockLength:
   Enabled: true
-  Max: 115 # Readable github.com diffs
-Style/Documentation:
+Metrics/ClassLength:
   Enabled: false
-Layout/EmptyLineBetweenDefs:
-  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 42
 Metrics/MethodLength:
   Max: 42
   Exclude:
-    - "**/spec/**/*"
+    - "spec/**/*_spec.rb"
-Metrics/BlockLength:
-  Exclude:
-    - "**/spec/**/*"
-    - "config/routes.rb"
-    - "**/*.gemspec"
-Lint/UselessAssignment:
-  Exclude:
-    - "spec/**/*"
+Metrics/ModuleLength:
+  Enabled: false
-Style/HashEachMethods:
+Metrics/ParameterLists:
+  CountKeywordArgs: false
   Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
+Metrics/PerceivedComplexity:
+  Max: 42
-Style/HashTransformValues:
+Naming/PredicateName:
   Enabled: true
+  ForbiddenPrefixes: is_
-Layout/SpaceAroundMethodCallOperator:
+Naming/VariableNumber:
   Enabled: true
-Style/ExponentialNotation:
-  Enabled: true
+RSpec/AnyInstance:
+  Enabled: false
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
+RSpec/DescribeClass:
+  Enabled: false
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
+RSpec/DescribedClass:
+  Enabled: false
-Style/SlicingWithRange:
-  Enabled: true
+RSpec/ExampleLength:
+  Enabled: false
-Style/IfUnlessModifier:
+RSpec/MultipleExpectations:
   Enabled: false
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
+RSpec/NestedGroups:
+  Max: 4
-Style/RedundantFetchBlock:
-  Enabled: true
+RSpec/NoExpectationExample:
+  Exclude:
+    - spec/domain/**/*
-Style/RedundantRegexpCharacterClass:
+RSpec/VerifiedDoubles:
   Enabled: true
-Style/RedundantRegexpEscape:
+Style/AccessorGrouping:
   Enabled: true
-Metrics/CyclomaticComplexity:
-  Max: 42
-Metrics/PerceivedComplexity:
-  Max: 42
+Style/ArrayCoercion:
+  Enabled: true
-Style/RescueModifier:
+Style/AsciiComments:
   Enabled: false
-Style/Lambda:
-  EnforcedStyle: literal
+Style/BisectedAttrAccessor:
+  Enabled: true
 Style/BlockDelimiters:
   Enabled: true
-Style/SingleArgumentDig: # (new in 0.89)
+Style/CaseLikeIf:
   Enabled: true
-Lint/BinaryOperatorWithIdenticalOperands: # (new in 0.89)
-  Enabled: true
-Lint/DuplicateRequire: # (new in 0.90)
-  Enabled: true
-Lint/DuplicateRescueException: # (new in 0.89)
-  Enabled: true
-Lint/EmptyConditionalBody: # (new in 0.89)
-  Enabled: true
-Lint/EmptyFile: # (new in 0.90)
-  Enabled: true
-Lint/FloatComparison: # (new in 0.89)
-  Enabled: true
-Lint/MissingSuper: # (new in 0.89)
-  Enabled: true
-Lint/OutOfRangeRegexpRef: # (new in 0.89)
-  Enabled: true
-Lint/SelfAssignment: # (new in 0.89)
-  Enabled: true
-Lint/TopLevelReturnWithArgument: # (new in 0.89)
-  Enabled: true
-Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
-  Enabled: true
-Lint/UnreachableLoop: # (new in 0.89)
-  Enabled: true
-Lint/UselessMethodDefinition: # (new in 0.90)
-  Enabled: true
-Style/CombinableLoops: # (new in 0.90)
-  Enabled: true
-Style/ExplicitBlockArgument: # (new in 0.89)
-  Enabled: true
-Style/GlobalStdStream: # (new in 0.89)
-  Enabled: true
-Style/KeywordParametersOrder: # (new in 0.90)
-  Enabled: true
-Style/OptionalBooleanParameter: # (new in 0.89)
-  Enabled: true
-Style/RedundantSelfAssignment: # (new in 0.90)
-  Enabled: true
-Style/SoleNestedConditional: # (new in 0.89)
-  Enabled: true
-Style/StringConcatenation: # (new in 0.89)
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/CombinableLoops:
   Enabled: true
-Metrics/ModuleLength:
+Style/Documentation:
   Enabled: false
-Layout/BeginEndAlignment: # (new in 0.91)
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+Style/ExplicitBlockArgument:
   Enabled: true
-Lint/ConstantDefinitionInBlock: # (new in 0.91)
+Style/ExponentialNotation:
   Enabled: true
-Lint/IdentityComparison: # (new in 0.91)
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+Style/GlobalStdStream:
   Enabled: true
-Lint/UselessTimes: # (new in 0.91)
+Style/GuardClause:
+  Enabled: false
+Style/HashAsLastArrayItem:
   Enabled: true
-Rails/AfterCommitOverride: # (new in 2.8)
+Style/HashEachMethods:
   Enabled: true
-Rails/SquishedSQLHeredocs: # (new in 2.8)
+Style/HashLikeCase:
   Enabled: true
-Rails/WhereNot: # (new in 2.8)
+Style/HashTransformKeys:
   Enabled: true
-Metrics/AbcSize:
-  Enabled: false
-Rails/UnknownEnv:
-  Environments:
-    - production
-    - development
-    - test
-    - staging
+Style/HashTransformValues:
+  Enabled: true
-RSpec/DescribeClass:
-  Enabled: false
-RSpec/DescribedClass:
-  Enabled: false
-RSpec/NestedGroups:
-  Max: 4
-RSpec/MultipleExpectations:
+Style/IfInsideElse:
   Enabled: false
-RSpec/ExampleLength:
+Style/IfUnlessModifier:
   Enabled: false
-RSpec/AnyInstance:
+Style/KeywordParametersOrder:
+  Enabled: true
+Style/Lambda:
+  EnforcedStyle: literal
+Style/MultilineBlockChain:
   Enabled: false
-# No translations needed in Admin, for now:
-Rails/I18nLocaleTexts:
-  Exclude:
-    - "app/controllers/admin/**/*"
+Style/NumericLiterals:
+  Enabled: false
-##
-# Multi-line formatting (hashes)
-##
-Layout/FirstHashElementLineBreak:
+Style/OptionalBooleanParameter:
   Enabled: true
-Layout/FirstHashElementIndentation:
+Style/RedundantAssignment:
   Enabled: true
-  EnforcedStyle: consistent
-Layout/MultilineHashBraceLayout:
+Style/RedundantFetchBlock:
   Enabled: true
-  EnforcedStyle: new_line
-Layout/MultilineHashKeyLineBreaks:
+Style/RedundantFileExtensionInRequire:
   Enabled: true
-##
-# Multi-line formatting (array)
-##
-Layout/FirstArrayElementLineBreak:
+Style/RedundantRegexpCharacterClass:
   Enabled: true
-Layout/FirstArrayElementIndentation:
+Style/RedundantRegexpEscape:
   Enabled: true
-  EnforcedStyle: consistent
-Layout/MultilineArrayBraceLayout:
+Style/RedundantSelfAssignment:
   Enabled: true
-  EnforcedStyle: new_line
-Layout/MultilineArrayLineBreaks:
-  Enabled: true
+Style/RescueModifier:
+  Enabled: false
-##
-# Multi-line formatting (methods/arguments/blocks)
-##
-Layout/FirstMethodArgumentLineBreak:
+Style/SingleArgumentDig:
   Enabled: true
-Layout/FirstArgumentIndentation:
+Style/SlicingWithRange:
   Enabled: true
-  EnforcedStyle: consistent
-Layout/FirstParameterIndentation:
+Style/SoleNestedConditional:
   Enabled: true
-  EnforcedStyle: consistent
-Layout/MultilineMethodCallBraceLayout:
+Style/StringConcatenation:
   Enabled: true
-  EnforcedStyle: new_line
-Layout/MultilineMethodArgumentLineBreaks:
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/TrailingCommaInArguments:
   Enabled: true
+  EnforcedStyleForMultiline: comma
-Layout/MultilineMethodCallIndentation:
+Style/TrailingCommaInArrayLiteral:
   Enabled: true
-  EnforcedStyle: indented
+  EnforcedStyleForMultiline: comma
-Layout/BlockAlignment:
+Style/TrailingCommaInHashLiteral:
   Enabled: true
-  EnforcedStyleAlignWith: start_of_block
+  EnforcedStyleForMultiline: comma

data/.ruby-version CHANGED Viewed

	@@ -1 +1 @@
1	- 3.0.2
1	+ 3.2.1

data/Gemfile CHANGED Viewed

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in zaptec.gemspec
 gemspec
+gem "gem-release", "~> 2.2"
 gem "jwt", "~> 2.6"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stekker_zaptec (1.1.1)
+    stekker_zaptec (1.2.1)
       activemodel
       activesupport
       faraday
@@ -10,17 +10,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activesupport (7.0.4.2)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    concurrent-ruby (1.2.0)
+    base64 (0.1.1)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
@@ -49,63 +50,72 @@ GEM
     faraday-retry (1.0.3)
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
+    gem-release (2.2.2)
     hashdiff (1.0.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    jwt (2.6.0)
-    minitest (5.17.0)
+    jwt (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
     multipart-post (2.3.0)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
-    rack (3.0.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rack (3.0.8)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.2)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.44.1)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    rubocop-capybara (2.17.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
-    rubocop-rails (2.17.4)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rails (2.21.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-    rubocop-rspec (2.18.1)
+    rubocop-rspec (2.24.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.11.0)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    timecop (0.9.6)
+    timecop (0.9.8)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -118,6 +128,7 @@ PLATFORMS
   x86_64-linux
 DEPENDENCIES
+  gem-release (~> 2.2)
   jwt (~> 2.6)
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md CHANGED Viewed

@@ -63,3 +63,15 @@ client.state(id, device_type_apollo).online?
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/stekker/zaptec.
+## Publishing
+```bash
+# - bumps the gem version to the next major, minor or patch version.
+# - creates commit for the version bump
+# - tags the commit
+# - pushes the commit and tag
+# - publishes the gem to Rubygems
+bin/release [major|minor|patch]
+# See also https://github.com/svenfuchs/gem-release#gem-bump
+```

data/bin/release ADDED Viewed

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+# Read major/minor/patch argument
+version="$1"
+# Do a pretend version bump to determine what the new version should be
+bumped_version=$(gem bump "$version" --pretend --no-commit | awk '{ print $4 }' | tr -d '[:space:]')
+# Use ruby to get the root level directory name
+gem_name=$(ruby -e "puts File.basename(Dir.pwd)")
+# Update version file
+gem bump --version "$bumped_version" --no-commit
+# Run bundle install to ensure gem version in Gemfile is updated
+bundle install
+# Stage Gemfile.lock and the version file
+git add Gemfile.lock "lib/$gem_name/version.rb"
+# Finally create the bump commit
+git commit -m "Bump $gem_name to $bumped_version"
+# Create a tag, push the commit and tag, and release to Rubygems
+gem bump --version "$bumped_version" --no-commit --tag --push --release

data/lib/stekker_zaptec.rb CHANGED Viewed

@@ -4,11 +4,15 @@ require "active_model"
 require "active_support/all"
 require "zaptec/charger"
+require "zaptec/circuit"
 require "zaptec/client"
 require "zaptec/constants"
 require "zaptec/credentials"
 require "zaptec/errors"
+require "zaptec/installation"
+require "zaptec/installation_hierarchy"
 require "zaptec/meter_reading"
+require "zaptec/null_encryptor"
 require "zaptec/state"
 require "zaptec/version"

data/lib/zaptec/charger.rb CHANGED Viewed

@@ -1,38 +1,14 @@
 module Zaptec
   class Charger
-    attr_reader :id,
-                :name,
-                :device_id,
-                :device_type,
-                :installation_name,
-                :installation_id
-    def initialize(
-      id:,
-      name:,
-      device_id:,
-      device_type:,
-      installation_name:,
-      installation_id:
-    )
-      @id = id
-      @name = name
-      @device_id = device_id
-      @device_type = device_type
-      @installation_name = installation_name
-      @installation_id = installation_id
+    def initialize(data)
+      @data = data.symbolize_keys
     end
-    def self.parse(data)
-      new(
-        id: data.fetch("Id"),
-        name: data.fetch("Name"),
-        device_id: data.fetch("DeviceId"),
-        device_type: data.fetch("DeviceType"),
-        installation_name: data.fetch("InstallationName"),
-        installation_id: data.fetch("InstallationId")
-      )
-    end
+    def id = @data.fetch(:Id)
+    def name = @data.fetch(:Name)
+    def device_id = @data.fetch(:DeviceId)
+    def device_type = @data.fetch(:DeviceType)
+    def installation_name = @data.fetch(:InstallationName)
+    def installation_id = @data.fetch(:InstallationId)
   end
 end

data/lib/zaptec/circuit.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module Zaptec
+  class Circuit
+    def initialize(data)
+      @data = data.symbolize_keys
+    end
+    def id = @data.fetch(:Id)
+    def max_current = @data.fetch(:MaxCurrent)
+    def chargers
+      @chargers ||= @data.fetch(:Chargers).map { |data| Charger.new(data) }
+    end
+  end
+end

data/lib/zaptec/client.rb CHANGED Viewed

@@ -1,10 +1,11 @@
 module Zaptec
   class Client
-    BASE_URI = "https://api.zaptec.com".freeze
+    BASE_URL = "https://api.zaptec.com".freeze
     USER_ROLE = 1
     OWNER_ROLE = 2
+    TOKENS_CACHE_KEY = "zaptec.auth.tokens".freeze
-    attr_reader :http_client, :credentials
+    attr_reader :credentials
     delegate :expired?,
              :access_token,
@@ -12,37 +13,45 @@ module Zaptec
              to: :credentials,
              prefix: true
-    def initialize(credentials: nil)
-      @credentials = credentials
+    def initialize(
+      username:,
+      password:,
+      token_cache: ActiveSupport::Cache::MemoryStore.new,
+      encryptor: NullEncryptor.new
+    )
+      @username = username
+      @password = password
+      @token_cache = token_cache
+      @encryptor = encryptor
+    end
-      @http_client = Faraday.new(url: BASE_URI) do |conn|
-        conn.request :json
-        conn.response :json
-        conn.response :raise_error
-      end
+    # https://zendesk.zaptec.com/hc/en-001/articles/6062673456657-Access-to-Installations-Authentication-for-Third-Parties#lookup-key-0-0
+    def grant_access_url(lookup_key:, partner_name:, redirect_url: nil, language: "en")
+      query = URI.encode_www_form(partnerName: partner_name, returnUrl: redirect_url, lang: language)
+      "https://portal.zaptec.com/#!/access/request/#{lookup_key}?#{query}"
     end
     # https://zaptec.com/downloads/ZapChargerPro_Integration.pdf
     def authorize(username:, password:)
       raise Errors::ParameterMissing if username.blank? || password.blank?
-      start = Time.zone.now
+      start = Time.current
-      response = http_client.post(
-        "#{BASE_URI}/oauth/token",
+      response = connection.post(
+        "#{BASE_URL}/oauth/token",
         {
-          username: username,
-          password: password,
-          grant_type: "password"
+          username:,
+          password:,
+          grant_type: "password",
         }.to_query,
         {
-          "Content-Type": "application/x-www-form-urlencoded"
-        }
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
       )
       @credentials = Zaptec::Credentials.new(
         response.body["access_token"],
-        start + response.body["expires_in"].to_f
+        start + response.body["expires_in"].to_f,
       )
     rescue Faraday::BadRequestError
       raise Errors::AuthorizationFailed
@@ -53,7 +62,19 @@ module Zaptec
       get("/api/chargers", { Roles: USER_ROLE | OWNER_ROLE })
         .body
         .fetch("Data")
-        .map { |data| Charger.parse(data) }
+        .map { |data| Charger.new(data) }
+    end
+    # https://api.zaptec.com/help/index.html#/Installation/get_api_installation__id_
+    def get_installation(installation_id)
+      get("/api/installation/#{installation_id}")
+        .then { |response| Installation.new(response.body) }
+    end
+    # https://api.zaptec.com/help/index.html#/Installation/get_api_installation__id__hierarchy
+    def get_installation_hierarchy(installation_id)
+      get("/api/installation/#{installation_id}/hierarchy")
+        .then { |response| InstallationHierarchy.new(response.body) }
     end
     # https://api.zaptec.com/help/index.html#/Charger/get_api_chargers__id__state
@@ -62,8 +83,8 @@ module Zaptec
         .body
         .to_h do |state|
           [
-            Constants.observation_state_id_to_name(state_id: state.fetch("StateId"), device_type: device_type),
-            state.fetch("ValueAsString", nil)
+            Constants.observation_state_id_to_name(state_id: state.fetch("StateId"), device_type:),
+            state.fetch("ValueAsString", nil),
           ]
         end
         .then { |data| State.new(data) }
@@ -75,6 +96,22 @@ module Zaptec
     private
+    attr_reader :username, :password
+    def connection
+      Faraday.new(url: BASE_URL) do |conn|
+        conn.request :json
+        conn.response :json
+        conn.response :raise_error
+      end
+    end
+    def authenticated_connection
+      connection.tap do |conn|
+        conn.request :authorization, "Bearer", access_token
+      end
+    end
     # https://api.zaptec.com/help/index.html#/Charger/post_api_chargers__id__sendCommand__commandId_
     def send_command(charger_id, command)
       command_id = Constants.command_to_command_id(command)
@@ -83,29 +120,69 @@ module Zaptec
     end
     def get(endpoint, query = {})
-      require_valid_credentials!
+      with_error_handling do
+        authenticated_connection.get("#{BASE_URL}#{endpoint}", query)
+      end
+    end
-      http_client.get(
-        "#{BASE_URI}#{endpoint}",
-        query,
-        { Authorization: "Bearer #{credentials.access_token}" }
-      )
+    def post(endpoint, body: nil, query: nil)
+      with_error_handling do
+        authenticated_connection.post("#{BASE_URL}#{endpoint}", body) do |req|
+          req.params = query unless query.nil?
+        end
+      end
     end
-    def post(endpoint, body = nil)
-      require_valid_credentials!
+    def with_error_handling
+      token_refreshed ||= false
-      http_client.post(
-        "#{BASE_URI}#{endpoint}",
-        body,
-        { Authorization: "Bearer #{credentials.access_token}" }
-      )
+      yield
+    rescue Faraday::UnauthorizedError => e
+      if token_refreshed
+        raise Errors::RequestFailed.new("Request returned status #{e.response_status}", e.response)
+      else
+        refresh_access_token!
+        token_refreshed = true
+        retry
+      end
     rescue Faraday::Error => e
-      raise Errors::RequestFailed, "Request returned status #{e.response_status}"
+      raise Errors::RequestFailed.new("Request returned status #{e.response_status}", e.response)
+    end
+    def access_token
+      current_access_token
+        .then do |current|
+          if current.expired?
+            refresh_access_token!
+            current_access_token
+          else
+            current
+          end
+        end
+        .then(&:access_token)
     end
-    def require_valid_credentials!
-      raise Errors::Unauthorized if credentials.blank? || credentials.expired?
+    def current_access_token
+      encrypted_tokens = @token_cache.fetch(TOKENS_CACHE_KEY) do
+        @encryptor.encrypt(request_access_token.to_json, cipher_options: { deterministic: true })
+      end
+      plain_text_tokens = @encryptor.decrypt(encrypted_tokens)
+      Credentials.parse(JSON.parse(plain_text_tokens))
     end
+    def refresh_access_token!
+      @token_cache.write(
+        TOKENS_CACHE_KEY,
+        @encryptor.encrypt(request_access_token.to_json, cipher_options: { deterministic: true }),
+        expires_in: 1.day,
+      )
+    rescue Faraday::Error => e
+      raise Errors::RequestFailed.new("Request returned status #{e.response_status}", e.response)
+    end
+    # https://developer.easee.cloud/reference/post_api-accounts-login
+    def request_access_token = authorize(username:, password:)
   end
 end

data/lib/zaptec/constants.rb CHANGED Viewed

@@ -21,6 +21,22 @@ module Zaptec
           .fetch(command.to_s) { raise "Unknown command '#{command}'" }
       end
+      def country_id_to_country_code(country_id)
+        return if country_id.nil?
+        constants
+          .fetch("Countries")
+          .fetch(country_id)
+          .fetch("Code")
+      end
+      def network_type_to_name(network_type)
+        constants
+          .fetch("NetworkTypes")
+          .detect { |_name, type| type == network_type }
+          .then { |name, _type| name }
+      end
       private
       def device_type_observation_ids(device_type)

data/lib/zaptec/credentials.rb CHANGED Viewed

@@ -10,5 +10,16 @@ module Zaptec
     def expired?(at = Time.zone.now)
       expires_at.nil? || at >= expires_at
     end
+    def self.parse(data)
+      new(
+        data.fetch("access_token"),
+        Time.zone.at(data.fetch("expires_at")),
+      )
+    end
+    def as_json(*)
+      super.merge("expires_at" => expires_at.to_i)
+    end
   end
 end

data/lib/zaptec/errors.rb CHANGED Viewed

@@ -3,7 +3,14 @@ module Zaptec
     class Base < StandardError; end
     class ParameterMissing < Base; end
     class Unauthorized < Base; end
-    class RequestFailed < Base; end
+    class RequestFailed < Base
+      attr_reader :response
+      def initialize(message, response = nil)
+        @response = response
+        super(message)
+      end
+    end
     class AuthorizationFailed < Base; end
   end
 end

data/lib/zaptec/installation.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Zaptec
+  class Installation
+    def initialize(data)
+      @data = data.deep_symbolize_keys
+    end
+    def id = @data.fetch(:Id)
+    def address = @data[:Address]
+    def zip_code = @data[:ZipCode]
+    def city = @data[:City]
+    def latitude = @data[:Latitude]
+    def country_code = Constants.country_id_to_country_code(@data[:CountryId])
+    def longitude = @data[:Longitude]
+  end
+end

data/lib/zaptec/installation_hierarchy.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Zaptec
+  class InstallationHierarchy
+    def initialize(data)
+      @data = data.deep_symbolize_keys
+    end
+    def id = @data.fetch(:Id)
+    def name = @data.fetch(:Name)
+    def network_type = Constants.network_type_to_name(@data.fetch(:NetworkType))
+    def circuits
+      @circuits ||= @data.fetch(:Circuits).map { |data| Circuit.new(data) }
+    end
+  end
+end

data/lib/zaptec/null_encryptor.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module Zaptec
+  # rubocop:disable Lint/UnusedMethodArgument
+  class NullEncryptor
+    def encrypt(clear_text, key_provider: nil, cipher_options: {})
+      clear_text
+    end
+    def decrypt(encrypted_text, key_provider: nil, cipher_options: {})
+      encrypted_text
+    end
+    def encrypted?(_text)
+      false
+    end
+  end
+  # rubocop:enable Lint/UnusedMethodArgument
+end

data/lib/zaptec/state.rb CHANGED Viewed

@@ -20,7 +20,7 @@ module Zaptec
     def online? = @data.fetch(:IsOnline).to_i.positive?
     def meter_reading
-      @meter_reading ||= MeterReading.new(reading_kwh: total_charge_power_session, timestamp: Time.zone.now)
+      @meter_reading ||= MeterReading.new(reading_kwh: total_charge_power, timestamp: Time.zone.now)
     end
     private

data/lib/zaptec/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Zaptec
-  VERSION = "1.1.1".freeze
+  VERSION = "1.2.1".freeze
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stekker_zaptec
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Team Stekker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -83,15 +83,20 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/release
 - bin/setup
 - data/constants.json
 - lib/stekker_zaptec.rb
 - lib/zaptec/charger.rb
+- lib/zaptec/circuit.rb
 - lib/zaptec/client.rb
 - lib/zaptec/constants.rb
 - lib/zaptec/credentials.rb
 - lib/zaptec/errors.rb
+- lib/zaptec/installation.rb
+- lib/zaptec/installation_hierarchy.rb
 - lib/zaptec/meter_reading.rb
+- lib/zaptec/null_encryptor.rb
 - lib/zaptec/state.rb
 - lib/zaptec/version.rb
 - zaptec.gemspec
@@ -110,14 +115,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.2
+      version: 3.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Connect to your Zaptec charger