stekker_easee 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e78ab3f32f01b4210e1d26b6022e5a5600720c59bca4ccb21f41109cb7add51
-  data.tar.gz: 914f32cb07c37b7d0260a9e6cd9baeb2c51ef0afb8fe1b55e3c25abb09219c79
+  metadata.gz: cc3c3c0ca289246df91530ff1103931b3f0a847b0ccc812c836a1acfa6148b0f
+  data.tar.gz: f2d2eb1332ca65973f256feb4d8546ece4c4af06ca509229b865db7071ebbbc1
 SHA512:
-  metadata.gz: e71594d0bf1f64c3d010d4d0f4df140927266bf3f8537b62c5b04b4ea375bec003bc01bc2d7f2804f26b92c4332718bcdfa8d00630ec480d4599ee7b146a3b69
-  data.tar.gz: 57261c2b415fc0e8bdb8a86de3684afcc554040d1539f7ab3b27cc6897ea4186a22634efb697e4d9bbe1b064bd389d6493e44bba44399afb27772ab04fb59c5f
+  metadata.gz: d2bbbace02bafae50a3adcbf1a75850d84c6f11b720071064aa83cb0eb33134dac2363c1f8f7378a9f90d9f095a8b8c8b28cfd250972df6e3da8c71fe12376bb
+  data.tar.gz: 953c5edf8b8d077a3e2d7a84ee27f88b1f74f214b2e34383378e9e123c72e1d31ba9dcca0a89ae59e8b8cf4c90f1b3ce39da3e58b4d6d1bbf82df66d2224b2ff

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
 
 AllCops:
   NewCops: enable
+  TargetRubyVersion: "3.2.1"
 
 Layout/BeginEndAlignment:
   Enabled: true

data/Gemfile.lock

@@ -1,117 +1,119 @@
 PATH
   remote: .
   specs:
-    stekker_easee (1.0.0)
+    stekker_easee (1.0.2)
       activemodel
       activesupport
       faraday
-      faraday_middleware
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activesupport (7.0.4.3)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    concurrent-ruby (1.2.2)
-    crack (0.4.5)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
-    faraday (1.10.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
     gem-release (2.2.2)
-    hashdiff (1.0.1)
-    i18n (1.12.0)
+    hashdiff (1.1.0)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    minitest (5.18.0)
-    multipart-post (2.3.0)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
-    rack (3.0.7)
+      racc
+    public_suffix (5.0.5)
+    racc (1.7.3)
+    rack (3.0.10)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rake (13.2.0)
+    regexp_parser (2.9.0)
+    rexml (3.3.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.4)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.62.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
-    rubocop-rails (2.18.0)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rails (2.24.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-    rubocop-rspec (2.19.0)
-      rubocop (~> 1.33)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (2.28.0)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.2)
+      rubocop (~> 1.40)
     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)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
+    webmock (3.23.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
@@ -126,4 +128,4 @@ DEPENDENCIES
   webmock (~> 3.18)
 
 BUNDLED WITH
-   2.4.8
+   2.4.6

data/README.md

@@ -61,15 +61,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/stekke
 ## Publishing
 
 ```bash
-# Bump the gem version
-# See https://github.com/svenfuchs/gem-release#gem-bump
-gem bump --version [major|minor|patch]
-
-# Release the gem to rubygems.org
-# See https://github.com/svenfuchs/gem-release#gem-release
-gem release
-
-# Push the commit and tag to git
-git push
-git push --tags
+# - 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

@@ -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 "$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/easee.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activemodel"
   spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency "faraday"
-  spec.add_runtime_dependency "faraday_middleware"
 
   spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/easee/amazon_gw_middleware.rb

@@ -0,0 +1,10 @@
+module Easee
+  class AmazonGwMiddleware < Faraday::Middleware
+    def on_complete(env)
+      return unless env.response_headers["X-Amzn-Errortype"] == "ForbiddenException"
+
+      response_values = Faraday::Response::RaiseError.new.response_values(env)
+      raise(Faraday::ForbiddenError, response_values)
+    end
+  end
+end

data/lib/easee/charger.rb

@@ -0,0 +1,12 @@
+module Easee
+  class Charger
+    def initialize(data)
+      @data = data.symbolize_keys
+    end
+
+    def id = @data.fetch(:id)
+    def name = @data.fetch(:name)
+    def color = @data.fetch(:color)
+    def product_code = @data.fetch(:productCode)
+  end
+end

data/lib/easee/client.rb

@@ -20,6 +20,13 @@ module Easee
       @encryptor = encryptor
     end
 
+    # https://developer.easee.cloud/reference/post_api-accounts-login
+    def login
+      with_error_handling do
+        request_access_token
+      end
+    end
+
     # https://developer.easee.cloud/reference/post_api-chargers-id-unpair
     def unpair(charger_id:, pin_code:)
       post("/api/chargers/#{charger_id}/unpair", query: { pinCode: pin_code })
@@ -30,6 +37,13 @@ module Easee
       post("/api/chargers/#{charger_id}/pair", query: { pinCode: pin_code })
     end
 
+    # https://developer.easee.cloud/reference/get_api-chargers
+    def chargers
+      get("/api/chargers").then do |response|
+        response.body.map { |data| Charger.new(data) }
+      end
+    end
+
     # https://developer.easee.cloud/reference/get_api-chargers-id-state
     def state(charger_id)
       get("/api/chargers/#{charger_id}/state")
@@ -46,11 +60,18 @@ module Easee
       post("/api/chargers/#{charger_id}/commands/resume_charging")
     end
 
+    # https://developer.easee.com/reference/post_api-chargers-chargerid-commands-poll-lifetimeenergy
+    def poll_lifetime_energy(charger_id)
+      post("/api/chargers/#{charger_id}/commands/poll_lifetimeenergy")
+    end
+
+    # https://developer.easee.cloud/reference/get_api-chargers-id-config
     def configuration(charger_id)
       get("/api/chargers/#{charger_id}/config")
         .then { |response| Configuration.new(response.body) }
     end
 
+    # https://developer.easee.cloud/reference/get_api-chargers-id-site
     def site(charger_id)
       get("/api/chargers/#{charger_id}/site")
         .then { |response| Site.new(response.body) }
@@ -70,13 +91,14 @@ module Easee
       Faraday.new(url: BASE_URL) do |conn|
         conn.request :json
         conn.response :raise_error
+        conn.use AmazonGwMiddleware
+        conn.response :json, content_type: /\bjson$/
       end
     end
 
     def authenticated_connection
       connection.tap do |conn|
         conn.request :authorization, "Bearer", access_token
-        conn.response :json, content_type: /\bjson$/
       end
     end
 
@@ -107,13 +129,21 @@ module Easee
 
         retry
       end
+    rescue Faraday::TooManyRequestsError => e
+      raise Errors::RateLimitExceeded.new("Rate limit exceeded", e.response)
+    rescue Faraday::ForbiddenError => e
+      raise Errors::Forbidden, "Access denied to charger"
     rescue Faraday::Error => e
+      if e.response_status == 400 && [100, 727].include?(e.response.dig(:body, "errorCode"))
+        raise Errors::InvalidCredentials, "Invalid username or password"
+      end
+
       raise Errors::RequestFailed.new("Request returned status #{e.response_status}", e.response)
     end
 
     def access_token
       encrypted_tokens = @token_cache.fetch(TOKENS_CACHE_KEY) do
-        @encryptor.encrypt(request_access_token, cipher_options: { deterministic: true })
+        @encryptor.encrypt(request_access_token.to_json, cipher_options: { deterministic: true })
       end
 
       plain_text_tokens = @encryptor.decrypt(encrypted_tokens)
@@ -124,7 +154,7 @@ module Easee
     def refresh_access_token!
       @token_cache.write(
         TOKENS_CACHE_KEY,
-        @encryptor.encrypt(refresh_access_token, cipher_options: { deterministic: true }),
+        @encryptor.encrypt(refresh_access_token.to_json, cipher_options: { deterministic: true }),
         expires_in: 1.day,
       )
     rescue Faraday::Error => e

data/lib/easee/errors.rb

@@ -1,6 +1,10 @@
 module Easee
   module Errors
-    class Base < ::StandardError; end
+    class Base < ::StandardError
+      def retryable? = false
+    end
+
+    class InvalidCredentials < Base; end
 
     class RequestFailed < Base
       attr_reader :response
@@ -10,5 +14,11 @@ module Easee
         super(message)
       end
     end
+
+    class Forbidden < Base; end
+
+    class RateLimitExceeded < RequestFailed
+      def retryable? = true
+    end
   end
 end

data/lib/easee/site.rb

@@ -9,12 +9,14 @@ module Easee
     def building_number = address.fetch(:buildingNumber)
     def zip = address.fetch(:zip)
     def area = address.fetch(:area)
-    def country_id = address.fetch(:country).fetch(:id)
+    def country_id = country[:id]
     def latitude = address.fetch(:latitude)
     def longitude = address.fetch(:longitude)
 
     private
 
+    def country = address.fetch(:country) || {}
+
     def address
       @address ||= @data.fetch(:address)
     end

data/lib/easee/state.rb

@@ -1,5 +1,7 @@
 module Easee
   class State
+    OP_MODE_UNKNOWN = :unknown
+
     CHARGER_OP_MODES = {
       0 => :offline,
       1 => :disconnected,
@@ -21,12 +23,15 @@ module Easee
     def meter_reading
       MeterReading.new(
         reading_kwh: @data.fetch(:lifetimeEnergy),
-        timestamp: Time.current,
+        timestamp: Time.zone.parse(@data.fetch(:latestPulse)),
       )
     end
 
     private
 
-    def charger_op_mode = CHARGER_OP_MODES.fetch(@data.fetch(:chargerOpMode))
+    def charger_op_mode
+      numeric_op_mode = @data.fetch(:chargerOpMode)
+      CHARGER_OP_MODES.fetch(numeric_op_mode) { OP_MODE_UNKNOWN }
+    end
   end
 end

data/lib/easee/version.rb

@@ -1,3 +1,3 @@
 module Easee
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.2".freeze
 end

data/lib/stekker_easee.rb

@@ -1,5 +1,7 @@
 require "faraday"
-require "active_support/core_ext/time/calculations"
+require "active_support/deprecation"
+require "active_support/deprecator"
+require "active_support/core_ext/numeric/time"
 require "active_support/isolated_execution_state"
 require "active_support/core_ext/hash"
 
@@ -10,6 +12,8 @@ require_relative "easee/errors"
 require_relative "easee/meter_reading"
 require_relative "easee/site"
 require_relative "easee/state"
+require_relative "easee/charger"
+require_relative "easee/amazon_gw_middleware"
 
 module Easee
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stekker_easee
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Team Stekker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  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'
 description: Easee connector
 email:
 - support@stekker.com
@@ -83,9 +69,11 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/release
 - bin/setup
 - easee.gemspec
-- lib/easee.rb
+- lib/easee/amazon_gw_middleware.rb
+- lib/easee/charger.rb
 - lib/easee/client.rb
 - lib/easee/configuration.rb
 - lib/easee/errors.rb

data/lib/easee.rb

@@ -1,15 +0,0 @@
-require "faraday"
-require "active_support/core_ext/time/calculations"
-require "active_support/isolated_execution_state"
-require "active_support/core_ext/hash"
-
-require_relative "easee/version"
-require_relative "easee/client"
-require_relative "easee/configuration"
-require_relative "easee/errors"
-require_relative "easee/meter_reading"
-require_relative "easee/site"
-require_relative "easee/state"
-
-module Easee
-end