smartcar 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 726e54a0eb8a7ebe98749b6765e8bf6302c4faccc42695d9d75fd3dd3cb5b544
-  data.tar.gz: d5ff12b61c36f1f151a3eb161ef8134fe55c6d0bf98cb71d0de8c4138dac4045
+  metadata.gz: 20f8c410ca2e09b81f481f66f8790b9040688dec92973825d7a7ba72cec14a7d
+  data.tar.gz: 5c748df1b3c987a00df29e1f7f65ae8c89c76ad7473acfc8135c27ddad94fe15
 SHA512:
-  metadata.gz: dd45d1487f7ee1247831d5af2eae9bba2dcf1de43ee4f748243b03bce7a09721de3ce3e4a3a79946bbcaa4bdcc19a92036978a052666a279b3f40447d1dffd4a
-  data.tar.gz: 4c44d4439be32d51be9b1bbc8bb0a27b1a8dfdfb00aff6ebcdfba945e05d4f0d62406dacc370f8560ca0d80474de7900bce001a9fafa822c76d139301c5dc59d
+  metadata.gz: 4bdbd39d8887437f76f53ccea2cdc8f6ae618d5a13558713c44b74ca21ab01fbe960b8d8b66104ace8df1a4c3de2d8a2308e3fe6ec000c9a80b721abda0fca09
+  data.tar.gz: 71f27cea632e1578e878f9bb6c7caa921890236515facc7435f6b17aa2faa1c198c8e7bfd4064fd90ec37ee2533d31aae362b1f0c13ce867b43380d3add3fcbc

data/.travis.yml

@@ -21,6 +21,7 @@ deploy:
   provider: rubygems
   api_key: $RUBYGEMSAPI_KEY
   gem: smartcar
+  gemspec: ruby-sdk.gemspec
   on:
     tags: true
     branch: master

data/Gemfile.lock

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

data/README.md

@@ -107,10 +107,10 @@ Smartcar::ExternalServiceError (API error - {"error":"vehicle_state_error","mess
 Example Usage for oAuth -
 ```ruby
 # To get the redirect URL :
-2.5.5 :002 > options = {test_mode: true,scope: ["read_battery","read_charge","read_fuel","read_location","control_security","read_odometer","read_tires","read_vin","read_vehicle_info"]}
+2.5.5 :002 > options = {test_mode: true,scope: ["read_battery","read_charge","read_fuel","read_location","control_security","read_odometer","read_tires","read_vin","read_vehicle_info"],flags: ["country:DE"]}
 2.5.5 :003 > require 'smartcar'
 2.5.5 :004 > url = Smartcar::Oauth.authorization_url(options)
- => "https://connect.smartcar.com/oauth/authorize?approval_prompt=auto&client_id=2715c6b2-eba8-4fda-85b1-8d849733a344&mode=test&redirect_uri=http%3A%2F%2Flocalhost%3A8000%2Fcallback&response_type=code&scope=read_battery+read_charge+read_fuel+read_location+control_security+read_odometer+read_tires+read_vin+read_vehicle_info"
+ => "https://connect.smartcar.com/oauth/authorize?approval_prompt=auto&client_id=2715c6b2-eba8-4fda-85b1-8d849733a344&mode=test&redirect_uri=http%3A%2F%2Flocalhost%3A8000%2Fcallback&response_type=code&scope=read_battery+read_charge+read_fuel+read_location+control_security+read_odometer+read_tires+read_vin+read_vehicle_info&flags=country%3ADE"
 # Redirect user to the above URL.
 # After authentication user control reaches the callback URL with code.
 # Use the code from the parameters and request a token
@@ -123,7 +123,7 @@ Example Usage for oAuth -
 
 ## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and  create a git tag for the version, push git commits and tags. When merging to master if it finds the tag it will deploy to rubygems automatically
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 To run tests, make sure you have the env variables setup for client id and secret.
 ```shell
@@ -135,6 +135,21 @@ Tests can be run using either default rake command OR specific rspec command.
 ```ruby
 bundle exec rake spec
 ```
+
+Releasing to rubygems right now cannot be automated because of MFA ([source](https://github.com/rubygems/rubygems/issues/3092)). For now the process is to run the gem build and push commands locally and manually enter in the Rubygems MFA code (available on 1password). Steps for that would be :
+
+```
+# After merging to master, checkout to master and pull code locally, then run the following
+gem build
+  Successfully built RubyGem
+  Name: smartcar
+  Version: <version>
+  File: smartcar-<version>.gem
+# now push the gem built by the build command. This would ask for the MFA code
+gem push smartcar-<version>.gem
+```
+In general it is a good advice to create a tag for every release. If not for the above mentioned MFA bug, creating a tag for a commit on master and pushing the tag would trigger travis to deploy to rubygems automatically.
+
 ## Contributing
 
 To contribute, please:

data/lib/smartcar/oauth.rb

@@ -27,6 +27,7 @@ module Smartcar
     # @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[: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)
@@ -40,9 +41,12 @@ module Smartcar
         mode: options[:test_mode] ? TEST : LIVE,
         response_type: CODE
       }
-      @auth_parameters[:scope] = options[:scope].join(' ') if options[:scope]
+      
+      %I(scope flags).each do |parameter|
+        @auth_parameters[parameter] = options[parameter].join(' ') unless options[parameter].nil?
+      end
       %I(state make).each do |parameter|
-        parameters[:parameter] = options[:parameter] unless options[:parameter].nil?
+        @auth_parameters[parameter] = options[parameter] unless options[parameter].nil?
       end
     end
 

data/lib/smartcar/vehicle.rb

@@ -47,16 +47,20 @@ module Smartcar
     # API - https://smartcar.com/docs/api#connect-compatibility
     # @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.
     #
     # @return [Boolean] true or false
-    def self.compatible?(vin:, scope:)
+    def self.compatible?(vin:, scope:, country: 'US')
       raise InvalidParameterValue.new, "vin is a required field" if vin.nil?
       raise InvalidParameterValue.new, "scope is a required field" if scope.nil?
 
       response, meta = new(token: 'none', id: 'none').fetch(path: COMPATIBLITY_PATH,
         options: {
           vin: vin,
-          scope: scope.join(' ')
+          scope: scope.join(' '),
+          country: country
         },
         auth: BASIC
       )

data/lib/smartcar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)