smartcar 2.5.0 → 3.0.0

data/lib/smartcar/version.rb

@@ -2,5 +2,5 @@
 
 module Smartcar
   # Gem current version number
-  VERSION = '2.5.0'
+  VERSION = '3.0.0'
 end

data/lib/smartcar_error.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Custom SmartcarError class to represent errors from Smartcar APIs.
+class SmartcarError < StandardError
+  attr_reader :code, :status_code, :request_id, :type, :description, :doc_url, :resolution, :detail
+
+  def initialize(status, body, headers)
+    @status_code = status
+    if body.is_a?(String)
+      super(body)
+      @request_id = headers['sc-request-id']
+      return
+    end
+    body = coerce_attributes(body)
+
+    super("#{body[:type]}:#{body[:code]} - #{body[:description]}")
+    @request_id = body[:requestId] || headers['sc-request-id']
+    set_attributes(body)
+  end
+
+  private
+
+  def coerce_attributes(body)
+    body[:type] = body.delete(:error) if body[:error]
+    unless body[:description]
+      body[:description] = if body[:error_description]
+                             body.delete(:error_description)
+                           elsif body[:message]
+                             body.delete(:message)
+                           else
+                             'Unknown error'
+                           end
+    end
+
+    body
+  end
+
+  def set_attributes(body)
+    body.each do |attribute, value|
+      instance_variable_set("@#{attribute}", value)
+    end
+    @doc_url = body[:docURL]
+    @type = @error if @error
+
+    return unless @resolution
+
+    @resolution = @resolution.is_a?(String) ? OpenStruct.new({ type: @resolution }) : OpenStruct.new(@resolution)
+  end
+end

data/ruby-sdk.gemspec

@@ -27,10 +27,13 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'codecov', '~> 0.5.2'
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency 'readapt', '~> 1.3'
   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_development_dependency 'webmock', '~> 3.13'
   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.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: readapt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.142'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -149,27 +191,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/open_struct_extensions.rb
 - lib/smartcar.rb
+- lib/smartcar/auth_client.rb
 - lib/smartcar/base.rb
-- lib/smartcar/battery.rb
-- lib/smartcar/battery_capacity.rb
-- lib/smartcar/charge.rb
-- lib/smartcar/engine_oil.rb
-- lib/smartcar/fuel.rb
-- lib/smartcar/location.rb
-- lib/smartcar/oauth.rb
-- lib/smartcar/odometer.rb
-- lib/smartcar/permissions.rb
-- lib/smartcar/tire_pressure.rb
-- lib/smartcar/user.rb
 - 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
+- lib/smartcar_error.rb
 - ruby-sdk.gemspec
 homepage: https://rubygems.org/gems/smartcar
 licenses:

data/lib/smartcar/battery.rb

@@ -1,15 +0,0 @@
-# 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.
-  class Battery < Base
-    # Path Proc for hitting battery end point
-    PATH = proc { |id| "/vehicles/#{id}/battery" }
-    attr_reader :percentRemaining, :range
-
-    # just to have Ruby-esque method names
-    alias percentage_remaining percentRemaining
-  end
-end

data/lib/smartcar/battery_capacity.rb

@@ -1,11 +0,0 @@
-# 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,15 +0,0 @@
-# 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.
-  class Charge < Base
-    # Path Proc for hitting charge end point
-    PATH = proc { |id| "/vehicles/#{id}/charge" }
-    attr_reader :isPluggedIn, :state
-
-    # just to have Ruby-esque method names
-    alias is_plugged_in? isPluggedIn
-  end
-end

data/lib/smartcar/engine_oil.rb

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

data/lib/smartcar/fuel.rb

@@ -1,17 +0,0 @@
-# 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.
-  class Fuel < Base
-    # Path Proc for hitting fuel end point
-    PATH = proc { |id| "/vehicles/#{id}/fuel" }
-    attr_reader :amountRemaining, :percentRemaining, :range
-
-    # just to have Ruby-esque method names
-    alias amount_remaining amountRemaining
-    alias percent_remaining percentRemaining
-  end
-end

data/lib/smartcar/location.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Smartcar
-  # class to represent Location info
-  # @attr [Number] latitude Latitude of last recorded location.
-  # @attr [Number] longitude Longitude of last recorded location.
-  class Location < Base
-    # Path Proc for hitting location end point
-    PATH = proc { |id| "/vehicles/#{id}/location" }
-    attr_reader :latitude, :longitude
-  end
-end

data/lib/smartcar/oauth.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-module Smartcar
-  # Oauth class to take care of the Oauth 2.0 with Smartcar APIs
-  #
-  class Oauth < Base
-    extend Smartcar::Utils
-
-    attr_reader :redirect_uri, :client_id, :client_secret, :scope, :mode
-
-    # 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
-    # approval_prompt to `force`.
-    #
-    # @param options [Hash]
-    # @option options[:client_id] [String] - Client ID, if not passed fallsback to ENV['CLIENT_ID']
-    # @option options[:client_secret] [String] - Client Secret, if not passed fallsback to ENV['CLIENT_SECRET']
-    # @option options[:redirect_uri] [String] - Redirect URI, if not passed fallsback to ENV['REDIRECT_URI']
-    # @option options[:scope] [Array of Strings] - array of scopes that specify what the user can access
-    #   EXAMPLE : ['read_odometer', 'read_vehicle_info', 'required:read_location']
-    # For further details refer to https://smartcar.com/docs/guides/scope/
-    # @option options[:test_mode] [Boolean] - Setting this to 'true' runs it in test mode.
-    #
-    # @return [Smartcar::Oauth] Returns a Smartcar::Oauth Object that has other methods
-    def initialize(options)
-      options[:redirect_uri] ||= get_config('REDIRECT_URI')
-      options[:client_id] ||= get_config('CLIENT_ID')
-      options[:client_secret] ||= get_config('CLIENT_SECRET')
-      options[:mode] = options[:test_mode].nil? || !options[:test_mode] ? LIVE : TEST
-      super
-    end
-
-    # Generate the OAuth authorization URL.
-    # @param options [Hash]
-    # @option options[:state] [String] - OAuth state parameter passed to the
-    # redirect uri. This parameter may be used for identifying the user who
-    # initiated the request.
-    # @option options[:force_prompt] [Boolean] - Setting `force_prompt` to
-    # `true` will show the permissions approval screen on every authentication
-    # attempt, even if the user has previously consented to the exact scope of
-    # permissions.
-    # @option options[:make] [String] - `make' is an optional parameter that allows
-    # users to bypass the car brand selection screen.
-    # For a complete list of supported makes, please see our
-    # [API Reference](https://smartcar.com/docs/api#authorization) documentation.
-    # @option options[:single_select] [Boolean, Hash] -  An optional value that sets the
-    #  behavior of the grant dialog displayed to the user. If set to `true`,
-    #  `single_select` limits the user to selecting only one vehicle. If `single_select`
-    #  is an hash with the property `vin`, Smartcar will only authorize the vehicle
-    #  with the specified VIN. See the
-    #  [Single Select guide](https://smartcar.com/docs/guides/single-select/)
-    #  for more information.
-    # @option options[:flags] [Array of Strings] - an optional array of early access features to enable.
-    #
-    # @return [String] Authorization URL string
-    def authorization_url(options = {})
-      initialize_auth_parameters(options)
-      add_single_select_options(options[:single_select])
-      client.auth_code.authorize_url(@auth_parameters)
-    end
-
-    # Generates the tokens hash using the code returned in oauth process.
-    # @param auth_code [String] This is the code that is returned after user
-    # visits and authorizes on the authorization URL.
-    #
-    # @return [Hash] Hash of token, refresh token, expiry info and token type
-    def get_token(auth_code)
-      client.auth_code
-            .get_token(
-              auth_code,
-              redirect_uri: redirect_uri
-            ).to_hash
-    end
-
-    # Refreshing the access token
-    # @param refresh_token [String] refresh_token received during token exchange
-    #
-    # @return [Hash] Hash of token, refresh token, expiry info and token type
-    def exchange_refresh_token(refresh_token)
-      token_object = OAuth2::AccessToken.from_hash(client, { refresh_token: refresh_token })
-      token_object = token_object.refresh!
-      token_object.to_hash
-    end
-
-    # Checks if token is expired using Oauth2 classes
-    # @param expires_at [Number] expires_at as time since epoch
-    #
-    # @return [Boolean]
-    def expired?(expires_at)
-      OAuth2::AccessToken.from_hash(client, { expires_at: expires_at }).expired?
-    end
-
-    private
-
-    def initialize_auth_parameters(options)
-      @auth_parameters = {
-        response_type: CODE,
-        redirect_uri: redirect_uri,
-        mode: mode,
-        state: options[:state],
-        make: options[:make],
-        approval_prompt: options[:force_prompt] ? FORCE : AUTO,
-        flags: options[:flags]&.join(' '),
-        scope: scope&.join(' ')
-      }
-    end
-
-    def add_single_select_options(single_select)
-      if single_select.is_a?(Hash)
-        @auth_parameters[:single_select_vin] = single_select[:vin]
-        @auth_parameters[:single_select] = true
-      else
-        @auth_parameters[:single_select] = !single_select.nil?
-      end
-    end
-
-    # gets the Oauth Client object
-    #
-    # @return [OAuth2::Client] A Oauth Client object.
-    def client
-      @client ||= OAuth2::Client.new(client_id,
-                                     client_secret,
-                                     site: OAUTH_PATH)
-    end
-  end
-end

data/lib/smartcar/odometer.rb

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

data/lib/smartcar/permissions.rb

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

data/lib/smartcar/tire_pressure.rb

@@ -1,20 +0,0 @@
-# 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.
-  class TirePressure < Base
-    # Path Proc for hitting tire pressure end point
-    PATH = proc { |id| "/vehicles/#{id}/tires/pressure" }
-    attr_reader :backLeft, :backRight, :frontLeft, :frontRight
-
-    # just to have Ruby-esque method names
-    alias back_left backLeft
-    alias back_right backRight
-    alias front_left frontLeft
-    alias front_right frontRight
-  end
-end