appium_lib_core 5.0.0.rc1 → 5.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc513ad9f9ba5689303763b09a884af18e1a9eb80e78a6e05cf838551905f732
-  data.tar.gz: 59241d4d8626cf39eeb63a51291f18deca6759bdba95a8e2bb942173e0b5df9e
+  metadata.gz: 19a2c4c9f752e5f2e4287ce8b0d53bc428bafaa997b58c40bc0b796b878eadeb
+  data.tar.gz: 451e46bc56fa768879ab680520dff4ec137455ca020e1176f3022160d1a46009
 SHA512:
-  metadata.gz: 867c6a7bfbdf95243fae3a6292f0349bf9bda1fbb83b44cb7d2e12e8f5e0ecb2f41fb6103aeebdcaaded1024cbb16cd2d758d73bef9bf00697325d75b5c2d027
-  data.tar.gz: 345771f473fca33668d101f00be374ebb3b345b6795c5392b9955da73bb45588e5589b70ba8c983ce161e35c311b2f18adfd7bac3a8d816ba93863820b05b4f6
+  metadata.gz: e9e155e17e026514e12657489569b17b389d62cb9d7cd79e8a753e12b37571d4a9d3a3f28227b935b2d3d101747a7ce66d28ff7eb08f6c9cfb7c1c94ca7f3f03
+  data.tar.gz: 13e2620a48fe753b5647a0ffcb6bf370f54796aa3b87ca34522659c219474804dfa7843394307ad84b36dc377a10d2bd5bec782467354abb252e945c27cdd748

data/.github/workflows/unittest.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, 3.0]
+        ruby: [2.6, 2.7, 3.0]
 
     runs-on: ubuntu-latest
 
@@ -37,8 +37,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Does not add 2.7 on Windows so far since a command fails only on Windows
-        ruby: [2.5, 2.6]
+        ruby: [2.6, 2.7, 3.0]
 
     runs-on: windows-latest
 

data/CHANGELOG.md

@@ -5,19 +5,32 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
-- Allow to override an existing method by `Appium::Core::Base::Driver#add_command` since Appium drivers/plugins allow to override them
 
 ### Bug fixes
 
 ### Deprecations
 
-## [5.0.0.beta]
+## [5.0.0]
+
+### Enhancements
 
-- Update base selenium webdriver version to `4.0.0.beta2`
-- Support only W3C spec
-- Support Ruby 2.5+
+- Update base selenium webdriver version to `4.0.0`
+  - Support only W3C spec as following Selenium v4 client
+  - Support Ruby 2.6+
+- `element.id` returns the element id instead of `element.ref`. `element.ref` now returns an array.
+- Removed `desired_capabilities` as capabilities for `Appium::Core#for`. Please use `capabilities` key name instead
+- Removals that already had _duplication_ mark
+  - Removed `driver#screenshot`. Please use `driver#save_screenshot` instead
+  - Removed `driver#send_keys` to send keys to an active element. Please use `driver.action.send_keys('happy testing').perform` instead
+  - Removed `forceMjsonwp` to send only MJSONWP capabilities since Selenium cleint v4 no longer supports MJSONWP
+- No longer set default `timeouts` as `0`. ruby_lib_core calls `/timeouts` endpoint only when `appium_lib: { wait: 5 }` is provided explicitly
 - Raises `::Appium::Core::Error::ArgumentError` instead of `ArgumentError` for this library specific argument errors
 
+## [4.7.1] - 2021-09-26
+
+### Enhancements
+- Allow to override an existing method by `Appium::Core::Base::Driver#add_command` since Appium drivers/plugins allow to override them
+
 ## [4.7.0] - 2021-07-17
 
 ### Enhancements

data/README.md

@@ -79,7 +79,7 @@ $ PARALLEL=1 bundle exec parallel_test test/functional/ios -n 2
 
 - Runs on CI environment (on Azure)
     - Non `IGNORE_VERSION_SKIP` or `IGNORE_VERSION_SKIP=true` runs all tests ignoring `skip` them by Appium versions
-    - `IGNORE_VERSION_SKIP=false` skips the following tests if the Appium version is lower than the requirement  
+    - `IGNORE_VERSION_SKIP=false` skips the following tests if the Appium version is lower than the requirement
 
 ```
 $ IGNORE_VERSION_SKIP=true CI=true bundle exec rake test:func:android
@@ -93,9 +93,9 @@ $ IGNORE_VERSION_SKIP=true CI=true bundle exec rake test:func:android
     ```ruby
     require 'rubygems'
     require 'appium_lib_core'
-    
+
     opts = {
-      desired_capabilities: { # or { caps: {....} }
+      capabilities: { # or { caps: {....} }
         platformName: :ios,
         platformVersion: '11.0',
         deviceName: 'iPhone Simulator',
@@ -108,7 +108,7 @@ $ IGNORE_VERSION_SKIP=true CI=true bundle exec rake test:func:android
     }
     @core = Appium::Core.for(opts) # create a core driver with `opts`
     @driver = @core.start_driver
-    
+
     # Launch iPhone Simulator and `MyiOS.app`
     @driver.find_element(:accessibility_id, 'some accessibility') # find an element
     ```
@@ -116,7 +116,7 @@ $ IGNORE_VERSION_SKIP=true CI=true bundle exec rake test:func:android
     ```bash
     # shell 1
     $ appium --log-level warn:error # show only warning and error logs
-    
+
     # shell 2
     $ ruby test.rb
     ```

data/appium_lib_core.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appium_lib_core/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.name          = 'appium_lib_core'
   spec.version       = Appium::Core::VERSION
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '4.0.0.rc1'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.0.0'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
   spec.add_development_dependency 'bundler', '>= 1.14'

data/docs/mobile_command.md

@@ -28,8 +28,7 @@ To handle it, we would recommend you to handle the error based on the error mess
 
 ```ruby
 error = assert_raises ::Selenium::WebDriver::Error::UnknownError do
-  _, element_id = el.ref
-  @driver.execute_script 'mobile: scrollToPage', { element: element_id, scrollToPage: -100 }
+  @driver.execute_script 'mobile: scrollToPage', { element: el.id, scrollToPage: -100 }
 end
 assert error.message.include? 'be a non-negative integer'
 ```

data/lib/appium_lib_core/common/base/bridge.rb

@@ -53,7 +53,7 @@ module Appium
         # Override
         # Creates session handling both OSS and W3C dialects.
         #
-        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] desired_capabilities A capability
+        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
         # @return [::Selenium::WebDriver::Remote::Capabilities]
         #
         # @example
@@ -78,7 +78,7 @@ module Appium
           @available_commands = ::Appium::Core::Commands::COMMANDS.dup
 
           caps = add_appium_prefix(capabilities)
-          response = execute(:new_session, {}, { capabilities: { firstMatch: [caps] } })
+          response = execute(:new_session, {}, { capabilities: { alwaysMatch: caps, firstMatch: [] } })
 
           @session_id = response['sessionId']
           raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
@@ -207,8 +207,7 @@ module Appium
           # For W3C
           # https://github.com/SeleniumHQ/selenium/commit/b618499adcc3a9f667590652c5757c0caa703289
           # execute_atom :isDisplayed, element
-          _, element_id = element.ref
-          execute :is_element_displayed, id: element_id
+          execute :is_element_displayed, id: element.id
         end
 
         # For Appium
@@ -216,8 +215,7 @@ module Appium
         def element_attribute(element, name)
           # For W3C in Selenium Client
           # execute_atom :getAttribute, element, name
-          _, element_id = element.ref
-          execute :get_element_attribute, id: element_id, name: name
+          execute :get_element_attribute, id: element.id, name: name
         end
 
         # For Appium

data/lib/appium_lib_core/common/base/capabilities.rb

@@ -22,6 +22,13 @@ module Appium
         # @return [::Selenium::WebDriver::Remote::Capabilities] Return instance of Appium::Core::Base::Capabilities
         #                         inherited ::Selenium::WebDriver::Remote::Capabilities
         def self.create_capabilities(opts_caps = {})
+          # TODO: Move to 'Options' way instead of 'Capabilities'.
+          # Selenium 5 will have Options instead of 'Capabilities'.
+          # https://github.com/SeleniumHQ/selenium/blob/trunk/rb/lib/selenium/webdriver/common/options.rb
+          # Then, Ruby client also shoud move to the Options way.
+          # Appium's capabilities could change by depending on Appium versions. So it does not have
+          # standard options like chrome and firefox etc. So, the implementation should differ from
+          # other browsers. But here should inherit `Options` to follow Selenium.
           ::Selenium::WebDriver::Remote::Capabilities.new(opts_caps)
         end
       end

data/lib/appium_lib_core/common/base/driver.rb

@@ -57,23 +57,7 @@ module Appium
         # @return [::Appium::Core::Base::Bridge]
         #
         def create_bridge(**opts)
-          caps = opts.delete(:capabilities)
-          # NOTE: This is deprecated
-          cap_array = caps.is_a?(Hash) ? [caps] : Array(caps)
-
-          desired_capabilities = opts.delete(:desired_capabilities)
-          if desired_capabilities
-            if desired_capabilities.is_a?(Hash)
-              desired_capabilities = ::Selenium::WebDriver::Remote::Capabilities(desired_capabilities)
-            end
-            cap_array << desired_capabilities
-          end
-
-          options = opts.delete(:options)
-          cap_array << options if options
-
-          capabilities = generate_capabilities(cap_array)
-
+          capabilities = opts.delete(:capabilities)
           bridge_opts = { http_client: opts.delete(:http_client), url: opts.delete(:url) }
           raise ::Appium::Core::Error::ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
 
@@ -175,8 +159,7 @@ module Appium
         #   # ':session_id' in the given url is replaced with current 'session id'.
         #   # ':id' in the given url is replaced with the given 'element_id'.
         #   e = @driver.find_element :accessibility_id, 'an element'
-        #   _, element_id = e.ref
-        #   @driver.test_action_command(element_id, 'action')
+        #   @driver.test_action_command(e.id, 'action')
         #
         def add_command(method:, url:, name:, &block)
           unless AVAILABLE_METHODS.include? method
@@ -255,22 +238,6 @@ module Appium
         end
         alias is_keyboard_shown keyboard_shown?
 
-        # [DEPRECATION]
-        # Send keys for a current active element
-        # @param [String] key Input text
-        #
-        # @example
-        #
-        #   @driver.send_keys 'happy testing!'
-        #
-        def send_keys(*key)
-          ::Appium::Logger.warn(
-            '[DEPRECATION] Driver#send_keys is deprecated in W3C spec. Use driver.action.<command>.perform instead'
-          )
-          @bridge.send_keys_to_active_element(key)
-        end
-        alias type send_keys
-
         # Returns an instance of DriverSettings to call get/update.
         #
         # @example

data/lib/appium_lib_core/common/base/screenshot.rb

@@ -82,12 +82,11 @@ module Appium
         #     @@driver.element_screenshot_as element, :base64 #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
         #
         def element_screenshot_as(element, format)
-          _, element_id = element.ref
           case format
           when :base64
-            bridge.element_screenshot element_id
+            bridge.element_screenshot element.id
           when :png
-            bridge.element_screenshot(element_id).unpack('m')[0]
+            bridge.element_screenshot(element.id).unpack('m')[0]
           else
             raise Core::Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
           end

data/lib/appium_lib_core/common/touch_action/touch_actions.rb

@@ -195,10 +195,7 @@ module Appium
       end
 
       def args_with_ele_ref(args)
-        if args.key? :element
-          _, element_id = args[:element].ref
-          args[:element] = element_id
-        end
+        args[:element] = args[:element].id if args.key? :element
         args
       end
     end # class TouchAction

data/lib/appium_lib_core/driver.rb

@@ -40,7 +40,7 @@ module Appium
 
       def initialize(appium_lib_opts)
         @custom_url = appium_lib_opts.fetch :server_url, nil
-        @default_wait = appium_lib_opts.fetch :wait, Driver::DEFAULT_IMPLICIT_WAIT
+        @default_wait = appium_lib_opts.fetch :wait, nil
         @enable_idempotency_header = appium_lib_opts.fetch :enable_idempotency_header, true
 
         # bump current session id into a particular file
@@ -135,11 +135,9 @@ module Appium
       attr_reader :export_session_path
 
       # Default wait time for elements to appear in Appium server side.
-      # Defaults to {::Appium::Core::Driver::DEFAULT_IMPLICIT_WAIT}.<br>
       # Provide <code>{ appium_lib: { wait: 30 } }</code> to {::Appium::Core.for}
       # @return [Integer]
       attr_reader :default_wait
-      DEFAULT_IMPLICIT_WAIT = 0
 
       # Appium's server port. 4723 is by default. Defaults to {::Appium::Core::Driver::DEFAULT_APPIUM_PORT}.<br>
       # Provide <code>{ appium_lib: { port: 8080 } }</code> to {::Appium::Core.for}.
@@ -187,8 +185,6 @@ module Appium
       # @option opts [Hash] :caps Appium capabilities.
       # @option opts [Hash] :capabilities The same as :caps.
       #                                   This param is for compatibility with Selenium WebDriver format
-      # @option opts [Hash] :desired_capabilities The same as :caps.
-      #                                           This param is for compatibility with Selenium WebDriver format
       # @option opts [Appium::Core::Options] :appium_lib Capabilities affect only ruby client
       # @option opts [String] :url The same as :custom_url in :appium_lib.
       #                            This param is for compatibility with Selenium WebDriver format
@@ -199,10 +195,8 @@ module Appium
       #
       #     # format 1
       #     @core = Appium::Core.for caps: {...}, appium_lib: {...}
-      #     # format 2. 'capabilities:' or 'desired_capabilities:' is also available instead of 'caps:'.
+      #     # format 2. 'capabilities:' is also available instead of 'caps:'.
       #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", capabilities: {...}, appium_lib: {...}
-      #     # format 3. 'appium_lib: {...}' can be blank
-      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}
       #
       #
       #     require 'rubygems'
@@ -230,7 +224,7 @@ module Appium
       #     @core.start_driver # Connect to 'http://127.0.0.1:8080/wd/hub' because of 'port: 8080'
       #
       #     # Start iOS driver with .zip file over HTTP
-      #     #  'desired_capabilities:' or 'capabilities:' is also available instead of 'caps:'. Either is fine.
+      #     # 'capabilities:' is also available instead of 'caps:'. Either is fine.
       #     opts = {
       #              capabilities: {
       #                platformName: :ios,
@@ -254,7 +248,7 @@ module Appium
       #     # Start iOS driver as another format. 'url' is available like below
       #     opts = {
       #              url: "http://custom-host:8080/wd/hub.com",
-      #              desired_capabilities: {
+      #              capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
       #                deviceName: 'iPhone Simulator',
@@ -368,8 +362,8 @@ module Appium
 
         begin
           @driver = ::Appium::Core::Base::Driver.new(listener: @listener,
-                                            http_client: @http_client,
-                                                     desired_capabilities: @caps,
+                                                     http_client: @http_client,
+                                                     capabilities: @caps, # ::Selenium::WebDriver::Remote::Capabilities
                                                      url: @custom_url)
 
           if @direct_connect
@@ -411,6 +405,8 @@ module Appium
 
       # Ignore setting default wait if the target driver has no implementation
       def set_implicit_wait_by_default(wait)
+        return if @default_wait.nil?
+
         @driver.manage.timeouts.implicit_wait = wait
       rescue ::Selenium::WebDriver::Error::UnknownError => e
         unless e.message.include?('The operation requested is not yet implemented')
@@ -480,21 +476,6 @@ module Appium
         p_version.split('.').map(&:to_i)
       end
 
-      # Takes a png screenshot and saves to the target path.
-      #
-      # @param png_save_path [String] the full path to save the png
-      # @return [File]
-      #
-      # @example
-      #
-      #   @core.screenshot '/tmp/hi.png' #=> nil
-      #   # same as '@driver.save_screenshot png_save_path'
-      #
-      def screenshot(png_save_path)
-        ::Appium::Logger.warn '[DEPRECATION] screenshot will be removed. Please use driver.save_screenshot instead.'
-        @driver.save_screenshot png_save_path
-      end
-
       private
 
       # @private
@@ -567,10 +548,7 @@ module Appium
       def validate_keys(opts)
         flatten_ops = flatten_hash_keys(opts)
 
-        # FIXME: Remove 'desired_capabilities' in the next major Selenium update
-        unless opts.member?(:caps) || opts.member?(:capabilities) || opts.member?(:desired_capabilities)
-          raise Error::NoCapabilityError
-        end
+        raise Error::NoCapabilityError unless opts.member?(:caps) || opts.member?(:capabilities)
 
         if !opts.member?(:appium_lib) && flatten_ops.member?(:appium_lib)
           raise Error::CapabilityStructureError, 'Please check the value of appium_lib in the capability'
@@ -591,8 +569,7 @@ module Appium
 
       # @private
       def get_caps(opts)
-        # FIXME: Remove 'desired_capabilities' in the next major Selenium update
-        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:capabilities] || opts[:desired_capabilities] || {})
+        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:capabilities] || {})
       end
 
       # @private

data/lib/appium_lib_core/element.rb

@@ -20,6 +20,15 @@ module Appium
       include ::Appium::Core::Base::SearchContext
       include ::Appium::Core::Base::TakesScreenshot
 
+      # Retuns the element id.
+      #
+      # @return [String]
+      # @example
+      #   e = @driver.find_element :accessibility_id, 'something'
+      #   e.id
+      #
+      attr_reader :id
+
       # Returns the value of attributes like below. Read each platform to know more details.
       #
       # uiautomator2: https://github.com/appium/appium-uiautomator2-server/blob/203cc7e57ce477f3cff5d95b135d1b3450a6033a/app/src/main/java/io/appium/uiautomator2/utils/Attribute.java#L19

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.0.0.rc1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-09-09' unless defined? ::Appium::Core::DATE
+    VERSION = '5.0.0.rc5' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-10-15' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,13 @@
+#### v4.7.1 2021-09-26
+
+- [cdd8906](https://github.com/appium/ruby_lib_core/commit/cdd890662585aa5051912d20d90ec3c3866ad8b1) Release 4.7.1
+- [059b092](https://github.com/appium/ruby_lib_core/commit/059b0920becd60d691b0b4fac05cc0d96bcc59c7) ci: tweak brew install
+- [fb32697](https://github.com/appium/ruby_lib_core/commit/fb32697d5ee7cf4ea4367aa9f9bf4458723d6fce) feat: allow to override an existing method by add_command (#330)
+- [cbf7f1f](https://github.com/appium/ruby_lib_core/commit/cbf7f1fc2ce6bb8833e2a7324446d79cbc848834) chore(deps-dev): update webmock requirement from ~> 3.13.0 to ~> 3.14.0 (#329)
+- [beefb17](https://github.com/appium/ruby_lib_core/commit/beefb179ac25e9337bf2badaf4eb0c4cfc5b1e45) chore(deps-dev): update rubocop requirement from = 1.12.0 to = 1.12.1 (#322)
+- [3438b48](https://github.com/appium/ruby_lib_core/commit/3438b481523ec978d06bc243cd42eee8dc00356f) docs: tweak docstring
+
+
 #### v4.7.0 2021-07-17
 
 - [0059974](https://github.com/appium/ruby_lib_core/commit/0059974b0b1d79a822db84d8b0169e8393e00ef9) Release 4.7.0

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc1
+  version: 5.0.0.rc5
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -333,7 +333,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"