appium_lib_core 3.6.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1011b8828b2d0dca338df3813ecb9f4b5e43464cff713c23b5a3c144a6ccdeba
-  data.tar.gz: b120ea9cae3e309ea11b00f9a87861db272aa4c3bd422e184f9b7ac4e01c84d3
+  metadata.gz: 16c3547b36730999941512edcad25073f99425d0312d71fa5fa6e487e3790cd3
+  data.tar.gz: b65e1f458ff358048c71772478e328afe6b1b88fba047928e78b98463be1eaad
 SHA512:
-  metadata.gz: 7c0abe1f60c93f5c32d3ed9597180c863e52dc3ddc3b1277ddcec37e07b872f679cd7f4f6f7cd14c16724f4664e38ca2d18ac598c9773241bcd3cbf83ffe33b5
-  data.tar.gz: 19d0aa306e8a1956365cda6fe589a2d3e4ebca3a5fe62b69c1fa9702d85b7389dacaadb26d24500b73c00d1462bf46a0eff53aa853621221dacf814862810e2c
+  metadata.gz: ab6ec325103678537790277605a17796adf96469223057f2ca7444a1335155d7c09b68a6dc4a78e5c326d28564cc5e212363e7099a6f40604cbe64e82528bf84
+  data.tar.gz: 8bf9ea9236f5de5b6cd8c0d5a432f49a31a54b44c408d48a9eaca2e28f1347f47f0e6bcf927ef3085d8f8c4775d7e0077d11d68775ae221d729ab20f7ec6be12

data/CHANGELOG.md

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

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.4
+  xcodeForTVOS: 11.4
   androidSDK: 29
   appiumVersion: 'beta'
   ignoreVersionSkip: true

data/lib/appium_lib_core/android/device.rb

@@ -285,6 +285,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
         ####
@@ -393,6 +406,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/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,19 @@ module Appium
               "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common::DEFAULT_HEADERS['User-Agent']})"
           }.freeze
 
+          attr_accessor :additional_headers
+
+          def initialize(open_timeout: nil, read_timeout: nil, enable_idempotency_header: true)
+            @open_timeout = open_timeout
+            @read_timeout = read_timeout
+
+            @additional_headers = if enable_idempotency_header
+                                    { RequestHeaders::KEYS[:idempotency] => SecureRandom.uuid }
+                                  else
+                                    {}
+                                  end
+          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 +86,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/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/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,12 @@ 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.
+      # 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 +121,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'
@@ -376,7 +383,9 @@ 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
+        @http_client = http_client || Appium::Core::Base::Http::Default.new(
+          enable_idempotency_header: @enable_idempotency_header
+        )
 
         # open_timeout and read_timeout are explicit wait.
         @http_client.open_timeout = open_timeout if open_timeout
@@ -570,6 +579,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/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '3.6.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-03-16' unless defined? ::Appium::Core::DATE
+    VERSION = '3.7.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2020-04-18' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,14 @@
+#### 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-04-18 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.