smartcar 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b46d97dfaa2c543d0c5a5a7fbe7be668991babc0b0d35b81c432dc6ae3b3d06
-  data.tar.gz: 6e67faac4de5a809023fad29fba657bba0648a67978831d4c19a1a26e7bc039b
+  metadata.gz: 4d9d54665fb1e1c644ec917708c8f702d6eec0afec4b7bc14e5504a717da92d9
+  data.tar.gz: 31d22b73a4406d512a738c694bc250b9eeab7e60ba1e137fbd11c221d05206fa
 SHA512:
-  metadata.gz: 92f3f9cb5002eae3d5289d5e426a7954ca2f789a55f264360083f7a85a46d95279c63b516a6aa09b6661b5604afc33e38ddcf1c9d990429a8204e162930b684c
-  data.tar.gz: 9a33b2a71aa62207a38143383fb010b2bf557214f265d5fd2b3eb5e747d19627fc1cd5e33670e75539f34a3d9f10d6ea293818e68e239311b6ce93af3673734e
+  metadata.gz: 950dccc0e0ae5e801bd24d8516a11258ef386bbc706e13b7ed323cbd032bf4e61d45f32ba7ec49136e022777d700611838548a73e7b339e7d668b01d3a64266a
+  data.tar.gz: 979f5ee0f0bb62255aec3f5c11c844b787da1a9710f025f18d9f6d99d95dd80dd5d4ce4ae681743583d4a50ea8d251184ed31a4fdcd8073d056dc3d9fd654da6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (2.3.0)
+    smartcar (2.4.0)
       oauth2 (~> 1.4)
 
 GEM

data/lib/smartcar.rb

@@ -29,8 +29,7 @@ module Smartcar
   class AuthenticationError < ExternalServiceError; end
   # Error raised when Smartcar returns 400 response
   class BadRequestError < ExternalServiceError; end
-  # Smartcar API version - default version.
-  DEFAULT_API_VERSION = "v1.0".freeze
+
   # Host to connect to smartcar
   SITE = "https://api.smartcar.com/".freeze
 
@@ -51,4 +50,24 @@ module Smartcar
   STOP_CHARGE = "STOP".freeze
   # Constant for units
   UNITS = [IMPERIAL,METRIC]
+
+  # Smartcar API version variable - defaulted to 1.0
+  @api_version = "1.0"
+
+  # 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
+
+  # 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')
+  end
 end

data/lib/smartcar/base.rb

@@ -29,7 +29,7 @@ module Smartcar
           request.headers['Authorization'] = "BASIC #{get_basic_auth}" if data[:auth] == BASIC
           request.headers['sc-unit-system'] = unit_system if unit_system
           request.headers['Content-Type'] = "application/json"
-          complete_path = "/#{version}#{path}"
+          complete_path = "/v#{version}#{path}"
           if verb==:get
             request.url complete_path, data
           else

data/lib/smartcar/user.rb

@@ -13,7 +13,7 @@ module Smartcar
     # @param token [String] Access token
     #
     # @return [String] User ID
-    def self.user_id(token:, version: DEFAULT_API_VERSION)
+    def self.user_id(token:, version: Smartcar.get_api_version)
       # @deprecated Please use {#get} instead
       warn "[DEPRECATION] `Smartcar::User.user_id` is deprecated and will be removed in next major version update.  Please use `Smartcar::User.get` instead."
       get(token: token, version: version).id
@@ -25,7 +25,7 @@ module Smartcar
     # @param token [String] Access token
     #
     # @return [User] User object
-    def self.get(token:, version: DEFAULT_API_VERSION)
+    def self.get(token:, version: Smartcar.get_api_version)
       user = new(token: token, version: version)
       body, _meta = user.fetch(path: USER_PATH)
       user.instance_variable_set('@id', body['id'])

data/lib/smartcar/vehicle.rb

@@ -16,7 +16,7 @@ module Smartcar
 
     attr_reader :id
 
-    def initialize(token:, id:, unit_system: IMPERIAL, version: DEFAULT_API_VERSION)
+    def initialize(token:, id:, unit_system: IMPERIAL, version: Smartcar.get_api_version)
       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?
       raise InvalidParameterValue.new, "Access Token(token) is a required field" if token.nil?
@@ -32,7 +32,7 @@ module Smartcar
     # @param options [Hash] - Optional filter parameters (check documentation)
     #
     # @return [Array] of vehicle IDs(Strings)
-    def self.all_vehicle_ids(token:, options: {}, version: DEFAULT_API_VERSION)
+    def self.all_vehicle_ids(token:, options: {}, version: Smartcar.get_api_version)
       response, meta = new(token: token, id: 'none', version: version).fetch(
         path: PATH.call(''),
         options: options
@@ -49,7 +49,7 @@ module Smartcar
     # Defaults to US.
     #
     # @return [Boolean] true or false
-    def self.compatible?(vin:, scope:, country: 'US', version: DEFAULT_API_VERSION)
+    def self.compatible?(vin:, scope:, country: 'US', version: Smartcar.get_api_version)
       raise InvalidParameterValue.new, "vin is a required field" if vin.nil?
       raise InvalidParameterValue.new, "scope is a required field" if scope.nil?
 

data/lib/smartcar/version.rb

@@ -1,4 +1,4 @@
 module Smartcar
   # Gem current version number
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler