rupower 0.1.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~
+.idea/

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in battery_linux.gemspec
+gemspec
+
+group :test, :development do
+  gem 'rake'
+  gem 'turn', :require => false
+end

data/README.md

@@ -0,0 +1,40 @@
+# Rupower
+
+Ruby interface to [UPower] tool available by default on Ubuntu and Debian distros.
+
+## Example
+
+    battery = Rupower::Battery.new
+    battery.serial          # =>   5981
+    battery.voltage         # =>  12.15     # [V]
+    battery.energy_rate:    # =>   18.97    # [W]
+    percentage:             # =>   77.36    # [%]
+    capacity:               # =>   100      # [%]
+    technology:             # =>   'lithium-ion'
+
+See the UPower documentation for full list of parameters that can be used as methods, or look at the
+acceptance tests.
+
+## Installation
+
+Add this to your Gemfile:
+
+    gem 'rupower'
+
+Then run:
+
+    bundle
+
+## Requirements
+
+ * Ruby >= 1.9.2
+
+## Running tests
+
+    bundle exec rake test
+
+## License
+
+Released under the MIT license. Copyright (C) 2012 Karol Nowicki
+
+[UPower]: http://upower.freedesktop.org

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs += ["lib"]
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/lib/rupower/command.rb

@@ -0,0 +1,16 @@
+module Rupower
+  class Command
+    def battery
+      upower( "/org/freedesktop/UPower/devices/battery_BAT0" )
+    end
+
+    def line_ac
+      upower( "/org/freedesktop/UPower/devices/line_power_AC" )
+    end
+
+    private
+      def upower( device )
+        `upower -i #{device}`
+      end
+  end
+end

data/lib/rupower/version.rb

@@ -0,0 +1,3 @@
+module Rupower
+  VERSION = "0.1.2"
+end

data/lib/rupower.rb

@@ -0,0 +1,125 @@
+require "date"
+require_relative "rupower/version"
+
+module Rupower
+
+  module Parser
+    VALUE =     Regexp.new( /(([0-9]{1,5}([.][0-9]{1,5}){0,1}).*|((\S)+))$/ )
+    TIME =      Regexp.new( /\s+\([\s\w]*\)/ )
+    NUMBER =    Regexp.new( /\A[+-]?\d+?(\.\d+)?\Z/ )
+    UNITS =     Regexp.new( /(( .{1,2})|(%))$/ )
+    AFTER_KEY = Regexp.new( /\s*:\s+[\s\S]+$/ )
+    PARAGRAPH = Regexp.new( /^\s+/ )
+    VALUABLE =  Regexp.new( /\w+:\s+\S+/ )
+  end
+
+  class PowerDevice
+    def initialize( params = {refresh_always:true} )
+      @refresh_always = params[:refresh_always]
+      @command = params[:command] || Command.new
+      refresh
+    end
+
+    def get_all
+      refresh if @refresh_always
+      get_hash
+    end
+
+    private
+      def sym_gsub( sym, before, after )
+        sym.to_s.gsub( before, after ).to_sym
+      end
+
+      def get_hash
+        @state.each_line.inject( {} ) do |hash, line|
+          key = line.gsub( Parser::AFTER_KEY, "" ).gsub( Parser::PARAGRAPH, "" ).to_sym
+          line[Parser::VALUABLE] ? hash.merge( key => get_value( line ) ) : hash
+        end
+      end
+
+      def get_value( line )
+        typize( line[Parser::VALUE].gsub( Parser::UNITS, "" ) )
+      end
+
+      def typize( value )
+        res = value
+        res = value[/^yes$/] ? true : false if value[/^(yes|no)$/]
+        res = to_number( value ) if number?( value )
+        res = to_datetime( value ) if time?( value )
+        res
+      end
+
+      def time?( value )
+        value.match( Parser::TIME )
+      end
+
+      def to_datetime( value )
+        DateTime.parse( value )
+      end
+
+      def number?( value )
+        value.match( Parser::NUMBER ) == nil ? false : true
+      end
+
+      def to_number( value )
+        value.to_f == value.to_i ? value.to_i : value.to_f
+      end
+  end
+
+  class Battery < PowerDevice
+    METHODS = [:native_path, :vendor, :model, :serial, :power_supply, :updated,
+               :has_history, :has_statistics, :present, :rechargeable, :state,
+               :energy, :energy_empty, :energy_full, :energy_full_design,
+               :energy_rate, :voltage, :percentage, :capacity, :technology]
+
+    METHODS.each do |method|
+      define_method method do
+        p method
+        name_v1 = sym_gsub( method, '_', '-' )
+        name_v2 = sym_gsub( method, '_', ' ' )
+        get_all[ name_v1 ] || get_all[ name_v2 ]
+      end
+    end
+
+    def refresh()
+      @state = @command.battery
+    end
+
+    def charging?
+      get_all[:state]["discharging"] ? false : true
+    end
+  end
+
+  class LineAc < PowerDevice
+    METHODS = [:native_path, :power_supply, :updated, :has_history, :has_statistics, :online]
+
+    METHODS.each do |method|
+      define_method method do
+        p method
+        name_v1 = sym_gsub( method, '_', '-' )
+        name_v2 = sym_gsub( method, '_', ' ' )
+        get_all[ name_v1 ] || get_all[ name_v2 ]
+      end
+    end
+
+    def refresh
+      @state = @command.line_ac
+    end
+  end
+
+  class Command
+    def battery
+      upower( "/org/freedesktop/UPower/devices/battery_BAT0" )
+    end
+
+    def line_ac
+      upower( "/org/freedesktop/UPower/devices/line_power_AC" )
+    end
+
+    private
+      def upower( device )
+        `upower -i #{device}`
+      end
+  end
+
+end

data/rupower.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rupower/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rupower"
+  s.version     = Rupower::VERSION
+  s.authors     = ["k-nowicki"]
+  s.email       = ["karol@knowicki.pl"]
+  s.homepage    = "https://github.com/k-nowicki/rupower"
+  s.summary     = %q{Rupower is UPower (http://upower.freedesktop.org) interface for Ruby.}
+  s.description = %q{Rupower is UPower (http://upower.freedesktop.org) interface for Ruby, working for Battery and AC supply.
+The main use case is to get all information providing by appropriate UPower service as parsed, hard typing hash.}
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end

data/test/acceptance/rupower_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path( "../../../lib/rupower", __FILE__ )
+require 'test/unit'
+require "turn"
+
+
+class RupowerTest < Test::Unit::TestCase
+
+  def setup
+    @battery = Rupower::Battery.new
+    @line_ac = Rupower::LineAc.new
+  end
+
+  def test_get_all_returns_correct_hash
+    assert_instance_of( Hash, @battery.get_all )
+    assert_instance_of( Hash, @line_ac.get_all )
+  end
+
+  def test_charging_returns_boolean_value
+    assert( @battery.charging? || !@battery.charging? )
+  end
+
+  def test_battery_get_methods_returns_correct_values
+    assert_instance_of( Float,  @battery.voltage )
+    assert_instance_of( String, @battery.vendor )
+    assert_instance_of( String, @battery.native_path )
+    assert_instance_of( DateTime,   @battery.updated )
+  end
+
+  def test_line_ac_get_methods_returns_correct_values
+    assert_instance_of( FalseClass, @line_ac.has_history )
+    assert_instance_of( String, @line_ac.native_path )
+    assert_instance_of( DateTime,   @line_ac.updated )
+  end
+
+  def test_battery_raise_no_method_error_given_invalid_method
+    assert_raise NoMethodError do
+      @battery.undefined_method
+    end
+  end
+
+end

data/test/fixtures/upower_battery.txt

@@ -0,0 +1,21 @@
+  native-path:          /sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:09/PNP0C09:00/PNP0C0A:00/power_supply/BAT0
+  vendor:               SONY
+  model:                42T4795
+  serial:               6804
+  power supply:         yes
+  updated:              Sun Mar 25 22:56:15 2012 (22 seconds ago)
+  has history:          yes
+  has statistics:       yes
+  battery
+    present:             yes
+    rechargeable:        yes
+    state:               fully-charged
+    energy:              62.9532 Wh
+    energy-empty:        0 Wh
+    energy-full:         63.8928 Wh
+    energy-full-design:  60.6528 Wh
+    energy-rate:         0 W
+    voltage:             12.187 V
+    percentage:          98.5294%
+    capacity:            100%
+    technology:          lithium-ion

data/test/fixtures/upower_line_ac.txt

@@ -0,0 +1,7 @@
+  native-path:          /sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:09/PNP0C09:00/ACPI0003:00/power_supply/AC
+  power supply:         yes
+  updated:              Sat Mar 24 23:47:24 2012 (79753 seconds ago)
+  has history:          no
+  has statistics:       no
+  line-power
+    online:             yes

data/test/functional/rupower_battery_test.rb

@@ -0,0 +1,97 @@
+require File.expand_path( "../../../lib/rupower", __FILE__ )
+require File.expand_path( "../../stubs/command_stub", __FILE__ )
+require 'test/unit'
+require "turn"
+
+
+class RupowerBatteryTest < Test::Unit::TestCase
+
+  def setup
+    @battery = Rupower::Battery.new( :command => CommandStub.new )
+  end
+
+  def test_native_path_returns_correct_value
+    assert_equal(
+        "/sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:09/PNP0C09:00/PNP0C0A:00/power_supply/BAT0",
+        @battery.native_path )
+  end
+
+  def test_vendor_returns_correct_value
+    assert_equal( "SONY", @battery.vendor )
+  end
+
+  def test_model_returns_correct_value
+    assert_equal( "42T4795", @battery.model )
+  end
+
+  def test_serial_returns_correct_value
+    assert_equal( 6804, @battery.serial )
+  end
+
+  def test_power_supply_returns_correct_value
+    assert_equal( true, @battery.power_supply )
+  end
+
+  def test_updated_returns_correct_value
+    assert_equal( DateTime.parse("Sun Mar 25 20:12:15 2012"), @battery.updated )
+  end
+
+  def test_has_history_returns_correct_value
+    assert_equal( true, @battery.has_history )
+  end
+
+  def test_has_statistics_returns_correct_value
+    assert_equal( true, @battery.has_statistics )
+  end
+
+  def test_present_returns_correct_value
+    assert_equal( true, @battery.present )
+  end
+
+  def test_rechargeable_returns_correct_value
+    assert_equal( true, @battery.rechargeable )
+  end
+
+  def test_state_returns_correct_value
+    assert_equal( "fully-charged", @battery.state )
+  end
+
+  def test_energy_returns_correct_value
+    assert_equal( 62.9532, @battery.energy )
+  end
+
+
+  def test_energy_empty_returns_correct_value
+    assert_equal( 0, @battery.energy_empty )
+  end
+
+  def test_energy_full_returns_correct_value
+    assert_equal( 63.8928, @battery.energy_full )
+  end
+
+  def test_energy_full_design_returns_correct_value
+    assert_equal( 60.6528, @battery.energy_full_design )
+  end
+
+  def test_energy_rate_returns_correct_value
+    assert_equal( 0, @battery.energy_rate )
+  end
+
+  def test_voltage_returns_correct_value
+    assert_equal( 12.187, @battery.voltage )
+  end
+
+  def test_percentage_returns_correct_value
+    assert_equal( 98.5294, @battery.percentage )
+  end
+
+  def test_capacity_returns_correct_value
+    assert_equal( 100, @battery.capacity )
+  end
+
+  def test_technology_returns_correct_value
+    assert_equal( "lithium-ion", @battery.technology )
+  end
+
+
+end

data/test/functional/rupower_line_ac_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path( "../../../lib/rupower", __FILE__ )
+require 'test/unit'
+require "turn"
+
+
+class RupowerLineAcTest < Test::Unit::TestCase
+
+  def setup
+    @line_ac = Rupower::LineAc.new( :command => CommandStub.new )
+  end
+
+#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+  def test_native_path_returns_correct_value
+    assert_equal(
+        "/sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:09/PNP0C09:00/ACPI0003:00/power_supply/AC",
+        @line_ac.native_path )
+  end
+
+  def test_power_supply_returns_correct_value
+    assert_equal( true, @line_ac.power_supply )
+  end
+
+  def test_updated_returns_correct_value
+    assert_equal( DateTime.parse("Sat Mar 24 20:12:24 2012"), @line_ac.updated )
+  end
+
+  def test_has_history_returns_correct_value
+    assert_equal( false, @line_ac.has_history )
+  end
+
+  def test_has_statistics_returns_correct_value
+    assert_equal( false, @line_ac.has_statistics )
+  end
+
+  def test_online_returns_correct_value
+    assert_equal( true, @line_ac.online )
+  end
+
+end

data/test/rupower_test.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+
+#load all tests
+Dir.glob( './**/*_test.rb' ).each { |test_file| require test_file }

data/test/stubs/command_stub.rb

@@ -0,0 +1,9 @@
+class CommandStub
+  def line_ac
+    File.read( File.dirname( __FILE__ ) + '/../fixtures/upower_line_ac.txt' )
+  end
+
+  def battery
+    File.read( File.dirname( __FILE__ ) + '/../fixtures/upower_battery.txt' )
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rupower
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- k-nowicki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-26 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Rupower is UPower (http://upower.freedesktop.org) interface for Ruby,
+  working for Battery and AC supply.
+
+  The main use case is to get all information providing by appropriate UPower service
+  as parsed, hard typing hash.'
+email:
+- karol@knowicki.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rupower.rb
+- lib/rupower/command.rb
+- lib/rupower/version.rb
+- rupower.gemspec
+- test/acceptance/rupower_test.rb
+- test/fixtures/upower_battery.txt
+- test/fixtures/upower_line_ac.txt
+- test/functional/rupower_battery_test.rb
+- test/functional/rupower_line_ac_test.rb
+- test/rupower_test.rb
+- test/stubs/command_stub.rb
+homepage: https://github.com/k-nowicki/rupower
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Rupower is UPower (http://upower.freedesktop.org) interface for Ruby.
+test_files:
+- test/acceptance/rupower_test.rb
+- test/fixtures/upower_battery.txt
+- test/fixtures/upower_line_ac.txt
+- test/functional/rupower_battery_test.rb
+- test/functional/rupower_line_ac_test.rb
+- test/rupower_test.rb
+- test/stubs/command_stub.rb