smartcar 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3848d46ccf722b908e7b42acc1afebccc24fbf1362c36bd0b0a867cd8bdd5b85
-  data.tar.gz: 3cfbf110c26177478a4ffad5373aeffcb73411b85f014c7af98293ea42739601
+  metadata.gz: 3f96ead76c474cc7bd2f579c79ae5457437b7826ea5738fc939e78e7fd15ad9a
+  data.tar.gz: 4ca101d8945328f524a4c4fe525eef8c0fa9ed5828a6d7fc1e7d96bccc299015
 SHA512:
-  metadata.gz: f46fc77b3eafb462cfbd210d7509293368d9d2306ce8d16dbfbd4aad7a76339e53b689f06c2e50b3cc6eb56be5a390c805f8ae88384f6cfcdfa7e1ce27b34e91
-  data.tar.gz: ee615279dc5c61e75ba1afd3ffa640b2df9ffafd4ea459cf22558d145e434b117814bd4279fcfd418643146eec4386911735f8f1066babd3ce494df44d15cfba
+  metadata.gz: c944b360628c97f3e78e6d1f7287e91c136a33cd8c696c0e8246c18839f97d790aea5457dc402ace57eda565f4937dbc72a51e5c66e70b12d24a1850674f6bcf
+  data.tar.gz: 73646b1545692c60714bd7581abef94f6271907587dc1ed2564dbae30adafb63b3c3d546b46f2188933fd2f4035a1eb8922fa4ef0c7e09a4fbd48a5d69c1cb11

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.vscode/
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -7,6 +7,10 @@ AllCops:
 Metrics/AbcSize:
   Enabled: false
 
+# Disabling this becuase we are using `set` and `get` prefixed methods to keep some commonality across SDKs
+Naming/AccessorMethodName:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - '**/*.gemspec'

data/.travis.yml

@@ -6,7 +6,6 @@ services:
 addons:
   firefox: latest
 rvm:
-- 2.5
 - 2.6
 - 2.7
 before_install:
@@ -25,5 +24,5 @@ deploy:
   on:
     tags: true
     branch: master
-    rvm: 2.5
+    rvm: 2.6
   skip_cleanup: 'true'

data/Gemfile.lock

@@ -1,22 +1,39 @@
 PATH
   remote: .
   specs:
-    smartcar (2.5.0)
+    smartcar (3.0.0)
       oauth2 (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    backport (1.1.2)
     byebug (11.1.3)
     childprocess (3.0.0)
-    diff-lcs (1.3)
-    faraday (1.3.0)
+    codecov (0.5.2)
+      simplecov (>= 0.15, < 0.22)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
-    jwt (2.2.2)
+    faraday-net_http_persistent (1.1.0)
+    hashdiff (1.0.1)
+    jwt (2.2.3)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
@@ -27,45 +44,60 @@ GEM
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (12.3.3)
+    readapt (1.3.0)
+      backport (~> 1.1)
+      thor (~> 1.0)
     redcarpet (3.5.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (1.12.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.16.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.4)
     rubyzip (2.3.0)
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
       rubyzip (>= 1.2.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    thor (1.1.0)
     unicode-display_width (2.0.0)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -73,12 +105,15 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   byebug (~> 11.0)
+  codecov (~> 0.5.2)
   rake (~> 12.3, >= 12.3.3)
+  readapt (~> 1.3)
   redcarpet (~> 3.5.0)
   rspec (~> 3.0)
   rubocop (~> 1.12)
   selenium-webdriver (~> 3.142)
   smartcar!
+  webmock (~> 3.13)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -29,28 +29,28 @@ not have access to the dashboard, please
 
 ### Flow
 
-- Create a new `AuthClient` object with your `clientId`, `clientSecret`,
-  `redirectUri`, and required `scope`.
-- Redirect the user to Smartcar Connect using `getAuthUrl` or one
+- 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.
-- Handle the get request to `redirectUri`.
+- Handle the get request to `redirect_uri`.
   - If the user accepted your permissions, `req.query.code` will contain an
     authorization code.
-    - Use `exchangeCode` with this code to obtain an access object
+    - Use `exchange_code` with this code to obtain an access object
       containing an access token (lasting 2 hours) and a refresh token
       (lasting 60 days).
       - Save this access object.
     - If the user denied your permissions, `req.query.error` will be set
       to `"access_denied"`.
-    - If you passed a state parameter to `getAuthUrl`, `req.query.state` will
+    - If you passed a state parameter to `get_auth_url`, `req.query.state` will
       contain the state value.
-- Get the user's vehicles with `getVehicleIds`.
-- Create a new `Vehicle` object using a `vehicleId` from the previous response,
+- Get the user's vehicles with `getVehicles`.
+- Create a new `Vehicle` object using a `vehicle_id` from the previous response,
   and the `access_token`.
 - Make requests to the Smartcar API.
-- Use `exchangeRefreshToken` on your saved `refreshToken` to retrieve a new token
-  when your `accessToken` expires.
+- Use `exchange_refresh_token` on your saved `refresh_token` to retrieve a new token
+  when your `access_token` expires.
 
 ## Installation
 
@@ -70,53 +70,47 @@ Or install it yourself as:
 
 ## Usage
 
-Setup the environment variables for CLIENT_ID and CLIENT_SECRET.
+Setup the environment variables for SMARTCAR_CLIENT_ID, SMARTCAR_CLIENT_SECRET and SMARTCAR_REDIRECT_URI.
 ```bash
 # Get your API keys from https://dashboard.smartcar.com/signup
-export CLIENT_ID=<client id>
-export CLIENT_SECRET=<client secret>
+export SMARTCAR_CLIENT_ID=<client id>
+export SMARTCAR_CLIENT_SECRET=<client secret>
+export SMARTCAR_REDIRECT_URI=<redirect URI>
 ```
 
 Example Usage for calling the reports API with oAuth token
 ```ruby
 2.5.7 :001 > require 'smartcar'
  => true
-2.5.7 :003 > ids =  Smartcar::Vehicle.all_vehicle_ids(token: token)
+2.5.7 :003 > ids =  Smartcar::Vehicle.get_vehicles(token: token).vehicles
  => ["4bb777b2-bde7-4305-8952-25956f8c0868"]
 2.5.7 :004 > vehicle = Smartcar::Vehicle.new(token: token, id: ids.first)
- => #<Smartcar::Vehicle:0x00005564211a7c48 @token="5ae77cb0-7c1a-486a-ac20-00c76d2fd1aa", @id="4bb777b2-bde7-4305-8952-25956f8c0868", @unit_system="imperial">
+ => #<Smartcar::Vehicle:0x0000558dcd7ee608 @token="c900e00e-ee8e-403d-a7bf-f992bc0ad302", @id="e31c9de6-1332-472b-b648-5d74b05b7fda", @options={:unit_system=>"metric", :version=>"2.0"}, @unit_system="metric", @version="2.0", @service=#<Faraday::Connection:0x0000558dcd7d63f0 @parallel_manager=nil, @headers={"User-Agent"=>"Faraday v1.4.2"}, @params={}, @options=#<Faraday::RequestOptions timeout=310>, @ssl=#<Faraday::SSLOptions verify=true>, @default_parallel_manager=nil, @builder=#<Faraday::RackBuilder:0x0000558dcd7c1bf8 @adapter=Faraday::Adapter::NetHttp, @handlers=[Faraday::Request::UrlEncoded], @app=#<Faraday::Request::UrlEncoded:0x0000558dcd7af048 @app=#<Faraday::Adapter::NetHttp:0x0000558dcd7af390 @ssl_cert_store=#<OpenSSL::X509::Store:0x0000558dcd7a36a8 @verify_callback=nil, @error=nil, @error_string=nil, @chain=nil, @time=nil>, @app=#<Proc:0x0000558dcd7af278 /home/ashwinsubramanian/.rvm/gems/ruby-2.7.2/gems/faraday-1.4.2/lib/faraday/adapter.rb:37 (lambda)>, @connection_options={}, @config_block=nil>, @options={}>>, @url_prefix=#<URI::HTTPS https://api.smartcar.com/>, @proxy=nil, @manual_proxy=false>>
 2.5.7 :006 > vehicle.odometer
- => #<Smartcar::Odometer:0x00005564211330f0 @distance=17966.94802354251, @meta={"date"=>"Fri, 12 Jun 2020 06:04:32 GMT", "content-type"=>"application/json; charset=utf-8", "content-length"=>"30", "connection"=>"keep-alive", "access-control-allow-origin"=>"*", "sc-data-age"=>"2020-06-12T06:04:28.843Z", "sc-unit-system"=>"imperial", "sc-request-id"=>"3c447e9e-4cf7-43cb-b688-fba8db3d3582"}>
+ => #<OpenStruct distance=39685.33984375, meta=#<OpenStruct data_age=#<DateTime: 2021-06-24T22:28:39+00:00 ((2459390j,80919s,95000000n),+0s,2299161j)>, unit_system="metric", request_id="4962ba7f-5c94-48ab-9955-4e2b101c7b8a">>
 2.5.7 :007 > vehicle.battery
- => #<Smartcar::Battery:0x00005564210fcb18 @range=105.63, @percentRemaining=0.98, @meta={"date"=>"Fri, 12 Jun 2020 06:04:44 GMT", "content-type"=>"application/json; charset=utf-8", "content-length"=>"40", "connection"=>"keep-alive", "access-control-allow-origin"=>"*", "sc-data-age"=>"2020-06-12T06:04:28.843Z", "sc-unit-system"=>"imperial", "sc-request-id"=>"455ed4b0-b768-4961-86d7-436ad71cf0fa"}>
+ => #<OpenStruct range=208.82, percentRemaining=0.31, meta=#<OpenStruct data_age=#<DateTime: 2021-06-24T22:28:54+00:00 ((2459390j,80934s,855000000n),+0s,2299161j)>, unit_system="metric", request_id="a88b95ec-b10f-4fc8-979b-5d95fe40d925">, percentage_remaining=0.31>
 2.5.7 :009 > vehicle.lock!
- => true
-2.5.7 :010 > vehicle.batch(["charge","battery"])
-=> {:charge=>#<Smartcar::Charge:0x000055853d1fd7c8 @state="NOT_CHARGING", @isPluggedIn=false, @meta={"sc-data-age"=>"2020-06-12T06:18:50.581Z"}>, :battery=>#<Smartcar::Battery:0x000055853d1fd638 @range=105.63, @percentRemaining=0.98, @meta={"sc-data-age"=>"2020-06-12T06:18:50.581Z", "sc-unit-system"=>"imperial"}>}
-2.5.7 :011 > vehicle.start_charge!
-Traceback (most recent call last):
-        5: from /usr/share/rvm/rubies/ruby-2.5.7/bin/irb:11:in `<main>'
-        4: from (irb):5
-        3: from /home/st-2vgpnn2/.rvm/gems/ruby-2.5.7/gems/smartcar-1.0.0/lib/smartcar/vehicle.rb:118:in `start_charge!'
-        2: from /home/st-2vgpnn2/.rvm/gems/ruby-2.5.7/gems/smartcar-1.0.0/lib/smartcar/vehicle.rb:290:in `start_or_stop_charge!'
-        1: from /home/st-2vgpnn2/.rvm/gems/ruby-2.5.7/gems/smartcar-1.0.0/lib/smartcar/base.rb:39:in `block (2 levels) in <class:Base>'
-Smartcar::ExternalServiceError (API error - {"error":"vehicle_state_error","message":"Charging plug is not connected to the vehicle.","code":"VS_004"})
-
+ => #<OpenStruct status="success", message="Successfully sent request to vehicle", meta=#<OpenStruct request_id="0c90918f-a9cc-405c-839f-7d9b70e249c4">>
+2.5.7 :010 > batch_response = vehicle.batch(["/charge","/battery"])
+=> #<OpenStruct>
+2.5.7 :011 > batch_response.charge()
+=> #<OpenStruct state="NOT_CHARGING", isPluggedIn=false, meta=#<OpenStruct data_age=#<DateTime: 2021-06-24T22:30:20+00:00 ((2459390j,81020s,892000000n),+0s,2299161j)>, request_id="29a66280-8685-4a57-9733-daa3dfb9970f">, is_plugged_in?=false>
 ```
 
 Example Usage for oAuth -
 ```ruby
 # To get the redirect URL :
-2.5.5 :002 > options = {test_mode: true,scope: ["read_battery","read_charge","read_fuel","read_location","control_security","read_odometer","read_tires","read_vin","read_vehicle_info"],flags: ["country:DE"]}
+2.5.5 :002 > options = {test_mode: true}
 2.5.5 :003 > require 'smartcar'
-2.5.5 :004 > client = Smartcar::Oauth.new(options)
-2.5.5 :005 > url = client.authorization_url
+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"]})
  => "https://connect.smartcar.com/oauth/authorize?approval_prompt=auto&client_id=<client id>&mode=test&redirect_uri=http%3A%2F%2Flocalhost%3A8000%2Fcallback&response_type=code&scope=read_battery+read_charge+read_fuel+read_location+control_security+read_odometer+read_tires+read_vin+read_vehicle_info&flags=country%3ADE"
 # Redirect user to the above URL.
 # After authentication user control reaches the callback URL with code.
 # Use the code from the parameters and request a token
-2.5.5 :006 > token_hash = client.get_token(code)
- => {"token_type"=>"Bearer", :access_token=>"56801a5e-6a0b-4d05-a43e-52a4d5e6648f", :refresh_token=>"4f46e7e4-28c5-47b3-ba8d-7dcef73d05dd", :expires_at=>1577875279}
+2.5.5 :006 > token_hash = client.exchange_code(code)
+ => #<OpenStruct token_type="Bearer", access_token="20e24b4a-3055-4cc8-9cf3-2b3c5afba3e6", refresh_token="cf89c62e-7b36-4e13-a9df-d9c2a5296280", expires_at=1624581588>
 # This access_token can be used to call the Smartcar APIs as given above.
 # Store this hash and if it expired refresh the token OR use the code again to
 # get a new token or use .
@@ -128,8 +122,10 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 To run tests, make sure you have the env variables setup for client id and secret.
 ```shell
-export INTEGRATION_CLIENT_ID=<client id>
-export INTEGRATION_CLIENT_SECRET=<client secret>
+export E2E_SMARTCAR_CLIENT_ID=<client id>
+export E2E_SMARTCAR_CLIENT_SECRET=<client secret>
+export E2E_SMARTCAR_AMT=<amt from dashboard for webhooks>
+export E2E_SMARTCAR_WEBHOOK_ID=<webhook id to use for tests>
 ```
 
 Tests can be run using either default rake command OR specific rspec command.
@@ -164,3 +160,9 @@ To contribute, please:
 
 [gem-image]: https://badge.fury.io/rb/smartcar
 [gem-url]: https://badge.fury.io/rb/smartcar.svg
+
+## Supported Ruby Branches
+
+Smartcar aims to support the SDK on all Ruby branches that have a status of "normal maintenance" or "security maintenance" as defined in the [Ruby Branches documentation](https://www.ruby-lang.org/en/downloads/branches/).
+
+In accordance with the Semantic Versioning specification, the addition of support for new Ruby branches would result in a MINOR version bump and the removal of support for Ruby branches would result in a MAJOR version bump.

data/lib/open_struct_extensions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Extension to OpenStruct to convert a nested OpenStruct object to a hash.
+# Using this method any of the API response can be converted back to hash
+# or JSON (from hash) for convenience.
+# Example Usage :
+# response = {a: { b: {c: "test", d: [{x: 1}, {y: 3}]}}}
+class OpenStruct
+  def deep_to_h
+    to_h.transform_values do |value|
+      case value
+      when is_a?(OpenStruct)
+        value.deep_to_h
+      when is_a?(Array)
+        value.map { |item| item.is_a?(OpenStruct) ? item.deep_to_h : item }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/smartcar.rb

@@ -1,83 +1,184 @@
 # frozen_string_literal: true
 
+require 'smartcar_error'
 require 'smartcar/utils'
 require 'smartcar/version'
 require 'smartcar/base'
-require 'smartcar/oauth'
-require 'smartcar/permissions'
-require 'smartcar/battery'
-require 'smartcar/battery_capacity'
-require 'smartcar/charge'
-require 'smartcar/engine_oil'
-require 'smartcar/fuel'
-require 'smartcar/location'
-require 'smartcar/odometer'
-require 'smartcar/tire_pressure'
-require 'smartcar/vin'
-require 'smartcar/vehicle_attributes'
-require 'smartcar/vehicle_utils/batch'
-require 'smartcar/vehicle_utils/data'
-require 'smartcar/vehicle_utils/actions'
+require 'smartcar/auth_client'
 require 'smartcar/vehicle'
-require 'smartcar/user'
 
 # Main Smartcar umbrella module
 module Smartcar
   # Error raised when a config is not found
   class ConfigNotFound < StandardError; end
 
-  # Error raised when Smartcar returns non 400, 404, 401, 200 or 204 response
-  class ExternalServiceError < StandardError; end
-
-  # Error raised when Smartcar returns 404
-  class ServiceUnavailableError < ExternalServiceError; end
-
-  # Error raised when Smartcar returns Authentication Error with status 401
-  class AuthenticationError < ExternalServiceError; end
-
-  # Error raised when Smartcar returns 400 response
-  class BadRequestError < ExternalServiceError; end
-
   # Host to connect to smartcar
-  SITE = 'https://api.smartcar.com/'
+  API_ORIGIN = 'https://api.smartcar.com/'
+  PATHS = {
+    compatibility: '/compatibility',
+    user: '/user',
+    vehicles: '/vehicles'
+  }.freeze
 
   # Path for smartcar oauth
-  OAUTH_PATH = 'https://connect.smartcar.com/oauth/authorize'
+  AUTH_ORIGIN = 'https://connect.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)
   end
 
-  # Lock value sent in request body
-  LOCK = 'LOCK'
-  # Unlock value sent in request body
-  UNLOCK = 'UNLOCK'
-  # Start charge value sent in request body
-  START_CHARGE = 'START'
-  # Stop charge value sent in request body
-  STOP_CHARGE = 'STOP'
   # Constant for units
   UNITS = [IMPERIAL, METRIC].freeze
 
-  # Smartcar API version variable - defaulted to 1.0
-  @api_version = '1.0'
-
-  # rubocop:disable Naming/AccessorMethodName
-  # 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
-  # separately.
-  # @param version [String] version to be set without 'v' prefix.
-  def self.set_api_version(version)
-    instance_variable_set('@api_version', version)
-  end
+  # Smartcar API version variable - defaulted to 2.0
+  @api_version = '2.0'
+
+  class << self
+    # 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
+    # separately.
+    # @param version [String] version to be set without 'v' prefix.
+    def set_api_version(version)
+      instance_variable_set('@api_version', version)
+    end
+
+    # Module method Used to get api version to be used.
+    # This is the getter for the class instance variable @api_version
+    #
+    # @return [String] api version number without 'v' prefix
+    def get_api_version
+      instance_variable_get('@api_version')
+    end
+
+    # Module method Used to check compatiblity for VIN and scope
+    #
+    # API Documentation - https://smartcar.com/docs/api#connect-compatibility
+    # @param vin [String] VIN of the vehicle to be checked
+    # @param scope [Array of Strings] - array of scopes
+    # @param country [String] An optional country code according to
+    # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+    # Defaults to US.
+    # @param options [Hash] Other optional parameters including overrides
+    # @option options [String] :client_id Client ID that overrides ENV
+    # @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 Wether to use test mode or not.
+    # @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.
+    #
+    # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#connect-compatibility
+    #  and a meta attribute with the relevant items from response headers.
+    def get_compatibility(vin:, scope:, country: 'US', options: {})
+      raise InvalidParameterValue.new, 'vin is a required field' if vin.nil?
+      raise InvalidParameterValue.new, 'scope is a required field' if scope.nil?
+
+      base_object = Base.new(
+        {
+          version: options[:version] || Smartcar.get_api_version,
+          auth_type: Base::BASIC
+        }
+      )
+
+      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)
+        }
+      ))
+    end
+
+    # Module method Used to get user id
+    #
+    # API Documentation - https://smartcar.com/docs/api#get-user
+    # @param token [String] Access token
+    #
+    # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-user
+    #  and a meta attribute with the relevant items from response headers.
+    def get_user(token:, version: Smartcar.get_api_version)
+      base_object = Base.new(
+        {
+          token: token,
+          version: version
+        }
+      )
+      base_object.build_response(*base_object.fetch({ path: PATHS[:user] }))
+    end
+
+    # Module method Returns a paged list of all vehicles connected to the application for the current authorized user.
+    #
+    # API Documentation - https://smartcar.com/docs/api#get-all-vehicles
+    # @param token [String] - Access token
+    # @param paging [Hash] - Optional filter parameters (check documentation)
+    #
+    # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-all-vehicles
+    #  and a meta attribute with the relevant items from response headers.
+    def get_vehicles(token:, paging: {}, version: Smartcar.get_api_version)
+      base_object = Base.new(
+        {
+          token: token,
+          version: version
+        }
+      )
+      base_object.build_response(*base_object.fetch(
+        {
+          path: PATHS[:vehicles],
+          query_params: paging
+        }
+      ))
+    end
+
+    # Module method to generate hash challenge for webhooks. It does HMAC_SHA256(amt, challenge)
+    #
+    # @param amt [String] - Application Management Token
+    # @param challenge [String] - Challenge string
+    #
+    # @return [String] String representing the hex digest
+    def hash_challenge(amt, challenge)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), amt, challenge)
+    end
+
+    # Module method used to verify webhook payload with AMT and signature.
+    #
+    # @param amt [String] - Application Management Token
+    # @param signature [String] - sc-signature header value
+    # @param body [Object] - webhook response body
+    #
+    # @return [true, false] - true if signature matches the hex digest of amt and body
+    def verify_payload(amt, signature, body)
+      hash_challenge(amt, body.to_json) == signature
+    end
+
+    private
+
+    def build_compatibility_params(vin, scope, country, options)
+      query_params = {
+        vin: vin,
+        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?
+
+      if options[:test_mode_compatibility_level]
+        query_params[:test_mode_compatibility_level] =
+          options[:test_mode_compatibility_level]
+        query_params[:mode] = 'test'
+      end
+
+      query_params
+    end
 
-  # Module method Used to get api version to be used.
-  # This is the getter for the class instance variable @api_version
-  #
-  # @return [String] api version number without 'v' prefix
-  def self.get_api_version
-    instance_variable_get('@api_version')
+    # returns auth token for Basic auth
+    #
+    # @return [String] Base64 encoding of CLIENT:SECRET
+    def generate_basic_auth(options, base_object)
+      client_id = options[:client_id] || base_object.get_config('SMARTCAR_CLIENT_ID')
+      client_secret = options[:client_secret] || base_object.get_config('SMARTCAR_CLIENT_SECRET')
+      Base64.strict_encode64("#{client_id}:#{client_secret}")
+    end
   end
-  # rubocop:enable Naming/AccessorMethodName
 end