droid_adbs 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12aa081c392cadc2fbeeece257869e5669ba60a1
-  data.tar.gz: 67c95c2d910f880ee36876792d1d93e6890662a3
+  metadata.gz: 568bd488d848be1f37d46702e9b2f5c151c826ab
+  data.tar.gz: 1aba89a26ec167fae9a811d70349ae8c0c0df0a9
 SHA512:
-  metadata.gz: ae7e8d24a6cf754f6987ad6ddd88b4d06e4b2cc3ef99fca9da8f4a8d07f74214dc7d376f41d8253681e84043769bd98894c6037d1d7c6af349a88a25166371e2
-  data.tar.gz: 7aba1f9a8429ac56917632099a53a5e0541f17b02a681e7a385450d8395e535a7a1b21c3da064a9627b090326faa1f4082c867e64c63db80516b9e4a0c474c87
+  metadata.gz: 2a33f99f5a6e38732f4176a56f1574197385891b8167dcb9a6eb2ca5bca9fc9ade201d78f499b6847c692d1e496803c0cf86ad4d111b50ef23c147862e09589c
+  data.tar.gz: ea5ab0b50f306212c196ff7bc3fca9c5ac63cf1f4fbedfdc48a5810c77458e63024561e4d500c4fa7e2f6738178283294b00820c8d27f28b80727da290ee8d9b

data/README.md

@@ -19,7 +19,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+Example:
+
+```
+::DroidAdbs.device_serial = "device cerial you would like to connect" # set device_serial
+::DroidAdbs devices # means `adb devices`
+::DroidAdbs.install(app_path) # install `app_path` to the device
+```
+
+Please read yard documents if you would like to know more.
 
 ## Development
 
@@ -30,6 +38,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Rubygems
 - https://rubygems.org/gems/droid_adbs
 
+## Documents
+You can get document by `yard` command.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/KazuCocoa/droid_adbs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/droid_adbs/aapt.rb

@@ -1,8 +1,12 @@
 module DroidAdbs
   module Aapt
     class << self
+      # @param [String] package_path
+      # @param [String] out_path
+      # @raise RuntimeError because get_manifesto can't find aapt command
+      # @return [fixnum]
       def get_manifesto(package_path, out_path)
-        raise "should set path to aapt, android-sdks/build-tools/xxxx" if `which aapt`.empty?
+        raise RuntimeError, "should set path to aapt, android-sdks/build-tools/xxxx" if `which aapt`.empty?
         dumped_data = `aapt dump xmltree #{package_path} AndroidManifest.xml`
         File.write out_path, dumped_data
       end

data/lib/droid_adbs/commons/backup.rb

@@ -6,31 +6,43 @@ module DroidAdbs
 
       # https://developer.android.com/intl/ja/training/backup/autosyncapi.html#testing
 
+      # @raise RuntimeError because backup available over SDK 23
+      # @return [String] message from adb command
       def enable_backup_logs
-        fail "Backup support over SDK 23(Android 6.0, M)" unless available_backup?
+        raise RuntimeError, "Backup support over SDK 23(Android 6.0, M)" unless available_backup?
         `#{::DroidAdbs.shell} setprop log.tag.BackupXmlParserLogging VERBOSE`
       end
 
+      # @param [String] package A package name you would like to backup
+      # @raise RuntimeError because backup available over SDK 23
+      # @return [String] message from adb command
       def full_backup(package)
-        fail "Backup support over SDK 23(Android 6.0, M)" unless available_backup?
+        raise RuntimeError, "Backup support over SDK 23(Android 6.0, M)" unless available_backup?
         `#{::DroidAdbs.shell} bmgr run`
         `#{::DroidAdbs.shell} bmgr fullbackup #{package}`
       end
 
+      # @param [String] package A package name you would like to backup
+      # @return [String] message from adb command
       def restore(package)
         fail "Backup support over SDK 23(Android 6.0, M)" unless available_backup?
         `#{::DroidAdbs.shell} bmgr restore #{package}`
       end
 
+      # @return [String] message from adb command
       def transports
         `#{::DroidAdbs.shell} bmgr list transports`
       end
 
+      # @param [String] transport
+      # @param [String] package A package name you would like to backup
+      # @return [String] message from adb command and puts message
       def clear_backup(transport, package)
         `#{::DroidAdbs.shell} bmgr wipe #{transport} #{package}`
         puts "You can also clear the backup data and associated metadata wither by turning backup off and on in Settings > Backup."
       end
 
+      # @return [Boolean] Return true if API Level against target device is over 23
       def available_backup?
         ::DroidAdbs::Devices.device_build_version_sdk.to_i >= 23
       end

data/lib/droid_adbs/commons/devices.rb

@@ -5,32 +5,37 @@ module DroidAdbs
     class << self
       ### device infos
       # @return [String] message from adb command
-      # e.g: docomo/SO-04E_1274-2936/SO-04E:4.2.2/10.3.1.B.0.256/_753rg:user/release-keys
+      # @example result of message
+      #     docomo/SO-04E_1274-2936/SO-04E:4.2.2/10.3.1.B.0.256/_753rg:user/release-keys
       def device_fingerprint
         `#{::DroidAdbs.shell} getprop ro.build.fingerprint`.chomp
       end
 
       ### device infos
       # @return [String] message from adb command
-      # e.g: SO-04E
+      # @example result of message
+      #     SO-04E
       def device_model
         `#{::DroidAdbs.shell} getprop ro.product.model`.chomp
       end
 
       # @return [String] message from adb command
-      # e.g: 4.2.2
+      # @example result of message
+      #     4.2.2
       def device_build_version_release
         `#{::DroidAdbs.shell} getprop ro.build.version.release`.chomp
       end
 
       # @return [String] message from adb command
-      # e.g: 17
+      # @example result of message
+      #     17
       def device_build_version_sdk
         `#{::DroidAdbs.shell} getprop ro.build.version.sdk`.chomp
       end
 
       # @return [String] message from adb command
-      # e.g: "en"
+      # @example result of message
+      #     "en"
       def current_language
         language = `#{::DroidAdbs.shell} getprop persist.sys.language`.chomp
         return language unless language.empty?
@@ -39,7 +44,8 @@ module DroidAdbs
       end
 
       # @return [String] message from adb command
-      # e.g.: "ja-JP"
+      # @example result of message
+      #     "ja-JP"
       def current_locale
         locale = `#{::DroidAdbs.shell} getprop persist.sys.locale`.chomp
         return locale unless locale.empty?

data/lib/droid_adbs/commons/grant.rb

@@ -0,0 +1,22 @@
+require_relative "../../droid_adbs"
+
+module DroidAdbs
+  module Grant
+    class << self
+      # @param [String] package A name of package you would like to allow permission
+      # @param [Object] permission Permission you would like to allow
+      # @return [String] message from adb command
+      def grant(package:, permission:)
+        result = `#{::DroidAdbs.shell} pm grant #{package} #{permission}`.chomp
+
+        unless result.empty?
+          exception = "java.lang.IllegalArgumentException:"
+          error_message = result.each_line.find { |line| line.include? exception }.chomp
+          raise RuntimeError, message unless error_message.empty?
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/droid_adbs/commons/ime.rb

@@ -3,29 +3,37 @@ require_relative "../../droid_adbs"
 module DroidAdbs
   module IME
     class << self
-      # @return [String] message from adb command
+      # @return [String] message from adb command as pure string.
       def get_ime_with_string
         `#{::DroidAdbs.shell} ime list`.chomp
       end
 
-      # @return [Array] Array of IME ID list such as ["com.agilebits.onepassword/.filling.FillingInputMethodService",
-      #   com.google.android.googlequicksearchbox/com.google.android.voicesearch.ime.VoiceInputMethodService"]
+      # @return [Array] Array of IME ID list
+      # @example
+      #   [
+      #     "com.agilebits.onepassword/.filling.FillingInputMethodService",
+      #     "com.google.android.googlequicksearchbox/com.google.android.voicesearch.ime.VoiceInputMethodService"
+      #   ]
       def get_ime_list
         string = get_ime_with_string
         parse_ime_list(string)
       end
 
       # @param [String] ime_id ID provided by IME such as "com.google.android.inputmethod.japanese/.MozcService"
-      # @return [String] message from adb command
-      #   if it succeeded to set IME, then it returns "Input method com.google.android.inputmethod.japanese/.MozcService selected"
-      #   if it failed to set IME because of no ID, then it returns "Error: Unknown id: ime_id"
+      # @return [String] message from adb command.
+      #     If it succeeded to set IME, then it returns "Input method com.google.android.inputmethod.japanese/.MozcService selected"
+      #     If it failed to set IME because of no ID, then it returns "Error: Unknown id: ime_id"
       def set_ime(ime_id)
         `#{::DroidAdbs.shell} ime set #{ime_id}`.chomp
       end
 
       # @param [String] ime_lists
-      # @return [Array] Array of IME ID list such as ["com.agilebits.onepassword/.filling.FillingInputMethodService",
-      #   com.google.android.googlequicksearchbox/com.google.android.voicesearch.ime.VoiceInputMethodService"]
+      # @return [Array] Array of IME ID list
+      # @example
+      #   [
+      #     "com.agilebits.onepassword/.filling.FillingInputMethodService",
+      #     "com.google.android.googlequicksearchbox/com.google.android.voicesearch.ime.VoiceInputMethodService"
+      #   ]
       def parse_ime_list(ime_lists)
         ime_lists.each_line.map { |line| line.chomp.scan(/\A\S+:\z/).first }.compact.map(&:chop)
       end

data/lib/droid_adbs/version.rb

@@ -1,3 +1,3 @@
 module DroidAdbs
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/droid_adbs.rb

@@ -4,6 +4,7 @@ require_relative "droid_adbs/commons/devices"
 require_relative "droid_adbs/commons/backup"
 require_relative "droid_adbs/commons/ime"
 require_relative "droid_adbs/commons/wm"
+require_relative "droid_adbs/commons/grant"
 require_relative "droid_adbs/aapt"
 
 module DroidAdbs
@@ -30,55 +31,58 @@ module DroidAdbs
       `#{adb} devices`.scan(/^.*\t/).map(&:strip)
     end
 
-    # @param app [String] application path
+    # @param [String] app Application path
     # @return [String] message from adb command
     def install(app)
       result = `#{adb_serial} install -r #{app}`
-      fail "invalid APK" if result.include?("Invalid APK file:")
-      fail "failed to update apk because INSTALL_FAILED_VERSION_DOWNGRADE" if result.include?("INSTALL_FAILED_VERSION_DOWNGRADE")
+      raise RuntimeError, result if result.include?("Error:")
+      raise RuntimeError, "invalid APK" if result.include?("Invalid APK file:")
+      raise RuntimeError, "failed to update apk because INSTALL_FAILED_VERSION_DOWNGRADE" if result.include?("INSTALL_FAILED_VERSION_DOWNGRADE")
       result
     end
 
-    # @param app [String] application path
+    # @param [String] app Application path
     # @return [String] message from adb command
     def install_with_grant(app)
       result = `#{adb_serial} install -r -g #{app}`
-      fail "invalid APK" if result.include?("Invalid APK file:")
-      fail "failed to update apk because INSTALL_FAILED_VERSION_DOWNGRADE" if result.include?("INSTALL_FAILED_VERSION_DOWNGRADE")
+      raise RuntimeError, result if result.include?("Error:")
+      raise RuntimeError, "invalid APK" if result.include?("Invalid APK file:")
+      raise RuntimeError, "failed to update apk because INSTALL_FAILED_VERSION_DOWNGRADE" if result.include?("INSTALL_FAILED_VERSION_DOWNGRADE")
       result
     end
 
-    # @param app [String] application path
+    # @param [String] app Application path
     # @return [String] message from adb command
     def install_with(app, option = "")
       result = `#{adb_serial} install #{option} #{app}`
-      fail "invalid APK" if result.include?("Invalid APK file:")
-      fail "failed to update apk because INSTALL_FAILED_VERSION_DOWNGRADE" if result.include?("INSTALL_FAILED_VERSION_DOWNGRADE")
+      raise RuntimeError, result if result.include?("Error:")
+      raise RuntimeError, "invalid APK" if result.include?("Invalid APK file:")
+      raise RuntimeError, "failed to update apk because INSTALL_FAILED_VERSION_DOWNGRADE" if result.include?("INSTALL_FAILED_VERSION_DOWNGRADE")
       result
     end
 
 
-    # @param package [String] package name you would like to uninstall
+    # @param [String] package A package name you would like to uninstall
     # @return [String] message from adb command
     def uninstall(package)
       `#{adb_serial} uninstall #{package}`
     end
 
-    # @param package [String] package name you would like to uninstall similar ones
+    # @param [String] package A package name you would like to uninstall similar ones
     # @return [String] message from adb command
     def uninstall_similar(package)
       installed_packages = installed_similar(package)
       installed_packages.each { |pack| `#{adb_serial} uninstall #{pack}` }
     end
 
-    # @param package [String] package name you would like to delete data in device local
+    # @param [String] package A package name you would like to delete data in device local
     # @return [String] message from adb command
     def delete_data(package)
       result = `#{shell} pm clear #{package}`.strip
       puts "failed to delete data" unless result == "Success"
     end
 
-    # @param package [String] package name you would like to check installed or not
+    # @param [String] package A package name you would like to check installed or not
     # @return [Bool] If the package installed, return true. Else return false
     def installed?(package)
       result = `#{shell} pm list packages -e #{package}`.strip
@@ -86,20 +90,20 @@ module DroidAdbs
       false
     end
 
-    # @param package [String] package name you would like to collect similar package
+    # @param [String] package A package name you would like to collect similar package
     # @return [Array] all package names
     def installed_similar(package)
       result = `#{shell} pm list packages -e #{package}`.strip
       result.each_line.map { |pack|  pack.strip.sub("package:", "") }
     end
 
-    # @param activity [String] activity name you would like to launch
+    # @param [String] activity An activity name you would like to launch
     # @return [String] message from adb command
     def start(activity)
       `#{shell} am start -n #{activity}`
     end
 
-    # @param account_type [String] accountType of Android OS
+    # @param [String] account_type accountType of Android OS
     # @return [String] message from adb command
     def launch_login_activity(account_type)
       if ::DroidAdbs::Devices.device_build_version_sdk.to_i >= 21
@@ -109,14 +113,14 @@ module DroidAdbs
       end
     end
 
-    # @param activity [String] activity name you would like to stop
+    # @param [String] package A package name you would like to stop
     # @return [String] message from adb command
     def force_stop(package)
       `#{shell} am force-stop #{package}`
     end
 
-    # @param broadcats_item [String] Target item for broadcast
-    # @param broadcast_extra [String] putExtra to send broadcast.
+    # @param [String] broadcats_item Target item for broadcast
+    # @param [String] broadcast_extra putExtra to send broadcast.
     # @return [String] message from adb command
     def send_broadcast(broadcats_item, broadcast_extra = "")
       `#{shell} am broadcast -a #{broadcats_item} #{broadcast_extra}`
@@ -134,14 +138,14 @@ module DroidAdbs
       `#{shell} dumpsys window windows | grep -E "mCurrentFocus|mFocusedApp"`
     end
 
-    # @param [String] referrer to broadcast
+    # @param referrer [String] To broadcast
     # @return [String] message from adb command
     def install_referrer_broadcast(referrer)
       `#{shell} broadcast window -a com.android.vending.INSTALL_REFERRER --include-stopped-packages --es referrer #{referrer}`
     end
 
     # send referrer for TVs
-    # @param [String] referrer to broadcast
+    # @param [String] ref to broadcast
     # @return [String] message from adb command
     def broad_install_referrer(ref)
       `#{shell} am broadcast -a com.android.vending.INSTALL_REFERRER --include-stopped-packages --es referrer #{ref}`
@@ -154,10 +158,13 @@ module DroidAdbs
       `#{shell} input keyevent 82`
     end
 
+    # @param [String] text Pin code to unlock
+    # @return [String] message from adb command
     def unlock_with_pin(text)
       `#{shell} input text #{text} && #{shell} input keyevent 66`
     end
 
+    # @return [String] message from adb command
     def screen_on_or_off
       `#{shell} input keyevent 26`
     end
@@ -174,4 +181,4 @@ module DroidAdbs
       "-s #{device_serial}"
     end
   end
-end
+end # module DroidAdbs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droid_adbs
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-13 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - lib/droid_adbs/aapt.rb
 - lib/droid_adbs/commons/backup.rb
 - lib/droid_adbs/commons/devices.rb
+- lib/droid_adbs/commons/grant.rb
 - lib/droid_adbs/commons/ime.rb
 - lib/droid_adbs/commons/settings.rb
 - lib/droid_adbs/commons/wm.rb