appium_lib_core 1.7.2 → 1.8.0

data/lib/appium_lib_core/device/device_lock.rb

@@ -1,28 +0,0 @@
-module Appium
-  module Core
-    module Device
-      module DeviceLock
-        def self.add_methods
-          ::Appium::Core::Device.add_endpoint_method(:lock) do
-            def lock(duration = nil)
-              opts = duration ? { seconds: duration } : {}
-              execute :lock, {}, opts
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:device_locked?) do
-            def device_locked?
-              execute :device_locked?
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:unlock) do
-            def unlock
-              execute :unlock
-            end
-          end
-        end
-      end # module DeviceLock
-    end # module Device
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/device/file_management.rb

@@ -1,32 +0,0 @@
-require 'base64'
-
-module Appium
-  module Core
-    module Device
-      module FileManagement
-        def self.add_methods
-          ::Appium::Core::Device.add_endpoint_method(:push_file) do
-            def push_file(path, filedata)
-              encoded_data = Base64.encode64 filedata
-              execute :push_file, {}, path: path, data: encoded_data
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:pull_file) do
-            def pull_file(path)
-              data = execute :pull_file, {}, path: path
-              Base64.decode64 data
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:pull_folder) do
-            def pull_folder(path)
-              data = execute :pull_folder, {}, path: path
-              Base64.decode64 data
-            end
-          end
-        end
-      end # module FileManagement
-    end # module Device
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/device/image_comparison.rb

@@ -1,178 +0,0 @@
-require 'base64'
-
-module Appium
-  module Core
-    module Device
-      module ImageComparison
-        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:, visualize: false, threshold: nil)
-        # 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.
-        # @param [Float] threshold: [0.5] At what normalized threshold to reject
-        #
-        # @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.add_methods
-          ::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, threshold: nil)
-              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
-              options[:threshold] = threshold unless threshold.nil?
-
-              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/device/ime_actions.rb

@@ -1,43 +0,0 @@
-module Appium
-  module Core
-    module Device
-      module ImeActions
-        def self.add_methods
-          ::Appium::Core::Device.add_endpoint_method(:ime_activate) do
-            def ime_activate(ime_name)
-              # from Selenium::WebDriver::Remote::OSS
-              execute :ime_activate_engine, {}, engine: ime_name
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:ime_available_engines) do
-            def ime_available_engines
-              execute :ime_get_available_engines
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:ime_active_engine) do
-            # from Selenium::WebDriver::Remote::OSS
-            def ime_active_engine
-              execute :ime_get_active_engine
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:ime_activated) do
-            # from Selenium::WebDriver::Remote::OSS
-            def ime_activated
-              execute :ime_is_activated
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:ime_deactivate) do
-            # from Selenium::WebDriver::Remote::OSS
-            def ime_deactivate
-              execute :ime_deactivate, {}
-            end
-          end
-        end
-      end # module ImeActions
-    end # module Device
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/device/keyboard.rb

@@ -1,26 +0,0 @@
-module Appium
-  module Core
-    module Device
-      module Keyboard
-        def self.add_methods
-          ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
-            def hide_keyboard(close_key = nil, strategy = nil)
-              option = {}
-
-              option[:key] = close_key || 'Done'        # default to Done key.
-              option[:strategy] = strategy || :pressKey # default to pressKey
-
-              execute :hide_keyboard, {}, option
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:is_keyboard_shown) do
-            def is_keyboard_shown # rubocop:disable Naming/PredicateName for compatibility
-              execute :is_keyboard_shown
-            end
-          end
-        end
-      end # module Keyboard
-    end # module Device
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/device/keyevent.rb

@@ -1,44 +0,0 @@
-module Appium
-  module Core
-    module Device
-      module KeyEvent
-        def self.add_methods
-          # Only for Selendroid
-          ::Appium::Core::Device.add_endpoint_method(:keyevent) do
-            def keyevent(key, metastate = nil)
-              args             = { keycode: key }
-              args[:metastate] = metastate if metastate
-              execute :keyevent, {}, args
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:press_keycode) do
-            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
-
-              args             = { keycode: key }
-              args[:metastate] = metastate.reduce(0) { |acc, meta| acc | meta } unless metastate.empty?
-              args[:flags]     = flags.reduce(0) { |acc, flag| acc | flag } unless flags.empty?
-
-              execute :press_keycode, {}, args
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:long_press_keycode) do
-            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
-
-              args             = { keycode: key }
-              args[:metastate] = metastate.reduce(0) { |acc, meta| acc | meta } unless metastate.empty?
-              args[:flags]     = flags.reduce(0) { |acc, flag| acc | flag } unless flags.empty?
-
-              execute :long_press_keycode, {}, args
-            end
-          end
-        end
-      end # module KeyEvent
-    end # module Device
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/device/screen_record.rb

@@ -1,56 +0,0 @@
-module Appium
-  module Core
-    module Device
-      class ScreenRecord
-        #
-        # @api private
-        #
-
-        attr_reader :upload_option
-
-        METHOD = %w(POST PUT).freeze
-
-        def self.add_methods
-          ::Appium::Core::Device.add_endpoint_method(:stop_recording_screen) do
-            def stop_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT')
-              option = ::Appium::Core::Device::ScreenRecord.new(
-                remote_path: remote_path, user: user, pass: pass, method: method
-              ).upload_option
-
-              params = option.empty? ? {} : { options: option }
-
-              execute(:stop_recording_screen, {}, params)
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:stop_and_save_recording_screen) do
-            def stop_and_save_recording_screen(file_path)
-              base64data = execute(:stop_recording_screen, {}, {})
-              File.open(file_path, 'wb') { |f| f << Base64.decode64(base64data) }
-            end
-          end
-        end
-
-        def initialize(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil)
-          @upload_option = if remote_path.nil?
-                             {}
-                           else
-                             raise 'method should be POST or PUT' unless METHOD.member?(method.to_s.upcase)
-
-                             option = {}
-                             option[:remotePath] = remote_path
-                             option[:user] = user unless user.nil?
-                             option[:pass] = pass unless pass.nil?
-                             option[:method] = method
-                             option
-                           end
-
-          return if force_restart.nil?
-
-          raise 'force_restart should be true or false' unless [true, false].member?(force_restart)
-          @upload_option[:forceRestart] = force_restart
-        end
-      end
-    end
-  end
-end

data/lib/appium_lib_core/device/setting.rb

@@ -1,21 +0,0 @@
-module Appium
-  module Core
-    module Device
-      module Setting
-        def self.add_methods
-          ::Appium::Core::Device.add_endpoint_method(:get_settings) do
-            def get_settings
-              execute :get_settings, {}
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:update_settings) do
-            def update_settings(settings)
-              execute :update_settings, {}, settings: settings
-            end
-          end
-        end
-      end # module Setting
-    end # module Device
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/device/touch_actions.rb

@@ -1,22 +0,0 @@
-module Appium
-  module Core
-    module Device
-      module TouchActions
-        def self.add_methods
-          ::Appium::Core::Device.add_endpoint_method(:touch_actions) do
-            def touch_actions(actions)
-              actions = { actions: [actions].flatten }
-              execute :touch_actions, {}, actions
-            end
-          end
-
-          ::Appium::Core::Device.add_endpoint_method(:multi_touch) do
-            def multi_touch(actions)
-              execute :multi_touch, {}, actions: actions
-            end
-          end
-        end
-      end # module TouchActions
-    end # module Device
-  end # module Core
-end # module Appium