smartcar 3.5.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ad3ad7082e2d27def7f0ee201f1b8f8b20eb25d3f17fffe71aecbb666dab87
-  data.tar.gz: ce9c4420338126a9cd6a22b2ae2da01f2ef9b469aaeb7df5a160377e54d939ce
+  metadata.gz: e1c4483d2719b243be93876bec15f34de1d2787308bb6a44383a9e0bbf0db00a
+  data.tar.gz: f4774a7225f67e3ddae7d4d935fbddf9cf772994ba5a7d236c3c2e8daf5ed222
 SHA512:
-  metadata.gz: 61339cf13180062815aca1ed833d5761a0c3613595818526fc9f247e44a23d4e76f547f859c769a5bdd90917ef3e77f74048ad624806aefe8a060331b13eb2a7
-  data.tar.gz: 9974454e496f5e67cb7bf121e696fea11c0b1ab22583a521293fcb42e750cfc70073efb33e63f1c8c2b11f77ddb1afc23f56904b7a6de2e8f03348c62fe6f0df
+  metadata.gz: 1a3c96cb014e4ad5b5797e0a8a4d74599f849f861fccee1739c916a02e77c53c105853a496a3f87b7e94e34c66046e0b49c0bc1e63b13da4a8fac6cf82c2c961
+  data.tar.gz: 4a3d22bb0334c947b39dcd43c2950e35c1b8453ddd3f731ae589f1dfbdbbd254cae671668f712387b455328fc0e15c25e925603e90be8fff2330ff31c9412936

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.5.0)
+    smartcar (3.7.0)
       oauth2 (~> 1.4)
       recursive-open-struct (~> 1.1.3)
 
@@ -20,25 +20,25 @@ GEM
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.4.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.7.10)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.1.0)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
-    jwt (2.4.1)
+    jwt (2.7.1)
     multi_json (1.15.0)
     multi_xml (0.6.0)
-    oauth2 (1.4.10)
+    oauth2 (1.4.11)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
+      rack (>= 1.2, < 4)
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
-    rack (2.2.3)
+    rack (3.0.8)
     rainbow (3.1.1)
     rake (12.3.3)
     readapt (1.4.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/utils.rb

@@ -125,6 +125,8 @@ module Smartcar
       # Adding this because else it would become tires_pressure
       return :tire_pressure if path == '/tires/pressure'
 
+      return :lock_status if path == '/security'
+
       path.split('/').reject(&:empty?).join('_').to_sym
     end
 

data/lib/smartcar/vehicle.rb

@@ -54,6 +54,13 @@ 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_status: {
+        path: proc { |id| "/vehicles/#{id}/security" },
+        aliases: {
+          'isLocked' => 'is_locked',
+          'chargingPort' => 'charging_port'
+        }
+      },
       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' } },
@@ -172,6 +179,17 @@ module Smartcar
     # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-vin
     #  and a meta attribute with the relevant items from response headers.
 
+    # @!method lock_status()
+    # Returns the lock status for a vehicle and the open status of its doors, windows, storage units,
+    # sunroof and charging port where available. The open status array(s) will be empty if a vehicle
+    # has partial support. The request will error if lock status can not be retrieved from the vehicle or
+    # the brand is not supported.
+    #
+    # API Documentation https://smartcar.com/docs/api#get-security
+    #
+    # @return [OpenStruct] And object representing the JSON response mentioned in https://smartcar.com/docs/api#get-security
+    #  and a meta attribute with the relevant items from response headers.
+
     # NOTES :
     # - We only generate the methods where there is no query string or additional options considering thats
     #   the majority, for all the ones that require parameters, write them separately.

data/lib/smartcar/version.rb

@@ -2,5 +2,5 @@
 
 module Smartcar
   # Gem current version number
-  VERSION = '3.5.0'
+  VERSION = '3.7.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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler