appium_lib_core 4.1.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5328494c785b852424a9ba61e627ed78c54c4bca6baf2643f16a647f4edfcf22
-  data.tar.gz: 130869ab5ca0d2967f98b5beed348d3e31bb7c90eb5219da60f2d8f973e8a381
+  metadata.gz: a3f77d23abb2c69ab5b4f5f733a9b901002f8d5fe24e8b99ad8ef03df1dcad99
+  data.tar.gz: 7acc05e37be676c753e2c0d7519c9882d13eb55bdef32678dd3b44458120e487
 SHA512:
-  metadata.gz: 48aae8b8e934edac9f178cc365825605fc40c7ff63a36e8e7cfe7baf7c815ec89dfecf60350dff401dcfdac80f1e892c86022659b65fc7000c55f7e4fa3b0243
-  data.tar.gz: 4cc0a6c8eb8b1258a6e7df79666ed4dd21cf3f6cae8c613fd5e3a34a11f15f7614151f296931205bc55d2c817cef298d682e6eb6dc95fb3ee826a864d39350f2
+  metadata.gz: 3ea82009235de78bedd7a03e4de1021fed4fcb5a21a878697fe4b3dde281d1d36976a2cc6e63dc5d2735cabbe8328f49de3d06f1568ffc48eebbb80144c69d5a
+  data.tar.gz: 4bee50ff9e195d09b634a3ff7420d04ca1ab896d26d9523a40f20ae2db7c6d2d4b81450dee4f2b0e225599e9e1a774c0e5cb19acc6d89bfeb01bd859caecfe6e

data/CHANGELOG.md

@@ -5,69 +5,59 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
-- Ruby 3.0 support
 
 ### Bug fixes
 
 ### Deprecations
 
-## [4.1.0] - 2020-12-25
+## [4.2.1] - 2021-01-10
 
 ### Enhancements
-- Ruby 3.0 support
+- Refactor routable
 
-### Bug fixes
-
-### Deprecations
+## [4.2.0] - 2021-01-02
 
-## [4.0.0] - 2020-12-19
+### Enhancements
+- Add  `Element#screenshot`, `Element#screenshot_as` and `Element#save_screenshot` in Element module
+    - `Element#screenshot_as` and `Element#save_screenshot` are same as `Driver#element_screenshot_as` and `Driver#save_element_screenshot`
+    - `Element#screenshot` is same as `Element#screenshot_as(:base64)`
 
-Supported Ruby version is 2.4+
+## [4.1.1] - 2020-12-25
 
 ### Enhancements
+- Ruby 3.0 support
+    - Arguments in `@driver.execute_cdp`
+        - It should be like `@driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'` as keyword arguments
+          instead of `@driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }` in Ruby 3
 
-### Bug fixes
+## [4.0.0] - 2020-12-19
+
+Supported Ruby version is 2.4+
 
 ### Deprecations
 - No longer work with `forceMjsonwp` capability to force the session MJSONWP
 
 ## [3.11.1] - 2020-11-20
 
-### Enhancements
-
 ### Bug fixes
 - Fix `install_app` to be able to set no args for options
 
-### Deprecations
-
 ## [3.11.0] - 2020-08-01
 
 ### Enhancements
 - Security update [GHSA-2v5c-755p-p4gv](https://github.com/advisories/GHSA-2v5c-755p-p4gv)
     - Affects only _::Appium::Core::WebSocket_
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.10.1] - 2020-06-29
 
-### Enhancements
-
 ### Bug fixes
 - Fix duplication warning of `execute_cdp`
 
-### Deprecations
-
 ## [3.10.0] - 2020-06-09
 
 ### Enhancements
 - Remove deprecated `Selenium::WebDriver::Error::TimeOutError`
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.9.0] - 2020-05-31
 
 ### Enhancements
@@ -86,10 +76,6 @@ Supported Ruby version is 2.4+
     @driver = Appium::Core.for(opts).start_driver
     ```
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.8.0] - 2020-05-17
 
 ### Enhancements
@@ -99,8 +85,6 @@ Supported Ruby version is 2.4+
 ### 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
@@ -109,76 +93,44 @@ Supported Ruby version is 2.4+
 - 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)
     - `#start_recording_screen`, `#stop_recording_screen`
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.5.0] - 2020-01-11
 
 ### Enhancements
 - Add `:viewmatcher` selector like `@driver.find_elements :view_matcher, { name: 'withText', args: %w(Accessibility), class: 'androidx.test.espresso.matcher.ViewMatchers' }`
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.4.2] - 2019-12-29
 
 ### Enhancements
 - Add `attr_reader :bridge` for flutter driver not to use `send`
    - https://github.com/truongsinh/appium-flutter-driver/pull/35
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.4.0, 3.4.1] - 2019-12-26, 2019-12-27
 
 ### Enhancements
 - Fix Ruby 2.7 warnings
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.3.0] - 2019-11-08
 
 ### Enhancements
 - Add `Logs#event` to post a custom log by `@driver.logs.event vendor: 'appium', event: 'funEvent'`
 - Add `Logs#events` to get events by `@driver.logs.events`. It is equal to  `@driver.session_capabilities['events']`
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.2.3] - 2019-09-30
 
 ### Enhancements
 - Add `system_bars` as an alias to `get_system_bars`
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.2.2] - 2019-08-04
 
-### Enhancements
-
 ### Bug fixes
 - Fixed parameters of `remove_app`
 
-### Deprecations
-
 ## [3.2.1] - 2019-07-19
 
 ### Enhancements
@@ -200,39 +152,23 @@ Supported Ruby version is 2.4+
 - Add `execute_driver` to run a batch script
     - It requires Appium version which has `execute_driver` support
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.1.3] - 2019-06-18
 
 ### Enhancements
 - Add arguments for `start_activity`
     - `intentAction`, `intentCategory`, `intentFlags`, `dontStopAppOnReset`
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.1.2] - 2019-05-10
 
 ### Enhancements
 - Add `sessions` command to get all available sessions on the Appium server
 - [internal] Tweak error messages in emulator module
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.1.1] - 2019-04-26
 
 ### Enhancements
 - [internal] Catch `Selenium::WebDriver::Error::TimeoutError` which will be used instead of `Selenium::WebDriver::Error::TimeOutError`
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.1.0] - 2019-03-31
 
 ### Enhancements
@@ -240,28 +176,16 @@ Supported Ruby version is 2.4+
     - `platformName: :tvos, automationName: :xcuitest` can work for iOS tvOS
     - It requires Appium 1.13
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.0.4] - 2019-03-24
 
 ### Enhancements
 - Add `pixelFormat` argument in screen record for iOS
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.0.3] - 2019-03-11
 
 ### Enhancements
 - [internal] Bump Rubocop target Ruby version to Ruby 2.3
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.0.2] - 2019-03-07
 
 ### Enhancements
@@ -271,17 +195,11 @@ Supported Ruby version is 2.4+
 - [internal] Fixed typo in `Emulator#gsm_signal` [#196](https://github.com/appium/ruby_lib_core/pull/196)
     - Thanks [khanhdodang](https://github.com/khanhdodang)
 
-### Deprecations
-
 ## [3.0.1] - 2019-02-25
 
 ### Enhancements
 - Add `:data_matcher` find_element/s attribute [appium-espresso-driver#386](https://github.com/appium/appium-espresso-driver/pull/386)
 
-### Bug fixes
-
-### Deprecations
-
 ## [3.0.0] - 2019-02-06
 
 This release has a breaking change about an implicit wait.
@@ -307,8 +225,6 @@ The behaviour follows the default spec in WebDriver.
 ### Bug fixes
 - Fix potential override of `AppManagement#background_app` [#188](https://github.com/appium/ruby_lib_core/pull/188)
 
-### Deprecations
-
 ## [2.3.4] - 2019-01-31
 ### Enhancements
 - Add 3D touch option for `TouchAction#press` [appium/WebDriverAgent#79](https://github.com/appium/WebDriverAgent/pull/79)
@@ -317,16 +233,10 @@ The behaviour follows the default spec in WebDriver.
 ### Bug fixes
 - Stop sending blank value in `start_activity`
 
-### Deprecations
-
 ## [2.3.3] - 2019-01-22
-### Enhancements
-
 ### Bug fixes
 - Add `*args, &block` in method missing in `Selenium::WebDriver::Element` [#184](https://github.com/appium/ruby_lib_core/pull/184)
 
-### Deprecations
-
 ## [2.3.2] - 2019-01-20
 ### Enhancements
 - Add alias for some method calls
@@ -337,18 +247,12 @@ The behaviour follows the default spec in WebDriver.
 ### Bug fixes
 -  `ServerError` inherits `CoreError` in order to handle it as an exception
 
-### Deprecations
-
 ## [2.3.1] - 2019-01-13
 ### Enhancements
 - `set_network_connection` accepts keys as same as `network_connection_type` in addition to numbers
     - `{ :airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0 }`
     - Read [documentation](https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device#set_network_connection-instance_method) more
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.3.0] - 2019-01-07
 ### Enhancements
 - Use `Base64.strict_encode64` when this client sends `Base64` encoded data to server
@@ -356,33 +260,19 @@ The behaviour follows the default spec in WebDriver.
     - Continues to decode base 64 data following `decode64` to accept RFC 2045 format
 - Add `query_app_state` as an alias of `app_state` to get application status
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.2.2] - 2018-12-22
 ### Enhancements
 - Append `appium` in header: `appium/ruby_lib_core/2.2.1 (selenium/3.141.0 (ruby macosx))`
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.2.1] - 2018-12-08
-### Enhancements
-
 ### Bug fixes
 - Reduce warnings for method definitions
 
-### Deprecations
-
 ## [2.2.0] - 2018-12-01
 ### Enhancements
 - Add `::Appium::Core::Base.platform` to call `::Selenium::WebDriver::Platform`
     - Can identify platform using `::Appium::Core::Base.platform.windows?` for example
 
-### Bug fixes
-
 ### Deprecations
 - `:offset_x` and `:offset_y` in `TouchAction#swipe` is deprecated in favor of `:end_x` and `:end_y`
 
@@ -401,10 +291,6 @@ The behaviour follows the default spec in WebDriver.
 - Update `start_recording_screen` for iOS, Appium 1.10.0
     - Add `:video_scale` and update `:video_type`
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.1.0] - 2018-11-14
 ### Enhancements
 - Support below style _1_, has _url_ parameter, in addition to style _2_
@@ -417,27 +303,15 @@ The behaviour follows the default spec in WebDriver.
     ```
 - Add `:video_fps` param for screen recording in iOS(XCUITest) to sync with Appium 1.10.0
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.0.6] - 2018-11-08
 ### Enhancements
 - Allow selenium update following Pi versioning like 3.141.0
 - [internal] Update dev libraries
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.0.5] - 2018-10-30
 ### Enhancements
 - [internal] No longer send `strategy: :tapOutside` as default value in Android
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.0.4] - 2018-10-19
 ### Enhancements
 - Add custom locator in the future work: [element-finding-plugins](https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/element-finding-plugins.md)
@@ -447,27 +321,15 @@ The behaviour follows the default spec in WebDriver.
 
     ```
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.0.3] - 2018-10-11
 ### Enhancements
 - Set `'selenium-webdriver', '~> 3.14.1'`
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.0.2] - 2018-10-02
 ### Enhancements
 - Add finger print feature for Android emulators [#13](https://github.com/appium/ruby_lib_core/issues/13)
 - Add `keyboard_shown?` and `context=` as aliases of `is_keyboard_shown` and `set_contex`
 
-### Bug fixes
-
-### Deprecations
-
 ## [2.0.1] - 2018-09-01
 ### Enhancements
 - Add `Appium::Core::Base::Driver#perform_actions` to send multiple actions. See `test_multiple_actions` as an example.
@@ -475,8 +337,6 @@ The behaviour follows the default spec in WebDriver.
 ### Bug fixes
 - Fix desired capability for W3C protocol under selenium grid environment [#137](https://github.com/appium/ruby_lib_core/issues/137)
 
-### Deprecations
-
 ## [2.0.0] - 2018-08-25
 
 This release has a breaking change for creating core. Thus, I've bumped the major version.
@@ -484,20 +344,14 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Enhancements
 - use `autoload` to load Android/iOS modules
 
-### Bug fixes
-
 ### Deprecations
 - `@core = Appium::Core.for(self, opts)` is deprecated in favor of `@core = Appium::Core.for(opts)`
     - Call `extend Appium::Core::Device` if you'd like to extend methods defined in `Appium::Core`
         - Read [#816](https://github.com/appium/ruby_lib/pull/816) as an example
 
 ## [1.9.2] - 2018-08-23
-### Enhancements
-
 ### Bug fixes
-- fix unexpedted method missing against `:to_hash` in Element
-
-### Deprecations
+- fix unexpected method missing against `:to_hash` in Element
 
 ## [1.9.1] - 2018-08-20
 ### Enhancements
@@ -507,8 +361,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Bug fixes
 - [internal] Fix raising error in `set_implicit_wait_by_default` [#130](https://github.com/appium/ruby_lib_core/issues/130)
 
-### Deprecations
-
 ## [1.9.0] - 2018-08-05
 ### Enhancements
 - Update documentation about `start_recording_screen`
@@ -516,8 +368,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 - Support `find_element/s :image, partial_image` [#119](https://github.com/appium/ruby_lib_core/pull/119)
 - Requires `selenium-webdriver 3.14+` because of W3C actions [#115](https://github.com/appium/ruby_lib_core/pull/115)
 
-### Bug fixes
-
 ### Deprecations
 - [Internal] Deprecate experimental `ImageElement` in favor of `Element`
 
@@ -527,10 +377,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 - Use method missing to get attributes like `e.resource_id` instead of `e.attribute 'resource-id'` [#116](https://github.com/appium/ruby_lib_core/pull/116)
 - Set `'~> 3.5', '< 3.14'`
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.8.3] - 2018-07-20
 ### Enhancements
 - Relax the logic of `:app` capability
@@ -538,11 +384,7 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Bug fixes
 - Fix `within_context`
 
-### Deprecations
-
 ## [1.8.2] - 2018-07-17
-### Enhancements
-
 ### Bug fixes
 - Available packages over HTTP [#106](https://github.com/appium/ruby_lib_core/issues/106)
 
@@ -550,23 +392,15 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 - Remove warning of camelCase capability for W3C format
 
 ## [1.8.1] - 2018-07-13
-### Enhancements
-
 ### Bug fixes
 - Fix including search context in `::Selenium::WebDriver::Elemenet`
     - `include ::Appium::Core::Base::SearchContext` instead of `::Selenium::WebDriver::SearchContext`
 
-### Deprecations
-
 ## [1.8.0] - 2018-07-07
 ### Enhancements
 - Add Tizen case
 - [Internal] reduce method definition by `add_endpoint_method`
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.7.2] - 2018-06-23
 ### Enhancements
 - Add `find_element_by_image` and `find_elements_by_image` to handle `ImageElement`
@@ -575,10 +409,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
    - Experimental feature
 - [Internal] Define screenshot methods in appium_lib_core instead of Selenium's one
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.7.1] - 2018-06-15
 ### Enhancements
 - Add a `format` argument for `device_time` [#94](https://github.com/appium/ruby_lib_core/pull/94)
@@ -586,8 +416,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Bug fixes
 - Return empty array `[]` for find_elements
 
-### Deprecations
-
 ## [1.7.0] - 2018-05-28
 ### Enhancements
 - Has one **Breaking Change**
@@ -600,10 +428,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 - [Internal] Change directory and file structure
 - [Internal] Set default content-type
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.6.0] - 2018-05-08
 ### Enhancements
 - **Breaking Change**
@@ -615,36 +439,22 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 - add `battery_info` to get battery information
 - add `is_keyboard_shown` for iOS ( see also https://github.com/appium/appium-xcuitest-driver/pull/664/files )
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.5.1] - 2018-04-25
-### Enhancements
-
 ### Bug fixes
 - Revert timeout logic in `1.4.1`
 
-### Deprecations
-
 ## [1.5.0] - 2018-04-25
 ### Enhancements
 - [internal] Remove hot fix for XCUITest action
 
-### Bug fixes
-
 ### Deprecations
 - Changed the name of arguments
     - `swipe(start_x:, start_y:, end_x:, end_y:)` instead of `swipe(start_x:, start_y:, offset_x:, offset_y:)`
 
 ## [1.4.2] - 2018-04-22
-### Enhancements
-
 ### Bug fixes
 - Revert `delegate_from_appium_driver` for `ruby_lib` compatibility
 
-### Deprecations
-
 ## [1.4.1] - 2018-04-22
 ### Enhancements
 - add base image comparison
@@ -653,54 +463,30 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
     - Raise `::Appium::Core::Wait::TimeoutError` instead of `::Selenium::WebDriver::Error::TimeOutError`
 - [internal] Separate mjsonwp commands module and w3c commands module from one command module
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.4.0] - 2018-04-15
 ### Enhancements
 - Add a support for WebSocket client based on Faye::WebSocket::Client [#74](https://github.com/appium/ruby_lib_core/pull/74)
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.8] - 2018-04-12
 ### Enhancements
 - Make no-argument commands friendly for IDE
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.7] - 2018-04-02
 ### Enhancements
 - Only for `ruby_lib_core` internal process
     - Remove `touch` action by default and following `selenium-webdriver` in W3C action.
         - Since XCUITest and UA2 drivers force handling the pointer as `touch`.
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.6] - 2018-04-01
 ### Enhancements
 - Be able to change `kind` in W3C touch action.
     - Read: https://github.com/appium/ruby_lib_core/blob/master/lib/appium_lib_core/common/base/bridge/w3c.rb#L29
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.5] - 2018-03-30
 ### Enhancements
 - Add a `bug_report` option in `start_recording_screen`, Android
 - Add clipboard apis [#69](https://github.com/appium/ruby_lib_core/pull/69)
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.4] - 2018-03-21
 ### Enhancements
 - Add `save_viewport_screenshot` which get screenshot except for status bar.
@@ -710,16 +496,10 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Bug fixes
 - Fix _create_session attempt to throw non-existent error type Appium::Core::Error::WebDriverError_ [#66](https://github.com/appium/ruby_lib_core/issues/66)
 
-### Deprecations
-
 ## [1.3.3] - 2018-03-03
 ### Enhancements
 - add `session_capabilities`: https://appium.io/docs/en/commands/session/get/
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.2] - 2018-02-18
 ### Enhancements
 - Add Android emulator commands
@@ -727,10 +507,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 - Add toggles
     - `toggle_location_services`, `toggle_wifi`, `toggle_data`
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.1] - 2018-02-14
 ### Enhancements
 - add some app management commands [#58](https://github.com/appium/ruby_lib_core/pull/58)
@@ -752,10 +528,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
               .perform
             ```
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.3.0] - 2018-01-28
 ### Enhancements
 - `start_recording_screen`/`stop_recording_screen` support iOS from `Appium 1.8.0` [#48](https://github.com/appium/ruby_lib_core/issues/48)
@@ -763,10 +535,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
         - `start_recording_screen`
             - The argument, `file_path`, was removed.
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.2.7] - 2018-01-25
 ### Enhancements
 - Print warning messages to use camelCase if capability key names are snake_case
@@ -775,8 +543,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Bug fixes
 - Make `@driver.automation_name` downcase [#50](https://github.com/appium/ruby_lib_core/issues/50)
 
-### Deprecations
-
 ## [1.2.6] - 2018-01-21
 ### Enhancements
 - Add `window_rect`
@@ -784,17 +550,11 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Bug fixes
 - Make `@driver.automation_name` symbol when someone define the `automationName` with the server argument. [#50](https://github.com/appium/ruby_lib_core/issues/50)
 
-### Deprecations
-
 ## [1.2.5] - 2018-01-13
 ### Enhancements
 - Enhance W3C support
     - Timeout related methods
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.2.4] - 2018-01-03
 ### Enhancements
 - Refactor `create_session` in `Appium::Core::Base::Bridge`
@@ -806,34 +566,18 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
     - Read `lib/appium_lib_core/common/base/w3c_bridge.rb` for more details
 - Can get logs like `driver.logs.available_types` and `driver.logs.get`
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.2.3] - 2017-12-27
-### Enhancements
-
 ### Bug fixes
 - Fix some w3c methods to work with Appium part 2 [#38](https://github.com/appium/ruby_lib_core/pull/38)
 
-### Deprecations
-
 ## [1.2.2] - 2017-12-25
-### Enhancements
-
 ### Bug fixes
 - Fix some w3c methods to work with Appium [#37](https://github.com/appium/ruby_lib_core/pull/37)
 
-### Deprecations
-
 ## [1.2.1] - 2017-12-23
 ### Enhancements
 - override default duration to make some action fast [#36](https://github.com/appium/ruby_lib_core/pull/36)
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.2.0] - 2017-12-23
 ### Enhancements
 - Append `appium:` prefix for capabilities automatically due to W3C format.
@@ -842,10 +586,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
     - IME related
     - Touch actions based on W3C spec
 
-### Bug fixes
-
-### Deprecations
-
 ## [1.1.0] - 2017-12-16
 ### Enhancements
 - Add guidelines in `.github`
@@ -854,8 +594,6 @@ This release has a breaking change for creating core. Thus, I've bumped the majo
 ### Bug fixes
 - fix creating sessions [#31](https://github.com/appium/ruby_lib_core/pull/31) for W3C creating sessions
 
-### Deprecations
-
 ## [1.0.0] - 2017-11-12
 
 Initial release

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.7.0'
+  spec.add_development_dependency 'rubocop', '1.8.0'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/lib/appium_lib_core/android/device.rb

@@ -290,16 +290,16 @@ module Appium
         #   @driver.finger_print 1
         #
 
-        # @!method execute_cdp(cmd, params)
+        # @!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.
+        # @option params The parameter for the command as keyword options.
         #
         # @example
         #
-        #   @driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }
+        #   @driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'
         #   @driver.execute_cdp 'Page.getResourceTree'
         #
 
@@ -415,7 +415,7 @@ module Appium
               # SeleniumWebdriver could already define this method
               return if method_defined? :execute_cdp
 
-              def execute_cdp(cmd, params = {})
+              def execute_cdp(cmd, **params)
                 execute :chrome_send_command, {}, { cmd: cmd, params: params }
               end
             end

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

@@ -32,6 +32,7 @@ module Appium
           include Device::Device
           include Device::TouchActions
           include Device::ExecuteDriver
+          include Device::Orientation
 
           def commands(command)
             ::Appium::Core::Commands::W3C::COMMANDS[command]

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

@@ -15,6 +15,7 @@
 require 'base64'
 require_relative 'search_context'
 require_relative 'screenshot'
+require_relative 'rotable'
 
 module Appium
   module Core
@@ -22,12 +23,12 @@ module Appium
       class Driver < ::Selenium::WebDriver::Driver
         include ::Selenium::WebDriver::DriverExtensions::UploadsFiles
         include ::Selenium::WebDriver::DriverExtensions::HasSessionId
-        include ::Selenium::WebDriver::DriverExtensions::Rotatable
         include ::Selenium::WebDriver::DriverExtensions::HasRemoteStatus
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
 
+        include ::Appium::Core::Base::Rotatable
         include ::Appium::Core::Base::SearchContext
-        include ::Appium::Core::Base::TakeScreenshot
+        include ::Appium::Core::Base::TakesScreenshot
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element

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

@@ -0,0 +1,54 @@
+# 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 Rotatable
+        ORIENTATIONS = %i[landscape portrait].freeze
+
+        #
+        # Change the screen orientation
+        #
+        # @param [:landscape, :portrait] orientation
+        #
+        #
+        def rotation=(orientation)
+          unless ORIENTATIONS.include?(orientation)
+            raise ArgumentError, "expected #{ORIENTATIONS.inspect}, got #{orientation.inspect}"
+          end
+
+          bridge.screen_orientation = orientation.to_s.upcase
+        end
+        alias rotate rotation=
+
+        #
+        # Get the current screen orientation
+        #
+        # @return [:landscape, :portrait] orientation
+        #
+        # @api public
+        #
+
+        def orientation
+          bridge.screen_orientation.to_sym.downcase
+        end
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@
 module Appium
   module Core
     class Base
-      module TakeScreenshot
+      module TakesScreenshot
         #
         # Save a PNG screenshot to the given path
         #

data/lib/appium_lib_core/common/base.rb

@@ -29,6 +29,7 @@ require_relative 'device/clipboard_content_type'
 require_relative 'device/device'
 require_relative 'device/touch_actions'
 require_relative 'device/execute_driver'
+require_relative 'device/orientation'
 
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'

data/lib/appium_lib_core/common/device/orientation.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
+      module Device
+        module Orientation
+          def screen_orientation=(orientation)
+            execute :set_screen_orientation, {}, { orientation: orientation }
+          end
+
+          def screen_orientation
+            execute :get_screen_orientation
+          end
+        end # module Orientation
+      end # module Device
+    end # class Base
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/patch.rb

@@ -21,6 +21,9 @@ module Appium
       # To extend Appium related SearchContext into ::Selenium::WebDriver::Element
       include ::Appium::Core::Base::SearchContext
 
+      # TODO: Probably can remove own TakesScreenshot since Selenium 4
+      include ::Appium::Core::Base::TakesScreenshot
+
       # Returns the value of attributes like below. Read each platform to know more details.
       #
       # uiautomator2: https://github.com/appium/appium-uiautomator2-server/blob/203cc7e57ce477f3cff5d95b135d1b3450a6033a/app/src/main/java/io/appium/uiautomator2/utils/Attribute.java#L19
@@ -99,6 +102,56 @@ module Appium
         w = driver.window_size
         ::Selenium::WebDriver::Point.new "#{center_x} / #{w.width.to_f}", "#{center_y} / #{w.height.to_f}"
       end
+
+      # Return an element screenshot as base64
+      #
+      # @return String Base 64 encoded string
+      #
+      # @example
+      #
+      #     element.screenshot #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
+      #
+      def screenshot
+        bridge.take_element_screenshot(self)
+      end
+
+      # Return an element screenshot in the given format
+      #
+      # @param [:base64, :png] format
+      # @return String screenshot
+      #
+      # @example
+      #
+      #     element.screenshot_as :base64 #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
+      #
+      def screenshot_as(format)
+        case format
+        when :base64
+          bridge.take_element_screenshot(self)
+        when :png
+          bridge.take_element_screenshot(self).unpack('m')[0]
+        else
+          raise Core::Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
+        end
+      end
+
+      # Save an element screenshot to the given path
+      #
+      # @param [String] png_path A path to save the screenshot
+      # @return [File] Path to the element screenshot.
+      #
+      # @example
+      #
+      #   element.save_screenshot("fine_name.png")
+      #
+      def save_screenshot(png_path)
+        extension = File.extname(png_path).downcase
+        if extension != '.png'
+          ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
+                                'It should end with .png extension'
+        end
+        File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
+      end
     end
   end # module Core
 end # module Appium

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '4.1.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-12-25' unless defined? ::Appium::Core::DATE
+    VERSION = '4.2.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-01-10' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,24 @@
+#### v4.2.1 2021-01-10
+
+- [23e944e](https://github.com/appium/ruby_lib_core/commit/23e944ed72c6ea861532f5acc1381af4441705e6) Release 4.2.1
+- [1a416b1](https://github.com/appium/ruby_lib_core/commit/1a416b136beb2b9115d3eb6637b22817f0e55601) chore: move rotable for w3c (#300)
+- [95821c6](https://github.com/appium/ruby_lib_core/commit/95821c6f1a4ebc785e2dc3e6e16c1705521237e8) ci: bump android app (#299)
+- [4e1770e](https://github.com/appium/ruby_lib_core/commit/4e1770e3b9d6995b1d5430b9033097609edca1c8) chore(deps-dev): update rubocop requirement from = 1.7.0 to = 1.8.0 (#298)
+- [b230512](https://github.com/appium/ruby_lib_core/commit/b230512c52875ea70545d3d2262c306640f87f7d) chore: fix rubocop
+
+
+#### v4.2.0 2021-01-02
+
+- [e55b2b6](https://github.com/appium/ruby_lib_core/commit/e55b2b6f7fe293091be0d3835075e66c74f3b9dd) Release 4.2.0
+- [b0cd235](https://github.com/appium/ruby_lib_core/commit/b0cd235a7fb6e5a8957871650bf86962cf0e0368) feat: append screenshot in element module as well (#297)
+
+
+#### v4.1.1 2020-12-25
+
+- [3a4cf56](https://github.com/appium/ruby_lib_core/commit/3a4cf56c73a64fb10ca0b7fecc5800719838095c) Release 4.1.1
+- [6b2d7dd](https://github.com/appium/ruby_lib_core/commit/6b2d7ddf027b5a9f49cbe9a7f5622eb345e2c076) fix: keyword argument in Ruby 3
+
+
 #### v4.1.0 2020-12-25
 
 - [89110a9](https://github.com/appium/ruby_lib_core/commit/89110a995b869471a134f8c45ebe8dfbaabfba63) Release 4.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-26 00:00:00.000000000 Z
+date: 2021-01-10 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.7.0
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +268,7 @@ files:
 - lib/appium_lib_core/common/base/driver.rb
 - lib/appium_lib_core/common/base/http_default.rb
 - lib/appium_lib_core/common/base/platform.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
 - lib/appium_lib_core/common/command.rb
@@ -287,6 +288,7 @@ files:
 - lib/appium_lib_core/common/device/ime_actions.rb
 - lib/appium_lib_core/common/device/keyboard.rb
 - lib/appium_lib_core/common/device/keyevent.rb
+- lib/appium_lib_core/common/device/orientation.rb
 - lib/appium_lib_core/common/device/screen_record.rb
 - lib/appium_lib_core/common/device/setting.rb
 - lib/appium_lib_core/common/device/touch_actions.rb