appium_lib 0.16.0 → 0.17.0

data/lib/appium_lib.rb

@@ -30,5 +30,5 @@ module Appium
 
   add_to_path __FILE__
 
-  require 'appium_lib/driver'
+  require_relative 'appium_lib/driver'
 end

data/lib/appium_lib/android/webview/javascript.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+module Appium; end # fix module not defined
+module Android; end
+module Appium::Android::Webview
+  class << self
+    # firstEmailInput().value = 'example';
+    # firstPasswordInput().value =  'example'
+    # firstSubmitElement().click();
+
+    # todo: prevent namespace pollution
+    # AppiumWebview = { 'ok': function() { return 'ok'; }, 'ok2': function() { return self.ok(); } }
+
+    def javascript
+      @javascript_webview_helpers ||= <<-'JS'
+function firstTagWithTypeOrName(targetTag, targetType, targetName) {
+  var inputs = document.getElementsByTagName(targetTag);
+  var inputsLength = inputs.length;
+  var target = null;
+
+  var targetNames = [];
+  if (targetName) targetNames = targetName.split(",");
+
+  for (var i = 0; i < inputsLength; i++) {
+    var input = inputs[i];
+
+    if (targetType) {
+      var type = input.type;
+      var hasType = typeof type !== "undefined";
+      if (hasType && type.trim().toLowerCase() === targetType) {
+        target = input;
+        break;
+      }
+    }
+
+    // type only search will have undefined targetName.
+    if (targetName) {
+      var name = input.name;
+      var hasName = typeof name !== "undefined";
+      if (hasName && targetNames.indexOf(name.trim().toLowerCase()) !== -1) {
+        target = input;
+        break;
+      }
+    }
+  }
+
+  return target;
+}
+
+function firstInputWithTypeOrName(targetType, targetName) {
+  return firstTagWithTypeOrName('input', targetType, targetName);
+}
+
+function firstEmailInput() {
+  return firstInputWithTypeOrName('email', 'id,username');
+}
+
+function firstPasswordInput() {
+  return firstInputWithTypeOrName('password', 'password');
+}
+
+// yahoo uses a submit button
+function firstSubmitElement() {
+  return firstTagWithTypeOrName('button', 'submit', 'submit') ||
+         firstTagWithTypeOrName('input', 'submit', 'submit') ||
+         firstTagWithTypeOrName('a', 'submit', 'submit');
+}
+
+// yahoo authorize link
+// <a type="submit"
+function firstAuthElement() {
+  return firstTagWithTypeOrName('a', 'submit');
+}
+      JS
+    end
+  end
+end

data/lib/appium_lib/android/webview/webview.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+# system requires
+require 'net/http'
+
+# 3rd party gems
+require 'rubygems'
+require 'json'
+require 'posix/spawn'
+require 'webkit_remote' # https://github.com/pwnall/webkit_remote/
+
+module Appium; end # fix module not defined
+module Android; end
+module Appium::Android::Webview
+  class << self
+    # @private
+    def adb_cmd cmd
+      _pid, _in, _out, _err = POSIX::Spawn::popen4 cmd, {:err => [:child, :out]}
+      _in.close
+
+      output = ''
+
+      begin
+        Process.waitpid _pid
+        output = _out.read
+        [_out, _err].each { |io| io.close unless io.nil? || io.closed? }
+      rescue # no such process
+      end
+
+      output
+    end
+
+    # @private
+    # returns nil if not found
+    def package_to_pid package
+      # USER     PID   PPID  VSIZE  RSS     WCHAN    PC         NAME
+      # use detect to return the first match
+      ps = adb_cmd('adb shell ps').split("\r\n").detect { |l| l.split(' ').last == package }
+      ps ? ps.split(' ')[1].to_i : nil # return pid
+    end
+
+    # @private
+    # 1 pid may have many webviews. The path remains the same
+    #
+    #["00000000: 00000002 00000000 00010000 0001 01  4716 @webview_devtools_remote_1597",
+    # "00000000: 00000003 00000000 00000000 0001 03 55080 @webview_devtools_remote_1597",
+    # "00000000: 00000003 00000000 00000000 0001 03 55078 @webview_devtools_remote_1597"]
+    #
+    # returns nil if not found
+    def pid_to_webview pid
+      return nil if pid.nil?
+      # Num       RefCount Protocol Flags    Type St Inode Path
+      cat_proc = adb_cmd 'adb shell cat /proc/net/unix'
+      pid_webview = "@webview_devtools_remote_#{pid}"
+      found = cat_proc.split("\r\n").detect { |l| l.include?(pid_webview) }
+      # must remove '@' prefix for use with adb forward command
+      found ? found.split(' ').last.sub('@', '') : nil
+    end
+
+    # @private
+    # connect_to_webview package: 'com.example.Package'
+    def connect_to_webview opts={}
+      package = opts[:package]
+      raise 'Must provide package' unless package
+      port = opts.fetch :port, 9000
+
+      unix_socket = pid_to_webview package_to_pid 'com.litl.Woven'
+      raise 'No webview found' unless unix_socket
+      adb_cmd "adb forward tcp:#{port} localabstract:#{unix_socket}"
+    end
+
+    # @public
+    #
+    # ```ruby
+    # webview = Appium::Android::Webview.attach_to_tab package: 'com.example.Package', url: 'yahoo.com/'
+    # webview.location
+    # webview.client
+    # webview.client.remote_eval Appium::Android::Webview.javascript
+    # ```
+    #
+    # port: is optional.
+    #
+    # can't be called more than once.
+    #
+    # returns URL of connected tab.
+    def attach_to_tab opts={}
+      connect_to_webview package: opts[:package]
+      target_url = opts[:url]
+      raise 'Must provide :url' unless target_url
+      port = opts.fetch(:port, 9000)
+
+      # webkit_remote defaults to using the last tab.
+      # The browser may have many tabs and the last tab is not always correct.
+      # Detect the tab by inspecting the URL.
+      # https://github.com/pwnall/webkit_remote/blob/590bfd3ace098f2b75d1a07651f36f4392109a23/lib/webkit_remote/top_level.rb#L30
+      browser = WebkitRemote::Browser.new host: 'localhost', port: port
+      target_tab = browser.tabs.detect { |tab| tab.url.include?(target_url) }
+
+      client = WebkitRemote::Client.new tab: target_tab, close_browser: true
+      document_location = client.remote_eval 'document.location.toString()'
+      client.clear_all
+
+      OpenStruct.new( client: client, location: document_location )
+    end
+  end
+end

data/lib/appium_lib/common/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '0.16.0' unless defined? ::Appium::VERSION
-  DATE = '2014-01-09' unless defined? ::Appium::DATE
+  VERSION = '0.17.0' unless defined? ::Appium::VERSION
+  DATE = '2014-01-22' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/driver.rb

@@ -129,27 +129,29 @@ module Appium
   require 'selenium-webdriver'
 
   # common
-  require 'common/helper'
-  require 'common/patch'
-  require 'common/version'
-  require 'common/element/button'
-  require 'common/element/text'
-  require 'common/element/window'
+  require_relative 'common/helper'
+  require_relative 'common/patch'
+  require_relative 'common/version'
+  require_relative 'common/element/button'
+  require_relative 'common/element/text'
+  require_relative 'common/element/window'
 
   # ios
-  require 'ios/helper'
-  require 'ios/patch'
-  require 'ios/element/alert'
-  require 'ios/element/generic'
-  require 'ios/element/textfield'
+  require_relative 'ios/helper'
+  require_relative 'ios/patch'
+  require_relative 'ios/element/alert'
+  require_relative 'ios/element/generic'
+  require_relative 'ios/element/textfield'
 
   # android
-  require 'android/dynamic'
-  require 'android/helper'
-  require 'android/patch'
-  require 'android/element/alert'
-  require 'android/element/generic'
-  require 'android/element/textfield'
+  require_relative 'android/dynamic'
+  require_relative 'android/helper'
+  require_relative 'android/patch'
+  require_relative 'android/element/alert'
+  require_relative 'android/element/generic'
+  require_relative 'android/element/textfield'
+  require_relative 'android/webview/javascript'
+  require_relative 'android/webview/webview'
 
   def self.promote_singleton_appium_methods main_module
     raise 'Driver is nil' if $driver.nil?
@@ -250,12 +252,16 @@ module Appium
       # quit last driver
       $driver.driver_quit if $driver
       opts = {} if opts.nil?
+      tmp_opts = {}
+
       # convert to downcased symbols
-      opts.each_pair { |k,v| opts[k.to_s.downcase.strip.intern] = v }
+      opts.each_pair { |k,v| tmp_opts[k.to_s.downcase.strip.intern] = v }
+      opts = tmp_opts
 
       @custom_url = opts.fetch :server_url, false
 
       @compress_xml = opts[:compress_xml] ? true : false
+      @fast_clear = opts[:fast_clear] ? true : false
 
       @export_session = opts.fetch :export_session, false
 
@@ -296,7 +302,7 @@ module Appium
 
       # :ios, :android, :selendroid
       @device = opts.fetch :device, ENV['DEVICE'] || :ios
-      @device = @device.intern # device must be a symbol
+      @device = @device.to_s.downcase.intern # device must be a symbol
 
       # load common methods
       extend Appium::Common
@@ -377,7 +383,7 @@ module Appium
         :'app-package' => @app_package,
         :'app-activity' => @app_activity,
         :'app-wait-activity' => @app_wait_activity || @app_activity,
-        fastClear: false # use adb uninstall/pm install not pm clear
+        fastClear: @fast_clear
       }
     end
 
@@ -627,4 +633,4 @@ end # end module Appium
 # Paging in Pry is annoying :q required to exit.
 # With pager disabled, the output is similar to IRB
 # Only set if Pry is defined.
-Pry.config.pager = false if defined?(Pry)
+Pry.config.pager = false if defined?(Pry)

data/release_notes.md

@@ -1,3 +1,9 @@
+#### v0.16.0 2014-01-09
+
+- [b9264f6](https://github.com/appium/ruby_lib/commit/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa) Release 0.16.0
+- [18466ea](https://github.com/appium/ruby_lib/commit/18466eae986647b27e3dbb041c591ce2dbc972a2) Hide invisible elements in iOS page output
+
+
 #### v0.15.2 2013-12-23
 
 - [35b84fd](https://github.com/appium/ruby_lib/commit/35b84fd4a0dcf37fe136451c9bcfa936e1017023) Release 0.15.2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -67,47 +67,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: posix-spawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.4
-  type: :development
+        version: 0.3.8
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: 0.3.8
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: webkit_remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7.3
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7.3
+        version: 10.0.4
 - !ruby/object:Gem::Dependency
-  name: posix-spawn
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.8.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.8.7.3
 description: Ruby library for Appium.
 email:
 - code@bootstraponline.com
@@ -121,6 +135,7 @@ files:
 - Rakefile
 - appium_lib.gemspec
 - docs/android_docs.md
+- docs/api_19_webview.md
 - docs/docs.md
 - docs/ios_docs.md
 - docs_gen/docs_from_js.md
@@ -132,6 +147,8 @@ files:
 - lib/appium_lib/android/element/textfield.rb
 - lib/appium_lib/android/helper.rb
 - lib/appium_lib/android/patch.rb
+- lib/appium_lib/android/webview/javascript.rb
+- lib/appium_lib/android/webview/webview.rb
 - lib/appium_lib/common/element/button.rb
 - lib/appium_lib/common/element/text.rb
 - lib/appium_lib/common/element/window.rb