adb-sdklib 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTE3YzhiZDg1MzU4MzkxZGM1N2I5Y2IxYjIwYTgxNWQ1OWY0ZWU5NA==
+  data.tar.gz: !binary |-
+    NmM3MzE5NmZhZjQxNmI0NjkyNjRkZWY4NGFkNzQwMmViMTA3NzJiOA==
+SHA512:
+  metadata.gz: !binary |-
+    YTY3ODE0OTI4MzI3Mzc4YTMwNzQ3ZmY4ZTQxMTZjNjQ0YzkxNTZlNzJmNzkz
+    NzZmM2QwYzU4NWMzN2U2MjY3MzU0ZGQwMDZhZjcyZWExMGQzNWY2YTM5MjU1
+    ZmIwZWQyZGQyNjA4YWRhNTMyOTMxZWUwYWRjZjdjOWU4MDNjNjY=
+  data.tar.gz: !binary |-
+    MzFjYzhjYzUxNDRlNzdmOWNmNDZhODU1NzM5ZWQzN2Q5NTkzNTA0ZThjMzli
+    MzA1ZDU4ZTA3NGE0ZDA1MWVmMTRjNGNiOWM3MDg0NDY0ZGZmODAyYmQ1MzRj
+    NmU0YTc0NGZkYjQ2ODdkZjc0NzUxNWY5M2E5MDRhYjRhOGI0MDQ=

data/.gitignore

@@ -0,0 +1,19 @@
+*.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
+nbproject

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adb-sdklib.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 yoyo0906
+
+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,75 @@
+# adb-sdklib
+
+Android Debug Bridge (ADB) wrapper using Android SDK Tools Library with Rjb
+
+## Installation
+```bash
+# Install Rjb
+$ export JAVA_HOME=<your java home path>
+$ gem install rjb
+
+# Install adb-sdklib
+$ gem install adb-sdklib
+```
+
+## Usage
+
+### Adb Object
+
+```ruby
+require 'adb-sdklib'
+adb = AdbSdkLib::Adb.new
+# If 'adb' command-line tool isn't in your $PATH, set adb location to constructor shown as below
+# adb = AdbSdkLib::Adb.new(<adb location>)
+
+# Get device objects
+devices = adb.devices
+```
+
+**Adb** object is wrapper of *com.android.ddmlib.AndroidDebugBridge*.  
+Source code of *com.android.ddmlib.AndroidDebugBridge*:
+<https://android.googlesource.com/platform/tools/base/+/master/ddmlib/src/main/java/com/android/ddmlib/AndroidDebugBridge.java>
+
+Some methods of *AndroidDebugBridge* are wrapped for Ruby.  
+For remaining methods, *Adb#method_missing* is defined to call
+wrapping java object's same name method using specified parameters.
+
+### Device Object
+
+```ruby
+adb = AdbSdkLib::Adb.new
+device = adb.devices.first
+# device = adb.devices['xxxxxx'] # get by serial number of the device.
+puts <<"EOS"
+serial    : #{device.serial}
+state     : #{device.state}
+emulator  : #{device.emulator?}
+build ver : #{device.build_version}
+api level : #{device.api_level}
+device model  : #{device.device_model}
+manufacturer  : #{device.manufacturer}
+build desc    : #{device.property('ro.build.description')}
+battery level : #{device.battery_level}
+EOS
+```
+
+**Device** object is wrapper of *com.android.ddmlib.Device*.  
+Source code of *com.android.ddmlib.Device*:
+<https://android.googlesource.com/platform/tools/base/+/master/ddmlib/src/main/java/com/android/ddmlib/Device.java>
+
+Some methods of *ddmlib.Device* are wrapped for Ruby.
+For remaining methods, *Device#method_missing* is defined to call
+wrapping java object's same name method using specified parameters.
+
+## Contributing
+
+1. Fork it ( http://github.com/yoyo0906/ruby-adb-sdklib/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+- MIT License
+- Copyright (c) 2014 yoyo0906

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/adb-sdklib.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adb_sdklib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "adb-sdklib"
+  spec.version       = AdbSdkLib::VERSION
+  spec.authors       = ["yoyo"]
+  spec.email         = ["yoyo0906@gmail.com"]
+  spec.summary       = "Android Debug Bridge (ADB) wrapper" +
+                       " using Android SDK Tools Library with Rjb."
+  spec.description   = "Ruby library for basic access to Android devices through" +
+                       " ADB using ddmlib.jar which is included Android SDK Tools" +
+                       " via Rjb (Ruby Java Bridge)."
+  spec.homepage      = "http://github.com/yoyo0906/ruby-adb-sdklib"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rjb'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/adb-sdklib.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+require "adb_sdklib/version"
+require 'adb_sdklib/common'
+require 'adb_sdklib/device'
+
+module AdbSdkLib
+  class Adb
+    include Common
+
+    @@AndroidDebugBridge = nil
+
+    def initialize(adb_location = nil, force_new_bridge = false)
+      if adb_location.nil?
+        @adbpath = `which adb`.chomp!
+      else
+        @adbpath = adb_location
+      end
+      raise AdbError, "Not found 'adb' command in $PATH" unless @adbpath
+
+      # load AndroidDebugBridge
+      libpath = File.expand_path('../tools/lib/', File.dirname(@adbpath))
+
+      if @@AndroidDebugBridge.nil?
+        load_jar("#{libpath}/ddmlib.jar")
+        @@AndroidDebugBridge = Rjb::import('com.android.ddmlib.AndroidDebugBridge')
+        @@AndroidDebugBridge.initIfNeeded(false)
+        at_exit { Adb.terminate }
+      end
+
+      @adb = @@AndroidDebugBridge.createBridge(@adbpath, force_new_bridge)
+      10.times { |i|
+        break if @adb.connected?
+        sleep(0.25)
+      }
+      raise AdbError, 'Connect adb error (timeout)' unless @adb.connected?
+    end
+
+    def self.terminate
+      unless @@AndroidDebugBridge.nil?
+        @@AndroidDebugBridge.terminate
+        @@AndroidDebugBridge = nil
+      end
+    end
+
+    def devices
+      devices = @adb.devices.map { |d| Device.new(d) }
+      class << devices
+        def [](serial); self.find { |d| d.serial_number == serial  } end
+      end
+      return devices
+    end
+  end
+end

data/lib/adb_sdklib/common.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+require 'rjb'
+
+module AdbSdkLib
+  class AdbError < StandardError; end
+
+  module Common
+    def load_jar(lib)
+      raise AdbError, "Not found #{lib}" unless File.exist?(lib)
+      Rjb::load(lib)
+    end
+
+    def convert_map_to_hash(object, &block)
+      hash = Hash.new
+      i = object.entrySet.iterator
+      if block_given?
+        while i.hasNext
+          entry = i.next
+          yield hash, entry.getKey, entry.getValue
+        end
+      else
+        while i.hasNext
+          entry = i.next
+          hash[entry.getKey] = entry.getValue
+        end
+      end
+      hash
+    end
+
+    module_function(:load_jar, :convert_map_to_hash)
+  end
+end
+

data/lib/adb_sdklib/device.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+require 'adb_sdklib/common'
+
+module AdbSdkLib
+  class Device
+    include Common
+
+    def initialize(device)
+      unless device.instance_of?(Rjb::Rjb_JavaProxy) &&
+          device.getClass.getCanonicalName == 'com.android.ddmlib.Device'
+        raise TypeError, "Parameter is not com.android.ddmlib.Device class"
+      end
+      @device = device
+    end
+
+    def serial;          @device.serial_number end
+    def state;           @device.state.toString.to_sym end
+    def online?;         @device.online?     end
+    def emulator?;       @device.emulator?   end
+    def offline?;        @device.offline?    end
+    def bootloader?;     @device.bootloader? end
+    def reboot(into=nil) @device.reboot(into) end
+    def property_count;  @device.property_count end
+    def property(prop);  @device.property(prop) end
+    def properties
+      convert_map_to_hash(@device.properties) { |hash, key, value|
+        hash[key.toString] = value.toString
+      }
+    end
+    def build_version;   @device.property(@device.PROP_BUILD_VERSION) end
+    def api_level;       @device.property(@device.PROP_BUILD_API_LEVEL) end
+    def build_codename;  @device.property(@device.PROP_BUILD_CODENAME) end
+    def device_model;    @device.property(@device.PROP_DEVICE_MODEL) end
+    def device_manufacturer; @device.property(@device.PROP_DEVICE_MANUFACTURER) end
+    def debuggable;      @device.property(@device.PROP_DEBUGGABLE) end
+
+    def battery_level(freshness_ms=nil)
+      if freshness_ms.nil?
+        @device.battery_level.int_value
+      else
+        @device.battery_level(freshness_ms).int_value
+      end
+    end
+    
+    def method_missing(action, *args)
+      return @device.__send__(action, *args)
+    end
+
+    def to_s
+      "Android: ID:#{self.serial}"
+    end
+
+    def inspect
+      "#<AdbSdkLib::Device:#{self.serial}>"
+    end
+
+    private
+    def to_ary; nil end
+  end
+end
+

data/lib/adb_sdklib/version.rb

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: adb-sdklib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yoyo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rjb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby library for basic access to Android devices through ADB using ddmlib.jar
+  which is included Android SDK Tools via Rjb (Ruby Java Bridge).
+email:
+- yoyo0906@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adb-sdklib.gemspec
+- lib/adb-sdklib.rb
+- lib/adb_sdklib/common.rb
+- lib/adb_sdklib/device.rb
+- lib/adb_sdklib/version.rb
+homepage: http://github.com/yoyo0906/ruby-adb-sdklib
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Android Debug Bridge (ADB) wrapper using Android SDK Tools Library with Rjb.
+test_files: []