appium_lib_core 3.6.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f19bd603ecc28d38a5ea210d846167130279bd12e0e59b8355af66877921f212
-  data.tar.gz: 509fa209cc410bcf9160e70905ad3b4ea439fda7f280128e210b20b1dca9b9b6
+  metadata.gz: cd289d16dabe2e45527ce5f09ed786082f81001039217e4f3025f5666b084ac6
+  data.tar.gz: b4a8cf9d7b0bb1f526bf910de4518796d2fcead98693a2bfa1c333eeb32a0d57
 SHA512:
-  metadata.gz: d955248f477098d7127d61a9319195bf7a5ac361780bce4f475621d160f067789de1ca5280b4330285623e893f04542cc51c767fd12655579322ed6354b0dfa3
-  data.tar.gz: a7c26d5b16b2bf9b8166aee1b87185b27a0b8d889307c10674239f70da64ce96ce99140c75032a16a8d631e7076884ecbce522e549c098c93aa3aa0c72e57b3c
+  metadata.gz: 32aa153b24cf08f661783cc0a1bfe93ef2ddea8b3b7b5eeffc89416c0dda6d97942afe146aff4ee8cdb055093acdc6c992ea359dd0311aa64b96e77613e06719
+  data.tar.gz: 67e5c83063987d25dd47cac816f5bedae955b5359bbe71dad7a4f54bcd7e047b2b09095eab08df748b06b44b3ee514113a1b652b7903e9a9ae90bd357736751e

data/.rubocop.yml

@@ -15,7 +15,7 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 13
 Metrics/ParameterLists:
-  Max: 6
+  Enabled: false
 Lint/NestedMethodDefinition:
   Enabled: false
 # TODO: Replace <<- with <<~ after dropping Ruby 2.2

data/CHANGELOG.md

@@ -10,7 +10,61 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
-## [3.6.0] - 2020-03-15
+## [3.10.0] - 2020-06-09
+
+### Enhancements
+- Remove deprecated `Selenium::WebDriver::Error::TimeOutError`
+
+### Bug fixes
+
+### Deprecations
+
+## [3.9.0] - 2020-05-31
+
+### Enhancements
+- `capabilities:` is available in addition to `desired_capabilities:` and `caps:` as a capability
+    ```ruby
+    # case 1
+    opts = { caps: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+
+    # case 2
+    opts = { capabilities: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+
+    # case 3
+    opts = { desired_capabilities: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+    ```
+
+### Bug fixes
+
+### Deprecations
+
+## [3.8.0] - 2020-05-17
+
+### Enhancements
+- Add options for `start_recording_screen`
+    - `file_field_name`, `form_fields` and `headers` are available since Appium 1.18.0
+
+### Bug fixes
+- Fix `x-idempotency-key` header to add it only in new session request (https://github.com/appium/ruby_lib_core/issues/262)
+
+### Deprecations
+
+## [3.7.0] - 2020-04-18
+
+### Enhancements
+- Add `x-idempotency-key` header support (https://github.com/appium/appium-base-driver/pull/400)
+    - Can disable the header with `enable_idempotency_header: false` in `appium_lib` capability. Defaults to `true`.
+- Add chrome devtools endpoint which is available chrome module in Selenium Ruby binding 
+    - https://github.com/appium/appium-base-driver/pull/405
+
+### Bug fixes
+
+### Deprecations
+
+## [3.6.1, 3.6.0] - 2020-03-15
 
 ### Enhancements
 - Add screen record feature for Windows driver (https://github.com/appium/appium-windows-driver/pull/66)

data/ci-jobs/functional/start-emulator.sh

@@ -18,7 +18,7 @@ echo ${ANDROID_HOME}/emulator/emulator -list-avds
 echo "Starting emulator"
 
 # Start emulator in background
-nohup ${ANDROID_HOME}/emulator/emulator -avd testemulator -no-boot-anim -no-snapshot > /dev/null 2>&1 &
+nohup ${ANDROID_HOME}/emulator/emulator -avd testemulator -accel auto -no-boot-anim -no-snapshot > /dev/null 2>&1 &
 ${ANDROID_HOME}/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed | tr -d '\r') ]]; do sleep 1; done; input keyevent 82'
 
 ${ANDROID_HOME}/platform-tools/adb devices

data/ci-jobs/functional_test.yml

@@ -2,8 +2,8 @@
 parameters:
   vmImage: 'macOS-10.15'
   vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
-  xcodeForIOS: 11.3
-  xcodeForTVOS: 11.3
+  xcodeForIOS: 11.5
+  xcodeForTVOS: 11.5
   androidSDK: 29
   appiumVersion: 'beta'
   ignoreVersionSkip: true

data/lib/appium_lib_core/android/device.rb

@@ -213,7 +213,7 @@ module Appium
         #   @driver.get_performance_data package_name: package_name, data_type: data_type, data_read_timeout: 2
         #
 
-        # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil, video_size: nil, time_limit: '180', bit_rate: '4000000', bug_report: nil)
+        # @!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, video_size: nil, time_limit: '180', bit_rate: '4000000', bug_report: nil)
         # @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
@@ -225,6 +225,11 @@ module Appium
         # @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+).
@@ -245,6 +250,8 @@ module Appium
         # @param [Boolean] bug_report Set it to +true+ in order to display additional information on the video overlay,
         #                             such as a timestamp, that is helpful in videos captured to illustrate bugs.
         #                             This option is only supported since API level 27 (Android P).
+        # @return [String] Base64 encoded content of the recorded media file or an empty string
+        #                  if the file has been successfully uploaded to a remote location (depends on the actual options)
         #
         # @example
         #
@@ -283,6 +290,19 @@ module Appium
         #   @driver.finger_print 1
         #
 
+        # @!method execute_cdp(cmd, params)
+        #     Execute Chrome Devtools protocol commands
+        #     https://chromedevtools.github.io/devtools-protocol
+        #
+        # @param [String] cmd The name of command
+        # @param [Hash] params The parameter for the command as hash.
+        #
+        # @example
+        #
+        #   @driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }
+        #   @driver.execute_cdp 'Page.getResourceTree'
+        #
+
         ####
         ## class << self
         ####
@@ -391,6 +411,12 @@ module Appium
               end
             end
 
+            ::Appium::Core::Device.add_endpoint_method(:execute_cdp) do
+              def execute_cdp(cmd, **params)
+                execute :chrome_send_command, {}, { cmd: cmd, params: params }
+              end
+            end
+
             Screen.add_methods
             Performance.add_methods
             Network.add_methods

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

@@ -25,11 +25,13 @@ module Appium
             end
 
             ::Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
-              # rubocop:disable Metrics/ParameterLists
-              def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil,
+              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,
                                          video_size: nil, time_limit: '180', bit_rate: nil, bug_report: nil)
                 option = ::Appium::Core::Base::Device::ScreenRecord.new(
-                  remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
+                  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[:videoSize] = video_size unless video_size.nil?
@@ -44,7 +46,6 @@ module Appium
 
                 execute(:start_recording_screen, {}, { options: option })
               end
-              # rubocop:enable Metrics/ParameterLists
             end
           end
         end # module Screen

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

@@ -12,12 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'securerandom'
+
 require_relative '../../version'
 
 module Appium
   module Core
     class Base
       module Http
+        module RequestHeaders
+          KEYS = {
+            idempotency: 'X-Idempotency-Key'
+          }.freeze
+        end
+
         class Default < Selenium::WebDriver::Remote::Http::Default
           DEFAULT_HEADERS = {
             'Accept' => CONTENT_TYPE,
@@ -26,6 +34,14 @@ module Appium
               "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common::DEFAULT_HEADERS['User-Agent']})"
           }.freeze
 
+          attr_reader :additional_headers
+
+          def initialize(open_timeout: nil, read_timeout: nil)
+            @open_timeout = open_timeout
+            @read_timeout = read_timeout
+            @additional_headers = {}
+          end
+
           # Update <code>server_url</code> provided when ruby_lib _core created a default http client.
           # Set <code>@http</code> as nil to re-create http client for the <code>server_url</code>
           #
@@ -65,19 +81,20 @@ module Appium
           def call(verb, url, command_hash)
             url      = server_url.merge(url) unless url.is_a?(URI)
             headers  = DEFAULT_HEADERS.dup
+            headers  = headers.merge @additional_headers unless @additional_headers.empty?
             headers['Cache-Control'] = 'no-cache' if verb == :get
 
             if command_hash
               payload                   = JSON.generate(command_hash)
               headers['Content-Length'] = payload.bytesize.to_s if [:post, :put].include?(verb)
-
-              ::Appium::Logger.info("   >>> #{url} | #{payload}")
-              ::Appium::Logger.debug("     > #{headers.inspect}")
             elsif verb == :post
               payload = '{}'
               headers['Content-Length'] = '2'
             end
 
+            ::Appium::Logger.info("   >>> #{url} | #{payload}")
+            ::Appium::Logger.info("     > #{headers.inspect}")
+
             request verb, url, headers, payload
           end
         end

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

@@ -135,8 +135,6 @@ module Appium
           by = _set_by_from_finders(how)
           begin
             bridge.find_element_by by, what.to_s, ref
-          rescue Selenium::WebDriver::Error::TimeOutError # will deprecate
-            raise Selenium::WebDriver::Error::NoSuchElementError
           rescue Selenium::WebDriver::Error::TimeoutError
             raise Selenium::WebDriver::Error::NoSuchElementError
           end
@@ -152,8 +150,6 @@ module Appium
           by = _set_by_from_finders(how)
           begin
             bridge.find_elements_by by, what.to_s, ref
-          rescue Selenium::WebDriver::Error::TimeOutError # will deprecate
-            []
           rescue Selenium::WebDriver::Error::TimeoutError
             []
           end

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

@@ -94,7 +94,10 @@ module Appium
         gsm_voice:                  [:post, 'session/:session_id/appium/device/gsm_voice'],
         set_network_speed:          [:post, 'session/:session_id/appium/device/network_speed'],
         set_power_capacity:         [:post, 'session/:session_id/appium/device/power_capacity'],
-        set_power_ac:               [:post, 'session/:session_id/appium/device/power_ac']
+        set_power_ac:               [:post, 'session/:session_id/appium/device/power_ac'],
+
+        # For chromium: https://chromium.googlesource.com/chromium/src/+/master/chrome/test/chromedriver/server/http_handler.cc
+        chrome_send_command:        [:post, 'session/:session_id/goog/cdp/execute']
       }.freeze
 
       COMMAND_IOS = {

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

@@ -25,7 +25,8 @@ module Appium
 
           METHOD = %w(POST PUT).freeze
 
-          def initialize(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil)
+          def initialize(remote_path: nil, user: nil, pass: nil, method: 'PUT',
+                         file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil)
             @upload_option = if remote_path.nil?
                                {}
                              else
@@ -36,6 +37,9 @@ module Appium
                                option[:user] = user unless user.nil?
                                option[:pass] = pass unless pass.nil?
                                option[:method] = method
+                               option[:fileFieldName] = file_field_name unless file_field_name.nil?
+                               option[:formFields] = form_fields unless form_fields.nil?
+                               option[:headers] = headers unless headers.nil?
                                option
                              end
 
@@ -47,9 +51,11 @@ module Appium
           end
 
           module Command
-            def stop_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT')
+            def stop_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT',
+                                      file_field_name: nil, form_fields: nil, headers: nil)
               option = ::Appium::Core::Base::Device::ScreenRecord.new(
-                remote_path: remote_path, user: user, pass: pass, method: method
+                remote_path: remote_path, user: user, pass: pass, method: method,
+                file_field_name: file_field_name, form_fields: form_fields, headers: headers
               ).upload_option
 
               params = option.empty? ? {} : { options: option }

data/lib/appium_lib_core/device.rb

@@ -40,7 +40,7 @@ module Appium
             :stop_recording_screen, :stop_and_save_recording_screen,
             :shake, :device_time,
             :touch_actions, :multi_touch,
-            :execute_driver
+            :execute_driver, :execute_cdp
           ].each(&method(:delegate_from_appium_driver))
         end
 

data/lib/appium_lib_core/driver.rb

@@ -34,11 +34,12 @@ module Appium
     class Options
       attr_reader :custom_url, :default_wait, :export_session, :export_session_path,
                   :port, :wait_timeout, :wait_interval, :listener,
-                  :direct_connect
+                  :direct_connect, :enable_idempotency_header
 
       def initialize(appium_lib_opts)
         @custom_url = appium_lib_opts.fetch :server_url, nil
         @default_wait = appium_lib_opts.fetch :wait, Driver::DEFAULT_IMPLICIT_WAIT
+        @enable_idempotency_header = appium_lib_opts.fetch :enable_idempotency_header, true
 
         # bump current session id into a particular file
         @export_session = appium_lib_opts.fetch :export_session, false
@@ -104,6 +105,13 @@ module Appium
       # @return [Appium::Core::Base::Http::Default] the http client
       attr_reader :http_client
 
+      # Return if adding 'x-idempotency-key' header is enabled for each new session request.
+      # Following commands should not have the key.
+      # The key is unique for each http client instance. Defaults to <code>true</code>
+      # https://github.com/appium/appium-base-driver/pull/400
+      # @return [Bool]
+      attr_reader :enable_idempotency_header
+
       # Device type to request from the appium server
       # @return [Symbol] :android and :ios, for example
       attr_reader :device
@@ -114,11 +122,11 @@ module Appium
       attr_reader :automation_name
 
       # Custom URL for the selenium server. If set this attribute, ruby_lib_core try to handshake to the custom url.<br>
-      # Defaults to false. Then try to connect to <code>http://127.0.0.1:#{port}/wd/hub<code>.
+      # Defaults to false. Then try to connect to <code>http://127.0.0.1:#{port}/wd/hub</code>.
       # @return [String]
       attr_reader :custom_url
 
-      # Export session id to textfile in /tmp for 3rd party tools. False bu default.
+      # Export session id to textfile in /tmp for 3rd party tools. False by default.
       # @return [Boolean]
       attr_reader :export_session
       # @return [String] By default, session id is exported in '/tmp/appium_lib_session'
@@ -174,7 +182,9 @@ module Appium
 
       # Creates a new driver and extend particular methods
       # @param [Hash] opts A options include capabilities for the Appium Server and for the client.
-      # @option opts [Hash] :caps Appium capabilities. Prior than :desired_capabilities
+      # @option opts [Hash] :caps Appium capabilities.
+      # @option opts [Hash] :capabilities The same as :caps.
+      #                                   This param is for compatibility with Selenium WebDriver format
       # @option opts [Hash] :desired_capabilities The same as :caps.
       #                                           This param is for compatibility with Selenium WebDriver format
       # @option opts [Appium::Core::Options] :appium_lib Capabilities affect only ruby client
@@ -187,8 +197,8 @@ module Appium
       #
       #     # format 1
       #     @core = Appium::Core.for caps: {...}, appium_lib: {...}
-      #     # format 2. 'desired_capabilities:' is also available instead of 'caps:'. Either is fine.
-      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}, appium_lib: {...}
+      #     # format 2. 'capabilities:' or 'desired_capabilities:' is also available instead of 'caps:'.
+      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", capabilities: {...}, appium_lib: {...}
       #     # format 3. 'appium_lib: {...}' can be blank
       #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}
       #
@@ -218,9 +228,9 @@ module Appium
       #     @core.start_driver # Connect to 'http://127.0.0.1:8080/wd/hub' because of 'port: 8080'
       #
       #     # Start iOS driver with .zip file over HTTP
-      #     #  'desired_capabilities:' is also available instead of 'caps:'. Either is fine.
+      #     #  'desired_capabilities:' or 'capabilities:' is also available instead of 'caps:'. Either is fine.
       #     opts = {
-      #              desired_capabilities: {
+      #              capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
       #                deviceName: 'iPhone Simulator',
@@ -342,9 +352,17 @@ module Appium
                        http_client_ops: { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 })
         @custom_url ||= server_url || "http://127.0.0.1:#{@port}/wd/hub"
 
-        create_http_client http_client: http_client_ops.delete(:http_client),
-                           open_timeout: http_client_ops.delete(:open_timeout),
-                           read_timeout: http_client_ops.delete(:read_timeout)
+        @http_client = get_http_client http_client: http_client_ops.delete(:http_client),
+                                       open_timeout: http_client_ops.delete(:open_timeout),
+                                       read_timeout: http_client_ops.delete(:read_timeout)
+
+        if @enable_idempotency_header
+          if @http_client.instance_variable_defined? :@additional_headers
+            @http_client.additional_headers[Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]] = SecureRandom.uuid
+          else
+            ::Appium::Logger.warn 'No additional_headers attribute in this http client instance'
+          end
+        end
 
         begin
           # included https://github.com/SeleniumHQ/selenium/blob/43f8b3f66e7e01124eff6a5805269ee441f65707/rb/lib/selenium/webdriver/remote/driver.rb#L29
@@ -364,6 +382,11 @@ module Appium
           raise "ERROR: Unable to connect to Appium. Is the server running on #{@custom_url}?"
         end
 
+        if @http_client.instance_variable_defined? :@additional_headers
+          # We only need the key for a new session request. Should remove it for other following commands.
+          @http_client.additional_headers.delete Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]
+        end
+
         # If "automationName" is set only server side, this method set "automationName" attribute into @automation_name.
         # Since @automation_name is set only client side before start_driver is called.
         set_automation_name_if_nil
@@ -375,12 +398,14 @@ module Appium
 
       private
 
-      def create_http_client(http_client: nil, open_timeout: nil, read_timeout: nil)
-        @http_client = http_client || Appium::Core::Base::Http::Default.new
+      def get_http_client(http_client: nil, open_timeout: nil, read_timeout: nil)
+        client = http_client || Appium::Core::Base::Http::Default.new
 
         # open_timeout and read_timeout are explicit wait.
-        @http_client.open_timeout = open_timeout if open_timeout
-        @http_client.read_timeout = read_timeout if read_timeout
+        client.open_timeout = open_timeout if open_timeout
+        client.read_timeout = read_timeout if read_timeout
+
+        client
       end
 
       # Ignore setting default wait if the target driver has no implementation
@@ -518,7 +543,10 @@ module Appium
       def validate_keys(opts)
         flatten_ops = flatten_hash_keys(opts)
 
-        raise Error::NoCapabilityError unless opts.member?(:caps) || opts.member?(:desired_capabilities)
+        # FIXME: Remove 'desired_capabilities' in the next major Selenium update
+        unless opts.member?(:caps) || opts.member?(:capabilities) || opts.member?(:desired_capabilities)
+          raise Error::NoCapabilityError
+        end
 
         if !opts.member?(:appium_lib) && flatten_ops.member?(:appium_lib)
           raise Error::CapabilityStructureError, 'Please check the value of appium_lib in the capability'
@@ -539,7 +567,8 @@ module Appium
 
       # @private
       def get_caps(opts)
-        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:desired_capabilities] || {})
+        # FIXME: Remove 'desired_capabilities' in the next major Selenium update
+        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:capabilities] || opts[:desired_capabilities] || {})
       end
 
       # @private
@@ -570,6 +599,7 @@ module Appium
         opts = Options.new appium_lib_opts
 
         @custom_url ||= opts.custom_url # Keep existence capability if it's already provided
+        @enable_idempotency_header = opts.enable_idempotency_header
 
         @default_wait = opts.default_wait
 

data/lib/appium_lib_core/ios/xcuitest/device.rb

@@ -51,7 +51,7 @@ module Appium
           #
 
           # @since Appium 1.9.1
-          # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: nil, force_restart: nil, video_type: 'mjpeg', video_fps: nil, time_limit: '180', video_quality: 'medium', video_scale: nil, video_filters: nil, pixel_format: nil)
+          # @!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, video_type: 'mjpeg', video_fps: nil, time_limit: '180', video_quality: nil, video_scale: nil, video_filters: nil, pixel_format: 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').
@@ -68,6 +68,11 @@ module Appium
           # @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+).
@@ -91,6 +96,8 @@ module Appium
           #                             - https://www.reddit.com/r/linux4noobs/comments/671z6b/width_not_divisible_by_2_error_when_using_ffmpeg/
           # @param [String] pixel_format Output pixel format. Run +ffmpeg -pix_fmts+ to list possible values.
           #                              For Quicktime compatibility, set to "yuv420p" along with videoType: "libx264".
+          # @return [String] Base64 encoded content of the recorded media file or an empty string
+          #                  if the file has been successfully uploaded to a remote location (depends on the actual options)
           #
           # @example
           #

data/lib/appium_lib_core/ios/xcuitest/device/performance.rb

@@ -32,9 +32,11 @@ module Appium
 
               ::Appium::Core::Device.add_endpoint_method(:get_performance_record) do
                 def get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor',
-                                           remote_path: nil, user: nil, pass: nil, method: 'PUT')
+                                           remote_path: nil, user: nil, pass: nil, method: 'PUT',
+                                           file_field_name: nil, form_fields: nil, headers: nil)
                   option = ::Appium::Core::Base::Device::ScreenRecord.new(
-                    remote_path: remote_path, user: user, pass: pass, method: method
+                    remote_path: remote_path, user: user, pass: pass, method: method,
+                    file_field_name: file_field_name, form_fields: form_fields, headers: headers
                   ).upload_option
 
                   option[:profileName] = profile_name

data/lib/appium_lib_core/ios/xcuitest/device/screen.rb

@@ -20,18 +20,20 @@ module Appium
           module Screen
             def self.add_methods
               ::Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
-                # rubocop:disable Metrics/ParameterLists
-                def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil,
-                                           video_type: 'mjpeg', time_limit: '180', video_quality: 'medium',
+                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,
+                                           video_type: 'mjpeg', time_limit: '180', video_quality: nil,
                                            video_fps: nil, video_scale: nil, video_filters: nil, pixel_format: nil)
                   option = ::Appium::Core::Base::Device::ScreenRecord.new(
-                    remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
+                    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[:videoType] = video_type
                   option[:timeLimit] = time_limit
-                  option[:videoQuality] = video_quality
 
+                  option[:videoQuality] = video_quality unless video_quality.nil?
                   option[:videoFps] = video_fps unless video_fps.nil?
                   option[:videoScale] = video_scale unless video_scale.nil?
                   option[:videoFilters] = video_filters unless video_filters.nil?
@@ -39,7 +41,6 @@ module Appium
 
                   execute(:start_recording_screen, {}, { options: option })
                 end
-                # rubocop:enable Metrics/ParameterLists
               end
             end
           end # module Screen

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '3.6.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-03-15' unless defined? ::Appium::Core::DATE
+    VERSION = '3.10.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2020-06-09' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core/windows/device.rb

@@ -29,21 +29,8 @@ module Appium
         # This method requires FFMPEG (https://www.ffmpeg.org/download.html) to be installed and present in PATH.
         # The resulting video uses H264 codec and is ready to be played by media players built-in into web browsers.
         #
-        # @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 [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 [String] time_limit Recording time. 180 seconds is by default.
+        # @param [Boolean] force_restart Whether to stop existing recording process forcefully and start a new recording process.
+        # @param [String] time_limit Recording time. 600 seconds is by default.
         # @param [Number|String] 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. Defaults to 15.
@@ -73,6 +60,7 @@ module Appium
         # @param [String] audio_input If provided then the given audio input will be used to record the computer audio
         #                             along with the desktop video. The list of available devices could be retrieved using
         #                             +ffmpeg -list_devices true -f dshow -i dummy+ command.
+        # @return [String] Base64 encoded content of the recorded media file
         #
         # @example
         #

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

@@ -19,15 +19,11 @@ module Appium
         module Screen
           def self.add_methods
             ::Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
-              # rubocop:disable Metrics/ParameterLists
-              def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT',
-                                         force_restart: nil, time_limit: nil,
+              def start_recording_screen(force_restart: nil, time_limit: nil,
                                          fps: nil, preset: nil, video_filter: nil,
                                          capture_clicks: nil, capture_cursor: nil, audio_input: nil)
-                option = ::Appium::Core::Base::Device::ScreenRecord.new(
-                  remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
-                ).upload_option
-
+                option = {}
+                option[:forceRestart] = force_restart unless force_restart.nil?
                 option[:timeLimit] = time_limit unless time_limit.nil?
                 option[:fps] = fps unless fps.nil?
                 option[:preset] = preset unless preset.nil?
@@ -38,7 +34,6 @@ module Appium
 
                 execute(:start_recording_screen, {}, { options: option })
               end
-              # rubocop:enable Metrics/ParameterLists
             end
           end
         end # module Screen

data/release_notes.md

@@ -1,3 +1,45 @@
+#### v3.10.0 2020-06-09
+
+- [9eff959](https://github.com/appium/ruby_lib_core/commit/9eff959240effde56460c77878a24a20d047f9e9) Release 3.10.0
+- [0602e2a](https://github.com/appium/ruby_lib_core/commit/0602e2ab2b332f7db8e39b7da73707a50720fadd) feat: Remove timeout deprecated (#267)
+
+
+#### v3.9.0 2020-05-31
+
+- [f306188](https://github.com/appium/ruby_lib_core/commit/f306188102222088fbd31b0b9249c6a39ddd074f) Release 3.9.0
+- [30c6529](https://github.com/appium/ruby_lib_core/commit/30c65299e4dffb9a2cea8b7a11b27cfcba294707) ci: run with Xcode 11.5 (#265)
+- [a10f2d1](https://github.com/appium/ruby_lib_core/commit/a10f2d15ef83e9ce7003b88ec1c0923c922974ea) feat: allow :capabilities as argument (#266)
+
+
+#### v3.8.0 2020-05-17
+
+- [8986a54](https://github.com/appium/ruby_lib_core/commit/8986a5400d6a3575b7413f15bb61de09af2ec789) Release 3.8.0
+- [2379f9a](https://github.com/appium/ruby_lib_core/commit/2379f9a69b43e8c2d2b584ac1e56d3a1aea5e85b) refactor: move idempotency in driver (#264)
+- [8103619](https://github.com/appium/ruby_lib_core/commit/8103619313328064df516e7094e2c8a6e1e9719c) fix: x-idempotency-key only for a new session (#263)
+- [971f912](https://github.com/appium/ruby_lib_core/commit/971f912a6b4d8e28896d146939c9e5b86dd4b1e0) feat: Add options for start_recording_screen (#261)
+- [11f840a](https://github.com/appium/ruby_lib_core/commit/11f840a2945b0376bb3ad762e9b2eefd0aace3b4) ci: add wait
+- [4931f4e](https://github.com/appium/ruby_lib_core/commit/4931f4e318e94f9253edd649757f5c774c3404a7) ci: tweak flaky case
+- [cb6ef1a](https://github.com/appium/ruby_lib_core/commit/cb6ef1a74dae7200952630076dd58af6bb9500ec) Merge branch 'master' of github.com:appium/ruby_lib_core
+- [9117de2](https://github.com/appium/ruby_lib_core/commit/9117de2674f018cfe8e10d9dadc188af846e6be4) ci: relax tests for uia2
+
+
+#### v3.7.0 2020-04-18
+
+- [5ffe630](https://github.com/appium/ruby_lib_core/commit/5ffe630e670943c6f6f60c0e331cdab4685e31c7) Release 3.7.0
+- [e561c8d](https://github.com/appium/ruby_lib_core/commit/e561c8db5b00f1132391f8ea79133c295d39a90b) feat: Add chrome devtools endpoints (#260)
+- [73cf85f](https://github.com/appium/ruby_lib_core/commit/73cf85fd6ab5bdfb9df7833a713b8d4df3e51a70) test: add w3c send_keys action
+- [b1c36fa](https://github.com/appium/ruby_lib_core/commit/b1c36fa538c145326dc50f49ab4d738478e5e0ac) fix typo
+- [350ba7b](https://github.com/appium/ruby_lib_core/commit/350ba7bdafd567dabc9bd54ab1476740c6f54a20) feat: Add x idempotency header (#259)
+- [94f16d8](https://github.com/appium/ruby_lib_core/commit/94f16d83909a2fb6111d281a00c0b911a00bb23c) ci: bump to Xcode 11.4 and iOS 13.4 (#257)
+- [53b7191](https://github.com/appium/ruby_lib_core/commit/53b7191b89e61d11b06628d710a13dac5ca9dfaf) ci: add -accel auto
+
+
+#### v3.6.1 2020-03-16
+
+- [46a2277](https://github.com/appium/ruby_lib_core/commit/46a2277e792cc583c9978db3ebd548bfee343942) Release 3.6.1
+- [2e28b32](https://github.com/appium/ruby_lib_core/commit/2e28b3205e83358e0aaba79d844c30ac7e29917d) fix: Tweak screen option (#256)
+
+
 #### v3.6.0 2020-03-15
 
 - [260d45e](https://github.com/appium/ruby_lib_core/commit/260d45e28a36e99e3dedbe8d41e2703c4d3fbdc8) Release 3.6.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -339,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Minimal Ruby library for Appium.