smartcar 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93454e55a42ab20160c545c9bda459e98c85fe5596519f704ffa001bcef5896f
-  data.tar.gz: 0a8148c0f6678079467ee10d58b8564b2dec7e08127a3e7691e734503fc4128b
+  metadata.gz: c3ad3ad7082e2d27def7f0ee201f1b8f8b20eb25d3f17fffe71aecbb666dab87
+  data.tar.gz: ce9c4420338126a9cd6a22b2ae2da01f2ef9b469aaeb7df5a160377e54d939ce
 SHA512:
-  metadata.gz: a5fb72f2ee3aab427c7eefd12628947eb3f5e8644f40f898acea27cdc1b6c47d7d1085b936b7661df699a31baa59e162efa7641cce7b18b823796cd6d392bc3b
-  data.tar.gz: dc0ab7c95a537ea9a87c7e8f11ef13de8f8bd752625e0ec0418896de573a05d635837499e2744f53f7881a13c42cf9265e6799727bb68e424c4f57dccdd62370
+  metadata.gz: 61339cf13180062815aca1ed833d5761a0c3613595818526fc9f247e44a23d4e76f547f859c769a5bdd90917ef3e77f74048ad624806aefe8a060331b13eb2a7
+  data.tar.gz: 9974454e496f5e67cb7bf121e696fea11c0b1ab22583a521293fcb42e750cfc70073efb33e63f1c8c2b11f77ddb1afc23f56904b7a6de2e8f03348c62fe6f0df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (3.3.0)
+    smartcar (3.5.0)
       oauth2 (~> 1.4)
       recursive-open-struct (~> 1.1.3)
 
@@ -20,15 +20,15 @@ GEM
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.2.0)
+    faraday (2.4.0)
       faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.2)
+    faraday-net_http (2.1.0)
     hashdiff (1.0.1)
-    jwt (2.3.0)
+    jwt (2.4.1)
     multi_json (1.15.0)
     multi_xml (0.6.0)
-    oauth2 (1.4.9)
+    oauth2 (1.4.10)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)

data/README.md

@@ -31,6 +31,7 @@ not have access to the dashboard, please
 
 - Create a new `AuthClient` object with your `client_id`, `client_secret`,
   `redirect_uri`.
+    -
 - Redirect the user to Smartcar Connect using `get_auth_url` with required `scope` or with one
   of our frontend SDKs.
 - The user will login, and then accept or deny your `scope`'s permissions.
@@ -76,6 +77,9 @@ Setup the environment variables for SMARTCAR_CLIENT_ID, SMARTCAR_CLIENT_SECRET a
 export SMARTCAR_CLIENT_ID=<client id>
 export SMARTCAR_CLIENT_SECRET=<client secret>
 export SMARTCAR_REDIRECT_URI=<redirect URI>
+# Optional ENV variables
+export SMARTCAR_CONNECT_ORIGIN=(default_value: connect.smartcar.com): Used as the host for the URL that starts the Connect/OAuth2 flow
+export SMARTCAR_AUTH_ORIGIN=(default_value: auth.smartcar.com): Used as the host for the token exchange requests
 ```
 
 Example Usage for calling the reports API with oAuth token

data/lib/smartcar/auth_client.rb

@@ -6,7 +6,7 @@ module Smartcar
   class AuthClient
     include Smartcar::Utils
 
-    attr_reader :redirect_uri, :client_id, :client_secret, :scope, :mode, :flags, :origin
+    attr_reader :redirect_uri, :client_id, :client_secret, :scope, :mode, :flags, :auth_origin, :connect_origin
 
     # Constructor for a client object
     #
@@ -23,7 +23,8 @@ module Smartcar
       options[:redirect_uri] ||= get_config('SMARTCAR_REDIRECT_URI')
       options[:client_id] ||= get_config('SMARTCAR_CLIENT_ID')
       options[:client_secret] ||= get_config('SMARTCAR_CLIENT_SECRET')
-      options[:origin] = ENV['SMARTCAR_AUTH_ORIGIN'] || AUTH_ORIGIN
+      options[:auth_origin] = ENV['SMARTCAR_AUTH_ORIGIN'] || AUTH_ORIGIN
+      options[:connect_origin] = ENV['SMARTCAR_CONNECT_ORIGIN'] || CONNECT_ORIGIN
       options[:mode] = determine_mode(options[:test_mode], options[:mode]) || 'live'
       super
     end
@@ -57,7 +58,7 @@ module Smartcar
     def get_auth_url(scope, options = {})
       initialize_auth_parameters(scope, options)
       add_single_select_options(options[:single_select])
-      client.auth_code.authorize_url(@auth_parameters)
+      connect_client.auth_code.authorize_url(@auth_parameters)
     end
 
     # Generates the tokens hash using the code returned in oauth process.
@@ -70,9 +71,9 @@ module Smartcar
     def exchange_code(code, options = {})
       set_token_url(options[:flags])
 
-      token_hash = client.auth_code
-                         .get_token(code, redirect_uri: redirect_uri)
-                         .to_hash
+      token_hash = auth_client.auth_code
+                              .get_token(code, redirect_uri: redirect_uri)
+                              .to_hash
 
       json_to_ostruct(token_hash)
     rescue OAuth2::Error => e
@@ -88,7 +89,7 @@ module Smartcar
     def exchange_refresh_token(token, options = {})
       set_token_url(options[:flags])
 
-      token_object = OAuth2::AccessToken.from_hash(client, { refresh_token: token })
+      token_object = OAuth2::AccessToken.from_hash(auth_client, { refresh_token: token })
       token_object = token_object.refresh!
 
       json_to_ostruct(token_object.to_hash)
@@ -101,7 +102,7 @@ module Smartcar
     #
     # @return [Boolean]
     def expired?(expires_at)
-      OAuth2::AccessToken.from_hash(client, { expires_at: expires_at }).expired?
+      OAuth2::AccessToken.from_hash(auth_client, { expires_at: expires_at }).expired?
     end
 
     private
@@ -117,7 +118,7 @@ module Smartcar
       params[:flags] = build_flags(flags) if flags
       # Note - The inbuild interface to get the token does not allow any way to pass additional
       # URL params. Hence building the token URL with the flags and setting it in client.
-      client.options[:token_url] = client.connection.build_url('/oauth/token', params).request_uri
+      auth_client.options[:token_url] = auth_client.connection.build_url('/oauth/token', params).request_uri
     end
 
     def initialize_auth_parameters(scope, options)
@@ -144,13 +145,22 @@ module Smartcar
       end
     end
 
-    # gets the Oauth Client object
+    # gets the Oauth Client object configured with auth.connect.smartcar.com
     #
     # @return [OAuth2::Client] A Oauth Client object.
-    def client
-      @client ||= OAuth2::Client.new(client_id,
-                                     client_secret,
-                                     site: origin)
+    def auth_client
+      @auth_client ||= OAuth2::Client.new(client_id,
+                                          client_secret,
+                                          site: auth_origin)
+    end
+
+    # gets the Oauth Client object configured with connect.smartcar.com
+    #
+    # @return [OAuth2::Client] A Oauth Client object.
+    def connect_client
+      @connect_client ||= OAuth2::Client.new(client_id,
+                                             client_secret,
+                                             site: connect_origin)
     end
   end
 end

data/lib/smartcar/vehicle.rb

@@ -52,11 +52,18 @@ module Smartcar
         }
       },
       vin: { path: proc { |id| "/vehicles/#{id}/vin" } },
+      get_charge_limit: { path: proc { |id| "/vehicles/#{id}/charge/limit" } },
       disconnect!: { type: :delete, path: proc { |id| "/vehicles/#{id}/application" } },
       lock!: { type: :post, path: proc { |id| "/vehicles/#{id}/security" }, body: { action: 'LOCK' } },
       unlock!: { type: :post, path: proc { |id| "/vehicles/#{id}/security" }, body: { action: 'UNLOCK' } },
       start_charge!: { type: :post, path: proc { |id| "/vehicles/#{id}/charge" }, body: { action: 'START' } },
       stop_charge!: { type: :post, path: proc { |id| "/vehicles/#{id}/charge" }, body: { action: 'STOP' } },
+      set_charge_limit!: {
+        type: :post,
+        path: proc { |id| "/vehicles/#{id}/charge/limit" },
+        body: proc { |limit| { limit: limit } },
+        skip: true
+      },
       subscribe!: {
         type: :post,
         path: proc { |id, webhook_id| "/vehicles/#{id}/webhooks/#{webhook_id}" },
@@ -228,6 +235,19 @@ module Smartcar
       build_response(response, headers)
     end
 
+    # Set the charge limit for a given vehicle
+    #
+    # @param limit [float] A value between 0 and 1 denoting the charge limit to be set.
+    #
+    # @return [OpenStruct] Meta attribute with the relevant items from response headers.
+    def set_charge_limit!(limit)
+      path = METHODS.dig(:set_charge_limit!, :path).call(id)
+      body = METHODS.dig(:set_charge_limit!, :body).call(limit)
+
+      response, headers = post(path, {}, body)
+      build_response(response, headers)
+    end
+
     # Method to get batch requests.
     # API - https://smartcar.com/docs/api#post-batch-request
     # @param paths [Array] Array of paths as strings. Ex ['/battery', '/odometer']

data/lib/smartcar/version.rb

@@ -2,5 +2,5 @@
 
 module Smartcar
   # Gem current version number
-  VERSION = '3.3.0'
+  VERSION = '3.5.0'
 end

data/lib/smartcar.rb

@@ -22,7 +22,8 @@ module Smartcar
   }.freeze
 
   # Path for smartcar oauth
-  AUTH_ORIGIN = 'https://connect.smartcar.com'
+  CONNECT_ORIGIN = 'https://connect.smartcar.com'
+  AUTH_ORIGIN = 'https://auth.smartcar.com'
   %w[success code test live force auto metric imperial].each do |constant|
     # Constant to represent the value
     const_set(constant.upcase, constant.freeze)

data/lib/smartcar_error.rb

@@ -2,7 +2,7 @@
 
 # Custom SmartcarError class to represent errors from Smartcar APIs.
 class SmartcarError < StandardError
-  attr_reader :code, :status_code, :request_id, :type, :description, :doc_url, :resolution, :detail
+  attr_reader :code, :status_code, :request_id, :type, :description, :doc_url, :resolution, :detail, :retry_after
 
   def initialize(status, body, headers)
     @status_code = status
@@ -11,6 +11,7 @@ class SmartcarError < StandardError
       @request_id = headers['sc-request-id']
       return
     end
+    @retry_after = headers['retry-after']
     body = coerce_attributes(body)
 
     super("#{body[:type]}:#{body[:code]} - #{body[:description]}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -235,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)