apc4r 0.1

data/README.markdown

@@ -0,0 +1,29 @@
+#apc4r - A simple library for accessing power information from an APC UPS device
+
+##Installation
+
+	gem install apc4r -s http://gemcutter.org
+
+## Examples
+
+  #create a new status class with a cache ttl of 60 seconds
+	status = Apc4r::Status.new 60
+
+	#print the load percentage
+	puts status.loadpct
+	
+	#print the estimated load in watts
+	puts status.estimated_load
+	
+	#print all available fields of the APC device
+	status.status.each_pair do |field, value|
+	  puts "#{field} -> #{value}"
+	end
+
+##Requirements
+
+* An APC UPS Battery backup device connected to a ruby-enabled host
+* apcupsd installed and running
+
+##Dependencies
+- Just apcupsd

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run All Specs"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end
+

data/apc4r.gemspec

@@ -0,0 +1,23 @@
+spec = Gem::Specification.new do |s|
+	s.name = 'apc4r'
+	s.version = '0.1'
+	s.date = '2010-08-29'
+	s.summary = 'A simple library for accessing power information from an APC UPS device'
+	s.email = 'dan.simpson@gmail.com'
+	s.homepage = 'http://github.com/dansimpson/apc4r'
+	s.description = 'A simple library for accessing power information from an APC UPS device.  Requires apcupsd.'
+	s.has_rdoc = true
+	
+	s.authors = ['Dan Simpson']
+
+	s.files = [
+	  'README.markdown',
+	  'apc4r.gemspec',
+	  'Rakefile',
+    'spec/helper.rb',
+    'spec/apc4r_spec.rb',
+    'spec/apc4r_status_spec.rb',
+    'lib/apc4r.rb',
+    'lib/apc4r/status.rb'
+	]
+end

data/lib/apc4r.rb

@@ -0,0 +1,13 @@
+module Apc4r
+
+  VERSION = 0.1
+
+  ##
+  # print the status of the UPS device
+  def self.print_status
+    puts Status.new
+  end
+
+end
+
+require "apc4r/status"

data/lib/apc4r/status.rb

@@ -0,0 +1,87 @@
+module Apc4r
+
+  ##
+  # Apc4r::Status is simple class for accessing power information from an APC UPS device
+  # 
+  # The running machine must have apcupsd installed and running for
+  # this library to function
+  #
+  # = Example
+  #   
+  #   status = Apc4r::Status.new 60
+  #   puts status.to_s 
+  class Status
+
+    ##
+    # Creates a Status object, which gives access to information
+    # related to the connected UPS device
+    #
+    # +cache_ttl+ is the number of seconds to cache status on an object
+    # leave blank to fetch information from the ups device on every call
+    def initialize cache_ttl=0
+      @cache_ttl = cache_ttl
+    end
+  
+    ##
+    # fetches a hash of status information from the UPS device
+    def status
+      if @cache_ttl > 0
+        if @cached_at == nil || @cached_at < (Time.now - @cache_ttl)
+          @status = fetch_status
+        end
+      else
+        @status = fetch_status
+      end
+      @status
+    end
+    
+    ##
+    # estimates the load, in watts, based on loadpct and nompower
+    # This may not be even close to accurate
+    def estimated_load
+      (loadpct / 100) * nompower
+    end
+
+    ##
+    # fetches a string represention of the UPS status
+    def to_s
+      result = ""
+      status.each_pair do |k,v|
+        result << "#{k} = #{v}\n"
+      end
+      result
+    end
+      
+    def method_missing sym, *args
+      if status.has_key?(sym)
+        status[sym]
+      else
+        super
+      end
+    end
+  
+    private
+  
+    def fetch_status
+      
+      dump = `apcaccess`
+      if dump =~ /Error/i
+        raise "apcupsd is not running.  Please start apcupsd."
+      end
+      
+      result = {}
+      lines  = dump.split("\n")
+      lines.each do |line|
+        key, value = line.split(":").collect(&:strip)
+        
+        if value =~ /^([0-9]*[\.]?[0-9]+)\s/
+          value = $1.to_f
+        end
+        
+        result[key.gsub(" ","_").downcase.to_sym] = value
+      end
+      result
+    end
+    
+  end
+end

data/spec/apc4r_spec.rb

@@ -0,0 +1,14 @@
+require "helper"
+
+describe Apc4r do
+  
+  it "should have a version" do
+    Apc4r.const_defined?("VERSION").should == true
+  end
+  
+  it "should respond to print_status" do
+    Apc4r.should respond_to :print_status
+  end
+  
+end
+

data/spec/apc4r_status_spec.rb

@@ -0,0 +1,13 @@
+require "helper"
+
+describe Apc4r::Status do
+  
+  before do
+    @status = Apc4r::Status.new 60
+  end
+  
+  it "should have a load percentage" do
+    @status.loadpct.should be_a_kind_of Float
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib/")
+
+require "apc4r"
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: apc4r
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Dan Simpson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A simple library for accessing power information from an APC UPS device.  Requires apcupsd.
+email: dan.simpson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- apc4r.gemspec
+- Rakefile
+- spec/helper.rb
+- spec/apc4r_spec.rb
+- spec/apc4r_status_spec.rb
+- lib/apc4r.rb
+- lib/apc4r/status.rb
+has_rdoc: true
+homepage: http://github.com/dansimpson/apc4r
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple library for accessing power information from an APC UPS device
+test_files: []
+