smartcar 2.4.0 → 2.5.0

data/lib/smartcar/vehicle_utils/actions.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Smartcar
+  module VehicleUtils
+    # Actions module has all the action methods here to declutter Vehicle class
+    module Actions
+      #  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("#{Smartcar::Vehicle::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
+
+      private
+
+      def lock_or_unlock!(action:)
+        response, = post("#{Smartcar::Vehicle::PATH.call(id)}/security", { action: action })
+        response['status'] == SUCCESS
+      end
+
+      def start_or_stop_charge!(action:)
+        response, = post("#{Smartcar::Vehicle::PATH.call(id)}/charge", { action: action })
+        response['status'] == SUCCESS
+      end
+    end
+  end
+end

data/lib/smartcar/vehicle_utils/batch.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Smartcar
+  module VehicleUtils
+    # Batch module , has all the batch related methods here to declutter Vehicle class
+    module Batch
+      DATA_CLASSES = {
+        battery: Smartcar::Battery,
+        charge: Smartcar::Charge,
+        engine_oil: Smartcar::EngineOil,
+        fuel: Smartcar::Fuel,
+        location: Smartcar::Location,
+        odometer: Smartcar::Odometer,
+        permissions: Smartcar::Permissions,
+        tire_pressure: Smartcar::TirePressure,
+        vin: Smartcar::Vin
+      }.freeze
+      # 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 with 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("#{Smartcar::Vehicle::PATH.call(id)}/batch", request_body)
+        process_batch_response(response)
+      end
+
+      private
+
+      def allowed_attributes
+        @allowed_attributes ||= DATA_CLASSES.transform_values { |klass| get_path(klass) }
+      end
+
+      def path_to_class
+        @path_to_class ||= DATA_CLASSES.transform_keys { |key| get_path(DATA_CLASSES[key]) }
+      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, all_requests|
+          all_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 || path_to_class[path].new(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 Smartcar::Base::InvalidParameterValue.new, message
+        end
+        attributes
+      end
+
+      def get_path(klass)
+        path = klass::PATH.call(id)
+        path.split("/vehicles/#{id}").last
+      end
+    end
+  end
+end

data/lib/smartcar/vehicle_utils/data.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Smartcar
+  module VehicleUtils
+    # Data module has all the data accessor methods here to declutter Vehicle class
+    module Data
+      # 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(klass: Permissions, options: options)
+      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(klass: 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(klass: 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(klass: 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(klass: 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(klass: 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(klass: 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(klass: 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(klass: 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(klass: 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
+        @vin ||= get_attribute(klass: Vin).vin
+      end
+
+      private
+
+      def get_attribute(klass:, options: {})
+        body, meta = fetch(
+          path: klass::PATH.call(id),
+          options: options
+        )
+        klass.new(body.merge(meta: meta))
+      end
+    end
+  end
+end

data/lib/smartcar/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Smartcar
   # Gem current version number
-  VERSION = "2.4.0"
+  VERSION = '2.5.0'
 end

data/lib/smartcar/vin.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Smartcar
   # Hidden class to represent vin
   #
-  #@attr [String] vin Vin of the vehicle
+  # @attr [String] vin Vin of the vehicle
   class Vin < Base
     # Path Proc for hitting vin end point
-    PATH = Proc.new{|id| "/vehicles/#{id}/vin"}
+    PATH = proc { |id| "/vehicles/#{id}/vin" }
     attr_reader :vin
   end
 end

data/ruby-sdk.gemspec

@@ -1,33 +1,36 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "smartcar/version"
+require 'smartcar/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "smartcar"
+  spec.name = 'smartcar'
   spec.version = Smartcar::VERSION
-  spec.required_ruby_version = ">= 2.5.0"
-  spec.authors = ["Ashwin Subramanian"]
-  spec.email = ["ashwin.subramanian@smartcar.com"]
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.authors = ['Ashwin Subramanian']
+  spec.email = ['ashwin.subramanian@smartcar.com']
   spec.homepage = 'https://rubygems.org/gems/smartcar'
-  spec.summary = %q{Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)}
-  spec.description = %q{This is a ruby gem to access the smartcar APIs. It includes the API classes and the OAuth system.}
-  spec.license = "MIT"
-  spec.metadata    = {
-    "source_code_uri" => "https://github.com/smartcar/ruby-sdk",
-    "documentation_uri" => "https://www.rubydoc.info/gems/smartcar",
+  spec.summary = 'Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)'
+  spec.description = 'This is a ruby gem to access the smartcar APIs. It includes the API classes and the OAuth system.'
+  spec.license = 'MIT'
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/smartcar/ruby-sdk',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/smartcar'
   }
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug', '~> 11.0'
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "byebug", "~> 11.0"
-  spec.add_development_dependency "redcarpet", "~> 3.5.0"
-  spec.add_development_dependency "selenium-webdriver", "~> 3.142"
-  spec.add_dependency "oauth2", "~> 1.4"
+  spec.add_development_dependency 'redcarpet', '~> 3.5.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
+  spec.add_development_dependency 'selenium-webdriver', '~> 3.142'
+  spec.add_dependency 'oauth2', '~> 1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -45,47 +59,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +138,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
@@ -150,6 +165,9 @@ files:
 - lib/smartcar/utils.rb
 - lib/smartcar/vehicle.rb
 - lib/smartcar/vehicle_attributes.rb
+- lib/smartcar/vehicle_utils/actions.rb
+- lib/smartcar/vehicle_utils/batch.rb
+- lib/smartcar/vehicle_utils/data.rb
 - lib/smartcar/version.rb
 - lib/smartcar/vin.rb
 - ruby-sdk.gemspec