appium_lib 4.0.0 → 4.1.0

data/ios_tests/lib/ios/specs/common/helper.rb

@@ -8,7 +8,7 @@ describe 'common/helper.rb' do
     before_first
   end
 
-  wait_time = [0.2, 0.2] # max_wait, interval
+  wait_opts = { timeout: 0.2, interval: 0.2 } # max_wait, interval
 
 =begin
 There's no `must_not_raise` as the opposite of must_raise
@@ -21,17 +21,20 @@ must_not_raise is a no-op.
   # max_wait=0 is infinity to use 0.1
   t 'wait' do
     # successful wait should not raise error
-    wait(*wait_time) { true }
-    wait(*wait_time) { false }
-    wait(*wait_time) { nil }
+    wait(wait_opts) { true }
+    wait(wait_opts) { false }
+    wait(wait_opts) { nil }
 
     # failed wait should error
-    proc { wait(*wait_time) { raise } }.must_raise Timeout::Error
+    proc { wait(wait_opts) { raise } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # regular rescue will not handle exceptions outside of StandardError hierarchy
     # must rescue Exception explicitly to rescue everything
-    proc { wait(*wait_time) { raise NoMemoryError } }.must_raise Timeout::Error
-    proc { wait(0.2, 0.0) { raise NoMemoryError } }.must_raise Timeout::Error
+    proc { wait(wait_opts) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait(timeout: 0.2, interval: 0.0) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+
+    # invalid keys are rejected
+    proc { wait(invalidkey: 2) { true } }.must_raise RuntimeError
   end
 
   t 'ignore' do
@@ -46,19 +49,22 @@ must_not_raise is a no-op.
   # wait_true is a success unless the value is not true
   t 'wait_true' do
     # successful wait should not error
-    wait_true(*wait_time) { true }
+    wait_true(wait_opts) { true }
 
     # failed wait should error
-    proc { wait_true(*wait_time) { false } }.must_raise Timeout::Error
-    proc { wait_true(*wait_time) { nil } }.must_raise Timeout::Error
+    proc { wait_true(wait_opts) { false } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait_true(wait_opts) { nil } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # raise should error
-    proc { wait_true(*wait_time) { raise } }.must_raise Timeout::Error
+    proc { wait_true(wait_opts) { raise } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # regular rescue will not handle exceptions outside of StandardError hierarchy
     # must rescue Exception explicitly to rescue everything
-    proc { wait_true(*wait_time) { raise NoMemoryError } }.must_raise Timeout::Error
-    proc { wait_true(0.2, 0.0) { raise NoMemoryError } }.must_raise Timeout::Error
+    proc { wait_true(wait_opts) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait_true(timeout: 0.2, interval: 0.0) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+
+    # invalid keys are rejected
+    proc { wait_true(invalidkey: 2) { true } }.must_raise RuntimeError
   end
 
   # t 'id' # id is for Selendroid

data/lib/appium_lib/android/client_xpath.rb

@@ -0,0 +1,47 @@
+require 'nokogiri'
+
+module Appium
+  module Android
+    def _nodeset_to_uiselector opts={}
+      results = ''
+
+      nodes = opts[:nodes]
+      first = opts[:first]
+
+      nodes = [nodes[0]] if first
+
+      nodes.each do |node|
+        results += %Q(new UiSelector().className("#{node.name}").instance(#{node.attr('instance')});)
+      end
+
+      results.strip
+    end
+
+    def _client_xpath opts={}
+      root_node = Nokogiri::XML(get_source).children.first
+
+      instance = Hash.new -1
+
+      root_node.traverse do |node|
+        number = instance[node.name] += 1
+        node.set_attribute 'instance', number
+      end
+
+      nodes = root_node.xpath(opts[:xpath])
+      first = opts[:first]
+
+      _nodeset_to_uiselector nodes: nodes, first: first
+    end
+
+    def client_xpath xpath
+      find_element :uiautomator, _client_xpath(xpath: xpath, first: true)
+    end
+
+    def client_xpaths xpath
+      find_elements :uiautomator, _client_xpath(xpath: xpath, first: false)
+    end
+  end
+end
+
+# http://stackoverflow.com/questions/9199415/getting-first-node-in-xpath-result-set
+# '(//android.widget.TextView)[1]' not '//android.widget.TextView[1]'

data/lib/appium_lib/common/helper.rb

@@ -18,38 +18,6 @@ module Appium
     #
     # find_element :text doesn't work so use XPath to find by text.
 
-    # Check every 0.5 seconds to see if block.call doesn't raise an exception.
-    # if .call raises an exception then it will be tried again.
-    # if .call doesn't raise an exception then it will stop waiting.
-    #
-    # Example: wait { name('back').click }
-    #
-    # Give up after 30 seconds.
-    # @param max_wait [Integer] the maximum time in seconds to wait for.
-    #         Note that max wait 0 means infinity.
-    # @param interval [Float] the time in seconds to wait after calling the block
-    # @param block [Block] the block to call
-    # @return [Object] the result of block.call
-    def wait max_wait=30, interval=0.5, &block
-      max_wait = 1 if max_wait <= 0
-      result   = nil
-      timeout max_wait do
-        until (
-        begin
-          result = block.call || true
-        rescue Errno::ECONNREFUSED => e
-          raise e
-        rescue Exception
-          sleep interval
-          # sleep returns truthy value which breaks out of until
-          # must return false value
-          false
-        end)
-        end
-      end
-      result
-    end
-
     # Return block.call and ignore any exceptions.
     def ignore &block
       begin
@@ -58,32 +26,6 @@ module Appium
       end
     end
 
-    # Check every 0.5 seconds to see if block.call returns a truthy value.
-    # Note this isn't a strict boolean true, any truthy value is accepted.
-    # false and nil are considered failures.
-    # Give up after 30 seconds.
-    # @param max_wait [Integer] the maximum time in seconds to wait for
-    # @param interval [Float] the time in seconds to wait after calling the block
-    # @param block [Block] the block to call
-    # @return [Object] the result of block.call
-    def wait_true max_wait=30, interval=0.5, &block
-      max_wait = 1 if max_wait <= 0
-      result   = nil
-      timeout max_wait do
-        until (
-        begin
-          result = block.call
-        rescue Errno::ECONNREFUSED => e
-          raise e
-        rescue Exception
-        ensure
-          sleep interval unless result
-        end)
-        end
-      end
-      result
-    end
-
     # Navigate back.
     # @return [void]
     def back

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '4.0.0' unless defined? ::Appium::VERSION
-  DATE    = '2014-07-05' unless defined? ::Appium::DATE
+  VERSION = '4.1.0' unless defined? ::Appium::VERSION
+  DATE    = '2014-07-21' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/common/wait.rb

@@ -0,0 +1,99 @@
+module Appium
+  module Common
+
+    # http://mudge.name/2011/01/26/passing-blocks-in-ruby-without-block.html
+    # Note that the Ruby timeout module is avoided. timeout has problems.
+    # https://coderwall.com/p/1novga
+
+    # Wait code from the selenium Ruby gem
+    # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
+    def _generic_wait opts={}, &block
+      valid_keys = [:timeout, :interval, :message, :ignore, :return_if_true]
+      invalid_keys = []
+      opts.keys.each { |key| invalid_keys << key unless valid_keys.include?(key) }
+      # [:one, :two] => :one, :two
+      raise "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
+
+      timeout        = opts.fetch(:timeout, 30)
+      interval       = opts.fetch(:interval, 0.5)
+      message        = opts[:message]
+      ignored        = Array(opts[:ignore] || ::Exception)
+      return_if_true = opts[:return_if_true]
+
+      end_time   = Time.now + timeout
+      last_error = nil
+
+      until Time.now > end_time
+        begin
+          if return_if_true
+            result = block.call
+            return result if result
+          else
+            return block.call
+          end
+        rescue ::Errno::ECONNREFUSED => e
+          raise e
+        rescue *ignored => last_error
+          # swallowed
+        end
+
+        sleep interval
+      end
+
+      if message
+        msg = message.dup
+      else
+        msg = "timed out after #{timeout} seconds"
+      end
+
+      msg << " (#{last_error.message})" if last_error
+
+      raise Selenium::WebDriver::Error::TimeOutError, msg
+    end
+
+    # process opts before calling _generic_wait
+    def _process_wait_opts opts
+      opts = { timeout: opts } if opts.is_a?(Numeric)
+      raise 'opts must be a hash' unless opts.is_a? Hash
+      opts
+    end
+
+    # Check every interval seconds to see if block.call returns a truthy value.
+    # Note this isn't a strict boolean true, any truthy value is accepted.
+    # false and nil are considered failures.
+    # Give up after timeout seconds.
+    #
+    # Wait code from the selenium Ruby gem
+    # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
+    #
+    # If only a number is provided then it's treated as the timeout value.
+    #
+    # @param [Hash] opts Options
+    # @option opts [Numeric] :timeout (30) Seconds to wait before timing out.
+    # @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
+    # @option opts [String] :message Exception message if timed out.
+    # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
+    def wait_true opts={}, &block
+      opts = _process_wait_opts(opts).merge(return_if_true: true)
+      _generic_wait opts, &block
+    end
+
+    # Check every interval seconds to see if block.call doesn't raise an exception.
+    # Give up after timeout seconds.
+    #
+    # Wait code from the selenium Ruby gem
+    # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
+    #
+    # If only a number is provided then it's treated as the timeout value.
+    #
+    # @param [Hash] opts Options
+    # @option opts [Numeric] :timeout (30) Seconds to wait before timing out.
+    # @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
+    # @option opts [String] :message Exception message if timed out.
+    # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
+    def wait opts={}, &block
+      opts = _process_wait_opts(opts).merge(return_if_true: false)
+      _generic_wait opts, &block
+    end
+  end # module Common
+end # module Appium

data/lib/appium_lib/device/touch_actions.rb

@@ -93,6 +93,9 @@ module Appium
     end
 
     # Convenience method to peform a swipe.
+    #
+    # Note that iOS 7 simulators have broken swipe.
+    #
     # @option opts [int] :start_x Where to start swiping, on the x axis.  Default 0.
     # @option opts [int] :start_y Where to start swiping, on the y axis.  Default 0.
     # @option opts [int] :end_x Where to end swiping, on the x axis.  Default 0.

data/lib/appium_lib/driver.rb

@@ -8,6 +8,7 @@ require_relative 'awesome_print/ostruct'
 
 # common
 require_relative 'common/helper'
+require_relative 'common/wait'
 require_relative 'common/patch'
 require_relative 'common/version'
 require_relative 'common/element/window'
@@ -26,6 +27,7 @@ require_relative 'ios/mobile_methods'
 # android
 require_relative 'android/helper'
 require_relative 'android/patch'
+require_relative 'android/client_xpath'
 require_relative 'android/element/alert'
 require_relative 'android/element/button'
 require_relative 'android/element/generic'
@@ -92,8 +94,8 @@ module Appium
     data = Appium::symbolize_keys data
     ap data unless data.empty? if verbose
 
-    if data && data[:caps] && data[:caps][:app]
-      data[:caps][:app] = Appium::Driver.absolute_app_path data[:caps][:app]
+    if data && data[:caps] && data[:caps][:app] && !data[:caps][:app].empty?
+      data[:caps][:app] = Appium::Driver.absolute_app_path data
     end
 
     # return list of require files as an array
@@ -147,12 +149,26 @@ module Appium
     result
   end
 
-  def self.promote_singleton_appium_methods main_module
+  # if modules is a module instead of an array, then the constants of
+  # that module are promoted on.
+  # otherwise, the array of modules will be used as the promotion target.
+  def self.promote_singleton_appium_methods modules
     raise 'Driver is nil' if $driver.nil?
-    main_module.constants.each do |sub_module|
+
+    target_modules = []
+
+    if modules.is_a? Module
+      modules.constants.each do |sub_module|
+        target_modules << modules.const_get(sub_module)
+      end
+    else
+      raise 'modules must be a module or an array' unless modules.is_a? Array
+      target_modules = modules
+    end
+
+    target_modules.each do |const|
       #noinspection RubyResolve
       $driver.public_methods(false).each do |m|
-        const = main_module.const_get(sub_module)
         const.send(:define_singleton_method, m) do |*args, &block|
           begin
             super(*args, &block) # promote.rb
@@ -264,8 +280,8 @@ module Appium
 
       # Path to the .apk, .app or .app.zip.
       # The path can be local or remote for Sauce.
-      unless !@caps || @caps[:app].nil? || @caps[:app].empty?
-        @caps[:app] = self.class.absolute_app_path @caps[:app]
+      if @caps && @caps[:app] && ! @caps[:app].empty?
+        @caps[:app] = self.class.absolute_app_path opts
       end
 
       # https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile
@@ -356,12 +372,24 @@ module Appium
     end
 
     # Converts app_path to an absolute path.
+    #
+    # opts is the full options hash (caps and appium_lib). If server_url is set
+    # then the app path is used as is.
+    #
+    # if app isn't set then an error is raised.
+    #
     # @return [String] APP_PATH as an absolute path
-    def self.absolute_app_path app_path
-      raise 'APP_PATH not set!' if app_path.nil? || app_path.empty?
+    def self.absolute_app_path opts
+      raise 'opts must be a hash' unless opts.is_a? Hash
+      caps            = opts[:caps] || {}
+      appium_lib_opts = opts[:appium_lib] || {}
+      server_url      = appium_lib_opts.fetch :server_url, false
+
+      app_path        = caps[:app]
+      raise 'absolute_app_path invoked and app is not set!' if app_path.nil? || app_path.empty?
       # may be absolute path to file on remote server.
       # if the file is on the remote server then we can't check if it exists
-      return app_path if @custom_url
+      return app_path if server_url
       # Sauce storage API. http://saucelabs.com/docs/rest#storage
       return app_path if app_path.start_with? 'sauce-storage:'
       return app_path if app_path.match(/^http/) # public URL for Sauce

data/release_notes.md

@@ -1,3 +1,16 @@
+#### v4.1.0 2014-07-21
+
+- [a13158f](https://github.com/appium/ruby_lib/commit/a13158fb926212d84f26120c3bc5355c8cd34baf) Release 4.1.0
+- [be1c710](https://github.com/appium/ruby_lib/commit/be1c710134ee9a001b8e71c0ce5cbb5786bebf1e) Update android specs
+- [4edd949](https://github.com/appium/ruby_lib/commit/4edd94989519ec14acf9c694d9ed3ae6a5939b10) Update self.promote_singleton_appium_methods
+- [82a236a](https://github.com/appium/ruby_lib/commit/82a236a84742f1eb6d55acab00d8f222d721bd9a) Update docs.md
+- [a724d5d](https://github.com/appium/ruby_lib/commit/a724d5d3711cdfa3ea420663949c06017189bf02) Fix #224
+- [d05bfe8](https://github.com/appium/ruby_lib/commit/d05bfe85d6c356a8ea6a0f151aaf21dfef979736) Fix docs
+- [c04d6f0](https://github.com/appium/ruby_lib/commit/c04d6f048ee4e24c66bef662e31a0d957360e7a7) Fix wait / wait_true by using selenium wait method
+- [da19c8c](https://github.com/appium/ruby_lib/commit/da19c8cca5753f06576b82bbbb6e77e7e36bcb9c) Add iOS 7 note to swipe
+- [4f4d800](https://github.com/appium/ruby_lib/commit/4f4d80094eac5a4fbc2c11b8050155b2f767839c) Add client side xpath support
+
+
 #### v4.0.0 2014-07-05
 
 - [8cc004a](https://github.com/appium/ruby_lib/commit/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7) Release 4.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-05 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -322,6 +322,7 @@ files:
 - ios_tests/upload/sauce_storage.rb
 - ios_tests/upload/upload.rb
 - lib/appium_lib.rb
+- lib/appium_lib/android/client_xpath.rb
 - lib/appium_lib/android/element/alert.rb
 - lib/appium_lib/android/element/button.rb
 - lib/appium_lib/android/element/generic.rb
@@ -335,6 +336,7 @@ files:
 - lib/appium_lib/common/helper.rb
 - lib/appium_lib/common/patch.rb
 - lib/appium_lib/common/version.rb
+- lib/appium_lib/common/wait.rb
 - lib/appium_lib/device/device.rb
 - lib/appium_lib/device/multi_touch.rb
 - lib/appium_lib/device/touch_actions.rb