meac_control 1.0.0

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2010 Bernd Ahlers <bernd@tuneafish.de>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+## MEACControl
+
+The library provides some Ruby classes to interact with a Mitsubishi Electric
+G-50A centralized controller. This device is used to control up to 50 indoor
+air conditioning units.
+
+The G-50A offers a XML API for the communication.
+
+So far, the library has only been tested with a G-50A. I'm not sure if there
+are other controller/devices which use the same API.
+
+### Security
+
+Mitsubishi recommends to put the controller into a private network. In fact,
+there's no authentication or encryption needed to access the controller.
+There's been a post to the BugTraq mailing list in March 2008 regarding that.
+[Archive](http://www.securityfocus.com/archive/1/489970)
+
+### Code Examples
+
+Please see the `example` directory for code examples.
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Write a spec to cover a bug or a new feature.
+* Make your feature addition or bug fix.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright (c) 2010 Bernd Ahlers. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "meac_control"
+    gem.summary = %Q{Library to communicate with a Mitsubishi Electric G-50A centralized controller}
+    gem.description = %Q{Library to communicate with a Mitsubishi Electric G-50A centralized controller}
+    gem.email = "bernd@tuneafish.de"
+    gem.homepage = "http://github.com/bernd/meac_control"
+    gem.authors = ["Bernd Ahlers"]
+
+    gem.files = FileList["LICENSE", "README.md", "Rakefile", "VERSION.yml", "{lib,spec}/**/*"]
+
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+
+    gem.add_dependency "httpclient"
+    gem.add_dependency "nokogiri"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = Jeweler::VersionHelper.new(File.dirname(__FILE__))
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "MEACControl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:build: 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/meac_control.rb

@@ -0,0 +1,4 @@
+require 'meac_control/command'
+require 'meac_control/device'
+require 'meac_control/http'
+require 'meac_control/xml'

data/lib/meac_control/command.rb

@@ -0,0 +1,4 @@
+require 'meac_control/command/generic'
+require 'meac_control/command/drive'
+require 'meac_control/command/fan_speed'
+require 'meac_control/command/inlet_temp'

data/lib/meac_control/command/drive.rb

@@ -0,0 +1,20 @@
+require 'meac_control/command/generic'
+
+module MEACControl
+  module Command
+    class Drive < Generic
+
+      def initialize
+        @command = 'Drive'
+      end
+
+      def on
+        @value = 'ON'
+      end
+
+      def off
+        @value = 'OFF'
+      end
+    end
+  end
+end

data/lib/meac_control/command/fan_speed.rb

@@ -0,0 +1,32 @@
+require 'meac_control/command/generic'
+
+module MEACControl
+  module Command
+    class FanSpeed < Generic
+
+      def initialize
+        @command = 'FanSpeed'
+      end
+
+      def low
+        @value = 'low'
+      end
+
+      def mid1
+        @value = 'mid1'
+      end
+
+      def mid2
+        @value = 'mid2'
+      end
+
+      def high
+        @value = 'high'
+      end
+
+      def auto
+        @value = 'auto'
+      end
+    end
+  end
+end

data/lib/meac_control/command/generic.rb

@@ -0,0 +1,32 @@
+module MEACControl
+  module Command
+    class InvalidValue < Exception
+    end
+
+    class InvalidMode < Exception
+    end
+
+    class Generic
+      attr_reader :command, :value
+
+      def self.request
+        new.freeze
+      end
+
+      def hash_for(mode)
+        if mode == :set
+          raise MEACControl::Command::InvalidValue if (value.nil? or value.empty?)
+          {command.to_sym => value}
+        elsif mode == :get
+          {command.to_sym => '*'}
+        else
+          raise MEACControl::Command::InvalidMode
+        end
+      end
+
+      def command_set?
+        (value.nil? or value.empty?) ? false : true
+      end
+    end
+  end
+end

data/lib/meac_control/command/inlet_temp.rb

@@ -0,0 +1,11 @@
+require 'meac_control/command/generic'
+
+module MEACControl
+  module Command
+    class InletTemp < Generic
+      def initialize
+        @command = 'InletTemp'
+      end
+    end
+  end
+end

data/lib/meac_control/device.rb

@@ -0,0 +1,11 @@
+module MEACControl
+  class Device
+    attr_reader :id
+    attr_accessor :name
+
+    def initialize(device_id, options = {})
+      @id = device_id
+      @name = options[:name] if options[:name]
+    end
+  end
+end

data/lib/meac_control/http.rb

@@ -0,0 +1,42 @@
+require 'meac_control/xml/get_request'
+require 'meac_control/xml/set_request'
+require 'meac_control/xml/response'
+require 'httpclient'
+
+module MEACControl
+  class HTTP
+    URI_TEMPLATE = 'http://%s/servlet/MIMEReceiveServlet'
+    DEFAULT_HEADER = {'Accept' => 'text/xml', 'Content-Type' => 'text/xml'}
+
+    class << self
+      # Executes a get request and returns a MEACControl::XML::Response object.
+      #
+      # Example:
+      #   device = MEACControl::Device.new(23)
+      #   command = MEACControl::Command::Drive.request
+      #   resp = MEACControl::HTTP.get('127.0.0.1', device, command)
+      #   resp.inspect # => "#<MEACControl::XML::Response:0x8bea3ef0 ...>"
+      def get(host, devices, commands)
+        action(host, MEACControl::XML::GetRequest.new(devices, commands))
+      end
+
+      # Executes a set request and returns a MEACControl::XML::Response object.
+      #
+      # Example:
+      #   device = MEACControl::Device.new(23)
+      #   command = MEACControl::Command::Drive.new
+      #   command.off
+      #   resp = MEACControl::HTTP.set('127.0.0.1', device, command)
+      #   resp.inspect # => "#<MEACControl::XML::Response:0x8bea3ef0 ...>"
+      def set(host, devices, commands)
+        action(host, MEACControl::XML::SetRequest.new(devices, commands))
+      end
+
+      private
+        def action(host, request)
+          resp = HTTPClient.post(sprintf(URI_TEMPLATE, host), request.to_xml, DEFAULT_HEADER)
+          MEACControl::XML::Response.new(resp.content, request)
+        end
+    end
+  end
+end

data/lib/meac_control/xml.rb

@@ -0,0 +1,5 @@
+require 'meac_control/xml/exceptions'
+require 'meac_control/xml/abstract_request'
+require 'meac_control/xml/get_request'
+require 'meac_control/xml/set_request'
+require 'meac_control/xml/response'

data/lib/meac_control/xml/abstract_request.rb

@@ -0,0 +1,36 @@
+require 'nokogiri'
+require 'meac_control/xml/exceptions'
+
+module MEACControl
+  module XML
+    class AbstractRequest
+      attr_reader :devices, :commands
+
+      def initialize(devices, commands)
+        @devices = [devices].compact.flatten
+        @commands = [commands].compact.flatten
+
+        raise MEACControl::XML::Request::EmptyDeviceList if @devices.empty?
+        raise MEACControl::XML::Request::EmptyCommandList if @commands.empty?
+      end
+
+      private
+        def xml_template(command, mode)
+          ::Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do
+            Packet do
+              Command command
+              DatabaseManager do
+                devices.each do |dev|
+                  attributes = {:Group => dev.id}
+                  commands.each do |cmd|
+                    attributes.merge!(cmd.hash_for(mode))
+                  end
+                  Mnet(attributes)
+                end
+              end
+            end
+          end.to_xml
+        end
+    end
+  end
+end

data/lib/meac_control/xml/exceptions.rb

@@ -0,0 +1,14 @@
+module MEACControl
+  module XML
+    class InvalidResponse < Exception
+    end
+
+    module Request
+      class EmptyDeviceList < Exception
+      end
+
+      class EmptyCommandList < Exception
+      end
+    end
+  end
+end

data/lib/meac_control/xml/get_request.rb

@@ -0,0 +1,16 @@
+require 'meac_control/xml/abstract_request'
+
+module MEACControl
+  module XML
+    class GetRequest < AbstractRequest
+      # returns a xml get request.
+      #
+      # example:
+      #   req = MEACControl::XML::GetRequest.new(device, command)
+      #   req.to_xml # => "<?xml version="1.0" encoding="UTF-8"?>..."
+      def to_xml
+        xml_template('getRequest', :get)
+      end
+    end
+  end
+end

data/lib/meac_control/xml/response.rb

@@ -0,0 +1,44 @@
+require 'nokogiri'
+require 'meac_control/xml/exceptions'
+
+module MEACControl
+  module XML
+    class Response
+      attr_reader :xml, :request
+
+      def initialize(xml, request = nil)
+        @xml = ::Nokogiri::XML(xml)
+        @request = request
+        raise(MEACControl::XML::InvalidResponse, @xml.to_s) if @xml.root.nil?
+      end
+
+      def to_xml
+        @xml.to_s
+      end
+
+      def ok?
+        !errors?
+      end
+
+      def errors?
+        !@xml.xpath('/Packet/DatabaseManager/ERROR').empty?
+      end
+
+      def errors
+        @xml.xpath('/Packet/DatabaseManager/ERROR').map do |error|
+          data = {}
+          error.each do |key, value|
+            data[key] = value
+          end
+          data
+        end
+      end
+
+      def error_messages
+        errors.map do |error|
+          error['Message']
+        end
+      end
+    end
+  end
+end

data/lib/meac_control/xml/set_request.rb

@@ -0,0 +1,16 @@
+require 'meac_control/xml/abstract_request'
+
+module MEACControl
+  module XML
+    class SetRequest < AbstractRequest
+      # returns a xml set request.
+      #
+      # example:
+      #   req = MEACControl::XML::SetRequest.new(device, command)
+      #   req.to_xml # => "<?xml version="1.0" encoding="UTF-8"?>..."
+      def to_xml
+        xml_template('setRequest', :set)
+      end
+    end
+  end
+end

data/spec/fixtures/get-request.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Packet>
+  <Command>getRequest</Command>
+  <DatabaseManager>
+    <Mnet Group="23" Drive="*"/>
+  </DatabaseManager>
+</Packet>

data/spec/fixtures/get-response-error.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Packet>
+  <Command>geErrorResponse</Command>
+  <DatabaseManager>
+    <Mnet Drive="*" Group="31"/>
+    <ERROR Point="geRequest" Code="0102" Message="Insufficiency Attribute"/>
+  </DatabaseManager>
+</Packet>

data/spec/fixtures/get-response-ok.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Packet>
+  <Command>getResponse</Command>
+  <DatabaseManager>
+    <Mnet Drive="OFF" Group="31"/>
+  </DatabaseManager>
+</Packet>

data/spec/fixtures/set-request.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Packet>
+  <Command>getRequest</Command>
+  <DatabaseManager>
+    <Mnet Group="23" Drive="OFF"/>
+  </DatabaseManager>
+</Packet>

data/spec/lib/meac_control/command/drive_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/command/drive'
+
+describe MEACControl::Command::Drive do
+  before(:each) do
+    @cmd = MEACControl::Command::Drive.new
+  end
+
+  it_should_behave_like "a class that includes MEACControl::Command::Generic"
+
+  it "has set the command to 'Drive'" do
+    @cmd.command.should == 'Drive'
+  end
+
+  describe "#on" do
+    it "sets the value to 'ON'" do
+      @cmd.on
+      @cmd.value.should == 'ON'
+    end
+  end
+
+  describe "#off" do
+    it "sets the value to 'OFF'" do
+      @cmd.off
+      @cmd.value.should == 'OFF'
+    end
+  end
+end

data/spec/lib/meac_control/command/fan_speed_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/command/fan_speed'
+
+describe MEACControl::Command::FanSpeed do
+  before(:each) do
+    @cmd = MEACControl::Command::FanSpeed.new
+  end
+
+  it_should_behave_like "a class that includes MEACControl::Command::Generic"
+
+  it "has set the command to 'FanSpeed'" do
+    @cmd.command.should == 'FanSpeed'
+  end
+
+  %w{low mid1 mid2 high auto}.each do |c|
+    describe "##{c}" do
+      it "sets the value to '#{c}'" do
+        @cmd.send(c)
+        @cmd.value.should == c
+      end
+    end
+  end
+end

data/spec/lib/meac_control/command/generic_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/command/generic'
+
+class Cmd < MEACControl::Command::Generic
+  def initialize
+    @command = "MyCommand"
+    @value = "MyValue"
+  end
+
+  def on
+    @value = 'ON'
+  end
+end
+
+describe MEACControl::Command::Generic do
+  before(:each) do
+    @obj = Cmd.new
+  end
+
+  describe ".request" do
+    it "returns a new frozen object" do
+      Cmd.request.should be_frozen
+    end
+
+    it "does not allow modifications" do
+      lambda { Cmd.request.on }.should raise_error(TypeError)
+    end
+  end
+
+  describe "#hash_for" do
+    it "will raise an exception if it's called without argument" do
+      lambda { @obj.hash_for }.should raise_error(ArgumentError)
+    end
+
+    context "with the :get argument" do
+      it "returns a hash with the command name as key and a value of '*'" do
+        @obj.hash_for(:get).should == {@obj.command.to_sym => '*'}
+      end
+    end
+
+    context "with the :set argument" do
+      it "returns a hash with the command as key and the command value as value" do
+        @obj.hash_for(:set).should == {@obj.command.to_sym => @obj.value}
+      end
+
+      it "will raise an exception if value is nil" do
+        @obj.stub!(:value).and_return(nil)
+        lambda { @obj.hash_for(:set) }.should raise_error(MEACControl::Command::InvalidValue)
+      end
+
+      it "will raise an exception if value is an empty string" do
+        @obj.stub!(:value).and_return('')
+        lambda { @obj.hash_for(:set) }.should raise_error(MEACControl::Command::InvalidValue)
+      end
+    end
+
+    context "with an unknown argument" do
+      it "will raise an exception" do
+        lambda { @obj.hash_for(:foobar_unknown) }.should raise_error(MEACControl::Command::InvalidMode)
+      end
+    end
+  end
+
+  describe "#command_set?" do
+    context "with value set to 'YES'" do
+      it "returns true" do
+        @obj.stub!(:value).and_return('YES')
+        @obj.command_set?.should be_true
+      end
+    end
+
+    context "with value set to an empty string" do
+      it "returns false" do
+        @obj.stub!(:value).and_return('')
+        @obj.command_set?.should be_false
+      end
+    end
+
+    context "with value set to nil" do
+      it "returns false" do
+        @obj.stub!(:value).and_return(nil)
+        @obj.command_set?.should be_false
+      end
+    end
+  end
+end

data/spec/lib/meac_control/command/inlet_temp_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/command/inlet_temp'
+
+describe MEACControl::Command::InletTemp do
+  before(:each) do
+    @cmd = MEACControl::Command::InletTemp.new
+  end
+
+  it_should_behave_like "a class that includes MEACControl::Command::Generic"
+
+  it "has set the command to 'InletTemp'" do
+    @cmd.command.should == 'InletTemp'
+  end
+end

data/spec/lib/meac_control/device_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'meac_control/device'
+
+describe MEACControl::Device do
+  describe "#id" do
+    it "returns the device id" do
+      MEACControl::Device.new(34).id.should == 34
+    end
+  end
+
+  describe "#name" do
+    it "returns the device name" do
+      device = MEACControl::Device.new(23)
+      device.name = "fooac"
+      device.name.should == "fooac"
+    end
+  end
+
+  it "will set the name value with the initializer option :name" do
+    device = MEACControl::Device.new(22, :name => "foobarac")
+    device.name.should == "foobarac"
+  end
+end

data/spec/lib/meac_control/http_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'meac_control/http'
+
+describe MEACControl::HTTP do
+  describe "URI_TEMPLATE constant" do
+    it "can be used to build the correct uri" do
+      uri = sprintf(MEACControl::HTTP::URI_TEMPLATE, '10.0.0.1')
+      uri.should == 'http://10.0.0.1/servlet/MIMEReceiveServlet'
+    end
+  end
+
+  describe "DEFAULT_HEADER constant" do
+    it "has 'Accept' set to 'text/xml'" do
+      MEACControl::HTTP::DEFAULT_HEADER['Accept'].should == 'text/xml'
+    end
+
+    it "has 'Content-Type' set to 'text/xml'" do
+      MEACControl::HTTP::DEFAULT_HEADER['Content-Type'].should == 'text/xml'
+    end
+  end
+
+  before(:each) do
+    @device = mock('device')
+    @command = mock('command')
+    @hostname = '127.0.0.1'
+    @uri = sprintf(MEACControl::HTTP::URI_TEMPLATE, @hostname)
+  end
+
+  describe ".get" do
+    before(:each) do
+      @xml = mock('xml_request', :to_xml => fixture_read('get-request.xml'))
+
+      HTTPClient.should_receive(:post).with(@uri, @xml.to_xml, MEACControl::HTTP::DEFAULT_HEADER).and_return do
+        mock('http_response', :content => fixture_read('get-response-ok.xml'))
+      end
+
+      MEACControl::XML::GetRequest.should_receive(:new).with(@device, @command).and_return(@xml)
+    end
+
+    it "executes a get request" do
+      MEACControl::HTTP.get(@hostname, @device, @command)
+    end
+
+    it "returns a response object" do
+      MEACControl::HTTP.get(@hostname, @device, @command).should be_ok
+    end
+
+    it "returns a response object which includes the request object" do
+      MEACControl::HTTP.get(@hostname, @device, @command).request.should == @xml
+    end
+  end
+
+  describe ".set" do
+    before(:each) do
+      @xml = mock('xml_request', :to_xml => fixture_read('set-request.xml'))
+
+      HTTPClient.should_receive(:post).with(@uri, @xml.to_xml, MEACControl::HTTP::DEFAULT_HEADER).and_return do
+        mock('http_response', :content => fixture_read('get-response-ok.xml'))
+      end
+
+      MEACControl::XML::SetRequest.should_receive(:new).with(@device, @command).and_return(@xml)
+    end
+
+    it "executes a set request" do
+      MEACControl::HTTP.set(@hostname, @device, @command)
+    end
+
+    it "returns a response object" do
+      MEACControl::HTTP.set(@hostname, @device, @command).should be_ok
+    end
+
+    it "returns a response object which includes the request object" do
+      MEACControl::HTTP.set(@hostname, @device, @command).request.should == @xml
+    end
+  end
+end

data/spec/lib/meac_control/xml/abstract_request_spec.rb

@@ -0,0 +1,141 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/xml/get_request'
+
+class Dev; end
+class Cmd; end
+
+class MyRequest < MEACControl::XML::AbstractRequest
+  def to_xml
+    xml_template('myRequest', :get)
+  end
+end
+
+describe MEACControl::XML::AbstractRequest do
+  it "creates a get request with one device and a list of commands" do
+    req = MyRequest.new(:one, [:one, :two, :three])
+    req.should have(1).devices
+    req.should have(3).commands
+  end
+
+  it "creates a get request with a list of devices and commands" do
+    req = MyRequest.new([:one, :two], [:one, :two, :three])
+    req.should have(2).devices
+    req.should have(3).commands
+  end
+
+  it "creates a get request with one device and one command" do
+    req = MyRequest.new(:two, :one)
+    req.should have(1).devices
+    req.should have(1).commands
+  end
+
+  it "fails to create a valid get request with an empty device list" do
+    lambda {
+      MyRequest.new([], [:one, :two, :three])
+    }.should raise_error(MEACControl::XML::Request::EmptyDeviceList)
+  end
+
+  it "fails to create a valid get request with a nil device" do
+    lambda {
+      MyRequest.new(nil, [:one, :two, :three])
+    }.should raise_error(MEACControl::XML::Request::EmptyDeviceList)
+  end
+
+  it "fails to create a valid get request with a nil command" do
+    lambda {
+      MyRequest.new([:one, :two, :three], nil)
+    }.should raise_error(MEACControl::XML::Request::EmptyCommandList)
+  end
+
+  describe "#xml_template" do
+    it "is not accessible as an instance method" do
+      req = MyRequest.new(:one, :two)
+      lambda { req.xml_template }.should raise_error(NoMethodError)
+    end
+  end
+
+  # Example XML output:
+  #   <?xml version="1.0" encoding="UTF-8"?>
+  #   <Packet>
+  #     <Command>getRequest</Command>
+  #     <DatabaseManager>
+  #       <Mnet Group="23" Drive="*"/>
+  #     </DatabaseManager>
+  #   </Packet>
+  describe "#to_xml" do
+    before(:each) do
+      device = mock(Dev, :id => 23)
+      commands = [
+        mock(Cmd, :hash_for => {:Command1 => '*'}),
+        mock(Cmd, :hash_for => {:Command2 => '*'}),
+        mock(Cmd, :hash_for => {:Command3  => '*'})
+      ]
+      @req = MyRequest.new(device, commands)
+      @xml = Nokogiri::XML(@req.to_xml)
+    end
+
+    it "has one root node named 'Packet'" do
+      @xml.root.name.should == 'Packet'
+    end
+
+    describe "<Packet>" do
+      it "has one child node named 'Command'" do
+        @xml.root.search('/Packet/Command').size.should == 1
+      end
+
+      it "has one child node named 'DatabaseManager'" do
+        @xml.root.search('/Packet/DatabaseManager').size.should == 1
+      end
+    end
+
+    describe "<Command>" do
+      it "has a text of 'getRequest'" do
+        @xml.root.at('/Packet/Command').text.should == "myRequest"
+      end
+
+      it "has a parent node named 'Packet'" do
+        @xml.root.at('/Packet/Command').parent.name.should == "Packet"
+      end
+    end
+
+    describe "<DatabaseManager>" do
+      it "has one chile node named 'Mnet'" do
+        @xml.root.search('/Packet/DatabaseManager/Mnet').size.should == 1
+      end
+
+      it "has a parent node named 'Packet'" do
+        @xml.root.at('/Packet/DatabaseManager').parent.name.should == "Packet"
+      end
+    end
+
+    describe "<Mnet>" do
+      before(:each) do
+        @mnet = @xml.root.at('/Packet/DatabaseManager/Mnet')
+      end
+
+      it "has a 'Group' attribute with value '23'" do
+        @mnet.key?('Group').should be_true
+        @mnet.attribute('Group').value.should == "23"
+      end
+
+      it "has a 'Command1' attribute with value '*'" do
+        @mnet.key?('Command1').should be_true
+        @mnet.attribute('Command1').value.should == "*"
+      end
+
+      it "has a 'Command2' attribute with value '*'" do
+        @mnet.key?('Command2').should be_true
+        @mnet.attribute('Command2').value.should == "*"
+      end
+
+      it "has a 'Command3' attribute with value '*'" do
+        @mnet.key?('Command3').should be_true
+        @mnet.attribute('Command3').value.should == "*"
+      end
+
+      it "has a parent node named 'DatabaseManager'" do
+        @xml.root.at('/Packet/DatabaseManager/Mnet').parent.name.should == "DatabaseManager"
+      end
+    end
+  end
+end

data/spec/lib/meac_control/xml/get_request_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/xml/get_request'
+
+class Dev; end
+class Cmd; end
+
+describe MEACControl::XML::GetRequest do
+  it "inherits from the MEACControl::XML::AbstractRequest class" do
+    req = MEACControl::XML::GetRequest.new(:one, [:one, :two, :three])
+    req.should be_kind_of(MEACControl::XML::AbstractRequest)
+  end
+
+  describe "#to_xml" do
+    it "returns a xml string with 'getRequest' in the <Command> element" do
+      device = mock(Dev, :id => 23)
+      commands = [
+        mock(Cmd, :hash_for => {:Command1 => 'ON'}),
+        mock(Cmd, :hash_for => {:Command2 => 'ON'}),
+        mock(Cmd, :hash_for => {:Command3  => 'ON'})
+      ]
+      req = MEACControl::XML::GetRequest.new(device, commands)
+      xml = Nokogiri::XML(req.to_xml)
+      xml.root.at('/Packet/Command').text.should == "getRequest"
+    end
+  end
+end

data/spec/lib/meac_control/xml/response_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/xml/response'
+
+describe MEACControl::XML::Response do
+  before(:each) do
+    @string_ok = fixture_read('get-response-ok.xml')
+    @string_error = fixture_read('get-response-error.xml')
+    @request = mock('xml_request')
+  end
+
+  it "creates a response from a xml string" do
+    response = MEACControl::XML::Response.new(@string_ok)
+    response.xml.should  be_a(Nokogiri::XML::Document)
+  end
+
+  it "creates a response from a xml string and a request object" do
+    response = MEACControl::XML::Response.new(@string_ok, @request)
+    response.xml.should  be_a(Nokogiri::XML::Document)
+  end
+
+  it "will raise an error if the XML response has no root node" do
+    lambda { MEACControl::XML::Response.new('foo') }.should raise_error(MEACControl::XML::InvalidResponse)
+  end
+
+  describe "#request" do
+    it "returns the request object" do
+      response = MEACControl::XML::Response.new(@string_ok, @request)
+      response.request.should == @request
+    end
+  end
+
+  describe "#to_xml" do
+    it "returns the response xml string" do
+      response = MEACControl::XML::Response.new(@string_ok)
+      response.to_xml.should == @string_ok
+    end
+  end
+
+  describe "#ok?" do
+    it "returns true if the response has no error messages" do
+      response = MEACControl::XML::Response.new(@string_ok)
+      response.ok?.should be_true
+    end
+
+    it "returns false if the response has an error message" do
+      response = MEACControl::XML::Response.new(@string_error)
+      response.ok?.should be_false
+    end
+  end
+
+  describe "#errors?" do
+    it "returns true if the response has an error message" do
+      response = MEACControl::XML::Response.new(@string_error)
+      response.errors?.should be_true
+    end
+
+    it "returns false if the response has no error message" do
+      response = MEACControl::XML::Response.new(@string_ok)
+      response.errors?.should be_false
+    end
+  end
+
+  describe "#errors" do
+    it "returns a list of hashes with the error messages" do
+      response = MEACControl::XML::Response.new(@string_error)
+      response.errors.should == [{'Point' => 'geRequest', 'Code' => '0102', 'Message' => 'Insufficiency Attribute'}]
+    end
+  end
+
+  describe "#error_messages" do
+    it "returns a list of error message strings" do
+      response = MEACControl::XML::Response.new(@string_error)
+      response.error_messages.should == ['Insufficiency Attribute']
+    end
+  end
+end

data/spec/lib/meac_control/xml/set_request_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper'))
+require 'meac_control/xml/set_request'
+
+class Dev; end
+class Cmd; end
+
+describe MEACControl::XML::SetRequest do
+  it "inherits from the MEACControl::XML::AbstractRequest class" do
+    req = MEACControl::XML::SetRequest.new(:one, [:one, :two, :three])
+    req.should be_kind_of(MEACControl::XML::AbstractRequest)
+  end
+
+  describe "#to_xml" do
+    it "returns a xml string with 'setRequest' in the <Command> element" do
+      device = mock(Dev, :id => 23)
+      commands = [
+        mock(Cmd, :hash_for => {:Command1 => 'ON'}),
+        mock(Cmd, :hash_for => {:Command2 => 'ON'}),
+        mock(Cmd, :hash_for => {:Command3  => 'ON'})
+      ]
+      req = MEACControl::XML::SetRequest.new(device, commands)
+      xml = Nokogiri::XML(req.to_xml)
+      xml.root.at('/Packet/Command').text.should == "setRequest"
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--format specdoc
+--diff unified

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+require 'rubygems'
+require 'spec'
+
+SPEC_ROOT = Pathname(__FILE__).dirname.expand_path
+$:.unshift File.join(SPEC_ROOT.parent, 'lib')
+
+# Pull the shared examples.
+require File.join(SPEC_ROOT, 'support', 'shared_examples')
+
+def fixture_read(filename)
+  File.read(File.join(SPEC_ROOT, 'fixtures', filename))
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,5 @@
+shared_examples_for "a class that includes MEACControl::Command::Generic" do
+  it "includes MEACControl::Command::Generic" do
+    @cmd.class.ancestors.should include(MEACControl::Command::Generic)
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: meac_control
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Bernd Ahlers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Library to communicate with a Mitsubishi Electric G-50A centralized controller
+email: bernd@tuneafish.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- VERSION.yml
+- lib/meac_control.rb
+- lib/meac_control/command.rb
+- lib/meac_control/command/drive.rb
+- lib/meac_control/command/fan_speed.rb
+- lib/meac_control/command/generic.rb
+- lib/meac_control/command/inlet_temp.rb
+- lib/meac_control/device.rb
+- lib/meac_control/http.rb
+- lib/meac_control/xml.rb
+- lib/meac_control/xml/abstract_request.rb
+- lib/meac_control/xml/exceptions.rb
+- lib/meac_control/xml/get_request.rb
+- lib/meac_control/xml/response.rb
+- lib/meac_control/xml/set_request.rb
+- spec/fixtures/get-request.xml
+- spec/fixtures/get-response-error.xml
+- spec/fixtures/get-response-ok.xml
+- spec/fixtures/set-request.xml
+- spec/lib/meac_control/command/drive_spec.rb
+- spec/lib/meac_control/command/fan_speed_spec.rb
+- spec/lib/meac_control/command/generic_spec.rb
+- spec/lib/meac_control/command/inlet_temp_spec.rb
+- spec/lib/meac_control/device_spec.rb
+- spec/lib/meac_control/http_spec.rb
+- spec/lib/meac_control/xml/abstract_request_spec.rb
+- spec/lib/meac_control/xml/get_request_spec.rb
+- spec/lib/meac_control/xml/response_spec.rb
+- spec/lib/meac_control/xml/set_request_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: true
+homepage: http://github.com/bernd/meac_control
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library to communicate with a Mitsubishi Electric G-50A centralized controller
+test_files: 
+- spec/lib/meac_control/command/drive_spec.rb
+- spec/lib/meac_control/command/fan_speed_spec.rb
+- spec/lib/meac_control/command/generic_spec.rb
+- spec/lib/meac_control/command/inlet_temp_spec.rb
+- spec/lib/meac_control/http_spec.rb
+- spec/lib/meac_control/device_spec.rb
+- spec/lib/meac_control/xml/get_request_spec.rb
+- spec/lib/meac_control/xml/set_request_spec.rb
+- spec/lib/meac_control/xml/abstract_request_spec.rb
+- spec/lib/meac_control/xml/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb