aq.rb 0.2.0

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+gem 'chronic'
+gem 'nokogiri'
+  
+group :development do
+  gem 'bundler', '>= 1.0.0'
+  gem 'fakeweb'
+  gem 'jeweler'
+  gem 'mocha'
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'rb-fsevent'
+  gem 'rspec'
+  gem 'timecop'
+  gem 'vcr'
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    chronic (0.6.2)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    guard (0.6.2)
+      thor (~> 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-rspec (0.4.2)
+      guard (>= 0.4.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.12)
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rb-fsevent (0.4.3.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    thor (0.14.6)
+    timecop (0.3.5)
+    vcr (1.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  chronic
+  fakeweb
+  guard
+  guard-bundler
+  guard-rspec
+  jeweler
+  mocha
+  nokogiri
+  rb-fsevent
+  rspec
+  timecop
+  vcr

data/Guardfile

@@ -0,0 +1,18 @@
+guard 'rspec', :all_on_start => false, :all_after_pass => false, :version => 2, :keep_failed => false, :cli => "--color --format nested --drb" do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+
+  # Rails example
+  watch('spec/spec_helper.rb')                       { "spec" }
+  watch('app/controllers/application_controller.rb') { "spec/controllers" }
+  watch('config/routes.rb')                          { ["spec/routing", "spec/requests"] }
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^app/(.+)\.rb})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2010 Chuck Collins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.

data/Rakefile

@@ -0,0 +1,18 @@
+require "rake"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "aq.rb"
+    gem.summary = "Ruby library for interfacing with various aquarium controllers"
+    gem.email = "chuck.collins@gmail.com"
+    gem.homepage = "http://github.com/ccollins/aq.rb"
+    gem.authors = ["Chuck Collins"]
+    gem.files = Dir["*", "{lib}/**/*"]
+    gem.add_dependency("json")
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/aq.rb.gemspec

@@ -0,0 +1,93 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{aq.rb}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Chuck Collins}]
+  s.date = %q{2011-08-21}
+  s.email = %q{chuck.collins@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "aq.rb.gemspec",
+    "init.rb",
+    "lib/aq.rb",
+    "lib/aq/controller.rb",
+    "lib/aq/controllers/apex.rb",
+    "lib/aq/controllers/aquacontroller.rb",
+    "lib/aq/controllers/aquatronica.rb",
+    "lib/aq/controllers/reefkeeper.rb",
+    "lib/aq/manufacturers/neptune.rb",
+    "lib/aq/response.rb"
+  ]
+  s.homepage = %q{http://github.com/ccollins/aq.rb}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Ruby library for interfacing with various aquarium controllers}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<chronic>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<chronic>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<chronic>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-bundler>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<rb-fsevent>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "aq")

data/lib/aq.rb

@@ -0,0 +1,8 @@
+require 'aq/manufacturers/neptune'
+require 'aq/controller'
+require 'aq/controllers/aquacontroller'
+require 'aq/controllers/apex'
+require 'aq/controllers/aquatronica'
+require 'aq/controllers/reefkeeper'
+require 'aq/response'
+require 'net/http'

data/lib/aq/controller.rb

@@ -0,0 +1,59 @@
+module Aq
+  class Controller
+    attr_accessor :url, :status, :status_fetch_time
+  
+    def initialize(host, user='', password='', port=80)
+      @url ||= build_url(user, password, host, port)
+    end
+    
+    def fetch_status
+      @status_fetch_time = Time.now
+      status = parse_status(fetch_url(url, status_page))
+    end
+  
+    def status
+      @status || fetch_status
+    end
+    
+    def on? outlet
+      outlet.include?("ON")
+    end
+    
+    def manual?
+      false
+    end
+  
+    def number_or_string(value)
+      if value.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/) 
+        value.to_s.match(/\./) ? Float(value) : Integer(value)
+      else
+        value
+      end
+    end
+    
+    protected
+    
+    def build_url(user, password, host, port)
+      if !user.nil? && !user.empty? && !password.nil? && !password.empty?
+        "http://#{user}:#{password}@#{host}:#{port.to_s}"
+      else
+        "http://#{host}:#{port.to_s}"
+      end
+    end
+    
+    def fetch_url url, page
+      url = URI.parse(url)
+      Net::HTTP.start(url.host, url.port) do |http|
+        req = Net::HTTP::Get.new("/#{page}")
+        req.basic_auth url.user, url.password
+        response = http.request(req)
+
+        case response
+        when Net::HTTPSuccess then response.body
+        else
+          raise Exception.new(response.error!)
+        end
+      end
+    end
+  end
+end

data/lib/aq/controllers/apex.rb

@@ -0,0 +1,7 @@
+module Aq
+  module Controllers
+    class Apex < Aq::Controller
+      include Neptune
+    end
+  end
+end

data/lib/aq/controllers/aquacontroller.rb

@@ -0,0 +1,7 @@
+module Aq
+  module Controllers
+    class Aquacontroller < Aq::Controller
+      include Neptune
+    end
+  end
+end

data/lib/aq/controllers/aquatronica.rb

@@ -0,0 +1,48 @@
+module Aq
+  module Controllers
+    class Aquatronica < Aq::Controller
+      TIMER_BITMASK = 0x80
+      STATUS_BITMASK = 0x7F
+      MANUAL = 120
+    
+      def status_page
+        'rtMon.xml'
+      end
+  
+      def parse_status(raw_status)
+        parsed_status = Nokogiri::XML raw_status
+        aq_status = {:general => read_general(parsed_status), :probes => read_probes(parsed_status), 
+                     :outlets => read_outlets(parsed_status), :power => {}}
+    
+        return aq_status
+      end
+  
+      def on? outlet
+        outlet.to_i & TIMER_BITMASK != 0
+      end
+  
+      def manual? outlet
+        outlet.to_i & STATUS_BITMASK == MANUAL
+      end
+  
+      protected
+  
+      def read_general(xml)
+        {:date => status_fetch_time}
+      end
+  
+      def read_probes(xml)    
+        xml.xpath('//sensorList//sensor').map do |sensor|
+          value = sensor.at_xpath('value').text.scan(/[[:digit:]]|[[:punct:]]/).join.strip
+          {:name => sensor.at_xpath('name').text.strip, :value => number_or_string(value)}
+        end
+      end
+  
+      def read_outlets(xml)
+        xml.xpath('//plugList//plug').map do |plug|
+          {:name => plug.at_xpath('name').text.strip, :state => number_or_string(plug.at_xpath('status').text.strip)}
+        end
+      end
+    end
+  end
+end

data/lib/aq/controllers/reefkeeper.rb

@@ -0,0 +1,45 @@
+module Aq
+  module Controllers
+    class Reefkeeper < Aq::Controller
+      def status_page
+        'rss/rss.xml'
+      end
+    
+      def parse_status(raw_status)
+        parsed_status = Nokogiri::XML raw_status
+        aq_status = {:general => read_general(parsed_status), :power => {}}.merge(read_outlets_and_probes(parsed_status))
+    
+        return aq_status
+      end
+  
+      protected
+  
+      def read_outlets_and_probes(xml)
+        o_and_ps = {:probes => [], :outlets => []}
+    
+        xml.xpath('//item').each do |o_or_p|
+          if outlet? o_or_p
+            o_and_ps[:outlets].push({:name => o_or_p.at_xpath('title').text.strip, :state => clean_value(o_or_p.at_xpath('description').text)})
+          else
+            o_and_ps[:probes].push({:name => o_or_p.at_xpath('title').text.strip, :value => number_or_string(clean_value(o_or_p.at_xpath('description').text))})
+          end
+        end  
+    
+        o_and_ps 
+      end
+  
+      def outlet? node
+        node.at_xpath('description').text.include? ": ON"
+      end
+  
+      def clean_value value
+        value.strip!.gsub!(/Current Value: /, '')
+        (value.match /ON|OFF/) ? value : value.scan(/[[:digit:]]|[[:punct:]]/).join.strip
+      end
+  
+      def read_general(xml)
+        {:date => Time.strptime(xml.xpath('//pubDate').first.text.strip, "%a, %d %B %y %H:%M:%S")}
+      end
+    end
+  end
+end

data/lib/aq/manufacturers/neptune.rb

@@ -0,0 +1,45 @@
+module Neptune  
+  def status_page
+    'cgi-bin/status.xml'
+  end
+    
+  def parse_status(raw_status)
+    parsed_status = Nokogiri::XML raw_status
+    aq_status = {:general => read_general(parsed_status), :probes => read_probes(parsed_status), 
+                 :outlets => read_outlets(parsed_status), :power => read_power(parsed_status)}
+    
+    return aq_status
+  end
+  
+  protected
+  
+  def read_probes(xml)    
+    xml.xpath('//probes//probe').map do |probe|
+      {:name => probe.at_xpath('name').text, :value => number_or_string(probe.at_xpath('value').text.strip)}
+    end
+  end
+  
+  def read_outlets(xml)
+    xml.xpath('//outlets//outlet').map do |outlet|
+      {:name => outlet.at_xpath('name').text, :state => outlet.at_xpath('state').text.strip}
+    end
+  end
+  
+  def read_general(xml)
+    general = {}
+    general[:hostname] = xml.at_xpath('//hostname').text.strip
+    general[:serial] = xml.at_xpath('//serial').text.strip
+    general[:date] = Chronic.parse(xml.at_xpath('//date').text.strip)
+    
+    general
+  end
+  
+  def read_power(xml)
+    power = {}
+    
+    power[:failed] = xml.at_xpath('//power//failed').text.strip
+    power[:restored] = xml.at_xpath('//power//restored').text.strip
+    
+    power
+  end
+end

data/lib/aq/response.rb

@@ -0,0 +1,2 @@
+class Aq::Response
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: aq.rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Chuck Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: &70321982448120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70321982448120
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70321982438980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70321982438980
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70321982437420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70321982437420
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70321982436160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982436160
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70321982432920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982432920
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70321982431120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982431120
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70321982429560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982429560
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &70321982428300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982428300
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70321982425860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982425860
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70321982424760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982424760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70321982423680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982423680
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70321982422040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982422040
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70321982420260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70321982420260
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70321982418620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70321982418620
+description: 
+email: chuck.collins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- aq.rb.gemspec
+- init.rb
+- lib/aq.rb
+- lib/aq/controller.rb
+- lib/aq/controllers/apex.rb
+- lib/aq/controllers/aquacontroller.rb
+- lib/aq/controllers/aquatronica.rb
+- lib/aq/controllers/reefkeeper.rb
+- lib/aq/manufacturers/neptune.rb
+- lib/aq/response.rb
+homepage: http://github.com/ccollins/aq.rb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Ruby library for interfacing with various aquarium controllers
+test_files: []