bmw-connected-drive 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b4448fb7c3ae0cfead75b9dca4784e36214cf4a
-  data.tar.gz: 73c99e9ad01c61030aa2c9cfdbb82693bf493577
+  metadata.gz: 108d392bbfabfc1318188486e87968673eecb31f
+  data.tar.gz: 37d94eb28b2da942f2e154d28f9ec20a3aca4c2e
 SHA512:
-  metadata.gz: 26bfba31514d8a140c05673f2316e9ef523c3dda9f10a9846a2afecb7acc1b9f57c3bdae9b1fcc39d77408d30776ac4e51145c13bbbda6969f193f8c55458a91
-  data.tar.gz: f1d83a4a247f5e64c07c6f465846670336beb478789120308f416bbef53ae13eb0f4765f23659dcc0b3fb734544c259f6ae00be08033b61b5f2bc833330c7d41
+  metadata.gz: 9b531ca477e72edcc1a9340bc546095862c18b1c04d76bbea7a1ac6581b9ac1aafb006c73785cae79cd64ae291703e39435e4525e3ca109bb2dcc78838ab8920
+  data.tar.gz: 9108d46243e5a6ed7eda16b3c4a19868ce31b032d8c47e5259d70394dd030e98aceb3df05e2bd2ff682e41a6db488b672c67b4f01fd75935a7ddfdf24326a7f1

data/README.md

@@ -1,6 +1,12 @@
-## BMW Connected Drive
+# BMW Connected Drive
 
-BMW Connected Drive JSON API
+BMW Connected Drive JSON API wrapper written in ruby
+
+## Description
+
+I needed a simple wrapper for the BMW Connected Drive JSON API - credits to [Terence Eden](https://github.com/edent) and [Quentin Stafford-Fraser](https://github.com/quentinsf) for their original work documenting the API of the i3 electric car [BMW-i-Remote](https://github.com/edent/BMW-i-Remote)
+
+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.
 
 ## Installation
 
@@ -22,9 +28,9 @@ Or install it yourself:
 require 'bmw-connected-drive'
 
 client = BMWConnectedDrive::Client.new({
-  :auth_basic => "auth_basic",
-  :username => "username",
-  :password => "password",
+  :auth_basic => auth_basic,
+  :username => username,
+  :password => password,
 })
 
 client.login
@@ -36,4 +42,12 @@ vehicle.all_trips
 vehicle.destinations
 vehicle.charging_profile
 vehicle.range_map
+vehicle.execute_service("DOOR_LOCK")
 ```
+
+## Contributing
+
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Submit a pull request

data/lib/bmw-connected-drive.rb

@@ -3,5 +3,5 @@ require 'bmw-connected-drive/client'
 require 'bmw-connected-drive/vehicle'
 
 module BMWConnectedDrive
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/bmw-connected-drive/client.rb

@@ -11,37 +11,18 @@ module BMWConnectedDrive
       @username = params[:username]
       @password = params[:password]
       @auth_basic = params[:auth_basic]
-      puts @username
-      puts @password
-      puts @auth_basic
     end
 
     def access_token=(access_token)
       @access_token = access_token
       self.class.headers "User-Agent" => USER_AGENT
       self.class.headers "Authorization" => "Bearer #{access_token}"
-      #self.class.headers "User-Agent" => USER_AGENT
-      #self.class.headers "Authorization" => "Bearer Zig2rc5cw98vwBNJhLZ3AZ4Fx6L9Qecp"
     end
 
     def expires_in=(seconds)
       @expires_in = seconds.to_f
     end
 
-    def created_at=(timestamp)
-      @created_at = Time.at(timestamp.to_f).to_datetime
-    end
-
-    def expired_at
-      return nil unless defined?(@created_at)
-      (@created_at.to_time + @expires_in.to_f).to_datetime
-    end
-
-    def expired?
-      return true unless defined?(@created_at)
-      expired_at <= DateTime.now
-    end
-
     def login
       response = self.class.post(
         "/oauth/token",
@@ -57,23 +38,15 @@ module BMWConnectedDrive
           "User-Agent" => USER_AGENT
         }
       )
-
-      puts response
-
       self.expires_in   = response["expires_in"]
-      #self.created_at   = response["created_at"]
       self.access_token = response["access_token"]
     end
 
     def call(path)
-      self.class.headers "User-Agent" => USER_AGENT
-      self.class.headers "Authorization" => "Bearer Zig2rc5cw98vwBNJhLZ3AZ4Fx6L9Qecp"
       self.class.get(path)
     end
 
     def vehicles
-      #self.class.headers "User-Agent" => USER_AGENT
-      #self.class.headers "Authorization" => "Bearer Zig2rc5cw98vwBNJhLZ3AZ4Fx6L9Qecp"
       self.class.get("/v1/user/vehicles/")["vehicles"].map { |vehicle| Vehicle.new(self.class, vehicle) }
     end
   end

data/lib/bmw-connected-drive/vehicle.rb

@@ -1,5 +1,29 @@
 module BMWConnectedDrive
   class Vehicle
+    SERVICES = [
+      "DOOR_LOCK",
+      "DOOR_UNLOCK",
+      "CHARGE_NOW",
+      "CHARGING_CONTROL",
+      "CLIMATE_CONTROL",
+      "CLIMATE_NOW",
+      "DOOR_LOCK",
+      "DOOR_UNLOCK",
+      "GET_ALL_IMAGES",
+      "GET_PASSWORD_RESET_INFO",
+      "GET_VEHICLES",
+      "GET_VEHICLE_IMAGE",
+      "GET_VEHICLE_STATUS",
+      "HORN_BLOW",
+      "LIGHT_FLASH",
+      "LOCAL_SEARCH",
+      "LOCAL_SEARCH_SUGGESTIONS",
+      "LOGIN",
+      "LOGOUT",
+      "SEND_POI_TO_CAR",
+      "VEHICLE_FINDER"
+    ]
+
     attr_reader :api, :vehicle
 
     def initialize(api, vehicle)
@@ -31,5 +55,26 @@ module BMWConnectedDrive
       api.get("/v1/user/vehicles/#{vehicle['vin']}/rangemap")["rangemap"]
     end
 
+    def execute_service(service_type, secret_knowledge=nil)
+      responses = []
+      if SERVICES.include? service_type
+        response = api.post(
+          "/v1/user/vehicles/#{vehicle['vin']}/executeService",
+          body: {
+            "serviceType" => service_type,
+            "secretKnowledge" => secret_knowledge
+          }
+        )
+        status = response["executionStatus"]["status"]
+        responses << response["executionStatus"]
+        while ["INITIATED","PENDING"].include? status do
+          response = api.get("/v1/user/vehicles/#{vehicle['vin']}/serviceExecutionStatus?serviceType=#{service_type}")
+          status = response["executionStatus"]["status"]
+          responses << response["executionStatus"]
+        end
+      end
+      responses
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bmw-connected-drive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ed Richards