huginn_renault_ze_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '01902892554eb864a1604eca1b1a67a7862b303e554fa6a1cf14d9a6aecde79b'
+  data.tar.gz: 81941e9c27ce5150f5ecb106009eba991338adcaf2ade30ec82b0eb53fde2f84
+SHA512:
+  metadata.gz: 76e40fd3e92b95940f1c0cf1f32bc8a356e6d44636e229be69fc143403ab3b221e44b375279ee357913480fcd3a6aa65ac458445a2cbb535fbbd8fd3015913ee
+  data.tar.gz: ded77044f591baee5679d4b3a6d4501b8889a8afbd364a9cb14487ae67fb43639b408a5bb70e5066a33a1e421806cc9bfb8a85523dae6bebf9a3d395abcd909b

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2019 Adrian Schoenig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/huginn_renault_ze_agent.rb

@@ -0,0 +1,6 @@
+require 'huginn_agent'
+require 'renault_ze/renault_ze_connect'
+
+# HuginnAgent.load 'huginn_renault_ze_agent/concerns/my_agent_concern'
+# HuginnAgent.register 'huginn_renault_ze_agent/renault_ze_agent'
+HuginnAgent.register 'huginn_renault_ze_agent/renault_ze_battery_agent'

data/lib/huginn_renault_ze_agent/renault_ze_agent.rb

@@ -0,0 +1,29 @@
+module Agents
+  class RenaultZeAgent < Agent
+    default_schedule '12h'
+
+    description <<-MD
+      Add a Agent description here
+    MD
+
+    def default_options
+      {
+      }
+    end
+
+    def validate_options
+    end
+
+    def working?
+      # Implement me! Maybe one of these next two lines would be a good fit?
+      # checked_without_error?
+      # received_event_without_error?
+    end
+
+#    def check
+#    end
+
+#    def receive(incoming_events)
+#    end
+  end
+end

data/lib/huginn_renault_ze_agent/renault_ze_battery_agent.rb

@@ -0,0 +1,45 @@
+module Agents
+  class RenaultZeBatteryAgent < Agent
+    default_schedule 'every_5h'
+
+    cannot_receive_events!
+
+    description <<-MD
+      The Renault ZE Battery Agent checks the battery status of your Renault.
+
+      To authenticate you need to either set the `username` and `password`, or
+      provide credentials named `renault_ze_username` and `renault_ze_password`.
+    MD
+
+    def default_options
+      {
+        "username" => "",
+        "password" => ""
+      }
+    end
+
+    form_configurable :username
+    form_configurable :password
+
+    def validate_options
+      errors.add(:base, "you need to specify your Renault ZE username or provide a credential names renault_ze_username") unless options["username"].present? || credential("renault_ze_username").present?
+      errors.add(:base, "you need to specify your Renault ZE password or provide a credential names renault_ze_password") unless options["password"].present? || credential("renault_ze_password").present?
+    end
+
+    def working?
+      checked_without_error?
+    end
+
+    def check
+      username = interpolated["username"].present? ? interpolated["username"] : credential("renault_ze_username")
+      password = interpolated["password"].present? ? interpolated["password"] : credential("renault_ze_password")
+      service = RenaultZE::Client.new(username, password)
+      content = service.get_battery(service.login())
+
+      return if memory["last_update"] == content["last_update"]
+      memory["last_update"] = content["last_update"]
+      create_event payload: content
+    end
+
+  end
+end

data/lib/renault_ze/renault_ze_connect.rb

@@ -0,0 +1,31 @@
+module RenaultZE
+  class Client
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def login
+      response = HTTParty.post(
+        "https://www.services.renault-ze.com/api/user/login", 
+        body: {username: @username, password: @password}.to_json
+      )
+      content = JSON.parse response
+      return {
+        token: content["token"],
+        vin: content["user"]["vehicle_details"]["VIN"]
+      }
+    end
+
+    def get_battery(creds)
+      response = HTTParty.get(
+        "https://www.services.renault-ze.com/api/vehicle/#{creds[:vin]}/battery",
+        headers: {"Authorization": "Bearer #{creds["token"]}"}
+      )
+
+      result = JSON.parse response
+      result["last_update"] = result["last_update"] / 1000
+      return result
+    end
+  end
+end

data/spec/renault_ze_agent_spec.rb

@@ -0,0 +1,13 @@
+# require 'rails_helper'
+# require 'huginn_agent/spec_helper'
+
+# describe Agents::RenaultZeAgent do
+#   before(:each) do
+#     @valid_options = Agents::RenaultZeAgent.new.default_options
+#     @checker = Agents::RenaultZeAgent.new(:name => "RenaultZeAgent", :options => @valid_options)
+#     @checker.user = users(:bob)
+#     @checker.save!
+#   end
+
+#   pending "add specs here"
+# end

data/spec/renault_ze_battery_agent_spec.rb

@@ -0,0 +1,67 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::RenaultZeBatteryAgent do
+  before(:each) do
+    @valid_options = {
+      "username" => "some_username",
+      "password" => "some_password"
+    }
+    @checker = Agents::RenaultZeBatteryAgent.new(:name => "RenaultZeBatteryAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.memory = {}
+    @checker.save!
+  end
+
+  describe "#validate_options" do
+    before do
+      expect(@checker).to be_valid
+    end
+
+    it "should reject an empty username" do
+      @checker.options["username"] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should reject an empty password" do
+      @checker.options["password"] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should allow credentials (instead of providing as options)" do
+      @checker.user.user_credentials.create :credential_name => "renault_ze_username", :credential_value => "some_username"
+      @checker.user.user_credentials.create :credential_name => "renault_ze_password", :credential_value => "some_password"
+      @checker.options["username"] = nil
+      @checker.options["password"] = nil
+      expect(@checker).to be_valid
+    end
+  end
+
+  describe "#check" do
+    before do
+      stub_login = {"token": "some_token", "user": {"vehicle_details": {"VIN": "some_vin"}}}
+      stub_battery = {"charge_level": 40, "charging": false, "last_update": 1554572276000, "remaining_range": 115.0}
+
+      stub_request(:post, "https://www.services.renault-ze.com/api/user/login")
+        .to_return(:status => 200, :body => JSON.dump(stub_login), :headers => {})
+      
+      stub_request(:get, "https://www.services.renault-ze.com/api/vehicle/some_vin/battery")
+        .to_return(:status => 200, :body => JSON.dump(stub_battery), :headers => {})
+    end
+
+    it "should execute the query and emit a new event with battery status" do
+      expect { @checker.check }.to change {Event.count}.by(1)
+
+      event = Event.last
+      expect(event.payload['charge_level']).to eq(40)
+      expect(event.payload['charging']).to eq(false)
+      expect(event.payload['last_update']).to eq(1554572276) # sic
+      expect(event.payload['remaining_range']).to eq(115)
+    end
+
+    it "shouldn't emit the same status again if the timestamp didn't change"  do
+      expect { @checker.check }.to change {Event.count}.by(1)
+      expect { @checker.check }.to change {Event.count}.by(0)
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: huginn_renault_ze_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Adrian Schoenig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  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: Write a longer description or delete this line.
+email:
+- adrian.schoenig@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_renault_ze_agent.rb
+- lib/huginn_renault_ze_agent/renault_ze_agent.rb
+- lib/huginn_renault_ze_agent/renault_ze_battery_agent.rb
+- lib/renault_ze/renault_ze_connect.rb
+- spec/renault_ze_agent_spec.rb
+- spec/renault_ze_battery_agent_spec.rb
+homepage: https://github.com/nighthawk/huginn_renault_ze_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/renault_ze_battery_agent_spec.rb
+- spec/renault_ze_agent_spec.rb