smartcar 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df9188b608db089e0225bdeaad7a7e585ec19ce0c2f8e024f16055c555c48cf
-  data.tar.gz: e85c23cacda1e774df87a84a4d916f7675584e4cb1f8d43f20496d9e04d6c213
+  metadata.gz: 8b46d97dfaa2c543d0c5a5a7fbe7be668991babc0b0d35b81c432dc6ae3b3d06
+  data.tar.gz: 6e67faac4de5a809023fad29fba657bba0648a67978831d4c19a1a26e7bc039b
 SHA512:
-  metadata.gz: fcce1b264d733d8abd2c5f0bb8fd84c2edd219ac45d1303b04deb0b5b2257b6a301cdeeb4e1c415ffbf8f339fd8543095e9d5897237f68e4e43e625f1e0f49c7
-  data.tar.gz: 3283ea8c41227ef0d46503b2b78be6581eadd6fc9c1d2b81e0f80ae65c06a868461040f0cb260a464cd966587fb491d826efea10a557928d94fe71ce82091d8a
+  metadata.gz: 92f3f9cb5002eae3d5289d5e426a7954ca2f789a55f264360083f7a85a46d95279c63b516a6aa09b6661b5604afc33e38ddcf1c9d990429a8204e162930b684c
+  data.tar.gz: 9a33b2a71aa62207a38143383fb010b2bf557214f265d5fd2b3eb5e747d19627fc1cd5e33670e75539f34a3d9f10d6ea293818e68e239311b6ce93af3673734e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (2.2.0)
+    smartcar (2.3.0)
       oauth2 (~> 1.4)
 
 GEM
@@ -60,4 +60,4 @@ DEPENDENCIES
   smartcar!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/lib/smartcar.rb

@@ -17,8 +17,8 @@ require "smartcar/vehicle"
 require "smartcar/user"
 
 
-  # Main Smartcar umbrella module
-  module Smartcar
+# 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
@@ -29,8 +29,8 @@ require "smartcar/user"
   class AuthenticationError < ExternalServiceError; end
   # Error raised when Smartcar returns 400 response
   class BadRequestError < ExternalServiceError; end
-  # Smartcar API version being used
-  API_VERSION = "v1.0".freeze
+  # Smartcar API version - default version.
+  DEFAULT_API_VERSION = "v1.0".freeze
   # Host to connect to smartcar
   SITE = "https://api.smartcar.com/".freeze
 

data/lib/smartcar/base.rb

@@ -15,7 +15,7 @@ module Smartcar
     # Number of seconds to wait for response
     REQUEST_TIMEOUT = 310
 
-    attr_accessor :token, :error, :meta, :unit_system
+    attr_accessor :token, :error, :meta, :unit_system, :version
 
     %i{get post patch put delete}.each do |verb|
       # meta programming and define all Restful methods.
@@ -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 = "/#{API_VERSION}#{path}"
+          complete_path = "/#{version}#{path}"
           if verb==:get
             request.url complete_path, data
           else

data/lib/smartcar/user.rb

@@ -13,10 +13,10 @@ module Smartcar
     # @param token [String] Access token
     #
     # @return [String] User ID
-    def self.user_id(token:)
+    def self.user_id(token:, version: DEFAULT_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).id
+      get(token: token, version: version).id
     end
 
     # Class method Used to get user id
@@ -25,8 +25,8 @@ module Smartcar
     # @param token [String] Access token
     #
     # @return [User] User object
-    def self.get(token:)
-      user = new(token: token)
+    def self.get(token:, version: DEFAULT_API_VERSION)
+      user = new(token: token, version: version)
       body, _meta = user.fetch(path: USER_PATH)
       user.instance_variable_set('@id', body['id'])
       user

data/lib/smartcar/vehicle.rb

@@ -16,13 +16,14 @@ module Smartcar
 
     attr_reader :id
 
-    def initialize(token:, id:, unit_system: IMPERIAL)
+    def initialize(token:, id:, unit_system: IMPERIAL, version: DEFAULT_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?
       @token = token
       @id = id
       @unit_system = unit_system
+      @version = version
     end
 
     # Class method Used to get all the vehicles in the app. This only returns
@@ -31,8 +32,8 @@ module Smartcar
     # @param options [Hash] - Optional filter parameters (check documentation)
     #
     # @return [Array] of vehicle IDs(Strings)
-    def self.all_vehicle_ids(token:, options: {})
-      response, _meta = new(token: token, id: 'none').fetch(
+    def self.all_vehicle_ids(token:, options: {}, version: DEFAULT_API_VERSION)
+      response, meta = new(token: token, id: 'none', version: version).fetch(
         path: PATH.call(''),
         options: options
       )
@@ -48,11 +49,11 @@ module Smartcar
     # Defaults to US.
     #
     # @return [Boolean] true or false
-    def self.compatible?(vin:, scope:, country: 'US')
+    def self.compatible?(vin:, scope:, country: 'US', version: DEFAULT_API_VERSION)
       raise InvalidParameterValue.new, "vin is a required field" if vin.nil?
       raise InvalidParameterValue.new, "scope is a required field" if scope.nil?
 
-      response, meta = new(token: 'none', id: 'none').fetch(path: COMPATIBLITY_PATH,
+      response, meta = new(token: 'none', id: 'none', version: version).fetch(path: COMPATIBLITY_PATH,
         options: {
           vin: vin,
           scope: scope.join(' '),

data/lib/smartcar/version.rb

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

metadata

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