smartcar 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42d14a5db8893d4b26b07e273924b854c1c5970aee1a072e5d748a95a5934201
-  data.tar.gz: 8b5c2a8c57127a1a494dc6448c84a251d8c6f2eaf0f6773255258006dcac7296
+  metadata.gz: 8df9188b608db089e0225bdeaad7a7e585ec19ce0c2f8e024f16055c555c48cf
+  data.tar.gz: e85c23cacda1e774df87a84a4d916f7675584e4cb1f8d43f20496d9e04d6c213
 SHA512:
-  metadata.gz: 3b143db051f1009607453d86e2f034b3ad3a6a32949a0aee77ea88a6ef4db34e9d0f65d2b3e8da361eb4aee7da4cad4bcfe873aeb8079647287d488206f6fddb
-  data.tar.gz: 47061d5c08c3db932e6d8c0b2cea7e0064c60348122ac70fb537fbf512b19b545593d9448cbc91766299c8c31ae79029088d10dab56fc5a445d47de501d635ef
+  metadata.gz: fcce1b264d733d8abd2c5f0bb8fd84c2edd219ac45d1303b04deb0b5b2257b6a301cdeeb4e1c415ffbf8f339fd8543095e9d5897237f68e4e43e625f1e0f49c7
+  data.tar.gz: 3283ea8c41227ef0d46503b2b78be6581eadd6fc9c1d2b81e0f80ae65c06a868461040f0cb260a464cd966587fb491d826efea10a557928d94fe71ce82091d8a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (2.1.0)
+    smartcar (2.2.0)
       oauth2 (~> 1.4)
 
 GEM
@@ -10,14 +10,16 @@ GEM
     byebug (11.1.3)
     childprocess (3.0.0)
     diff-lcs (1.3)
-    faraday (1.2.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
+    faraday-net_http (1.0.1)
     jwt (2.2.2)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    oauth2 (1.4.4)
+    oauth2 (1.4.7)
       faraday (>= 0.8, < 2.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
@@ -25,7 +27,7 @@ GEM
       rack (>= 1.2, < 3)
     rack (2.2.3)
     rake (12.3.3)
-    redcarpet (3.5.0)
+    redcarpet (3.5.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -39,7 +41,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.4)
     rubyzip (2.3.0)
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)

data/lib/smartcar/base.rb

@@ -4,7 +4,7 @@ module Smartcar
   # The Base class for all of the other class.
   # Let other classes inherit from here and put common methods here.
   class Base
-    include Utils
+    include Smartcar::Utils
 
     # Error raised when an invalid parameter is passed.
     class InvalidParameterValue < StandardError; end
@@ -15,7 +15,7 @@ module Smartcar
     # Number of seconds to wait for response
     REQUEST_TIMEOUT = 310
 
-    attr_accessor :token, :error, :meta
+    attr_accessor :token, :error, :meta, :unit_system
 
     %i{get post patch put delete}.each do |verb|
       # meta programming and define all Restful methods.
@@ -27,7 +27,7 @@ module Smartcar
         response = service.send(verb) do |request|
           request.headers['Authorization'] = "BEARER #{token}"
           request.headers['Authorization'] = "BASIC #{get_basic_auth}" if data[:auth] == BASIC
-          request.headers['sc-unit-system'] = unit_system
+          request.headers['sc-unit-system'] = unit_system if unit_system
           request.headers['Content-Type'] = "application/json"
           complete_path = "/#{API_VERSION}#{path}"
           if verb==:get

data/lib/smartcar/oauth.rb

@@ -2,7 +2,7 @@ module Smartcar
   # Oauth class to take care of the Oauth 2.0 with Smartcar APIs
   #
   class Oauth < Base
-    extend Utils
+    extend Smartcar::Utils
     # By default users are not shown the permission dialog if they have already
     # approved the set of scopes for this application. The application can elect
     # to always display the permissions dialog to the user by setting

data/lib/smartcar/user.rb

@@ -5,22 +5,31 @@ module Smartcar
   class User < Base
     # Path  for hitting user end point
     USER_PATH = '/user'.freeze
-    attr_reader :id, :token
-
-    def initialize(token:)
-      raise InvalidParameterValue.new, "Access Token(token) is a required field" if token.nil?
-      @token = token
-    end
+    attr_reader :id
 
     # Class method Used to get user id
-    # EX : Smartcar::User.fetch
+    # EX : Smartcar::User.user_id
     # API - https://smartcar.com/docs/api#get-user
     # @param token [String] Access token
     #
-    # @return [User] object
+    # @return [String] User ID
     def self.user_id(token:)
-      new(token: token).get(USER_PATH)['id']
+      # @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
     end
 
+    # Class method Used to get user id
+    # EX : Smartcar::User.get
+    # API - https://smartcar.com/docs/api#get-user
+    # @param token [String] Access token
+    #
+    # @return [User] User object
+    def self.get(token:)
+      user = new(token: token)
+      body, _meta = user.fetch(path: USER_PATH)
+      user.instance_variable_set('@id', body['id'])
+      user
+    end
   end
 end

data/lib/smartcar/utils.rb

@@ -1,44 +1,46 @@
-  # Utils module , provides utility methods to underlying classes
+# Utils module , provides utility methods to underlying classes
+module Smartcar
   module Utils
-  # A constructor to take a hash and assign it to the instance variables
-  # @param options = {} [Hash] Could by any class's hash, but the first level keys should be defined in the class
-  #
-  # @return [Subclass os Base] Returns object of any subclass like Report
-  def initialize(options = {})
-    options.each do |attribute, value|
-      instance_variable_set("@#{attribute}", value)
+    # A constructor to take a hash and assign it to the instance variables
+    # @param options = {} [Hash] Could by any class's hash, but the first level keys should be defined in the class
+    #
+    # @return [Subclass os Base] Returns object of any subclass like Report
+    def initialize(options = {})
+      options.each do |attribute, value|
+        instance_variable_set("@#{attribute}", value)
+      end
     end
-  end
 
-  # Utility method to return a hash of the isntance variables
-  #
-  # @return [Hash] hash of all instance variables
-  def to_hash
-    instance_variables.each_with_object({}) do |attribute, hash|
-      hash[attribute.to_s.delete("@").to_sym] = instance_variable_get(attribute)
+    # Utility method to return a hash of the isntance variables
+    #
+    # @return [Hash] hash of all instance variables
+    def to_hash
+      instance_variables.each_with_object({}) do |attribute, hash|
+        hash[attribute.to_s.delete("@").to_sym] = instance_variable_get(attribute)
+      end
     end
-  end
 
-  # gets a given env variable, checks for existence and throws exception if not present
-  # @param config_name [String] key of the env variable
-  #
-  # @return [String] value of the env variable
-  def get_config(config_name)
-    config_name = "INTEGRATION_#{config_name}" if ENV['MODE'] == 'test'
-    raise Smartcar::ConfigNotFound, "Environment variable #{config_name} not found !" unless ENV[config_name]
-    ENV[config_name]
-  end
+    # gets a given env variable, checks for existence and throws exception if not present
+    # @param config_name [String] key of the env variable
+    #
+    # @return [String] value of the env variable
+    def get_config(config_name)
+      config_name = "INTEGRATION_#{config_name}" if ENV['MODE'] == 'test'
+      raise Smartcar::ConfigNotFound, "Environment variable #{config_name} not found !" unless ENV[config_name]
+      ENV[config_name]
+    end
 
-  # Given the response from smartcar API, returns an error object if needed
-  # @param response [Object] response Object with status and body
-  #
-  # @return [Object] nil OR Error object
-  def get_error(response)
-    status = response.status
-    return nil if [200,204].include?(status)
-    return Smartcar::ServiceUnavailableError.new("Service Unavailable - #{response.body}") if status == 404
-    return Smartcar::BadRequestError.new("Bad Request - #{response.body}") if status == 400
-    return Smartcar::AuthenticationError.new("Authentication error") if status == 401
-    return Smartcar::ExternalServiceError.new("API error - #{response.body}")
+    # Given the response from smartcar API, returns an error object if needed
+    # @param response [Object] response Object with status and body
+    #
+    # @return [Object] nil OR Error object
+    def get_error(response)
+      status = response.status
+      return nil if [200,204].include?(status)
+      return Smartcar::ServiceUnavailableError.new("Service Unavailable - #{response.body}") if status == 404
+      return Smartcar::BadRequestError.new("Bad Request - #{response.body}") if status == 400
+      return Smartcar::AuthenticationError.new("Authentication error") if status == 401
+      return Smartcar::ExternalServiceError.new("API error - #{response.body}")
+    end
   end
 end

data/lib/smartcar/vehicle.rb

@@ -8,9 +8,6 @@ module Smartcar
   #@attr [String] id Smartcar vehicle ID.
   #@attr [String] unit_system unit system to represent the data in.
   class Vehicle < Base
-    include Utils
-
-
     # Path for hitting compatibility end point
     COMPATIBLITY_PATH = '/compatibility'.freeze
 
@@ -18,7 +15,6 @@ module Smartcar
     PATH = Proc.new{|id| "/vehicles/#{id}"}
 
     attr_reader :id
-    attr_accessor :token, :unit_system
 
     def initialize(token:, id:, unit_system: IMPERIAL)
       raise InvalidParameterValue.new, "Invalid Units provided : #{unit_system}" unless UNITS.include?(unit_system)
@@ -36,7 +32,7 @@ module Smartcar
     #
     # @return [Array] of vehicle IDs(Strings)
     def self.all_vehicle_ids(token:, options: {})
-      response, meta = new(token: token, id: 'none').fetch(
+      response, _meta = new(token: token, id: 'none').fetch(
         path: PATH.call(''),
         options: options
       )

data/lib/smartcar/version.rb

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

metadata

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