appium_lib_core 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5798df58380b50a707092f9b68a1ad39b3da1ac8e5103ee0c0b0f178a338c828
-  data.tar.gz: ff85cb387a48c36ec2b4f50e4b59214cdc84fb4a7452e1f31ac7f8c127c9bebd
+  metadata.gz: 4ffb1cbef0e8af1c0cf3b8dba42764a0decc3f9b5938ebff6f95f09c7438e516
+  data.tar.gz: baaeb26f3d7333f9aeccfcb25e84a81caadae91ff90b95ce3b8f884c14fb7872
 SHA512:
-  metadata.gz: 8bbdf3f1b440126a92ae5fac4e7f88a7edfffdcbf661acbab43c156678a3406df19294e6aa6417679b4ca6e7d1617ce89d37cd30e91c6e894bd79f8f41bc3f3f
-  data.tar.gz: af3f57193be3c0e179b1fa0b96f0ce9a443b3e8e997df33d6ce76eaf8cb5bfd76f3f32bac4e0ebb8d13204c7e098ab7fb8646a756201914c5a7a2aaa2d47f917
+  metadata.gz: 7b102f1ee71cb033a2763b14f390fde773da2c02dc0c5ff6869c366a25067afd1c7448b228111c7117f1c6f5efd9e88e55f534b3c48dd1b3a1769a40bfb720c2
+  data.tar.gz: 70d55ecdd3cc250c6d504954006dfef47b7e89db80fcc05379ea7e71362ad572a61786651239c5f5cbd462efb4e0e8776aa594bef1540a0148278cf0789f9a4c

data/.rubocop.yml

@@ -18,6 +18,9 @@ Metrics/ParameterLists:
   Max: 6
 Lint/NestedMethodDefinition:
   Enabled: false
+# TODO: Replace <<- with <<~ after dropping Ruby 2.2
+Layout/IndentHeredoc:
+  Enabled: false
 Style/Documentation:
   Enabled: false
 Style/CommentedKeyword:

data/CHANGELOG.md

@@ -10,6 +10,16 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [3.2.0] - 2019-06-27
+
+### Enhancements
+- 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

data/lib/appium_lib_core/common/base.rb

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

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

@@ -31,6 +31,7 @@ module Appium
           include Device::ScreenRecord::Command
           include Device::Device
           include Device::TouchActions
+          include Device::ExecuteDriver
 
           def commands(command)
             ::Appium::Core::Commands::MJSONWP::COMMANDS[command]
@@ -53,6 +54,13 @@ module Appium
           def send_actions(_data)
             raise Error::UnsupportedOperationError, '#send_actions has not been supported in MJSONWP'
           end
+
+          # For Appium
+          # @param [Hash] id The id which can get as a response from server
+          # @return [::Selenium::WebDriver::Element]
+          def convert_to_element(id)
+            ::Selenium::WebDriver::Element.new self, element_id_from(id)
+          end
         end # class MJSONWP
       end # class Bridge
     end # class Base

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

@@ -31,6 +31,7 @@ module Appium
           include Device::ScreenRecord::Command
           include Device::Device
           include Device::TouchActions
+          include Device::ExecuteDriver
 
           def commands(command)
             ::Appium::Core::Commands::W3C::COMMANDS[command]
@@ -133,6 +134,13 @@ module Appium
             ids.map { |id| ::Selenium::WebDriver::Element.new self, element_id_from(id) }
           end
 
+          # For Appium
+          # @param [Hash] id The id which can get as a response from server
+          # @return [::Selenium::WebDriver::Element]
+          def convert_to_element(id)
+            ::Selenium::WebDriver::Element.new self, element_id_from(id)
+          end
+
           # For Appium
           # override
           # called in `extend DriverExtensions::HasNetworkConnection`

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

@@ -1042,6 +1042,54 @@ module Appium
           template = Base64.strict_encode64 File.read img_path
           find_elements :image, template
         end
+
+        # @since Appium 1.14.0
+        #
+        # Run a set of script against the current session, allowing execution of many commands in one Appium request.
+        # Supports {https://webdriver.io/docs/api.html WebdriverIO} API so far.
+        # Please read {http://appium.io/docs/en/commands/session/execute-driver command API} for more details
+        # about acceptable scripts and the output.
+        #
+        # @param [String] script The string consisting of the script itself
+        # @param [String] type The name of the script type.
+        #                      Defaults to 'webdriverio'. Depends on server implementation which type is supported.
+        # @param [Integer] timeout_ms The number of `ms` Appium should wait for the script to finish
+        #                          before killing it due to timeout.
+        #
+        # @return [Appium::Core::Base::Device::ExecuteDriver::Result] The script result parsed by
+        #                          Appium::Core::Base::Device::ExecuteDriver::Result.
+        #
+        # @raise [::Selenium::WebDriver::Error::UnknownError] If something error happens in the script.
+        #                                                     It has the original message.
+        #
+        # @example
+        #      script = <<~SCRIPT
+        #        const status = await driver.status();
+        #        console.warn('warning message');
+        #        return [status];
+        #      SCRIPT
+        #      r = @@driver.execute_driver(script: script, type: 'webdriverio', timeout: 10_000)
+        #      r        #=> An instance of Appium::Core::Base::Device::ExecuteDriver::Result
+        #      r.result #=> The `result` key part as the result of the script
+        #      r.logs   #=> The `logs` key part as `{'log' => [], 'warn' => [], 'error' => []}`
+        #
+        def execute_driver(script: '', type: 'webdriverio', timeout_ms: nil)
+          @bridge.execute_driver(script: script, type: type, timeout_ms: timeout_ms)
+        end
+
+        # Convert vanilla element response to ::Selenium::WebDriver::Element
+        #
+        # @param [Hash] id The id which can get as a response from server
+        # @return [::Selenium::WebDriver::Element]
+        #
+        # @example
+        #     response = {"element-6066-11e4-a52e-4f735466cecf"=>"xxxx", "ELEMENT"=>"xxxx"}
+        #     ele = @driver.convert_to_element(response) #=> ::Selenium::WebDriver::Element
+        #     ele.rect #=> Can get the rect of the element
+        #
+        def convert_to_element(id)
+          @bridge.convert_to_element id
+        end
       end # class Driver
     end # class Base
   end # module Core

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

@@ -64,7 +64,8 @@ module Appium
         stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'],
         start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'],
         compare_images:             [:post, 'session/:session_id/appium/compare_images'],
-        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown']
+        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'],
+        execute_driver:             [:post, 'session/:session_id/appium/execute_driver']
       }.freeze
 
       COMMAND_ANDROID = {

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

@@ -0,0 +1,41 @@
+# 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 ExecuteDriver
+          class Result
+            attr_reader :result, :logs
+
+            def initialize(response)
+              @result = response['result']
+              @logs = response['logs']
+            end
+          end
+
+          def execute_driver(script: '', type: 'webdriverio', timeout_ms: nil)
+            option = { script: script, type: type }
+
+            option[:timeout] = timeout_ms if timeout_ms
+
+            response = execute :execute_driver, {}, option
+            Result.new(response)
+          end
+        end # module Execute
+      end # module Device
+    end # class Base
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/device.rb

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

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '3.1.3' unless defined? ::Appium::Core::VERSION
-    DATE    = '2019-06-18' unless defined? ::Appium::Core::DATE
+    VERSION = '3.2.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2019-06-27' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,12 @@
+#### v3.2.0 2019-06-27
+
+- [2f6ca23](https://github.com/appium/ruby_lib_core/commit/2f6ca23847de85fb8134f09da627391b4a66a544) Release 3.2.0
+- [9376bf2](https://github.com/appium/ruby_lib_core/commit/9376bf2b3d573798ad1d335ca84954b5b5b15abe) add execuite_driver (#222)
+- [8b70c86](https://github.com/appium/ruby_lib_core/commit/8b70c866f12f6341dfe204c3b4b1fa8946bbe305) add visual check for find by elemenet (#214)
+- [f8338b9](https://github.com/appium/ruby_lib_core/commit/f8338b9386e478c498a1d6bdc4386d9590d3efa3) make uia test simple
+- [b641af8](https://github.com/appium/ruby_lib_core/commit/b641af85d1e01a620d0f8cc2d033728947c92afc) wrap with wait
+
+
 #### v3.1.3 2019-06-18
 
 - [a63da6b](https://github.com/appium/ruby_lib_core/commit/a63da6b9e410d83fe1e1d35a89c430da0eae76b6) Release 3.1.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -280,6 +280,7 @@ files:
 - lib/appium_lib_core/common/device/context.rb
 - lib/appium_lib_core/common/device/device.rb
 - lib/appium_lib_core/common/device/device_lock.rb
+- lib/appium_lib_core/common/device/execute_driver.rb
 - lib/appium_lib_core/common/device/file_management.rb
 - lib/appium_lib_core/common/device/image_comparison.rb
 - lib/appium_lib_core/common/device/ime_actions.rb