appium_lib_core 4.1.0 → 9.2.1

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

@@ -47,7 +47,7 @@ module Appium
           #                               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).
+          # @param [String, nil] good_matches_factor The maximum count of "good" matches (e. g. with minimal distances).
           #                                     The default one is nil.
           # @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.
@@ -65,14 +65,17 @@ module Appium
                                     good_matches_factor: nil,
                                     visualize: false)
             unless MATCH_FEATURES[:detector_name].member?(detector_name.to_s)
-              raise "detector_name should be #{MATCH_FEATURES[:detector_name]}"
+              raise ::Appium::Core::Error::ArgumentError, "detector_name should be #{MATCH_FEATURES[:detector_name]}"
             end
 
             unless MATCH_FEATURES[:match_func].member?(match_func.to_s)
-              raise "match_func should be #{MATCH_FEATURES[:match_func]}"
+              raise ::Appium::Core::Error::ArgumentError, "match_func should be #{MATCH_FEATURES[:match_func]}"
             end
 
-            raise "visualize should be #{MATCH_FEATURES[:visualize]}" unless MATCH_FEATURES[:visualize].member?(visualize)
+            unless MATCH_FEATURES[:visualize].member?(visualize)
+              raise ::Appium::Core::Error::ArgumentError,
+                    "visualize should be #{MATCH_FEATURES[:visualize]}"
+            end
 
             options = {}
             options[:detectorName] = detector_name.to_s.upcase
@@ -94,7 +97,12 @@ module Appium
           #                                are supported.
           # @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] threshold [0.5] At what normalized threshold to reject
+          # @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 +110,18 @@ 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)
-            raise "visualize should be #{MATCH_TEMPLATE[:visualize]}" unless MATCH_TEMPLATE[:visualize].member?(visualize)
+          def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil,
+                                    multiple: nil, match_neighbour_threshold: nil)
+            unless MATCH_TEMPLATE[:visualize].member?(visualize)
+              raise ::Appium::Core::Error::ArgumentError,
+                    "visualize should be #{MATCH_TEMPLATE[:visualize]}"
+            end
 
             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
@@ -128,7 +142,10 @@ module Appium
           #     File.write 'images_similarity_visual.png', Base64.decode64(visual['visualization']) # if the image is PNG
           #
           def get_images_similarity(first_image:, second_image:, visualize: false)
-            raise "visualize should be #{GET_SIMILARITY[:visualize]}" unless GET_SIMILARITY[:visualize].member?(visualize)
+            unless GET_SIMILARITY[:visualize].member?(visualize)
+              raise ::Appium::Core::Error::ArgumentError,
+                    "visualize should be #{GET_SIMILARITY[:visualize]}"
+            end
 
             options = {}
             options[:visualize] = visualize
@@ -144,13 +161,13 @@ module Appium
           #                      +: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.
+          # @param [Hash, nil] options The content of this dictionary depends on the actual +mode+ value.
           #                       See the documentation on +appium-support+ module for more details.
           # @return [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.
           #
           def compare_images(mode: :matchFeatures, first_image:, second_image:, options: nil)
-            raise "content_type should be #{MODE}" unless MODE.member?(mode)
+            raise ::Appium::Core::Error::ArgumentError, "content_type should be #{MODE}" unless MODE.member?(mode)
 
             params = {}
             params[:mode] = mode

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

@@ -25,8 +25,8 @@ module Appium
           end
 
           def press_keycode(key, metastate: [], flags: [])
-            raise ArgumentError, 'flags should be Array' unless flags.is_a? Array
-            raise ArgumentError, 'metastates should be Array' unless metastate.is_a? Array
+            raise ::Appium::Core::Error::ArgumentError, 'flags should be Array' unless flags.is_a? Array
+            raise ::Appium::Core::Error::ArgumentError, 'metastates should be Array' unless metastate.is_a? Array
 
             args             = { keycode: key }
             args[:metastate] = metastate.reduce(0) { |acc, meta| acc | meta } unless metastate.empty?
@@ -36,8 +36,8 @@ module Appium
           end
 
           def long_press_keycode(key, metastate: [], flags: [])
-            raise ArgumentError, 'flags should be Array' unless flags.is_a? Array
-            raise ArgumentError, 'metastates should be Array' unless metastate.is_a? Array
+            raise ::Appium::Core::Error::ArgumentError, 'flags should be Array' unless flags.is_a? Array
+            raise ::Appium::Core::Error::ArgumentError, 'metastates should be Array' unless metastate.is_a? Array
 
             args             = { keycode: key }
             args[:metastate] = metastate.reduce(0) { |acc, meta| acc | meta } unless metastate.empty?

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

@@ -12,23 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../touch_action/touch_actions'
-require_relative '../touch_action/multi_touch'
-
 module Appium
   module Core
     class Base
       module Device
-        module TouchActions
-          def touch_actions(actions)
-            actions = { actions: [actions].flatten }
-            execute :touch_actions, {}, actions
+        module Orientation
+          def screen_orientation=(orientation)
+            execute :set_screen_orientation, {}, { orientation: orientation }
           end
 
-          def multi_touch(actions)
-            execute :multi_touch, {}, actions: actions
+          def screen_orientation
+            execute :get_screen_orientation
           end
-        end # module TouchActions
+        end # module Orientation
       end # module Device
     end # class Base
   end # module Core

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

@@ -30,7 +30,10 @@ module Appium
             @upload_option = if remote_path.nil?
                                {}
                              else
-                               raise 'method should be POST or PUT' unless METHOD.member?(method.to_s.upcase)
+                               unless METHOD.member?(method.to_s.upcase)
+                                 raise ::Appium::Core::Error::ArgumentError,
+                                       'method should be POST or PUT'
+                               end
 
                                option = {}
                                option[:remotePath] = remote_path
@@ -45,7 +48,10 @@ module Appium
 
             return if force_restart.nil?
 
-            raise 'force_restart should be true or false' unless [true, false].member?(force_restart)
+            unless [true, false].member?(force_restart)
+              raise ::Appium::Core::Error::ArgumentError,
+                    'force_restart should be true or false'
+            end
 
             @upload_option[:forceRestart] = force_restart
           end

data/lib/appium_lib_core/common/error.rb

@@ -17,18 +17,18 @@ module Appium
     module Error
       class CoreError < StandardError; end
 
-      # Capability related errors
-      class NoCapabilityError < CoreError; end
-      class CapabilityStructureError < CoreError; end
-
       # Appium related errors
       class NotSupportedAppiumServer < CoreError; end
       class NoSuchElementError < CoreError; end
 
       class UnsupportedOperationError < CoreError; end
 
-      # Server side error
+      # Server side errors
       class ServerError < CoreError; end
+
+      # ruby_lib_core library specific errors
+      class SessionNotCreatedError < CoreError; end
+      class ArgumentError < CoreError; end
     end
   end
 end

data/lib/appium_lib_core/common/log.rb

@@ -44,8 +44,7 @@ module Appium
 
       # @since Appium 1.16.0
       #
-      # Logs a custom event. The event is available via {::Appium::Core::Events#get} or
-      # <code>@driver.session_capabilities['events']</code> with <code>eventTimings</code> capabilities.
+      # Logs a custom event. The event is available via {::Appium::Core::Events#get}.
       #
       # @param [String] vendor The vendor prefix for the event
       # @param [String] event The name of event
@@ -54,7 +53,6 @@ module Appium
       # @example
       #
       #   @driver.logs.event vendor: 'appium', event: 'funEvent'
-      #   @driver.session_capabilities['events'] #=> {...., 'appium:funEvent' => 1572957315}
       #
       #   @driver.logs.event = { vendor: 'appium', event: 'anotherEvent' }
       #   @driver.logs.events #=> {...., 'appium:funEvent' => [1572957315, 1572960305],
@@ -65,7 +63,10 @@ module Appium
       end
 
       def event=(log_event)
-        raise ArgumentError('log_event should be Hash like { vendor: "appium", event: "funEvent"}') unless log_event.is_a?(Hash)
+        unless log_event.is_a?(Hash)
+          raise ::Appium::Core::Error::ArgumentError,
+                'log_event should be Hash like { vendor: "appium", event: "funEvent"}'
+        end
 
         event vendor: log_event[:vendor], event: log_event[:event]
       end

data/lib/appium_lib_core/common/wait.rb

@@ -38,6 +38,8 @@ module Appium
         #
         #     result = Appium::Core::Wait.until { @driver.find_element(:id, 'something') }
         #
+        #     result = Appium::Core::Wait.until(timeout: 30, message: 'timeout') { @driver.find_element(:id, 'something') }
+        #
         #     result = Appium::Core::Wait.until(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -82,6 +84,8 @@ module Appium
         #
         #     Appium::Core::Wait.until_true { @driver.find_element(:id, 'something') }
         #
+        #     Appium::Core::Wait.until_true(timeout: 30) { @driver.find_element(:id, 'something') }
+        #
         #     Appium::Core::Wait.until_true(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -133,17 +137,31 @@ module Appium
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #
-      # @example
+      # @example With core instance
       #
       #   @core.wait_true { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @core.wait_until_true { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_until_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      # @example With driver instance
+      #
+      #   @driver.wait_true { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_true(timeout: 30, interval: 2) { |d| driver.find_element :accessibility_id, 'something' }
       #
-      def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)
+      #   @driver.wait_until_true { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_until_true(timeout: 30, interval: 2) { |d| driver.find_element :accessibility_id, 'something' }
+      #
+      def wait_until_true(timeout: nil, interval: nil, message: nil, ignored: nil, &block)
         Wait.until_true(timeout: timeout || @wait_timeout,
                         interval: interval || @wait_interval,
                         message: message,
                         ignored: ignored,
-                        object: self) { yield }
+                        object: self,
+                        &block)
       end
+      alias wait_true wait_until_true
 
       # Check every interval seconds to see if yield doesn't raise an exception.
       # Give up after timeout seconds.
@@ -155,17 +173,31 @@ module Appium
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #
-      # @example
+      # @example With core instance
       #
       #   @core.wait { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @core.wait_until { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_until(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      # @example With driver instance
+      #
+      #   @driver.wait { @driver.find_element :accessibility_id, 'something' }
+      #   @driver.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @driver.wait_until { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_until(timeout: 30, interval: 2) { |d| d.find_element :accessibility_id, 'something' }
       #
-      def wait(timeout: nil, interval: nil, message: nil, ignored: nil)
+      def wait_until(timeout: nil, interval: nil, message: nil, ignored: nil, &block)
         Wait.until(timeout: timeout || @wait_timeout,
                    interval: interval || @wait_interval,
                    message: message,
                    ignored: ignored,
-                   object: self) { yield }
+                   object: self,
+                   &block)
       end
+      alias wait wait_until
     end
   end # module Core
 end # module Appium

data/lib/appium_lib_core/device.rb

@@ -29,17 +29,15 @@ module Appium
             :hide_keyboard, :is_keyboard_shown,
             :ime_activate, :ime_available_engines, :ime_active_engine, :ime_activated, :ime_deactivate,
             :get_settings, :update_settings,
-            :within_context, :switch_to_default_context, :current_context, :available_contexts, :set_context,
-            :set_immediate_value, :replace_value,
+            :within_context, :current_context, :available_contexts, :set_context,
             :push_file, :pull_file, :pull_folder,
             :keyevent, :press_keycode, :long_press_keycode,
             :match_images_features, :find_image_occurrence, :get_images_similarity, :compare_images,
-            :launch_app, :close_app, :reset, :app_strings, :background_app,
+            :app_strings, :background_app,
             :install_app, :remove_app, :app_installed?, :activate_app, :terminate_app,
             :app_state,
             :stop_recording_screen, :stop_and_save_recording_screen,
             :shake, :device_time,
-            :touch_actions, :multi_touch,
             :execute_driver, :execute_cdp
           ].each(&method(:delegate_from_appium_driver))
         end
@@ -79,11 +77,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