RubyGems - tesla_api - Versions diffs - 3.0.7 → 3.1.0 - Mend

tesla_api 3.0.7 → 3.1.0

Files changed (13) hide show

checksums.yaml +4 -4
data/.github/workflows/test.yml +36 -0
data/docs/api-basics/authentication.md +163 -36
data/docs/vehicle/optioncodes.md +82 -42
data/docs/vehicle/state/data.md +42 -37
data/lib/tesla_api/client.rb +76 -11
data/lib/tesla_api/version.rb +1 -1
data/spec/cassettes/client-login.yml +254 -46
data/spec/cassettes/client-refresh.yml +109 -49
data/spec/lib/tesla_api/client_spec.rb +20 -38
metadata +6 -8
data/.travis.yml +0 -16
data/spec/cassettes/client-login_timeout.yml +0 -83

data/spec/cassettes/client-refresh.yml CHANGED

@@ -1,51 +1,111 @@
 ---
 http_interactions:
-- request:
-    method: post
-    uri: https://owner-api.teslamotors.com/oauth/token
-    body:
-      encoding: UTF-8
-      string: grant_type=refresh_token&client_id=<TESLA_CLIENT_ID>&client_secret=<TESLA_CLIENT_SECRET>&refresh_token=<TESLA_REFRESH_TOKEN>
-    headers:
-      User-Agent:
-      - github.com/timdorr/tesla-api v:1.5.0
-      Authorization:
-      - Bearer <TESLA_ACCESS_TOKEN>
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Mon, 23 Sep 2019 17:25:05 GMT
-      Content-Type:
-      - application/json; charset=utf-8
-      Transfer-Encoding:
-      - chunked
-      Connection:
-      - keep-alive
-      X-Frame-Options:
-      - SAMEORIGIN
-      - SAMEORIGIN
-      X-Xss-Protection:
-      - 1; mode=block
-      X-Content-Type-Options:
-      - nosniff
-      Cache-Control:
-      - no-store
-      Pragma:
-      - no-cache
-      Etag:
-      - W/"25e04c26d708b6763d3dca87bcaeb2a7"
-      X-Request-Id:
-      - d153d7b0-ce0b-4c24-a109-e60488df7f48
-      X-Runtime:
-      - '0.020946'
-    body:
-      encoding: UTF-8
-      string: '{"access_token":"bb91d9892b8af05ad389f2d05b9689657a076f61c4d97ff398f23d86112fb5ca","token_type":"bearer","expires_in":3888000,"refresh_token":"21879d76c4e00309b3d69c6ecb128b89e0c7e210838404601d9f433e9a069022","created_at":1569259505}'
-    http_version:
-  recorded_at: Mon, 23 Sep 2019 17:25:05 GMT
-recorded_with: VCR 4.0.0
+  - request:
+      method: post
+      uri: https://auth.tesla.com/oauth2/v3/token
+      body:
+        encoding: UTF-8
+        string: '{"grant_type":"refresh_token","scope":"openid email offline_access","client_id":"ownerapi","client_secret":"<TESLA_CLIENT_SECRET>","refresh_token":"<TESLA_REFRESH_TOKEN>"}'
+      headers:
+        User-Agent:
+          - github.com/timdorr/tesla-api v:3.0.7
+        Content-Type:
+          - application/json
+        Accept-Encoding:
+          - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+        Accept:
+          - '*/*'
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        Server:
+          - nginx
+        Content-Type:
+          - application/json
+        X-Dns-Prefetch-Control:
+          - 'off'
+        X-Frame-Options:
+          - DENY
+        Strict-Transport-Security:
+          - max-age=15552000; includeSubDomains
+        X-Download-Options:
+          - noopen
+        X-Content-Type-Options:
+          - nosniff
+        X-Xss-Protection:
+          - 1; mode=block
+        X-Request-Id:
+          - c6575e47-91d3-4a07-9985-358de3dbe39e
+        X-Correlation-Id:
+          - c6575e47-91d3-4a07-9985-358de3dbe39e
+        Cache-Control:
+          - no-store
+        Pragma:
+          - no-cache
+        X-Response-Time:
+          - 24.639ms
+        Date:
+          - Sat, 30 Jan 2021 15:18:43 GMT
+        Content-Length:
+          - '2517'
+        Connection:
+          - keep-alive
+      body:
+        encoding: UTF-8
+        string: '{"access_token":"acess","refresh_token":"<TESLA_REFRESH_TOKEN>","id_token":"id","expires_in":300,"token_type":"Bearer"}'
+    recorded_at: Sat, 30 Jan 2021 15:18:43 GMT
+  - request:
+      method: post
+      uri: https://owner-api.teslamotors.com/oauth/token
+      body:
+        encoding: UTF-8
+        string: '{"grant_type":"urn:ietf:params:oauth:grant-type:jwt-bearer","client_id":"<TESLA_CLIENT_ID>","client_secret":"<TESLA_CLIENT_SECRET>"}'
+      headers:
+        User-Agent:
+          - github.com/timdorr/tesla-api v:3.0.7
+        Authorization:
+          - Bearer bear
+        Content-Type:
+          - application/json
+        Accept-Encoding:
+          - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+        Accept:
+          - '*/*'
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        Date:
+          - Sat, 30 Jan 2021 15:18:44 GMT
+        Content-Type:
+          - application/json; charset=utf-8
+        Transfer-Encoding:
+          - chunked
+        Connection:
+          - keep-alive
+        Vary:
+          - Accept-Encoding
+        X-Frame-Options:
+          - SAMEORIGIN
+        X-Xss-Protection:
+          - 1; mode=block
+        X-Content-Type-Options:
+          - nosniff
+        Etag:
+          - W/"85c5baa66d3db433982e5744ccc1e96e"
+        Cache-Control:
+          - max-age=0, private, must-revalidate
+        X-Request-Id:
+          - 2f0ad7f617da468d211594930c0e88d52f0ad7f617da468d211594930c0e88d5
+        X-Runtime:
+          - '0.301686'
+        Strict-Transport-Security:
+          - max-age=15724800; includeSubDomains
+      body:
+        encoding: ASCII-8BIT
+        string: '{"access_token":"qts-deadbeef","token_type":"bearer","expires_in":3888000,"refresh_token":"yes","created_at":1612019924}'
+    recorded_at: Sat, 30 Jan 2021 15:18:44 GMT
+recorded_with: VCR 6.0.0

data/spec/lib/tesla_api/client_spec.rb CHANGED

@@ -3,6 +3,8 @@ require 'spec_helper'
 RSpec.describe TeslaApi::Client do
   subject(:tesla_api) { TeslaApi::Client.new(email: ENV['TESLA_EMAIL']) }
+  it { is_expected.to be_a(TeslaApi::Client) }
   context 'password grant auth' do
     describe '#new' do
       it 'has no expiry date' do
@@ -14,9 +16,13 @@ RSpec.describe TeslaApi::Client do
       end
     end
-    describe '#login!', vcr: { cassette_name: 'client-login' } do
-      it { is_expected.to be_a(TeslaApi::Client) }
+    describe '#login!', vcr: {
+      cassette_name: 'client-login',
+      match_requests_on: [
+        :method,
+        VCR.request_matchers.uri_without_params(:code_challenge, :state)
+      ]
+    } do
       it 'logs into the API' do
         tesla_api.login!(ENV['TESLA_PASS'])
         expect(a_request(:post, "https://#{URI.parse(TeslaApi::Client::BASE_URI).host}/oauth/token")).to have_been_made.once
@@ -24,22 +30,22 @@ RSpec.describe TeslaApi::Client do
       it 'obtains a Bearer token' do
         tesla_api.login!(ENV['TESLA_PASS'])
-        expect(tesla_api.access_token).to match(/[a-z0-9]{32}/)
+        expect(tesla_api.access_token).to start_with('qts-')
       end
       it 'set a expiry date' do
         tesla_api.login!(ENV['TESLA_PASS'])
-        expect(tesla_api.access_token_expires_at).to eq(Time.at(1475777133 + 7776000).to_datetime)
+        expect(tesla_api.access_token_expires_at).to eq(Time.at(1612019326 + 3888000).to_datetime)
       end
       it 'obtains a refresh token' do
         tesla_api.login!(ENV['TESLA_PASS'])
-        expect(tesla_api.refresh_token).to match(/[a-z0-9]{32}/)
+        expect(tesla_api.refresh_token).to start_with('eyJ')
       end
       it 'expose expiry status' do
         tesla_api.login!(ENV['TESLA_PASS'])
-        expect(tesla_api.expired?).to eq(true)
+        expect(tesla_api.expired?).to eq(false)
       end
     end
   end
@@ -60,7 +66,13 @@ RSpec.describe TeslaApi::Client do
       end
     end
-    describe '#refresh_access_token', vcr: {cassette_name: 'client-refresh'} do
+    describe '#refresh_access_token', vcr: {
+      cassette_name: 'client-refresh',
+      match_requests_on: [
+        :method,
+        VCR.request_matchers.uri_without_params(:code_challenge, :state)
+      ]
+    } do
       it 'refreshes the access token' do
         tesla_api.refresh_access_token
         expect(tesla_api.access_token).not_to eq(access_token)
@@ -73,34 +85,4 @@ RSpec.describe TeslaApi::Client do
       expect(tesla_api.vehicles).to include(TeslaApi::Vehicle)
     end
   end
-  describe 'retry options', vcr: { cassette_name: 'client-login_timeout' } do
-    subject(:tesla_api) { TeslaApi::Client.new(
-      access_token: ENV['TESLA_ACCESS_TOKEN'],
-      retry_options: retry_options
-    ) }
-    let(:retry_options) {{
-      max: 2,
-      methods: [:post],
-      retry_statuses: [408]
-    }}
-    context 'with retry' do
-      it 'obtains a Bearer token after retry' do
-        tesla_api.login!(ENV['TESLA_PASS'])
-        expect(tesla_api.access_token).to be
-      end
-    end
-    context 'without retry' do
-      let(:retry_options) { nil }
-      it 'raises an error' do
-        expect {
-          tesla_api.login!(ENV['TESLA_PASS'])
-        }.to raise_error(Faraday::ClientError)
-      end
-    end
-  end
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tesla_api
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.1.0
 platform: ruby
 authors:
 - Tim Dorr
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -145,10 +145,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitbook.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".tool-versions"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -198,7 +198,6 @@ files:
 - lib/tesla_api/vehicle.rb
 - lib/tesla_api/version.rb
 - spec/cassettes/client-login.yml
-- spec/cassettes/client-login_timeout.yml
 - spec/cassettes/client-refresh.yml
 - spec/cassettes/client-vehicles.yml
 - spec/cassettes/vehicle-activate_speed_limit.yml
@@ -265,7 +264,7 @@ homepage: https://github.com/timdorr/tesla-api
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -281,12 +280,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key:
 specification_version: 4
 summary: A wrapper for the Tesla JSON API
 test_files:
 - spec/cassettes/client-login.yml
-- spec/cassettes/client-login_timeout.yml
 - spec/cassettes/client-refresh.yml
 - spec/cassettes/client-vehicles.yml
 - spec/cassettes/vehicle-activate_speed_limit.yml

data/.travis.yml DELETED

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.7
-env:
-  global:
-    - TESLA_EMAIL=elon.musk@teslamotors.com
-    - TESLA_PASS=oilLOL
-    - TESLA_CLIENT_ID=1
-    - TESLA_CLIENT_SECRET=2
-    - TESLA_ACCESS_TOKEN=3
-    - TESLA_REFRESH_TOKEN=4
-before_install:
-  - gem update --system
-  - gem install bundler
-notifications:
-  email: false

data/spec/cassettes/client-login_timeout.yml DELETED

@@ -1,83 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://owner-api.teslamotors.com/oauth/token
-    body:
-      encoding: UTF-8
-      string: grant_type=password&client_id=<TESLA_CLIENT_ID>&client_secret=<TESLA_CLIENT_SECRET>&email=<TESLA_EMAIL>&password=<TESLA_PASS>
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 408
-      message: Request Timeout
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Mon, 15 Dec 2014 03:09:22 GMT
-      Content-Type:
-      - application/json; charset=utf-8
-      Transfer-Encoding:
-      - chunked
-      Connection:
-      - keep-alive
-      Status:
-      - 408 Request Timeout
-    body:
-      encoding: UTF-8
-      string: '{}'
-    http_version:
-  recorded_at: Mon, 15 Dec 2014 03:09:22 GMT
-- request:
-    method: post
-    uri: https://owner-api.teslamotors.com/oauth/token
-    body:
-      encoding: UTF-8
-      string: grant_type=password&client_id=<TESLA_CLIENT_ID>&client_secret=<TESLA_CLIENT_SECRET>&email=<TESLA_EMAIL>&password=<TESLA_PASS>
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Mon, 15 Dec 2014 03:09:22 GMT
-      Content-Type:
-      - application/json; charset=utf-8
-      Transfer-Encoding:
-      - chunked
-      Connection:
-      - keep-alive
-      Status:
-      - 200 OK
-      Cache-Control:
-      - no-store
-      Pragma:
-      - no-cache
-      X-Ua-Compatible:
-      - IE=Edge,chrome=1
-      X-Request-Id:
-      - 349d563d345a9694c610770b743d3006
-      X-Runtime:
-      - '0.416152'
-    body:
-      encoding: UTF-8
-      string: '{"access_token":"1cba4845a8653d4b731440e9911d84304a179bd16a9ecbc9b649f2d8e0f6947e","token_type":"bearer","expires_in":7776000,"refresh_token":"fea03b395fa4e72ebc399d9cda6163dcf438c248f744ebdd5bfcda571f5f317f","created_at":1475777133}'
-    http_version:
-  recorded_at: Mon, 15 Dec 2014 03:09:22 GMT
-recorded_with: VCR 2.9.3