smartcar 3.2.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af85a8f04bb5ecfd37182ae539ef60e5ca4e9487edf5db544109417df43d82d0
-  data.tar.gz: 5f2ccac9657e5e5b122b32943fa48845aa0acd5319dccc8836fd6b3cbf063ced
+  metadata.gz: fe729c83b0d759f2d787090e3f815ec9d97cd0b283585f8775ebe16e61b16e56
+  data.tar.gz: '029284bb31e8363b2cd0fe751705749e19365fb5692cbc3054325d648440117e'
 SHA512:
-  metadata.gz: 47abd5b611ddc7089be88614c2b79a4d2c33db498f1254eea55f2ed1426b795752b47b7e08e9ac8825086790313738f16affdf536ebed450963b36fd0d1305e3
-  data.tar.gz: 3ffef0a6f8f06da4c9f70a6798a9f701521831cdc30bbc183e613515b2b9520a492bd2d9e686a5c4cca0421d42def98bc0ccb6c4239cabd1d7b250ba5416f31d
+  metadata.gz: 6e469fcb92c39256e4a779476217fdb7cd5cce276af14d61ac9a51054e5d5e485f70e8f7886fb1852d2fb9d8128edd9b85164303f7c36fdca9d919f50bb0f4cb
+  data.tar.gz: faf78f8b977e3548e9f44fa45a59ce3b26cc89de53e6d85f3a8bc5391ced3031bdb2801696cb237cc2bb8c801bf85f7d2dd5bb6f15ccf2904430c65549c8ac86

data/.rubocop.yml

@@ -12,7 +12,7 @@ Naming/AccessorMethodName:
   Enabled: false
 
 # Disabling this until we figure out a better way than using openstruct
-# Currently we use open struct because this gives us an object representing the JSON 
+# Currently we use open struct because this gives us an object representing the JSON
 # with accessor style methods.
 Style/OpenStructUse:
   Enabled: false
@@ -30,3 +30,9 @@ Metrics/MethodLength:
 
 Metrics/ClassLength:
   Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (3.2.0)
+    smartcar (3.3.1)
       oauth2 (~> 1.4)
       recursive-open-struct (~> 1.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
@@ -101,7 +105,7 @@ Example Usage for calling the reports API with oAuth token
 Example Usage for oAuth -
 ```ruby
 # To get the redirect URL :
-2.5.5 :002 > options = {test_mode: true}
+2.5.5 :002 > options = {mode: 'test'}
 2.5.5 :003 > require 'smartcar'
 2.5.5 :004 > client = Smartcar::AuthClient.new(options)
 2.5.5 :005 > url = client.get_auth_url(["read_battery","read_charge","read_fuel","read_location","control_security","read_odometer","read_tires","read_vin","read_vehicle_info"], {flags: ["country:DE"]})

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
     #
@@ -14,15 +14,18 @@ module Smartcar
     # @option options[:client_id] [String] - Client ID, if not passed fallsback to ENV['SMARTCAR_CLIENT_ID']
     # @option options[:client_secret] [String] - Client Secret, if not passed fallsback to ENV['SMARTCAR_CLIENT_SECRET']
     # @option options[:redirect_uri] [String] - Redirect URI, if not passed fallsback to ENV['SMARTCAR_REDIRECT_URI']
-    # @option options[:test_mode] [Boolean] - Setting this to 'true' runs it in test mode.
-    #
+    # @option options[:test_mode] [Boolean] - [DEPRECATED], please use `mode` instead.
+    # Launch Smartcar Connect in [test mode](https://smartcar.com/docs/guides/testing/).
+    # @option options[:mode] [String] - Determine what mode Smartcar Connect should be launched in.
+    # Should be one of test, live or simulated.
     # @return [Smartcar::AuthClient] Returns a Smartcar::AuthClient Object that has other methods
     def initialize(options)
       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[:mode] = options[:test_mode].is_a?(TrueClass) ? TEST : LIVE
-      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
 
@@ -55,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.
@@ -68,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
@@ -86,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)
@@ -99,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
@@ -115,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)
@@ -142,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 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 client
-      @client ||= OAuth2::Client.new(client_id,
-                                     client_secret,
-                                     site: origin)
+    def connect_client
+      @connect_client ||= OAuth2::Client.new(client_id,
+                                             client_secret,
+                                             site: connect_origin)
     end
   end
 end

data/lib/smartcar/base.rb

@@ -22,7 +22,7 @@ module Smartcar
       # @param data [Hash] request body if needed.
       #
       # @return [Hash] The response Json parsed as a hash.
-      define_method verb do |path, data = nil, headers = {}|
+      define_method verb do |path, query_params = {}, data = nil, headers = {}|
         response = service.send(verb) do |request|
           request_headers = {}
           request_headers['Authorization'] = auth_type == BASIC ? "Basic #{token}" : "Bearer #{token}"
@@ -32,6 +32,7 @@ module Smartcar
             "Smartcar/#{VERSION} (#{RbConfig::CONFIG['host_os']}; #{RbConfig::CONFIG['arch']}) Ruby v#{RUBY_VERSION}"
           request.headers = request_headers.merge(headers)
           complete_path = "/v#{version}#{path}"
+          complete_path += "?#{URI.encode_www_form(query_params.compact)}" unless query_params.empty?
           if verb == :get
             request.url complete_path, data
           else
@@ -46,17 +47,6 @@ module Smartcar
       end
     end
 
-    # This requires a proc 'PATH' to be defined in the class
-    # @param path [String] resource path
-    # @param query_params [Hash] query params
-    # @param auth [String] type of auth
-    #
-    # @return [Object]
-    def fetch(path:, query_params: {})
-      path += "?#{URI.encode_www_form(query_params)}" unless query_params.empty?
-      get(path)
-    end
-
     private
 
     # gets a smartcar API service/client

data/lib/smartcar/utils.rb

@@ -127,5 +127,25 @@ module Smartcar
 
       path.split('/').reject(&:empty?).join('_').to_sym
     end
+
+    # takes query parameters and returns them as a string
+    # EX - {'country': 'DE', 'flags': true} -> "county:DE flags:true"
+    def stringify_params(query_params)
+      query_params&.map { |key, value| "#{key}:#{value}" }&.join(' ')
+    end
+
+    def determine_mode(test_mode, mode)
+      unless mode.nil?
+        unless %w[test live simulated].include? mode
+          raise 'The "mode" parameter MUST be one of the following: \'test\', \'live\', \'simulated\''
+        end
+
+        return mode
+      end
+      return if test_mode.nil?
+
+      warn '[DEPRECATION] The "test_mode" parameter is deprecated, please use the "mode" parameter instead.'
+      test_mode.is_a?(TrueClass) ? 'test' : 'live'
+    end
   end
 end

data/lib/smartcar/vehicle.rb

@@ -11,6 +11,7 @@ module Smartcar
   # @attr [Hash] options
   # @attr unit_system [String] Unit system to represent the data in, defaults to Imperial
   # @attr version [String] API version to be used.
+  # @attr flags [Hash] Object of flags where key is the name of the flag and value is string or boolean value.
   # @attr service [Faraday::Connection] An optional connection object to be used for requests.
   class Vehicle < Base
     attr_reader :id
@@ -77,6 +78,7 @@ module Smartcar
       @unit_system = options[:unit_system] || METRIC
       @version = options[:version] || Smartcar.get_api_version
       @service = options[:service]
+      @query_params = { flags: stringify_params(options[:flags]) }
 
       raise InvalidParameterValue.new, "Invalid Units provided : #{@unit_system}" unless UNITS.include?(@unit_system)
       raise InvalidParameterValue.new, 'Vehicle ID (id) is a required field' if id.nil?
@@ -177,11 +179,11 @@ module Smartcar
       define_method method do
         body, headers = case item[:type]
                         when :post
-                          post(item[:path].call(id), item[:body])
+                          post(item[:path].call(id), @query_params, item[:body])
                         when :delete
-                          delete(item[:path].call(id))
+                          delete(item[:path].call(id), @query_params)
                         else
-                          fetch(path: item[:path].call(id))
+                          get(item[:path].call(id), @query_params)
                         end
         build_aliases(build_response(body, headers), item[:aliases])
       end
@@ -195,7 +197,7 @@ module Smartcar
     # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-application-permissions
     #  and a meta attribute with the relevant items from response headers.
     def permissions(paging = {})
-      response, headers = fetch(path: METHODS.dig(:permissions, :path).call(id), query_params: paging)
+      response, headers = get(METHODS.dig(:permissions, :path).call(id), @query_params.merge(paging))
       build_response(response, headers)
     end
 
@@ -206,7 +208,7 @@ module Smartcar
     # @return [OpenStruct] An object representing the JSON response and a meta attribute
     #   with the relevant items from response headers.
     def subscribe!(webhook_id)
-      response, headers = post(METHODS.dig(:subscribe!, :path).call(id, webhook_id), {})
+      response, headers = post(METHODS.dig(:subscribe!, :path).call(id, webhook_id), @query_params)
       build_aliases(build_response(response, headers), METHODS.dig(:subscribe!, :aliases))
     end
 
@@ -220,7 +222,8 @@ module Smartcar
       # swapping off the token with amt for unsubscribe.
       access_token = token
       self.token = amt
-      response, headers = delete(METHODS.dig(:unsubscribe!, :path).call(id, webhook_id))
+      response, headers = delete(METHODS.dig(:unsubscribe!, :path).call(id, webhook_id),
+                                 @query_params)
       self.token = access_token
       build_response(response, headers)
     end
@@ -233,7 +236,7 @@ module Smartcar
     #  an OpenStruct object of the requested attribute or taises if it is an error.
     def batch(paths)
       request_body = { requests: paths.map { |path| { path: path } } }
-      response, headers = post("/vehicles/#{id}/batch", request_body)
+      response, headers = post("/vehicles/#{id}/batch", @query_params, request_body)
       process_batch_response(response, headers)
     end
 
@@ -249,7 +252,7 @@ module Smartcar
     #   response body and a "meta" attribute with the relevant items from response headers.
     def request(method, path, body = {}, headers = {})
       path = "/vehicles/#{id}/#{path}"
-      raw_response, headers = send(method.downcase, path, body, headers)
+      raw_response, headers = send(method.downcase, path, @query_params, body, headers)
       meta = build_meta(headers)
       json_to_ostruct({ body: raw_response, meta: meta })
     end

data/lib/smartcar/version.rb

@@ -2,5 +2,5 @@
 
 module Smartcar
   # Gem current version number
-  VERSION = '3.2.0'
+  VERSION = '3.3.1'
 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)
@@ -38,6 +39,7 @@ module Smartcar
   @api_version = '2.0'
 
   class << self
+    include Smartcar::Utils
     # Module method Used to set api version to be used.
     # This method can be used at the top to set the version and any
     # following request will use the version set here unless overridden
@@ -67,7 +69,10 @@ module Smartcar
     # @option options [String] :client_secret Client Secret that overrides ENV
     # @option options [String] :version API version to use, defaults to what is globally set
     # @option options [Hash] :flags A hash of flag name string as key and a string or boolean value.
-    # @option options [Boolean] :test_mode Whether to use test mode or not.
+    # @option options[Boolean] :test_mode [DEPRECATED], please use `mode` instead.
+    # Launch Smartcar Connect in test mode(https://smartcar.com/docs/guides/testing/).
+    # @option options [String] :mode Determine what mode Smartcar Connect should be launched in.
+    # Should be one of test, live or simulated.
     # @option options [String] :test_mode_compatibility_level this is required argument while using
     # test mode with a real vin. For more information refer to docs.
     # @option options [Faraday::Connection] :service Optional connection object to be used for requests
@@ -88,9 +93,9 @@ module Smartcar
 
       base_object.token = generate_basic_auth(options, base_object)
 
-      base_object.build_response(*base_object.fetch(
-        path: PATHS[:compatibility],
-        query_params: build_compatibility_params(vin, scope, country, options)
+      base_object.build_response(*base_object.get(
+        PATHS[:compatibility],
+        build_compatibility_params(vin, scope, country, options)
       ))
     end
 
@@ -112,7 +117,7 @@ module Smartcar
           service: options[:service]
         }
       )
-      base_object.build_response(*base_object.fetch(path: PATHS[:user]))
+      base_object.build_response(*base_object.get(PATHS[:user]))
     end
 
     # Module method Returns a paged list of all vehicles connected to the application for the current authorized user.
@@ -134,9 +139,9 @@ module Smartcar
           service: options[:service]
         }
       )
-      base_object.build_response(*base_object.fetch(
-        path: PATHS[:vehicles],
-        query_params: paging
+      base_object.build_response(*base_object.get(
+        PATHS[:vehicles],
+        paging
       ))
     end
 
@@ -169,15 +174,15 @@ module Smartcar
         scope: scope.join(' '),
         country: country
       }
-      query_params[:flags] = options[:flags].map { |key, value| "#{key}:#{value}" }.join(' ') if options[:flags]
-      query_params[:mode] = options[:test_mode].is_a?(TrueClass) ? 'test' : 'live' unless options[:test_mode].nil?
+      query_params[:flags] = stringify_params(options[:flags])
 
-      if options[:test_mode_compatibility_level]
-        query_params[:test_mode_compatibility_level] =
-          options[:test_mode_compatibility_level]
-        query_params[:mode] = 'test'
-      end
+      mode = determine_mode(options[:test_mode], options[:mode])
 
+      unless options[:test_mode_compatibility_level].nil?
+        query_params[:test_mode_compatibility_level] = options[:test_mode_compatibility_level]
+        mode = 'test'
+      end
+      query_params[:mode] = mode unless mode.nil?
       query_params
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2023-03-08 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/)