smartcar 1.0.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f5f753c2493733b16502aa5d2cbd3957ed073a1caf9dbcd032241febbe75b7
-  data.tar.gz: 2f639abde820c99a2ea91a80518dd95ffba94dbfc1915dd5ddb53578189fdb5e
+  metadata.gz: b57225d3763fbbe7c577b89697ea80af48c4de44dcb39efdbb3a4811bfcfc27d
+  data.tar.gz: 5b7915fd5b5686909ddc01a63725287ed1771efa53b48b4c5c7327a6079449e1
 SHA512:
-  metadata.gz: 2abac7e475acd840ba72e98367857abed3ea53c1df739179cbaf1a9c6751542bdfc3871cd8f1fc908a428fa603839f68ec0a82c13f0bf9f985f462ee3bf32fa5
-  data.tar.gz: e7352fd756b8c969eb50450e6fa7024e4196e86511b9630afe1db0ba46cdf8d6ca71d342402b2e891bfcfe0ec6d88ba70a1f17dcf7ac3481ea169d12106ad5cc
+  metadata.gz: f792bda809f5a3be1e89f775877f3ce11495b2416c8ec3d0767e8e0ed744333203a0defeb95beca33ba6f0f42d93bcaf7fd40cd6e6dc86ebcdf5fbb066487efa
+  data.tar.gz: cd9e6ac196300057dc0e704aab9a75bb65c0475273cf60b62872c92a07d7d7975f316e5e7c7bdab3424c866af1eac710492db538cd94b29e72dfd3678fcad73f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (1.0.8)
+    smartcar (2.0.0)
       oauth2 (~> 1.4)
 
 GEM

data/lib/smartcar/oauth.rb

@@ -12,10 +12,25 @@ module Smartcar
     # @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)
+      @redirect_uri = options[:redirect_uri] || get_config('REDIRECT_URI')
+      @client_id = options[:client_id] || get_config('CLIENT_ID')
+      @client_secret = options[:client_secret] || get_config('CLIENT_SECRET')
+      @scope = options[:scope]
+      @test_mode = !!options[:test_mode]
+    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[:test_mode] [Boolean] - Setting this to 'true' runs it in test mode.
     # @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
@@ -24,37 +39,39 @@ module Smartcar
     # 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[: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[: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 [Smartcar::Oauth] Returns a Smartcar::Oauth Object that has other methods
-    def initialize(options)
-      @redirect_uri = options[:redirect_uri] || get_config('REDIRECT_URI')
-      @client_id = options[:client_id] || get_config('CLIENT_ID')
-      @client_secret = options[:client_secret] || get_config('CLIENT_SECRET')
-
-      @auth_parameters = {
+    # @return [String] Authorization URL string
+    def authorization_url(options = {})
+      options[:scope] = @scope
+      auth_parameters = {
         redirect_uri: @redirect_uri,
         approval_prompt: options[:force_prompt] ? FORCE : AUTO,
-        mode: options[:test_mode] ? TEST : LIVE,
-        response_type: CODE
+        mode: @test_mode ? TEST : LIVE,
+        response_type: CODE,
       }
-      
-      %I(scope flags).each do |parameter|
-        @auth_parameters[parameter] = options[parameter].join(' ') unless options[parameter].nil?
-      end
+
+      auth_parameters[:flags] = options[:flags].join(' ') unless options[:flags].nil?
+      auth_parameters[:scope] = @scope.join(' ') unless @scope.nil?
+
       %I(state make).each do |parameter|
-        @auth_parameters[parameter] = options[parameter] unless options[parameter].nil?
+        auth_parameters[parameter] = options[parameter] unless options[parameter].nil?
       end
-    end
 
-    # Generate the OAuth authorization URL.
-    #
-    # @return [String] Authorization URL string
-    def authorization_url
-      client.auth_code.authorize_url(@auth_parameters)
+      if(options[:single_select].is_a?(Hash))
+        auth_parameters[:single_select_vin] = options[:single_select][:vin]
+        auth_parameters[:single_select] = true
+      else
+        auth_parameters[:single_select] = !!options[:single_select]
+      end
+      client.auth_code.authorize_url(auth_parameters)
     end
 
     # Generates the tokens hash using the code returned in oauth process.
@@ -71,16 +88,23 @@ module Smartcar
     end
 
     # Refreshing the access token
-    # @param token_hash [Hash] This is the hash that is returned with the
-    # get_token method
+    # @param refresh_token [String] refresh_token received during token exchange
     #
     # @return [Hash] Hash of token, refresh token, expiry info and token type
-    def refresh_token(token_hash)
-      token_object = OAuth2::AccessToken.from_hash(client, token_hash)
+    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
     # gets the Oauth Client object
     #

data/lib/smartcar/utils.rb

@@ -10,6 +10,15 @@
     end
   end
 
+  # Utility method to return a hash of the isntance variables
+  #
+  # @return [Hash] hash of all instance variables
+  def to_hash
+    instance_variables.each_with_object({}) do |attribute, hash|
+      hash[attribute.to_s.delete("@").to_sym] = instance_variable_get(attribute)
+    end
+  end
+
   # gets a given env variable, checks for existence and throws exception if not present
   # @param config_name [String] key of the env variable
   #

data/lib/smartcar/version.rb

@@ -1,4 +1,4 @@
 module Smartcar
   # Gem current version number
-  VERSION = "1.0.8"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 2.0.0
 platform: ruby
 authors:
 - Ashwin Subramanian