smartcar 3.3.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe729c83b0d759f2d787090e3f815ec9d97cd0b283585f8775ebe16e61b16e56
-  data.tar.gz: '029284bb31e8363b2cd0fe751705749e19365fb5692cbc3054325d648440117e'
+  metadata.gz: 8b73275a395285b7814ea6a00e15ba722b34c04e93f04f911558243cd906fb85
+  data.tar.gz: 46a585c74ab00a8c61fb3493a1f4cff476cbbbcae525be27124c5fdffb5be64b
 SHA512:
-  metadata.gz: 6e469fcb92c39256e4a779476217fdb7cd5cce276af14d61ac9a51054e5d5e485f70e8f7886fb1852d2fb9d8128edd9b85164303f7c36fdca9d919f50bb0f4cb
-  data.tar.gz: faf78f8b977e3548e9f44fa45a59ce3b26cc89de53e6d85f3a8bc5391ced3031bdb2801696cb237cc2bb8c801bf85f7d2dd5bb6f15ccf2904430c65549c8ac86
+  metadata.gz: 448a25c995db755a1b5d198d4843bb46da8c58512c8c42d83e9efcd81c68b8e57e8586fc0eba401936da85b64392aa95f8f05f3d9b1d80843764cae42ee6cd04
+  data.tar.gz: 4a3aa2472759eec45741c9d842cb336fccb5e1b4fc98859400aba6f526ac6a89c8ae0f1aedb9f87486e18e15e34c80a15855361aa1f909d9d83bebb21bc7ada6

data/.rubocop.yml

@@ -7,6 +7,10 @@ AllCops:
 Metrics/AbcSize:
   Enabled: false
 
+# Lengthen module line length
+Metrics/ModuleLength:
+  Max: 200
+
 # Disabling this becuase we are using `set` and `get` prefixed methods to keep some commonality across SDKs
 Naming/AccessorMethodName:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (3.3.1)
+    smartcar (3.6.0)
       oauth2 (~> 1.4)
       recursive-open-struct (~> 1.1.3)
 
@@ -20,15 +20,15 @@ GEM
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.2.0)
+    faraday (2.4.0)
       faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.2)
+    faraday-net_http (2.1.0)
     hashdiff (1.0.1)
-    jwt (2.3.0)
+    jwt (2.4.1)
     multi_json (1.15.0)
     multi_xml (0.6.0)
-    oauth2 (1.4.9)
+    oauth2 (1.4.10)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)

data/README.md

@@ -144,6 +144,8 @@ Example of providing a custom Faraday connection to various methods:
 
   # Passing the custom service into a Smartcar::Vehicle object
   vehicle = Smartcar::Vehicle.new(token: token, id: id, options: { service: service })
+
+  connections = Smartcar.get_connections(amt: 'amt', filter: {userId: 'user-id'}, options: {service: service})
 ```
 
 ## Development

data/lib/smartcar/base.rb

@@ -14,7 +14,7 @@ module Smartcar
     # Constant for Basic auth type
     BASIC = 'Basic'
 
-    attr_accessor :token, :error, :unit_system, :version, :auth_type
+    attr_accessor :token, :error, :unit_system, :version, :auth_type, :url
 
     %i[get post patch put delete].each do |verb|
       # meta programming and define all Restful methods.
@@ -54,7 +54,7 @@ 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,
+        url: url || ENV['SMARTCAR_API_ORIGIN'] || API_ORIGIN,
         request: { timeout: DEFAULT_REQUEST_TIMEOUT }
       )
     end

data/lib/smartcar/vehicle.rb

@@ -52,11 +52,18 @@ module Smartcar
         }
       },
       vin: { path: proc { |id| "/vehicles/#{id}/vin" } },
+      get_charge_limit: { path: proc { |id| "/vehicles/#{id}/charge/limit" } },
       disconnect!: { type: :delete, path: proc { |id| "/vehicles/#{id}/application" } },
       lock!: { type: :post, path: proc { |id| "/vehicles/#{id}/security" }, body: { action: 'LOCK' } },
       unlock!: { type: :post, path: proc { |id| "/vehicles/#{id}/security" }, body: { action: 'UNLOCK' } },
       start_charge!: { type: :post, path: proc { |id| "/vehicles/#{id}/charge" }, body: { action: 'START' } },
       stop_charge!: { type: :post, path: proc { |id| "/vehicles/#{id}/charge" }, body: { action: 'STOP' } },
+      set_charge_limit!: {
+        type: :post,
+        path: proc { |id| "/vehicles/#{id}/charge/limit" },
+        body: proc { |limit| { limit: limit } },
+        skip: true
+      },
       subscribe!: {
         type: :post,
         path: proc { |id, webhook_id| "/vehicles/#{id}/webhooks/#{webhook_id}" },
@@ -228,6 +235,19 @@ module Smartcar
       build_response(response, headers)
     end
 
+    # Set the charge limit for a given vehicle
+    #
+    # @param limit [float] A value between 0 and 1 denoting the charge limit to be set.
+    #
+    # @return [OpenStruct] Meta attribute with the relevant items from response headers.
+    def set_charge_limit!(limit)
+      path = METHODS.dig(:set_charge_limit!, :path).call(id)
+      body = METHODS.dig(:set_charge_limit!, :body).call(limit)
+
+      response, headers = post(path, {}, body)
+      build_response(response, headers)
+    end
+
     # Method to get batch requests.
     # API - https://smartcar.com/docs/api#post-batch-request
     # @param paths [Array] Array of paths as strings. Ex ['/battery', '/odometer']

data/lib/smartcar/version.rb

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

data/lib/smartcar.rb

@@ -15,10 +15,12 @@ module Smartcar
 
   # Host to connect to smartcar
   API_ORIGIN = 'https://api.smartcar.com/'
+  MANAGEMENT_API_ORIGIN = 'https://management.smartcar.com'
   PATHS = {
     compatibility: '/compatibility',
     user: '/user',
-    vehicles: '/vehicles'
+    vehicles: '/vehicles',
+    connections: '/management/connections'
   }.freeze
 
   # Path for smartcar oauth
@@ -80,8 +82,8 @@ module Smartcar
     # @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?
-      raise InvalidParameterValue.new, 'scope is a required field' if scope.nil?
+      raise Base::InvalidParameterValue.new, 'vin is a required field' if vin.nil?
+      raise Base::InvalidParameterValue.new, 'scope is a required field' if scope.nil? || scope.empty?
 
       base_object = Base.new(
         {
@@ -166,6 +168,70 @@ module Smartcar
       hash_challenge(amt, body.to_json) == signature
     end
 
+    # Module method Returns a paged list of all vehicle connections connected to the application.
+    #
+    # API Documentation - https://smartcar.com/docs/api#get-connections
+    # @param amt [String] - Application Management token
+    # @param filters [Hash] - Optional filter parameters (check documentation)
+    # @param paging [Hash] - Pass a cursor for paginated results
+    # @param options [Hash] Other optional parameters including overrides
+    # @option options [Faraday::Connection] :service Optional connection object to be used for requests
+    # @option options [String] :version Optional API version to use, defaults to what is globally set
+    #
+    # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-connections
+    #  and a meta attribute with the relevant items from response headers.
+    def get_connections(amt:, filter: {}, paging: {}, options: {})
+      paging[:limit] ||= 10
+      base_object = Base.new(
+        token: generate_basic_management_auth(amt, options),
+        version: options[:version] || Smartcar.get_api_version,
+        service: options[:service],
+        auth_type: Base::BASIC,
+        url: ENV['SMARTCAR_MANAGEMENT_API_ORIGIN'] || MANAGEMENT_API_ORIGIN
+      )
+      query_params = filter.merge(paging).compact
+
+      base_object.build_response(*base_object.get(
+        PATHS[:connections],
+        query_params
+      ))
+    end
+
+    def delete_connections(amt:, filter: {}, options: {})
+      user_id = filter[:user_id]
+      vehicle_id = filter[:vehicle_id]
+      error_message = nil
+      error_message = 'Filter can contain EITHER user_id OR vehicle_id, not both.' if user_id && vehicle_id
+      error_message = 'Filter needs one of user_id OR vehicle_id.' unless user_id || vehicle_id
+
+      raise Base::InvalidParameterValue.new, error_message if error_message
+
+      query_params = {}
+      query_params['user_id'] = user_id if user_id
+      query_params['vehicle_id'] = vehicle_id if vehicle_id
+
+      base_object = Base.new(
+        url: ENV['SMARTCAR_MANAGEMENT_API_ORIGIN'] || MANAGEMENT_API_ORIGIN,
+        auth_type: Base::BASIC,
+        token: generate_basic_management_auth(amt, options),
+        version: options[:version] || Smartcar.get_api_version,
+        service: options[:service]
+      )
+
+      base_object.build_response(*base_object.delete(
+        PATHS[:connections],
+        query_params
+      ))
+    end
+
+    # returns auth token for Basic vehicle management auth
+    #
+    # @return [String] Base64 encoding of default:amt
+    def generate_basic_management_auth(amt, options = {})
+      username = options[:username] || 'default'
+      Base64.strict_encode64("#{username}:#{amt}")
+    end
+
     private
 
     def build_compatibility_params(vin, scope, country, options)

data/lib/smartcar_error.rb

@@ -2,7 +2,7 @@
 
 # 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
+  attr_reader :code, :status_code, :request_id, :type, :description, :doc_url, :resolution, :detail, :retry_after
 
   def initialize(status, body, headers)
     @status_code = status
@@ -11,6 +11,7 @@ class SmartcarError < StandardError
       @request_id = headers['sc-request-id']
       return
     end
+    @retry_after = headers['retry-after']
     body = coerce_attributes(body)
 
     super("#{body[:type]}:#{body[:code]} - #{body[:description]}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.6.0
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler