appium_lib_core 4.2.1 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f77d23abb2c69ab5b4f5f733a9b901002f8d5fe24e8b99ad8ef03df1dcad99
-  data.tar.gz: 7acc05e37be676c753e2c0d7519c9882d13eb55bdef32678dd3b44458120e487
+  metadata.gz: 27d5a8e4018e381172273c5b705a2166e8f47530101eed83ffd0ddf83e93653d
+  data.tar.gz: 78ceb26083c9ae018101180cf13c91cd28f363e819119b6500b2d48a28273474
 SHA512:
-  metadata.gz: 3ea82009235de78bedd7a03e4de1021fed4fcb5a21a878697fe4b3dde281d1d36976a2cc6e63dc5d2735cabbe8328f49de3d06f1568ffc48eebbb80144c69d5a
-  data.tar.gz: 4bee50ff9e195d09b634a3ff7420d04ca1ab896d26d9523a40f20ae2db7c6d2d4b81450dee4f2b0e225599e9e1a774c0e5cb19acc6d89bfeb01bd859caecfe6e
+  metadata.gz: 5d07ce477474a38c3df1fb1bd989d9e6b28188ab21d7851bec98443940b0ea5d8b358c628998aeb1f62ca93be783c617dab3b4cf4fdf26e47e97def6467dca97
+  data.tar.gz: 29634dc748e222cf65bc6af144656f291815e4c5eaea1fa177aa7e1543752ffbcbac0d4b206f4169ab306dd25e1d5a36c2a1b3d9b51cdef438456c27e52a7bea

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10

data/CHANGELOG.md

@@ -10,6 +10,27 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [4.5.0] - 2021-03-14
+
+### Enhancements
+- Add `speed` argument for `Appium::Core::Base::Driver#set_location` since Appium 1.21.0 
+- Add `multiple` and `match_neighbour_threshold` arguments for `Appium::Core::Base::Driver#find_image_occurrence`
+
+### Bug fixes
+
+### Deprecations
+
+
+## [4.4.1(4.4.0)] - 2021-02-15(2021-02-13)
+
+### Enhancements
+- Returns `{}` any errors in `Core#appium_server_version` to prevent errors in some cases
+
+## [4.3.1(4.3.0)] - 2021-02-07(2021-02-05)
+
+### Enhancements
+- Add `start_recording_screen` for Mac2 driver
+
 ## [4.2.1] - 2021-01-10
 
 ### Enhancements

data/appium_lib_core.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 3.11.0'
-  spec.add_development_dependency 'rubocop', '1.8.0'
+  spec.add_development_dependency 'rubocop', '1.8.1'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional/run_appium.yml

@@ -1,8 +1,8 @@
 steps:
 - task: NodeTool@0
   inputs:
-    versionSpec: 10.x
-  displayName: Install Node 10.x
+    versionSpec: 12.x
+  displayName: Install Node 12.x
 - script: npm install -g appium@${APPIUM_VERSION}
   displayName: Install appium beta
 - script: npm install -g mjpeg-consumer

data/ci-jobs/functional_test.yml

@@ -4,7 +4,7 @@ parameters:
   vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
   xcodeForIOS: 12.2
   xcodeForTVOS: 12.2
-  androidSDK: 30
+  androidSDK: 29  # API Level 30 emulators are more unstable than 29
   appiumVersion: 'beta'
   ignoreVersionSkip: true
   CI: true

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

@@ -42,6 +42,10 @@ module Appium
             execute :get_all_sessions
           end
 
+          def status
+            execute :status
+          end
+
           # For Appium
           def log_event(vendor, event)
             execute :post_log_event, {}, { vendor: vendor, event: event }
@@ -74,6 +78,12 @@ module Appium
           def convert_to_element(id)
             ::Selenium::WebDriver::Element.new self, element_id_from(id)
           end
+
+          def set_location(lat, lon, alt = 0.0, speed: nil)
+            loc = { latitude: lat, longitude: lon, altitude: alt }
+            loc[:speed] = speed unless speed.nil?
+            execute :set_location, {}, { location: loc }
+          end
         end # class MJSONWP
       end # class Bridge
     end # class Base

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

@@ -43,6 +43,10 @@ module Appium
             execute :get_all_sessions
           end
 
+          def status
+            execute :status
+          end
+
           # Perform touch actions for W3C module.
           # Generate +touch+ pointer action here and users can use this via +driver.action+
           # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
@@ -166,18 +170,9 @@ module Appium
 
           # For Appium
           # No implementation for W3C webdriver module
-          # called in +extend DriverExtensions::HasLocation+
-          # It has below code as well. We should consider the same context in Selenium 4 as backward compatibility.
-          #
-          #     def location=(loc)
-          #       # note: Location  = Struct.new(:latitude, :longitude, :altitude)
-          #       raise TypeError, "expected #{Location}, got #{loc.inspect}:#{loc.class}" unless loc.is_a?(Location)
-          #
-          #       @bridge.set_location loc.latitude, loc.longitude, loc.altitude
-          #     end
-          #
-          def set_location(lat, lon, alt = 0.0)
+          def set_location(lat, lon, alt = 0.0, speed: nil)
             loc = { latitude: lat, longitude: lon, altitude: alt }
+            loc[:speed] = speed unless speed.nil?
             execute :set_location, {}, { location: loc }
           end
 

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

@@ -16,6 +16,8 @@ require 'base64'
 require_relative 'search_context'
 require_relative 'screenshot'
 require_relative 'rotable'
+require_relative 'remote_status'
+require_relative 'has_location'
 
 module Appium
   module Core
@@ -25,10 +27,14 @@ module Appium
         include ::Selenium::WebDriver::DriverExtensions::HasSessionId
         include ::Selenium::WebDriver::DriverExtensions::HasRemoteStatus
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
+        include ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
+        include  ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
 
         include ::Appium::Core::Base::Rotatable
         include ::Appium::Core::Base::SearchContext
         include ::Appium::Core::Base::TakesScreenshot
+        include ::Appium::Core::Base::HasRemoteStatus
+        include ::Appium::Core::Base::HasLocation
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
@@ -37,16 +43,6 @@ module Appium
         def initialize(opts = {})
           listener = opts.delete(:listener)
           @bridge = ::Appium::Core::Base::Bridge.handshake(**opts)
-          if @bridge.dialect == :oss # MJSONWP
-            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
-            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
-            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
-          elsif @bridge.dialect == :w3c
-            # TODO: Only for Appium. Ideally, we'd like to remove the below like selenium-webdriver
-            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
-            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
-            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
-          end
           super(@bridge, listener: listener)
         end
 
@@ -59,6 +55,7 @@ module Appium
         # Update +server_url+ and HTTP clients following this arguments, protocol, host, port and path.
         # After this method, +@bridge.http+ will be a new instance following them instead of +server_url+ which is
         # set before creating session.
+        # If +@bridge.http+ did not have +update_sending_request_to+ method, this method returns immediately.
         #
         # @example
         #
@@ -67,10 +64,16 @@ module Appium
         #     driver.manage.timeouts.implicit_wait = 10 # @bridge.http is for 'https://example2.com:9000/wd/hub/'
         #
         def update_sending_request_to(protocol:, host:, port:, path:)
-          @bridge.http.update_sending_request_to(scheme: protocol,
-                                                 host: host,
-                                                 port: port,
-                                                 path: path)
+          unless @bridge.http&.class&.method_defined? :update_sending_request_to
+            ::Appium::Logger.warn "#{@bridge.http&.class} has no 'update_sending_request_to'. " \
+              'It keeps current connection target.'
+            return
+          end
+
+          @bridge.http&.update_sending_request_to(scheme: protocol,
+                                                  host: host,
+                                                  port: port,
+                                                  path: path)
         end
 
         ### Methods for Appium
@@ -240,6 +243,8 @@ module Appium
 
         # Returns an instance of DeviceIME
         #
+        # @return [Appium::Core::Base::Driver::DeviceIME]
+        #
         # @example
         #
         #   @driver.ime.activate engine: 'com.android.inputmethod.latin/.LatinIME'
@@ -290,6 +295,8 @@ module Appium
         # @!method ime_activated
         #   Android only. Indicates whether IME input is active at the moment (not if it is available).
         #
+        # @return [Boolean]
+        #
         # @example
         #
         #   @driver.ime_activated #=> True if IME is activated
@@ -854,7 +861,7 @@ module Appium
         end
 
         # Get the device window's logs.
-        # @return [String]
+        # @return [Appium::Core::Logs]
         #
         # @example
         #
@@ -880,7 +887,7 @@ module Appium
         # Retrieve the capabilities of the specified session.
         # It's almost same as +@driver.capabilities+ but you can get more details.
         #
-        # @return [Selenium::WebDriver::Remote::Capabilities]
+        # @return [Selenium::WebDriver::Remote::Capabilities, Selenium::WebDriver::Remote::W3C::Capabilities]
         #
         # @example
         #   @driver.session_capabilities
@@ -993,11 +1000,14 @@ module Appium
                                         visualize: visualize)
         end
 
-        def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil)
+        def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil,
+                                  multiple: nil, match_neighbour_threshold: nil)
           @bridge.find_image_occurrence(full_image: full_image,
                                         partial_image: partial_image,
                                         visualize: visualize,
-                                        threshold: threshold)
+                                        threshold: threshold,
+                                        multiple: multiple,
+                                        match_neighbour_threshold: match_neighbour_threshold)
         end
 
         def get_images_similarity(first_image:, second_image:, visualize: false)
@@ -1039,7 +1049,7 @@ module Appium
         #
         # @param [String] img_path A path to a partial image you'd like to find
         #
-        # @return [::Selenium::WebDriver::Element]
+        # @return [Array<Selenium::WebDriver::Element>]
         #
         # @example
         #

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+      module HasLocation
+        # Get the location of the device.
+        #
+        # @return [::Selenium::WebDriver::Location]
+        #
+        # @example
+        #
+        #   driver.location #=> ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #
+        def location
+          @bridge.location
+        end
+
+        # Set the location of the device.
+        #
+        # @param [::Selenium::WebDriver::Location] location Set the location.
+        #
+        # @example
+        #
+        #   driver.location = ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #
+        def location=(location)
+          unless location.is_a?(::Selenium::WebDriver::Location)
+            raise TypeError, "expected #{::Selenium::WebDriver::Location}, got #{location.inspect}:#{location.class}"
+          end
+
+          @bridge.set_location location.latitude, location.longitude, location.altitude
+        end
+
+        # Set the location of the device.
+        #
+        # @param [String, Number] latitude Set the latitude.
+        # @param [String, Number] longitude Set the longitude.
+        # @param [String, Number] altitude Set the altitude.
+        # @param [String, Number] speed Set the speed to apply the location on Android real devices @since Appium 1.21.0.
+        # @param [::Selenium::WebDriver::Location]
+        #
+        # @example
+        #
+        #   driver.location = ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #
+        def set_location(latitude, longitude, altitude, speed: nil)
+          if speed.nil?
+            self.location = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
+          else
+            loc = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
+            @bridge.set_location loc.latitude, loc.longitude, loc.altitude, speed: Float(speed)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -55,8 +55,6 @@ module Appium
           def update_sending_request_to(scheme:, host:, port:, path:)
             return @server_url unless validate_url_param(scheme, host, port, path)
 
-            ::Appium::Logger.debug("[experimental] This feature, #{__method__}, is an experimental")
-
             # Add / if 'path' does not have it
             path = path.start_with?('/') ? path : "/#{path}"
             path = path.end_with?('/') ? path : "#{path}/"
@@ -71,7 +69,7 @@ module Appium
             return true unless [scheme, host, port, path].include?(nil)
 
             message = "Given parameters are scheme: '#{scheme}', host: '#{host}', port: '#{port}', path: '#{path}'"
-            ::Appium::Logger.warn(message)
+            ::Appium::Logger.debug(message)
             false
           end
 

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+
+      module HasRemoteStatus
+        # Selenium binding has this ability only in Remote Binding,
+        # so this library has this method by own for safe.
+        def remote_status
+          bridge.status
+        end
+      end
+    end
+  end
+end

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

@@ -141,6 +141,8 @@ module Appium
         #
         # Find all elements matching the given arguments
         #
+        # @return [Array<Selenium::WebDriver::Element>]
+        #
         # @see SearchContext#find_elements
         #
         def find_elements(*args)

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.
@@ -94,7 +94,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 +107,15 @@ module Appium
           #     visual = @@driver.find_image_occurrence full_image: image1, partial_image: image2, visualize: true
           #     File.write 'find_result_visual.png', Base64.decode64(visual['visualization']) # if the image is PNG
           #
-          def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil)
+          def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil,
+                                    multiple: nil, match_neighbour_threshold: nil)
             raise "visualize should be #{MATCH_TEMPLATE[:visualize]}" unless MATCH_TEMPLATE[:visualize].member?(visualize)
 
             options = {}
             options[:visualize] = visualize
             options[:threshold] = threshold unless threshold.nil?
+            options[:multiple] = multiple unless multiple.nil?
+            options[:matchNeighbourThreshold] = match_neighbour_threshold unless match_neighbour_threshold.nil?
 
             compare_images(mode: :matchTemplate, first_image: full_image, second_image: partial_image, options: options)
           end
@@ -144,7 +152,7 @@ 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.

data/lib/appium_lib_core/driver.rb

@@ -27,6 +27,8 @@ module Appium
       autoload :Xcuitest, 'appium_lib_core/ios_xcuitest'
     end
 
+    autoload :Mac2, 'appium_lib_core/mac2'
+
     autoload :Windows, 'appium_lib_core/windows'
 
     # This options affects only client side as <code>:appium_lib</code> key.<br>
@@ -45,7 +47,7 @@ module Appium
         @export_session = appium_lib_opts.fetch :export_session, false
         @export_session_path = appium_lib_opts.fetch :export_session_path, default_tmp_appium_lib_session
 
-        @direct_connect = appium_lib_opts.fetch :direct_connect, false
+        @direct_connect = appium_lib_opts.fetch :direct_connect, true
 
         @port = appium_lib_opts.fetch :port, Driver::DEFAULT_APPIUM_PORT
 
@@ -175,7 +177,7 @@ module Appium
       # - <code>directConnectPort</code>
       # - <code>directConnectPath</code>
       #
-      # Ignore them if this parameter is <code>false</code>. Defaults to false.
+      # Ignore them if this parameter is <code>false</code>. Defaults to true.
       #
       # @return [Bool]
       attr_reader :direct_connect
@@ -435,7 +437,8 @@ module Appium
         nil
       end
 
-      # Returns the server's version info
+      # Returns the server's version info. This method calls +driver.remote_status+ internally
+      #
       # @return [Hash]
       #
       # @example
@@ -449,18 +452,20 @@ module Appium
       #         }
       #     }
       #
-      # Returns blank hash for Selenium Grid since 'remote_status' gets 500 error
+      # Returns blank hash in a case +driver.remote_status+ got an error
+      # such as Selenium Grid. It returns 500 error against 'remote_status'.
       #
       # @example
       #
       #   @core.appium_server_version #=> {}
       #
       def appium_server_version
-        @driver.remote_status
-      rescue Selenium::WebDriver::Error::ServerError => e
-        raise ::Appium::Core::Error::ServerError unless e.message.include?('status code 500')
+        return {} if @driver.nil?
 
-        # driver.remote_status returns 500 error for using selenium grid
+        @driver.remote_status
+      rescue StandardError
+        # Ignore error case in a case the target appium server
+        # does not support `/status` API.
         {}
       end
 
@@ -526,7 +531,7 @@ module Appium
           when :gecko
             ::Appium::Logger.debug('Gecko Driver for macOS')
           when :mac2
-            ::Appium::Logger.debug('macOS XCUITest')
+            ::Appium::Core::Mac2::Bridge.for self
           else
             # no Mac specific extentions
             ::Appium::Logger.debug('macOS Native')

data/lib/appium_lib_core/mac2.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# loaded in common/driver.rb
+require_relative 'mac2/device'
+require_relative 'mac2/bridge'

data/lib/appium_lib_core/mac2/bridge.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    module Mac2
+      module Bridge
+        def self.for(target)
+          target.extend Appium::Core::Mac2::Device
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/mac2/device.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'device/screen'
+
+module Appium
+  module Core
+    module Mac2
+      module Device
+        extend Forwardable
+
+        # rubocop:disable Layout/LineLength
+
+        # @since Appium 1.20.0
+        # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil, fps: nil, preset: nil, video_filter: nil, enable_capture_clicks: nil, enable_cursor_capture: nil, device_id: nil)
+        #
+        # Record the display of devices running iOS Simulator since Xcode 9 or real devices since iOS 11
+        # (ffmpeg utility is required: 'brew install ffmpeg').
+        # We would recommend to play the video by VLC or Mplayer if you can not play the video with other video players.
+        #
+        # @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 endpount response value.
+        #                             An exception will be thrown if the generated media file is too big to
+        #                             fit into the available process memory.
+        #                             This option only has an effect if there is screen recording process in progreess
+        #                             and +forceRestart+ parameter is not set to +true+.
+        # @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.
+        # @param [String] file_field_name The name of the form field containing the binary payload in multipart/form-data
+        #                             requests since Appium 1.18.0. Defaults to 'file'.
+        # @param [Array<Hash, Array<String>>] form_fields The form fields mapping in multipart/form-data requests since Appium 1.18.0.
+        #                             If any entry has the same key in this mapping, then it is going to be ignored.
+        # @param [Hash] headers The additional headers in multipart/form-data requests since Appium 1.18.0.
+        # @param [Boolean] force_restart Whether to try to catch and upload/return the currently running screen recording
+        #                                (+false+, the default setting on server) or ignore the result of it
+        #                                and start a new recording immediately (+true+).
+        # @param [integer] fps The count of frames per second in the resulting video.
+        #                      Increasing fps value also increases the size of the resulting video file and the CPU usage.
+        #                      The default value is 15.
+        # @param [String] preset A preset is a collection of options that will provide a certain encoding speed to compression ratio.
+        #                        A slower preset will provide better compression (compression is quality per filesize).
+        #                        This means that, for example, if you target a certain file size or constant bit rate, you will
+        #                        achieve better quality with a slower preset. Read https://trac.ffmpeg.org/wiki/Encode/H.264
+        #                        for more details.
+        # @param [Boolean] enable_cursor_capture Whether to capture the click gestures while recording the screen. Disabled by default.
+        # @param [Boolean] enable_capture_clicks Recording time. 180 seconds is by default.
+        # @param [String] video_filter The video filter spec to apply for ffmpeg.
+        #                              See https://trac.ffmpeg.org/wiki/FilteringGuide for more details on the possible values.
+        #                              Example: Set it to +scale=ifnot(gte(iw\,1024)\,iw\,1024):-2+ in order to limit the video width
+        #                              to 1024px. The height will be adjusted automatically to match the actual screen aspect ratio.
+        # @param [integer] device_id Screen device index to use for the recording.
+        #                            The list of available devices could be retrieved using
+        #                            +ffmpeg -f avfoundation -list_devices true -i ""+ command.
+        #                            This option is mandatory and must be always provided.
+        # @param [String] time_limit The maximum recording time. The default value is 600 seconds (10 minutes).
+        #                            The minimum time resolution unit is one second.
+        #
+        # @example
+        #
+        #    @driver.start_recording_screen
+        #    @driver.start_recording_screen fps: 30, enable_cursor_capture: true
+        #
+
+        # rubocop:enable Layout/LineLength
+
+        ####
+        ## class << self
+        ####
+
+        class << self
+          def extended(_mod)
+            Screen.add_methods
+          end
+        end # class << self
+      end # module Device
+    end # module Mac2
+  end # module Core
+end # module Appium

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    module Mac2
+      module Device
+        module Screen
+          def self.add_methods
+            ::Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
+              def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT',
+                                         file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil,
+                                         fps: nil, preset: nil, video_filter: nil, time_limit: nil,
+                                         enable_capture_clicks: nil, enable_cursor_capture: nil, device_id: nil)
+                option = ::Appium::Core::Base::Device::ScreenRecord.new(
+                  remote_path: remote_path, user: user, pass: pass, method: method,
+                  file_field_name: file_field_name, form_fields: form_fields, headers: headers,
+                  force_restart: force_restart
+                ).upload_option
+
+                option[:fps] = fps unless fps.nil?
+                option[:preset] = preset unless preset.nil?
+                option[:videoFilter] = video_filter unless video_filter.nil?
+                option[:captureClicks] = enable_capture_clicks unless enable_capture_clicks.nil?
+                option[:captureCursor] = enable_cursor_capture unless enable_cursor_capture.nil?
+                option[:deviceId] = device_id unless device_id.nil?
+                option[:timeLimit] = time_limit unless time_limit.nil?
+
+                execute(:start_recording_screen, {}, { options: option })
+              end
+            end
+          end
+        end # module Screen
+      end # module Device
+    end # module Mac2
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '4.2.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-01-10' unless defined? ::Appium::Core::DATE
+    VERSION = '4.5.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-03-14' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,41 @@
+#### v4.5.0 2021-03-14
+
+- [656230e](https://github.com/appium/ruby_lib_core/commit/656230e688ed86414c06efaa73bce7359933cc91) Release 4.5.0
+- [a0a3cfc](https://github.com/appium/ruby_lib_core/commit/a0a3cfc71783bed3d1b0e7afbf6bc0a27bf60a48) feat: add speed option (#318)
+- [16b4f09](https://github.com/appium/ruby_lib_core/commit/16b4f0991deb639314857c3cbece1e4d00393646) feat: add multiple and match_neighbour_threshold (#313)
+- [d195a5b](https://github.com/appium/ruby_lib_core/commit/d195a5ba48c2e1a7229e0145eac616fd886c1ee0) ci: use node 12
+
+
+#### v4.4.1 2021-02-15
+
+- [dc34419](https://github.com/appium/ruby_lib_core/commit/dc34419dfcc4dd8d499a6407d45ab3efe70c2445) Release 4.4.1
+- [3085048](https://github.com/appium/ruby_lib_core/commit/3085048b4816e3415017ebb188e653c8e229a05e) chore: return {} in nil case as well
+
+
+#### v4.4.0 2021-02-13
+
+- [06c68fb](https://github.com/appium/ruby_lib_core/commit/06c68fbe3ffdbb7b068d2f71ad6841c66dbabf8f) Release 4.4.0
+- [3c54ae2](https://github.com/appium/ruby_lib_core/commit/3c54ae25d9a334f3690c94ce8a59a5c6a4bacd20) feat: always return {} in appium_server_version for errors (#311)
+
+
+#### v4.3.1 2021-02-07
+
+- [1f4d52c](https://github.com/appium/ruby_lib_core/commit/1f4d52cc915783cf89cf4b8ca5a21bd1af5403e0) Release 4.3.1
+- [fb41014](https://github.com/appium/ruby_lib_core/commit/fb410146567ed03902b602813881fd3abc3a3d28) chore: change log level
+- [1e54662](https://github.com/appium/ruby_lib_core/commit/1e546628c871e4ed9c8aa038a455d03e4e2e6c4e) chore : Create Dependabot config file (#309)
+
+
+#### v4.3.0 2021-02-05
+
+- [6e85426](https://github.com/appium/ruby_lib_core/commit/6e85426c1ff8f3e4b90d3da5305d493500539467) Release 4.3.0
+- [405b3d8](https://github.com/appium/ruby_lib_core/commit/405b3d8e627323376dbf74a4423d0ebce5ca0cad) feat: Add mac2 module and screen recording option (#308)
+- [876d254](https://github.com/appium/ruby_lib_core/commit/876d25494c76c31ad5c26900d6e30e30ecd8d20c) chore: teak types in yardoc (#307)
+- [7548ea9](https://github.com/appium/ruby_lib_core/commit/7548ea9cb7e031a3689a63e75d32da82d317488a) test: add wait
+- [9d6fef4](https://github.com/appium/ruby_lib_core/commit/9d6fef469fad8bccf61ee6565f2e30095f4e2a6a) feat: makes direct_connect true by default (#303)
+- [761067e](https://github.com/appium/ruby_lib_core/commit/761067e5c42cfb3e4c1e5c5a377dbeb3c903eb7b) test: add location test (#302)
+- [bd33397](https://github.com/appium/ruby_lib_core/commit/bd3339791552d2eb5181ca4475c9ebc90644a456) chore(deps-dev): update rubocop requirement from = 1.8.0 to = 1.8.1 (#301)
+
+
 #### v4.2.1 2021-01-10
 
 - [23e944e](https://github.com/appium/ruby_lib_core/commit/23e944ed72c6ea861532f5acc1381af4441705e6) Release 4.2.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.5.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +221,7 @@ extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/issue-report.md"
 - ".github/contributing.md"
+- ".github/dependabot.yml"
 - ".github/issue_template.md"
 - ".github/workflows/unittest.yml"
 - ".gitignore"
@@ -266,8 +267,10 @@ files:
 - lib/appium_lib_core/common/base/capabilities.rb
 - lib/appium_lib_core/common/base/command.rb
 - lib/appium_lib_core/common/base/driver.rb
+- lib/appium_lib_core/common/base/has_location.rb
 - lib/appium_lib_core/common/base/http_default.rb
 - lib/appium_lib_core/common/base/platform.rb
+- lib/appium_lib_core/common/base/remote_status.rb
 - lib/appium_lib_core/common/base/rotable.rb
 - lib/appium_lib_core/common/base/screenshot.rb
 - lib/appium_lib_core/common/base/search_context.rb
@@ -315,6 +318,10 @@ files:
 - lib/appium_lib_core/ios/xcuitest/device/performance.rb
 - lib/appium_lib_core/ios/xcuitest/device/screen.rb
 - lib/appium_lib_core/ios_xcuitest.rb
+- lib/appium_lib_core/mac2.rb
+- lib/appium_lib_core/mac2/bridge.rb
+- lib/appium_lib_core/mac2/device.rb
+- lib/appium_lib_core/mac2/device/screen.rb
 - lib/appium_lib_core/patch.rb
 - lib/appium_lib_core/version.rb
 - lib/appium_lib_core/windows.rb