smartcar 0.0.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8fd8a3a8c8239d87ed360d17d3683525c64c0662
-  data.tar.gz: f72f37a1d07b31bcec3d14691b9f4b5f466f6963
+SHA256:
+  metadata.gz: 77763e723a789174f3bab09883c2c4770019d73f6984acc2a20ab5580b71683d
+  data.tar.gz: 72ea1a37d4864c8f1e2251e15afcb8510ed07a910bdffe12abba2e6b17ff48fe
 SHA512:
-  metadata.gz: d3e8b86b26a86136e2f9644f011aff83d25f22193e1cc8d9cb39192d2c663b07524ebbc11feafb0559e4b5465ee94be59185f9d76debc8ca3d6b95b02601fdab
-  data.tar.gz: 2a1257fe53d9635d82b80ddcc1722308969cd6b1b89fd161d7d0627eca5d49cb6d31182d323375b887e29d52fb27635f51740ff4e22eb9d001825bd282ef07d6
+  metadata.gz: c8ca779368dc98843d5e623b1faa52fda1503077b932727da4ac84fd6ce2d9b35670e15c82427ee4074ea821fc025a46158ac42d63e9441eb5af25d8a12d26ad
+  data.tar.gz: 55c56eb58615e9ef19dfff70a8d25ec4cd61b3ac90152b63555ceb7218b15230a533302887d827b502d8b0b6f06dc3010412ae13d66e9d6757cd71aefcfaeaf7

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.2

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 Ashwin.Subramanian@ooma.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,51 @@
+PATH
+  remote: .
+  specs:
+    smartcar (0.1.1)
+      oauth2 (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    faraday (0.17.0)
+      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.2)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.0.8)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 11.0)
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+  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,75 @@
+
+
+Ruby gem library to quickly get started with the Smartcar API.
+
+## 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.5 :003 > require 'smartcar'
+ => true
+2.5.5 :009 > ids =  Smartcar::Vehicle.all_vehicle_ids(token: token)
+ => ["35e8a7c4-9e5c-4eb6-b552-7509e371669a", "c3332c35-fdeb-4780-a84b-706b7364979a", "d10ad5cf-5469-467e-972e-90427981873f", "fab5a744-6488-40d8-a6dd-41f0a804d44f"]
+2.5.5 :010 > vehicle = Smartcar::Vehicle.new(token: token, id: ids.first)
+ => #<Smartcar::Vehicle:0x00007fbad71aa2b8 @token="56801a5e-6a0b-4d05-a43e-52a4d5e6648f", @id="35e8a7c4-9e5c-4eb6-b552-7509e371669a", @unit_system="imperial">
+2.5.5 :011 > vehicle.permissions
+ => ["control_security", "read_battery", "read_charge", "read_location", "read_odometer", "read_vehicle_info", "read_vin"]
+2.5.5 :012 > vehicle.odometer
+ => #<Smartcar::Odometer:0x00007fbad718a3f0 @distance=74988.44443760936>
+2.5.5 :013 > vehicle.battery
+ => #<Smartcar::Battery:0x00007fbad50f4c80 @range=134.35, @percentRemaining=0.02>
+2.5.5 :014 > vehicle.charge
+ => #<Smartcar::Charge:0x00007fbad787e620 @state="FULLY_CHARGED", @isPluggedIn=true>
+```
+
+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 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).
+
+## 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.

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/base.rb

@@ -0,0 +1,72 @@
+require 'oauth2'
+require 'base64'
+module Smartcar
+  # The Base class for all of the other class.
+  # Let other classes inherit from here and put common methods here.
+  #
+  # @author [ashwin]
+  #
+  class Base
+    class InvalidParameterValue < StandardError; end
+    BEARER = 'BEARER'.freeze
+    BASIC = 'BASIC'.freeze
+
+    attr_accessor :token
+    # meta programming and define all Restful methods.
+    # @param path [String] the path to hit for the request.
+    # @param token [String] the access token to be used.
+    #
+    # @return [Hash] The response Json parsed as a hash.
+    %i{get post patch put delete}.each do |verb|
+      define_method verb do |path, data=nil|
+        response = service.send(verb) do |request|
+          request.headers['Authorization'] = "BEARER #{token}"
+          request.headers['Authorization'] = "BASIC #{get_basic_auth}" if data[:auth] == BASIC
+          request.headers['sc-unit-system'] = unit_system
+          request.headers['Content-Type'] = "application/json"
+          complete_path = "/#{API_VERSION}#{path}"
+          if verb==:get
+            request.url complete_path, data
+          else
+            request.url complete_path
+            request.body = data if data
+          end
+        end
+        status = response.status
+        raise ServiceUnavailableError.new, "Service Unavailable - #{response.body}" if status == 404
+        raise BadRequestError.new, "Bad Request - #{response.body}" if status == 400
+        raise AuthenticationError.new, "Authentication error" if status == 401
+        raise ExternalServiceError.new, "API error - #{response.body}" unless [200,204].include?(status)
+        JSON.parse(response.body)
+      end
+    end
+
+    # This requires a proc 'PATH' to be defined in the class
+    # @param token [String] Access token
+    # @param token [String] Vechicle ID
+    #
+    # @return [Object]
+    def fetch(path: , options: {}, auth: 'BEARER')
+      _path = path
+      _path += "?#{URI.encode_www_form(options)}" unless options.empty?
+      get(_path, {auth: auth})
+    end
+
+    private
+
+    # returns auth token for BASIC auth
+    #
+    # @return [String] Base64 encoding of CLIENT:SECRET
+    def get_basic_auth
+      Base64.strict_encode64("#{ENV['CLIENT_ID']}:#{ENV['CLIENT_SECRET']}")
+    end
+
+    # gets a smartcar API service/client
+    # @param token [String] Access token.
+    #
+    # @return [OAuth2::AccessToken] An initialized AccessToken instance that acts as service client
+    def service
+      @service ||= Faraday.new(url: SITE)
+    end
+  end
+end

data/lib/smartcar/battery.rb

@@ -0,0 +1,14 @@
+module Smartcar
+  # class to represent battery info
+  #
+  # @author [ashwin]
+  #
+  class Battery < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/battery"}
+    attr_accessor :percentRemaining, :range
+
+    # just to have Ruby-esque method names
+    alias_method :percentage_remaining, :percentRemaining
+  end
+end

data/lib/smartcar/charge.rb

@@ -0,0 +1,14 @@
+module Smartcar
+  # class to represent Charge info
+  #
+  # @author [ashwin]
+  #
+  class Charge < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/charge"}
+    attr_accessor :isPluggedIn, :state
+
+    # just to have Ruby-esque method names
+    alias_method :is_plugged_in?, :isPluggedIn
+  end
+end

data/lib/smartcar/engine_oil.rb

@@ -0,0 +1,14 @@
+module Smartcar
+  # class to represent Engine oil life
+  #
+  # @author [ashwin]
+  #
+  class EngineOil < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/engine/oil"}
+    attr_accessor :lifeRemaining
+
+    # just to have Ruby-esque method names
+    alias_method :life_remaining, :lifeRemaining
+  end
+end

data/lib/smartcar/fuel.rb

@@ -0,0 +1,15 @@
+module Smartcar
+  # class to represent Fuel info
+  #
+  # @author [ashwin]
+  #
+  class Fuel < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/fuel"}
+    attr_accessor :amountRemaining, :percentRemaining, :range
+
+    # just to have Ruby-esque method names
+    alias_method :amount_remaining, :amountRemaining
+    alias_method :percent_remaining, :percentRemaining
+  end
+end

data/lib/smartcar/location.rb

@@ -0,0 +1,11 @@
+module Smartcar
+  # class to represent Location info
+  #
+  # @author [ashwin]
+  #
+  class Location < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/location"}
+    attr_accessor :latitude, :longitude
+  end
+end

data/lib/smartcar/oauth.rb

@@ -0,0 +1,93 @@
+module Smartcar
+  # Oauth class to take care of the Oauth 2.0 with genomelink APIs
+  #
+  # @author [ashwin]
+  #
+  class Oauth < Base
+    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]
+      # @param options[:state] [String] - OAuth state parameter passed to the
+      # redirect uri. This parameter may be used for identifying the user who
+      # initiated the request.
+      # @param options[:test_mode] [Boolean] - Setting this to 'true' runs it in test mode.
+      # @param 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.
+      # @param 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.
+      # @param 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
+        
+        client.auth_code.authorize_url(parameters)
+      end
+
+      # [get_token description]
+      # @param auth_code [String] This is the code that is returned after use 
+      # 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
+
+      # [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
+
+      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
+
+      # gets a given env variable, checks for existence and throws exception if not present
+      # @param config_name [String] key of the env variable
+      #
+      # @return [String] value of the env variable
+      def get_config(config_name)
+        raise ConfigNotFound, "Environment variable #{config_name} not found !" unless ENV[config_name]
+        ENV[config_name]
+      end
+    end
+  end
+end

data/lib/smartcar/odometer.rb

@@ -0,0 +1,11 @@
+module Smartcar
+  # class to get Charge info
+  #
+  # @author [ashwin]
+  #
+  class Odometer < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/odometer"}
+    attr_accessor :distance
+  end
+end

data/lib/smartcar/permissions.rb

@@ -0,0 +1,11 @@
+module Smartcar
+  # class to get Charge info
+  #
+  # @author [ashwin]
+  #
+  class Permissions
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/permissions"}
+    attr_accessor :permissions
+  end
+end

data/lib/smartcar/tire_pressure.rb

@@ -0,0 +1,17 @@
+module Smartcar
+  # class to represent Engine oil life
+  #
+  # @author [ashwin]
+  #
+  class TirePressure < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/tires/pressure"}
+    attr_accessor :backLeft, :backRight, :frontLeft, :frontRight
+
+    # just to have Ruby-esque method names
+    alias_method :back_left, :backLeft
+    alias_method :back_right, :backRight
+    alias_method :front_left, :frontLeft
+    alias_method :front_right, :frontRight
+  end
+end

data/lib/smartcar/user.rb

@@ -0,0 +1,26 @@
+module Smartcar
+  # Class to get to user API.
+  #
+  # @author [ashwin]
+  #
+  class User < Base
+    USER_PATH = '/user'.freeze
+    attr_accessor :id, :token
+
+    def initialize(token:)
+      raise InvalidParameterValue.new, "Access Token(token) is a required field" if token.nil?
+      @token = token
+    end
+
+    # Class method Used to get user id
+    # EX : Smartcar::User.fetch
+    # API - https://smartcar.com/docs/api#get-user
+    # @param token [String] Access token
+    #
+    # @return [User] object
+    def self.user_id(token:)
+      new(token: token).get(USER_PATH)['id']
+    end
+    
+  end
+end

data/lib/smartcar/utils.rb

@@ -0,0 +1,11 @@
+module Utils
+    # A constructor to take a hash and assign it to the instance variables
+    # @param options = {} [Hash] Could by any class's hash, but the first level keys should be defined in the class
+    #
+    # @return [Subclass os Base] Returns object of any subclass like Report
+    def initialize(options = {})
+      options.each do |attribute, value|
+        instance_variable_set("@#{attribute}", value)
+      end
+    end
+end

data/lib/smartcar/vehicle.rb

@@ -0,0 +1,186 @@
+module Smartcar
+  # Vehicle class to connect to vehicle basic info,disconnect, lock unlock and get all vehicles API
+  # For ease of use, this also has methods define to be able to call other resources on a vehicle object
+  # For Ex. Vehicle object will be treate as an entity and doing vehicle_object.
+  # Battery should return Battery object.
+  #
+  # @author [ashwin]
+  #
+  class Vehicle < Base
+
+    COMPATIBLITY_PATH = '/compatibility'.freeze
+    PATH = Proc.new{|id| "/vehicles/#{id}"}
+    attr_accessor :token, :id, :unit_system
+
+
+    def initialize(token:, id:, unit_system: IMPERIAL)
+      raise InvalidParameterValue.new, "Invalid Units provided : #{unit_system}" unless UNITS.include?(unit_system)
+      raise InvalidParameterValue.new, "Vehicle ID (id) is a required field" if id.nil?
+      raise InvalidParameterValue.new, "Access Token(token) is a required field" if token.nil?
+      @token = token
+      @id = id
+      @unit_system = unit_system
+    end
+
+    # Accessor method for vehicle attributes.
+    %I(make model year).each do |method_name|
+      define_method method_name do
+        vehicle_attributes.send(method_name)
+      end
+    end
+
+    # Class method Used to get all the vehicles in the app. This only returns
+    # API - https://smartcar.com/docs/api#get-all-vehicles
+    # @param token [String] - Access token
+    # @param options [Hash] - Optional filter parameters (check documentation)
+    #
+    # @return [Array] of vehicle IDs(Strings)
+    def self.all_vehicle_ids(token:, options: {})
+      new(token: token, id: 'none').fetch(
+        path: PATH.call(''),
+        options: options
+      )['vehicles']
+    end
+
+    # Class method Used to check compatiblity for VIN and scope
+    # 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
+    #
+    # @return [Boolean] true or false
+    def self.compatible?(vin:, scope:)
+      raise InvalidParameterValue.new, "vin is a required field" if vin.nil?
+      raise InvalidParameterValue.new, "scope is a required field" if scope.nil?
+
+      new(token: 'none', id: 'none').fetch(path: COMPATIBLITY_PATH,
+        options: {
+          vin: vin,
+          scope: scope.join(' ')
+        },
+        auth: BASIC
+      )['compatible']
+    end
+
+    # Fetch the list of permissions that this application has been granted for
+    # this vehicle
+    # EX : Smartcar::Vehicle.new(token: token, id: id).permissions
+    # @param options [Hash] - Optional filter parameters (check documentation)
+    #
+    # @return [Array] of permissions (Strings)
+    def permissions(options: {})
+      Permissions.new(fetch(
+        path: Permissions::PATH.call(id),
+        options: options
+      )).permissions
+    end
+
+    #  Method Used toRevoke access for the current requesting application
+    # API - https://smartcar.com/docs/api#delete-disconnect
+    #
+    # @return [Boolean] true if success
+    def disconnect!
+      response = delete(PATH.call(id) + "/application")
+      response['status'] == SUCCESS
+    end
+
+    # Methods Used lock or unlock car
+    # API - https://smartcar.com/docs/api#post-security
+    #
+    # @return [Boolean] true if success
+    %w(lock unlock).each do |method_name|
+      define_method "#{method_name}!" do
+        lock_or_unlock!(action: Smartcar.const_get(method_name.upcase))
+      end
+    end
+
+    # Following section defined methods using meta programing to fetch various
+    # details of a vehicle. The key is the method name, and value is Class that
+    # wraps the data.
+    {
+      # Returns the state of charge (SOC) and remaining range of an electric or
+      # plug-in hybrid vehicle's battery.
+      # API - https://smartcar.com/docs/api#get-ev-battery
+      #
+      # @return [Battery] object
+      battery: Battery,
+      # Returns the current charge status of the vehicle.
+      # API - https://smartcar.com/docs/api#get-ev-battery
+      #
+      # @return [Charge] object
+      charge: Charge,
+      # Returns the remaining life span of a vehicle's engine oil
+      # API - https://smartcar.com/docs/api#get-engine-oil-life
+      #
+      # @return [EngineOil] object
+      engine_oil: EngineOil,
+      # Returns the status of the fuel remaining in the vehicle's gas tank.
+      # API - https://smartcar.com/docs/api#get-fuel-tank
+      #
+      # @return [Fuel] object
+      fuel: Fuel,
+      # Returns the last known location of the vehicle in geographic coordinates.
+      # API - https://smartcar.com/docs/api#get-location
+      #
+      # @return [Location] object
+      location: Location,
+      # Returns the vehicle's last known odometer reading.
+      # API - https://smartcar.com/docs/api#get-odometer
+      #
+      # @return [Odometer] object
+      odometer: Odometer,
+      # Returns the air pressure of each of the vehicle's tires.
+      # API - https://smartcar.com/docs/api#get-tire-pressure
+      #
+      # @return [TirePressure] object
+      tire_pressure: TirePressure,
+    }.each do |method_name, klass|
+      define_method method_name do
+        klass.new(
+          fetch(
+            path: klass::PATH.call(id)
+          )
+        )
+      end
+    end
+
+    #NOTE : The following two also could be defined by metaprogramming,
+    # But these are items that dont change and hence can be cached in the
+    # vehicle object.
+
+    # Returns the vehicle's manufacturer identifier.
+    # API - https://smartcar.com/docs/api#get-vin
+    #
+    # @return [Vin] object
+    def vin
+      @vin ||= Vin.new(
+        fetch(
+          path: Vin::PATH.call(id)
+        )
+      ).vin
+    end
+
+    # Returns the vehicle's model make and year.
+    # API - https://smartcar.com/docs/api#get-vehicle-attributes
+    #
+    # @return [VehicleAttributes] object
+    def vehicle_attributes
+      @vehicle_attributes ||= VehicleAttributes.new(
+        fetch(
+          path: PATH.call(id)
+        )
+      )
+    end
+
+    private
+
+    def lock_or_unlock!(action:)
+      response = post(PATH.call(id) + "/security", {action: action}.to_json)
+      response['status'] == SUCCESS
+    end
+
+    class VehicleAttributes
+      include Utils
+      attr_accessor :id, :make, :model, :year
+    end
+  end
+end

data/lib/smartcar/version.rb

@@ -0,0 +1,3 @@
+module Smartcar
+  VERSION = "0.1.1"
+end

data/lib/smartcar/vin.rb

@@ -0,0 +1,11 @@
+module Smartcar
+  # class to represent Engine oil life
+  #
+  # @author [ashwin]
+  #
+  class Vin < Base
+    include Utils
+    PATH = Proc.new{|id| "/vehicles/#{id}/vin"}
+    attr_accessor :vin
+  end
+end

data/lib/smartcar.rb

@@ -0,0 +1,36 @@
+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"
+require "smartcar/user"
+
+
+module Smartcar
+  class ConfigNotFound < StandardError; end
+  class ExternalServiceError < StandardError; end
+  class ServiceUnavailableError < ExternalServiceError; end
+  class AuthenticationError < ExternalServiceError; end
+  class ParserError < ExternalServiceError; end
+  class BadRequestError < ExternalServiceError; end
+  API_VERSION = "v1.0".freeze
+  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|
+    const_set(constant.upcase, constant.freeze)
+  end
+  LOCK = "LOCK".freeze
+  UNLOCK = "UNLOCK".freeze
+  UNITS = [IMPERIAL,METRIC]
+end

data/ruby-sdk.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "smartcar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "smartcar"
+  spec.version       = Smartcar::VERSION
+  spec.authors       = ["Ashwin Subramanian"]
+  spec.email         = ["sshwin.subramanian@smartcar.com"]
+  spec.homepage      = 'https://rubygems.org/gems/smartcar'
+  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.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 11.0"
+  spec.add_dependency "oauth2", "~> 1.4"
+end

metadata

@@ -1,22 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Philip Hayes
+- Ashwin Subramanian
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
-dependencies: []
-description: ''
-email: hello@smartcar.com
+date: 2020-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: This is a ruby gem to access the smartcar APIs. It includes the API classes
+  and the OAuth system.
+email:
+- sshwin.subramanian@smartcar.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://smartcar.com
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smartcar.rb
+- lib/smartcar/base.rb
+- lib/smartcar/battery.rb
+- lib/smartcar/charge.rb
+- lib/smartcar/engine_oil.rb
+- lib/smartcar/fuel.rb
+- lib/smartcar/location.rb
+- lib/smartcar/oauth.rb
+- lib/smartcar/odometer.rb
+- lib/smartcar/permissions.rb
+- lib/smartcar/tire_pressure.rb
+- lib/smartcar/user.rb
+- lib/smartcar/utils.rb
+- lib/smartcar/vehicle.rb
+- lib/smartcar/version.rb
+- lib/smartcar/vin.rb
+- ruby-sdk.gemspec
+homepage: https://rubygems.org/gems/smartcar
 licenses:
 - MIT
 metadata: {}
@@ -35,9 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Smartcar ruby client library.
+summary: Ruby Gem to access smartcar APIs (https://smartcar.com/docs/)
 test_files: []