smartcar 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ad3ad7082e2d27def7f0ee201f1b8f8b20eb25d3f17fffe71aecbb666dab87
-  data.tar.gz: ce9c4420338126a9cd6a22b2ae2da01f2ef9b469aaeb7df5a160377e54d939ce
+  metadata.gz: 8b73275a395285b7814ea6a00e15ba722b34c04e93f04f911558243cd906fb85
+  data.tar.gz: 46a585c74ab00a8c61fb3493a1f4cff476cbbbcae525be27124c5fdffb5be64b
 SHA512:
-  metadata.gz: 61339cf13180062815aca1ed833d5761a0c3613595818526fc9f247e44a23d4e76f547f859c769a5bdd90917ef3e77f74048ad624806aefe8a060331b13eb2a7
-  data.tar.gz: 9974454e496f5e67cb7bf121e696fea11c0b1ab22583a521293fcb42e750cfc70073efb33e63f1c8c2b11f77ddb1afc23f56904b7a6de2e8f03348c62fe6f0df
+  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.5.0)
+    smartcar (3.6.0)
       oauth2 (~> 1.4)
       recursive-open-struct (~> 1.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/version.rb

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

metadata

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