appium_lib 9.7.1 → 9.7.2

data/lib/appium_lib/core/ios/uiautomation/bridge.rb

@@ -8,7 +8,8 @@ module Appium
           def self.for(target)
             Core::Ios::SearchContext.extend
             target.extend Appium::Ios::Device
-            patch_webdriver_element
+
+            Core::Ios::Uiautomation.patch_webdriver_element
           end
         end
       end

data/lib/appium_lib/core/ios/uiautomation/patch.rb

@@ -6,8 +6,8 @@ module Appium
         # 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
+        def self.patch_webdriver_element
+          ::Selenium::WebDriver::Element.class_eval do
             # Cross platform way of entering text into a textfield
             def type(text, driver = $driver)
               driver.execute_script %(au.getElement('#{ref}').setValue('#{text}');)

data/lib/appium_lib/driver.rb

@@ -63,49 +63,46 @@ module Appium
     #
     # @example
     #
-    #     ```ruby
-    #     require 'rubygems'
-    #     require 'appium_lib'
-    #
-    #     # platformName takes a string or a symbol.
-    #
-    #     # Start iOS driver with global scope
-    #     opts = {
-    #              caps: {
-    #                platformName: :ios,
-    #                app: '/path/to/MyiOS.app'
-    #              },
-    #              appium_lib: {
-    #                wait_timeout: 30
-    #              }
+    #   require 'rubygems'
+    #   require 'appium_lib'
+    #
+    #   # platformName takes a string or a symbol.
+    #   # Start iOS driver with global scope
+    #   opts = {
+    #            caps: {
+    #              platformName: :ios,
+    #              app: '/path/to/MyiOS.app'
+    #            },
+    #            appium_lib: {
+    #              wait_timeout: 30
     #            }
-    #     Appium::Driver.new(opts, true).start_driver
-    #
-    #     # Start Android driver with global scope
-    #     opts = {
-    #              caps: {
-    #                platformName: :android,
-    #                app: '/path/to/my.apk'
-    #              },
-    #              appium_lib: {
-    #                wait_timeout: 30,
-    #                wait_interval: 1
-    #              }
+    #          }
+    #   Appium::Driver.new(opts, true).start_driver
+    #
+    #   # Start Android driver with global scope
+    #   opts = {
+    #            caps: {
+    #              platformName: :android,
+    #              app: '/path/to/my.apk'
+    #            },
+    #            appium_lib: {
+    #              wait_timeout: 30,
+    #              wait_interval: 1
     #            }
-    #     Appium::Driver.new(opts, true).start_driver
-    #
-    #     # Start iOS driver without global scope
-    #     opts = {
-    #              caps: {
-    #                platformName: :ios,
-    #                app: '/path/to/MyiOS.app'
-    #              },
-    #              appium_lib: {
-    #                wait_timeout: 30
-    #              }
+    #          }
+    #   Appium::Driver.new(opts, true).start_driver
+    #
+    #   # Start iOS driver without global scope
+    #   opts = {
+    #            caps: {
+    #              platformName: :ios,
+    #              app: '/path/to/MyiOS.app'
+    #            },
+    #            appium_lib: {
+    #              wait_timeout: 30
     #            }
-    #     Appium::Driver.new(opts, false).start_driver
-    #     ```
+    #          }
+    #   Appium::Driver.new(opts, false).start_driver
     #
     # @param opts [Object] A hash containing various options.
     # @param global_driver [Bool] A bool require global driver before initialize.
@@ -279,14 +276,13 @@ module Appium
 
     # Returns the server's version info
     #
-    # ```ruby
-    # {
+    # @example
+    #   {
     #     "build" => {
     #         "version" => "0.18.1",
     #         "revision" => "d242ebcfd92046a974347ccc3a28f0e898595198"
     #     }
-    # }
-    # ```
+    #   }
     #
     # @return [Hash]
     def appium_server_version
@@ -311,11 +307,11 @@ module Appium
 
     # Returns the client's version info
     #
-    # ```ruby
-    # {
-    #     "version" => "9.1.1"
-    # }
-    # ```
+    # @example
+    #
+    #   {
+    #       "version" => "9.1.1"
+    #   }
     #
     # @return [Hash]
     def appium_client_version
@@ -378,7 +374,9 @@ module Appium
 
     # Takes a png screenshot and saves to the target path.
     #
-    # Example: screenshot '/tmp/hi.png'
+    # @example
+    #
+    #   screenshot '/tmp/hi.png'
     #
     # @param png_save_path [String] the full path to save the png
     # @return [nil]
@@ -397,9 +395,11 @@ module Appium
     # @return [Selenium::WebDriver::Dimension]
     #
     # @example
+    #
     #   size = @driver.window_size
     #   size.width #=> Integer
     #   size.height #=> Integer
+    #
     def window_size
       @driver.window_size
     end
@@ -408,23 +408,22 @@ module Appium
     # You can customise http_client as the following
     #
     # @example
-    #     ```ruby
-    #     require 'rubygems'
-    #     require 'appium_lib'
-    #
-    #     # platformName takes a string or a symbol.
-    #
-    #     # Start iOS driver
-    #     opts = {
-    #              caps: {
-    #                platformName: :ios,
-    #                app: '/path/to/MyiOS.app'
-    #              },
-    #              appium_lib: {
-    #                wait_timeout: 30
-    #              }
+    #
+    #   require 'rubygems'
+    #   require 'appium_lib'
+    #
+    #   # platformName takes a string or a symbol.
+    #   # Start iOS driver
+    #   opts = {
+    #            caps: {
+    #              platformName: :ios,
+    #              app: '/path/to/MyiOS.app'
+    #            },
+    #            appium_lib: {
+    #              wait_timeout: 30
     #            }
-    #     Appium::Driver.new(opts).start_driver
+    #          }
+    #   Appium::Driver.new(opts).start_driver
     #
     # @option http_client_ops [Hash] :http_client Custom HTTP Client
     # @option http_client_ops [Hash] :open_timeout Custom open timeout for http client.
@@ -470,11 +469,11 @@ module Appium
 
     # Set implicit wait. Default to @core.default_wait.
     #
-    # ```ruby
-    # set_wait 2
-    # set_wait # @core.default_wait
+    # @example
+    #
+    #   set_wait 2
+    #   set_wait # @core.default_wait
     #
-    # ```
     #
     # @param timeout [Integer] the timeout in seconds
     # @return [void]
@@ -526,18 +525,16 @@ module Appium
     # Calls @driver.find_elements_with_appium
     #
     # @example
-    #     ```ruby
-    #     @driver = Appium::Driver.new(opts, false)
-    #     @driver.find_elements :predicate, yyy
-    #     ```
+    #
+    #   @driver = Appium::Driver.new(opts, false)
+    #   @driver.find_elements :predicate, yyy
     #
     # If you call `Appium.promote_appium_methods`, you can call `find_elements` directly.
     #
     # @example
-    #     ```ruby
-    #     @driver = Appium::Driver.new(opts, false)
-    #     @driver.find_elements :predicate, yyy
-    #     ```
+    #
+    #   @driver = Appium::Driver.new(opts, false)
+    #   @driver.find_elements :predicate, yyy
     #
     # If you call `Appium.promote_appium_methods`, you can call `find_elements` directly.
     #
@@ -550,10 +547,9 @@ module Appium
     # Calls @driver.find_element
     #
     # @example
-    #     ```ruby
-    #     @driver = Appium::Driver.new(opts, false)
-    #     @driver.find_element :accessibility_id, zzz
-    #     ```
+    #
+    #   @driver = Appium::Driver.new(opts, false)
+    #   @driver.find_element :accessibility_id, zzz
     #
     # If you call `Appium.promote_appium_methods`, you can call `find_element` directly.
     #
@@ -586,16 +582,6 @@ module Appium
       driver_quit
       exit # exit pry
     end
-
-    private
-
-    # @private
-    def write_session_id(session_id)
-      File.open('/tmp/appium_lib_session', 'w') { |f| f.puts session_id }
-    rescue IOError => e
-      ::Appium::Logger.warn e
-      nil
-    end
   end # class Driver
 end # module Appium
 

data/lib/appium_lib/ios/common/helper.rb

@@ -1,5 +1,6 @@
 module Appium
   module Ios
+    # @private
     class UITestElementsPrinter < Nokogiri::XML::SAX::Document
       attr_accessor :filter
 

data/lib/appium_lib/sauce_labs.rb

@@ -4,9 +4,32 @@ module Appium
     attr_reader :username
     # Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
     attr_reader :access_key
-    # Override the Sauce Appium endpoint to allow e.g. TestObject tests
+    # Override the Sauce Appium endpoint to allow e.g. TestObject tests. Default is 'ondemand.saucelabs.com:443/wd/hub'.
     attr_reader :endpoint
 
+    #
+    # Create a SauceLabs instance to manage sauce labs related attributes.
+    #
+    # @param [Hash] appium_lib_opts Appium library parameter
+    # @return [Appium::SauceLabs]
+    #
+    # @example
+    #
+    #   opts_blank = {}
+    #   sauce_labs_blank = Appium::SauceLabs.new(opts_blank)
+    #   sauce_labs_blank.username   #=> nil
+    #   sauce_labs_blank.access_key #=> nil
+    #   sauce_labs_blank.endpoint   #=> "ondemand.saucelabs.com:443/wd/hub"
+    #
+    #   opts = { sauce_username: "user-name",
+    #            sauce_access_key: "access-key-to-sauce-labs",
+    #            sauce_endpoint: "ondemand.other_saucelabs.com:443/wd/hub",
+    #          }
+    #   sauce_labs = Appium::SauceLabs.new(opts)
+    #   sauce_labs.username   #=> "user-name"
+    #   sauce_labs.access_key #=> "access-key-to-sauce-labs"
+    #   sauce_labs.endpoint   #=> "ondemand.other-saucelabs.com:443/wd/hub"
+    #
     def initialize(appium_lib_opts)
       @username   = appium_lib_opts.fetch :sauce_username, ENV['SAUCE_USERNAME']
       @username   = nil if !@username || (@username.is_a?(String) && @username.empty?)
@@ -18,10 +41,28 @@ module Appium
       @endpoint   = 'ondemand.saucelabs.com:443/wd/hub' if !@endpoint || (@endpoint.is_a?(String) && @endpoint.empty?)
     end
 
+    #
+    # Return true if an instance of Appium::SauceLabs has sauce_username and sauce_access_key.
+    # @return [Boolean]
+    #
+    # @example
+    #
+    #   sauce_labs_blank.sauce_server_url? #=> false
+    #   sauce_labs.sauce_server_url?       #=> true
+    #
     def sauce_server_url?
       !username.nil? && !access_key.nil?
     end
 
+    #
+    # Return a particular server url to access to. Default is the local address.
+    # @return [String]
+    #
+    # @example
+    #
+    #   sauce_labs_blank.server_url #=> "http://127.0.0.1:4723/wd/hub"
+    #   sauce_labs.server_url #=> "https://user-name:access-key-to-sauce-labs@ondemand.other-saucelabs.com:443/wd/hub"
+    #
     def server_url
       sauce_server_url? ? "https://#{username}:#{access_key}@#{endpoint}" : 'http://127.0.0.1:4723/wd/hub'
     end

data/lib/appium_lib/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '9.7.1'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2017-10-01'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.7.2'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2017-10-07'.freeze unless defined? ::Appium::DATE
 end

data/release_notes.md

@@ -1,3 +1,9 @@
+#### v9.7.1 2017-10-01
+
+- [ebde85f](https://github.com/appium/ruby_lib/commit/ebde85fac616ac09e19a5f8215195e536d88344d) [Release 9 7 1 (#682)](https://github.com/appium/ruby_lib/issues/682)
+- [db29b66](https://github.com/appium/ruby_lib/commit/db29b664172935f7814266c7357e099969404fe3) [fix: Fix appium version error (#681)](https://github.com/appium/ruby_lib/issues/681)
+
+
 #### v9.7.0 2017-10-01
 
 - [bf12459](https://github.com/appium/ruby_lib/commit/bf124597977514e4d338efaaea5a29bdcbef5578) [Release 9 7 0 (#679)](https://github.com/appium/ruby_lib/issues/679)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.7.1
+  version: 9.7.2
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver