tesla-api 0.0.1 → 0.0.2

data/lib/tesla-api/charge_state.rb

@@ -3,66 +3,66 @@ module TeslaAPI
   # Defines the current charge state of the vehicle
   class ChargeState < Data
     ##
-    # :method: charging_state
-    # Charging state ("Complete", "Charging")
+    # @method charging_state
+    # @return Charging state ("Complete", "Charging")
 
     ##
-    # :method charging_to_max?
-    # true if currently performing a range charge
+    # @method charging_to_max?
+    # @return [Boolean] true if currently performing a range charge
 
     ##
-    # :method: battery_range_miles
-    # Rated miles for the current charge
+    # @method battery_range_miles
+    # @return [Float] Rated miles for the current charge
 
     ##
-    # :method: estimated_battry_range_miles
-    # Range estimated from current driving
+    # @method estimated_battry_range_miles
+    # @return [Float] Range estimated from current driving
 
     ##
-    # :method: ideal_battery_range_miles
-    # Ideal range for the current charge
+    # @method ideal_battery_range_miles
+    # @return [Float] Ideal range for the current charge
 
     ##
-    # :method: battery_percentage
-    # Percentage of battery charge
+    # @method battery_percentage
+    # @return [Integer] Percentage of battery charge
 
     ##
-    # :method: battery_current_flow
-    # Current flowing into the battery
+    # @method battery_current_flow
+    # @return [Float] Current flowing into the battery
 
     ##
-    # :method: charger_voltage
-    # Current voltage being used to charge battery
+    # @method charger_voltage
+    # @return [Float] Current voltage being used to charge battery
 
     ##
-    # :method: charger_pilot_amperage
-    # Max amperage allowed by the charger
+    # @method charger_pilot_amperage
+    # @return [Integer] Max amperage allowed by the charger
 
     ##
-    # :method: charger_actual_amperage
-    # Current amperage being drawn into battery
+    # @method charger_actual_amperage
+    # @return [Integer] Current amperage being drawn into battery
 
     ##
-    # :method: charger_power
-    # Kilowatt of charger (rounded down)
+    # @method charger_power
+    # @return [Integer] Kilowatt of charger (rounded down)
 
     ##
-    # :method: hours_to_full_charge
-    # Hours remaining until the vehicle is fully charged
+    # @method hours_to_full_charge
+    # @return [Float] Hours remaining until the vehicle is fully charged
 
     ##
-    # :method: charge_rate_miles_per_hour
-    # Miles of range being added per hour
+    # @method charge_rate_miles_per_hour
+    # @return [Float] Miles of range being added per hour
 
     ##
-    # :method: charge_port_open?
-    # true if the charge port is open
+    # @method charge_port_open?
+    # @return [Boolean] charge port open state
 
     ##
-    # :method: supercharging?
-    # true if charging via a Tesla SuperCharger
+    # @method supercharging?
+    # @return [Boolean] charging via a Tesla SuperCharger
 
-    def initialize(data) # :nodoc:
+    def initialize(data)
       ivar_from_data("charging_state",               "charging_state",         data)
       ivar_from_data("charging_to_max",              "charge_to_max_range",    data)
       ivar_from_data("battery_range_miles",          "battery_range",          data)

data/lib/tesla-api/climate_state.rb

@@ -3,42 +3,42 @@ module TeslaAPI
   #
   class ClimateState < Data
     ##
-    # :method: inside_temp_celcius
-    # Temperature (celcius) inside the vehicle
+    # @method inside_temp_celcius
+    # @return [Float] Temperature (celcius) inside the vehicle
 
     ##
-    # :method: outside_temp_celcius
-    # Temperature (celcius) outside the vehicle
+    # @method outside_temp_celcius
+    # @return [Float] Temperature (celcius) outside the vehicle
 
     ##
-    # :method: driver_temp_setting_celcius
-    # Temperature (celcius) the driver has set
+    # @method driver_temp_setting_celcius
+    # @return [Float] Temperature (celcius) the driver has set
 
     ##
-    # :method: passenger_temp_setting_celcius
-    # Temperature (celcius) the passenger has set
+    # @method passenger_temp_setting_celcius
+    # @return [Float] Temperature (celcius) the passenger has set
 
     ##
-    # :method: fan_speed
-    # 0 to 6 (or nil)
+    # @method fan_speed
+    # @return [Integer] 0 to 6 (or nil)
 
     ##
-    # :method: auto_conditioning_on?
-    # true if auto air conditioning is on
+    # @method auto_conditioning_on?
+    # @return [Boolean] if auto air conditioning is on
 
     ##
-    # :method: front_defroster_on?
-    # true if the front defroster is on
+    # @method front_defroster_on?
+    # @return [Boolean] if the front defroster is on
 
     ##
-    # :method: rear_defroster_on?
-    # true if the rear defroster is on
+    # @method rear_defroster_on?
+    # @return [Boolean] if the rear defroster is on
 
     ##
-    # :method: fan_on?
-    # true if the fan is on
+    # @method fan_on?
+    # @return [Boolean] if the fan is on
 
-    def initialize(data) # :nodoc:
+    def initialize(data)
       ivar_from_data("inside_temp_celcius",            "inside_temp",            data)
       ivar_from_data("outside_temp_celcius",           "outside_temp",           data)
       ivar_from_data("driver_temp_setting_celcius",    "driver_temp_setting",    data)

data/lib/tesla-api/data.rb

@@ -2,27 +2,27 @@ module TeslaAPI
   # Base class for all data responses from the HTTP API
   #
   # Defines an instance_variable? method for each instance_variable defined allowing for
-  # methods such as __________?
+  # methods such as #charge_port_open?
   #
   # Also overrides #inspect to elimiante the back reference to the connection object
   class Data
-    def method_missing(method_name, *args, &block) # :nodoc:
+    def method_missing(method_name, *args, &block)
       if has_query_ivar_method?(method_name)
         instance_variable_get(ivar_for_method_name(method_name))
       else
-        super(symbol, *args, &block)
+        super
       end
     end
 
-    def respond_to_missing?(method_name, include_private = false) # :nodoc:
+    def respond_to_missing?(method_name, include_private = false)
       has_query_ivar_method?(method_name) || super
     end
 
-    def inspect # :nodoc:
+    def inspect
       "#<#{self.class.name}:0x#{self.object_id.to_s(16)} #{inspect_ivars}>"
     end
 
-    def ivar_from_data(name, data_key, data) # :nodoc:
+    def ivar_from_data(name, data_key, data)
       instance_variable_set("@#{name}".to_sym, data[data_key])
 
       self.class.send(:attr_reader, name.to_sym)
@@ -30,21 +30,21 @@ module TeslaAPI
 
     protected
 
-    def ivar_for_method_name(method_name) # :nodoc:
+    def ivar_for_method_name(method_name)
       "@#{method_name.to_s.gsub(/\?$/,"")}".to_sym
     end
 
-    def has_query_ivar_method?(method_name) # :nodoc:
+    def has_query_ivar_method?(method_name)
       method = method_name.to_s
 
       method =~ /(.+)\?/ && instance_variables.include?(ivar_for_method_name(method_name))
     end
 
-    def inspect_ivars # :nodoc:
+    def inspect_ivars
       ivars_for_inspect.map { |ivar| "#{ivar}=#{instance_variable_get(ivar)}" }.join(" ")
     end
 
-    def ivars_for_inspect # :nodoc:
+    def ivars_for_inspect
       (instance_variables - [:@tesla])
     end
   end

data/lib/tesla-api/drive_state.rb

@@ -5,26 +5,27 @@ module TeslaAPI
     attr_reader :gps_timestamp
 
     ##
-    # :method: shift_state
+    # @method shift_state
     # Unknown
 
     ##
-    # :method: speed
+    # @method speed
     # Vehicle speed (units?)
 
     ##
-    # :method: latitude
-    # Lattitude of vehicle
+    # @method latitude
+    # @return [Float] Lattitude of vehicle
 
     ##
-    # :method: longitude
-    # Longitude of vehicle
+    # @method longitude
+    # @return [Float] Longitude of vehicle
 
     ##
-    # :method: heading
-    # Compass heading (0 to 360) degrees
+    # @method heading
+    # @return [Integer] Compass heading (0 to 360) degrees
 
-    def initialize(data) # :nodoc:
+    # initialize
+    def initialize(data)
       ivar_from_data("shift_state", "shift_state", data)
       ivar_from_data("speed",       "speed",       data)
       ivar_from_data("latitude",    "latitude",    data)

data/lib/tesla-api/errors.rb

@@ -6,11 +6,11 @@ module TeslaAPI
       # JSON parsing error details
       attr_reader :error
 
-      def initialize(error) # :nodoc:
+      def initialize(error)
         @error = error
       end
 
-      def to_s # :nodoc:
+      def to_s
         error.to_s
       end
     end
@@ -28,11 +28,11 @@ module TeslaAPI
       # Response object from httpclient
       attr_reader :response
 
-      def initialize(response) # :nodoc:
+      def initialize(response)
         @response = response
       end
 
-      def to_s # :nodoc:
+      def to_s
         "Invalid Response: #{response.inspect}"
       end
     end

data/lib/tesla-api/gui_settings.rb

@@ -2,27 +2,27 @@ module TeslaAPI
   # Defines the current user settings for the vehicle's graphical display
   class GUISettings < Data
     ##
-    # :method: gui_distance_units
-    # Units ("mi/hr") for showing range
+    # @method gui_distance_units
+    # @return [String] Units ("mi/hr") for showing range
 
     ##
-    # :method: gui_temperature_units
-    # Units ("F", "C") for showing temperaturs
+    # @method gui_temperature_units
+    # @return [String] Units ("F", "C") for showing temperaturs
 
     ##
-    # :method: gui_charge_rate_units
-    # Units ("kW") for showing charge rage
+    # @method gui_charge_rate_units
+    # @return [String} Units ("kW") for showing charge rage
 
     ##
-    # :method: gui_range_display
-    # Units ("Rated", "Ideal") for showing range
+    # @method gui_range_display
+    # @return [String] Units ("Rated", "Ideal") for showing range
 
     # true if the UI show 24 hour time (e.g. 17:45)
     def gui_24_hour_time?
       @gui_24_hour_time
     end
 
-    def initialize(data) # :nodoc:
+    def initialize(data)
       ivar_from_data("gui_distance_units",    "gui_distance_units",    data)
       ivar_from_data("gui_temperature_units", "gui_temperature_units", data)
       ivar_from_data("gui_charge_rate_units", "gui_charge_rate_units", data)

data/lib/tesla-api/private_api.rb

@@ -1,5 +1,5 @@
 module TeslaAPI
-  module PrivateAPI # :nodoc:
+  module PrivateAPI
     def login(email, password)
       params = { "user_session[email]"    => email,
                  "user_session[password]" => password }

data/lib/tesla-api/vehicle.rb

@@ -5,42 +5,42 @@ module TeslaAPI
     attr_reader :option_codes
 
     ##
-    # :method: color
-    # Should be car color but is always nil
+    # @method color
+    # @return [String] Should be car color but is always nil
 
     ##
-    # :method: display_name
-    # Only observed as nil
+    # @method display_name
+    # @return [String] Only observed as nil
 
     ##
-    # :method: id
-    # Vehicle ID used in other API calls
+    # @method id
+    # @return Vehicle ID used in other API calls
 
     ##
-    # :method: user_id
-    # Logged in user ID
+    # @method user_id
+    # @return [Integer] Logged in user ID
 
     ##
-    # :method: vehicle_id
-    # Vehicle ID used in streaming API
+    # @method vehicle_id
+    # @return [Integer] Vehicle ID used in streaming API
 
     ##
-    # :method: vin
-    # Vehicle Identification Number
+    # @method vin
+    # @return [String] Vehicle Identification Number
 
     ##
-    # :method: tokens
-    # API tokens (first is used for streaming API)
+    # @method tokens
+    # @return [Array] API tokens (first is used for streaming API)
 
     ##
-    # :method: online_state
-    # "online" if currently online with API (streaming?)
+    # @method online_state
+    # @return [String] "online" if currently online with API (streaming?)
 
     ##
-    # :method: option_codes
-    # Array of option codes defining how the vehicle is configured
+    # @method option_codes
+    # @return [Array] option codes defining how the vehicle is configured
 
-    def initialize(tesla, data) # :nodoc:
+    def initialize(tesla, data)
       @tesla = tesla
 
       ivar_from_data("color",        "color",        data)
@@ -60,12 +60,12 @@ module TeslaAPI
       tesla.api_mobile_access?(self)
     end
 
-    # Returns the option codes as human readable string
+    # @return [String] the option codes as human readable string
     def option_code_descriptions
       option_codes.map { |code| codes_to_description.fetch(code, code) }.join(", ")
     end
 
-    # Returns the streaming data interface
+    # @return [Object] the streaming data interface
     def stream
       tesla.stream(self)
     end
@@ -154,38 +154,38 @@ module TeslaAPI
     #
     #################################
 
-    # Returns the vehicles charge state
+    # @return [ChargeState] the vehicle's charge state
     def charge_state
       @charge_state ||= tesla.api_charge_state_for_vehicle(self)
     end
 
-    # Returns the vehicle climate state
+    # @return [ClimateState] the vehicle's climate state
     def climate_state
       @climate_state || tesla.api_climate_state_for_vehicle(self)
     end
 
-    # Returns the vehicle drive state
+    # @return [DriveState] the vehicle's drive state
     def drive_state
       @drive_state ||= tesla.api_drive_state_for_vehicle(self)
     end
 
-    # Returns the vehicle gui settings
+    # @return [GUISettings] the vehicle's gui settings
     def gui_settings
       @gui_settings ||= tesla.api_gui_settings_for_vehicle(self)
     end
 
-    # Returns the vehicle state
+    # @return [VehicleState] the vehicle's state
     def state
       @state ||= tesla.api_get_vehicle_state_for_vehicle(self)
     end
 
     private
 
-    def tesla #:nodoc:
+    def tesla
       @tesla
     end
 
-    def codes_to_description #:nodoc:
+    def codes_to_description
       {
         "MS01" => "base",
         "RENA" => "region_us",

data/lib/tesla-api/vehicle_state.rb

@@ -2,73 +2,71 @@ module TeslaAPI
   # Defines the current vehicle state
   class VehicleState < Data
     ##
-    # :method: firmware_version
-    # Current firmware version
+    # @method firmware_version
+    # @return [String] Current firmware version
 
     ##
-    # :method: sun_roof_installed?
-    # true if the vehicle is configured with the panoramic sun roof
+    # @method sun_roof_installed?
+    # @return [Boolean] if the vehicle is configured with the panoramic sun roof
 
     ##
-    # :method: sun_roof_state
-    # Current state of the sun roof
-    # Potential values:
-    #   unknown
-    #   moving
+    # @method sun_roof_state
+    # @return [String] Current state of the sun roof
+    # Potential values: unknown, moving
 
     ##
-    # :method: sun_roof_percent_open
-    # Percentage the sun roof is open
+    # @method sun_roof_percent_open
+    # @return [Integer] Percentage the sun roof is open
 
     ##
-    # :method: driver_front_door_open?
-    # true if the driver's side front door is open
+    # @method driver_front_door_open?
+    # @return [Boolean] if the driver's side front door is open
 
     ##
-    # :method: driver_rear_door_open?
-    # true if the driver's side rear door is open
+    # @method driver_rear_door_open?
+    # @return [Boolean] if the driver's side rear door is open
 
     ##
-    # :method: passenger_front_door_open?
-    # true if the passenger's side front door is open
+    # @method passenger_front_door_open?
+    # @return [Boolean] if the passenger's side front door is open
 
     ##
-    # :method: passenger_rear_door_open
-    # true if the passenger's side rear door is open
+    # @method passenger_rear_door_open
+    # @return [Boolean] if the passenger's side rear door is open
 
     ##
-    # :method: front_trunk_open?
-    # true if the front trunk (frunk) is open
+    # @method front_trunk_open?
+    # @return [Boolean] if the front trunk (frunk) is open
 
     ##
-    # :method: rear_trunk_open?
-    # true if the rear trunk is open
+    # method rear_trunk_open?
+    # @return [Boolean] if the rear trunk is open
 
     ##
-    # :method: locked?
-    # true if the doors are locked
+    # @method locked?
+    # @return [Boolean] if the doors are locked
 
     ##
-    # :method: dark_rims?
-    # true if configured with dark colored rims
+    # @method dark_rims?
+    # @return [Boolean] if configured with dark colored rims
 
     ##
-    # :method: spoiler?
-    # true if configured with a spoiler
+    # @method spoiler?
+    # @return [Boolean] if configured with a spoiler
 
     ##
-    # :method: nineteen_inch_wheels?
-    # true if configured with nineteen inch wheels
+    # @method nineteen_inch_wheels?
+    # @return [Boolean] if configured with nineteen inch wheels
 
     ##
-    # :method: panoramic?
-    # true if configured with a panoramic roof
+    # @method panoramic?
+    # @return [Boolean] configured with a panoramic roof
 
     ##
-    # :method: perf?
-    # true if a performance configured vehicle
+    # @method perf?
+    # @return [Boolean] if a performance configured vehicle
 
-    def initialize(data) # :nodoc:
+    def initialize(data)
       ivar_from_data("firmware_version",          "car_version",           data)
       ivar_from_data("sun_roof_installed",        "sun_roof_installed",    data)
       ivar_from_data("sun_roof_state",            "sun_roof_state",        data)

data/lib/tesla-api/version.rb

@@ -1,4 +1,4 @@
-module TeslaAPI # :nodoc:
+module TeslaAPI
   # Version Number
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tesla-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -133,3 +133,4 @@ test_files:
 - test/test_gui_settings.rb
 - test/test_vehicle.rb
 - test/test_vehicle_state.rb
+has_rdoc: