appium_lib 12.1.0 → 12.1.1

data/lib/appium_lib/driver.rb

@@ -101,6 +101,7 @@ module Appium
     #              app: '/path/to/MyiOS.app'
     #            },
     #            appium_lib: {
+    #              server_url: 'http://127.0.0.1:4723'
     #              wait_timeout: 30
     #            }
     #          }
@@ -392,9 +393,6 @@ module Appium
     def self.absolute_app_path(opts)
       raise 'opts must be a hash' unless opts.is_a? Hash
 
-      ::Appium::Logger.warning('[Deprecation] Converting the path to absolute path will be removed. ' \
-                               'Please specify the full path which can be accessible from the appium server')
-
       # FIXME: 'caps' and 'app' will be correct
       caps            = opts[:caps] || opts['caps'] || {}
       app_path        = caps[:app] || caps['app']
@@ -403,6 +401,9 @@ module Appium
       return app_path if app_path.start_with? 'sauce-storage:'
       return app_path if app_path =~ URI::DEFAULT_PARSER.make_regexp # public URL for Sauce
 
+      ::Appium::Logger.warn('[Deprecation] Converting the path to absolute path will be removed. ' \
+                            'Please specify the full path which can be accessible from the appium server')
+
       absolute_app_path = File.expand_path app_path
       if File.exist? absolute_app_path
         absolute_app_path

data/lib/appium_lib/version.rb

@@ -14,6 +14,6 @@
 
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '12.1.0' unless defined? ::Appium::VERSION
-  DATE    = '2022-10-11' unless defined? ::Appium::DATE
+  VERSION = '12.1.1' unless defined? ::Appium::VERSION
+  DATE    = '2022-10-19' unless defined? ::Appium::DATE
 end

data/readme.md

@@ -6,22 +6,20 @@
 [![Downloads](https://img.shields.io/gem/dt/appium_lib.svg)](https://rubygems.org/gems/appium_lib)
 
 - [appium_lib on RubyGems](https://rubygems.org/gems/appium_lib)
-- [Documentation for appium_lib](https://github.com/appium/ruby_lib/tree/master/docs)
+- [Documentation for appium_lib](https://www.rubydoc.info/github/appium/ruby_lib)
     - [Documentation for core lib](http://www.rubydoc.info/github/appium/ruby_lib_core)
         - Especially [driver method for Appium](http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device)
-- [Getting Started](https://github.com/appium/appium/blob/master/docs/en/about-appium/getting-started.md)
-- [code examples](https://github.com/appium/sample-code/tree/master/sample-code/examples/ruby)
 
 Helper methods for writing cross platform (iOS, Android) tests in Ruby using Appium. Note that user waits should not exceed 120 seconds if they're going to run on Sauce Labs.
 
-**Recommend** to use [ruby_lib_core](https://github.com/appium/ruby_lib_core), which is available as a Ruby client for Appium. `ruby_lib` wraps the core library with some additional helpful methods.
+**Recommend** to use [ruby_lib_core](https://github.com/appium/ruby_lib_core), which works as a Ruby client for Appium. `ruby_lib` wraps the core library with some additional helpful methods, but some of wrapped methods may have unexpected complexity.
 Ordinary, `ruby_lib` worked with class driver, `$driver`, mainly.
 We can avoid the class driver with current `ruby_lib`, but if you'd like to implement your test cases based on instance driver, `@driver`, you can consider using `ruby_lib_core` first.
 
 # Setup
 ## Requirement
 - [Appium](https://github.com/appium/appium#requirements)
-- Ruby: 2.6+
+- Ruby: 2.7+
 
 ### Ruby Lib and Appium
 
@@ -32,6 +30,33 @@ We can avoid the class driver with current `ruby_lib`, but if you'd like to impl
 
 ## Start appium server
 
+### Appium 2
+
+```bash
+$ npm install -g appium@next
+$ appium driver install xcuitest  # proper driver name to install
+$ appium server
+```
+
+> **Note** Please set `server_url` properly like the below since the appium 2
+> changed the default WebDriver URL to without `/wd/hub` to follow W3C.
+> ```
+>  opts = {
+>    caps: {
+>      automationName: 'xcuitest'
+>      platformName: 'ios',
+>      app: '/path/to/MyiOS.app'
+>    },
+>    appium_lib: {
+>      server_url: 'http://127.0.0.1:4723'
+>    }
+>  }
+>  appium_driver = Appium::Driver.new(opts)
+>  appium_driver.start_driver
+> ```
+> Or please start the appium server with `appium server --base-path=/wd/hub`
+
+### Appium 1
 ```bash
 $ npm install -g appium
 $ appium
@@ -53,12 +78,11 @@ gem install appium_lib
 
 # Documentation
 
-- [Getting started](https://github.com/appium/appium/blob/master/docs/en/about-appium/getting-started.md)
+- [Getting started](https://github.com/appium/appium)
 - [Overview](https://github.com/appium/ruby_lib/blob/master/docs/docs.md)
 - [Ruby Android methods](https://github.com/appium/ruby_lib/blob/master/docs/android_docs.md)
 - [Ruby iOS methods](https://github.com/appium/ruby_lib/blob/master/docs/ios_docs.md)
     - [Tips for XCUITest for iOS](https://github.com/appium/ruby_lib/blob/master/docs/ios_xcuitest.md)
-- [Appium Server docs](https://github.com/appium/appium/tree/master/docs)
 
 # Related libraries
 - [ruby_lib_core](https://github.com/appium/ruby_lib_core): Bridged commands, WebDriver dependencies

data/release_notes.md

@@ -1,5 +1,10 @@
-#### v12.1.0 2022-10-11
+#### v12.1.1 2022-10-19
 
+- [83c89c1](https://github.com/appium/ruby_lib/commit/83c89c107ea0e030b7eae2d8ab664c38766df6ed) Release 12.1.1
+- [e40222d](https://github.com/appium/ruby_lib/commit/e40222d66f497fe295aea982ef0c042b901f6e3f) fix: use warn (#951)
+- [a9b7558](https://github.com/appium/ruby_lib/commit/a9b75583e9923ade4f4fd16cb7fad03cc0f7c1be) docs: tweak
+- [600f867](https://github.com/appium/ruby_lib/commit/600f8670f97d91babfd84e1c6c1ef34d2682b883) docs: updating (#950)
+- [a81ea4b](https://github.com/appium/ruby_lib/commit/a81ea4b2a74ea71fa62c1756ffea2f85da57d49b) docd: udpate readme
 - [8f20fe1](https://github.com/appium/ruby_lib/commit/8f20fe12b728195a8d2eb7d39004de4075caeff8) Release 12.1.0
 - [b00662a](https://github.com/appium/ruby_lib/commit/b00662a3976aeadc8d5385fd00129fb9dafa967c) chore: specify latest core
 - [98a3c6b](https://github.com/appium/ruby_lib/commit/98a3c6b9720eeff74f6eefda6e54196477854ed3) feat: update the minimal ruby lib core version (#946)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 12.1.0
+  version: 12.1.1
 platform: ruby
 authors:
 - code@bootstraponline.com
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
@@ -236,7 +236,6 @@ files:
 - docs/docs.md
 - docs/ios_docs.md
 - docs/ios_xcuitest.md
-- docs/migration.md
 - docs/parallel.md
 - docs/w3c.md
 - lib/appium_lib.rb

data/docs/migration.md

@@ -1,175 +0,0 @@
-### Breaking Changes in 9.13.0
-Change the results of `app_state`
-
-- After
-```
-driver.app_state('com.example.apple-samplecode.UICatalog') #=> :running_in_foreground
-```
-
-- Before
-```
-driver.app_state('com.example.apple-samplecode.UICatalog') #=> 1
-```
-
-### Breaking Changes in 9.9.0
-Change `start_recording_screen` interface. Please read [documentation](https://github.com/appium/ruby_lib_core/blob/0ba7b1c726f02e11d6daa46481309b1e0e54b00e/lib/appium_lib_core/android/device.rb#L84) for more details.
-
-- After
-
-```ruby
-start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil, video_size: nil, time_limit: '180', bit_rate: '4000000')
-```
-
-- Before
-
-```ruby
-start_recording_screen(file_path: 'file path in /sdcard/...', video_size: 'videosize', time_limit: '180', bit_rate: '4000000')
-```
-
-
-### Breaking Changes in 9.6.0
-Raise warning if users call `Appium::Driver.new(opts)`.
-
-- After
-
-```ruby
-Appium::Driver.new(opts).start_driver # Raise warning.
-Appium::Driver.new(opts, true).start_driver # $driver is defined.
-Appium::Driver.new(opts, false).start_driver # $driver isn't defined.
-```
-
-- Before
-
-```ruby
-Appium::Driver.new(opts).start_driver # $driver is defined.
-```
-
-### Breaking Changes in 9.3.7
-change `@selenium_driver.find_element/s_with_appium` to `@selenium_driver.find_element/s`.
-ref: https://github.com/appium/ruby_lib/pull/532
-
-A breaking change in v9.1.0 is reverted in this version.
-
-           Old | New
-            :--|:--
-`@selenium_driver.find_element/s_with_appium` | `@selenium_driver.find_element/s`
-
-- after
-
-```
-@selenium_driver.find_element :accessibility_id, "some ids"
-@selenium_driver.find_elements :accessibility_id, "some ids"
-```
-
-- before
-
-```
-@selenium_driver.find_element_with_appium :accessibility_id, "some ids"
-@selenium_driver.find_elements_with_appium :accessibility_id, "some ids"
-```
-
-
-### Breaking Changes in 9.1.0
-change `@selenium_driver.find_element/s` to `@selenium_driver.find_element/s_with_appium`.
-ref: https://github.com/appium/ruby_lib/pull/383
-
-           Old | New
-            :--|:--
-`@selenium_driver.find_element/s` | `@selenium_driver.find_element/s_with_appium`
-
-- after
-
-```
-@selenium_driver.find_element_with_appium :accessibility_id, "some ids"
-@selenium_driver.find_elements_with_appium :accessibility_id, "some ids"
-```
-
-- before
-
-```
-@selenium_driver.find_element :accessibility_id, "some ids"
-@selenium_driver.find_elements :accessibility_id, "some ids"
-```
-
-### Breaking Changes in 8.2.0
-change `Appium.load_appium_txt` to `Appium.load_settings`.
-
-           Old | New
-            :--|:--
-`Appium.load_appium_txt` | `Appium.load_settings`
-
-- after
-
-```
-dir        = File.expand_path(File.join(Dir.pwd, 'lib'))
-appium_txt = File.join(Dir.pwd, 'appium.txt')
-caps       = Appium.load_settings file: appium_txt, verbose: true
-```
-
-- before
-
-```
-appium_txt = File.expand_path(File.join(Dir.pwd, 'lib'))
-dir        = appium_txt
-caps       = Appium.load_appium_txt file: appium_txt, verbose: true
-```
-
-### Breaking Changes in 7.0
-
-Requires appium 1.4.0-beta or newer for iOS helper methods. appium_lib no longer automatically promotes methods on minispec. To restore the old behavior use: `Appium.promote_appium_methods ::Minitest::Spec`
-
-The implicit wait now defaults to zero. To restore the old behavior, use `set_wait 30`.
-
-           Old | New
-            :--|:--
-`installed?`   | `app_installed?`
-
-### Breaking Changes in 5.0
-
-           Old | New
-            :--|:--
-`launch`       | `launch_app`
-`install`      | `install_app`
-`remove`       | `remove_app`
-
-method_missing has been removed from the Ruby bindings. If you want to invoke methods on the top level object,
-you can use the following:
-
-`Appium.promote_appium_methods Object`
-
-Also make sure to update to Appium Ruby Console v1.0.3 or better. Old consoles will not work with the 5.0 release due to the removal of method_missing.
-
-### Breaking Changes in 4.0
-
-           Old | New
-            :--|:--
-`key_event`    | `press_keycode`
-
-### Breaking Changes in 2.0
-
-In 2.0, the e_* methods have been renamed.
-
-           Old | New
-            :--|:--
-`e_buttons`    | `buttons`
-`e_s_texts`    | `texts`
-`e_textfields` | `textfields`
-
-All s_texts methods have been renamed.
-
-            Old | New
-             :--|:--
-`s_text`        | `text`
-`s_texts`       | `texts`
-`first_s_text`  | `first_text`
-`last_s_text`   | `last_text`
-`s_text_exact`  | `text_exact`
-`s_texts_exact` | `texts_exact`
-
-Other changes:
-
-                 Old | New
-                  :--|:--
-`press_for_duration` | `long_press`
-`current_context=`   | `set_context`
-`name`               | `find`