tesla_api 1.3.0 → 1.4.0

data/spec/cassettes/vehicle-navigation_request.yml

@@ -0,0 +1,100 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://owner-api.teslamotors.com/api/1/vehicles
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - github.com/timdorr/tesla-api v:1.3.0
+      Authorization:
+      - Bearer <TESLA_API_TOKEN>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 11 Dec 2018 03:52:42 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '659'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Txid:
+      - 133482a0eb21b88a3bbb970d365529f5
+      Etag:
+      - W/"0d85a34aa9e150f718d20dc8c7a68fb1"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - cec88ce0-2eee-40c6-9f7b-4ae66fa0770b
+      X-Runtime:
+      - '0.018938'
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"id":19298251174317440,"vehicle_id":1817902171,"vin":"5YJSA1E41GF167745","display_name":"Nikola
+        2.0","option_codes":"MDLS,RENA,AF02,APF1,APH2,APPB,AU01,BC0R,BP00,BR00,BS00,CDM0,CH05,PBCW,CW00,DCF0,DRLH,DSH7,DV4W,FG02,FR04,HP00,IDBA,IX01,LP01,ME02,MI01,PF01,PI01,PK00,PS01,PX00,PX4D,QTVB,RFP2,SC01,SP00,SR01,SU01,TM00,TP03,TR00,UTAB,WTAS,X001,X003,X007,X011,X013,X021,X024,X027,X028,X031,X037,X040,X044,YFFC,COUS","color":null,"tokens":["08f5098517a10231","8d219a2e09242e02"],"state":"online","in_service":false,"id_s":"19298251174317440","calendar_enabled":true,"api_version":4,"backseat_token":null,"backseat_token_updated_at":null}],"count":1}'
+    http_version: 
+  recorded_at: Tue, 11 Dec 2018 03:52:42 GMT
+- request:
+    method: post
+    uri: https://owner-api.teslamotors.com/api/1/vehicles/19298251174317440/command/navigation_request
+    body:
+      encoding: UTF-8
+      string: type=share_ext_content_raw&locale=en-US&timestamp_ms=1544500362&value[android.intent.extra.TEXT]=1180%20W%20Peachtree%20St%2C%20Atlanta%2C%20GA%2030309
+    headers:
+      User-Agent:
+      - github.com/timdorr/tesla-api v:1.3.0
+      Authorization:
+      - Bearer <TESLA_API_TOKEN>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 11 Dec 2018 03:52:43 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '43'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Txid:
+      - 0f96fb719f1b87111da5f4809ca3e19a
+      Etag:
+      - W/"6c93a9ca22c89240ebbffee93abe0348"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 1b4238b5-00f7-4187-8f85-e45da6124c05
+      X-Runtime:
+      - '0.459076'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"result":true,"queued":false}}'
+    http_version: 
+  recorded_at: Tue, 11 Dec 2018 03:52:43 GMT
+recorded_with: VCR 4.0.0

data/spec/cassettes/vehicle-nearby_charging_sites.yml

@@ -0,0 +1,95 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://owner-api.teslamotors.com/api/1/vehicles
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - github.com/timdorr/tesla-api v:1.3.0
+      Authorization:
+      - Bearer <TESLA_API_TOKEN>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 11 Dec 2018 04:01:43 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '659'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Txid:
+      - c21a79d3bc8fbefa118a466bd7841dbb
+      Etag:
+      - W/"0b0233c8e9ab2c7fcdba390a757e034a"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - d7a6f72b-9737-4697-8240-5fb746579067
+      X-Runtime:
+      - '0.018695'
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"id":19298251174317440,"vehicle_id":1817902171,"vin":"5YJSA1E41GF167745","display_name":"Nikola
+        2.0","option_codes":"MDLS,RENA,AF02,APF1,APH2,APPB,AU01,BC0R,BP00,BR00,BS00,CDM0,CH05,PBCW,CW00,DCF0,DRLH,DSH7,DV4W,FG02,FR04,HP00,IDBA,IX01,LP01,ME02,MI01,PF01,PI01,PK00,PS01,PX00,PX4D,QTVB,RFP2,SC01,SP00,SR01,SU01,TM00,TP03,TR00,UTAB,WTAS,X001,X003,X007,X011,X013,X021,X024,X027,X028,X031,X037,X040,X044,YFFC,COUS","color":null,"tokens":["921c1c9a2f2b479a","08f5098517a10231"],"state":"online","in_service":false,"id_s":"19298251174317440","calendar_enabled":true,"api_version":4,"backseat_token":null,"backseat_token_updated_at":null}],"count":1}'
+    http_version: 
+  recorded_at: Tue, 11 Dec 2018 04:01:43 GMT
+- request:
+    method: get
+    uri: https://owner-api.teslamotors.com/api/1/vehicles/19298251174317440/nearby_charging_sites
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - github.com/timdorr/tesla-api v:1.3.0
+      Authorization:
+      - Bearer <TESLA_API_TOKEN>
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 11 Dec 2018 04:01:44 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '67'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - e01a24c4-d7b3-445e-a628-3f37c8bc1cfb
+      X-Runtime:
+      - '0.185555'
+    body:
+      encoding: UTF-8
+      string: '{"response":null,"error":"invalid_endpoint","error_description":""}'
+    http_version: 
+  recorded_at: Tue, 11 Dec 2018 04:01:44 GMT
+recorded_with: VCR 4.0.0

data/spec/cassettes/vehicle-schedule_software_update.yml

@@ -0,0 +1,100 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://owner-api.teslamotors.com/api/1/vehicles
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - github.com/timdorr/tesla-api v:1.3.0
+      Authorization:
+      - Bearer <TESLA_API_TOKEN>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 11 Dec 2018 03:59:52 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '659'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Txid:
+      - 7ba6b0ffa0a12110ff272668fe5654cd
+      Etag:
+      - W/"0d85a34aa9e150f718d20dc8c7a68fb1"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 5d47f7df-9017-4222-8c17-af1670dcdb47
+      X-Runtime:
+      - '0.020096'
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"id":19298251174317440,"vehicle_id":1817902171,"vin":"5YJSA1E41GF167745","display_name":"Nikola
+        2.0","option_codes":"MDLS,RENA,AF02,APF1,APH2,APPB,AU01,BC0R,BP00,BR00,BS00,CDM0,CH05,PBCW,CW00,DCF0,DRLH,DSH7,DV4W,FG02,FR04,HP00,IDBA,IX01,LP01,ME02,MI01,PF01,PI01,PK00,PS01,PX00,PX4D,QTVB,RFP2,SC01,SP00,SR01,SU01,TM00,TP03,TR00,UTAB,WTAS,X001,X003,X007,X011,X013,X021,X024,X027,X028,X031,X037,X040,X044,YFFC,COUS","color":null,"tokens":["08f5098517a10231","8d219a2e09242e02"],"state":"online","in_service":false,"id_s":"19298251174317440","calendar_enabled":true,"api_version":4,"backseat_token":null,"backseat_token_updated_at":null}],"count":1}'
+    http_version: 
+  recorded_at: Tue, 11 Dec 2018 03:59:52 GMT
+- request:
+    method: post
+    uri: https://owner-api.teslamotors.com/api/1/vehicles/19298251174317440/command/schedule_software_update
+    body:
+      encoding: UTF-8
+      string: offset_sec=7200
+    headers:
+      User-Agent:
+      - github.com/timdorr/tesla-api v:1.3.0
+      Authorization:
+      - Bearer <TESLA_API_TOKEN>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 11 Dec 2018 03:59:53 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '159'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Txid:
+      - 619c829cb360874596a6326d3e950279
+      Etag:
+      - W/"842860ac949644ddb069883f17553de5"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - d61d0bfc-9895-477f-9759-6ea5a31fc51a
+      X-Runtime:
+      - '0.701839'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"expected_duration_sec":6000,"reason":"","result":true,"scheduled_time_ms":1544500793459,"status":"scheduled","warning_time_remaining_ms":120000}}'
+    http_version: 
+  recorded_at: Tue, 11 Dec 2018 03:59:53 GMT
+recorded_with: VCR 4.0.0

data/spec/lib/tesla_api/vehicle_spec.rb

@@ -25,12 +25,29 @@ RSpec.describe TeslaApi::Vehicle do
     end
   end
 
+  describe '#data', vcr: {cassette_name: 'vehicle-data'} do
+    context 'data about the vehicle\'s overall state' do
+      subject { vehicle.data }
+
+      it { should include('display_name') }
+      it { should include('drive_state') }
+      it { should include('vehicle_state') }
+      it { should include('charge_state') }
+    end
+  end
+
   describe '#mobile_enabled', vcr: {cassette_name: 'vehicle-mobile_enabled'} do
     it 'indicates if mobile app access is enabled' do
       expect(vehicle.mobile_enabled).to eq(true)
     end
   end
 
+  describe '#nearby_charging_sites', vcr: {cassette_name: 'vehicle-nearby_charging_sites'} do
+    pending 'returns a list of nearby charging sites' do
+      expect(vehicle.nearby_charging_sites).to eq([])
+    end
+  end
+
   describe '#gui_settings', vcr: {cassette_name: 'vehicle-gui_settings'} do
     context 'details for a GUI built on the API' do
       subject { vehicle.gui_settings }
@@ -161,6 +178,18 @@ RSpec.describe TeslaApi::Vehicle do
     end
   end
 
+  describe '#charge_port_door_open', vcr: {cassette_name: 'vehicle-charge_port_door_open'} do
+    it 'opens the charge port door' do
+      expect(vehicle.charge_port_door_open['result']).to eq(true)
+    end
+  end
+
+  describe '#charge_port_door_close', vcr: {cassette_name: 'vehicle-charge_port_door_close'} do
+    it 'closes the charge port door' do
+      expect(vehicle.charge_port_door_close['result']).to eq(true)
+    end
+  end
+
   describe '#charge_start', vcr: {cassette_name: 'vehicle-charge_start'} do
     it 'starts charging' do
       expect(vehicle.charge_start['result']).to eq(true)
@@ -220,10 +249,6 @@ RSpec.describe TeslaApi::Vehicle do
   end
 
   describe '#sun_roof_control' do
-    it 'opens the sun roof', vcr: {cassette_name: 'vehicle-sun_roof_control-open'} do
-      expect(vehicle.sun_roof_control('open')['result']).to eq(true)
-    end
-
     it 'closes the sun roof', vcr: {cassette_name: 'vehicle-sun_roof_control-close'} do
       expect(vehicle.sun_roof_control('close')['result']).to eq(true)
     end
@@ -231,24 +256,6 @@ RSpec.describe TeslaApi::Vehicle do
     it 'vents the sun roof', vcr: {cassette_name: 'vehicle-sun_roof_control-vent'} do
       expect(vehicle.sun_roof_control('vent')['result']).to eq(true)
     end
-
-    it 'sets the sun roof to the comfort (80%) setting', vcr: {cassette_name: 'vehicle-sun_roof_control-comfort'} do
-      expect(vehicle.sun_roof_control('comfort')['result']).to eq(true)
-    end
-  end
-
-  describe '#sun_roof_move' do
-    it 'moves the sun roof to 100% open', vcr: {cassette_name: 'vehicle-sun_roof_move-100'} do
-      expect(vehicle.sun_roof_move(100)['result']).to eq(true)
-    end
-
-    it 'moves the sun roof to closed', vcr: {cassette_name: 'vehicle-sun_roof_move-0'} do
-      expect(vehicle.sun_roof_move(0)['result']).to eq(true)
-    end
-
-    it 'moves the sun roof to 50% open', vcr: {cassette_name: 'vehicle-sun_roof_move-50'} do
-      expect(vehicle.sun_roof_move(50)['result']).to eq(true)
-    end
   end
 
   describe '#remote_start_drive', vcr: {cassette_name: 'vehicle-remote_start_drive'} do
@@ -292,4 +299,22 @@ RSpec.describe TeslaApi::Vehicle do
       expect(vehicle.clear_speed_limit_pin('1234')['result']).to eq(true)
     end
   end
+
+  describe '#navigation_request', vcr: {cassette_name: 'vehicle-navigation_request'} do
+    it 'makes a request to navigate to a new address' do
+      expect(vehicle.navigation_request('1180 W Peachtree St, Atlanta, GA 30309')['result']).to eq(true)
+    end
+  end
+
+  describe '#schedule_software_update', vcr: {cassette_name: 'vehicle-schedule_software_update'} do
+    it 'cancels a pending software update' do
+      expect(vehicle.schedule_software_update(7200)['result']).to eq(true)
+    end
+  end
+
+  describe '#cancel_software_update', vcr: {cassette_name: 'vehicle-cancel_software_update'} do
+    it 'cancels a pending software update' do
+      expect(vehicle.cancel_software_update['result']).to eq(true)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tesla_api
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Tim Dorr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -171,6 +171,8 @@ files:
 - docs/SUMMARY.md
 - docs/api-basics/authentication.md
 - docs/api-basics/vehicles.md
+- docs/miscellaneous/README.md
+- docs/miscellaneous/endpoints.md
 - docs/vehicle/autopark.md
 - docs/vehicle/commands/README.md
 - docs/vehicle/commands/alerts.md
@@ -195,6 +197,7 @@ files:
 - docs/vehicle/state/drivestate.md
 - docs/vehicle/state/guisettings.md
 - docs/vehicle/state/mobileenabled.md
+- docs/vehicle/state/nearbychargingsites.md
 - docs/vehicle/state/vehiclestate.md
 - docs/vehicle/streaming.md
 - lib/tesla_api.rb
@@ -208,8 +211,10 @@ files:
 - spec/cassettes/vehicle-activate_speed_limit.yml
 - spec/cassettes/vehicle-auto_conditioning_start.yml
 - spec/cassettes/vehicle-auto_conditioning_stop.yml
+- spec/cassettes/vehicle-cancel_software_update.yml
 - spec/cassettes/vehicle-charge_max_range-twice.yml
 - spec/cassettes/vehicle-charge_max_range.yml
+- spec/cassettes/vehicle-charge_port_door_close.yml
 - spec/cassettes/vehicle-charge_port_door_open.yml
 - spec/cassettes/vehicle-charge_standard-twice.yml
 - spec/cassettes/vehicle-charge_standard.yml
@@ -218,6 +223,7 @@ files:
 - spec/cassettes/vehicle-charge_stop.yml
 - spec/cassettes/vehicle-clear_speed_limit_pin.yml
 - spec/cassettes/vehicle-climate_state.yml
+- spec/cassettes/vehicle-data.yml
 - spec/cassettes/vehicle-deactivate_speed_limit.yml
 - spec/cassettes/vehicle-door_lock.yml
 - spec/cassettes/vehicle-door_unlock.yml
@@ -226,10 +232,13 @@ files:
 - spec/cassettes/vehicle-gui_settings.yml
 - spec/cassettes/vehicle-honk_horn.yml
 - spec/cassettes/vehicle-mobile_enabled.yml
+- spec/cassettes/vehicle-navigation_request.yml
+- spec/cassettes/vehicle-nearby_charging_sites.yml
 - spec/cassettes/vehicle-open_frunk.yml
 - spec/cassettes/vehicle-open_trunk.yml
 - spec/cassettes/vehicle-remote_start_drive.yml
 - spec/cassettes/vehicle-reset_valet_pin.yml
+- spec/cassettes/vehicle-schedule_software_update.yml
 - spec/cassettes/vehicle-set_charge_limit-1.yml
 - spec/cassettes/vehicle-set_charge_limit-100.yml
 - spec/cassettes/vehicle-set_charge_limit-50.yml
@@ -239,12 +248,7 @@ files:
 - spec/cassettes/vehicle-set_temps-75-65.yml
 - spec/cassettes/vehicle-set_valet_mode.yml
 - spec/cassettes/vehicle-sun_roof_control-close.yml
-- spec/cassettes/vehicle-sun_roof_control-comfort.yml
-- spec/cassettes/vehicle-sun_roof_control-open.yml
 - spec/cassettes/vehicle-sun_roof_control-vent.yml
-- spec/cassettes/vehicle-sun_roof_move-0.yml
-- spec/cassettes/vehicle-sun_roof_move-100.yml
-- spec/cassettes/vehicle-sun_roof_move-50.yml
 - spec/cassettes/vehicle-vehicle_state.yml
 - spec/cassettes/vehicle-wake_up.yml
 - spec/cassettes/vehicle.yml
@@ -272,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A wrapper for the Tesla JSON API
@@ -282,8 +286,10 @@ test_files:
 - spec/cassettes/vehicle-activate_speed_limit.yml
 - spec/cassettes/vehicle-auto_conditioning_start.yml
 - spec/cassettes/vehicle-auto_conditioning_stop.yml
+- spec/cassettes/vehicle-cancel_software_update.yml
 - spec/cassettes/vehicle-charge_max_range-twice.yml
 - spec/cassettes/vehicle-charge_max_range.yml
+- spec/cassettes/vehicle-charge_port_door_close.yml
 - spec/cassettes/vehicle-charge_port_door_open.yml
 - spec/cassettes/vehicle-charge_standard-twice.yml
 - spec/cassettes/vehicle-charge_standard.yml
@@ -292,6 +298,7 @@ test_files:
 - spec/cassettes/vehicle-charge_stop.yml
 - spec/cassettes/vehicle-clear_speed_limit_pin.yml
 - spec/cassettes/vehicle-climate_state.yml
+- spec/cassettes/vehicle-data.yml
 - spec/cassettes/vehicle-deactivate_speed_limit.yml
 - spec/cassettes/vehicle-door_lock.yml
 - spec/cassettes/vehicle-door_unlock.yml
@@ -300,10 +307,13 @@ test_files:
 - spec/cassettes/vehicle-gui_settings.yml
 - spec/cassettes/vehicle-honk_horn.yml
 - spec/cassettes/vehicle-mobile_enabled.yml
+- spec/cassettes/vehicle-navigation_request.yml
+- spec/cassettes/vehicle-nearby_charging_sites.yml
 - spec/cassettes/vehicle-open_frunk.yml
 - spec/cassettes/vehicle-open_trunk.yml
 - spec/cassettes/vehicle-remote_start_drive.yml
 - spec/cassettes/vehicle-reset_valet_pin.yml
+- spec/cassettes/vehicle-schedule_software_update.yml
 - spec/cassettes/vehicle-set_charge_limit-1.yml
 - spec/cassettes/vehicle-set_charge_limit-100.yml
 - spec/cassettes/vehicle-set_charge_limit-50.yml
@@ -313,12 +323,7 @@ test_files:
 - spec/cassettes/vehicle-set_temps-75-65.yml
 - spec/cassettes/vehicle-set_valet_mode.yml
 - spec/cassettes/vehicle-sun_roof_control-close.yml
-- spec/cassettes/vehicle-sun_roof_control-comfort.yml
-- spec/cassettes/vehicle-sun_roof_control-open.yml
 - spec/cassettes/vehicle-sun_roof_control-vent.yml
-- spec/cassettes/vehicle-sun_roof_move-0.yml
-- spec/cassettes/vehicle-sun_roof_move-100.yml
-- spec/cassettes/vehicle-sun_roof_move-50.yml
 - spec/cassettes/vehicle-vehicle_state.yml
 - spec/cassettes/vehicle-wake_up.yml
 - spec/cassettes/vehicle.yml