appium_lib 0.3.3 → 0.3.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWIwNjQ5MmY3YTQ0YTg1NTM4YzYwZTk4ZjlmMGEzNTI4NmNhMmM4NA==
+    YTA5MjVhYjAyZWEwMGM5NzQzYmI5OGRlZGU5NTkxMGM5YjY4ZDNmMw==
   data.tar.gz: !binary |-
-    ZTRjMjNjZTQ2NzVhMzgwYTQ5MzNjMDFhNDc3MjVkYTA4NTM2YTBmNA==
+    YTg3MDQxYjBmZTEzZDhkNjYyODg2ZDIzYTY3YWRkMzVmMTc4NDFiZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OWIyZGE2M2U3ZGQ1MjllMjQ3NDQ0N2ViNjA0ZmVlZmZhZjMxZmJhYjUyMzQy
-    N2IyZGRjMDIxMTRmNzQxYzRhMWZlOGU1MDc1NDdlZjQ3Y2Q2NTc0YTllZDIx
-    YzhiZDRmMGYyMTE1N2IyMWRhZDVjODdhN2E2ZTdlYWQ1MDYwYzk=
+    OGYyMzJlNGE1NWY3YWI4OWU1ZGY4Y2U2OWUzODljMzc2YzRjZDJlM2JhZTc2
+    OWU4Yzc3MmQzZGFiMjFiYjJmNjZmYTdkOWE3NzdlMjg5YjQwMDhlZGViNjMz
+    NjEwNzJlZGFkOGM3YTMzYWJlYjJkZWY3ZGQ1ZmUzOWY2MjA5NmM=
   data.tar.gz: !binary |-
-    ODY1ZmRiM2RhMDdhMDFkYjZmMWM0NzllYWIxY2MxNmU5YjU2OWU2MTIwZDFm
-    OWZkMTMxYTMxY2UzMWNkYzk4YTZjYWRkNTQ3MTUwOTMxNGMzMzFmYzdmZDkz
-    YTIxYjA0MjlhNGE3MTc0NWNjODcyM2E1MzA1MDUwZTZjODYxZGE=
+    NTNjYmE5OTU1YzVlM2EwNjcxNzFiOTY5ZmVkYzZkY2JmMTc3YzA0MzUzZDUz
+    ODg2N2VmMjJkZTU4YjU2MGM4NzJhOTdjZGY2MDZkYjJhN2JhYjRhNmY5YzA5
+    ZTgwMjVlNmI1NzM2OGY0NjExMTdjZTdjODVlODFhZmQwM2M0ZmQ=

data/Rakefile

@@ -90,7 +90,7 @@ end
 
 desc 'Install gem'
 task :install => [ :gem, :uninstall ] do
-  sh "gem install --no-rdoc --no-ri #{repo_name}-#{version}.gem"
+  sh "gem install --no-rdoc --no-ri --local #{repo_name}-#{version}.gem"
 end
 
 desc 'Update release notes'

data/lib/appium_lib.rb

@@ -1,14 +1,14 @@
 # encoding: utf-8
 
-$last_driver = nil
+$driver = nil
 
 # Invoke top level methods on last created Appium driver.
 def self.method_missing method, *args, &block
-  raise "driver is nil. called #{method}" if $last_driver == nil
+  raise "driver is nil. called #{method}" if $driver == nil
 
-  $last_driver.respond_to?(method) ?
-    $last_driver.send( method, *args, &block ) :
-    super
+  $driver.respond_to?(method) ?
+      $driver.send( method, *args, &block ) :
+      super
 end
 
 module Appium

data/lib/appium_lib/android/patch.rb

@@ -1,10 +1,14 @@
 # encoding: utf-8
 module Appium::Android
-  # Implement useful features for element.
-  class Selenium::WebDriver::Element
-    # Cross platform way of entering text into a textfield
-    def type text
-      self.send_keys text
+  # class_eval inside a method because class Selenium::WebDriver::Element
+  # will trigger as soon as the file is required. in contrast a method
+  # will trigger only when invoked.
+  def patch_webdriver_element
+      Selenium::WebDriver::Element.class_eval do
+        # Cross platform way of entering text into a textfield
+        def type text
+          self.send_keys text
+        end
+      end
     end
-  end
-end
+  end

data/lib/appium_lib/common/helper.rb

@@ -20,12 +20,14 @@ module Appium::Common
 
   # Check every 0.5 seconds to see if block.call is true.
   # 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 &block
+  def wait max_wait=30, interval=0.5, &block
     # Rescue Timeout::Error: execution expired
     result = nil
-    timeout(30) { until (result = begin; block.call; rescue; end) do; sleep 0.5 end }
+    timeout(max_wait) { until (result = begin; block.call; rescue; end) do; sleep interval end }
     result
   end
 
@@ -158,4 +160,4 @@ module Appium::Common
   def find_names name
     find_elements :name, name
   end
-end # module Appium::Common
+end # module Appium::Common

data/lib/appium_lib/common/patch.rb

@@ -52,11 +52,11 @@ require 'selenium/webdriver/remote/http/default'
 # Show http calls to the Selenium server.
 #
 # Invaluable for debugging.
-module Selenium::WebDriver::Remote
-  class Bridge
+def patch_webdriver_bridge
+  Selenium::WebDriver::Remote::Bridge.class_eval do
     # 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}")
+      verb, path = Selenium::WebDriver::Remote::COMMANDS[command] || raise(ArgumentError, "unknown command: #{command.inspect}")
       path       = path.dup
 
       path[':session_id'] = @session_id if path.include?(':session_id')
@@ -75,12 +75,16 @@ module Selenium::WebDriver::Remote
       path_str = path.sub(path_match[0], '') unless path_match.nil?
 
       puts "#{verb} #{path_str}"
-      puts command_hash.to_json unless command_hash.to_json == 'null'
+      unless command_hash.nil? || command_hash.length == 0
+        print_command = command_hash.clone
+        print_command.delete :args if print_command[:args] == []
+        ap print_command
+      end
       # puts "verb: #{verb}, path #{path}, command_hash #{command_hash.to_json}"
       http.call verb, path, command_hash
     end # def
   end # class
-end if defined? Pry # module Selenium::WebDriver::Remote
+end # def
 
 # Print Appium's origValue error messages.
 class Selenium::WebDriver::Remote::Response

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.3.3' unless defined? ::Appium::VERSION
-  DATE = '2013-04-27' unless defined? ::Appium::DATE
+  VERSION = '0.3.4' unless defined? ::Appium::VERSION
+  DATE = '2013-04-30' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/driver.rb

@@ -37,32 +37,42 @@ module Appium
     attr_reader :app_path, :app_name, :app_package, :app_activity,
                 :app_wait_activity, :sauce_username, :sauce_access_key,
                 :port, :os, :ios_js
-    def initialize opts={}
+    def initialize options={}
+      # quit last driver
+      $driver.driver_quit if $driver
+
+      opts = {}
+      # convert to downcased symbols
+      options.each_pair { |k,v| opts[k.to_s.downcase.strip.intern] = v }
+
       opts = {} if opts.nil?
       # Path to the .apk, .app or .app.zip.
       # The path can be local or remote for Sauce.
-      @app_path = opts.fetch 'APP_PATH', ENV['APP_PATH']
+      @app_path = opts.fetch :app_path, ENV['APP_PATH']
       raise 'APP_PATH must be set.' if @app_path.nil?
 
       # The name to use for the test run on Sauce.
-      @app_name = opts.fetch 'APP_NAME', ENV['APP_NAME']
+      @app_name = opts.fetch :app_name, ENV['APP_NAME']
+
+      # If key or env is defined, use selendroid else nil
+      @selendroid = opts.key?(:selendroid) ||  ENV['SELENDROID'] ? 'selendroid' : nil
 
       # Android app package
-      @app_package = opts.fetch 'APP_PACKAGE', ENV['APP_PACKAGE']
+      @app_package = opts.fetch :app_package, ENV['APP_PACKAGE']
 
       # Android app starting activity.
-      @app_activity = opts.fetch 'APP_ACTIVITY', ENV['APP_ACTIVITY']
+      @app_activity = opts.fetch :app_activity, ENV['APP_ACTIVITY']
 
       # Android app waiting activity
-      @app_wait_activity = opts.fetch 'APP_WAIT_ACTIVITY', ENV['APP_WAIT_ACTIVITY']
+      @app_wait_activity = opts.fetch :app_wait_activity, ENV['APP_WAIT_ACTIVITY']
 
       # Sauce Username
-      @sauce_username = opts.fetch'SAUCE_USERNAME', ENV['SAUCE_USERNAME']
+      @sauce_username = opts.fetch :sauce_username, ENV['SAUCE_USERNAME']
 
       # Sauce Key
-      @sauce_access_key = opts.fetch 'SAUCE_ACCESS_KEY', ENV['SAUCE_ACCESS_KEY']
+      @sauce_access_key = opts.fetch :sauce_access_key, ENV['SAUCE_ACCESS_KEY']
 
-      @port = opts.fetch 'PORT', ENV['PORT'] || 4723
+      @port = opts.fetch :port, ENV['PORT'] || 4723
 
       @os = :ios
       @os = :android if @app_path.end_with?('.apk') || @app_path.end_with?('.apk.zip')
@@ -81,18 +91,24 @@ module Appium
         extend Appium::Ios
       end
 
+      # apply os specific patches
+      patch_webdriver_element
+
+      # enable debug patch
+      patch_webdriver_bridge if opts.fetch :debug, defined?(Pry)
+
       # Save global reference to last created Appium driver for top level methods.
-      $last_driver = self
+      $driver = self
 
       # Promote exactly once the first time the driver is created.
       # Subsequent drivers do not trigger promotion.
       unless @@loaded
         @@loaded = true
         # Promote Appium driver methods to Object instance methods.
-        $last_driver.public_methods(false).each do | m |
+        $driver.public_methods(false).each do | m |
           Object.class_eval do
             define_method m do | *args, &block |
-              $last_driver.send m, *args, &block
+              $driver.send m, *args, &block
             end
           end
         end
@@ -106,7 +122,7 @@ module Appium
         browserName: 'Android',
         platform: 'LINUX',
         version: '4.1',
-        device: 'Android',
+        device: @selendroid || 'Android',
         name: @app_name || 'Ruby Console Android Appium',
         app: absolute_app_path,
         :'app-package' => @app_package,

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

@@ -31,22 +31,35 @@ module Appium::Ios
     # execute_script 'au.mainApp.getNameContains("sign")'
     # execute_script 'au.mainApp.getNameContains("zzz")'
     # must check .isVisible or a hidden element may be returned.
-    # .tap() will error on invisible elements.
+    # .tap() may error on invisible elements.
+    # if there are no visible elements though, then it's useful
+    # to .tap() on an invisible element.
     <<-JS
     UIAElement.prototype.getNameContains = function(targetName) {
       var target = UIATarget.localTarget();
       target.pushTimeout(0);
-      var search = "(name contains[c] '" + targetName + "' || label contains[c] '" + targetName + "') && visible == 1";
+      var search = "name contains[c] '" + targetName + "' || label contains[c] '" + targetName + "'";
+      var result = {};
+      result.type = function() { return 'UIAElementNil'; };
+      result.isVisible = function() { return -1; };
+
       var searchElements = function(element) {
         var children = element.elements();
-        var result = children.firstWithPredicate(search);
-        if (result.type() !== 'UIAElementNil' && result.isVisible() === 1) {
-          return result;
+        var results = children.withPredicate(search);
+
+        for (var resIdx = 0, resLen = results.length; resIdx < resLen; resIdx++) {
+          var tmp = results[resIdx];
+          if (tmp.type() !== 'UIAElementNil') {
+            result = tmp;
+            if (tmp.isVisible() === 1) {
+              return tmp;
+            }
+          }
         }
 
         for ( var a = 0, len = children.length; a < len; a++) {
-          result = searchElements(children[a]);
-          if (result.type() !== 'UIAElementNil') {
+          searchElements(children[a]);
+          if (result.type() !== 'UIAElementNil' && result.isVisible() === 1) {
             return result;
           }
         }
@@ -63,6 +76,7 @@ module Appium::Ios
         };
       }
 
+      console.log("Match is visible? " + result.isVisible())
       return {
         status: 0,
         value: {ELEMENT: au.getId(result)}

data/lib/appium_lib/ios/patch.rb

@@ -1,15 +1,19 @@
 # encoding: utf-8
 module Appium::Ios
-  # Implement useful features for element.
-  class Selenium::WebDriver::Element
-    # Cross platform way of entering text into a textfield
-    def type 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
+  # class_eval inside a method because class Selenium::WebDriver::Element
+  # will trigger as soon as the file is required. in contrast a method
+  # will trigger only when invoked.
+  def patch_webdriver_element
+    Selenium::WebDriver::Element.class_eval do
+      # Cross platform way of entering text into a textfield
+      def type text
+        # enter text then tap window to hide the keyboard.
+        js = <<-JS
+          au.getElement('#{self.ref}').setValue('#{text}');
+          au.lookup('window')[0].tap();
+        JS
+        @driver.execute_script js
+      end
     end
   end
 end

data/readme.md

@@ -8,6 +8,10 @@ Helper methods for writing cross platform (iPad, iPhone, Android) tests in Ruby
 
 Make sure you're using Ruby 1.9.3+ with upgraded rubygems and bundler.
 
+#### Start appium server
+
+`node server.js -V --fast-reset --without-delay`
+
 #### Install / Upgrade
 
 Update rubygems and bundler.

data/release_notes.md

@@ -1,3 +1,12 @@
+#### v0.3.3 2013-04-27
+
+- [b0ca37c](https://github.com/appium/ruby_lib/commit/b0ca37cfe47318f029e1f2ad498a5c08338016d7) Release 0.3.3
+- [e7f55d9](https://github.com/appium/ruby_lib/commit/e7f55d92181660ea188a5123e6e4f447389c8d6d) Add driver method
+- [6d381fe](https://github.com/appium/ruby_lib/commit/6d381fe029bd9a5c11aa4d1a322d6afb603c6434) Update readme.md
+- [07da208](https://github.com/appium/ruby_lib/commit/07da208973ea4de64ec9605ef5dd38884771e8c6) Add troubleshooting steps
+- [7df8ddc](https://github.com/appium/ruby_lib/commit/7df8ddcd0edb294abaddd2424f0f6b45f086fb53) Update release notes
+
+
 #### v0.3.2 2013-04-26
 
 - [eee6632](https://github.com/appium/ruby_lib/commit/eee6632251c40c8b2d6be9a361f429d7c89762f8) Release 0.3.2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver