appium_lib_core 4.3.1 → 5.0.0.beta2

data/lib/appium_lib_core/common/device/image_comparison.rb

@@ -95,6 +95,11 @@ module Appium
           # @param [Bool] visualize Makes the endpoint to return an image, which contains the visualized result of
           #                         the corresponding picture matching operation. This option is disabled by default.
           # @param [Float, nil] threshold [0.5] At what normalized threshold to reject
+          # @param [bool, nil] multiple Whether to enable the support of multiple image occurrences @since Appium 1.21.0.
+          # @param [integer, nil] match_neighbour_threshold The pixel distance between matches we consider to be part of
+          #                                                 the same template match @since Appium 1.21.0.
+          #                                                 This option is only considered if multiple matches mode is enabled.
+          #                                                 10 pixels by default.
           #
           # @example
           #     @driver.find_image_occurrence full_image: "image data 1", partial_image: "image data 2"
@@ -102,12 +107,15 @@ module Appium
           #     visual = @@driver.find_image_occurrence full_image: image1, partial_image: image2, visualize: true
           #     File.write 'find_result_visual.png', Base64.decode64(visual['visualization']) # if the image is PNG
           #
-          def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil)
+          def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil,
+                                    multiple: nil, match_neighbour_threshold: nil)
             raise "visualize should be #{MATCH_TEMPLATE[:visualize]}" unless MATCH_TEMPLATE[:visualize].member?(visualize)
 
             options = {}
             options[:visualize] = visualize
             options[:threshold] = threshold unless threshold.nil?
+            options[:multiple] = multiple unless multiple.nil?
+            options[:matchNeighbourThreshold] = match_neighbour_threshold unless match_neighbour_threshold.nil?
 
             compare_images(mode: :matchTemplate, first_image: full_image, second_image: partial_image, options: options)
           end

data/lib/appium_lib_core/device.rb

@@ -79,11 +79,7 @@ module Appium
         end
 
         def create_bridge_command(method, &block)
-          ::Appium::Core::Base::Bridge::MJSONWP.class_eval do
-            undef_method method if method_defined? method
-            block_given? ? class_eval(&block) : define_method(method) { execute method }
-          end
-          ::Appium::Core::Base::Bridge::W3C.class_eval do
+          ::Appium::Core::Base::Bridge.class_eval do
             undef_method method if method_defined? method
             block_given? ? class_eval(&block) : define_method(method) { execute method }
           end

data/lib/appium_lib_core/driver.rb

@@ -368,10 +368,10 @@ module Appium
 
         begin
           # included https://github.com/SeleniumHQ/selenium/blob/43f8b3f66e7e01124eff6a5805269ee441f65707/rb/lib/selenium/webdriver/remote/driver.rb#L29
-          @driver = ::Appium::Core::Base::Driver.new(http_client: @http_client,
-                                                     desired_capabilities: @caps,
-                                                     url: @custom_url,
-                                                     listener: @listener)
+          @driver = ::Appium::Core::Base::Driver.new(listener: @listener,
+                                                     http_client: @http_client,
+                                                      desired_capabilities: @caps,
+                                                      url: @custom_url)
 
           if @direct_connect
             d_c = DirectConnections.new(@driver.capabilities)
@@ -437,7 +437,8 @@ module Appium
         nil
       end
 
-      # Returns the server's version info
+      # Returns the server's version info. This method calls +driver.remote_status+ internally
+      #
       # @return [Hash]
       #
       # @example
@@ -451,18 +452,20 @@ module Appium
       #         }
       #     }
       #
-      # Returns blank hash for Selenium Grid since 'remote_status' gets 500 error
+      # Returns blank hash in a case +driver.remote_status+ got an error
+      # such as Selenium Grid. It returns 500 error against 'remote_status'.
       #
       # @example
       #
       #   @core.appium_server_version #=> {}
       #
       def appium_server_version
-        @driver.remote_status
-      rescue Selenium::WebDriver::Error::ServerError => e
-        raise ::Appium::Core::Error::ServerError unless e.message.include?('status code 500')
+        return {} if @driver.nil?
 
-        # driver.remote_status returns 500 error for using selenium grid
+        @driver.remote_status
+      rescue StandardError
+        # Ignore error case in a case the target appium server
+        # does not support `/status` API.
         {}
       end
 

data/lib/appium_lib_core/{patch.rb → element.rb}

@@ -12,16 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Style/ClassAndModuleChildren
 module Appium
   module Core
     # Implement useful features for element.
     # Patch for Selenium Webdriver.
-    class Selenium::WebDriver::Element
-      # To extend Appium related SearchContext into ::Selenium::WebDriver::Element
+    class Element < ::Selenium::WebDriver::Element
       include ::Appium::Core::Base::SearchContext
-
-      # TODO: Probably can remove own TakesScreenshot since Selenium 4
       include ::Appium::Core::Base::TakesScreenshot
 
       # Returns the value of attributes like below. Read each platform to know more details.
@@ -152,7 +148,6 @@ module Appium
         end
         File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
       end
-    end
+    end # class Element
   end # module Core
 end # module Appium
-# rubocop:enable Style/ClassAndModuleChildren

data/lib/appium_lib_core/ios/uiautomation/patch.rb

@@ -21,7 +21,7 @@ module Appium
         # will trigger as soon as the file is required. in contrast a method
         # will trigger only when invoked.
         def self.patch_webdriver_element
-          ::Selenium::WebDriver::Element.class_eval do
+          ::Appium::Core::Element.class_eval do
             # Cross platform way of entering text into a textfield
             def type(text, driver)
               driver.execute_script %(au.getElement('#{ref}').setValue('#{text}');)

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '4.3.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-02-07' unless defined? ::Appium::Core::DATE
+    VERSION = '5.0.0.beta2' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-04-13' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,23 @@
+#### v4.5.0 2021-03-14
+
+- [656230e](https://github.com/appium/ruby_lib_core/commit/656230e688ed86414c06efaa73bce7359933cc91) Release 4.5.0
+- [a0a3cfc](https://github.com/appium/ruby_lib_core/commit/a0a3cfc71783bed3d1b0e7afbf6bc0a27bf60a48) feat: add speed option (#318)
+- [16b4f09](https://github.com/appium/ruby_lib_core/commit/16b4f0991deb639314857c3cbece1e4d00393646) feat: add multiple and match_neighbour_threshold (#313)
+- [d195a5b](https://github.com/appium/ruby_lib_core/commit/d195a5ba48c2e1a7229e0145eac616fd886c1ee0) ci: use node 12
+
+
+#### v4.4.1 2021-02-15
+
+- [dc34419](https://github.com/appium/ruby_lib_core/commit/dc34419dfcc4dd8d499a6407d45ab3efe70c2445) Release 4.4.1
+- [3085048](https://github.com/appium/ruby_lib_core/commit/3085048b4816e3415017ebb188e653c8e229a05e) chore: return {} in nil case as well
+
+
+#### v4.4.0 2021-02-13
+
+- [06c68fb](https://github.com/appium/ruby_lib_core/commit/06c68fbe3ffdbb7b068d2f71ad6841c66dbabf8f) Release 4.4.0
+- [3c54ae2](https://github.com/appium/ruby_lib_core/commit/3c54ae25d9a334f3690c94ce8a59a5c6a4bacd20) feat: always return {} in appium_server_version for errors (#311)
+
+
 #### v4.3.1 2021-02-07
 
 - [1f4d52c](https://github.com/appium/ruby_lib_core/commit/1f4d52cc915783cf89cf4b8ca5a21bd1af5403e0) Release 4.3.1

data/script/commands.rb

@@ -18,26 +18,18 @@ require './lib/appium_lib_core'
 module Script
   class CommandsChecker
     attr_reader :spec_commands,
-                :implemented_mjsonwp_commands, :implemented_w3c_commands, :implemented_core_commands,
-                :webdriver_oss_commands, :webdriver_w3c_commands
+                :implemented_w3c_commands, :implemented_core_commands,
+                :webdriver_w3c_commands
 
     # Set commands implemented in this core library.
     #
-    # - implemented_mjsonwp_commands:  All commands include ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS
-    # - implemented_w3c_commands:  All commands include ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS
+    # - implemented_w3c_commands:  All commands include ::Selenium::WebDriver::Remote::Bridge::COMMANDS
     # - implemented_core_commands:  All commands except for selenium-webdriver's commands
-    # - webdriver_oss_commands: ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS
-    # - webdriver_w3c_commands: ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS
     #
     def initialize
       @spec_commands = nil
 
-      @implemented_mjsonwp_commands = convert_driver_commands Appium::Core::Commands::MJSONWP::COMMANDS
-      @implemented_w3c_commands = convert_driver_commands Appium::Core::Commands::W3C::COMMANDS
       @implemented_core_commands = convert_driver_commands Appium::Core::Commands::COMMANDS
-
-      @webdriver_oss_commands = convert_driver_commands Appium::Core::Base::Commands::OSS
-      @webdriver_w3c_commands = convert_driver_commands Appium::Core::Base::Commands::W3C
     end
 
     # Get the bellow url's file.
@@ -80,18 +72,6 @@ module Script
       end
     end
 
-    # All commands which haven't been implemented in ruby core library yet.
-    # @return [Hash]
-    #
-    def all_diff_commands_mjsonwp
-      result = compare_commands(@spec_commands, @implemented_mjsonwp_commands)
-
-      white_list.each { |v| result.delete v }
-      w3c_spec.each { |v| result.delete v }
-
-      result
-    end
-
     # All commands which haven't been implemented in ruby core library yet.
     # @return [Hash]
     #
@@ -111,20 +91,6 @@ module Script
       result
     end
 
-    def diff_webdriver_oss
-      result = compare_commands(@spec_commands, @webdriver_oss_commands)
-      white_list.each { |v| result.delete v }
-      w3c_spec.each { |v| result.delete v }
-      result
-    end
-
-    def diff_webdriver_w3c
-      result = compare_commands(@spec_commands, @webdriver_w3c_commands)
-      white_list.each { |v| result.delete v }
-      mjsonwp_spec.each { |v| result.delete v }
-      result
-    end
-
     def compare_commands(command1, with_command2)
       return {} if command1.nil?
       return command1 if with_command2.nil?

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 5.0.0.beta2
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.14'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.1
+        version: 4.0.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.14'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.1
+        version: 4.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -262,20 +256,17 @@ files:
 - lib/appium_lib_core/common.rb
 - lib/appium_lib_core/common/base.rb
 - lib/appium_lib_core/common/base/bridge.rb
-- lib/appium_lib_core/common/base/bridge/mjsonwp.rb
-- lib/appium_lib_core/common/base/bridge/w3c.rb
 - lib/appium_lib_core/common/base/capabilities.rb
-- lib/appium_lib_core/common/base/command.rb
 - lib/appium_lib_core/common/base/driver.rb
+- lib/appium_lib_core/common/base/has_location.rb
+- lib/appium_lib_core/common/base/has_network_connection.rb
 - lib/appium_lib_core/common/base/http_default.rb
 - lib/appium_lib_core/common/base/platform.rb
+- lib/appium_lib_core/common/base/remote_status.rb
 - lib/appium_lib_core/common/base/rotable.rb
 - lib/appium_lib_core/common/base/screenshot.rb
 - lib/appium_lib_core/common/base/search_context.rb
 - lib/appium_lib_core/common/command.rb
-- lib/appium_lib_core/common/command/common.rb
-- lib/appium_lib_core/common/command/mjsonwp.rb
-- lib/appium_lib_core/common/command/w3c.rb
 - lib/appium_lib_core/common/device/app_management.rb
 - lib/appium_lib_core/common/device/app_state.rb
 - lib/appium_lib_core/common/device/battery_status.rb
@@ -304,6 +295,7 @@ files:
 - lib/appium_lib_core/common/ws/websocket.rb
 - lib/appium_lib_core/device.rb
 - lib/appium_lib_core/driver.rb
+- lib/appium_lib_core/element.rb
 - lib/appium_lib_core/ios.rb
 - lib/appium_lib_core/ios/device.rb
 - lib/appium_lib_core/ios/device/clipboard.rb
@@ -320,7 +312,6 @@ files:
 - lib/appium_lib_core/mac2/bridge.rb
 - lib/appium_lib_core/mac2/device.rb
 - lib/appium_lib_core/mac2/device/screen.rb
-- lib/appium_lib_core/patch.rb
 - lib/appium_lib_core/version.rb
 - lib/appium_lib_core/windows.rb
 - lib/appium_lib_core/windows/bridge.rb
@@ -340,12 +331,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: 

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module Appium
-  module Core
-    class Base
-      class Bridge
-        class MJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
-          include Device::DeviceLock
-          include Device::Keyboard
-          include Device::ImeActions
-          include Device::Setting
-          include Device::Context
-          include Device::Value
-          include Device::FileManagement
-          include Device::KeyEvent
-          include Device::ImageComparison
-          include Device::AppManagement
-          include Device::AppState
-          include Device::ScreenRecord::Command
-          include Device::Device
-          include Device::TouchActions
-          include Device::ExecuteDriver
-
-          def commands(command)
-            ::Appium::Core::Commands::MJSONWP::COMMANDS[command]
-          end
-
-          # Returns all available sessions on the Appium server instance
-          def sessions
-            execute :get_all_sessions
-          end
-
-          # For Appium
-          def log_event(vendor, event)
-            execute :post_log_event, {}, { vendor: vendor, event: event }
-          end
-
-          # For Appium
-          def log_events(type = nil)
-            args = {}
-            args['type'] = type unless type.nil?
-
-            execute :get_log_events, {}, args
-          end
-
-          def take_element_screenshot(element)
-            execute :take_element_screenshot, id: element.ref
-          end
-
-          def take_viewport_screenshot
-            # TODO: this hasn't been supported by Espresso driver
-            execute_script('mobile: viewportScreenshot')
-          end
-
-          def send_actions(_data)
-            raise Error::UnsupportedOperationError, '#send_actions has not been supported in MJSONWP'
-          end
-
-          # For Appium
-          # @param [Hash] id The id which can get as a response from server
-          # @return [::Selenium::WebDriver::Element]
-          def convert_to_element(id)
-            ::Selenium::WebDriver::Element.new self, element_id_from(id)
-          end
-        end # class MJSONWP
-      end # class Bridge
-    end # class Base
-  end # module Core
-end # module Appium