smartcar 2.5.0 → 3.0.0

data/lib/smartcar/user.rb

@@ -1,38 +0,0 @@
-# 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.
-  class User < Base
-    # Path  for hitting user end point
-    USER_PATH = '/user'
-    attr_reader :id
-
-    # Class method Used to get user id
-    # EX : Smartcar::User.user_id
-    # API - https://smartcar.com/docs/api#get-user
-    # @param token [String] Access token
-    #
-    # @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.'
-      get(token: token, version: version).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:, version: Smartcar.get_api_version)
-      user = new(token: token, version: version)
-      body, _meta = user.fetch(path: USER_PATH)
-      user.instance_variable_set('@id', body['id'])
-      user
-    end
-  end
-end

data/lib/smartcar/vehicle_attributes.rb

@@ -1,14 +0,0 @@
-# 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.
-  class VehicleAttributes < Base
-    # Path Proc for hitting vehicle attributes end point
-    PATH = proc { |id| "/vehicles/#{id}" }
-    attr_accessor :id, :make, :model, :year
-  end
-end

data/lib/smartcar/vehicle_utils/actions.rb

@@ -1,61 +0,0 @@
-# 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

@@ -1,83 +0,0 @@
-# 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

@@ -1,110 +0,0 @@
-# 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/vin.rb

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