appium_lib_core 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16c3547b36730999941512edcad25073f99425d0312d71fa5fa6e487e3790cd3
-  data.tar.gz: b65e1f458ff358048c71772478e328afe6b1b88fba047928e78b98463be1eaad
+  metadata.gz: b87c76f4273480fb8a37f7e16f739dced62732a86b673c4ae36fed4f38035329
+  data.tar.gz: 421040d807e1d4cd33b12d0a42ccb7ab905643a9dcd4ccb67706d8386e52b337
 SHA512:
-  metadata.gz: ab6ec325103678537790277605a17796adf96469223057f2ca7444a1335155d7c09b68a6dc4a78e5c326d28564cc5e212363e7099a6f40604cbe64e82528bf84
-  data.tar.gz: 8bf9ea9236f5de5b6cd8c0d5a432f49a31a54b44c408d48a9eaca2e28f1347f47f0e6bcf927ef3085d8f8c4775d7e0077d11d68775ae221d729ab20f7ec6be12
+  metadata.gz: 892368e156ca5145207d9c01bedb55355df22e22d6a653fb0a646b3b357c0677008c8d897bfe5775b725ce89a71b4ae29ec53d93827001b75451a0239a9761c6
+  data.tar.gz: 3736d593e1b450530f269b15c74d9e22730c0ce69a99c40f4df243d87591ba724efa42262b03012cd67f70174e9e621b483f0f0539c228849d080fc68b925af5

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,6 +10,17 @@ Read `release_notes.md` for commit level details.
 
 ### 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

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+).

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

@@ -34,17 +34,12 @@ module Appium
               "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common::DEFAULT_HEADERS['User-Agent']})"
           }.freeze
 
-          attr_accessor :additional_headers
+          attr_reader :additional_headers
 
-          def initialize(open_timeout: nil, read_timeout: nil, enable_idempotency_header: true)
+          def initialize(open_timeout: nil, read_timeout: nil)
             @open_timeout = open_timeout
             @read_timeout = read_timeout
-
-            @additional_headers = if enable_idempotency_header
-                                    { RequestHeaders::KEYS[:idempotency] => SecureRandom.uuid }
-                                  else
-                                    {}
-                                  end
+            @additional_headers = {}
           end
 
           # Update <code>server_url</code> provided when ruby_lib _core created a default http client.

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/driver.rb

@@ -105,7 +105,8 @@ module Appium
       # @return [Appium::Core::Base::Http::Default] the http client
       attr_reader :http_client
 
-      # Return if adding 'x-idempotency-key' header is each request.
+      # 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]
@@ -349,9 +350,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
@@ -371,6 +380,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
@@ -382,14 +396,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(
-          enable_idempotency_header: @enable_idempotency_header
-        )
+      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

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+).

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.7.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-04-18' unless defined? ::Appium::Core::DATE
+    VERSION = '3.8.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2020-05-17' unless defined? ::Appium::Core::DATE
   end
 end

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

@@ -19,7 +19,6 @@ 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(force_restart: nil, time_limit: nil,
                                          fps: nil, preset: nil, video_filter: nil,
                                          capture_clicks: nil, capture_cursor: nil, audio_input: nil)
@@ -35,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,15 @@
+#### 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-18 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver