gembird-backend 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - ree

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+# rspec
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jens Bissinger
+
+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,59 @@
+# GembirdBackend
+
+This is a wrapper to provide ruby API for `sispmctl` script.
+
+More info at the [sispmctl project page](http://sispmctl.sourceforge.net/).
+
+[![Travis-CI Build Status](https://secure.travis-ci.org/dpree/gembird-backend.png)](https://secure.travis-ci.org/dpree/gembird-backend)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem gembird-backend
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install gembird-backend
+
+## Usage
+
+**List all connected devices**
+
+    require 'gembird-backend'
+    
+    GembirdBackend.devices
+    # => [{:number=>"0",
+    #      :usb_device=>"001",
+    #      :usb_bus=>"004",
+    #      :type=>"4-socket SiS-PM",
+    #      :serial=>"02:01:48:af:e0"}]
+    
+    require 'gembird-backend'
+
+**Check the status of the sockets for every connected device**
+
+    require 'gembird-backend'
+    GembirdBackend.socket
+    # => [{:number=>"0",
+    #      :usb_device => "003",
+    #      :sockets=>{"1"=>"on",
+    #                 "2"=>"off",
+    #                 "3"=>"on",
+    #                 "4"=>"off"}}]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+see LICENSE file

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/gembird-backend.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gembird-backend/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jens Bissinger"]
+  gem.email         = ["mail@jens-bissinger.de"]
+  gem.description   = %q{Wrapper around sispmctl script}
+  gem.summary       = %q{Provides an API to control Gembird USB power strips}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gembird-backend"
+  gem.require_paths = ["lib"]
+  gem.version       = GembirdBackend::VERSION
+  
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "rake"
+  
+end

data/lib/gembird-backend.rb

@@ -0,0 +1,54 @@
+require "logger"
+require File.join(File.dirname(__FILE__), "gembird-backend/scanner")
+require File.join(File.dirname(__FILE__), "gembird-backend/parser")
+require File.join(File.dirname(__FILE__), "gembird-backend/command")
+require File.join(File.dirname(__FILE__), "gembird-backend/retry")
+module GembirdBackend
+  # when error occurs
+  class ExecutionError < StandardError; end
+  
+  class << self
+    def logger
+      @logger ||= Logger.new(open('/dev/null', "w+"))
+    end
+    
+    def parse result
+      @parser ||= GembirdBackend::Parser.new
+      @parser.parse result
+    end
+    
+    def command
+      @command ||= GembirdBackend::Command.new
+    end
+    
+    def try &block
+      @retry ||= GembirdBackend::Retry.new
+      @retry.try &block
+    end
+    
+    # @see GembirdBackend::Command#devices
+    def devices
+      try { parse command.devices }
+    end
+    
+    # @see GembirdBackend::Command#on!
+    def on! socket='all', options={}
+      try { parse command.on! socket, options }
+    end
+    
+    # @see GembirdBackend::Command#off!
+    def off! socket='all', options={}
+      try { parse command.off! socket, options }
+    end
+    
+    # @see GembirdBackend::Command#toggle!
+    def toggle! socket='all', options={}
+      try { parse command.toggle! socket, options }
+    end
+    
+    # @see GembirdBackend::Command#status
+    def status socket='all', options={}
+      try { parse command.status socket, options }
+    end
+  end
+end

data/lib/gembird-backend/command.rb

@@ -0,0 +1,78 @@
+module GembirdBackend
+  class Command
+    BIN = 'sispmctl' # the sispmctl binary
+    
+    # set dry to true for testing purposes
+    attr_reader :dry
+    def initialize dry=false
+      @dry = dry
+    end
+    
+    def call action, argument = nil, options = {}
+      args = []
+      if device = options[:device]
+        # serial or number
+        args << (device.to_s.include?(":") ? "-D" : "-d")
+        args << device
+      end
+      args << (argument ? [action, argument] : action)
+      command = build args
+      dry ? command : exec(command)
+    end
+    
+    def build *options
+      [BIN, options].flatten.join ' '
+    end
+    
+    def exec command
+      `#{command}`
+    end
+    
+    # scans for devices
+    # @return [Array<Hash>] devices
+    # @example return
+    #     [{:number=>"0",
+    #       :usb_device=>"001",
+    #       :usb_bus=>"004",
+    #       :type=>"4-socket SiS-PM",
+    #       :serial=>"02:01:48:af:e0"}]
+    def devices
+      call '-s'
+    end
+    
+    # switch a socket on
+    # @return [Array<Hash>] devices
+    # @see #status example return values
+    def on! socket='all', options={}
+      call '-o', socket, options
+    end
+    
+    # switch a socket off
+    # @return [Array<Hash>] devices
+    # @see #status example return values
+    def off! socket='all', options={}
+      call '-f', socket, options
+    end
+    
+    # toggle a socket
+    # @return [Array<Hash>] devices
+    # @see #status example return values
+    def toggle! socket='all', options={}
+      call '-t', socket, options
+    end
+    
+    # get the status of a socket
+    # @return [Array<Hash>] devices
+    # @example return
+    #     [{:number=>"0",
+    #       :usb_device => "003",
+    #       :sockets=>{"1"=>"on",
+    #                  "2"=>"off",
+    #                  "3"=>"on",
+    #                  "4"=>"off"}}]
+    #       :sockets=>{"1"=>"on", "2"=>"off", "3"=>"on", "4"=>"off"}}]
+    def status socket='all', options={}
+      call '-g', socket, options
+    end
+  end
+end

data/lib/gembird-backend/parser.rb

@@ -0,0 +1,34 @@
+module GembirdBackend
+  class Parser
+    # @param [String] result
+    # @return [Array] stack of parsed result
+    def parse result
+      tokens = GembirdBackend::Scanner.new.scan result
+      stack = []
+      tokens.each do |token, *args|
+        case token
+          when :begin_device
+            stack << {}
+            stack.last[:number] = args.first.first
+          when :device_type
+            stack.last[:type] = args.first.first
+          when :device_serial
+            stack.last[:serial] = args.first.first
+          when :usb_info
+            stack.last[:usb_device] = args.first
+            stack.last[:usb_bus] = args.last
+          when :accessing_device
+            stack << {}
+            stack.last[:number] = args.first
+            stack.last[:usb_device] = args.last
+          when :socket_status
+            stack.last[:sockets] ||= {}
+            stack.last[:sockets][args.first] = args.last
+          when :error
+            raise GembirdBackend::ExecutionError, args.first
+        end
+      end
+      stack
+    end
+  end
+end

data/lib/gembird-backend/retry.rb

@@ -0,0 +1,30 @@
+module GembirdBackend
+  class Retry
+    attr_reader :delay
+    def initialize(delay = true)
+      @delay = delay
+    end
+    
+    # try to make a successful call
+    # retry n times in case of error
+    # @param [Fixnum] n
+    def try(n = 3, &block)
+      try = lambda do
+        begin
+          block.call
+        rescue ExecutionError => e
+          GembirdBackend.logger.warn "retrying... #{e}"
+          nil
+        end
+      end
+      sleep_time = 0
+      n.times do
+        result = try.call
+        return result if result
+        sleep (2 ** sleep_time) if delay
+        sleep_time += 1
+      end
+      nil
+    end
+  end
+end

data/lib/gembird-backend/scanner.rb

@@ -0,0 +1,44 @@
+module GembirdBackend
+  class Scanner
+    # @param [String] result
+    # @return [Array] tokens
+    def scan result
+      tokens = []
+      result.split("\n").each do |line|
+        
+        ### socket
+        if matched = line.match(/^Accessing Gembird #(.+) USB device (.+)$/)
+          device_number, usb_device = *matched.captures
+          tokens << [:accessing_device, device_number, usb_device]
+        elsif matched = line.match(/outlet.+?(\d+).+?(on|off)/)
+          socket_number, status = *matched.captures
+          tokens << [:socket_status, socket_number, status]
+        
+        ### device
+        elsif matched = line.match(/^Gembird #(.+)$/)
+          device_number = *matched.captures
+          tokens << [:begin_device, device_number]
+        elsif matched = line.match(/device type:\s+(.+)/)
+          device_type = *matched.captures
+          tokens << [:device_type, device_type]
+        elsif matched = line.match(/serial number:\s+(.+)/)
+          device_serial = *matched.captures
+          tokens << [:device_serial, device_serial]
+        elsif matched = line.match(/USB information:\s+bus (.+), device (.+)/)
+          usb_bus, usb_device = *matched.captures
+          tokens << [:usb_info, usb_device, usb_bus]
+        
+        ### error
+        elsif line =~ /error/i || line =~ /Check USB connections/
+          tokens << [:error, result]
+        elsif line =~ /Invalid number or given device not found/ ||
+              line =~ /No device with serial number/
+          tokens << [:device_not_found]
+        else
+          # noop
+        end
+      end
+      tokens
+    end
+  end
+end

data/lib/gembird-backend/version.rb

@@ -0,0 +1,3 @@
+module GembirdBackend
+  VERSION = "0.0.1"
+end

data/spec/assets/sispmctl/device-not-found.txt

@@ -0,0 +1,2 @@
+Invalid number or given device not found.
+Terminating

data/spec/assets/sispmctl/devices.txt

@@ -0,0 +1,4 @@
+Gembird #0
+USB information:  bus 004, device 001
+device type:      4-socket SiS-PM
+serial number:    02:01:48:af:e0

data/spec/assets/sispmctl/no-connection.txt

@@ -0,0 +1 @@
+No GEMBIRD SiS-PM found. Check USB connections, please!

data/spec/assets/sispmctl/socket-status-error.txt

@@ -0,0 +1,5 @@
+Accessing Gembird #0 USB device 003
+Status of outlet 1:	off
+Error performing requested action
+Libusb error string: Operation timed out
+Terminating

data/spec/assets/sispmctl/socket-status.txt

@@ -0,0 +1,5 @@
+Accessing Gembird #0 USB device 003
+Status of outlet 1:	on
+Status of outlet 2:	off
+Status of outlet 3:	on
+Status of outlet 4:	off

data/spec/assets/sispmctl/wrong-serial.txt

@@ -0,0 +1,2 @@
+No device with serial number foobar123 found.
+Terminating

data/spec/lib/gembird-backend/command_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+describe GembirdBackend::Command do
+  before :each do
+    @command = GembirdBackend::Command.new(true)
+  end
+  
+  it 'builds empty command' do
+    @command.build.should == 'sispmctl'
+  end
+  
+  it 'builds any command' do
+    @command.build('foo', 'bar').should == 'sispmctl foo bar'
+  end
+  
+  describe '#devices' do
+    it 'scans all' do
+      @command.devices.should == 'sispmctl -s'
+    end
+  end
+  
+  describe '#status' do
+    it 'retrieves all' do
+      @command.status.should == 'sispmctl -g all'
+    end
+    it 'retrieves single' do
+      @command.status(1).should == 'sispmctl -g 1'
+    end
+    it 'retrieves single for device' do
+      @command.status(1, :device=>"aa:bb").should == 'sispmctl -D aa:bb -g 1'
+    end
+  end
+  
+  describe '#on!' do
+    it 'switches all on' do
+      @command.on!.should == 'sispmctl -o all'
+    end
+    it 'switches single on' do
+      @command.on!(1).should == 'sispmctl -o 1'
+    end
+    it 'switches single for device' do
+      @command.on!(1, :device=>"123").should == 'sispmctl -d 123 -o 1'
+    end
+  end
+  
+  describe '#off!' do
+    it 'switches all off' do
+      @command.off!.should == 'sispmctl -f all'
+    end
+    it 'switches single off' do
+      @command.off!(1).should == 'sispmctl -f 1'
+    end
+    it 'switches single for device off' do
+      @command.off!(1, :device=>1).should == 'sispmctl -d 1 -f 1'
+    end
+  end
+  
+  describe '#toggle!' do
+    it 'toggles all' do
+      @command.toggle!.should == 'sispmctl -t all'
+    end
+    it 'toggles single' do
+      @command.toggle!(1).should == 'sispmctl -t 1'
+    end
+    it 'toggles single for device' do
+      @command.toggle!(1, :device=>1).should == 'sispmctl -d 1 -t 1'
+    end
+  end
+end
+  

data/spec/lib/gembird-backend/parser_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe GembirdBackend::Parser do
+  before :each do
+    @parser = GembirdBackend::Parser.new
+  end
+  
+  it 'lists all devices' do
+    @parser.parse(command_result('devices.txt')).should == \
+      [{:number=>"0", :usb_device=>"001", :usb_bus=>"004",
+       :type=>"4-socket SiS-PM", :serial=>"02:01:48:af:e0"}]
+  end
+  
+  it 'lists all sockets' do
+    @parser.parse(command_result('socket-status.txt')).should == \
+      [{:number=>"0", :usb_device => "003",
+        :sockets=>{"1"=>"on", "2"=>"off", "3"=>"on", "4"=>"off"}}]
+  end
+  
+  it 'detects error' do
+    lambda do
+      @parser.parse(command_result('socket-status-error.txt'))
+    end.should raise_error(GembirdBackend::ExecutionError)
+  end
+  
+  it 'detects connection loss' do
+    lambda do
+      @parser.parse(command_result('no-connection.txt'))
+    end.should raise_error(GembirdBackend::ExecutionError)
+  end
+end

data/spec/lib/gembird-backend_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe GembirdBackend do
+  before :each do
+    GembirdBackend.instance_variable_set('@retry', GembirdBackend::Retry.new(false))
+    class CommandMock < GembirdBackend::Command
+      attr_accessor :exec_count
+      def exec command
+        self.exec_count ||= 0
+        self.exec_count += 1
+        case command
+        when /-g/
+          command_result('socket-status.txt')
+        else
+          command_result('socket-status-error.txt')
+        end
+      end
+    end
+    @mock = CommandMock.new
+    GembirdBackend.instance_variable_set("@command", @mock)
+  end
+  
+  it 'should try 3 times' do
+    GembirdBackend.on!.should be_nil
+    @mock.exec_count.should == 3
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), "../lib/gembird-backend")
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+def assets(*path)
+  File.join(File.dirname(__FILE__), "assets", *path)
+end
+
+def command_result(file)
+  File.read assets "sispmctl", file
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: gembird-backend
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Jens Bissinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-01 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: guard-rspec
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: yard
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id004
+description: Wrapper around sispmctl script
+email: 
+  - mail@jens-bissinger.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - .rspec
+  - .travis.yml
+  - Gemfile
+  - Guardfile
+  - LICENSE
+  - README.md
+  - Rakefile
+  - gembird-backend.gemspec
+  - lib/gembird-backend.rb
+  - lib/gembird-backend/command.rb
+  - lib/gembird-backend/parser.rb
+  - lib/gembird-backend/retry.rb
+  - lib/gembird-backend/scanner.rb
+  - lib/gembird-backend/version.rb
+  - spec/assets/sispmctl/device-not-found.txt
+  - spec/assets/sispmctl/devices.txt
+  - spec/assets/sispmctl/no-connection.txt
+  - spec/assets/sispmctl/socket-status-error.txt
+  - spec/assets/sispmctl/socket-status.txt
+  - spec/assets/sispmctl/wrong-serial.txt
+  - spec/lib/gembird-backend/command_spec.rb
+  - spec/lib/gembird-backend/parser_spec.rb
+  - spec/lib/gembird-backend_spec.rb
+  - spec/spec_helper.rb
+homepage: ""
+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.15
+signing_key: 
+specification_version: 3
+summary: Provides an API to control Gembird USB power strips
+test_files: 
+  - spec/assets/sispmctl/device-not-found.txt
+  - spec/assets/sispmctl/devices.txt
+  - spec/assets/sispmctl/no-connection.txt
+  - spec/assets/sispmctl/socket-status-error.txt
+  - spec/assets/sispmctl/socket-status.txt
+  - spec/assets/sispmctl/wrong-serial.txt
+  - spec/lib/gembird-backend/command_spec.rb
+  - spec/lib/gembird-backend/parser_spec.rb
+  - spec/lib/gembird-backend_spec.rb
+  - spec/spec_helper.rb
+has_rdoc: