smartcar 2.4.0 → 2.5.0

data/lib/smartcar/odometer.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent Odometer
-  #@attr [Number] distanceLast recorded odometer reading.
+  # @attr [Number] distanceLast recorded odometer reading.
   class Odometer < Base
     # Path Proc for hitting odometer end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/odometer"}
+    PATH = proc { |id| "/vehicles/#{id}/odometer" }
     attr_reader :distance
   end
 end

data/lib/smartcar/permissions.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent permissions response
-  #@attr [Array] permissions Array of permissions granted on the vehicle.
+  # @attr [Array] permissions Array of permissions granted on the vehicle.
   class Permissions < Base
     # Path Proc for hitting permissions end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/permissions"}
+    PATH = proc { |id| "/vehicles/#{id}/permissions" }
     attr_reader :permissions
   end
 end

data/lib/smartcar/tire_pressure.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent Tire Pressure response
-  #@attr [Number] back_left Last recorded tire pressure of the back left tire.
-  #@attr [Number] back_right Last recorded tire pressure of the back right tire.
-  #@attr [Number] front_left Last recorded tire pressure of the front left tire.
-  #@attr [Number] front_right Last recorded tire pressure of the front right tire.
-
+  # @attr [Number] back_left Last recorded tire pressure of the back left tire.
+  # @attr [Number] back_right Last recorded tire pressure of the back right tire.
+  # @attr [Number] front_left Last recorded tire pressure of the front left tire.
+  # @attr [Number] front_right Last recorded tire pressure of the front right tire.
   class TirePressure < Base
     # Path Proc for hitting tire pressure end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/tires/pressure"}
+    PATH = proc { |id| "/vehicles/#{id}/tires/pressure" }
     attr_reader :backLeft, :backRight, :frontLeft, :frontRight
 
     # just to have Ruby-esque method names
-    alias_method :back_left, :backLeft
-    alias_method :back_right, :backRight
-    alias_method :front_left, :frontLeft
-    alias_method :front_right, :frontRight
+    alias back_left backLeft
+    alias back_right backRight
+    alias front_left frontLeft
+    alias front_right frontRight
   end
 end

data/lib/smartcar/user.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Smartcar
   # Class to get to user API.
-  #@attr [String] id Smartcar user id.
-  #@attr [String] token Access token used to connect to Smartcar API.
+  # @attr [String] id Smartcar user id.
+  # @attr [String] token Access token used to connect to Smartcar API.
   class User < Base
     # Path  for hitting user end point
-    USER_PATH = '/user'.freeze
+    USER_PATH = '/user'
     attr_reader :id
 
     # Class method Used to get user id
@@ -15,7 +17,8 @@ module Smartcar
     # @return [String] User ID
     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."
+      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
     end
 

data/lib/smartcar/utils.rb

@@ -1,5 +1,7 @@
-# Utils module , provides utility methods to underlying classes
+# frozen_string_literal: true
+
 module Smartcar
+  # Utils module , provides utility methods to underlying classes
   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
@@ -16,7 +18,7 @@ module Smartcar
     # @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)
+        hash[attribute.to_s.delete('@').to_sym] = instance_variable_get(attribute)
       end
     end
 
@@ -27,6 +29,7 @@ module Smartcar
     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
 
@@ -36,11 +39,17 @@ module Smartcar
     # @return [Object] nil OR Error object
     def get_error(response)
       status = response.status
-      return nil if [200,204].include?(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}")
+      return Smartcar::AuthenticationError.new('Authentication error') if status == 401
+
+      Smartcar::ExternalServiceError.new("API error - #{response.body}")
+    end
+
+    def handle_errors(response)
+      error = get_error(response)
+      raise error if error
     end
   end
 end

data/lib/smartcar/vehicle.rb

@@ -1,25 +1,32 @@
+# frozen_string_literal: true
+
 module Smartcar
   # Vehicle class to connect to vehicle basic info,disconnect, lock unlock and get all vehicles API
   # For ease of use, this also has methods define to be able to call other resources on a vehicle object
   # For Ex. Vehicle object will be treate as an entity and doing vehicle_object.
   # Battery should return Battery object.
   #
-  #@attr [String] token Access token used to connect to Smartcar API.
-  #@attr [String] id Smartcar vehicle ID.
-  #@attr [String] unit_system unit system to represent the data in.
+  # @attr [String] token Access token used to connect to Smartcar API.
+  # @attr [String] id Smartcar vehicle ID.
+  # @attr [String] unit_system unit system to represent the data in.
   class Vehicle < Base
+    include VehicleUtils::Data
+    include VehicleUtils::Actions
+    include VehicleUtils::Batch
     # Path for hitting compatibility end point
-    COMPATIBLITY_PATH = '/compatibility'.freeze
+    COMPATIBLITY_PATH = '/compatibility'
 
     # Path for hitting vehicle ids end point
-    PATH = Proc.new{|id| "/vehicles/#{id}"}
+    PATH = proc { |id| "/vehicles/#{id}" }
 
     attr_reader :id
 
     def initialize(token:, id:, unit_system: IMPERIAL, version: Smartcar.get_api_version)
+      super
       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?
+      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
@@ -33,7 +40,7 @@ module Smartcar
     #
     # @return [Array] of vehicle IDs(Strings)
     def self.all_vehicle_ids(token:, options: {}, version: Smartcar.get_api_version)
-      response, meta = new(token: token, id: 'none', version: version).fetch(
+      response, = new(token: token, id: 'none', version: version).fetch(
         path: PATH.call(''),
         options: options
       )
@@ -50,10 +57,11 @@ module Smartcar
     #
     # @return [Boolean] true or false
     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?
+      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', version: version).fetch(path: COMPATIBLITY_PATH,
+      response, = new(token: 'none', id: 'none', version: version).fetch(
+        path: COMPATIBLITY_PATH,
         options: {
           vin: vin,
           scope: scope.join(' '),
@@ -64,241 +72,10 @@ module Smartcar
       response['compatible']
     end
 
-    # Method to get batch requests
-    # API - https://smartcar.com/docs/api#post-batch-request
-    # @param attributes [Array] Array of strings or symbols of attributes to be fetched together
-    #
-    # @return [Hash] Hash wth key as requested attribute(symbol) and value as Error OR Object of the requested attribute
-    def batch(attributes = [])
-      raise InvalidParameterValue.new, "vin is a required field" if attributes.nil?
-      request_body = get_batch_request_body(attributes)
-      response, _meta = post(PATH.call(id) + "/batch", request_body)
-      process_batch_response(response)
-    end
-
-    # Fetch the list of permissions that this application has been granted for
-    # this vehicle
-    # EX : Smartcar::Vehicle.new(token: token, id: id).permissions
-    # @param options [Hash] - Optional filter parameters (check documentation)
-    #
-    # @return [Permissions] object
-    def permissions(options: {})
-      get_attribute(Permissions)
-    end
-
-    #  Method Used toRevoke access for the current requesting application
-    # API - https://smartcar.com/docs/api#delete-disconnect
-    #
-    # @return [Boolean] true if success
-    def disconnect!
-      response = delete(PATH.call(id) + "/application")
-      response['status'] == SUCCESS
-    end
-
-    # Methods Used to lock car
-    # API - https://smartcar.com/docs/api#post-security
-    #
-    # @return [Boolean] true if success
-    def lock!
-      lock_or_unlock!(action: Smartcar::LOCK)
-    end
-
-    # Methods Used to unlock car
-    # API - https://smartcar.com/docs/api#post-security
-    #
-    # @return [Boolean] true if success
-    def unlock!
-      lock_or_unlock!(action: Smartcar::UNLOCK)
-    end
-
-    # Method used to start charging a car
-    #
-    #
-    # @return [Boolean] true if success
-    def start_charge!
-      start_or_stop_charge!(action: Smartcar::START_CHARGE)
-    end
-
-    # Method used to stop charging a car
-    #
-    #
-    # @return [Boolean] true if success
-    def stop_charge!
-      start_or_stop_charge!(action: Smartcar::STOP_CHARGE)
-    end
-
-    # Returns make model year and id of the vehicle
-    # API - https://smartcar.com/api#get-vehicle-attributes
-    #
-    # @return [VehicleAttributes] object
-    def vehicle_attributes
-      get_attribute(VehicleAttributes)
-    end
-
-    # Returns the state of charge (SOC) and remaining range of an electric or
-    # plug-in hybrid vehicle's battery.
-    # API - https://smartcar.com/docs/api#get-ev-battery
-    #
-    # @return [Battery] object
-    def battery
-      get_attribute(Battery)
-    end
-
-    # Returns the capacity of an electric or
-    # plug-in hybrid vehicle's battery.
-    # API - https://smartcar.com/docs/api#get-ev-battery-capacity
-    #
-    # @return [Battery] object
-    def battery_capacity
-      get_attribute(BatteryCapacity)
-    end
-
-    # Returns the current charge status of the vehicle.
-    # API - https://smartcar.com/docs/api#get-ev-battery
-    #
-    # @return [Charge] object
-    def charge
-      get_attribute(Charge)
-    end
-
-    # Returns the remaining life span of a vehicle's engine oil
-    # API - https://smartcar.com/docs/api#get-engine-oil-life
-    #
-    # @return [EngineOil] object
-    def engine_oil
-      get_attribute(EngineOil)
-    end
-
-    # Returns the status of the fuel remaining in the vehicle's gas tank.
-    # API - https://smartcar.com/docs/api#get-fuel-tank
-    #
-    # @return [Fuel] object
-    def fuel
-      get_attribute(Fuel)
-    end
-
-    # Returns the last known location of the vehicle in geographic coordinates.
-    # API - https://smartcar.com/docs/api#get-location
-    #
-    # @return [Location] object
-    def location
-      get_attribute(Location)
-    end
-
-    # Returns the vehicle's last known odometer reading.
-    # API - https://smartcar.com/docs/api#get-odometer
-    #
-    # @return [Odometer] object
-    def odometer
-      get_attribute(Odometer)
-    end
-
-    # Returns the air pressure of each of the vehicle's tires.
-    # API - https://smartcar.com/docs/api#get-tire-pressure
-    #
-    # @return [TirePressure] object
-    def tire_pressure
-      get_attribute(TirePressure)
-    end
-
-    # Returns the vehicle's manufacturer identifier (VIN).
-    # API - https://smartcar.com/docs/api#get-vin
-    #
-    # @return [String] Vin of the vehicle.
-    def vin
-      _object = get_attribute(Vin)
-      @vin ||= _object.vin
-    end
-
     private
 
-    def allowed_attributes
-      @allowed_attributes ||= {
-        battery: get_path(Battery),
-        charge: get_path(Charge),
-        engine_oil: get_path(EngineOil),
-        fuel: get_path(Fuel),
-        location: get_path(Location),
-        odometer: get_path(Odometer),
-        permissions: get_path(Permissions),
-        tire_pressure: get_path(TirePressure),
-        vin: get_path(Vin),
-      }
-    end
-
-    def path_to_class
-      @path_to_class ||= {
-        get_path(Battery) => Battery,
-        get_path(Charge) => Charge,
-        get_path(EngineOil) => EngineOil,
-        get_path(Fuel) => Fuel,
-        get_path(Location) => Location,
-        get_path(Odometer) => Odometer,
-        get_path(Permissions) => Permissions,
-        get_path(TirePressure) => TirePressure,
-        get_path(Vin) => Vin,
-      }
-    end
-
-    # @private
-    BatchItemResponse = Struct.new(:body, :status, :headers) do
-      def body_with_meta
-        body.merge(meta: headers)
-      end
-    end
-
-    def get_batch_request_body(attributes)
-      attributes = validated_attributes(attributes)
-      requests = attributes.each_with_object([]) do |item, requests|
-        requests << { path: allowed_attributes[item] }
-      end
-      { requests: requests }
-    end
-
-    def process_batch_response(responses)
-      inverted_map = allowed_attributes.invert
-      responses["responses"].each_with_object({}) do |response, result|
-        item_response = BatchItemResponse.new(response["body"], response["code"], response["headers"])
-        error = get_error(item_response)
-        path = response["path"]
-        result[inverted_map[path]] = error || get_object(path_to_class[path], item_response.body_with_meta)
-      end
-    end
-
-    def validated_attributes(attributes)
-      attributes.map!(&:to_sym)
-      unsupported_attributes = (attributes - allowed_attributes.keys) || []
-      unless unsupported_attributes.empty?
-        message = "Unsupported attribute(s) requested in batch  - #{unsupported_attributes.join(',')}"
-        raise InvalidParameterValue.new, message
-      end
-      attributes
-    end
-
-    def get_attribute(klass)
-      body, meta =  fetch(
-        path: klass::PATH.call(id)
-      )
-      get_object(klass, body.merge(meta: meta))
-    end
-
     def get_object(klass, data)
       klass.new(data)
     end
-
-    def get_path(klass)
-      path = klass::PATH.call(id)
-      path.split("/vehicles/#{id}").last
-    end
-
-    def lock_or_unlock!(action:)
-      response, meta = post(PATH.call(id) + "/security", { action: action })
-      response['status'] == SUCCESS
-    end
-
-    def start_or_stop_charge!(action:)
-      response, meta = post(PATH.call(id) + "/charge", { action: action })
-      response['status'] == SUCCESS
-    end
   end
 end

data/lib/smartcar/vehicle_attributes.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Smartcar
   # class to represent Vehicle attributes like make model year
-  #@attr [String] id Smartcar vehicle ID
-  #@attr [String] make Manufacturer of the vehicle.
-  #@attr [String] model Model of the vehicle.
-  #@attr [Number] year Model year of the vehicle.
+  # @attr [String] id Smartcar vehicle ID
+  # @attr [String] make Manufacturer of the vehicle.
+  # @attr [String] model Model of the vehicle.
+  # @attr [Number] year Model year of the vehicle.
   class VehicleAttributes < Base
     # Path Proc for hitting vehicle attributes end point
-    PATH = Proc.new{|id| "/vehicles/#{id}"}
+    PATH = proc { |id| "/vehicles/#{id}" }
     attr_accessor :id, :make, :model, :year
   end
 end