smartcar 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32c5b37d833b0951c08a33faa9e4c3af4cc02a5032b46fdd22ee80418aaa23ec
-  data.tar.gz: e89526a99861483111ef3fb8af353d64e2444f32641772e34a78f66524f66a7d
+  metadata.gz: af85a8f04bb5ecfd37182ae539ef60e5ca4e9487edf5db544109417df43d82d0
+  data.tar.gz: 5f2ccac9657e5e5b122b32943fa48845aa0acd5319dccc8836fd6b3cbf063ced
 SHA512:
-  metadata.gz: cc82965cdba424926a2929cc8c6ba9e9e9c957939b60fde968485ba04985dc50542372d7c42dbb6621fbda362f2666a8a67ee93b0665548f7806b6d46f85efc0
-  data.tar.gz: 0faa6f47b0242ec99b5d3752a7ae2507bea41da3bb1b9a41880dc22dd6ebcf50292456f00586f489095dc00c2f86924e76eef8170acfa48e410d0b4d13d46156
+  metadata.gz: 47abd5b611ddc7089be88614c2b79a4d2c33db498f1254eea55f2ed1426b795752b47b7e08e9ac8825086790313738f16affdf536ebed450963b36fd0d1305e3
+  data.tar.gz: 3ffef0a6f8f06da4c9f70a6798a9f701521831cdc30bbc183e613515b2b9520a492bd2d9e686a5c4cca0421d42def98bc0ccb6c4239cabd1d7b250ba5416f31d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (3.1.0)
+    smartcar (3.2.0)
       oauth2 (~> 1.4)
       recursive-open-struct (~> 1.1.3)
 
@@ -20,36 +20,16 @@ GEM
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (1.9.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
+    faraday-net_http (2.0.2)
     hashdiff (1.0.1)
     jwt (2.3.0)
     multi_json (1.15.0)
     multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    oauth2 (1.4.7)
-      faraday (>= 0.8, < 2.0)
+    oauth2 (1.4.9)
+      faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)

data/README.md

@@ -116,6 +116,32 @@ Example Usage for oAuth -
 # get a new token or use .
 ```
 
+## Advanced configuration
+
+This SDK uses the [Faraday HTTP client library](https://lostisland.github.io/faraday/) which supports extensive customization through the use of middleware. If you need to customize the behavior of HTTP request/response processing, you can provide your own instance of Faraday::Connection to most methods in this library.
+
+**Important:** If you provide your own Faraday connection, you are responsible for configuring all HTTP connection behavior, including timeouts! This SDK uses some custom timeouts internally to ensure best behavior by default, so unless you want to customize them you may want to replicate those timeouts.
+
+Example of providing a custom Faraday connection to various methods:
+```ruby
+  # Example Faraday connection that uses the Instrumentation middleware
+  service = Faraday::Connection.new(url: Smartcar::API_ORIGIN, request: { timeout: Smartcar::DEFAULT_REQUEST_TIMEOUT }) do |c|
+    c.request :instrumentation
+  end
+
+  # Passing the custom service to #get_vehicles
+  Smartcar.get_vehicles(token: token, options: { service: service })
+
+  # Passing the custom service to #get_user
+  Smartcar.get_user(token: token, options: { service: service })
+
+  # Passing the custom service to #get_compatibility
+  Smartcar.get_compatibility(vin: vin, scope: scope, options: { service: service })
+
+  # Passing the custom service into a Smartcar::Vehicle object
+  vehicle = Smartcar::Vehicle.new(token: token, id: id, options: { service: service })
+```
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`.

data/lib/smartcar/base.rb

@@ -13,8 +13,6 @@ module Smartcar
     class InvalidParameterValue < StandardError; end
     # Constant for Basic auth type
     BASIC = 'Basic'
-    # Number of seconds to wait for response
-    REQUEST_TIMEOUT = 310
 
     attr_accessor :token, :error, :unit_system, :version, :auth_type
 
@@ -65,7 +63,10 @@ module Smartcar
     #
     # @return [OAuth2::AccessToken] An initialized AccessToken instance that acts as service client
     def service
-      @service ||= Faraday.new(url: ENV['SMARTCAR_API_ORIGIN'] || API_ORIGIN, request: { timeout: REQUEST_TIMEOUT })
+      @service ||= Faraday.new(
+        url: ENV['SMARTCAR_API_ORIGIN'] || API_ORIGIN,
+        request: { timeout: DEFAULT_REQUEST_TIMEOUT }
+      )
     end
   end
 end

data/lib/smartcar/vehicle.rb

@@ -11,6 +11,7 @@ module Smartcar
   # @attr [Hash] options
   # @attr unit_system [String] Unit system to represent the data in, defaults to Imperial
   # @attr version [String] API version to be used.
+  # @attr service [Faraday::Connection] An optional connection object to be used for requests.
   class Vehicle < Base
     attr_reader :id
 
@@ -69,12 +70,13 @@ module Smartcar
                                          }, skip: true }
     }.freeze
 
-    def initialize(token:, id:, options: { unit_system: METRIC, version: Smartcar.get_api_version })
+    def initialize(token:, id:, options: {})
       super
       @token = token
       @id = id
-      @unit_system = options[:unit_system]
-      @version = options[:version]
+      @unit_system = options[:unit_system] || METRIC
+      @version = options[:version] || Smartcar.get_api_version
+      @service = options[:service]
 
       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?
@@ -247,7 +249,7 @@ module Smartcar
     #   response body and a "meta" attribute with the relevant items from response headers.
     def request(method, path, body = {}, headers = {})
       path = "/vehicles/#{id}/#{path}"
-      raw_response, headers = send(method, path, body, headers)
+      raw_response, headers = send(method.downcase, path, body, headers)
       meta = build_meta(headers)
       json_to_ostruct({ body: raw_response, meta: meta })
     end

data/lib/smartcar/version.rb

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

data/lib/smartcar.rb

@@ -31,6 +31,9 @@ module Smartcar
   # Constant for units
   UNITS = [IMPERIAL, METRIC].freeze
 
+  # Number of seconds to wait for responses
+  DEFAULT_REQUEST_TIMEOUT = 310
+
   # Smartcar API version variable - defaulted to 2.0
   @api_version = '2.0'
 
@@ -54,22 +57,22 @@ module Smartcar
 
     # Module method Used to check compatiblity for VIN and scope
     #
-    # API Documentation - https://smartcar.com/docs/api#connect-compatibility
+    # API Documentation - https://smartcar.com/docs/api#compatibility-api. Options Hash
     # @param vin [String] VIN of the vehicle to be checked
     # @param scope [Array of Strings] - array of scopes
     # @param country [String] An optional country code according to
-    # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
-    # Defaults to US.
-    # @param options [Hash] Other optional parameters including overrides
+    # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Defaults to US.
+    # @param options [Hash] Other optional parameters including overrides (only valid for Smartcar API v1.0)
     # @option options [String] :client_id Client ID that overrides ENV
     # @option options [String] :client_secret Client Secret that overrides ENV
     # @option options [String] :version API version to use, defaults to what is globally set
     # @option options [Hash] :flags A hash of flag name string as key and a string or boolean value.
-    # @option options [Boolean] :test_mode Wether to use test mode or not.
+    # @option options [Boolean] :test_mode Whether to use test mode or not.
     # @option options [String] :test_mode_compatibility_level this is required argument while using
     # test mode with a real vin. For more information refer to docs.
+    # @option options [Faraday::Connection] :service Optional connection object to be used for requests
     #
-    # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#connect-compatibility
+    # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#compatibility-api
     #  and a meta attribute with the relevant items from response headers.
     def get_compatibility(vin:, scope:, country: 'US', options: {})
       raise InvalidParameterValue.new, 'vin is a required field' if vin.nil?
@@ -78,7 +81,8 @@ module Smartcar
       base_object = Base.new(
         {
           version: options[:version] || Smartcar.get_api_version,
-          auth_type: Base::BASIC
+          auth_type: Base::BASIC,
+          service: options[:service]
         }
       )
 
@@ -94,14 +98,18 @@ module Smartcar
     #
     # API Documentation - https://smartcar.com/docs/api#get-user
     # @param token [String] Access token
+    # @param version [String] Optional API version to use, defaults to what is globally set
+    # @param options [Hash] Other optional parameters including overrides
+    # @option options [Faraday::Connection] :service Optional connection object to be used for requests
     #
     # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-user
     #  and a meta attribute with the relevant items from response headers.
-    def get_user(token:, version: Smartcar.get_api_version)
+    def get_user(token:, version: Smartcar.get_api_version, options: {})
       base_object = Base.new(
         {
           token: token,
-          version: version
+          version: version,
+          service: options[:service]
         }
       )
       base_object.build_response(*base_object.fetch(path: PATHS[:user]))
@@ -112,14 +120,18 @@ module Smartcar
     # API Documentation - https://smartcar.com/docs/api#get-all-vehicles
     # @param token [String] - Access token
     # @param paging [Hash] - Optional filter parameters (check documentation)
+    # @param version [String] Optional API version to use, defaults to what is globally set
+    # @param options [Hash] Other optional parameters including overrides
+    # @option options [Faraday::Connection] :service Optional connection object to be used for requests
     #
     # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-all-vehicles
     #  and a meta attribute with the relevant items from response headers.
-    def get_vehicles(token:, paging: {}, version: Smartcar.get_api_version)
+    def get_vehicles(token:, paging: {}, version: Smartcar.get_api_version, options: {})
       base_object = Base.new(
         {
           token: token,
-          version: version
+          version: version,
+          service: options[:service]
         }
       )
       base_object.build_response(*base_object.fetch(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler