smartcar 0.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8fd8a3a8c8239d87ed360d17d3683525c64c0662
-  data.tar.gz: f72f37a1d07b31bcec3d14691b9f4b5f466f6963
+SHA256:
+  metadata.gz: 6edb5e52f0934476c62ad8dd9c8851c4e65e8e2b38023b54ccf1d9b584ad75b1
+  data.tar.gz: 7dcf139e66ede5b2ab77b3c2c90ef5645776bcedcb72537402326da6d3be6eb8
 SHA512:
-  metadata.gz: d3e8b86b26a86136e2f9644f011aff83d25f22193e1cc8d9cb39192d2c663b07524ebbc11feafb0559e4b5465ee94be59185f9d76debc8ca3d6b95b02601fdab
-  data.tar.gz: 2a1257fe53d9635d82b80ddcc1722308969cd6b1b89fd161d7d0627eca5d49cb6d31182d323375b887e29d52fb27635f51740ff4e22eb9d001825bd282ef07d6
+  metadata.gz: 47a1bbb0152d2ab79e2e15f85094d28bacdea30e9f18003ae0e2b2e25f3f7475885e94eced22b568536ae043bb3f1c3f8cdf13e1cc9a29cb777f6420ad2f2964
+  data.tar.gz: 928aa7165e2af3a3a1c0a2402c7ea0f57467aa1cd2b3aaa7ff5aa2acf5662603c07eebe7e96121b0e432f81002147785b0cfbc3775ead59da9cbbfc6efc97634

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug files
+.byebug*
+
+# ctags
+.tags*
+
+#idea files
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,28 @@
+sudo: false
+language: ruby
+cache: bundler
+services:
+- xvfb
+addons:
+  firefox: latest
+rvm:
+- 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/.yardopts

@@ -0,0 +1,2 @@
+--markup=markdown
+--no-private

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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 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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in smartcar.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    smartcar (1.0.3)
+      oauth2 (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    childprocess (3.0.0)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    jwt (2.2.1)
+    multi_json (1.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.4)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.2.3)
+    rake (12.3.3)
+    redcarpet (3.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubyzip (2.3.0)
+    selenium-webdriver (3.142.7)
+      childprocess (>= 0.5, < 4.0)
+      rubyzip (>= 1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 11.0)
+  rake (~> 12.3, >= 12.3.3)
+  redcarpet (~> 3.5.0)
+  rspec (~> 3.0)
+  selenium-webdriver (~> 3.142)
+  smartcar!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ashwin Subramanian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+
+# Smartcar Ruby SDK [![Gem Version][gem-url]][gem-image]
+
+Ruby gem library to quickly get started with the Smartcar API.
+
+## Overview
+
+The [Smartcar API](https://smartcar.com/docs) lets you read vehicle data
+(location, odometer) and send commands to vehicles (lock, unlock) using HTTP requests.
+
+To make requests to a vehicle from a web or mobile application, the end user
+must connect their vehicle using
+[Smartcar Connect](https://smartcar.com/docs/api#smartcar-connect).
+This flow follows the OAuth spec and will return a `code` which can be used to
+obtain an access token from Smartcar.
+
+The Smartcar Ruby Gem provides methods to:
+
+1. Generate the link to redirect to Connect.
+2. Make a request to Smartcar with the `code` obtained from Connect to obtain an
+   access and refresh token
+3. Make requests to the Smartcar API to read vehicle data and send commands to
+   vehicles using the access token obtained in step 2.
+
+Before integrating with Smartcar's SDK, you'll need to register an application
+in the [Smartcar Developer portal](https://developer.smartcar.com). If you do
+not have access to the dashboard, please
+[request access](https://smartcar.com/subscribe).
+
+### Flow
+
+- Create a new `AuthClient` object with your `clientId`, `clientSecret`,
+  `redirectUri`, and required `scope`.
+- Redirect the user to Smartcar Connect using `getAuthUrl` or one
+  of our frontend SDKs.
+- The user will login, and then accept or deny your `scope`'s permissions.
+- Handle the get request to `redirectUri`.
+  - If the user accepted your permissions, `req.query.code` will contain an
+    authorization code.
+    - Use `exchangeCode` with this code to obtain an access object
+      containing an access token (lasting 2 hours) and a refresh token
+      (lasting 60 days).
+      - Save this access object.
+    - If the user denied your permissions, `req.query.error` will be set
+      to `"access_denied"`.
+    - If you passed a state parameter to `getAuthUrl`, `req.query.state` will
+      contain the state value.
+- Get the user's vehicles with `getVehicleIds`.
+- Create a new `Vehicle` object using a `vehicleId` from the previous response,
+  and the `access_token`.
+- Make requests to the Smartcar API.
+- Use `exchangeRefreshToken` on your saved `refreshToken` to retrieve a new token
+  when your `accessToken` expires.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smartcar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smartcar
+
+## Usage
+
+Setup the environment variables for CLIENT_ID and CLIENT_SECRET.
+```bash
+# Get your API keys from https://dashboard.smartcar.com/signup
+export CLIENT_ID=<client id>
+export CLIENT_SECRET=<client secret>
+```
+
+Example Usage for calling the reports API with oAuth token
+```ruby
+2.5.7 :001 > require 'smartcar'
+ => true
+2.5.7 :003 > ids =  Smartcar::Vehicle.all_vehicle_ids(token: token)
+ => ["4bb777b2-bde7-4305-8952-25956f8c0868"]
+2.5.7 :004 > vehicle = Smartcar::Vehicle.new(token: token, id: ids.first)
+ => #<Smartcar::Vehicle:0x00005564211a7c48 @token="5ae77cb0-7c1a-486a-ac20-00c76d2fd1aa", @id="4bb777b2-bde7-4305-8952-25956f8c0868", @unit_system="imperial">
+2.5.7 :006 > vehicle.odometer
+ => #<Smartcar::Odometer:0x00005564211330f0 @distance=17966.94802354251, @meta={"date"=>"Fri, 12 Jun 2020 06:04:32 GMT", "content-type"=>"application/json; charset=utf-8", "content-length"=>"30", "connection"=>"keep-alive", "access-control-allow-origin"=>"*", "sc-data-age"=>"2020-06-12T06:04:28.843Z", "sc-unit-system"=>"imperial", "sc-request-id"=>"3c447e9e-4cf7-43cb-b688-fba8db3d3582"}>
+2.5.7 :007 > vehicle.battery
+ => #<Smartcar::Battery:0x00005564210fcb18 @range=105.63, @percentRemaining=0.98, @meta={"date"=>"Fri, 12 Jun 2020 06:04:44 GMT", "content-type"=>"application/json; charset=utf-8", "content-length"=>"40", "connection"=>"keep-alive", "access-control-allow-origin"=>"*", "sc-data-age"=>"2020-06-12T06:04:28.843Z", "sc-unit-system"=>"imperial", "sc-request-id"=>"455ed4b0-b768-4961-86d7-436ad71cf0fa"}>
+2.5.7 :009 > vehicle.lock!
+ => true
+2.5.7 :010 > vehicle.batch(["charge","battery"])
+=> {:charge=>#<Smartcar::Charge:0x000055853d1fd7c8 @state="NOT_CHARGING", @isPluggedIn=false, @meta={"sc-data-age"=>"2020-06-12T06:18:50.581Z"}>, :battery=>#<Smartcar::Battery:0x000055853d1fd638 @range=105.63, @percentRemaining=0.98, @meta={"sc-data-age"=>"2020-06-12T06:18:50.581Z", "sc-unit-system"=>"imperial"}>}
+2.5.7 :011 > vehicle.start_charge!
+Traceback (most recent call last):
+        5: from /usr/share/rvm/rubies/ruby-2.5.7/bin/irb:11:in `<main>'
+        4: from (irb):5
+        3: from /home/st-2vgpnn2/.rvm/gems/ruby-2.5.7/gems/smartcar-1.0.0/lib/smartcar/vehicle.rb:118:in `start_charge!'
+        2: from /home/st-2vgpnn2/.rvm/gems/ruby-2.5.7/gems/smartcar-1.0.0/lib/smartcar/vehicle.rb:290:in `start_or_stop_charge!'
+        1: from /home/st-2vgpnn2/.rvm/gems/ruby-2.5.7/gems/smartcar-1.0.0/lib/smartcar/base.rb:39:in `block (2 levels) in <class:Base>'
+Smartcar::ExternalServiceError (API error - {"error":"vehicle_state_error","message":"Charging plug is not connected to the vehicle.","code":"VS_004"})
+
+```
+
+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 :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"
+# 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)
+ => {"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
+# get a new token or use .
+```
+
+## 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 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:
+
+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.
+
+[gem-image]: https://badge.fury.io/rb/smartcar
+[gem-url]: https://badge.fury.io/rb/smartcar.svg

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smartcar"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smartcar.rb

@@ -0,0 +1,53 @@
+require "smartcar/utils"
+require "smartcar/version"
+require "smartcar/base"
+require "smartcar/oauth"
+require "smartcar/permissions"
+require "smartcar/battery"
+require "smartcar/charge"
+require "smartcar/engine_oil"
+require "smartcar/fuel"
+require "smartcar/location"
+require "smartcar/odometer"
+require "smartcar/tire_pressure"
+require "smartcar/vin"
+require "smartcar/vehicle_attributes"
+require "smartcar/vehicle"
+require "smartcar/user"
+
+
+  # Main Smartcar umbrella module
+  module Smartcar
+  # Error raised when a config is not found
+  class ConfigNotFound < StandardError; end
+  # Error raised when Smartcar returns non 400, 404, 401, 200 or 204 response
+  class ExternalServiceError < StandardError; end
+  # Error raised when Smartcar returns 404
+  class ServiceUnavailableError < ExternalServiceError; end
+  # Error raised when Smartcar returns Authentication Error with status 401
+  class AuthenticationError < ExternalServiceError; end
+  # Error raised when Smartcar returns 400 response
+  class BadRequestError < ExternalServiceError; end
+  # Smartcar API version being used
+  API_VERSION = "v1.0".freeze
+  # Host to connect to smartcar
+  SITE = "https://api.smartcar.com/".freeze
+
+  # Path for smartcar oauth
+  OAUTH_PATH = "https://connect.smartcar.com/oauth/authorize".freeze
+  %w(success code test live force auto metric imperial).each do |constant|
+    # Constant to represent the value
+    const_set(constant.upcase, constant.freeze)
+  end
+
+  # Lock value sent in request body
+  LOCK = "LOCK".freeze
+  # Unlock value sent in request body
+  UNLOCK = "UNLOCK".freeze
+  # Start charge value sent in request body
+  START_CHARGE = "START".freeze
+  # Stop charge value sent in request body
+  STOP_CHARGE = "STOP".freeze
+  # Constant for units
+  UNITS = [IMPERIAL,METRIC]
+end