appium_lib 0.0.21

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTY2ZDQ0ZGExZTAzZjk4ZTU2YzBkMjBlYTdjZTE1MDk4NDJmZmZmZg==
+  data.tar.gz: !binary |-
+    ZTBjMjc1NzZhY2UzMTQxNjZkZTJhODM3NTE4ZDFlNGEyYmEzY2RkMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjU1ODExZDgwZWFhMmNhNjYwOWU0ZGRjMjk2YjAzMmM4NzllZWY0OTMzNDQy
+    ODg4ODI3NDQ4OWJlNzgwNzlhYWM1YzllNWM5ZWIyZjM1OTJmYWIwYzI4YTdh
+    ZjhkZTQ0NzI2NGMwNjRjZThmMmZmMGFjNWZiY2E2YWY3NzdlNGQ=
+  data.tar.gz: !binary |-
+    NGIxOWI1MTUzY2IxM2Q3OWFiZmEyNmFkYWI5ODA4M2M5ZTlkYmMwYmU0OTA4
+    OWYxNDBhODVlOWEyZjQ0YzA0MmRjMDQ2ZDg1NGZiYmYzNGMwOWYxZjAyYzU2
+    N2NjNjQ2NmJmMjMyNTU3NWJiYzJmN2E3NzI0Yzc1N2VkZWQ5YWQ=

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+# Defines gem name.
+def repo_name; 'appium_lib'; end # ruby_lib published as appium_lib
+def version_file; "lib/#{repo_name}/version.rb"; end
+def version_rgx; /VERSION = '([^']+)'/m; end
+
+def version
+  @version = @version || File.read(version_file).match(version_rgx)[1]
+end
+
+def bump
+  data = File.read version_file
+
+  v_line = data.match version_rgx
+  d_line = data.match /DATE = '([^']+)'/m
+
+  old_v = v_line[0]
+  old_d = d_line[0]
+
+  old_num = v_line[1]
+  new_num = old_num.split('.')
+  new_num[-1] = new_num[-1].to_i + 1
+  new_num = new_num.join '.'
+
+  new_v = old_v.sub old_num, new_num
+  puts "#{old_num} -> #{new_num}"
+
+  old_date = d_line[1]
+  new_date = Date.today.to_s
+  new_d = old_d.sub old_date, new_date
+  puts "#{old_date} -> #{new_date}" unless old_date == new_date
+
+  data.sub! old_v, new_v
+  data.sub! old_d, new_d
+
+  File.write version_file, data
+end
+
+desc 'Bump the version number and update the date.'
+task :bump do
+  bump
+end
+
+# Inspired by Gollum's Rakefile
+desc 'Build and release a new gem to rubygems.org'
+task :release => :gem do
+  unless `git branch`.include? '* master'
+    puts 'Master branch required to release.'
+    exit!
+  end
+
+  # Commit then pull before pushing.
+  sh "git commit --allow-empty -am 'Release #{version}'"
+  sh 'git pull'
+  sh "git tag v#{version}"
+  sh 'git push origin master'
+  sh "git push origin v#{version}"
+  sh "gem push #{repo_name}-#{version}.gem"
+end
+
+desc 'Build a new gem'
+task :gem do
+  `chmod 0600 ~/.gem/credentials`
+  sh "gem build #{repo_name}.gemspec"
+end
+
+desc 'Build a new gem (same as gem task)'
+task :build => :gem do
+end
+
+desc 'Install gem'
+task :install => :gem do
+ `gem uninstall -aIx #{repo_name}`
+ sh "gem install --no-rdoc --no-ri #{repo_name}-#{version}.gem"
+end

data/appium_lib.gemspec

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+def self.add_to_path path
+ path = File.expand_path "../#{path}/", __FILE__
+
+ $:.unshift path unless $:.include? path
+end
+
+add_to_path 'lib'
+
+require 'appium_lib/version'
+
+Gem::Specification.new do |s|
+  # 1.8.x is not supported
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.name = 'appium_lib'
+  s.version = AppiumLib::VERSION
+  s.date = AppiumLib::DATE
+  s.license = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+  s.description = s.summary = 'Ruby lib for use with Appium'
+  s.description += '.' # avoid identical warning
+  s.authors = s.email = [ 'code@bootstraponline.com' ]
+  s.homepage = 'https://github.com/appium/ruby_lib' # published as appium_lib
+  s.require_paths = [ 'lib' ]
+
+  s.add_runtime_dependency 'selenium-webdriver', '~> 2.31.0'
+  s.add_runtime_dependency 'awesome_print', '~> 1.1.0'
+
+  s.add_development_dependency 'rake', '~> 10.0.3'
+
+  s.files = `git ls-files`.split "\n"
+end

data/lib/appium_lib.rb

@@ -0,0 +1,10 @@
+def self.add_to_path file, path=false
+ path = path ? "../#{path}/" : '..' 
+ path = File.expand_path path, file
+
+ $:.unshift path unless $:.include? path
+end
+
+add_to_path __FILE__, 'appium_lib'
+
+require 'console'

data/lib/appium_lib/console.rb

@@ -0,0 +1,207 @@
+# encoding: utf-8
+=begin
+Run with:
+pry -r ./console.rb
+
+Based on simple_test.rb
+https://github.com/appium/appium/blob/82995f47408530c80c3376f4e07a1f649d96ba22/sample-code/examples/ruby/simple_test.rb
+https://github.com/appium/appium/blob/c58eeb66f2d6fa3b9a89d188a2e657cca7cb300f/LICENSE
+=end
+
+add_to_path __FILE__
+add_to_path __FILE__, 'element'
+
+require 'selenium-webdriver'
+
+# Path to the .app or .app.zip.
+# The path can be local or remote for Sauce.
+APP_PATH = ENV['APP_PATH'] unless defined?(APP_PATH)
+raise "APP_PATH must be set." if APP_PATH.nil?
+
+# The name to use for the test run on Sauce.
+APP_NAME = ENV['APP_NAME'] unless defined?(APP_NAME)
+
+# Android app package
+APP_PACKAGE = ENV['APP_PACKAGE'] unless defined?(APP_PACKAGE)
+
+# Android app starting activity.
+APP_ACTIVITY = ENV['APP_ACTIVITY'] unless defined?(APP_ACTIVITY)
+
+# Sauce Username
+SAUCE_USERNAME = ENV['SAUCE_USERNAME'] unless defined?(SAUCE_USERNAME)
+
+# Sauce Key
+SAUCE_ACCESS_KEY = ENV['SAUCE_ACCESS_KEY'] unless defined?(SAUCE_ACCESS_KEY)
+
+PORT = ENV['PORT'] || 4723 unless defined?(PORT)
+
+$os = nil
+
+if $os.nil?
+  $os = :ios
+  $os = :android if APP_PATH.end_with?('.apk') || APP_PATH.end_with?('.apk.zip')
+end
+
+puts "OS is: #{$os}" if defined?(Pry)
+
+if $os == :android
+  raise "APP_PACKAGE must be set." if APP_PACKAGE.nil?
+  raise "APP_ACTIVITY must be set." if APP_ACTIVITY.nil?
+end
+
+# ruby_console files load depending on OS
+require 'helper'
+require 'button'
+require 'text'
+require 'window'
+require 'patch'
+require 'alert'
+
+# Android combines secure and textfield.
+# iOS differentiates between secure and textfield.
+# combine secure & textfield on iOS to match Android behavior.
+$os == :ios ? require('ios/textfield') :
+              require('android/textfield')
+
+# WebDriver capabilities. Must be valid for Sauce to work.
+# https://github.com/jlipps/appium/blob/master/app/android.js
+def android_capabilities
+  {
+    browserName: 'Android',
+    platform: 'LINUX',
+    version: '4.1',
+    device: 'Android',
+    name: APP_NAME || 'Ruby Console Android Appium',
+    app: absolute_app_path,
+    :'app-package' => APP_PACKAGE,
+    :'app-activity' => APP_ACTIVITY
+  }
+end
+
+# WebDriver capabilities. Must be valid for Sauce to work.
+def ios_capabilities
+  {
+    browserName: 'iOS 6.0',
+    platform: 'Mac 10.8',
+    version: '6.0',
+    device: 'iPhone Simulator',
+    name: APP_NAME || 'Ruby Console iOS Appium',
+    app: absolute_app_path
+  }
+end
+
+def capabilities
+  $os == :ios ? ios_capabilities : android_capabilities
+end
+
+# Converts environment variable APP_PATH to an absolute path.
+# @return [String] APP_PATH as an absolute path
+def absolute_app_path
+    raise 'APP_PATH environment variable not set!' if APP_PATH.nil?
+    return APP_PATH if APP_PATH.match(/^http/) # public URL for Sauce
+    return APP_PATH if APP_PATH.match(/^\//) # absolute file path
+    file = File.join(File.dirname(__FILE__), APP_PATH)
+    raise "App doesn't exist #{file}" unless File.exist? file
+    file
+end
+
+# Get the server url for sauce or local based on env vars.
+# @return [String] the server url
+def server_url
+  if !SAUCE_USERNAME.nil? && !SAUCE_ACCESS_KEY.nil?
+    "http://#{SAUCE_USERNAME}:#{SAUCE_ACCESS_KEY}@ondemand.saucelabs.com:80/wd/hub"
+  else
+    "http://127.0.0.1:#{PORT}/wd/hub"
+  end
+end
+
+# Quits the driver
+# @return [void]
+def driver_quit
+  # rescue NoSuchDriverError
+  begin; $driver.quit unless $driver.nil?; rescue; end
+end
+
+# Creates a new global driver and quits the old one if it exists.
+# @return [Selenium::WebDriver] the new global driver
+def start_driver
+  @client = @client || Selenium::WebDriver::Remote::Http::Default.new
+  @client.timeout = 999999
+
+  # If the driver already exists, quit before creating a new driver.
+  driver_quit
+
+  begin
+    $driver = Selenium::WebDriver.for(:remote, http_client: @client, desired_capabilities: capabilities, url: server_url)
+  rescue Errno::ECONNREFUSED
+    puts 'ERROR: Unable to connect to Appium. Is the server running?'
+    exit
+  end
+
+  # Set timeout to a large number so that Appium doesn't quit
+  # when no commands are entered after 60 seconds.
+  $driver.execute_script 'mobile: setCommandTimeout', timeout: 9999
+
+  # Must set implicit_wait to zero or $ commands will fail.
+  # execute_script "$('button')"
+  # $ commands fail anyway now so set implicit wait.
+  # https://github.com/appium/appium/issues/214
+  $driver.manage.timeouts.implicit_wait = 30
+
+  $driver
+end
+
+# Set implicit wait to zero.
+def no_wait
+  $driver.manage.timeouts.implicit_wait = 0
+end
+
+# Set implicit wait to timeout, defaults to 30.
+# @param timeout [Integer] the timeout in seconds
+# @return [void]
+def set_wait timeout=30
+  $driver.manage.timeouts.implicit_wait = timeout
+end
+
+# The same as $driver.execute_script
+# @return the object returned by execute_script
+def execute_script script, *args
+  $driver.execute_script script, *args
+end
+
+# Helper method for mobile gestures
+#
+# https://github.com/appium/appium/wiki/Automating-mobile-gestures
+#
+# $driver.execute_script 'mobile: swipe', endX: 100, endY: 100, duration: 0.01
+#
+# becomes
+#
+# mobile :swipe, endX: 100, endY: 100, duration: 0.01
+def mobile method, *args
+  raise "Method must not be nil" if method.nil?
+  raise "Method must have .to_s" unless method.respond_to? :to_s
+  $driver.execute_script "mobile: #{method.to_s}", *args
+end
+
+# Calls $driver.find_elements
+def find_elements *args
+  $driver.find_elements *args
+end
+
+# Calls $driver.find_elements
+def find_element *args
+  $driver.find_element *args
+end
+
+# Quit the driver and Pry.
+# quit and exit are reserved by Pry.
+def x
+  driver_quit
+  exit # exit pry
+end
+
+# 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)

data/lib/appium_lib/element/alert.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+# iOS only
+# Tap the alert button identified by value.
+# @param value [Integer, String] either an integer index of the button or the button's name
+# @return [void]
+def alert_click value
+  $driver.execute_script "UIATarget.localTarget().frontMostApp().alert().buttons()[#{value}].tap();"
+end
+
+# Get the alert message text.
+# @return [String]
+def alert_text
+  $driver.switch_to.alert.text
+end
+
+# Accept the alert.
+# @return [void]
+def alert_accept
+  $driver.switch_to.alert.accept
+end
+
+# Get the text of the alert's accept button.
+# The last button is considered "accept."
+# @return [String]
+def alert_accept_text
+  a = $driver.find_element(:tag_name, :alert)
+  return if a.nil?
+  b = a.find_elements(:tag_name, :button)
+  b.last.text if b && b.size >= 1
+end
+
+# Dismiss the alert.
+# @return [void]
+def alert_dismiss
+  $driver.switch_to.alert.dismiss
+end
+
+# Get the text of the alert's dismiss button.
+# The first button is considered "dismiss."
+# @return [String]
+def alert_dismiss_text
+  a = $driver.find_element(:tag_name, :alert)
+  return if a.nil?
+  b = a.find_elements(:tag_name, :button)
+  b.first.text if b && b.size >= 1
+end

data/lib/appium_lib/element/android/textfield.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+# UIATextField methods
+
+if $os == :android
+
+# Get an array of textfield texts.
+# @return [Array<String>]
+def textfields
+  find_eles_attr :textfield, :text
+end
+
+# Get an array of textfield elements.
+# @return [Array<Textfield>]
+def e_textfields
+  find_eles :textfield
+end
+
+# Get the first textfield element.
+# @return [Textfield]
+def first_textfield
+  first_ele :textfield
+end
+
+# Get the last textfield element.
+# @return [Textfield]
+def last_textfield
+  last_ele :textfield
+end
+
+# Get the first textfield that matches text.
+# @param text [String, Integer] the text to match exactly. If int then the textfield at that index is returned.
+# @return [Textfield]
+def textfield text
+  return ele_index :textfield, text if text.is_a? Numeric
+  find_ele_by_text :textfield, text
+end
+
+# Get the first textfield that includes text.
+# @param text [String] the text the textfield must include
+# @return [Textfield]
+def textfield_include text
+  find_ele_by_text_include :textfield, text
+end
+
+end # if $os

data/lib/appium_lib/element/button.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+# UIAButton methods
+
+=begin
+ Method Signatures:
+
+   button( text, number = -1 )
+   buttons( text = nil )
+   button_include( text )
+   buttons_include( text )
+   first_button
+   last_button
+
+ Examples:
+
+   button 'text'    # 1st button exactly matching text
+   button 'text', 2 # 2nd button exactly matching text
+
+   buttons          # text of all buttons.
+   buttons 'text'   # all buttons exactly matching text
+
+   button_include  'text' # the first button that includes text
+   buttons_include 'text' # all buttons that include text
+
+   first_button     # the first button
+   last_button      # the last button
+=end
+
+# Find a button by text and optionally number.
+# @param text [String, Integer] the text to exactly match. If int then the button at that index is returned.
+# @param number [Integer] the occurance of the button matching text. Defaults to the first button.
+# @return [Button] the button found with text and matching number
+def button text, number=0
+  return ele_index :button, text if text.is_a? Numeric
+
+  number >= 1 ? button_text_num( text, number ) :
+  button_text( text )
+end
+
+# Get an array of button texts or button elements if text is provided.
+# @param text [String] the text to exactly match
+# @return [Array<String>, Array<Buttons>] either an array of button texts or an array of button elements if text is provided.
+def buttons text=nil
+  text == nil ? find_eles_attr(:button, :text) :
+                find_ele_by_text(:button, text)
+end
+
+# Get the first button that includes text.
+# @param text [String] the text that the element must include
+# @return [Button]
+def button_include text
+  find_ele_by_text_include :button, text
+end
+
+# Get all buttons that include text.
+# @param text [String] the text that the element must include
+# @return [Array<Button>]
+def buttons_include text
+  find_eles_by_text_include :button, text
+end
+
+# Get the first button element.
+# @return [Button]
+def first_button
+  first_ele :button
+end
+
+# Get the last button element.
+# @return [Button]
+def last_button
+  last_ele :button
+end
+
+# -- prefer above methods before using these.
+private
+
+# Get the first button element that exactly matches text.
+# @param text [String] the text to match exactly
+# @return [Button]
+def button_text text
+  find_ele_by_text :button, text
+end
+
+# Get the button element exactly matching text and
+# occurrence. number=2 means the 2nd occurrence.
+#
+# find the second Sign In button
+#
+# b = e_button 'Sign In', 2
+#
+# Button order will change in iOS vs Android
+# so if there's no button found at number then
+# return the first button.
+#
+# @param text [String] the text to match exactly
+# @param number [Integer] the button occurance to return. 1 = first button
+# @return [Button] the button that exactly matches text and number
+def button_text_num text, number=1
+  raise "Number must be >= 1" if number <= 0
+  number = number - 1 # zero indexed
+
+  result = nil
+
+  elements = find_eles_by_text :button, text
+  elements.size > number ? result = elements[number]
+                         : result = elements.first
+
+  result
+end
+
+# Get an array of button elements.
+# @return [Array<Button>]
+def e_buttons
+  find_eles :button
+end

data/lib/appium_lib/element/ios/textfield.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+# UIATextField & UIASecureTextField methods
+#
+# Find textfield and then secure elements in one server call
+# to match Android.
+
+if $os == :ios
+
+# Get an array of textfield texts.
+# @return [Array<String>]
+def textfields
+  find_2_eles_attr :textfield, :secure, :text
+end
+
+# Get an array of textfield elements.
+# @return [Array<Textfield>]
+def e_textfields
+  execute_script textfield_js
+end
+
+# Get the first textfield element.
+# @return [Textfield]
+def first_textfield
+  js = textfield_js 'r = r.length > 0 ? $(r[0]) : r;'
+  execute_script(js).first
+end
+
+# Get the last textfield element.
+# @return [Textfield]
+def last_textfield
+  js = textfield_js 'r = r.length > 0 ? $(r[r.length - 1]) : r;'
+  execute_script(js).first
+end
+
+# Get the first textfield that matches text.
+# @param text [String, Integer] the text to match exactly. If int then the textfield at that index is returned.
+# @return [Textfield]
+def textfield text
+  # Don't use ele_index because that only works on one element type.
+  # iOS needs to combine textfield and secure to match Android.
+  if text.is_a? Numeric
+    js = textfield_js 'r = r.length > 0 ? $(r[#{text}]) : r;'
+    return execute_script(js).first
+  end
+
+  # find_ele_by_text :textfield, text
+  js = %Q(
+    var t = au.getElementsByXpath('textfield[@text="#{text}"]').value;
+    var s = au.getElementsByXpath('secure[@text="#{text}"]').value;
+    t.concat(s)[0];
+  )
+
+  puts js if defined?(Pry)
+
+  execute_script js
+end
+
+# Get the first textfield that includes text.
+# @param text [String] the text the textfield must include
+# @return [Textfield]
+def textfield_include text
+  js = %Q(
+    var t = au.getElementsByXpath('textfield[contains(@text, "#{text}")]').value;
+    var s = au.getElementsByXpath('secure[contains(@text, "#{text}")]').value;
+    t.concat(s)[0];
+  )
+
+  puts js if defined?(Pry)
+
+  execute_script js
+end
+
+private
+
+# Return combined lookup of textfield and secure
+# with an optional filter. $() wrap is required for .each
+def textfield_js filter=''
+%Q(
+  var t = au.lookup('textfield');
+  var s = au.lookup('secure');
+  var r = $(t.concat(s));
+  #{filter}
+  au._returnElems(r);
+)
+end
+
+end # if $os

data/lib/appium_lib/element/text.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+# UIAStaticText methods
+
+# Get an array of text texts.
+# @return [Array<String>]
+def texts
+  find_eles_attr :text, :text
+end
+
+# Get an array of text elements.
+# @return [Array<Text>]
+def e_texts
+  find_eles :text
+end
+
+# Get the first text element.
+# @return [Text]
+def first_text
+  first_ele :text
+end
+
+# Get the last text element
+# @return [Text]
+def last_text
+  last_ele :text
+end
+
+# Get the first element that matches text.
+# @param text [String, Integer] the text to find exactly. If int then the text at that index is returned.
+# @return [Text]
+def text text
+  return ele_index :text, text if text.is_a? Numeric
+  find_ele_by_text :text, text
+end
+
+# Get the first textfield that includes text.
+# @param text [String] the text that the tag must include
+# @return [Text]
+def text_include text
+  find_ele_by_text_include :text, text
+end

data/lib/appium_lib/element/window.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+# UIAWindow methods
+
+# Get the window's size
+#
+# window_size.width
+#
+# window_size.height
+def window_size
+  return nil if $driver.nil?
+  $driver.manage.window.size
+end

data/lib/appium_lib/helper.rb

@@ -0,0 +1,176 @@
+# encoding: utf-8
+# Generic helper methods not specific
+# to a particular tag name
+
+# json and ap are required for the source method.
+require 'json'
+require 'ap' # awesome print
+require 'timeout' # for wait
+
+# iOS .name returns the accessibility attribute if it's set. if not set, the string value is used.
+# Android .name returns the accessibility attribute and nothing if it's not set.
+#
+# .text should be cross platform so prefer that over name, unless both
+# Android and iOS have proper accessibility attributes.
+# .text and .value should be the same so use .text over .value.
+#
+# secure tag_name is iOS only because it can't be implemented using uiautomator for Android.
+#
+# find_element :text doesn't work so use XPath to find by text.
+
+# Check every 0.5 seconds to see if block.call is true.
+# Give up after 30 seconds.
+# @param block [Block] the block to call
+# @return [Object] the result of block.call
+def wait &block
+  # Rescue Timeout::Error: execution expired
+  result = nil
+  timeout(30) { while(!(result = begin;block.call;rescue;end)) do; sleep(0.5) end }
+  result
+end
+
+# Presses the back button on Android.
+# @return [void]
+def back
+  $driver.navigate.back
+end
+
+# Get the element of type tag_name at matching index.
+# @param tag_name [String] the tag name to find
+# @param index [Integer] the index
+# @return [Element] the found element of type tag_name
+def ele_index tag_name, index
+  find_eles(tag_name)[index]
+end
+
+# Get all elements exactly matching tag name
+# @param tag_name [String] the tag name to find
+# @return [Array<Element>] the found elements of type tag_name
+def find_eles tag_name
+  $driver.find_elements :tag_name, tag_name
+end
+
+# iOS only. Android uses uiautomator instead of uiautomation.
+# Get an array of attribute values from elements exactly matching tag name.
+# @param tag_name [String] the tag name to find
+# @param attribute [String] the attribute to collect
+# @result [Array<String>] an array of strings containing the attribute from found elements of type tag_name.
+def find_eles_attr tag_name, attribute
+  # Use au.lookup(tag_name) instead of $(tag_name)
+  # See https://github.com/appium/appium/issues/214
+  js = %Q(
+    var eles = au.lookup('#{tag_name}');
+    var result = [];
+    for (var a = 0, length = eles.length; a < length; a++) {
+      result.push(eles[a].#{attribute}());
+    }
+    result
+  )
+
+  $driver.execute_script js
+end
+
+# iOS only. Android uses uiautomator instead of uiautomation.
+# Get an array of attribute values from elements exactly matching tag name.
+# @param tag_name_1 [String] the 1st tag name to find
+# @param tag_name_2 [String] the 2nd tag name to find
+# @param attribute [String] the attribute to collect
+# @result [Array<String>] an array of strings containing the attribute from found elements of type tag_name.
+def find_2_eles_attr tag_name_1, tag_name_2, attribute
+  # Use au.lookup(tag_name) instead of $(tag_name)
+  # See https://github.com/appium/appium/issues/214
+  js = %Q(
+    var eles = au.lookup('#{tag_name_1}');
+    eles = $(eles.concat(au.lookup('#{tag_name_2}')));
+    var result = [];
+    for (var a = 0, length = eles.length; a < length; a++) {
+      result.push(eles[a].#{attribute}());
+    }
+    result
+  )
+
+  $driver.execute_script js
+end
+
+# Get the first tag that exactly matches tag and text.
+# @param tag [String] the tag name to match
+# @param text [String] the text to exactly match
+# @return [Element] the element of type tag exactly matching text
+def find_ele_by_text tag, text
+  $driver.find_element :xpath, %Q(#{tag}[@text='#{text}'])
+end
+
+# Get all tags that exactly match tag and text.
+# @param tag [String] the tag name to match
+# @param text [String] the text to exactly match
+# @return [Array<Element>] the elements of type tag exactly matching text
+def find_eles_by_text tag, text
+  $driver.find_elements :xpath, %Q(#{tag}[@text='#{text}'])
+end
+
+# Get the first tag by attribute that exactly matches value.
+# @param tag [String] the tag name to match
+# @param attr [String] the attribute to compare
+# @param value [String] the value of the attribute that the element must include
+# @return [Element] the element of type tag who's attribute includes value
+def find_ele_by_attr_include tag, attr, value
+  $driver.find_element :xpath, %Q(#{tag}[contains(@#{attr}, '#{value}')])
+end
+
+# Get tags by attribute that include value.
+# @param tag [String] the tag name to match
+# @param attr [String] the attribute to compare
+# @param value [String] the value of the attribute that the element must include
+# @return [Array<Element>] the elements of type tag who's attribute includes value
+def find_eles_by_attr_include tag, attr, value
+  $driver.find_elements :xpath, %Q(#{tag}[contains(@#{attr}, '#{value}')])
+end
+
+# Get the first tag that includes text.
+# @param tag [String] the tag name to match
+# @param text [String] the text the element must include
+# @return [Element] the element of type tag that includes text
+# element.attribute(:text).include? text
+def find_ele_by_text_include tag, text
+  find_ele_by_attr_include tag, :text, text
+end
+
+# Get the tags that include text.
+# @param tag [String] the tag name to match
+# @param text [String] the text the element must include
+# @return [Array<Element>] the elements of type tag that includes text
+# element.attribute(:text).include? text
+def find_eles_by_text_include tag, text
+  find_eles_by_attr_include tag, :text, text
+end
+
+# Get the first tag that matches tag_name
+# @param tag_name [String] the tag to match
+# @return [Element]
+def first_ele tag_name
+  tag = find_eles tag_name
+  tag = tag.first unless tag.nil?
+end
+
+# Get the last tag that matches tag_name
+# @param tag_name [String] the tag to match
+# @return [Element]
+def last_ele tag_name
+  tag = find_eles tag_name
+  tag = tag.last unless tag.nil?
+end
+
+# Prints a JSON view of the current page
+# @return [void]
+def source
+  ap JSON.parse($driver.page_source)
+end
+
+# iOS only. On Android uiautomator always returns an empty string for EditText password.
+#
+# Password character returned from value of UIASecureTextField
+# @param length [Integer] the length of the password to generate
+# @return [String] the returned string is of size length
+def password length=1
+  '•' * length
+end

data/lib/appium_lib/patch.rb

@@ -0,0 +1,93 @@
+# Implement useful features for element.
+class Selenium::WebDriver::Element
+  # Note: For testing .text should be used over value, and name.
+
+  # Fixes NoMethodError: undefined method `value' for #<Selenium::WebDriver::Element:0x..fa4a9148235390a44 id="1">
+  def value
+    self.attribute :value
+  end
+  
+  # Fixes NoMethodError: undefined method `name' for #<Selenium::WebDriver::Element
+  def name
+    self.attribute :name
+  end
+  
+  # Fixes NoMethodError: undefined method `type' for #<Selenium::WebDriver::Element
+  def type
+    self.attribute :type
+  end
+  
+  # Tag name appears to be the same as type.
+  #
+  # Fixes Selenium::WebDriver::Error::UnknownError: Not yet implemented
+  def tag_name
+    type
+  end
+
+  # Cross platform way of entering text into a textfield
+  def set_value text
+  # enter text then tap window to hide the keyboard.
+  js = %Q(
+    au.getElement('#{self.ref}').setValue('#{text}');
+    au.lookup('window')[0].tap()
+  )
+  $driver.execute_script js
+  end if $os == :ios
+
+  # Cross platform way of entering text into a textfield
+  def set_value text
+    self.send_keys text
+  end if $os == :android
+
+  # For use with mobile tap.
+  #
+  # $driver.execute_script 'mobile: tap', :x => 0.0, :y => 0.98
+  #
+  # https://github.com/appium/appium/wiki/Automating-mobile-gestures
+  # @return [OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
+  def location_rel
+    xy = self.location
+    w = window_size
+    OpenStruct.new( x: xy.x.to_f / w.width.to_f,
+                    y: xy.y.to_f / w.height.to_f )
+  end
+end
+
+# Print JSON posted to Appium
+#
+# Requires from lib/selenium/webdriver/remote.rb
+require 'selenium/webdriver/remote/capabilities'
+require 'selenium/webdriver/remote/bridge'
+require 'selenium/webdriver/remote/server_error'
+require 'selenium/webdriver/remote/response'
+require 'selenium/webdriver/remote/commands'
+require 'selenium/webdriver/remote/http/common'
+require 'selenium/webdriver/remote/http/default'
+
+# Show http calls to the Selenium server.
+#
+# Invaluable for debugging.
+module Selenium::WebDriver::Remote
+  class Bridge
+    # Code from lib/selenium/webdriver/remote/bridge.rb
+    def raw_execute(command, opts = {}, command_hash = nil)
+      verb, path = COMMANDS[command] || raise(ArgumentError, "unknown command: #{command.inspect}")
+      path       = path.dup
+      
+      path[':session_id'] = @session_id if path.include?(":session_id")
+      
+      begin
+        opts.each { |key, value| path[key.inspect] = escaper.escape(value.to_s) }
+        rescue IndexError
+        raise ArgumentError, "#{opts.inspect} invalid for #{command.inspect}"
+      end
+      
+      puts verb
+      puts path
+      puts command_hash.to_json
+      
+      puts "-> #{verb.to_s.upcase} #{path}" if $DEBUG
+      http.call verb, path, command_hash
+    end # def
+  end # class
+end if defined?(Pry)# module

data/lib/appium_lib/version.rb

@@ -0,0 +1,4 @@
+module AppiumLib
+  VERSION = '0.0.21' unless defined? ::AppiumLib::VERSION
+  DATE = '2013-03-22' unless defined? ::AppiumLib::DATE
+end

data/readme.md

@@ -0,0 +1,30 @@
+#### appium_lib [![Dependency Status](https://gemnasium.com/appium/ruby_lib.png)](https://gemnasium.com/appium/ruby_lib)
+
+- [appium_lib on RubyGems](https://rubygems.org/gems/appium_lib)
+- [Documentation for appium_lib](http://www.rubydoc.info/github/appium/ruby_lib/master/frames)
+
+Helper methods for writing cross platform (iPad, iPhone, Android) tests in Ruby using Appium.
+
+Make sure you're using Ruby 1.9.3+ with upgraded rubygems and bundler.
+
+#### Install / Upgrade
+
+Update rubygems and bundler.
+
+```ruby
+gem update --system ;\
+gem update bundler
+```
+
+Install the latest gem release.
+
+```ruby
+gem uninstall -aIx appium_lib ;\
+gem install --no-rdoc --no-ri appium_lib
+```
+
+#### Run from Source
+
+`pry -r ./lib/appium_lib.rb`
+
+Then `start_driver`

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: appium_lib
+version: !ruby/object:Gem::Version
+  version: 0.0.21
+platform: ruby
+authors:
+- code@bootstraponline.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.31.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.31.0
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+description: Ruby lib for use with Appium.
+email:
+- code@bootstraponline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE-2.0.txt
+- Rakefile
+- appium_lib.gemspec
+- lib/appium_lib.rb
+- lib/appium_lib/console.rb
+- lib/appium_lib/element/alert.rb
+- lib/appium_lib/element/android/textfield.rb
+- lib/appium_lib/element/button.rb
+- lib/appium_lib/element/ios/textfield.rb
+- lib/appium_lib/element/text.rb
+- lib/appium_lib/element/window.rb
+- lib/appium_lib/helper.rb
+- lib/appium_lib/patch.rb
+- lib/appium_lib/version.rb
+- readme.md
+homepage: https://github.com/appium/ruby_lib
+licenses:
+- http://www.apache.org/licenses/LICENSE-2.0.txt
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby lib for use with Appium
+test_files: []