battery 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+log
+

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+  # Use the gem instead of a dated version bundled with Ruby
+  gem 'minitest', '2.8.1'
+  gem 'mocha'
+  gem 'activesupport', '~>3.2.0'
+  gem 'simplecov', :require => false
+end
+
+group :development do
+  gem 'rake'
+  # enhance irb
+  gem 'awesome_print', :require => false
+  gem 'pry', :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    battery (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    awesome_print (1.0.2)
+    coderay (1.0.5)
+    i18n (0.6.0)
+    metaclass (0.0.1)
+    method_source (0.7.1)
+    minitest (2.8.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.1.0)
+    pry (0.9.8.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2.0)
+  awesome_print
+  battery!
+  minitest (= 2.8.1)
+  mocha
+  pry
+  rake
+  simplecov

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Piotr 'Qertoip' Włodarek
+
+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,49 @@
+# battery
+
+API to your laptop's battery.
+
+Based on the UPower tool available by default on Ubuntu and Debian distros.
+Other data sources can be easilly added as plugins.
+
+## Example
+
+    battery = Battery.new
+    battery.energy_left          # =>   0.97  (almost fully charged)
+    battery.voltage              # =>  12.78  [V]
+    battery.charging?            # =>  true
+    battery.vendor               # =>  'Panasonic'
+    battery.update.energy_left   # =>   0.96  (notice the updated value)
+
+See the acceptance tests for the exhaustive list of examples. Don't fear to look at the code.
+
+## Installation
+
+Add this to your Gemfile:
+
+    gem 'battery'
+
+Then run:
+
+    bundle
+
+## Requirements
+
+ * Ruby 1.9.2
+
+## Running tests
+
+Run all tests:
+
+    bundle exec rake test
+
+Run only functional tests:
+
+    bundle exec rake test:functional
+
+Run only acceptance tests:
+
+    bundle exec rake test:acceptance
+
+## License
+
+Released under the MIT license. Copyright (C) 2012 Piotr 'Qertoip' Włodarek.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new( 'test:functional' ) do |t|
+  t.libs += ['test', 'lib']
+  t.pattern = FileList['test/functional/**/*_test.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new( 'test:acceptance' ) do |t|
+  t.libs += ['test', 'lib']
+  t.pattern = FileList['test/acceptance/**/*_test.rb']
+  t.verbose = true
+end
+
+desc 'Run all tests'
+task :test => ['test:functional', 'test:acceptance']
+
+task :default => :test

data/battery.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'battery/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'battery'
+  s.version     = Battery::VERSION
+  s.authors     = ['Piotr \'Qertoip\' Włodarek']
+  s.email       = ['qertoip@gmail.com']
+  s.homepage    = 'https://github.com/qertoip/battery'
+  s.summary     = %q{API to your laptop's battery.}
+  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/d

@@ -0,0 +1 @@
+bundle exec ruby test/test_console.rb

data/lib/battery.rb

@@ -0,0 +1,5 @@
+# -*- coding: UTF-8 -*-
+
+require 'battery/battery'
+require 'battery/version'
+require 'battery/upower_data_source'

data/lib/battery/battery.rb

@@ -0,0 +1,37 @@
+# -*- encoding : utf-8 -*-
+
+require 'forwardable'
+
+class Battery
+
+  extend Forwardable
+
+  attr_accessor :data_source
+
+  def initialize( options = {} )
+    self.data_source = options[:data_source] || UPowerDataSource.new
+  end
+
+  def_delegators :data_source, :energy_left,
+                               :energy_left_wh,
+                               :max_energy_wh,
+                               :design_max_energy_wh,
+                               :voltage,
+                               :charging?,
+                               :discharging?,
+                               :fully_charged?,
+                               :present?,
+                               :has_history?,
+                               :has_stats?,
+                               :vendor,
+                               :model,
+                               :serial,
+                               :technology,
+                               :last_update             # =>  DateTime of the last refresh
+
+  def update
+    data_source.update
+    self
+  end
+
+end

data/lib/battery/upower_data_source.rb

@@ -0,0 +1,115 @@
+# -*- coding: UTF-8 -*-
+
+class UPowerDataSource
+
+  attr_accessor :upower_command
+
+  def initialize( options = {} )
+    self.upower_command = options[:upower_command] || UPowerCommand.new
+    update
+  end
+
+  def vendor
+    fetch( 'vendor' )
+  end
+
+  def model
+    fetch( 'model' )
+  end
+
+  def serial
+    fetch( 'serial' )
+  end
+
+  def technology
+    fetch( 'technology' )
+  end
+
+  def last_update
+    fetch( 'updated', :as => DateTime )
+  end
+
+  def has_history?
+    fetch( 'has history', :as => Boolean )
+  end
+
+  def has_stats?
+    fetch( 'has statistics', :as => Boolean )
+  end
+
+  def present?
+    fetch( 'present', :as => Boolean )
+  end
+
+  def charging?
+    fetch( 'state' ) == 'charging'
+  end
+
+  def discharging?
+    fetch( 'state' ) == 'discharging'
+  end
+
+  def fully_charged?
+    fetch( 'state' ) == 'fully-charged'
+  end
+
+  def energy_left
+    fetch( 'percentage', :as => Float ) / 100.0
+  end
+
+  def energy_left_wh
+    fetch( 'energy', :as => Float )
+  end
+
+  def design_max_energy_wh
+    fetch( 'energy-full-design', :as => Float )
+  end
+
+  def max_energy_wh
+    fetch( 'energy-full', :as => Float )
+  end
+
+  def voltage
+    fetch( 'voltage', :as => Float )
+  end
+
+  def update
+    output = upower_command.exec
+    first_battery = output.scan( /Device:.*battery_.*\n((.|\n)+)\n(Daemon:|Device:)/ )
+    first_battery = first_battery.first.first rescue ''
+    first_battery_rows = first_battery.strip.split( /$/ ).map( &:strip ).reject{ |r| !r.include?( ':' ) }
+    first_battery_key_value_array = first_battery_rows.map{ |r| r.split( ':', 2 ) }.flatten.map( &:strip )
+    @values = Hash[*first_battery_key_value_array]
+  end
+
+  private
+
+  class UPowerCommand
+    def exec
+      `upower -d`
+    end
+  end
+
+  class Boolean
+    def self.parse( s )
+      return true if s == 'yes'
+      return false if s == 'no'
+      nil
+    end
+  end
+
+  def fetch( key, options = {} )
+    type = options[:as] || String
+    value = @values[key]
+    return nil if value.nil?
+    case type.name
+      when 'String' then value
+      when 'Float' then value.to_f
+      when 'DateTime' then DateTime.parse( value )
+      when 'UPowerDataSource::Boolean' then Boolean.parse( value )
+      when 'UPowerDataSource::Percents' then Percents.parse( value )
+      else raise "Unknown type #{type}"
+    end
+  end
+
+end

data/lib/battery/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+
+class Battery
+  VERSION = '1.0.0'
+end

data/test/acceptance/battery_test.rb

@@ -0,0 +1,36 @@
+# -*- coding: UTF-8 -*-
+
+require 'test_helper'
+
+class BatteryTest < ActiveSupport::TestCase
+
+  test '.works fine' do
+    battery = Battery.new
+
+    assert_kind_of( Float, battery.energy_left )             # =>    0.97  [means 97%]
+    assert_kind_of( Float, battery.energy_left_wh )          # =>   48.34  [Wh]
+
+    assert_kind_of( Float, battery.max_energy_wh )           # =>   56.13  [Wh]
+    assert_kind_of( Float, battery.design_max_energy_wh )    # =>   60.00  [Wh]
+
+    assert_kind_of( Float, battery.voltage )                 # =>   12.64  [V]
+
+    battery.charging?
+    battery.discharging?
+    battery.fully_charged?
+
+    battery.present?
+    battery.has_history?
+    battery.has_stats?
+
+    assert_kind_of( String, battery.vendor )                 # =>   'Panasonic'
+    assert_kind_of( String, battery.model )                  # =>   '42T4793'
+    assert_kind_of( String, battery.serial )                 # =>   '8651'
+    assert_kind_of( String, battery.technology )             # =>   'lithium-ion'
+
+    assert_kind_of( DateTime, battery.last_update )          # =>   Sun Mar 25 18:51:10 2012
+
+    battery.update.energy_left
+  end
+
+end

data/test/fixtures/upower_output.txt

@@ -0,0 +1,41 @@
+Device: /org/freedesktop/UPower/devices/line_power_AC
+  native-path:          /sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:09/PNP0C09:00/ACPI0003:00/power_supply/AC
+  power supply:         yes
+  updated:              Sun Mar 25 15:46:05 2012 (11108 seconds ago)
+  has history:          no
+  has statistics:       no
+  line-power
+    online:             yes
+
+Device: /org/freedesktop/UPower/devices/battery_BAT0
+  native-path:          /sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:09/PNP0C09:00/PNP0C0A:00/power_supply/BAT0
+  vendor:               Panasonic
+  model:                42T4793
+  serial:               8651
+  power supply:         yes
+  updated:              Sun Mar 25 18:51:10 2012 (3 seconds ago)
+  has history:          yes
+  has statistics:       no
+  battery
+    present:             yes
+    rechargeable:        yes
+    state:               fully-charged
+    energy:              49.87 Wh
+    energy-empty:        0 Wh
+    energy-full:         50.16 Wh
+    energy-full-design:  56.16 Wh
+    energy-rate:         0 W
+    voltage:             12.504 V
+    percentage:          99.4219%
+    capacity:            89.3162%
+    technology:          lithium-ion
+
+Daemon:
+  daemon-version:  0.9.13
+  can-suspend:     yes
+  can-hibernate    yes
+  on-battery:      no
+  on-low-battery:  no
+  lid-is-closed:   no
+  lid-is-present:  yes
+  is-docked:       no

data/test/functional/battery_test.rb

@@ -0,0 +1,105 @@
+# -*- coding: UTF-8 -*-
+
+require 'test_helper'
+
+class BatteryTest < ActiveSupport::TestCase
+
+  class UPowerCommandStub
+    def exec
+      File.read( File.dirname( __FILE__ ) + '/../fixtures/upower_output.txt' )
+    end
+  end
+
+  setup do
+    data_source = UPowerDataSource.new( :upower_command => UPowerCommandStub.new )
+    @battery = Battery.new( :data_source => data_source )
+  end
+
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+  test '.energy_left' do
+    assert_equal( 0.994219, @battery.energy_left )
+  end
+
+  test '.energy_left_wh' do
+    assert_equal( 49.87, @battery.energy_left_wh )
+  end
+
+  test '.max_energy_wh' do
+    assert_equal( 50.16, @battery.max_energy_wh )
+  end
+
+  test '.design_max_energy_wh' do
+    assert_equal( 56.16, @battery.design_max_energy_wh )
+  end
+
+  test '.voltage' do
+    assert_equal( 12.504, @battery.voltage )
+  end
+
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+  test '.discharging?' do
+    refute( @battery.discharging? )
+  end
+
+  test '.charging?' do
+    refute( @battery.charging? )
+  end
+
+  test 'fully_charged?' do
+    assert( @battery.fully_charged? )
+  end
+
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+  test '.has_history?' do
+    assert( @battery.has_history? )
+  end
+
+  test '.has_stats?' do
+    refute( @battery.has_stats? )
+  end
+
+  test '.present?' do
+    assert( @battery.present? )
+  end
+
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+  test '.vendor' do
+    assert_equal( 'Panasonic', @battery.vendor )
+  end
+
+  test '.model' do
+    assert_equal( '42T4793', @battery.model )
+  end
+
+  test '.serial' do
+    assert_equal( '8651', @battery.serial )
+  end
+
+  test '.technology' do
+    assert_equal( 'lithium-ion', @battery.technology )
+  end
+
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+  test '.last_update' do
+    assert_equal( DateTime.parse( 'Sun Mar 25 18:51:10 2012' ), @battery.last_update )
+  end
+
+  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+  test '.update updates the state' do
+    data_source = UPowerDataSource.new( :upower_command => UPowerCommandStub.new )
+    battery = Battery.new( :data_source => data_source )
+    data_source.expects( :update )
+    battery.update
+  end
+
+  test '.update returns Battery' do
+    assert_kind_of( Battery, @battery.update )
+  end
+
+end

data/test/library_setup.rb

@@ -0,0 +1,3 @@
+# -*- encoding : utf-8 -*-
+
+require 'battery'

data/test/test_console.rb

@@ -0,0 +1,13 @@
+# -*- encoding : utf-8 -*-
+
+# Ensure that LOAD_PATH is the same as when running "rake test"; normally rake takes care of that
+$LOAD_PATH << File.expand_path( ".", File.dirname( __FILE__ ) )
+$LOAD_PATH << File.expand_path( "./lib", File.dirname( __FILE__ ) )
+$LOAD_PATH << File.expand_path( "./test", File.dirname( __FILE__ ) )
+
+# Boot the app
+require_relative 'library_setup'
+
+# Fire the console
+require 'pry'
+binding.pry

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+
+# Load test coverage tool (must be loaded before any code)
+#require 'simplecov'
+#SimpleCov.start do
+#  add_filter '/test/'
+#  add_filter '/config/'
+#end
+
+# Load and initialize the application to be tested
+require 'library_setup'
+
+require 'active_support/test_case'
+
+# Load test frameworks
+require 'minitest/autorun'

data/test/test_runner.rb

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: battery
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Piotr 'Qertoip' Włodarek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-25 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- qertoip@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- battery.gemspec
+- d
+- lib/battery.rb
+- lib/battery/battery.rb
+- lib/battery/upower_data_source.rb
+- lib/battery/version.rb
+- test/acceptance/battery_test.rb
+- test/fixtures/upower_output.txt
+- test/functional/battery_test.rb
+- test/library_setup.rb
+- test/test_console.rb
+- test/test_helper.rb
+- test/test_runner.rb
+homepage: https://github.com/qertoip/battery
+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.11
+signing_key: 
+specification_version: 3
+summary: API to your laptop's battery.
+test_files: []