smartcar 1.0.1 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cbfd63412fb93df29762bcd8d7e1809efba9282414399ceeed67c62983cb43a
-  data.tar.gz: 1b27850fcee3fccde621fed15ae3a18a8ce8907a100db605e858ae7f06515c21
+  metadata.gz: a3f5f753c2493733b16502aa5d2cbd3957ed073a1caf9dbcd032241febbe75b7
+  data.tar.gz: 2f639abde820c99a2ea91a80518dd95ffba94dbfc1915dd5ddb53578189fdb5e
 SHA512:
-  metadata.gz: bc0fc036488e193817fcbb619aef63b03ab58997787bb41d8eb0491adc650a82927d0cd2b3c9cf44eebc6e3e1ffa0ffca503cfa610befc8e5e8e40a1a2b73fde
-  data.tar.gz: ad0c515197096c789558bed15820324fcd6e4bb13e651cd7351f225084aa5f7604a1e9debf89df12567efb9b468c8d4bd796b259e9451f200a20f59a495fcf0d
+  metadata.gz: 2abac7e475acd840ba72e98367857abed3ea53c1df739179cbaf1a9c6751542bdfc3871cd8f1fc908a428fa603839f68ec0a82c13f0bf9f985f462ee3bf32fa5
+  data.tar.gz: e7352fd756b8c969eb50450e6fa7024e4196e86511b9630afe1db0ba46cdf8d6ca71d342402b2e891bfcfe0ec6d88ba70a1f17dcf7ac3481ea169d12106ad5cc

data/.travis.yml

@@ -1,7 +1,29 @@
----
 sudo: false
 language: ruby
 cache: bundler
+services:
+- xvfb
+addons:
+  firefox: latest
 rvm:
-  - 2.5.5
-before_install: gem install bundler -v 2.0.2
+- 2.5
+- 2.6
+- 2.7
+before_install:
+  - gem install bundler -v 2.1.2
+  - wget https://github.com/mozilla/geckodriver/releases/download/v0.26.0/geckodriver-v0.26.0-linux64.tar.gz
+  - mkdir geckodriver
+  - tar -xzf geckodriver-v0.26.0-linux64.tar.gz -C geckodriver
+  - export PATH=$PATH:$PWD/geckodriver
+# install:
+# - firefox -headless &
+deploy:
+  provider: rubygems
+  api_key: $RUBYGEMSAPI_KEY
+  gem: smartcar
+  gemspec: ruby-sdk.gemspec
+  on:
+    tags: true
+    branch: master
+    rvm: 2.5
+  skip_cleanup: 'true'

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at Ashwin.Subramanian@ooma.com. All
+reported by contacting the project team at support@smartcar.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartcar (1.0.0)
+    smartcar (1.0.8)
       oauth2 (~> 1.4)
 
 GEM
@@ -10,10 +10,11 @@ GEM
     byebug (11.1.3)
     childprocess (3.0.0)
     diff-lcs (1.3)
-    faraday (1.0.1)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
-    jwt (2.2.1)
-    multi_json (1.14.1)
+      ruby2_keywords
+    jwt (2.2.2)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
     oauth2 (1.4.4)
@@ -22,7 +23,7 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    rack (2.2.2)
+    rack (2.2.3)
     rake (12.3.3)
     redcarpet (3.5.0)
     rspec (3.9.0)
@@ -38,6 +39,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    ruby2_keywords (0.0.2)
     rubyzip (2.3.0)
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
@@ -50,7 +52,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   byebug (~> 11.0)
   rake (~> 12.3, >= 12.3.3)
-  redcarpet
+  redcarpet (~> 3.5.0)
   rspec (~> 3.0)
   selenium-webdriver (~> 3.142)
   smartcar!

data/README.md

@@ -107,14 +107,15 @@ 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"
+2.5.5 :004 > client = Smartcar::Oauth.new(options)
+2.5.5 :005 > url = client.authorization_url
+ => "https://connect.smartcar.com/oauth/authorize?approval_prompt=auto&client_id=<client id>&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
-2.5.5 :006 > token_hash = Smartcar::Oauth.get_token(code)
+2.5.5 :006 > token_hash = client.get_token(code)
  => {"token_type"=>"Bearer", :access_token=>"56801a5e-6a0b-4d05-a43e-52a4d5e6648f", :refresh_token=>"4f46e7e4-28c5-47b3-ba8d-7dcef73d05dd", :expires_at=>1577875279}
 # This access_token can be used to call the Smartcar APIs as given above.
 # Store this hash and if it expired refresh the token OR use the code again to
@@ -123,7 +124,35 @@ 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 then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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
+export INTEGRATION_CLIENT_ID=<client id>
+export INTEGRATION_CLIENT_SECRET=<client secret>
+```
+
+Tests can be run using either default rake command OR specific rspec command.
+```ruby
+bundle exec rake spec
+```
+
+**NOTE : Do not forget to update the version number in version.rb.**
+
+## Release
+
+Deployments to Rubgygems is automated through Travis. After merging to master, create a tag on the latest commit on master and push it. That would trigger a CI job which will build, test and deploy to Rubygems. As a convention we use the version number of the gem for the release tag.
+
+```
+# After merging to master, checkout to master and pull code locally, then run the following
+git tag v1.2.3
+# now push the tags
+git push origin --tags
+Total 0 (delta 0), reused 0 (delta 0)
+To github.com:smartcar/ruby-sdk.git
+ * [new tag]         v1.2.3 -> v1.2.3
+```
+
 
 ## Contributing
 
@@ -131,7 +160,7 @@ To contribute, please:
 
 1. Open an issue for the feature (or bug) you would like to resolve.
 2. Resolve the issue and add tests in your feature branch.
-3. Open a PR from your feature branch into `develop` that tags the issue.
+3. Open a PR from your feature branch into `master` that tags the issue.
 
 [gem-image]: https://badge.fury.io/rb/smartcar
 [gem-url]: https://badge.fury.io/rb/smartcar.svg

data/lib/smartcar.rb

@@ -11,6 +11,7 @@ require "smartcar/location"
 require "smartcar/odometer"
 require "smartcar/tire_pressure"
 require "smartcar/vin"
+require "smartcar/vehicle_attributes"
 require "smartcar/vehicle"
 require "smartcar/user"
 

data/lib/smartcar/base.rb

@@ -12,6 +12,8 @@ module Smartcar
     BEARER = 'BEARER'.freeze
     # Constant for Basic auth type
     BASIC = 'BASIC'.freeze
+    # Number of seconds to wait for response
+    REQUEST_TIMEOUT = 310
 
     attr_accessor :token, :error, :meta
 
@@ -66,7 +68,7 @@ module Smartcar
     #
     # @return [OAuth2::AccessToken] An initialized AccessToken instance that acts as service client
     def service
-      @service ||= Faraday.new(url: SITE)
+      @service ||= Faraday.new(url: SITE, request: { timeout: REQUEST_TIMEOUT })
     end
   end
 end

data/lib/smartcar/oauth.rb

@@ -1,83 +1,95 @@
 module Smartcar
-  # Oauth class to take care of the Oauth 2.0 with genomelink APIs
+  # Oauth class to take care of the Oauth 2.0 with Smartcar APIs
   #
   class Oauth < Base
     extend Utils
-    class << self
-      # Generate the OAuth authorization URL.
-      #
-      # By default users are not shown the permission dialog if they have already
-      # approved the set of scopes for this application. The application can elect
-      # to always display the permissions dialog to the user by setting
-      # approval_prompt to `force`.
-      #
-      # @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
-      # permissions.
-      # @option options[:make] [String] - `make' is an optional parameter that allows
-      # 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/
-      #
-      # @return [String] URL where user needs to be redirected for authorization
-      def authorization_url(options)
-        parameters = {
-          redirect_uri: get_config('REDIRECT_URI'),
-          approval_prompt: options[:force_prompt] ? FORCE : AUTO,
-          mode: options[:test_mode] ? TEST : LIVE,
-          response_type: CODE
-        }
-        parameters[:scope] = options[:scope].join(' ') if options[:scope]
-        %I(state make).each do |parameter|
-          parameters[:parameter] = options[:parameter] unless options[:parameter].nil?
-        end
+    # By default users are not shown the permission dialog if they have already
+    # approved the set of scopes for this application. The application can elect
+    # to always display the permissions dialog to the user by setting
+    # approval_prompt to `force`.
+    #
+    # @param options [Hash]
+    # @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[: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
+    # permissions.
+    # @option options[:make] [String] - `make' is an optional parameter that allows
+    # 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[: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')
 
-        client.auth_code.authorize_url(parameters)
+      @auth_parameters = {
+        redirect_uri: @redirect_uri,
+        approval_prompt: options[:force_prompt] ? FORCE : AUTO,
+        mode: options[:test_mode] ? TEST : LIVE,
+        response_type: CODE
+      }
+      
+      %I(scope flags).each do |parameter|
+        @auth_parameters[parameter] = options[parameter].join(' ') unless options[parameter].nil?
       end
-
-      # [get_token description]
-      # @param auth_code [String] This is the code that is returned after use r
-      # visits and authorizes on the authorization URL.
-      #
-      # @return [Hash] Hash of token, refresh token, expiry info and token type
-      def get_token(auth_code)
-        client.auth_code
-          .get_token(
-            auth_code,
-            redirect_uri: get_config('REDIRECT_URI')
-          ).to_hash
+      %I(state make).each do |parameter|
+        @auth_parameters[parameter] = options[parameter] unless options[parameter].nil?
       end
+    end
 
-      # [refresh_token description]
-      # @param token_hash [Hash] This is the hash that is returned with the
-      # get_token method
-      #
-      # @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)
-        token_object = token_object.refresh!
-        token_object.to_hash
-      end
+    # Generate the OAuth authorization URL.
+    #
+    # @return [String] Authorization URL string
+    def authorization_url
+      client.auth_code.authorize_url(@auth_parameters)
+    end
 
-      private
-      # gets the Oauth Client object
-      #
-      # @return [OAuth2::Client] A Oauth Client object.
-      def client
-        @client ||= OAuth2::Client.new( get_config('CLIENT_ID'),
-          get_config('CLIENT_SECRET'),
-          :site => OAUTH_PATH
-        )
-      end
+    # Generates the tokens hash using the code returned in oauth process.
+    # @param auth_code [String] This is the code that is returned after user
+    # visits and authorizes on the authorization URL.
+    #
+    # @return [Hash] Hash of token, refresh token, expiry info and token type
+    def get_token(auth_code)
+      client.auth_code
+        .get_token(
+          auth_code,
+          redirect_uri: @redirect_uri
+        ).to_hash
+    end
+
+    # Refreshing the access token
+    # @param token_hash [Hash] This is the hash that is returned with the
+    # get_token method
+    #
+    # @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)
+      token_object = token_object.refresh!
+      token_object.to_hash
+    end
+
+    private
+    # gets the Oauth Client object
+    #
+    # @return [OAuth2::Client] A Oauth Client object.
+    def client
+      @client ||= OAuth2::Client.new( @client_id,
+        @client_secret,
+        :site => OAUTH_PATH
+      )
     end
   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
       )
@@ -80,7 +84,7 @@ module Smartcar
     # EX : Smartcar::Vehicle.new(token: token, id: id).permissions
     # @param options [Hash] - Optional filter parameters (check documentation)
     #
-    # @return [Array] of permissions (Strings)
+    # @return [Permissions] object
     def permissions(options: {})
       get_attribute(Permissions)
     end

data/lib/smartcar/version.rb

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

data/ruby-sdk.gemspec

@@ -12,7 +12,10 @@ Gem::Specification.new do |spec|
   spec.summary = %q{Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)}
   spec.description = %q{This is a ruby gem to access the smartcar APIs. It includes the API classes and the OAuth system.}
   spec.license = "MIT"
-  spec.metadata    = { "source_code_uri" => "https://github.com/smartcar/ruby-sdk" }
+  spec.metadata    = {
+    "source_code_uri" => "https://github.com/smartcar/ruby-sdk",
+    "documentation_uri" => "https://www.rubydoc.info/gems/smartcar",
+  }
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.8
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,6 +157,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/smartcar/ruby-sdk
+  documentation_uri: https://www.rubydoc.info/gems/smartcar
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)