appium_lib_core 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 816965726811ed0e4814ff74f562f821a1d02a96
-  data.tar.gz: 48de6d03d02f08681e80b2f830e415016016b57f
+  metadata.gz: 1f5dd97d1cbe46c9a3de56622d0235855c17d5fa
+  data.tar.gz: 8ae9a77dd25ac92e3c6c2028f2e2366f770d4b7c
 SHA512:
-  metadata.gz: fe453c38eee0cdf8405c19580f48de596338054bd4208e245a81825da5d229c65732c62327047f0da48169e2522dacbd8181ffe70c357abd25f6f2f938a70a80
-  data.tar.gz: da619b8b509db626f9dfbadc38048d9673e632bd505cb343750b3f6153b8871fd59c3d20d426656e3b741e320b498bfa4f94548ced25d145a0fb595df9087f1b
+  metadata.gz: d6239c7d4e68eb97e9f9bb55cd727f585a671baee664d89fb8f08f7ff86f40fc7bc68753575154709ce5ee963d1a90bc3a02a3234c182b49051ef08cab4fe635
+  data.tar.gz: 66925a81fe4e906508ac090bc606053ebc0fcb05a870fdbbc7cd81b9cad56229b2301b7d8109c6618d8dfe259275713c9eacfc5306b89170c65d314159bde129

data/.rubocop.yml

@@ -11,9 +11,9 @@ Metrics/ClassLength:
 Metrics/AbcSize:
   Enabled: false
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 9
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 9
 Style/Documentation:
   Enabled: false
 Style/CommentedKeyword:

data/CHANGELOG.md

@@ -8,6 +8,17 @@ All notable changes to this project will be documented in this file.
 
 ### Deprecations
 
+## [1.4.1] - 2018-04-22
+### Enhancements
+- add base image comparison
+    - `match_images_features`, `find_image_occurrence`, `get_images_similarity`, `compare_images`
+- [internal] No longer have dependency for Selenium's wait
+- [internal] Separate mjsonwp commands module and w3c commands module from one command module
+
+### Bug fixes
+
+### Deprecations
+
 ## [1.4.0] - 2018-04-15
 ### Enhancements
 - Add a support for WebSocket client based on Faye::WebSocket::Client [#74](https://github.com/appium/ruby_lib_core/pull/74)

data/appium_lib_core.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'selenium-webdriver', '~> 3.5'
-  spec.add_runtime_dependency 'json', '>= 1.8'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.10.0'
 
   spec.add_development_dependency 'bundler', '~> 1.14'

data/lib/appium_lib_core.rb

@@ -5,12 +5,7 @@ require_relative 'appium_lib_core/common'
 require_relative 'appium_lib_core/patch'
 require_relative 'appium_lib_core/driver'
 
-# for multi touch related methods
-require_relative 'appium_lib_core/device/touch_actions'
-require_relative 'appium_lib_core/device/multi_touch'
-require_relative 'appium_lib_core/device/screen_record'
-require_relative 'appium_lib_core/device/app_state'
-require_relative 'appium_lib_core/device/clipboard_content_type'
+require_relative 'appium_lib_core/device'
 
 require_relative 'appium_lib_core/android'
 require_relative 'appium_lib_core/android_uiautomator2'

data/lib/appium_lib_core/common.rb

@@ -2,6 +2,6 @@ require_relative 'common/logger'
 require_relative 'common/error'
 require_relative 'common/log'
 require_relative 'common/command'
-require_relative 'common/device'
 require_relative 'common/base'
+require_relative 'common/wait'
 require_relative 'common/ws/websocket'

data/lib/appium_lib_core/common/base.rb

@@ -1,10 +1,9 @@
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'
 require_relative 'base/bridge'
-require_relative 'base/bridge/msjsonwp'
+require_relative 'base/bridge/mjsonwp'
 require_relative 'base/bridge/w3c'
 require_relative 'base/capabilities'
 require_relative 'base/http_default'
 require_relative 'base/search_context'
 require_relative 'base/command'
-require_relative 'base/wait'

data/lib/appium_lib_core/common/base/bridge/{msjsonwp.rb → mjsonwp.rb}

@@ -4,7 +4,7 @@ module Appium
       class Bridge
         class MJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
           def commands(command)
-            ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
+            ::Appium::Core::Commands::MJSONWP::COMMANDS[command]
           end
         end # class MJSONWP
       end # class Bridge

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

@@ -8,7 +8,7 @@ module Appium
           ::Selenium::WebDriver::PointerActions::DEFAULT_MOVE_DURATION = 0.05
 
           def commands(command)
-            ::Appium::Core::Commands::COMMANDS_EXTEND_W3C[command]
+            ::Appium::Core::Commands::W3C::COMMANDS[command]
           end
 
           # Perform touch actions for W3C module.

data/lib/appium_lib_core/common/command.rb

@@ -1,132 +1,4 @@
 require_relative 'base/command'
-
-module Appium
-  module Core
-    # ref: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js
-    module Commands
-      # Some commands differ for each driver.
-      COMMAND = {
-        # common
-        available_contexts:         [:get,  'session/:session_id/contexts'.freeze],
-        set_context:                [:post, 'session/:session_id/context'.freeze],
-        current_context:            [:get,  'session/:session_id/context'.freeze],
-
-        touch_actions:              [:post, 'session/:session_id/touch/perform'.freeze],
-        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'.freeze],
-
-        set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
-        replace_value:              [:post, 'session/:session_id/appium/element/:id/replace_value'.freeze],
-
-        launch_app:                 [:post, 'session/:session_id/appium/app/launch'.freeze],
-        close_app:                  [:post, 'session/:session_id/appium/app/close'.freeze],
-        reset:                      [:post, 'session/:session_id/appium/app/reset'.freeze],
-        background_app:             [:post, 'session/:session_id/appium/app/background'.freeze],
-        app_strings:                [:post, 'session/:session_id/appium/app/strings'.freeze],
-
-        device_locked?:             [:post, 'session/:session_id/appium/device/is_locked'.freeze],
-        unlock:                     [:post, 'session/:session_id/appium/device/unlock'.freeze],
-        lock:                       [:post, 'session/:session_id/appium/device/lock'.freeze],
-        device_time:                [:get,  'session/:session_id/appium/device/system_time'.freeze],
-        install_app:                [:post, 'session/:session_id/appium/device/install_app'.freeze],
-        remove_app:                 [:post, 'session/:session_id/appium/device/remove_app'.freeze],
-        app_installed?:             [:post, 'session/:session_id/appium/device/app_installed'.freeze],
-        activate_app:               [:post, 'session/:session_id/appium/device/activate_app'.freeze],
-        terminate_app:              [:post, 'session/:session_id/appium/device/terminate_app'.freeze],
-        app_state:                  [:post, 'session/:session_id/appium/device/app_state'.freeze],
-        shake:                      [:post, 'session/:session_id/appium/device/shake'.freeze],
-        hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
-        press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'.freeze],
-        long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
-        # keyevent is only for Selendroid
-        keyevent:                   [:post, 'session/:session_id/appium/device/keyevent'.freeze],
-        push_file:                  [:post, 'session/:session_id/appium/device/push_file'.freeze],
-        pull_file:                  [:post, 'session/:session_id/appium/device/pull_file'.freeze],
-        pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
-        get_clipboard:              [:post, 'session/:session_id/appium/device/get_clipboard'.freeze],
-        set_clipboard:              [:post, 'session/:session_id/appium/device/set_clipboard'.freeze],
-        get_settings:               [:get,  'session/:session_id/appium/settings'.freeze],
-        update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
-        stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'.freeze],
-        start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'.freeze]
-      }.freeze
-
-      COMMAND_ANDROID = {
-        open_notifications:         [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
-        toggle_airplane_mode:       [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
-        start_activity:             [:post, 'session/:session_id/appium/device/start_activity'.freeze],
-        current_activity:           [:get,  'session/:session_id/appium/device/current_activity'.freeze],
-        current_package:            [:get,  'session/:session_id/appium/device/current_package'.freeze],
-        get_system_bars:            [:get,  'session/:session_id/appium/device/system_bars'.freeze],
-        get_display_density:        [:get,  'session/:session_id/appium/device/display_density'.freeze],
-        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'.freeze],
-        toggle_wifi:                [:post, 'session/:session_id/appium/device/toggle_wifi'.freeze],
-        toggle_data:                [:post, 'session/:session_id/appium/device/toggle_data'.freeze],
-        toggle_location_services:   [:post, 'session/:session_id/appium/device/toggle_location_services'.freeze],
-        end_coverage:               [:post, 'session/:session_id/appium/app/end_test_coverage'.freeze],
-        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze],
-        get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'.freeze],
-        get_network_connection:     [:get,  'session/:session_id/network_connection'.freeze], # defined also in OSS
-        set_network_connection:     [:post, 'session/:session_id/network_connection'.freeze], # defined also in OSS
-
-        # only emulator
-        send_sms:                   [:post, 'session/:session_id/appium/device/send_sms'.freeze],
-        gsm_call:                   [:post, 'session/:session_id/appium/device/gsm_call'.freeze],
-        gsm_signal:                 [:post, 'session/:session_id/appium/device/gsm_signal'.freeze],
-        gsm_voice:                  [:post, 'session/:session_id/appium/device/gsm_voice'.freeze],
-        set_network_speed:          [:post, 'session/:session_id/appium/device/network_speed'.freeze],
-        set_power_capacity:         [:post, 'session/:session_id/appium/device/power_capacity'.freeze],
-        set_power_ac:               [:post, 'session/:session_id/appium/device/power_ac'.freeze]
-      }.freeze
-
-      COMMAND_IOS = {
-        touch_id:                   [:post, 'session/:session_id/appium/simulator/touch_id'.freeze],
-        toggle_touch_id_enrollment: [:post, 'session/:session_id/appium/simulator/toggle_touch_id_enrollment'.freeze]
-      }.freeze
-
-      COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS).freeze
-
-      COMMANDS_EXTEND_MJSONWP = COMMANDS.merge(::Appium::Core::Base::Commands::OSS).merge(
-        {
-          # W3C already has.
-          take_element_screenshot:    [:get, 'session/:session_id/element/:id/screenshot'.freeze]
-        }
-      ).freeze
-      COMMANDS_EXTEND_W3C = COMMANDS.merge(::Appium::Core::Base::Commands::W3C).merge(
-        {
-          # ::Appium::Core::Base::Commands::OSS has the following commands and Appium also use them.
-          # Delegated to ::Appium::Core::Base::Commands::OSS commands
-          status:                    [:get, 'status'.freeze],
-          is_element_displayed:      [:get, 'session/:session_id/element/:id/displayed'.freeze],
-
-          # FIXME: remove after apply https://github.com/SeleniumHQ/selenium/pull/5249
-          # The fix will be included in selenium-3.8.2
-          get_page_source: [:get, 'session/:session_id/source'.freeze],
-
-          get_timeouts: [:get, 'session/:session_id/timeouts'.freeze],
-
-          ## Add OSS commands to W3C commands. We can remove them if we would like to remove them from W3C module.
-          ### Session capability
-          get_capabilities:       [:get, 'session/:session_id'.freeze],
-
-          ### rotatable
-          get_screen_orientation: [:get, 'session/:session_id/orientation'.freeze],
-          set_screen_orientation: [:post, 'session/:session_id/orientation'.freeze],
-
-          get_location: [:get, 'session/:session_id/location'.freeze],
-          set_location: [:post, 'session/:session_id/location'.freeze],
-
-          ### For IME
-          ime_get_available_engines: [:get,  'session/:session_id/ime/available_engines'.freeze],
-          ime_get_active_engine:     [:get,  'session/:session_id/ime/active_engine'.freeze],
-          ime_is_activated:          [:get,  'session/:session_id/ime/activated'.freeze],
-          ime_deactivate:            [:post, 'session/:session_id/ime/deactivate'.freeze],
-          ime_activate_engine:       [:post, 'session/:session_id/ime/activate'.freeze],
-
-          ### Logs
-          get_available_log_types: [:get, 'session/:session_id/log/types'.freeze],
-          get_log: [:post, 'session/:session_id/log'.freeze]
-        }
-      ).freeze
-    end
-  end
-end
+require_relative 'command/common'
+require_relative 'command/mjsonwp'
+require_relative 'command/w3c'

data/lib/appium_lib_core/common/command/common.rb

@@ -0,0 +1,88 @@
+module Appium
+  module Core
+    # ref: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js
+    module Commands
+      # Some commands differ for each driver.
+      COMMAND = {
+        # common
+        available_contexts:         [:get,  'session/:session_id/contexts'.freeze],
+        set_context:                [:post, 'session/:session_id/context'.freeze],
+        current_context:            [:get,  'session/:session_id/context'.freeze],
+
+        touch_actions:              [:post, 'session/:session_id/touch/perform'.freeze],
+        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'.freeze],
+
+        set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
+        replace_value:              [:post, 'session/:session_id/appium/element/:id/replace_value'.freeze],
+
+        launch_app:                 [:post, 'session/:session_id/appium/app/launch'.freeze],
+        close_app:                  [:post, 'session/:session_id/appium/app/close'.freeze],
+        reset:                      [:post, 'session/:session_id/appium/app/reset'.freeze],
+        background_app:             [:post, 'session/:session_id/appium/app/background'.freeze],
+        app_strings:                [:post, 'session/:session_id/appium/app/strings'.freeze],
+
+        device_locked?:             [:post, 'session/:session_id/appium/device/is_locked'.freeze],
+        unlock:                     [:post, 'session/:session_id/appium/device/unlock'.freeze],
+        lock:                       [:post, 'session/:session_id/appium/device/lock'.freeze],
+        device_time:                [:get,  'session/:session_id/appium/device/system_time'.freeze],
+        install_app:                [:post, 'session/:session_id/appium/device/install_app'.freeze],
+        remove_app:                 [:post, 'session/:session_id/appium/device/remove_app'.freeze],
+        app_installed?:             [:post, 'session/:session_id/appium/device/app_installed'.freeze],
+        activate_app:               [:post, 'session/:session_id/appium/device/activate_app'.freeze],
+        terminate_app:              [:post, 'session/:session_id/appium/device/terminate_app'.freeze],
+        app_state:                  [:post, 'session/:session_id/appium/device/app_state'.freeze],
+        shake:                      [:post, 'session/:session_id/appium/device/shake'.freeze],
+        hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
+        press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'.freeze],
+        long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
+        # keyevent is only for Selendroid
+        keyevent:                   [:post, 'session/:session_id/appium/device/keyevent'.freeze],
+        push_file:                  [:post, 'session/:session_id/appium/device/push_file'.freeze],
+        pull_file:                  [:post, 'session/:session_id/appium/device/pull_file'.freeze],
+        pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
+        get_clipboard:              [:post, 'session/:session_id/appium/device/get_clipboard'.freeze],
+        set_clipboard:              [:post, 'session/:session_id/appium/device/set_clipboard'.freeze],
+        get_settings:               [:get,  'session/:session_id/appium/settings'.freeze],
+        update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
+        stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'.freeze],
+        start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'.freeze],
+        compare_images:             [:post, 'session/:session_id/appium/compare_images'.freeze]
+      }.freeze
+
+      COMMAND_ANDROID = {
+        open_notifications:         [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
+        toggle_airplane_mode:       [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
+        start_activity:             [:post, 'session/:session_id/appium/device/start_activity'.freeze],
+        current_activity:           [:get,  'session/:session_id/appium/device/current_activity'.freeze],
+        current_package:            [:get,  'session/:session_id/appium/device/current_package'.freeze],
+        get_system_bars:            [:get,  'session/:session_id/appium/device/system_bars'.freeze],
+        get_display_density:        [:get,  'session/:session_id/appium/device/display_density'.freeze],
+        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'.freeze],
+        toggle_wifi:                [:post, 'session/:session_id/appium/device/toggle_wifi'.freeze],
+        toggle_data:                [:post, 'session/:session_id/appium/device/toggle_data'.freeze],
+        toggle_location_services:   [:post, 'session/:session_id/appium/device/toggle_location_services'.freeze],
+        end_coverage:               [:post, 'session/:session_id/appium/app/end_test_coverage'.freeze],
+        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze],
+        get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'.freeze],
+        get_network_connection:     [:get,  'session/:session_id/network_connection'.freeze], # defined also in OSS
+        set_network_connection:     [:post, 'session/:session_id/network_connection'.freeze], # defined also in OSS
+
+        # only emulator
+        send_sms:                   [:post, 'session/:session_id/appium/device/send_sms'.freeze],
+        gsm_call:                   [:post, 'session/:session_id/appium/device/gsm_call'.freeze],
+        gsm_signal:                 [:post, 'session/:session_id/appium/device/gsm_signal'.freeze],
+        gsm_voice:                  [:post, 'session/:session_id/appium/device/gsm_voice'.freeze],
+        set_network_speed:          [:post, 'session/:session_id/appium/device/network_speed'.freeze],
+        set_power_capacity:         [:post, 'session/:session_id/appium/device/power_capacity'.freeze],
+        set_power_ac:               [:post, 'session/:session_id/appium/device/power_ac'.freeze]
+      }.freeze
+
+      COMMAND_IOS = {
+        touch_id:                   [:post, 'session/:session_id/appium/simulator/touch_id'.freeze],
+        toggle_touch_id_enrollment: [:post, 'session/:session_id/appium/simulator/toggle_touch_id_enrollment'.freeze]
+      }.freeze
+
+      COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS).freeze
+    end # module Commands
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/common/command/mjsonwp.rb

@@ -0,0 +1,14 @@
+module Appium
+  module Core
+    module Commands
+      module MJSONWP
+        COMMANDS = ::Appium::Core::Commands::COMMANDS.merge(::Appium::Core::Base::Commands::OSS).merge(
+          {
+            # W3C already has.
+            take_element_screenshot:    [:get, 'session/:session_id/element/:id/screenshot'.freeze]
+          }
+        ).freeze
+      end # module MJSONWP
+    end # module Commands
+  end # module Core
+end # Appium

data/lib/appium_lib_core/common/command/w3c.rb

@@ -0,0 +1,44 @@
+module Appium
+  module Core
+    module Commands
+      module W3C
+        COMMANDS = ::Appium::Core::Commands::COMMANDS.merge(::Appium::Core::Base::Commands::W3C).merge(
+          {
+            # ::Appium::Core::Base::Commands::OSS has the following commands and Appium also use them.
+            # Delegated to ::Appium::Core::Base::Commands::OSS commands
+            status:                    [:get, 'status'.freeze],
+            is_element_displayed:      [:get, 'session/:session_id/element/:id/displayed'.freeze],
+
+            # FIXME: remove after apply https://github.com/SeleniumHQ/selenium/pull/5249
+            # The fix will be included in selenium-3.8.2
+            get_page_source:           [:get, 'session/:session_id/source'.freeze],
+
+            get_timeouts:              [:get, 'session/:session_id/timeouts'.freeze],
+
+            ## Add OSS commands to W3C commands. We can remove them if we would like to remove them from W3C module.
+            ### Session capability
+            get_capabilities:          [:get, 'session/:session_id'.freeze],
+
+            ### rotatable
+            get_screen_orientation:    [:get, 'session/:session_id/orientation'.freeze],
+            set_screen_orientation:    [:post, 'session/:session_id/orientation'.freeze],
+
+            get_location:              [:get, 'session/:session_id/location'.freeze],
+            set_location:              [:post, 'session/:session_id/location'.freeze],
+
+            ### For IME
+            ime_get_available_engines: [:get,  'session/:session_id/ime/available_engines'.freeze],
+            ime_get_active_engine:     [:get,  'session/:session_id/ime/active_engine'.freeze],
+            ime_is_activated:          [:get,  'session/:session_id/ime/activated'.freeze],
+            ime_deactivate:            [:post, 'session/:session_id/ime/deactivate'.freeze],
+            ime_activate_engine:       [:post, 'session/:session_id/ime/activate'.freeze],
+
+            ### Logs
+            get_available_log_types:   [:get, 'session/:session_id/log/types'.freeze],
+            get_log:                   [:post, 'session/:session_id/log'.freeze]
+          }
+        ).freeze
+      end # module W3C
+    end # module Commands
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/common/wait.rb

@@ -0,0 +1,162 @@
+require_relative 'wait/timer'
+
+module Appium
+  module Core
+    module Wait
+      class TimeoutError < StandardError; end
+
+      DEFAULT_TIMEOUT  = 30
+      DEFAULT_INTERVAL = 0.5
+
+      class << self
+        # Check every interval seconds to see if yield doesn't raise an exception.
+        # Give up after timeout seconds.
+        #
+        # If only a number is provided then it's treated as the timeout value.
+        #
+        # @param [Integer] timeout: Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
+        # @param [Integer] interval: Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+        # @param [String] message: Exception message if timed out.
+        # @param [Array, Exception] ignored: Exceptions to ignore while polling (default: Exception)
+        # @param [Object, NilClass] object: Object to evaluate block against
+        #
+        # @example
+        #
+        #     result = Appium::Core::Wait.until { @driver.find_element(:id, 'something') }
+        #
+        #     result = Appium::Core::Wait.until(object: 'some object') { |object|
+        #        @driver.find_element(:id, object)
+        #     }
+        #
+        def until(timeout: DEFAULT_TIMEOUT, interval: DEFAULT_INTERVAL, message: nil, ignored: nil, object: nil)
+          ignored = Array(ignored || ::Exception)
+
+          last_error = nil
+
+          begin
+            run_with_timer(timeout, interval) { return yield(object) }
+          rescue ::Errno::ECONNREFUSED => e
+            raise e
+          rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
+            # swallowed
+          end
+
+          msg = message_for timeout, message
+          msg << " (#{last_error.message})" if last_error
+
+          raise TimeoutError, msg
+        end
+
+        # Check every interval seconds to see if yield returns a truthy value.
+        # Note this isn't a strict boolean true, any truthy value is accepted.
+        # false and nil are considered failures.
+        # Give up after timeout seconds.
+        #
+        # If only a number is provided then it's treated as the timeout value.
+        #
+        # @param [Integer] timeout: Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
+        # @param [Integer] interval: Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+        # @param [String] message: Exception message if timed out.
+        # @param [Array, Exception] ignored: Exceptions to ignore while polling (default: Exception)
+        # @param [Object, NilClass] object: Object to evaluate block against
+        #
+        # @example
+        #
+        #     Appium::Core::Wait.until_true { @driver.find_element(:id, 'something') }
+        #
+        #     Appium::Core::Wait.until_true(object: 'some object') { |object|
+        #        @driver.find_element(:id, object)
+        #     }
+        #
+        def until_true(timeout: DEFAULT_TIMEOUT, interval: DEFAULT_INTERVAL, message: nil, ignored: nil, object: nil)
+          ignored = Array(ignored || ::Exception)
+
+          last_error = nil
+
+          begin
+            run_with_timer(timeout, interval) do
+              result = yield(object)
+              return result if result
+            end
+          rescue ::Errno::ECONNREFUSED => e
+            raise e
+          rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
+            # swallowed
+          end
+
+          msg = message_for timeout, message
+          msg << " (#{last_error.message})" if last_error
+
+          raise TimeoutError, msg
+        end
+
+        private
+
+        def message_for(timeout, message)
+          msg = "timed out after #{timeout} seconds"
+          msg << ", #{message}" if message
+          msg
+        end
+
+        def run_with_timer(timeout, interval, &block)
+          if timeout.zero?
+            block.call # rubocop:disable Performance/RedundantBlockCall
+          else
+            Timer.wait timeout do
+              block.call # rubocop:disable Performance/RedundantBlockCall
+              sleep interval
+            end
+          end
+        end
+      end # self
+    end # module Wait
+
+    module Waitable
+      # Check every interval seconds to see if yield returns a truthy value.
+      # Note this isn't a strict boolean true, any truthy value is accepted.
+      # false and nil are considered failures.
+      # Give up after timeout seconds.
+      #
+      # If only a number is provided then it's treated as the timeout value.
+      #
+      # @param [Integer] timeout: Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
+      # @param [Integer] interval: Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+      # @param [String] message: Exception message if timed out.
+      # @param [Array, Exception] ignored: Exceptions to ignore while polling (default: Exception)
+      #
+      # @example
+      #
+      #   @core.wait_true { @driver.find_element :accessibility_id, 'something' }
+      #
+      def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)
+        Wait.until_true(timeout: timeout || @wait_timeout,
+                        interval: interval || @wait_interval,
+                        message: message,
+                        ignored: ignored,
+                        object: self) { yield }
+      end
+
+      # Check every interval seconds to see if yield doesn't raise an exception.
+      # Give up after timeout seconds.
+      #
+      # If only a number is provided then it's treated as the timeout value.
+      #
+      # @param [Integer] timeout: Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
+      # @param [Integer] interval: Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
+      # @param [String] message: Exception message if timed out.
+      # @param [Array, Exception] ignored: Exceptions to ignore while polling (default: Exception)
+      #
+      # @example
+      #
+      #   @core.wait { @driver.find_element :accessibility_id, 'something' }
+      #
+      def wait(timeout: nil, interval: nil, message: nil, ignored: nil)
+        Wait.until(timeout: timeout || @wait_timeout,
+                   interval: interval || @wait_interval,
+                   message: message,
+                   ignored: ignored,
+                   object: self) { yield }
+      end
+    end
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/common/wait/timer.rb

@@ -0,0 +1,30 @@
+module Appium
+  module Core
+    module Wait
+      module Timer
+        class << self
+          # @private
+          def wait(timeout, &block)
+            end_time = current_time + timeout
+            loop do
+              yield(block)
+              break if current_time > end_time
+            end
+          end
+
+          private
+
+          if defined?(Process::CLOCK_MONOTONIC)
+            def current_time
+              Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            end
+          else
+            def current_time
+              ::Time.now.to_f
+            end
+          end
+        end
+      end # module Timer
+    end # module Wait
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/{common/device.rb → device.rb}

@@ -1,3 +1,10 @@
+require_relative 'device/touch_actions'
+require_relative 'device/multi_touch'
+require_relative 'device/screen_record'
+require_relative 'device/app_state'
+require_relative 'device/clipboard_content_type'
+require_relative 'device/image_comparison'
+
 require 'base64'
 
 module Appium
@@ -513,6 +520,7 @@ module Appium
           add_app_management
           add_device_lock
           add_file_management
+          Core::Device::ImageComparison.extended
         end
 
         # def extended
@@ -522,7 +530,6 @@ module Appium
           block_given? ? create_bridge_command(method, &Proc.new) : create_bridge_command(method)
 
           delegate_driver_method method
-          delegate_from_appium_driver method
         end
 
         # @private CoreBridge
@@ -539,11 +546,6 @@ module Appium
           ::Appium::Core::Base::Driver.class_eval { def_delegator :@bridge, method }
         end
 
-        # @private
-        def delegate_from_appium_driver(method, delegation_target = :driver)
-          def_delegator delegation_target, method
-        end
-
         # @private
         def create_bridge_command(method)
           ::Appium::Core::Base::Bridge::MJSONWP.class_eval do

data/lib/appium_lib_core/device/image_comparison.rb

@@ -0,0 +1,178 @@
+require 'base64'
+
+module Appium
+  module Core
+    module Device
+      module ImageComparison
+        extend Forwardable
+
+        MODE = [:matchFeatures, :getSimilarity, :matchTemplate].freeze
+
+        MATCH_FEATURES = {
+          detector_name: %w(AKAZE AGAST BRISK FAST GFTT KAZE MSER SIFT ORB),
+          match_func: %w(FlannBased BruteForce BruteForceL1 BruteForceHamming BruteForceHammingLut BruteForceSL2),
+          goodMatchesFactor: nil, # Integer
+          visualize: [true, false]
+        }.freeze
+
+        MATCH_TEMPLATE = {
+          visualize: [true, false]
+        }.freeze
+
+        GET_SIMILARITY = {
+          visualize: [true, false]
+        }.freeze
+
+        # @!method match_images_features(first_image:, second_image:, detector_name: 'ORB',
+        #                                match_func: 'BruteForce', good_matches_factor: 100, visualize: false)
+        # Performs images matching by features with default options. Read https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_feature2d/py_matcher/py_matcher.html
+        # for more details on this topic.
+        #
+        # @param [String] first_image An image data. All image formats, that OpenCV library itself accepts, are supported.
+        # @param [String] second_image An image data. All image formats, that OpenCV library itself accepts, are supported.
+        # @param [String] detector_name Sets the detector name for features matching
+        #                               algorithm. Some of these detectors (FAST, AGAST, GFTT, FAST, SIFT and MSER) are
+        #                               not available in the default OpenCV installation and have to be enabled manually
+        #                               before library compilation. The default detector name is 'ORB'.
+        # @param [String] match_func The name of the matching function. The default one is 'BruteForce'.
+        # @param [String] good_matches_factor The maximum count of "good" matches (e. g. with minimal distances).
+        #                                     The default one is nil.
+        # @param [Bool] visualise Makes the endpoint to return an image, which contains the visualized result of
+        #               the corresponding picture matching operation. This option is disabled by default.
+        #
+        # @example
+        #     @driver.match_images_features first_image: "image data 1", second_image: "image data 2"
+        #
+        #     visual = @@driver.match_images_features first_image: image1, second_image: image2, visualize: true
+        #     File.write 'match_images_visual.png', Base64.decode64(visual['visualization']) # if the image is PNG
+        #
+
+        # @!method find_image_occurrence(full_image:, partial_image:, detector_name: 'ORB', visualize: false)
+        # Performs images matching by template to find possible occurrence of the partial image
+        # in the full image with default options. Read https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html
+        # for more details on this topic.
+        #
+        # @param [String] full_image: A full image data.
+        # @param [String] partial_image: A partial image data. All image formats, that OpenCV library itself accepts,
+        #                                are supported.
+        # @param [Bool] visualise: Makes the endpoint to return an image, which contains the visualized result of
+        #               the corresponding picture matching operation. This option is disabled by default.
+        #
+        # @example
+        #     @driver.find_image_occurrence full_image: "image data 1", partial_image: "image data 2"
+        #
+        #     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
+        #
+
+        # @!method get_images_similarity(first_image:, second_image:, detector_name: 'ORB', visualize: false)
+        # Performs images matching to calculate the similarity score between them
+        # with default options. The flow there is similar to the one used in `find_image_occurrence`
+        # but it is mandatory that both images are of equal size.
+        #
+        # @param [String] first_image: An image data. All image formats, that OpenCV library itself accepts, are supported.
+        # @param [String] second_image: An image data. All image formats, that OpenCV library itself accepts, are supported.
+        # @param [Bool] visualise: Makes the endpoint to return an image, which contains the visualized result of
+        #               the corresponding picture matching operation. This option is disabled by default.
+        #
+        # @example
+        #     @driver.get_images_similarity first_image: "image data 1", second_image: "image data 2"
+        #
+        #     visual = @@driver.get_images_similarity first_image: image1, second_image: image2, visualize: true
+        #     File.write 'images_similarity_visual.png', Base64.decode64(visual['visualization']) # if the image is PNG
+        #
+
+        # @!method compare_images(mode:, first_image:, second_image:, options:)
+        #
+        # Performs images comparison using OpenCV framework features.
+        # It is expected that both OpenCV framework and opencv4nodejs
+        # module are installed on the machine where Appium server is running.
+        #
+        # @param [Symbol] mode: One of possible comparison modes: `:matchFeatures`, `:getSimilarity`, `:matchTemplate`.
+        #                       `:matchFeatures is by default.
+        # @param [String] first_image: An image data. All image formats, that OpenCV library itself accepts, are supported.
+        # @param [String] second_image: An image data. All image formats, that OpenCV library itself accepts, are supported.
+        # @param [Hash] options: The content of this dictionary depends on the actual `mode` value.
+        #               See the documentation on `appium-support` module for more details.
+        # @returns [Hash] The content of the resulting dictionary depends on the actual `mode` and `options` values.
+        #                 See the documentation on `appium-support` module for more details.
+        #
+
+        ####
+        ## class << self
+        ####
+
+        def self.extended
+          ::Appium::Core::Device.add_endpoint_method(:match_images_features) do
+            def match_images_features(first_image:, # rubocop:disable Metrics/ParameterLists
+                                      second_image:,
+                                      detector_name: 'ORB',
+                                      match_func: 'BruteForce',
+                                      good_matches_factor: nil,
+                                      visualize: false)
+              unless ::Appium::Core::Device::ImageComparison::MATCH_FEATURES[:detector_name].member?(detector_name.to_s)
+                raise "detector_name should be #{::Appium::Core::Device::ImageComparison::MATCH_FEATURES[:detector_name]}"
+              end
+              unless ::Appium::Core::Device::ImageComparison::MATCH_FEATURES[:match_func].member?(match_func.to_s)
+                raise "match_func should be #{::Appium::Core::Device::ImageComparison::MATCH_FEATURES[:match_func]}"
+              end
+              unless ::Appium::Core::Device::ImageComparison::MATCH_FEATURES[:visualize].member?(visualize)
+                raise "visualize should be #{::Appium::Core::Device::ImageComparison::MATCH_FEATURES[:visualize]}"
+              end
+
+              options = {}
+              options[:detectorName] = detector_name.to_s.upcase
+              options[:matchFunc] = match_func.to_s
+              options[:goodMatchesFactor] = good_matches_factor.to_i unless good_matches_factor.nil?
+              options[:visualize] = visualize
+
+              compare_images(mode: :matchFeatures, first_image: first_image, second_image: second_image, options: options)
+            end
+          end
+
+          ::Appium::Core::Device.add_endpoint_method(:find_image_occurrence) do
+            def find_image_occurrence(full_image:, partial_image:, visualize: false)
+              unless ::Appium::Core::Device::ImageComparison::MATCH_TEMPLATE[:visualize].member?(visualize)
+                raise "visualize should be #{::Appium::Core::Device::ImageComparison::MATCH_TEMPLATE[:visualize]}"
+              end
+
+              options = {}
+              options[:visualize] = visualize
+
+              compare_images(mode: :matchTemplate, first_image: full_image, second_image: partial_image, options: options)
+            end
+          end
+
+          ::Appium::Core::Device.add_endpoint_method(:get_images_similarity) do
+            def get_images_similarity(first_image:, second_image:, visualize: false)
+              unless ::Appium::Core::Device::ImageComparison::GET_SIMILARITY[:visualize].member?(visualize)
+                raise "visualize should be #{::Appium::Core::Device::ImageComparison::GET_SIMILARITY[:visualize]}"
+              end
+
+              options = {}
+              options[:visualize] = visualize
+
+              compare_images(mode: :getSimilarity, first_image: first_image, second_image: second_image, options: options)
+            end
+          end
+
+          ::Appium::Core::Device.add_endpoint_method(:compare_images) do
+            def compare_images(mode: :matchFeatures, first_image:, second_image:, options: nil)
+              unless ::Appium::Core::Device::ImageComparison::MODE.member?(mode)
+                raise "content_type should be #{::Appium::Core::Device::ImageComparison::MODE}"
+              end
+
+              params = {}
+              params[:mode] = mode
+              params[:firstImage] = Base64.encode64 first_image
+              params[:secondImage] = Base64.encode64 second_image
+              params[:options] = options if options
+
+              execute(:compare_images, {}, params)
+            end
+          end
+        end # self
+      end # module ImageComparison
+    end # module Device
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/driver.rb

@@ -1,6 +1,7 @@
 module Appium
   module Core
     class Driver
+      include Waitable
       # Selenium webdriver capabilities
       # @return [Core::Base::Capabilities]
       attr_reader :caps
@@ -278,73 +279,8 @@ module Appium
         @driver.save_screenshot png_save_path
       end
 
-      # Check every interval seconds to see if yield returns a truthy value.
-      # Note this isn't a strict boolean true, any truthy value is accepted.
-      # false and nil are considered failures.
-      # Give up after timeout seconds.
-      #
-      # Wait code from the selenium Ruby gem
-      # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
-      #
-      # If only a number is provided then it's treated as the timeout value.
-      #
-      # @param [Hash] opts Options
-      # @option opts [Numeric] :timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
-      # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
-      # @option opts [String] :message Exception message if timed out.
-      # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
-      #
-      # @example
-      #
-      #   @core.wait_true { @driver.find_element :accessibility_id, 'something' }
-      #
-      def wait_true(opts = {})
-        opts = process_wait_opts(opts).merge(return_if_true: true)
-
-        opts[:timeout]  ||= @wait_timeout
-        opts[:interval] ||= @wait_interval
-
-        wait = ::Appium::Core::Base::Wait.new opts
-        wait.until { yield }
-      end
-
-      # Check every interval seconds to see if yield doesn't raise an exception.
-      # Give up after timeout seconds.
-      #
-      # Wait code from the selenium Ruby gem
-      # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
-      #
-      # If only a number is provided then it's treated as the timeout value.
-      #
-      # @param [Hash] opts Options
-      # @option opts [Numeric] :timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
-      # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
-      # @option opts [String] :message Exception message if timed out.
-      # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
-      #
-      # @example
-      #
-      #   @core.wait { @driver.find_element :accessibility_id, 'something' }
-      #
-      def wait(opts = {})
-        opts = process_wait_opts(opts).merge(return_if_true: false)
-
-        opts[:timeout] ||= @wait_timeout
-        opts[:interval] ||= @wait_interval
-
-        wait = ::Appium::Core::Base::Wait.new opts
-        wait.until { yield }
-      end
-
       private
 
-      # @private
-      def process_wait_opts(opts)
-        opts = { timeout: opts } if opts.is_a?(Numeric)
-        raise 'opts must be a hash' unless opts.is_a? Hash
-        opts
-      end
-
       # @private
       def extend_for(device:, automation_name:, target:)
         target.extend Appium::Core
@@ -432,8 +368,8 @@ module Appium
         @port = appium_lib_opts.fetch :port, DEFAULT_APPIUM_PORT
 
         # timeout and interval used in ::Appium::Comm.wait/wait_true
-        @wait_timeout  = appium_lib_opts.fetch :wait_timeout, 30
-        @wait_interval = appium_lib_opts.fetch :wait_interval, 0.5
+        @wait_timeout  = appium_lib_opts.fetch :wait_timeout, ::Appium::Core::Wait::DEFAULT_TIMEOUT
+        @wait_interval = appium_lib_opts.fetch :wait_interval, ::Appium::Core::Wait::DEFAULT_INTERVAL
 
         # to pass it in Selenium.new.
         # `listener = opts.delete(:listener)` is called in Selenium::Driver.new
@@ -467,7 +403,7 @@ module Appium
 
       # @private
       def write_session_id(session_id, export_path = '/tmp/appium_lib_session')
-        File.open(export_path, 'w') { |f| f.puts session_id }
+        File.write(export_path, session_id)
       rescue IOError => e
         ::Appium::Logger.warn e
         nil

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.4.0'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-04-15'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.4.1'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-04-22'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,12 @@
+#### v1.4.1 2018-04-22
+
+- [afb5d33](https://github.com/appium/ruby_lib_core/commit/afb5d334a786a12bd407848312ddd35c8c9ad308) Release 1.4.1
+- [7fd0ccc](https://github.com/appium/ruby_lib_core/commit/7fd0ccca947e742f03ac41022d0670bf809d3969) add base image comparison (#80)
+- [0b10980](https://github.com/appium/ruby_lib_core/commit/0b10980cbbb48cfba0352fa0ef4e15b2fd16d086) split timer loop from wait
+- [009f679](https://github.com/appium/ruby_lib_core/commit/009f679c08fd4c019b4876454d758ef5cf30daae) Refactor commands (#79)
+- [4b1c086](https://github.com/appium/ruby_lib_core/commit/4b1c0868c6258106faae24978be324b79785fc5b) Extract wait (#78)
+
+
 #### v1.4.0 2018-04-15
 
 - [5cc89aa](https://github.com/appium/ruby_lib_core/commit/5cc89aa4a9533e174527db5b805b96cf2b45a9ac) Release 1.4.0

data/script/commands.rb

@@ -16,8 +16,8 @@ module Script
     # - webdriver_w3c_commands: ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS
     #
     def initialize
-      @implemented_mjsonwp_commands = convert_driver_commands Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP
-      @implemented_w3c_commands = convert_driver_commands Appium::Core::Commands::COMMANDS_EXTEND_W3C
+      @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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-15 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -247,22 +233,27 @@ 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/msjsonwp.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/http_default.rb
 - lib/appium_lib_core/common/base/search_context.rb
-- lib/appium_lib_core/common/base/wait.rb
 - lib/appium_lib_core/common/command.rb
-- lib/appium_lib_core/common/device.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/error.rb
 - lib/appium_lib_core/common/log.rb
 - lib/appium_lib_core/common/logger.rb
+- lib/appium_lib_core/common/wait.rb
+- lib/appium_lib_core/common/wait/timer.rb
 - lib/appium_lib_core/common/ws/websocket.rb
+- lib/appium_lib_core/device.rb
 - lib/appium_lib_core/device/app_state.rb
 - lib/appium_lib_core/device/clipboard_content_type.rb
+- lib/appium_lib_core/device/image_comparison.rb
 - lib/appium_lib_core/device/multi_touch.rb
 - lib/appium_lib_core/device/screen_record.rb
 - lib/appium_lib_core/device/touch_actions.rb

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

@@ -1,56 +0,0 @@
-# rubocop:disable Lint/HandleExceptions
-module Appium
-  module Core
-    class Base
-      class Wait < ::Selenium::WebDriver::Wait
-        require 'timeout' # for wait
-
-        def initialize(opts = {})
-          valid_keys = %i(timeout interval message ignore return_if_true)
-          invalid_keys = []
-          opts.each_key { |key| invalid_keys << key unless valid_keys.include?(key) }
-          # [:one, :two] => :one, :two
-          unless invalid_keys.empty?
-            raise "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}"
-          end
-
-          @timeout        = opts.fetch(:timeout, DEFAULT_TIMEOUT)
-          @interval       = opts.fetch(:interval, DEFAULT_INTERVAL)
-          @message        = opts[:message]
-          @ignored        = Array(opts[:ignore] || ::Exception)
-          @return_if_true = opts[:return_if_true]
-
-          super(timeout: @timeout, interval: @interval, message: @message, ignore: @ignored)
-        end
-
-        # Wait code from the selenium Ruby gem
-        # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
-        def until
-          end_time   = Time.now + @timeout
-          last_error = nil
-
-          until Time.now > end_time
-            begin
-              return yield unless @return_if_true
-
-              result = yield
-              return result if result
-            rescue ::Errno::ECONNREFUSED => e
-              raise e
-            rescue *@ignored => last_error
-              # swallowed
-            end
-
-            sleep @interval
-          end
-
-          msg = @message ? @message.dup : "timed out after #{@timeout} seconds"
-
-          msg << " (#{last_error.message})" if last_error
-
-          raise Selenium::WebDriver::Error::TimeOutError, msg
-        end
-      end # module Wait
-    end # module Base
-  end # module Core
-end # module Appium