neptune_apex 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc8ffa43bd65e6f68071b9c4c88d08b5733ff076
+  data.tar.gz: d36aa42af0b4e5f7d3f638d1a913d065a5eef6e2
+SHA512:
+  metadata.gz: 43318cb0eb0bd69592bf38459427cc5bf4772e9d287f7e6b67909e0c957cd7a341c6c792f46da957ad2c7a1165602e17c0c934e235ea999e548e202c05ad8680
+  data.tar.gz: ae125a0da2674874e2c0accb60bbedcf4e3b9ae6f2424aa3d86a6c18700ec0a6e356320ee7113076fc12066d676bc8de4e07caaac3b2f83128c213e6fa61c6df

data/.gitignore

@@ -0,0 +1,15 @@
+*.swp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apex.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Scott Peshak
+
+MIT License
+
+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/README.md

@@ -0,0 +1,35 @@
+# NeptuneApex
+
+A Ruby Gem for interacting with a Neptune Apex aquarium controller.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'neptune_apex'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neptune_apex
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Legal
+
+This module is in no way affiliated with Neptune Systems, the maker of the Apex controller.
+
+## Contributing
+
+1. Fork it ( https://github.com/speshak/apex/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+

data/bin/apex

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'neptune_apex/cli/main'
+
+NeptuneApex::Cli::Main.start(ARGV)

data/lib/neptune_apex/cli/main.rb

@@ -0,0 +1,44 @@
+require 'neptune_apex'
+require 'thor'
+require 'terminal-table'
+
+require_relative 'profile'
+
+module NeptuneApex
+  module Cli
+    class Main < Thor
+      desc "status", "Get current status of controller outlets & probes"
+      def status
+        cont = NeptuneApex::Controller.new()
+        status = cont.status
+
+        puts "Apex status as of #{status.date.strftime('%F %R')}"
+
+        puts Terminal::Table.new :headings => ['Probe', 'Value'] {|t|
+          status.probes.each{|name, probe|
+            t << [name, probe[:value].to_s('F')]
+          }
+        }
+
+        puts "\n"
+
+        puts Terminal::Table.new :headings => ['Outlet', 'State'] {|t|
+          status.outlets.each{|name, outlet|
+            t << [name, outlet[:state]]
+          }
+        }
+
+      end
+
+
+
+      desc "datalog", "Get datalog values"
+      def datalog
+        puts "Not yet implemented"
+      end
+
+      desc "profile SUBCOMMAND", "manage profiles"
+      subcommand "profile", ProfileCli
+    end
+  end
+end

data/lib/neptune_apex/cli/profile.rb

@@ -0,0 +1,19 @@
+require 'thor'
+
+module NeptuneApex
+  module Cli
+    class ProfileCli < Thor
+      desc "export <name>", "Exports profile named <name>"
+      def export(name)
+        puts "Not yet implemented"
+      end
+
+
+      desc "import <name>", "Imports a profile named <name>.  Overwrites existing profile of the same name."
+      def import(name)
+        puts "Not yet implemented"
+      end
+    end
+  end
+end
+

data/lib/neptune_apex/controller.rb

@@ -0,0 +1,70 @@
+require 'open-uri'
+require 'yaml'
+require 'httpclient'
+
+module NeptuneApex
+  class Controller
+    # Controller URL
+    attr_accessor :url
+
+    # Controller username
+    attr_accessor :user
+
+    # Controller password
+    attr_accessor :password
+
+
+    def initialize(url=nil)
+      load_conf
+
+      if url
+        @url = url
+      end
+    end
+
+    ##
+    # Look for a config file & load
+    def load_conf
+      conf_file = File.expand_path('~/.apexcli')
+
+      if ENV['APEXCONF']
+        conf_file = ENV['APEXCONF']
+      end
+
+      if File.exist?(conf_file)
+        conf = YAML.load_file(conf_file)
+        @url = conf['url']
+        @user = conf['user']
+        @password = conf['password']
+      else
+        raise Exception.new('Config file not found!')
+      end
+    end
+
+
+    ##
+    # Get the current status of the controller
+    def status
+      Status.from_xml(open("#{@url}/cgi-bin/status.xml"))
+    end
+
+
+    ##
+    # Get the datalog from the controller
+    def datalog
+      Datalog.from_xml(open("#{@url}/cgi-bin/datalog.xml"))
+    end
+
+
+    # Get a prepared UserAgent
+    def user_agent
+      unless @user_agent
+        @user_agent = HTTPClient.new
+        @user_agent.set_auth(@url, @user, @password)
+      end
+
+      @user_agent
+    end
+
+  end
+end

data/lib/neptune_apex/datalog.rb

@@ -0,0 +1,30 @@
+require "nokogiri"
+
+module NeptuneApex
+  class Datalog
+    attr_accessor :records
+
+    def initialize
+      @records = {}
+    end
+
+
+    def read_xml(xml)
+      doc = Nokogiri::XML(xml)
+
+      doc.xpath('//datalog/record').each{|record|
+        stat = Status.new
+
+        record.xpath('./probe').each{|probe|
+          stat.add_probe(
+            probe.at_xpath('./name').text,
+            probe.at_xpath('./value').text,
+            probe.at_xpath('./type').text
+          )
+        }
+
+        @records[record.at_xpath('./date').text] = stat
+      }
+    end
+  end
+end

data/lib/neptune_apex/profiles/base.rb

@@ -0,0 +1,8 @@
+module Apex
+  module Profile
+    class Base
+      attr_accessor :name
+      attr_reader :type
+    end
+  end
+end

data/lib/neptune_apex/profiles/vega.rb

@@ -0,0 +1,18 @@
+module Apex
+  module Profile
+    # An AI Vega/Hydra LED light profile
+    class Vega < Base
+      # Colors
+      attr_accessor :cWhite, :wWhite, :nWhite, :green, :violet, :red, :dBlue, :rBlue, :UV, :blue
+
+      # Parameters
+      attr_accessor :min, :max, :rampTime
+
+
+      def initialize
+        @type = 'vega'
+      end
+
+    end
+  end
+end

data/lib/neptune_apex/status.rb

@@ -0,0 +1,60 @@
+require 'bigdecimal'
+require "nokogiri"
+
+module NeptuneApex
+  class Status
+    attr_accessor :date, :power, :probes, :outlets
+
+    def self.from_xml(data)
+      status = Status.new
+      status.read_xml(data)
+      return status
+    end
+
+
+    def initialize
+      @probes = {}
+      @outlets = {}
+    end
+
+
+    def read_xml(xml)
+      doc = Nokogiri::XML(xml)
+
+      @date = Date.strptime(doc.at_xpath('//status/date').text, '%m/%d/%Y %H:%M:%s')
+
+      doc.xpath('//status/probes/probe').each{|probe|
+        add_probe(
+          probe.at_xpath('./name').text,
+          probe.at_xpath('./value').text,
+          probe.at_xpath('./type').text
+        )
+      }
+
+
+      doc.xpath('//status/outlets/outlet').each{|outlet|
+        add_outlet(
+          outlet.at_xpath('./name').text,
+          outlet.at_xpath('./outputID').text,
+          outlet.at_xpath('./state').text,
+          outlet.at_xpath('./deviceID').text
+        )
+      }
+    end
+
+
+    def add_probe(name, value, type)
+      @probes[name] = { :value => BigDecimal.new(value), :type => type }
+    end
+
+
+    def add_outlet(name, id, state, device_id)
+      @outlets[name] = {
+        :id     => id,
+        :state    => state,
+        :device_id  => device_id,
+      }
+    end
+
+  end
+end

data/lib/neptune_apex/version.rb

@@ -0,0 +1,3 @@
+module NeptuneApex
+  VERSION = "0.4"
+end

data/lib/neptune_apex.rb

@@ -0,0 +1,14 @@
+# Class for interacting with a Neptune Systems Apex aquarium controller.
+#
+# Author:: Scott Peshak (mailto:scott@peshak.net)
+# Copyright:: Copyright (c) 2014 Scott Peshak
+
+require "neptune_apex/version"
+require "neptune_apex/controller"
+require "neptune_apex/status"
+require "neptune_apex/datalog"
+
+
+module NeptuneApex
+
+end

data/neptune_apex.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'neptune_apex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "neptune_apex"
+  spec.version       = NeptuneApex::VERSION
+  spec.authors       = ["Scott Peshak"]
+  spec.email         = ["scott@peshak.net"]
+  spec.summary       = %q{Gem for interacting with a Neptune Apex aquarium controller.}
+  spec.homepage      = "https://github.com/speshak/apex"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.executables << "apex"
+
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "terminal-table", "~> 1.5"
+  spec.add_dependency "httpclient", "~> 2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

data/spec/lib/controller_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe NeptuneApex::Controller, '#status' do
+  it "returns status object" do
+    apex = NeptuneApex::Controller.new('http://apex.peshak.net')
+
+# status = apex.status
+  end
+end

data/spec/lib/datalog_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe NeptuneApex::Datalog, "#read_xml" do
+	it "reads xml data into structures" do
+		datalog = NeptuneApex::Datalog.new
+		datalog.read_xml(File.open(File.expand_path('../../../test-data/datalog.xml', __FILE__)))
+
+		expect(datalog.records['11/02/2014 00:10:00'].probes['Temp'][:value]).to eq(BigDecimal.new('75.5'))
+	end
+end
+

data/spec/lib/neptune_apex_spec.rb

@@ -0,0 +1,2 @@
+require 'spec_helper'
+

data/spec/lib/status_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'bigdecimal'
+
+describe NeptuneApex::Status, '#read_xml' do
+	it "reads xml data into structures" do
+		status = NeptuneApex::Status.new
+		status.read_xml(File.open(File.expand_path('../../../test-data/status.xml', __FILE__)))
+
+		expect(status.date).to eq(Date.strptime('12/29/2013 19:14:58', '%m/%d/%Y %H:%M:%s'))
+
+		expect(status.probes['Temp'][:value]).to eq(BigDecimal.new('77.6'))
+		expect(status.outlets['VarSpd3_I3'][:state]).to eq('OFF')
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'neptune_apex'