mios 0.3.0 → 0.3.1

data/lib/mios/services/energy_metering1.rb

@@ -1,20 +1,19 @@
 module MiOS
   module Services
     module EnergyMetering1
-      def self.extended(base)
-        base.instance_variable_set("@energymetering1_urn", "urn:micasaverde-com:serviceId:EnergyMetering1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:EnergyMetering1'
 
       def watts
-        integer_for(@energymetering1_urn, 'Watts')
+        value_for URN, 'Watts', as: Integer
       end
 
       def kWh
-        float_for(@energymetering1_urn, 'KWH')
+        value_for URN, 'KWH', as: Float
       end
 
       def last_reading_at
-        time_for(@energymetering1_urn, "KWHReading")
+        value_for URN, 'KWHReading', as: Time
       end
     end
   end

data/lib/mios/services/generic_sensor1.rb

@@ -1,9 +1,9 @@
 module MiOS
   module Services
     module GenericSensor1
-      def self.extended(base)
-        base.instance_variable_set("@genericsensor1_urn", "urn:micasaverde-com:serviceId:GenericSensor1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:GenericSensor1'
+
     end
   end
-end
+end

data/lib/mios/services/ha_device1.rb

@@ -1,28 +1,27 @@
 module MiOS
   module Services
     module HaDevice1
-      def self.extended(base)
-        base.instance_variable_set("@hadevice1_urn", "urn:micasaverde-com:serviceId:HaDevice1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:HaDevice1'
 
       def auto_configure
-        boolean_for(@hadevice1_urn, "AutoConfigure")
+        value_for(URN, 'AutoConfigure', as: Boolean)
       end
 
       def battery_date
-        timestamp_for(@hadevice1_urn, "BatteryDate")
+        value_for(URN, 'BatteryDate', as: Time)
       end
 
       def battery_level
-        integer_for(@hadevice1_urn, "BatteryLevel")
+        value_for(URN, 'BatteryLevel', as: Integer)
       end
 
       def first_configured
-        timestamp_for(@hadevice1_urn, "FirstConfigured")
+        value_for(URN, 'FirstConfigured', as: Time)
       end
 
       def last_update
-        timestamp_for(@hadevice1_urn, "LastUpdate")
+        value_for(URN, 'LastUpdate', as: Time)
       end
     end
   end

data/lib/mios/services/humidity_sensor1.rb

@@ -1,13 +1,12 @@
-# NOTE: Currently untested with a real humidity sensor
+# Tested with Everspring Combo Sensor
 module MiOS
   module Services
     module HumiditySensor1
-      def self.extended(base)
-        base.instance_variable_set("@humiditysensor1_urn", "urn:upnp-org:serviceId:HumiditySensor1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:HumiditySensor1'
 
       def humidity
-        integer_for(@humiditysensor1_urn, 'CurrentHumidity')
+        value_for URN, 'CurrentLevel', as: Integer
       end
     end
   end

data/lib/mios/services/hvac_fan_operating_mode1.rb

@@ -1,12 +1,11 @@
 module MiOS
   module Services
     module HVACFanOperatingMode1
-      def self.extended(base)
-        base.instance_variable_set("@hvac_fan_operating_mode1_urn", "urn:upnp-org:serviceId:HVAC_FanOperatingMode1")
-      end
+
+      URN = 'urn:upnp-org:serviceId:HVAC_FanOperatingMode1'
 
       def fan_mode
-        value_for(@hvac_fan_operating_mode1_urn, 'Mode')
+        value_for URN, 'Mode'
       end
     end
   end

data/lib/mios/services/hvac_operating_state1.rb

@@ -1,12 +1,11 @@
 module MiOS
   module Services
     module HVACOperatingState1
-      def self.extended(base)
-        base.instance_variable_set("@hvac_operating_state1_urn", "urn:micasaverde-com:serviceId:HVAC_OperatingState1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:HVAC_OperatingState1'
 
       def operating_state
-        value_for(@hvac_operating_state1_urn, 'ModeState')
+        value_for URN, 'ModeState'
       end
     end
   end

data/lib/mios/services/hvac_user_operating_mode1.rb

@@ -1,12 +1,11 @@
 module MiOS
   module Services
     module HVACUserOperatingMode1
-      def self.extended(base)
-        base.instance_variable_set("@hvac_user_operating_mode1_urn", "urn:upnp-org:serviceId:HVAC_UserOperatingMode1")
-      end
+
+      URN = 'urn:upnp-org:serviceId:HVAC_UserOperatingMode1'
 
       def mode
-        value_for(@hvac_user_operating_mode1_urn, 'ModeStatus')
+        value_for URN, 'ModeStatus'
       end
     end
   end

data/lib/mios/services/light_sensor1.rb

@@ -1,21 +1,13 @@
 module MiOS
   module Services
     module LightSensor1
-      def self.extended(base)
-        base.instance_variable_set("@lightsensor1_urn", "urn:micasaverde-com:serviceId:LightSensor1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:LightSensor1'
 
       def level
-        @states.each do |state_hash|
-          if state_hash['service'] == @lightsensor1_urn
-            if state_hash['variable'] == "CurrentLevel"
-              return state_hash['value'].to_i
-            end
-          end
-        end
-        
-        return nil
+        value_for URN, 'CurrentLevel', as: Integer
       end
+
     end
   end
 end

data/lib/mios/services/scene_controller1.rb

@@ -1,9 +1,9 @@
 module MiOS
   module Services
     module SceneController1
-      def self.extended(base)
-        base.instance_variable_set("@scenecontroller1_urn", "urn:micasaverde-com:serviceId:SceneController1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:SceneController1'
+
     end
   end
-end
+end

data/lib/mios/services/security_sensor1.rb

@@ -1,32 +1,31 @@
 module MiOS
   module Services
     module SecuritySensor1
-      def self.extended(base)
-        base.instance_variable_set("@securitysensor1_urn", "urn:micasaverde-com:serviceId:SecuritySensor1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:SecuritySensor1'
 
       def tripped?
-        boolean_for(@securitysensor1_urn, 'Tripped')
+        value_for URN, 'Tripped', as: Boolean
       end
-      
+
       def armed?
-        boolean_for(@securitysensor1_urn, 'Armed')
+        value_for URN, 'Armed', as: Boolean
       end
-      
+
       def disarmed?
         !armed?
       end
-      
+
       def lasttrip
-        timestamp_for(@securitysensor1_urn, 'LastTrip')
+        value_for URN, 'LastTrip', as: Time
       end
-      
+
       def arm!(async=false, &block)
-        set(@securitysensor1_urn, "SetArmed", {"newArmedValue" => 1}, async, &block)
+        set(URN, 'SetArmed', { "newArmedValue" => 1 }, async, &block)
       end
 
       def disarm!(async=false, &block)
-        set(@securitysensor1_urn, "SetArmed", {"newArmedValue" => 0}, async, &block)
+        set(URN, 'SetArmed', { "newArmedValue" => 0 }, async, &block)
       end
     end
   end

data/lib/mios/services/switch_power1.rb

@@ -1,24 +1,23 @@
 module MiOS
   module Services
     module SwitchPower1
-      def self.extended(base)
-        base.instance_variable_set("@switchpower1_urn", "urn:upnp-org:serviceId:SwitchPower1")
-      end
+
+      URN = 'urn:upnp-org:serviceId:SwitchPower1'
 
       def on?
-        boolean_for(@switchpower1_urn, 'Status')
+        value_for URN, 'Status', as: Boolean
       end
-      
+
       def off?
         !on?
       end
-      
+
       def on!(async=false, &block)
-        set(@switchpower1_urn, "SetTarget", {"newTargetValue" => 1}, async, &block)
+        set(URN, 'SetTarget', { "newTargetValue" => 1 }, async, &block)
       end
 
       def off!(async=false, &block)
-        set(@switchpower1_urn, "SetTarget", {"newTargetValue" => 0}, async, &block)
+        set(URN, 'SetTarget', { "newTargetValue" => 0 }, async, &block)
       end
     end
   end

data/lib/mios/services/temperature_sensor1.rb

@@ -1,12 +1,11 @@
 module MiOS
   module Services
     module TemperatureSensor1
-      def self.extended(base)
-        base.instance_variable_set("@temperaturesensor1_urn", "urn:upnp-org:serviceId:TemperatureSensor1")
-      end
+
+      URN = 'urn:upnp-org:serviceId:TemperatureSensor1'
 
       def temperature
-        integer_for(@temperaturesensor1_urn, 'CurrentTemperature')
+        value_for URN 'CurrentTemperature', as: Integer
       end
     end
   end

data/lib/mios/services/temperature_setpoint1_cool.rb

@@ -1,12 +1,11 @@
 module MiOS
   module Services
     module TemperatureSetpoint1Cool
-      def self.extended(base)
-        base.instance_variable_set("@temperaturesetpoint1cool_urn", "urn:upnp-org:serviceId:TemperatureSetpoint1_Cool")
-      end
+
+      URN = 'urn:upnp-org:serviceId:TemperatureSetpoint1_Cool'
 
       def cool_target
-        integer_for(@temperaturesetpoint1cool_urn, 'CurrentSetpoint')
+        value_for URN, 'CurrentSetpoint', as: Integer
       end
     end
   end

data/lib/mios/services/temperature_setpoint1_heat.rb

@@ -1,12 +1,11 @@
 module MiOS
   module Services
     module TemperatureSetpoint1Heat
-      def self.extended(base)
-        base.instance_variable_set("@temperaturesetpoint1heat_urn", "urn:upnp-org:serviceId:TemperatureSetpoint1_Heat")
-      end
+
+      URN = 'urn:upnp-org:serviceId:TemperatureSetpoint1_Heat'
 
       def heat_target
-        integer_for(@temperaturesetpoint1heat_urn, 'CurrentSetpoint')
+        value_for URN, 'CurrentSetpoint', as: Integer
       end
     end
   end

data/lib/mios/services/window_covering1.rb

@@ -1,20 +1,19 @@
 module MiOS
   module Services
     module WindowCovering1
-      def self.extended(base)
-        base.instance_variable_set("@windowcovering1_urn", "urn:upnp-org:serviceId:WindowCovering1")
-      end
+
+      URN = 'urn:upnp-org:serviceId:WindowCovering1'
 
       def up!(async=false, &block)
-        set(@windowcovering1_urn, "Up", async, &block)
+        set(URN, 'Up', async, &block)
       end
 
       def down!(async=false, &block)
-        set(@windowcovering1_urn, "Down", async, &block)
+        set(URN, 'Down', async, &block)
       end
 
       def stop!(async=false, &block)
-        set(@windowcovering1_urn, "Stop", async, &block)
+        set(URN, 'Stop', async, &block)
       end
     end
   end

data/lib/mios/services/zwave_device1.rb

@@ -1,9 +1,9 @@
 module MiOS
   module Services
     module ZWaveDevice1
-      def self.extended(base)
-        base.instance_variable_set("@zwavedevice1_urn", "urn:micasaverde-com:serviceId:ZWaveDevice1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:ZWaveDevice1'
+
     end
   end
 end

data/lib/mios/services/zwave_network1.rb

@@ -1,9 +1,9 @@
 module MiOS
   module Services
     module ZWaveNetwork1
-      def self.extended(base)
-        base.instance_variable_set("@zwavenetwork1_urn", "urn:micasaverde-com:serviceId:ZWaveNetwork1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:ZWaveNetwork1'
+
     end
   end
 end

data/lib/mios/type_conversion.rb

@@ -0,0 +1,21 @@
+class Boolean; end
+
+module MiOS
+
+  def self.cast(value, type)
+    result = case
+    when type == Integer
+      value.to_i
+    when type == Time
+      Time.at(value.to_i)
+    when type == Boolean
+      value.to_i == 1
+    when type == Float
+      value.to_f
+    else
+      value
+    end
+    result
+  end
+
+end

data/lib/mios/version.rb

@@ -1,3 +1,3 @@
 module MiOS
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/mios.rb

@@ -1,8 +1,14 @@
 require 'httpclient'
-require 'multi_json'
-require "mios/version"
-require "mios/interface"
-require "mios/device"
-require "mios/action"
-require "mios/job"
+require 'json'
+require 'mios/version'
+require 'mios/interface'
+require 'mios/device'
+require 'mios/action'
+require 'mios/job'
+require 'mios/client'
+require 'mios/category'
+require 'mios/category_collection'
+require 'mios/room'
+require 'mios/type_conversion'
+require 'mios/scene'
 Dir[File.dirname(__FILE__) + '/mios/services/*.rb'].each {|file| require file }

data/mios.gemspec

@@ -16,10 +16,9 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  
+
   gem.add_dependency "httpclient", ">= 2.2.0"
-  gem.add_dependency "multi_json", ">= 1.3.0"
-  
+
   gem.add_development_dependency "rspec", ">= 2.8.0"
   gem.add_development_dependency "syntax"
   gem.add_development_dependency "rake", ">= 0.9.2"

data/spec/integration/lights_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'light type device control' do
+  let(:mios) { MiOS::Interface.new('http://192.168.50.21:3480') }
+
+  it 'should turn on the light' do
+    VCR.use_cassette('turn_on_light') do
+      mios.devices[11].on! { expect(mios.devices[11]).to be_on }
+    end
+  end
+
+  it 'should turn off the light' do
+    VCR.use_cassette('turn_off_light') do
+      mios.devices[11].off! { expect(mios.devices[11]).to be_off }
+    end
+  end
+end

data/spec/lib/mios/category_collection_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module MiOS
+  describe CategoryCollection do
+    before do
+      filters = JSON.parse(File.read('spec/support/device_data/category_filter.json'))
+      @category_collection = CategoryCollection.new(filters)
+      @category = @category_collection.all[5]
+    end
+
+    describe :find_for_id do
+      it 'should return a Category object given an id' do
+        category = @category_collection.find_by_id(16)
+        expect(category).to eql @category
+      end
+    end
+
+    describe :find_for_label do
+      it 'should return a Category object given a label' do
+        category = @category_collection.find_by_label('Sensors')
+        expect(category).to eql @category
+      end
+    end
+
+    describe :all do
+      it 'should return an array of all Categories' do
+        expect(@category_collection.all.count).to eql 7
+      end
+    end
+
+    describe :to_s do
+      it 'should return the correct string' do
+        expect(@category_collection.to_s).to_not be_empty
+      end
+    end
+  end
+end

data/spec/lib/mios/category_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module MiOS
+  describe Category do
+    before do
+      @category = Category.new('Sensors', [4, 12, 16, 17, 18])
+    end
+
+    describe :to_s do
+      it 'should return the correct string' do
+        expect(@category.to_s).to eql 'Sensors'
+      end
+    end
+  end
+end

data/spec/lib/mios/client_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe MiOS::Client do
+
+  it "can be instantiated" do
+    client = MiOS::Client.new('0.0.0.0:3000')
+    expect(client).to be_a MiOS::Client
+  end
+
+  describe "#data_request" do
+    let(:client) { MiOS::Client.new('http://192.168.50.21:3480') }
+    let(:data_request_json) { JSON.parse(File.read('spec/support/device_data/data_request.json')) }
+
+    it "returns ruby object from parsed json" do
+      VCR.use_cassette('data_request') do
+        test_params = { id: 'user_data', output_format: :json}
+        expect(client.data_request(test_params)).to eq data_request_json
+      end
+    end
+
+    it "defaults to json output format" do
+      VCR.use_cassette('data_request') do
+        test_params = { id: 'user_data' }
+        expect(client.data_request(test_params)).to eq data_request_json
+      end
+    end
+  end
+end

data/spec/lib/mios/device_spec.rb

@@ -1,10 +1,73 @@
 require 'spec_helper'
 
-describe "device" do
-  it "should correctly parse service names" do
-    output = capture_stderr do
-      device = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/echo-energy-manager.json')))
+module MiOS
+  describe Device do
+    before :each do
+      @data_request = JSON.parse(File.read('spec/support/device_data/data_request.json'))
+      @states = @data_request['devices'][11]['states']
+      @attributes = JSON.parse(File.read('spec/support/device_data/device_attributes.json'))
+      VCR.use_cassette('data_request') do
+        @interface =  MiOS::Interface.new('http://192.168.50.21:3480')
+        @interface.stub(:device_status).and_return('id' => '12', 'states' => @states, 'name' => 'On/Off Outlet')
+        @device = @interface.devices[11]
+      end
+    end
+
+    describe :initialize do
+      it 'should be an instance of Device' do
+        expect(@device).to be_an_instance_of(MiOS::Device)
+      end
+
+      it 'should output a warning for unsupported services' do
+        output = capture_stderr do
+          device = MiOS::Device.new(nil, JSON.parse(File.read('spec/support/device_data/echo-energy-manager.json')))
+        end
+        expect(output).to eql "WARNING: EEMPlugin1 not yet supported\n"
+      end
+    end
+
+    describe :method_missing do
+      it 'should throw an exception for missing attributes' do
+        expect {@device.foo}.to raise_error
+      end
+
+      it 'should not throw an exception for defined attributes' do
+        expect {@device.id}.to_not raise_error
+        expect(@device.id).to eql '12'
+      end
+    end
+
+    describe :states do
+      it 'should return the current device states' do
+        expect(@device.states).to eql(@states)
+      end
+    end
+
+    describe :room do
+      it 'should return the correct room for the device' do
+        expect(@device.room.name).to eql 'Living Room'
+      end
+    end
+
+    describe :reload do
+      it 'should change state' do
+        expect(@device.states).to eql(@states)
+        @states[1]['value'] = 'off'
+        @device.reload
+        expect(@device.states).to eql(@states)
+      end
+    end
+
+    describe :category do
+      it 'should return the appropriate category' do
+        expect(@device.category.label).to eql 'Lights'
+      end
+    end
+
+    describe :attributes do
+      it 'should return the attributes hash' do
+        expect(@device.attributes).to eql(@attributes)
+      end
     end
-    expect(output).to eql "WARNING: EEMPlugin1 not yet supported\n"
   end
-end
+end