appium_lib_core 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4396bf8502f02909fc45492b5f205554cd367f2
-  data.tar.gz: ece56ca4022cef888da977917121a403df721b47
+  metadata.gz: '0973ef5a6046f3de9ee41ce9fc1d4d3d66529335'
+  data.tar.gz: e26a62a0620e8e79a493b47e972dc6d13c3e7cfb
 SHA512:
-  metadata.gz: 261082f3a1f085f18d549ad837d0b93dac630886ddcd24e4c40420744efac7f9ef0490ab94c32d171ba58816cb2607bd476988513a558435723eb7448ed212cc
-  data.tar.gz: f46ec6897d884275faa9260ef48c550c479e5173986e9464035e03d7af50e29ea576b97d2e33560e55ef0422c27990e5cb8b61dfe9d5761674ce3fd99cfbba51
+  metadata.gz: 067eda5fda5a52d0d3f3197b3228172d38144a5b9a92e8672fd0f2297eebb7d7f8469e3880e83870421c2b420956979c2e48e99d2d2b5c3f78b06eb48d539f42
+  data.tar.gz: bd9e058c3c294a68b575ae5732db43c743a17f9e79e05d878d9e4128a6c9f8da50acb63654088320a47dece2f71801b3f3dafd397a89d7334f6daafca9c8138b

data/.rubocop.yml

@@ -14,6 +14,8 @@ Metrics/CyclomaticComplexity:
   Max: 10
 Metrics/PerceivedComplexity:
   Max: 10
+Metrics/ParameterLists:
+  Max: 6
 Style/Documentation:
   Enabled: false
 Style/CommentedKeyword:

data/CHANGELOG.md

@@ -8,8 +8,19 @@ All notable changes to this project will be documented in this file.
 
 ### Deprecations
 
+## [1.8.0] - 2018-07-07
+### Enhancements
+- Add Tizen case
+- [Internal] reduce method definition by `add_endpoint_method`
+
+### Bug fixes
+
+### Deprecations
+
 ## [1.7.2] - 2018-06-23
 ### Enhancements
+- Add `find_element_by_image` and `find_elements_by_image` to handle `ImageElement`
+   - Read [here](https://github.com/appium/ruby_lib_core/blob/a08c7c769d12316f3a410b28f93799682a111ed8/lib/appium_lib_core/common/base/driver.rb#L191-L257) for more details
 - Add a `ImageElement` to handle images as elements by `matchTemplate`
    - Experimental feature
 - [Internal] Define screenshot methods in appium_lib_core instead of Selenium's one

data/lib/appium_lib_core/android/device/clipboard.rb

@@ -8,8 +8,8 @@ module Appium
           def self.add_methods
             ::Appium::Core::Device.add_endpoint_method(:get_clipboard) do
               def get_clipboard(content_type: :plaintext)
-                unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
-                  raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+                unless ::Appium::Core::Base::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                  raise "content_type should be #{::Appium::Core::Base::Device::Clipboard::CONTENT_TYPE}"
                 end
 
                 params = { contentType: content_type }
@@ -21,8 +21,8 @@ module Appium
 
             ::Appium::Core::Device.add_endpoint_method(:set_clipboard) do
               def set_clipboard(content:, content_type: :plaintext, label: nil)
-                unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
-                  raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+                unless ::Appium::Core::Base::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                  raise "content_type should be #{::Appium::Core::Base::Device::Clipboard::CONTENT_TYPE}"
                 end
 
                 params = {

data/lib/appium_lib_core/android/device/screen.rb

@@ -14,7 +14,7 @@ module Appium
               # rubocop:disable Metrics/ParameterLists
               def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil,
                                          video_size: nil, time_limit: '180', bit_rate: nil, bug_report: nil)
-                option = ::Appium::Core::Device::ScreenRecord.new(
+                option = ::Appium::Core::Base::Device::ScreenRecord.new(
                   remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
                 ).upload_option
 

data/lib/appium_lib_core/android/uiautomator2/device/battery.rb

@@ -11,10 +11,10 @@ module Appium
 
                   state = case response['state']
                           when 2, 3, 4, 5
-                            ::Appium::Core::Device::BatteryStatus::ANDROID[response['state']]
+                            ::Appium::Core::Base::Device::BatteryStatus::ANDROID[response['state']]
                           else
                             ::Appium::Logger.warn("The state is unknown or undefined: #{response['state']}")
-                            ::Appium::Core::Device::BatteryStatus::ANDROID[1] # :unknown
+                            ::Appium::Core::Base::Device::BatteryStatus::ANDROID[1] # :unknown
                           end
                   { state: state, level: response['level'] }
                 end

data/lib/appium_lib_core/common/base.rb

@@ -1,3 +1,20 @@
+require_relative 'device/device_lock'
+require_relative 'device/keyboard'
+require_relative 'device/ime_actions'
+require_relative 'device/setting'
+require_relative 'device/context'
+require_relative 'device/value'
+require_relative 'device/file_management'
+require_relative 'device/keyevent'
+require_relative 'device/image_comparison'
+require_relative 'device/app_management'
+require_relative 'device/app_state'
+require_relative 'device/screen_record'
+require_relative 'device/battery_status'
+require_relative 'device/clipboard_content_type'
+require_relative 'device/device'
+require_relative 'device/touch_actions'
+
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'
 require_relative 'base/bridge'

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

@@ -5,6 +5,7 @@ module Appium
         # Prefix for extra capability defined by W3C
         APPIUM_PREFIX = 'appium:'.freeze
 
+        # TODO: Remove the forceMjsonwp after Appium server won't need it
         FORCE_MJSONWP = :forceMjsonwp
 
         # Almost same as self.handshake in ::Selenium::WebDriver::Remote::Bridge

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

@@ -3,6 +3,21 @@ module Appium
     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
+
           def commands(command)
             ::Appium::Core::Commands::MJSONWP::COMMANDS[command]
           end

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

@@ -5,6 +5,21 @@ module Appium
     class Base
       class Bridge
         class W3C < ::Selenium::WebDriver::Remote::W3C::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
+
           # Used for default duration of each touch actions
           # Override from 250 milliseconds to 50 milliseconds
           ::Selenium::WebDriver::PointerActions::DEFAULT_MOVE_DURATION = 0.05
@@ -204,6 +219,10 @@ module Appium
             end
           end
 
+          def take_viewport_screenshot
+            execute_script('mobile: viewportScreenshot')
+          end
+
           def take_element_screenshot(element)
             execute :take_element_screenshot, id: element.ref
           end

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

@@ -37,6 +37,574 @@ module Appium
           @bridge.dialect
         end
 
+        ### Methods for Appium
+
+        # Lock the device
+        # @return [String]
+        #
+        # @example
+        #
+        #   @driver.lock    #=> Lock the device
+        #   @driver.lock(5) #=> Lock the device in 5 sec and unlock the device after 5 sec.
+        #                   #   Block other commands during locking the device.
+        #
+        def lock(duration = nil)
+          @bridge.lock(duration)
+        end
+
+        # Check current device status is weather locked or not
+        #
+        # @example
+        #
+        #   @driver.device_locked?
+        #
+        def device_locked?
+          @bridge.device_locked?
+        end
+
+        # Unlock the device
+        #
+        # @example
+        #
+        #   @driver.unlock
+        #
+        def unlock
+          @bridge.unlock
+        end
+
+        # Hide the onscreen keyboard
+        # @param [String] close_key The name of the key which closes the keyboard.
+        #   Defaults to 'Done' for iOS(except for XCUITest).
+        # @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
+        #   XCUITest ignore this argument.
+        #   Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
+        #
+        # @example
+        #
+        #   @driver.hide_keyboard # Close a keyboard with the 'Done' button
+        #   @driver.hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
+        #   @driver.hide_keyboard(nil, :tapOutside) # Close a keyboard with tapping out side of keyboard
+        #
+        def hide_keyboard(close_key = nil, strategy = nil)
+          @bridge.hide_keyboard close_key, strategy
+        end
+
+        # Get whether keyboard is displayed or not.
+        # @return [Boolean] Return true if keyboard is shown. Return false if keyboard is hidden.
+        #
+        # @example
+        #   @driver.is_keyboard_shown # false
+        #
+        def is_keyboard_shown # rubocop:disable Naming/PredicateName
+          @bridge.is_keyboard_shown
+        end
+
+        # Get appium Settings for current test session
+        #
+        # @example
+        #
+        #   @driver.pull_folder '/data/local/tmp' #=> Get the folder at that path
+        #
+        def get_settings
+          @bridge.get_settings
+        end
+
+        # Update Appium Settings for current test session
+        # @param [Hash] settings Settings to update, keys are settings, values to value to set each setting to
+        #
+        # @example
+        #
+        #   @driver.update_settings('allowInvisibleElements': true)
+        #
+        def update_settings(settings)
+          @bridge.update_settings(settings)
+        end
+
+        # Android only. Make an engine that is available active.
+        # @param [String] ime_name The IME owning the activity [required]
+        #
+        # @example
+        #
+        #   ime_activate engine: 'com.android.inputmethod.latin/.LatinIME'
+        #
+        def ime_activate(ime_name)
+          @bridge.ime_activate(ime_name)
+        end
+
+        # Android only. List all available input engines on the machine.
+        #
+        # @example
+        #
+        #   ime_available_engines #=> Get the list of IME installed in the target device
+        #
+        def ime_available_engines
+          @bridge.ime_available_engines
+        end
+
+        # Android only. Get the name of the active IME engine.
+        #
+        # @example
+        #
+        #   ime_active_engine #=> Get the current active IME such as 'com.android.inputmethod.latin/.LatinIME'
+        #
+        def ime_active_engine
+          @bridge.ime_active_engine
+        end
+
+        # @!method ime_activated
+        #   Android only. Indicates whether IME input is active at the moment (not if it is available).
+        #
+        # @example
+        #
+        #   ime_activated #=> True if IME is activated
+        #
+        def ime_activated
+          @bridge.ime_activated
+        end
+
+        # Android only. De-activates the currently-active IME engine.
+        #
+        # @example
+        #
+        #   ime_deactivate #=> Deactivate current IME engine
+        #
+        def ime_deactivate
+          @bridge.ime_deactivate
+        end
+
+        # Perform a block within the given context, then switch back to the starting context.
+        # @param [String] context The context to switch to for the duration of the block.
+        #
+        # @example
+        #
+        #   result = @driver.within_context('NATIVE_APP') do
+        #     @driver.find_element :tag, "button"
+        #   end # The result of `find_element :tag, "button"`
+        #
+        def within_context(context)
+          @bridge.within_context(context)
+        end
+
+        # Change to the default context. This is equivalent to `set_context nil`.
+        #
+        # @example
+        #
+        #   @driver.switch_to_default_context
+        #
+        def switch_to_default_context
+          @bridge.switch_to_default_context
+        end
+
+        # @return [String] The context currently being used.
+        #
+        # @example
+        #
+        #   @driver.current_context
+        #
+        def current_context
+          @bridge.current_context
+        end
+
+        # @return [Array<String>] All usable contexts, as an array of strings.
+        #
+        # @example
+        #
+        #   @driver.available_contexts
+        #
+        def available_contexts
+          @bridge.available_contexts
+        end
+
+        # Change the context to the given context.
+        # @param [String] context The context to change to
+        #
+        # @example
+        #
+        #   @driver.set_context "NATIVE_APP"
+        #
+        def set_context(context = null)
+          @bridge.set_context(context)
+        end
+
+        # Set the value to element directly
+        #
+        # @example
+        #
+        #   set_immediate_value element, 'hello'
+        #
+        def set_immediate_value(element, *value)
+          @bridge.set_immediate_value(element, *value)
+        end
+
+        # Replace the value to element directly
+        #
+        # @example
+        #
+        #   replace_value element, 'hello'
+        #
+        def replace_value(element, *value)
+          @bridge.replace_value(element, *value)
+        end
+
+        # Place a file in a specific location on the device.
+        # On iOS, the server should have ifuse libraries installed and configured properly for this feature to work on
+        # real devices.
+        # On Android, the application under test should be built with debuggable flag enabled in order to get access to
+        # its container on the internal file system.
+        #
+        # @see https://github.com/libimobiledevice/ifuse iFuse GitHub page6
+        # @see https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ
+        # @see https://developer.android.com/studio/debug/ 'Debug Your App' developer article
+        #
+        # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
+        #                      If the path starts with application id prefix, then the file will be pushed to the root of
+        #                      the corresponding application container.
+        # @param [String] filedata Raw file data to be sent to the device. Converted to base64 in the method.
+        #
+        # @example
+        #
+        #   @driver.push_file "/file/to/path", "data"
+        #
+        def push_file(path, filedata)
+          @bridge.push_file(path, filedata)
+        end
+
+        # Pull a file from the simulator/device.
+        # On iOS the server should have ifuse
+        # libraries installed and configured properly for this feature to work on real devices.
+        # On Android the application under test should be built with debuggable flag enabled in order to get access
+        # to its container on the internal file system.
+        #
+        # @see https://github.com/libimobiledevice/ifuse iFuse GitHub page6
+        # @see https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ
+        # @see https://developer.android.com/studio/debug/ 'Debug Your App' developer article
+        #
+        # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
+        #                      If the path starts with application id prefix, then the file will be pulled from the root
+        #                      of the corresponding application container.
+        #                      Otherwise the root folder is considered as / on Android and on iOS it is a media folder root
+        #                      (real devices only).
+        # @return [Base64-decoded] Base64 decoded data
+        #
+        # @example
+        #
+        #   @driver.pull_file '/local/data/some/path'     #=> Get the file at that path
+        #   @driver.pull_file 'Shenanigans.app/some/file' #=> Get 'some/file' from the install location of Shenanigans.app
+        #
+        def pull_file(path)
+          @bridge.pull_file(path)
+        end
+
+        # Pull a folder content from the simulator/device.
+        # On iOS the server should have ifuse libraries installed and configured properly for this feature to work
+        # on real devices.
+        # On Android the application under test should be built with debuggable flag enabled in order to get access to
+        # its container on the internal file system.
+        #
+        # @see https://github.com/libimobiledevice/ifuse iFuse GitHub page6
+        # @see https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ
+        # @see https://developer.android.com/studio/debug/ 'Debug Your App' developer article
+        #
+        # @param [String] path Absolute path to the folder.
+        #                      If the path starts with <em>@applicationId/</em> prefix, then the folder will be pulled
+        #                      from the root of the corresponding application container.
+        #                      Otherwise the root folder is considered as / on Android and on iOS it is a media folder root
+        #                      (real devices only).
+        #
+        # @return [Base64-decoded] Base64 decoded data which is zip archived
+        #
+        # @example
+        #
+        #   @driver.pull_folder '/data/local/tmp' #=> Get the folder at that path
+        #
+        def pull_folder(path)
+          @bridge.pull_folder(path)
+        end
+
+        # Send keyevent on the device.(Only for Selendroid)
+        # http://developer.android.com/reference/android/view/KeyEvent.html
+        # @param [integer] key The key to press.
+        # @param [String] metastate The state the metakeys should be in when pressing the key.
+        #
+        # @example
+        #
+        #   @driver.keyevent 82
+        #
+        def keyevent(key, metastate = nil)
+          @bridge.keyevent(key, metastate)
+        end
+
+        # Press keycode on the device.
+        # http://developer.android.com/reference/android/view/KeyEvent.html
+        # @param [Integer] key The key to press. The values which have `KEYCODE_` prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                      e.g.: KEYCODE_HOME is `3` or `0x00000003`
+        # @param [[Integer]] metastate: The state the metakeys should be in when pressing the key. Default is empty Array.
+        #                            Metastate have `META_` prefix in https://developer.android.com/reference/android/view/KeyEvent.html
+        #                            e.g.: META_SHIFT_ON is `1` or `0x00000001`
+        # @param [[Integer]] flags: Native Android flag value. Several flags can be combined into a single key event.
+        #                           Default is empty Array.  Can set multiple flags as Array.
+        #                           Flags have `FLAG_` prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                           e.g.: FLAG_CANCELED is `32` or `0x00000020`
+        #
+        # @example
+        #
+        #   @driver.press_keycode 66
+        #   @driver.press_keycode 66, flags: [0x02]
+        #   @driver.press_keycode 66, metastate: [1], flags: [32]
+        #
+        def press_keycode(key, metastate: [], flags: [])
+          @bridge.press_keycode(key, metastate: metastate, flags: flags)
+        end
+
+        # Long press keycode on the device.
+        # http://developer.android.com/reference/android/view/KeyEvent.html
+        # @param [Integer] key The key to long press. The values which have `KEYCODE_` prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                      e.g.: KEYCODE_HOME is `3` or `0x00000003`
+        # @param [[Integer]] metastate: The state the metakeys should be in when pressing the key. Default is empty Array.
+        #                            Metastate have `META_` prefix in https://developer.android.com/reference/android/view/KeyEvent.html
+        #                            e.g.: META_SHIFT_ON is `1` or `0x00000001`
+        # @param [[Integer]] flags: Native Android flag value. Several flags can be combined into a single key event.
+        #                           Default is empty Array. Can set multiple flags as Array.
+        #                           Flags have `FLAG_` prefix in http://developer.android.com/reference/android/view/KeyEvent.html
+        #                           e.g.: FLAG_CANCELED is `32` or `0x00000020`
+        #
+        # @example
+        #
+        #   @driver.long_press_keycode 66
+        #   @driver.long_press_keycode 66, flags: [0x20, 0x2000]
+        #   @driver.long_press_keycode 66, metastate: [1], flags: [32, 8192]
+        #
+        def long_press_keycode(key, metastate: [], flags: [])
+          @bridge.long_press_keycode(key, metastate: metastate, flags: flags)
+        end
+
+        # Start the simulator and application configured with desired capabilities
+        #
+        # @example
+        #
+        #   @driver.launch_app
+        #
+        def launch_app
+          @bridge.launch_app
+        end
+
+        # Close an app on device
+        #
+        # @example
+        #
+        #   @driver.close_app
+        #
+        def close_app
+          @bridge.close_app
+        end
+
+        # Reset the device, relaunching the application.
+        #
+        # @example
+        #
+        #   @driver.reset
+        #
+        def reset
+          @bridge.reset
+        end
+
+        # Return the hash of all localization strings.
+        # @return [Hash]
+        #
+        # @example
+        #
+        #   @driver.app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web"
+        #
+        def app_strings(language = nil)
+          @bridge.app_strings(language)
+        end
+
+        # Backgrounds the app for a set number of seconds.
+        # This is a blocking application
+        # @param [Integer] duration How many seconds to background the app for.
+        # @return [String]
+        #
+        # @example
+        #
+        #   @driver.background_app
+        #   @driver.background_app(5)
+        #   @driver.background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
+        #
+        def background_app(duration = 0)
+          @bridge.background_app(duration)
+        end
+
+        # Install the given app onto the device
+        #
+        # @param [String] path The absolute local path or remote http URL to an .ipa or .apk file,
+        #                      or a .zip containing one of these.
+        # @param [Boolean] replace: Only for Android. Whether to reinstall/upgrade the package if it is already present
+        #                           on the device under test. `true` by default
+        # @param [Integer] timeout: Only for Android. How much time to wait for the installation to complete.
+        #                           60000ms by default.
+        # @param [Boolean] allow_test_packages: Only for Android. Whether to allow installation of packages marked as test
+        #                                       in the manifest. `false` by default
+        # @param [Boolean] use_sdcard: Only for Android. Whether to use the SD card to install the app. `false` by default
+        # @param [Boolean] grant_permissions: Only for Android. whether to automatically grant application permissions
+        #                                     on Android 6+ after the installation completes. `false` by default
+        #
+        # @example
+        #
+        #   @driver.install_app("/path/to/test.apk")
+        #   @driver.install_app("/path/to/test.apk", replace: true, timeout: 20000, allow_test_packages: true,
+        #                       use_sdcard: false, grant_permissions: false)
+        #
+        def install_app(path,
+                        replace: nil,
+                        timeout: nil,
+                        allow_test_packages: nil,
+                        use_sdcard: nil,
+                        grant_permissions: nil)
+          @bridge.install_app(path,
+                              replace: replace,
+                              timeout: timeout,
+                              allow_test_packages: allow_test_packages,
+                              use_sdcard: use_sdcard,
+                              grant_permissions: grant_permissions)
+        end
+
+        # @param [Strong] app_id BundleId for iOS or package name for Android
+        # @param [Boolean] keep_data: Only for Android. Whether to keep application data and caches after it is uninstalled.
+        #                             `false` by default
+        # @param [Integer] timeout: Only for Android. How much time to wait for the uninstall to complete. 20000ms by default.
+        #
+        # @example
+        #
+        #   @driver.remove_app("io.appium.bundle")
+        #   @driver.remove_app("io.appium.bundle", keep_data: false, timeout, 10000)
+        #
+        def remove_app(app_id, keep_data: nil, timeout: nil)
+          @bridge.remove_app(app_id, keep_data: keep_data, timeout: timeout)
+        end
+
+        # Check whether the specified app is installed on the device
+        # @return [Boolean]
+        #
+        # @example
+        #
+        #   @driver.app_installed?("io.appium.bundle")
+        #
+        def app_installed?(app_id)
+          @bridge.app_installed?(app_id)
+        end
+
+        # Activate(Launch) the specified app.
+        # @return [Hash]
+        #
+        # @example
+        #
+        #   @driver.activate_app("io.appium.bundle") #=> {}
+        #
+        def activate_app(app_id)
+          @bridge.activate_app(app_id)
+        end
+
+        # Terminate the specified app.
+        #
+        # @param [Strong] app_id BundleId for iOS or package name for Android
+        # @param [Integer] timeout: Only for Android. How much time to wait for the application termination to complete.
+        #                           500ms by default.
+        # @return [Boolean]
+        #
+        # @example
+        #
+        #   @driver.terminate_app("io.appium.bundle") # true
+        #   @driver.terminate_app("io.appium.bundle", timeout: 500)
+        #
+        def terminate_app(app_id, timeout: nil)
+          @bridge.terminate_app(app_id, timeout: timeout)
+        end
+
+        # Get the status of an existing application on the device.
+        # State:
+        #   :not_installed : The current application state cannot be determined/is unknown
+        #   :not_running : The application is not running
+        #   :running_in_background_suspended : The application is running in the background and is suspended
+        #   :running_in_background : The application is running in the background and is not suspended
+        #   :running_in_foreground : The application is running in the foreground
+        #
+        # For more details: https://developer.apple.com/documentation/xctest/xcuiapplicationstate
+        #
+        # @param [String] app_id A target app's bundle id
+        # @return [AppState::STATUS] A number of the state
+        #
+        # @example
+        #
+        #      @driver.app_state("io.appium.bundle") #=> :not_running
+        #
+        def app_state(app_id)
+          @bridge.app_state(app_id)
+        end
+
+        # @param [String] remote_path: The path to the remote location, where the resulting video should be uploaded.
+        #                             The following protocols are supported: http/https, ftp.
+        #                             Null or empty string value (the default setting) means the content of resulting
+        #                             file should be encoded as Base64 and passed as the endpoint response value.
+        #                             An exception will be thrown if the generated media file is too big to
+        #                             fit into the available process memory.
+        # @param [String] user: The name of the user for the remote authentication.
+        # @param [String] pass: The password for the remote authentication.
+        # @param [String] method: The http multipart upload method name. The 'PUT' one is used by default.
+        #
+        # @example
+        #
+        #    @driver.stop_recording_screen
+        #    @driver.stop_recording_screen remote_path: 'https://example.com', user: 'example', pass: 'pass', method: 'POST'
+        #
+        def stop_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT')
+          @bridge.stop_recording_screen(remote_path: remote_path, user: user, pass: pass, method: method)
+        end
+
+        # @param [String] file_path The path to save video decoded from base64 from Appium server.
+        #
+        # @example
+        #
+        #    @driver.stop_and_save_recording_screen 'example.mp4'
+        #
+        def stop_and_save_recording_screen(file_path)
+          @bridge.stop_and_save_recording_screen(file_path)
+        end
+
+        # Cause the device to shake
+        #
+        # @example
+        #
+        #   @driver.shake
+        #
+        def shake
+          @bridge.shake
+        end
+
+        # Get the time on the device
+        #
+        # @param [String] format The set of format specifiers. Read https://momentjs.com/docs/ to get
+        #                        the full list of supported datetime format specifiers.
+        #                        The default format is `YYYY-MM-DDTHH:mm:ssZ`, which complies to ISO-8601
+        # @return [String] Formatted datetime string or the raw command output if formatting fails
+        #
+        # @example
+        #
+        #   @driver.device_time #=> "2018-06-12T11:13:31+02:00"
+        #   @driver.device_time "YYYY-MM-DD" #=> "2018-06-12"
+        #
+        def device_time(format = nil)
+          @bridge.device_time(format)
+        end
+
+        # touch actions
+        def touch_actions(actions)
+          @bridge.touch_actions(actions)
+        end
+
+        def multi_touch(actions)
+          @bridge.multi_touch(actions)
+        end
+
         # Get the device window's size.
         # @return [Selenium::WebDriver::Dimension]
         #
@@ -188,6 +756,36 @@ module Appium
 
         DEFAULT_MATCH_THRESHOLD = 0.5
 
+        # Image Comparison
+        def match_images_features(first_image:,
+                                  second_image:,
+                                  detector_name: 'ORB',
+                                  match_func: 'BruteForce',
+                                  good_matches_factor: nil,
+                                  visualize: false)
+          @bridge.match_images_features(first_image: first_image,
+                                        second_image: second_image,
+                                        detector_name: detector_name,
+                                        match_func: match_func,
+                                        good_matches_factor: good_matches_factor,
+                                        visualize: visualize)
+        end
+
+        def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil)
+          @bridge.find_image_occurrence(full_image: full_image,
+                                        partial_image: partial_image,
+                                        visualize: visualize,
+                                        threshold: threshold)
+        end
+
+        def get_images_similarity(first_image:, second_image:, visualize: false)
+          @bridge.get_images_similarity(first_image: first_image, second_image: second_image, visualize: visualize)
+        end
+
+        def compare_images(mode: :matchFeatures, first_image:, second_image:, options: nil)
+          @bridge.compare_images(mode: mode, first_image: first_image, second_image: second_image, options: options)
+        end
+
         # Return ImageElement if current view has a partial image
         #
         # @param [String] png_img_path A path to a partial image you'd like to find
@@ -234,7 +832,7 @@ module Appium
         #
         # @example
         #
-        #     e = @@driver.find_elements_by_image './test/functional/data/test_element_image.png'
+        #     e = @@driver.find_elements_by_image ['./test/functional/data/test_element_image.png']
         #     e == [] # if the `e` is empty
         #
         def find_elements_by_image(png_img_paths, match_threshold: DEFAULT_MATCH_THRESHOLD, visualize: false)