stekker_easee 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5592a4edc9d574ac3d942adea5527716bb97f15090f33e6829a2e002f5fee5c
+  data.tar.gz: 9e26e2712745636dac113c1abc3282ea705a60f9598998e3d829dfd10222110a
+SHA512:
+  metadata.gz: 836a495d985e421acf2508c2618de4034fb3bae460d1184eb40a09f2127875f6654bfd8a49c7986b7962623ec360addf5fd872d8b6ce54b525fd0f2683bfbe8c
+  data.tar.gz: '06358a19035ef71ea2d7d6a7a071a832b888963feb26a81b8802b595c4ad630afa3947cbdabbbdeab5bfc4d39827d800a7d1db4b680adcefe3caa5e023422bfb'

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: "Ruby"
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    env:
+      RAILS_ENV: test
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4
+        with:
+          bundler-cache: true
+
+      - name: Run tests and Rubocop
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: ../../.rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in easee.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rails", "~> 2.17"
+gem "rubocop-rspec", "~> 2.10"
+gem "timecop", "~> 0.9.6"
+gem "webmock", "~> 3.18"

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    stekker_easee (0.1.0)
+      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)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      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)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      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)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rack (3.0.7)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      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)
+      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 (~> 1.41)
+    rubocop-rails (2.18.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    timecop (0.9.6)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rails (~> 2.17)
+  rubocop-rspec (~> 2.10)
+  stekker_easee!
+  timecop (~> 0.9.6)
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.4.8

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "easee"
+
+# 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/easee.gemspec

@@ -0,0 +1,34 @@
+require_relative "lib/easee/version"
+ruby_version = File.read(".ruby-version").strip
+
+Gem::Specification.new do |spec|
+  spec.name          = "stekker_easee"
+  spec.version       = Easee::VERSION
+  spec.authors       = ["Team Stekker"]
+  spec.email         = ["support@stekker.com"]
+
+  spec.summary       = "Connect to your Easee charger"
+  spec.description   = "Easee connector"
+  spec.homepage      = "https://stekker.com"
+  spec.required_ruby_version = Gem::Requirement.new(">= #{ruby_version}")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/stekker/easee"
+  spec.metadata["changelog_uri"] = "https://github.com/stekker/easee"
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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/client.rb

@@ -0,0 +1,158 @@
+require "active_support/notifications"
+require "active_support/cache"
+
+require_relative "null_encryptor"
+
+module Easee
+  class Client
+    BASE_URL = "https://api.easee.cloud".freeze
+    TOKENS_CACHE_KEY = "easee.auth.tokens".freeze
+
+    def initialize(
+      user_name:,
+      password:,
+      token_cache: ActiveSupport::Cache::MemoryStore.new,
+      encryptor: NullEncryptor.new
+    )
+      @user_name = user_name
+      @password = password
+      @token_cache = token_cache
+      @encryptor = encryptor
+    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 })
+    end
+
+    # https://developer.easee.cloud/reference/post_api-chargers-id-pair
+    def pair(charger_id:, pin_code:)
+      post("/api/chargers/#{charger_id}/pair", query: { pinCode: pin_code })
+    end
+
+    # https://developer.easee.cloud/reference/get_api-chargers-id-state
+    def state(charger_id)
+      get("/api/chargers/#{charger_id}/state")
+        .then { |response| State.new(response.body) }
+    end
+
+    # https://developer.easee.cloud/reference/post_api-chargers-id-commands-pause-charging
+    def pause_charging(charger_id)
+      post("/api/chargers/#{charger_id}/commands/pause_charging")
+    end
+
+    # https://developer.easee.cloud/reference/post_api-chargers-id-commands-resume-charging
+    def resume_charging(charger_id)
+      post("/api/chargers/#{charger_id}/commands/resume_charging")
+    end
+
+    def configuration(charger_id)
+      get("/api/chargers/#{charger_id}/config")
+        .then { |response| Configuration.new(response.body) }
+    end
+
+    def site(charger_id)
+      get("/api/chargers/#{charger_id}/site")
+        .then { |response| Site.new(response.body) }
+    end
+
+    def inspect
+      <<~INSPECT
+        #<#{self.class.name} @user_name="[FILTERED]", @password="[FILTERED]", @token_cache=#{@token_cache.inspect}, @encryptor=#{@encryptor.inspect}>
+      INSPECT
+    end
+
+    private
+
+    attr_reader :user_name, :password
+
+    def connection
+      Faraday.new(url: BASE_URL) do |conn|
+        conn.request :json
+        conn.response :raise_error
+      end
+    end
+
+    def authenticated_connection
+      connection.tap do |conn|
+        conn.request :authorization, "Bearer", access_token
+        conn.response :json, content_type: /\bjson$/
+      end
+    end
+
+    def get(endpoint, query = {})
+      with_error_handling do
+        authenticated_connection.get("#{BASE_URL}#{endpoint}", query)
+      end
+    end
+
+    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 with_error_handling
+      token_refreshed ||= false
+
+      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.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 })
+      end
+
+      plain_text_tokens = @encryptor.decrypt(encrypted_tokens)
+
+      JSON.parse(plain_text_tokens).fetch("accessToken")
+    end
+
+    def refresh_access_token!
+      @token_cache.write(
+        TOKENS_CACHE_KEY,
+        @encryptor.encrypt(refresh_access_token, 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
+      connection
+        .post("/api/accounts/login", userName: user_name, password:)
+        .then(&:body)
+    end
+
+    # https://developer.easee.cloud/reference/post_api-accounts-refresh-token
+    def refresh_access_token
+      tokens = JSON.parse(
+        @encryptor.decrypt(
+          @token_cache.fetch(TOKENS_CACHE_KEY),
+        ),
+      )
+
+      connection
+        .post(
+          "/api/accounts/refresh_token",
+          accessToken: tokens.fetch("accessToken"),
+          refreshToken: tokens.fetch("refreshToken"),
+        )
+        .then(&:body)
+    end
+  end
+end

data/lib/easee/configuration.rb

@@ -0,0 +1,10 @@
+module Easee
+  class Configuration
+    def initialize(data)
+      @data = data.symbolize_keys
+    end
+
+    def phase_mode = @data.fetch(:phaseMode)
+    def max_charger_current = @data.fetch(:maxChargerCurrent)
+  end
+end

data/lib/easee/errors.rb

@@ -0,0 +1,14 @@
+module Easee
+  module Errors
+    class Base < ::StandardError; end
+
+    class RequestFailed < Base
+      attr_reader :response
+
+      def initialize(message, response = nil)
+        @response = response
+        super(message)
+      end
+    end
+  end
+end

data/lib/easee/meter_reading.rb

@@ -0,0 +1,10 @@
+module Easee
+  class MeterReading
+    attr_reader :reading_kwh, :timestamp
+
+    def initialize(reading_kwh:, timestamp:)
+      @reading_kwh = reading_kwh
+      @timestamp = timestamp
+    end
+  end
+end

data/lib/easee/null_encryptor.rb

@@ -0,0 +1,17 @@
+module Easee
+  # 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/easee/site.rb

@@ -0,0 +1,22 @@
+module Easee
+  class Site
+    def initialize(data)
+      @data = data.deep_symbolize_keys
+    end
+
+    def name = @data.fetch(:name)
+    def street = address.fetch(:street)
+    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 latitude = address.fetch(:latitude)
+    def longitude = address.fetch(:longitude)
+
+    private
+
+    def address
+      @address ||= @data.fetch(:address)
+    end
+  end
+end

data/lib/easee/state.rb

@@ -0,0 +1,32 @@
+module Easee
+  class State
+    CHARGER_OP_MODES = {
+      0 => :offline,
+      1 => :disconnected,
+      2 => :awaiting_start,
+      3 => :charging,
+      4 => :completed,
+      5 => :error,
+      6 => :ready_to_charge,
+    }.freeze
+
+    def initialize(data)
+      @data = data.symbolize_keys
+    end
+
+    def charging? = charger_op_mode == :charging
+    def disconnected? = charger_op_mode == :disconnected
+    def online? = @data.fetch(:isOnline)
+
+    def meter_reading
+      MeterReading.new(
+        reading_kwh: @data.fetch(:lifetimeEnergy),
+        timestamp: Time.current,
+      )
+    end
+
+    private
+
+    def charger_op_mode = CHARGER_OP_MODES.fetch(@data.fetch(:chargerOpMode))
+  end
+end

data/lib/easee/version.rb

@@ -0,0 +1,3 @@
+module Easee
+  VERSION = "0.1.0".freeze
+end

data/lib/stekker_easee.rb

@@ -0,0 +1,15 @@
+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

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: stekker_easee
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Team Stekker
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: activesupport
+  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: 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: 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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/console
+- bin/setup
+- easee.gemspec
+- lib/easee/client.rb
+- lib/easee/configuration.rb
+- lib/easee/errors.rb
+- lib/easee/meter_reading.rb
+- lib/easee/null_encryptor.rb
+- lib/easee/site.rb
+- lib/easee/state.rb
+- lib/easee/version.rb
+- lib/stekker_easee.rb
+homepage: https://stekker.com
+licenses: []
+metadata:
+  homepage_uri: https://stekker.com
+  source_code_uri: https://github.com/stekker/easee
+  changelog_uri: https://github.com/stekker/easee
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Connect to your Easee charger
+test_files: []