ruze 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fa802b8dceb6e72c4e9c04b3a0ee3fd0a1c70d2063b0ffae6d46398057b317d
-  data.tar.gz: 9976f664f420a5b351023f3d4bb8ef44947849c752aebbc0c0d8de402dd0a507
+  metadata.gz: 328fbd59ffa961117d42c42029132b42d2109858f2a6f365d067019430d20dba
+  data.tar.gz: eb41527948e38b6d26a713e33afc1a7cf54c8616f1f0360e1e9394eb1e8cba39
 SHA512:
-  metadata.gz: 5b5e04039d1562360d0f237179555b5660e8f0d5369269723f343d689dd9f747c2ff184a6bd68331fa493bb9ae5f75e7801fdf55b8924928efe7fea1525f5691
-  data.tar.gz: 708613986c1f2f35bd215cc2a4099bc2487d7f456200643c8fba86ffef83b132e30a2cf2878337a15d0eb3236d8172a03bb97489f34abb152d2bbb55c7ecf08d
+  metadata.gz: 30b962007b6fb90f95c50ced022dbc381f23f10a015627c0550521e01366a80b74f53b8aa18d79635590b77b0f57f307bc5af838b44209d3dff8b8e1aa72a4ed
+  data.tar.gz: 433d7097c27ea567c3a19387e8d04f6d0f167bac0be43d52ccaf3363ad7df7a1fb6cb76bfbfcf01178f392e55783ef4d8ac447a09f4d80e1da1ab5b8ab891803

data/.rubocop.yml

@@ -4,13 +4,15 @@ AllCops:
   SuggestExtensions: false
 
 Metrics/ClassLength:
-  Max: 170
+  Max: 180
 
 Metrics/MethodLength:
   Max: 20
 
 Metrics/BlockLength:
   Max: 90
+  Exclude:
+    - 'spec/**/*'
 
 Metrics/AbcSize:
   Max: 18

data/README.md

@@ -68,6 +68,33 @@ car.location
 # }
 ```
 
+### Repeated queries
+
+A `Ruze::Car` keeps the data it fetched. To get new data, call `reload`
+and query the car again:
+
+```ruby
+loop do
+  car.reload
+  puts car.battery['batteryLevel']
+  sleep 600
+end
+```
+
+Use one car for all queries. The car logs in once and keeps the login. It
+gets a new token from Renault when the old token expires (after 15 minutes).
+If Renault rejects the login later (HTTP 401 or 403), the car logs in again
+and repeats the query once. Other errors, like a failing server, raise
+`Ruze::Error` without a new login. A new `Ruze::Car` for each query makes 4 more requests, because
+it logs in again and looks up the account and the VIN.
+
+To log each login and each new token, give a logger. Any object with an
+`info` method works:
+
+```ruby
+car = Ruze::Car.new(email, password, logger: Logger.new($stdout))
+```
+
 
 ## Two-factor authentication
 

data/lib/ruze/car.rb

@@ -2,22 +2,62 @@ require_relative 'gigya'
 require_relative 'kamereon'
 
 module Ruze
+  # One Car can be queried repeatedly: it keeps the login and renews the JWT
+  # when needed. Call #reload to fetch fresh vehicle data.
+  #
+  # logger is any object with #info. It gets a message for each login and
+  # each new token.
   class Car
-    def initialize(email, password, vin = nil, device: Ruze::Device.new)
-      gigya = Ruze::Gigya.new(email, password, device: device)
-      @kamereon = Ruze::Kamereon.new(gigya.person_id, gigya.jwt, vin)
+    def initialize(email, password, vin = nil, device: Ruze::Device.new, logger: nil)
+      @email = email
+      @password = password
+      @vin = vin
+      @device = device
+      @logger = logger
+      @gigya = new_gigya
     end
 
     def battery
-      @kamereon.battery
+      with_session { kamereon.battery }
     end
 
     def cockpit
-      @kamereon.cockpit
+      with_session { kamereon.cockpit }
     end
 
     def location
-      @kamereon.location
+      with_session { kamereon.location }
+    end
+
+    # Forgets the vehicle data, but keeps the login
+    def reload
+      @kamereon&.reload
+      self
+    end
+
+    private
+
+    def kamereon
+      @kamereon ||= Ruze::Kamereon.new(@gigya.person_id, -> { @gigya.jwt }, @vin)
+    end
+
+    def new_gigya
+      Ruze::Gigya.new(@email, @password, device: @device, logger: @logger)
+    end
+
+    # A reused login can expire. If Renault rejects it, log in again and retry
+    # once. A fresh login gets no retry, because it would fail the same way.
+    # Other errors (like a failing server) get no new login.
+    def with_session
+      reused = !@kamereon.nil?
+      yield
+    rescue AuthenticationError => e
+      raise unless reused
+
+      @logger&.info("Login expired (#{e.message}), logging in again")
+      @gigya = new_gigya
+      @kamereon = nil
+      yield
     end
   end
 end

data/lib/ruze/errors.rb

@@ -1,6 +1,10 @@
 module Ruze
   class Error < StandardError; end
 
+  # Raised when Renault rejects the login or the token (HTTP 401 or 403).
+  # A new login can help.
+  class AuthenticationError < Error; end
+
   # Raised when Renault/Gigya requires two-factor authentication and no trusted
   # device is available. Run the bootstrap flow (request_verification_code +
   # verify_code) to establish a trusted device.

data/lib/ruze/gigya.rb

@@ -8,12 +8,19 @@ module Ruze
     BASE_URL      = 'https://accounts.eu1.gigya.com'.freeze
     SOCIALIZE_URL = 'https://socialize.eu1.gigya.com'.freeze
 
-    def initialize(email, password, device: Device.new)
+    # Lifetime of a JWT in seconds. A new one is fetched shortly before the
+    # old one expires.
+    JWT_LIFETIME  = 900
+    JWT_MARGIN    = 60
+
+    # logger is any object with #info
+    def initialize(email, password, device: Device.new, logger: nil)
       raise ArgumentError unless email.is_a?(String) && password.is_a?(String)
 
       @email = email
       @password = password
       @device = device
+      @logger = logger
     end
     attr_reader :email, :password, :device
 
@@ -25,13 +32,20 @@ module Ruze
     end
 
     def jwt
-      @jwt ||= dig_from post(
+      return @jwt if @jwt && now < @jwt_expires_at
+
+      login_token = session_cookie_value
+      @logger&.info('Fetching new token')
+      fetched_at = now
+      @jwt = dig_from post(
         "#{BASE_URL}/accounts.getJWT",
         { 'apiKey'      => api_key,
-          'login_token' => session_cookie_value,
+          'login_token' => login_token,
           'fields'      => 'data.personId,data.gigyaDataCenter',
-          'expiration'  => 900 }
+          'expiration'  => JWT_LIFETIME }
       ), label: 'jwt', keys: %w[id_token]
+      @jwt_expires_at = fetched_at + JWT_LIFETIME - JWT_MARGIN
+      @jwt
     end
 
     # Logs in using the trusted device and returns the session cookie value.
@@ -88,6 +102,7 @@ module Ruze
     private
 
     def login(ids = device_ids)
+      @logger&.info('Logging in')
       json = parse post(
         "#{BASE_URL}/accounts.login",
         login_params(ids), cookie: cookie(ids)
@@ -191,6 +206,10 @@ module Ruze
       { gmid: json['gmid'], ucid: json['ucid'] }
     end
 
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
     def cookie(ids)
       "gmid=#{ids[:gmid]}; ucid=#{ids[:ucid]}"
     end
@@ -215,11 +234,16 @@ module Ruze
 
     def dig_from(response, label:, keys:)
       json = parse(response)
-      raise Error, "Error in #{label}: #{error_detail(json)}" unless json['errorCode']&.zero?
+      raise error_class(json), "Error in #{label}: #{error_detail(json)}" unless json['errorCode']&.zero?
 
       json.dig(*keys)
     end
 
+    # The first three digits of a Gigya error code are the HTTP status
+    def error_class(json)
+      json['errorCode'].to_s.start_with?('401', '403') ? AuthenticationError : Error
+    end
+
     def error_detail(json)
       json['errorDetails'] || json['errorMessage'] || "errorCode #{json['errorCode']}"
     end

data/lib/ruze/kamereon.rb

@@ -6,14 +6,19 @@ module Ruze
     BASE_URL = 'https://api-wired-prod-1-euw1.wrd-aws.com/commerce/v1'.freeze
     COUNTRY  = 'DE'.freeze
 
+    # gigya_token is a String or a callable that returns a valid token
     def initialize(person_id, gigya_token, vin = nil)
-      raise ArgumentError unless person_id.is_a?(String) && gigya_token.is_a?(String)
+      raise ArgumentError unless person_id.is_a?(String) && (gigya_token.is_a?(String) || gigya_token.respond_to?(:call))
 
       @person_id = person_id
       @gigya_token = gigya_token
       @vin = vin
     end
-    attr_reader :person_id, :gigya_token
+    attr_reader :person_id
+
+    def gigya_token
+      @gigya_token.respond_to?(:call) ? @gigya_token.call : @gigya_token
+    end
 
     def account_id
       accounts.first['accountId']
@@ -62,6 +67,12 @@ module Ruze
       {}
     end
 
+    # Forgets the vehicle data, but keeps account and VIN
+    def reload
+      @battery = @cockpit = @location = nil
+      self
+    end
+
     private
 
     def api_key
@@ -90,7 +101,8 @@ module Ruze
     def return_from(response, keys:)
       unless response.is_a?(Net::HTTPOK)
         caller = caller_locations(1, 1)[0].base_label
-        raise Error, "Error in #{caller}: #{response.message} (#{response.code})"
+        error = %w[401 403].include?(response.code) ? AuthenticationError : Error
+        raise error, "Error in #{caller}: #{response.message} (#{response.code})"
       end
 
       json = JSON.parse(response.body)

data/lib/ruze/version.rb

@@ -1,3 +1,3 @@
 module Ruze
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruze
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Georg Ledermann
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Unofficial Ruby client for the Renault ZE API
 test_files: []