smartcar 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33c66ec003de2197f9f13d42b2dfb3b7f9fae2899a560d6b8453be21c9ed29b6
-  data.tar.gz: 39e7776b2bf8474dd3b95895b52358fbd22ec743b45584b0e9ac9a35ff18f816
+  metadata.gz: 6edb5e52f0934476c62ad8dd9c8851c4e65e8e2b38023b54ccf1d9b584ad75b1
+  data.tar.gz: 7dcf139e66ede5b2ab77b3c2c90ef5645776bcedcb72537402326da6d3be6eb8
 SHA512:
-  metadata.gz: a5f53bf8ddeb9a23d3bdc3fef43eb70c44422b844c3677d021dfee5f1d527e70ad2379f37b07d89e46829c86a94f30c5ef267322dba28716816552c6c0d3a2d9
-  data.tar.gz: 5912d436ed1cc6fe31b55d35bcaa2a553a9d94eb5cc8c808c48f131885234f0f07b14dc6fd720576c217fbda58a0e4716a57edfbe9f651be82e719b916bb0209
+  metadata.gz: 47a1bbb0152d2ab79e2e15f85094d28bacdea30e9f18003ae0e2b2e25f3f7475885e94eced22b568536ae043bb3f1c3f8cdf13e1cc9a29cb777f6420ad2f2964
+  data.tar.gz: 928aa7165e2af3a3a1c0a2402c7ea0f57467aa1cd2b3aaa7ff5aa2acf5662603c07eebe7e96121b0e432f81002147785b0cfbc3775ead59da9cbbfc6efc97634

data/.travis.yml

@@ -1,7 +1,28 @@
----
 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
+  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.3)
       oauth2 (~> 1.4)
 
 GEM
@@ -22,7 +22,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)
@@ -50,7 +50,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

@@ -123,8 +123,18 @@ 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 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 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
+```
 ## Contributing
 
 To contribute, please:

data/lib/smartcar/oauth.rb

@@ -1,83 +1,91 @@
 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/
+    #
+    # @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
+      }
+      @auth_parameters[:scope] = options[:scope].join(' ') if options[:scope]
+      %I(state make).each do |parameter|
+        parameters[:parameter] = options[:parameter] unless options[:parameter].nil?
       end
+    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
-      end
+    # Generate the OAuth authorization URL.
+    #
+    # @return [String] Authorization URL string
+    def authorization_url
+      client.auth_code.authorize_url(@auth_parameters)
+    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
+    # 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
 
-      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
+    # 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/version.rb

@@ -1,4 +1,4 @@
 module Smartcar
   # Gem current version number
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 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.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-17 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.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)