stekker_easee 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5592a4edc9d574ac3d942adea5527716bb97f15090f33e6829a2e002f5fee5c
-  data.tar.gz: 9e26e2712745636dac113c1abc3282ea705a60f9598998e3d829dfd10222110a
+  metadata.gz: f1cb2855dca8dd2bd2bc7670e2da0db9b31c083e6dd35a80c0eacb78031d173f
+  data.tar.gz: 3aabf9fe36a3eb46f2af3062d1daca8db14946e39f6a69002472e0d9a185117d
 SHA512:
-  metadata.gz: 836a495d985e421acf2508c2618de4034fb3bae460d1184eb40a09f2127875f6654bfd8a49c7986b7962623ec360addf5fd872d8b6ce54b525fd0f2683bfbe8c
-  data.tar.gz: '06358a19035ef71ea2d7d6a7a071a832b888963feb26a81b8802b595c4ad630afa3947cbdabbbdeab5bfc4d39827d800a7d1db4b680adcefe3caa5e023422bfb'
+  metadata.gz: b19294d36bbea358b1f67a97b0fd3a726c6d6b113596ce631adf8585b9731dc6af0e258597fe92414ecea34736b6cfd1232253d1b1b4925786e83e94e03b8759
+  data.tar.gz: 1c0d69be491fd212755acaea9fd1b0e7f24801cabe177e7c4aaa419088632d51c9be26b7b4e7db312ffd1394c71051abfeb263bbd0e344f0d83d84887357b38a

data/.github/workflows/ruby.yml

@@ -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

@@ -1 +1,344 @@
-inherit_from: ../../.rubocop.yml
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Layout/BeginEndAlignment:
+  Enabled: true
+
+Layout/BlockAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_block
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Enabled: true
+  Max: 115
+
+Layout/MultilineArrayBraceLayout:
+  Enabled: true
+  EnforcedStyle: new_line
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineHashBraceLayout:
+  Enabled: true
+  EnforcedStyle: new_line
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: true
+  EnforcedStyle: new_line
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+  - spec/**/*
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: false
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRequire:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/EmptyFile:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/IdentityComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/UselessMethodDefinition:
+  Enabled: true
+
+Lint/UselessTimes:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: true
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 42
+
+Metrics/MethodLength:
+  Max: 42
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Max: 42
+
+Naming/PredicateName:
+  Enabled: true
+  ForbiddenPrefixes: is_
+
+Naming/VariableNumber:
+  Enabled: true
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/NoExpectationExample:
+  Exclude:
+  - spec/domain/**/*
+
+RSpec/VerifiedDoubles:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/BlockDelimiters:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CombinableLoops:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/IfInsideElse:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/KeywordParametersOrder:
+  Enabled: true
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RedundantSelfAssignment:
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/SoleNestedConditional:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stekker_easee (0.1.0)
+    stekker_easee (1.0.1)
       activemodel
       activesupport
       faraday
@@ -10,16 +10,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activesupport (7.0.4.3)
+    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)
+    base64 (0.1.1)
     concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
@@ -49,70 +50,81 @@ 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)
-    minitest (5.18.0)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
     multipart-post (2.3.0)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
-    rack (3.0.7)
+      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.7.0)
-    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.1)
+    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.4)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.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.26.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
-    rubocop-rails (2.18.0)
+    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.19.0)
+    rubocop-rspec (2.24.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
+      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)
 
 PLATFORMS
   arm64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
+  gem-release (~> 2.2)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)

data/README.md

@@ -0,0 +1,71 @@
+# Connect to the Easee API
+
+## How to use this without any technical knowledge
+
+With this gem, you can connect to Easee chargers to smart charge your vehicle.
+
+However, for an even more seamless experience, we recommend using
+the [Stekker app](https://stekker.com/?utm_source=github&utm_medium=referral&utm_campaign=opensource). Our mobile app is
+designed to make smart charging effortless, eliminating the need for any configuration. Simply install the app, and it
+will handle the rest. Our app uses advanced algorithms to determine the best times to charge your vehicle, ensuring
+you'll use the most sustainable and cheapest energy available.
+
+## Build your own with this gem
+
+We are proud to introduce this open source project, the Easee charger Ruby gem. As passionate ruby developers, we
+believe in giving back to the community and contributing to the growth of this amazing language. That's why we are
+making our Easee connection accessible to everyone through open source. Our goal is to make smart charging easier and
+more accessible, and we hope that by opening up our project, we can help others in the community achieve their own
+goals.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "stekker_easee"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install stekker_easee
+
+## Usage
+
+You can use this without Rails in the following way:
+
+```
+$ bin/console
+```
+
+```ruby
+client = Easee::Client.new(username: "username@example.com", password: "password")
+# => #<Easee::Client @user_name="[FILTERED]", @password="[FILTERED]", @token_cache=#<ActiveSupport::Cache::MemoryStore entries=0, ...
+
+# This is the charger's serial number
+charger_id = "ABCDEFGH"
+
+# Get the state of a charger
+client.state(charger_id).charging?
+# => false
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stekker/easee.
+
+## 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

@@ -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/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

@@ -30,6 +30,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 +53,13 @@ module Easee
       post("/api/chargers/#{charger_id}/commands/resume_charging")
     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) }
@@ -108,7 +117,11 @@ module Easee
         retry
       end
     rescue Faraday::Error => e
-      raise Errors::RequestFailed.new("Request returned status #{e.response_status}", e.response)
+      if e.response_status == 429 # HTTP 429 TooManyRequests
+        raise Errors::RateLimitExceeded.new("Rate limit exceeded", e.response)
+      else
+        raise Errors::RequestFailed.new("Request returned status #{e.response_status}", e.response)
+      end
     end
 
     def access_token

data/lib/easee/errors.rb

@@ -1,6 +1,8 @@
 module Easee
   module Errors
-    class Base < ::StandardError; end
+    class Base < ::StandardError
+      def retryable? = false
+    end
 
     class RequestFailed < Base
       attr_reader :response
@@ -10,5 +12,9 @@ module Easee
         super(message)
       end
     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 = "0.1.0".freeze
+  VERSION = "1.0.1".freeze
 end

data/lib/stekker_easee.rb

@@ -10,6 +10,7 @@ require_relative "easee/errors"
 require_relative "easee/meter_reading"
 require_relative "easee/site"
 require_relative "easee/state"
+require_relative "easee/charger"
 
 module Easee
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stekker_easee
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Team Stekker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -80,10 +80,13 @@ files:
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - bin/console
+- bin/release
 - bin/setup
 - easee.gemspec
+- lib/easee/charger.rb
 - lib/easee/client.rb
 - lib/easee/configuration.rb
 - lib/easee/errors.rb
@@ -115,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Connect to your Easee charger