smartcar 2.0.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b57225d3763fbbe7c577b89697ea80af48c4de44dcb39efdbb3a4811bfcfc27d
-  data.tar.gz: 5b7915fd5b5686909ddc01a63725287ed1771efa53b48b4c5c7327a6079449e1
+  metadata.gz: 3848d46ccf722b908e7b42acc1afebccc24fbf1362c36bd0b0a867cd8bdd5b85
+  data.tar.gz: 3cfbf110c26177478a4ffad5373aeffcb73411b85f014c7af98293ea42739601
 SHA512:
-  metadata.gz: f792bda809f5a3be1e89f775877f3ce11495b2416c8ec3d0767e8e0ed744333203a0defeb95beca33ba6f0f42d93bcaf7fd40cd6e6dc86ebcdf5fbb066487efa
-  data.tar.gz: cd9e6ac196300057dc0e704aab9a75bb65c0475273cf60b62872c92a07d7d7975f316e5e7c7bdab3424c866af1eac710492db538cd94b29e72dfd3678fcad73f
+  metadata.gz: f46fc77b3eafb462cfbd210d7509293368d9d2306ce8d16dbfbd4aad7a76339e53b689f06c2e50b3cc6eb56be5a390c805f8ae88384f6cfcdfa7e1ce27b34e91
+  data.tar.gz: ee615279dc5c61e75ba1afd3ffa640b2df9ffafd4ea459cf22558d145e434b117814bd4279fcfd418643146eec4386911735f8f1066babd3ce494df44d15cfba

data/.rubocop.yml

@@ -0,0 +1,28 @@
+# Prevent messages for libraries of rubocop
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+# Disabling ABC size for now as refactoring few places seems pointless for now
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.gemspec'
+    - 'spec/**/*'
+
+# Just ignoring test helper for headless auth.
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'spec/smartcar/helpers/auth_helper.rb'
+
+# Parameters in data from json API comes in as camelCase, ignoring those files to avoid snake_case enforcement
+Naming/MethodName:
+  Exclude:
+    - 'lib/smartcar/battery.rb'
+    - 'lib/smartcar/charge.rb'
+    - 'lib/smartcar/engine_oil.rb'
+    - 'lib/smartcar/fuel.rb'
+    - 'lib/smartcar/tire_pressure.rb'

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in smartcar.gemspec
 gemspec

data/Gemfile.lock

@@ -1,31 +1,40 @@
 PATH
   remote: .
   specs:
-    smartcar (2.0.0)
+    smartcar (2.5.0)
       oauth2 (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     byebug (11.1.3)
     childprocess (3.0.0)
     diff-lcs (1.3)
-    faraday (1.1.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)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     rack (2.2.3)
+    rainbow (3.0.0)
     rake (12.3.3)
-    redcarpet (3.5.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)
@@ -39,11 +48,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    ruby2_keywords (0.0.2)
+    rubocop (1.12.0)
+      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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    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)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -54,8 +76,9 @@ DEPENDENCIES
   rake (~> 12.3, >= 12.3.3)
   redcarpet (~> 3.5.0)
   rspec (~> 3.0)
+  rubocop (~> 1.12)
   selenium-webdriver (~> 3.142)
   smartcar!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/Rakefile

@@ -1,6 +1,14 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task default: %i[rubocop spec]

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "smartcar"
+require 'bundler/setup'
+require 'smartcar'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "smartcar"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/smartcar.rb

@@ -1,53 +1,83 @@
-require "smartcar/utils"
-require "smartcar/version"
-require "smartcar/base"
-require "smartcar/oauth"
-require "smartcar/permissions"
-require "smartcar/battery"
-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"
-require "smartcar/user"
-
-
-  # Main Smartcar umbrella module
-  module Smartcar
+# frozen_string_literal: true
+
+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/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
-  # Smartcar API version being used
-  API_VERSION = "v1.0".freeze
+
   # Host to connect to smartcar
-  SITE = "https://api.smartcar.com/".freeze
+  SITE = 'https://api.smartcar.com/'
 
   # Path for smartcar oauth
-  OAUTH_PATH = "https://connect.smartcar.com/oauth/authorize".freeze
-  %w(success code test live force auto metric imperial).each do |constant|
+  OAUTH_PATH = 'https://connect.smartcar.com/oauth/authorize'
+  %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".freeze
+  LOCK = 'LOCK'
   # Unlock value sent in request body
-  UNLOCK = "UNLOCK".freeze
+  UNLOCK = 'UNLOCK'
   # Start charge value sent in request body
-  START_CHARGE = "START".freeze
+  START_CHARGE = 'START'
   # Stop charge value sent in request body
-  STOP_CHARGE = "STOP".freeze
+  STOP_CHARGE = 'STOP'
   # Constant for units
-  UNITS = [IMPERIAL,METRIC]
+  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
+
+  # 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
+  # rubocop:enable Naming/AccessorMethodName
 end

data/lib/smartcar/base.rb

@@ -1,36 +1,38 @@
+# frozen_string_literal: true
+
 require 'oauth2'
 require 'base64'
 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
     # Constant for Bearer auth type
-    BEARER = 'BEARER'.freeze
+    BEARER = 'BEARER'
     # Constant for Basic auth type
-    BASIC = 'BASIC'.freeze
+    BASIC = 'BASIC'
     # Number of seconds to wait for response
     REQUEST_TIMEOUT = 310
 
-    attr_accessor :token, :error, :meta
+    attr_accessor :token, :error, :meta, :unit_system, :version
 
-    %i{get post patch put delete}.each do |verb|
+    %i[get post patch put delete].each do |verb|
       # meta programming and define all Restful methods.
       # @param path [String] the path to hit for the request.
       # @param data [Hash] request body if needed.
       #
       # @return [Hash] The response Json parsed as a hash.
-      define_method verb do |path, data=nil|
+      define_method verb do |path, data = nil|
         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['Content-Type'] = "application/json"
-          complete_path = "/#{API_VERSION}#{path}"
-          if verb==:get
+          request.headers['Authorization'] = "BASIC #{generate_basic_auth}" if data && data[:auth] == BASIC
+          request.headers['sc-unit-system'] = unit_system if unit_system
+          request.headers['Content-Type'] = 'application/json'
+          complete_path = "/v#{version}#{path}"
+          if verb == :get
             request.url complete_path, data
           else
             request.url complete_path
@@ -39,6 +41,7 @@ module Smartcar
         end
         error = get_error(response)
         raise error if error
+
         [JSON.parse(response.body), response.headers]
       end
     end
@@ -49,10 +52,9 @@ module Smartcar
     # @param auth [String] type of auth
     #
     # @return [Object]
-    def fetch(path: , options: {}, auth: 'BEARER')
-      _path = path
-      _path += "?#{URI.encode_www_form(options)}" unless options.empty?
-      get(_path, {auth: auth})
+    def fetch(path:, options: {}, auth: 'BEARER')
+      path += "?#{URI.encode_www_form(options)}" unless options.empty?
+      get(path, { auth: auth })
     end
 
     private
@@ -60,7 +62,7 @@ module Smartcar
     # returns auth token for BASIC auth
     #
     # @return [String] Base64 encoding of CLIENT:SECRET
-    def get_basic_auth
+    def generate_basic_auth
       Base64.strict_encode64("#{get_config('CLIENT_ID')}:#{get_config('CLIENT_SECRET')}")
     end
 

data/lib/smartcar/battery.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent Battery info
-  #@attr [Number] percentRemaining Decimal value representing the remaining charge percent.
-  #@attr [Number] range Remaining range of the vehicle.
+  # @attr [Number] percentRemaining Decimal value representing the remaining charge percent.
+  # @attr [Number] range Remaining range of the vehicle.
   class Battery < Base
     # Path Proc for hitting battery end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/battery"}
+    PATH = proc { |id| "/vehicles/#{id}/battery" }
     attr_reader :percentRemaining, :range
 
     # just to have Ruby-esque method names
-    alias_method :percentage_remaining, :percentRemaining
+    alias percentage_remaining percentRemaining
   end
 end

data/lib/smartcar/battery_capacity.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Smartcar
+  # class to represent Battery Capacity info
+  # @attr [Number] capacity Decimal value representing the battery's total capacity in kWh.
+  class BatteryCapacity < Base
+    # Path Proc for hitting battery capacity end point
+    PATH = proc { |id| "/vehicles/#{id}/battery/capacity" }
+    attr_reader :capacity
+  end
+end

data/lib/smartcar/charge.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent Charge info
-  #@attr [Boolean] isPluggedIn Specifies if the vehicle is plugged in.
-  #@attr [String] state Charging state of the vehicle.
+  # @attr [Boolean] isPluggedIn Specifies if the vehicle is plugged in.
+  # @attr [String] state Charging state of the vehicle.
   class Charge < Base
     # Path Proc for hitting charge end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/charge"}
+    PATH = proc { |id| "/vehicles/#{id}/charge" }
     attr_reader :isPluggedIn, :state
 
     # just to have Ruby-esque method names
-    alias_method :is_plugged_in?, :isPluggedIn
+    alias is_plugged_in? isPluggedIn
   end
 end

data/lib/smartcar/engine_oil.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent Engine oil info
-  #@attr [Number] lifeRemaining Remaining life of the engine oil
+  # @attr [Number] lifeRemaining Remaining life of the engine oil
   class EngineOil < Base
     # Path Proc for hitting engine oil end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/engine/oil"}
+    PATH = proc { |id| "/vehicles/#{id}/engine/oil" }
     attr_reader :lifeRemaining
 
     # just to have Ruby-esque method names
-    alias_method :life_remaining, :lifeRemaining
+    alias life_remaining lifeRemaining
   end
 end

data/lib/smartcar/fuel.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent Fuel info
-  #@attr [Number] amountRemaining Amount of fuel remaining.
-  #@attr [Number] percentageRemaining Decimal value representing the remaining fuel percent.
-  #@attr [Number] range Remaining range of the vehicle.
+  # @attr [Number] amountRemaining Amount of fuel remaining.
+  # @attr [Number] percentageRemaining Decimal value representing the remaining fuel percent.
+  # @attr [Number] range Remaining range of the vehicle.
   class Fuel < Base
     # Path Proc for hitting fuel end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/fuel"}
+    PATH = proc { |id| "/vehicles/#{id}/fuel" }
     attr_reader :amountRemaining, :percentRemaining, :range
 
     # just to have Ruby-esque method names
-    alias_method :amount_remaining, :amountRemaining
-    alias_method :percent_remaining, :percentRemaining
+    alias amount_remaining amountRemaining
+    alias percent_remaining percentRemaining
   end
 end