ADB 0.1

data/.gitignore

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

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3-p194@ADB --create

data/ADB.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ADB/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jeffrey S. Morgan"]
+  gem.email         = ["jeff.morgan@leandog.com"]
+  gem.description   = %q{Simple wrapper over Android Debug Bridge command-line tool}
+  gem.summary       = %q{Simple wrapper over Android Debug Bridge command-line tool}
+  gem.homepage      = "http://github.com/cheezy/ADB"
+
+  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          = "ADB"
+  gem.require_paths = ["lib"]
+  gem.version       = ADB::VERSION
+  
+  gem.add_dependency 'childprocess', '>= 0.3.5'
+  
+  gem.add_development_dependency 'rspec', '>= 2.11.0'
+  gem.add_development_dependency 'cucumber', '>= 1.2.0'
+
+end

data/ChangeLog

@@ -0,0 +1,10 @@
+=== 0.1 / 2012-8-10
+Initial release of the gem.  It has support for the following commands
+* start-server => start_server
+* kill-server => stop_server
+* connect => connect
+* disconnect => disconnect
+* devices => devices
+* wait-for-device => wait_for_device
+* install => install
+* uninstall => uninstall

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'fuubar'
+gem 'growl'
+gem 'guard-rspec'
+gem 'guard-cucumber'
+
+# Specify your gem's dependencies in ADB.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,18 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => '--color --format Fuubar' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'cucumber', :notification => true, :all_after_pass => false, :cli => '--profile default' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^lib/.+\.rb$})                   { "features" }
+  watch(%r{^cucumber.yml$})                 { "features" }
+end
+
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeffrey S. Morgan
+
+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,29 @@
+# ADB
+
+A simple wrapper around the Android Debug Bridge
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ADB'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ADB
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :spec
+
+Cucumber::Rake::Task.new(:features, "Run all features") do |t|
+  t.profile = 'default'
+end
+
+desc 'Run all specs and features'
+task :test => ['spec', 'features']
+
+task :lib do
+  $LOAD_PATH.unshift(File.expand_path("lib", File.dirname(__FILE__)))
+end
+
+task :default => :spec
+

data/cucumber.yml

@@ -0,0 +1 @@
+default:  --no-source --color --format pretty

data/features/ADB.feature

@@ -0,0 +1,24 @@
+Feature: Using the ADB module
+
+  Scenario: Starting the adb server
+    When the adb server is started
+    Then the adb server should be running
+
+  Scenario: Connecting to a device
+    Given the adb server is started
+    Then I should be able to connect to a local device
+
+  Scenario: Getting list of devices
+    Given the adb server is started
+    And I am connected to the local device
+    Then I should see the device "localhost:5555"
+
+  Scenario: Installing applications on the device
+    Given the adb server is started
+    And I am connected to the local device
+    Then I should be able to install the sample application
+
+  Scenario: Uninstalling the application
+    Given the adb server is started
+    And I am connected to the local device
+    Then I should be able to uninstall the sample application

data/features/step_definitions/adb_steps.rb

@@ -0,0 +1,34 @@
+When /^the adb server is started$/ do
+  start_server
+end
+
+Then /^the adb server should be running$/ do
+  last_stdout.should include "daemon started successfully"
+end
+
+Then /^I should be able to connect to a local device$/ do
+  connect('localhost')
+  last_stdout.should include "connected to localhost"
+  disconnect('localhost')
+end
+
+Given /^I am connected to the local device$/ do
+  connect
+end
+
+Then /^I should see the device "(.*?)"$/ do |device|
+  devices.should include device
+end
+
+Then /^I should be able to install the sample application$/ do
+  sn = devices[0]
+  wait_for_device({:serial => sn}, 60)
+  install 'features/support/ApiDemos.apk', {:serial => sn}, 60
+  last_stdout.should include 'Success'
+end
+
+Then /^I should be able to uninstall the sample application$/ do
+  sn = devices[0]
+  uninstall 'com.example.android.apis', {:serial => sn}
+  last_stdout.should include 'Success'
+end

data/features/support/env.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
+
+require 'rspec/expectations'
+require 'childprocess'
+require 'ADB'
+
+World(ADB)
+
+emulator = ChildProcess.build('emulator', '-avd', 'Android_4.0.3')
+emulator.start
+
+at_exit do
+  emulator.stop
+end
+
+
+After do
+  stop_server
+  sleep 1
+end
+

data/lib/ADB.rb

@@ -0,0 +1,156 @@
+require 'ADB/version'
+require 'ADB/errors'
+require 'childprocess'
+require 'tempfile'
+
+#
+# Mixin that provides access to the commands of the adb executable
+# which is a part of the android toolset.
+#
+module ADB
+
+  attr_reader :last_stdout, :last_stderr
+
+  #
+  # start the server process
+  #
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def start_server(timeout=30)
+    execute_adb_with(timeout, 'start-server')
+    raise ADBError, "Server didn't start" unless stdout_contains "daemon started successfully"
+  end
+
+  #
+  # stop the server process
+  #
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def stop_server(timeout=30)
+    execute_adb_with(timeout, 'kill-server')
+  end
+
+  #
+  # connect to a running device via TCP/IP
+  #
+  # @param hostname defaults to 'localhost'
+  # @param port defaults to '5555'
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def connect(hostname='localhost', port='5555', timeout=30)
+    execute_adb_with(timeout, "connect #{hostname}:#{port}")
+    raise ADBError, "Could not connect to device at #{hostname}:#{port}" unless stdout_contains "connected to #{hostname}"
+  end
+
+  #
+  # disconnect from a device
+  #
+  # @param hostname defaults to 'localhost'
+  # @param port defaults to '5555'
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def disconnect(hostname='localhost', port='5555', timeout=30)
+    execute_adb_with(timeout, "disconnect #{hostname}:#{port}")
+  end
+
+  #
+  # list all connected devices
+  #
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def devices(timeout=30)
+    execute_adb_with(timeout, 'devices')
+    device_list = last_stdout.split("\n")
+    device_list.shift
+    device_list.collect { |device| device.split("\t").first }
+  end
+
+  #
+  # wait for a device to complete startup
+  #
+  # @param [Hash] which device to wait for.  Valid keys are :device,
+  # :emulator, and :serial.
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def wait_for_device(target={}, timeout=30)
+    execute_adb_with(timeout, "#{which_one(target)} wait-for-device")
+  end
+
+  #
+  # install an apk file to a device
+  #
+  # @param the path and filename to the apk you wish to install
+  # @param [Hash] which device to wait for.  Valid keys are :device,
+  # :emulator, and :serial.
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def install(installable, target={}, timeout=30)
+    execute_adb_with(timeout, "#{which_one(target)} install #{installable}")
+    raise ADBError, "Could not install #{installable}" unless stdout_contains "Success"
+  end
+
+  #
+  # uninstall an apk file to a device
+  #
+  # @param the package name of the apk ou wish to uninstall
+  # @param [Hash] which device to wait for.  Valid keys are :device,
+  # :emulator, and :serial.
+  # @param timeout value for the command to complete.  Defaults to 30
+  # seconds.
+  #
+  def uninstall(package, target={}, timeout=30)
+    execute_adb_with(timeout, "#{which_one(target)} uninstall #{package}")
+    raise ADBError, "Could not uninstall #{package}" unless stdout_contains "Success"
+  end
+
+  private
+
+  def execute_adb_with(timeout, arguments)
+    args = arguments.split
+    process = ChildProcess.build('adb', *args)
+    process.io.stdout, process.io.stderr = std_out_err
+    process.start
+    kill_if_longer_than(process, timeout)
+    @last_stdout = output(process.io.stdout)
+    @last_stderr = output(process.io.stderr)
+  end
+
+  def which_one(target)
+    direct = ''
+    direct = '-d' if target[:device]
+    direct = '-e' if target[:emulator]
+    direct = "-s #{target[:serial]}" if target[:serial]
+    direct
+  end
+
+  def kill_if_longer_than(process, timeout)
+    begin
+      process.poll_for_exit(timeout)
+    rescue ChildProcess::TimeoutError
+      process.stop
+    end
+  end
+
+  def output(file)
+    file.rewind
+    out = file.read
+    file.close
+    file.unlink
+    out
+  end
+
+  def std_out_err
+    return ::Tempfile.new("adb-out#{Time.now}"), ::Tempfile.new("adb-err#{Time.now}")
+  end
+
+  def stdout_contains(expected)
+    last_stdout.include? expected
+  end
+end

data/lib/ADB/errors.rb

@@ -0,0 +1,8 @@
+module ADB
+  class Error < StandardError
+  end
+
+  class ADBError < Error
+  end
+  
+end

data/lib/ADB/version.rb

@@ -0,0 +1,3 @@
+module ADB
+  VERSION = "0.1"
+end

data/spec/lib/ADB_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe ADB do
+  it "should know how to start the adb server" do
+    ADB.should_receive(:last_stdout).and_return("daemon started successfully")
+    should_call_adb_with('start-server')
+    ADB.start_server
+  end
+
+  it "should know how to stop the adb server" do
+    should_call_adb_with('kill-server')
+    ADB.stop_server
+  end
+  
+  it "should stop process if it takes too long" do
+    ADB.should_receive(:last_stdout).and_return("device")
+    process = double('process')
+    process.should_receive(:start)
+    process.should_receive(:poll_for_exit).and_raise(ChildProcess::TimeoutError)
+    process.should_receive(:stop)
+    mock_output_file(process)
+    ChildProcess.should_receive(:build).with('adb', 'devices').and_return(process)
+    ADB.devices
+  end
+
+  it "should know how to provide list of devices" do
+    ADB.should_receive(:last_stdout).and_return("device")
+    should_call_adb_with('devices')
+    ADB.devices
+  end
+
+  context "when connecting to a device" do
+    before(:each) do
+      ADB.should_receive(:last_stdout).and_return("connected to localhost")
+    end
+
+    it "should connect successfully" do
+      should_call_adb_with('connect', 'localhost:5555')
+      ADB.connect('localhost', '5555')
+    end
+
+    it "should default to using port 5555" do
+      should_call_adb_with('connect', 'localhost:5555')
+      ADB.connect('localhost')
+    end
+
+    it "should default to using host localhost" do
+      should_call_adb_with('connect', 'localhost:5555')
+      ADB.connect
+    end
+  end
+
+  context "when disconnecting from a device" do
+    it "should disconnect successfully" do
+      should_call_adb_with('disconnect', 'localhost:5555')
+      ADB.disconnect('localhost', '5555')
+    end
+
+    it "should default to using port 5555" do
+      should_call_adb_with('disconnect', 'localhost:5555')
+      ADB.disconnect('localhost')
+    end
+
+    it "should default to using host localhost" do
+      should_call_adb_with('disconnect', 'localhost:5555')
+      ADB.disconnect
+    end
+  end
+
+  context "wating for a device to start" do
+    it "should wait for only device" do
+      should_call_adb_with('wait-for-device')
+      ADB.wait_for_device
+    end
+
+    it "should wait for the only connected device" do
+      should_call_adb_with('-d', 'wait-for-device')
+      ADB.wait_for_device :device => 'blah'
+    end
+
+    it "should wait for the only emulator" do
+      should_call_adb_with('-e', 'wait-for-device')
+      ADB.wait_for_device :emulator => 'blah'
+    end
+
+    it "should wait for a device when using serial number" do
+      should_call_adb_with('-s', 'sernum', 'wait-for-device')
+      ADB.wait_for_device :serial => 'sernum'
+    end
+  end
+
+  context "when installing an apk" do
+    it "should be able to install an application" do
+      ADB.should_receive(:last_stdout).and_return("Success")
+      should_call_adb_with('install', 'Test.apk')
+      ADB.install 'Test.apk'
+    end
+
+    it "should install to the only connected device" do
+      ADB.should_receive(:last_stdout).and_return("Success")
+      should_call_adb_with('-d', 'install', 'Test.apk')
+      ADB.install 'Test.apk', :device => 'blah'
+    end
+
+    it "should install to the only emulator" do
+      ADB.should_receive(:last_stdout).and_return("Success")
+      should_call_adb_with('-e', 'install', 'Test.apk')
+      ADB.install 'Test.apk', :emulator => 'blah'
+    end
+
+    it "should install to a target using serial number" do
+      ADB.should_receive(:last_stdout).and_return("Success")
+      should_call_adb_with('-s', 'sernum', 'install', 'Test.apk')
+      ADB.install 'Test.apk', :serial => 'sernum'
+    end
+
+    it "should raise an error when the install fails" do
+      ADB.should_receive(:last_stdout).and_return("some error")
+      should_call_adb_with('install', 'Test.apk')
+      expect { ADB.install('Test.apk') }.to raise_error(ADBError)
+    end
+  end
+
+  context "when uninstalling an apk" do
+    it "should be able to uninstall an application" do
+      ADB.should_receive(:last_stdout).and_return('Success')
+      should_call_adb_with('uninstall', 'com.example')
+      ADB.uninstall 'com.example'
+    end
+
+    it "should uninstall from the only connected device" do
+      ADB.should_receive(:last_stdout).and_return('Success')
+      should_call_adb_with('-d', 'uninstall', 'com.example')
+      ADB.uninstall 'com.example', :device => 'blah'
+    end
+
+    it "should uninstall from the only emulator" do
+      ADB.should_receive(:last_stdout).and_return('Success')
+      should_call_adb_with('-e', 'uninstall', 'com.example')
+      ADB.uninstall 'com.example', :emulator => 'blah'
+    end
+
+    it "should unistall from a device using the serial number" do
+      ADB.should_receive(:last_stdout).and_return('Success')
+      should_call_adb_with('-s', 'sernum', 'uninstall', 'com.example')
+      ADB.uninstall 'com.example', :serial => 'sernum'
+    end
+
+    it "should raise an error when the uninstall fails" do
+      ADB.should_receive(:last_stdout).and_return('some error')
+      should_call_adb_with('uninstall', 'com.example')
+      expect { ADB.uninstall('com.example') }.to raise_error(ADBError)
+    end
+  end
+  
+  
+  def should_call_adb_with(*args)
+    ChildProcess.should_receive(:build).with('adb', *args).and_return(process_mock)    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'ADB'
+require 'childprocess'
+
+include ADB
+
+def process_mock
+  process_mock = double('process_mock')
+  process_mock.should_receive(:start)
+  process_mock.should_receive(:poll_for_exit)
+  mock_output_file(process_mock)
+  process_mock
+end
+
+def mock_output_file(output)
+  output.should_receive(:io).exactly(4).times.and_return(output)
+  output.should_receive(:stdout=)
+  output.should_receive(:stdout).and_return(output)
+  output.should_receive(:stderr=)
+  output.should_receive(:stderr).and_return(output)
+  output.should_receive(:rewind).twice
+  output.should_receive(:read).twice.and_return([])
+  output.should_receive(:close).twice
+  output.should_receive(:unlink).twice
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: ADB
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jeffrey S. Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Simple wrapper over Android Debug Bridge command-line tool
+email:
+- jeff.morgan@leandog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- ADB.gemspec
+- ChangeLog
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- cucumber.yml
+- features/ADB.feature
+- features/step_definitions/adb_steps.rb
+- features/support/ApiDemos.apk
+- features/support/env.rb
+- lib/ADB.rb
+- lib/ADB/errors.rb
+- lib/ADB/version.rb
+- spec/lib/ADB_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cheezy/ADB
+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'
+      segments:
+      - 0
+      hash: 1303897695555104367
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1303897695555104367
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple wrapper over Android Debug Bridge command-line tool
+test_files:
+- features/ADB.feature
+- features/step_definitions/adb_steps.rb
+- features/support/ApiDemos.apk
+- features/support/env.rb
+- spec/lib/ADB_spec.rb
+- spec/spec_helper.rb