appium_lib_core 2.3.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bceabea49800493b2a7f3ca6180df16e44c46b931442cfbc34d6e081127d5249
-  data.tar.gz: dac898db424d25bf06eee64e3cb8c338f4de8c50b2bccecce46a7e3479f028aa
+  metadata.gz: 964bd12f85a4c6d913e71f664c9a672114b978f0b439fcee38470891128d1740
+  data.tar.gz: bc62600215d921364530c368bf3d02d6b685444130bd9c36209ac42f7d2b92d9
 SHA512:
-  metadata.gz: 7caa9b73f44e35aad52e9226044dc0faa1e9f79d2968ffbf8f51f8783ed1f034a15ea368347ce3bcaa6d97d1cf229ad3f07ced9524a3c12a19445440c7496472
-  data.tar.gz: 4c3c9c079d7815c6f515984898aa8d547a613fb929f79081fbba696aff8b1b23190f4a3ac8ed2dc07c4f215ab8c9bedc93b419e6d0d882eec44c4aa7cdf35f6c
+  metadata.gz: 57e0aae70e9a102f94012dba112df99f6ed2a1ad615f18d91e55000eca18c3c29648403765b712c3019df880cb43b9453c1ec0de664f6c6674b656411b8ad3af
+  data.tar.gz: b2327a0fb7650b001f36f87bee57d77bc00d34a906dba295c20d2bc2a10254c9c8ecceb30aaa673e2bf89fe7d7b56732b6121db85c6bceb0534fd1b0a0118f03

data/.travis.yml

@@ -14,6 +14,8 @@ before_install:
 script:
   - bundle exec rake rubocop
   - bundle exec parallel_test test/unit/ -n 4
+  - AUTOMATION_NAME_DROID=espresso bundle exec parallel_test test/unit/android -n 4
+  - AUTOMATION_NAME_DROID=appium AUTOMATION_NAME_IOS=appium bundle exec parallel_test test/unit -n 4
 
 notifications:
   email:

data/CHANGELOG.md

@@ -3,15 +3,44 @@ All notable changes to this project will be documented in this file.
 Read `release_notes.md` for commit level details.
 
 ## [Unreleased]
+
+### Enhancements
+
+### Bug fixes
+
+### Deprecations
+
+## [3.0.0] - 2019-02-06
+
+This release has a breaking change about an implicit wait.
+Ruby client sets `0` seconds as implicit wait by default instead of `20` seconds.
+The behaviour follows the default spec in WebDriver.
+
 ### Enhancements
+- **Breaking changes**
+    - Set implicit wait zero by default
+        - Can configure `wait: 20` as `appium_lib` capability to keep the behaviour
+- [Experimental] Add `direct_connect` capability for the Ruby client in order to handle `directConnect` capability in a create session response by Appium server
+    - Update http client following `directConnectProtocol`, `directConnectHost`, `directConnectPort` and `directConnectPath`
+      if `direct_connect` capability for ruby_lib_core is `true`
+    - This will resolve a performance issue if a user has a proxy server to handle requests from client to Appium server.
+      With this feature, the user can send requests directly to the Appium server after create session skipping the proxy server.
+      ```
+      # create session
+      client <---> proxy server <---> appium server <> devices
+      # Following requests after the create session
+      client <----------------------> appium server <> devices
+      ```
 
 ### Bug fixes
+- Fix potential override of `AppManagement#background_app`
 
 ### 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)
+    - `:pressure` option
 
 ### Bug fixes
 - Stop sending blank value in `start_activity`

data/lib/appium_lib_core/android/device.rb

@@ -326,7 +326,7 @@ module Appium
               end
             end
 
-            # Android, Override
+            # Android, Override included method in bridge
             ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
               def hide_keyboard(close_key = nil, strategy = nil)
                 option = {}
@@ -338,6 +338,13 @@ module Appium
               end
             end
 
+            # Android, Override included method in bridge
+            ::Appium::Core::Device.add_endpoint_method(:background_app) do
+              def background_app(duration = 0)
+                execute :background_app, {}, seconds: duration
+              end
+            end
+
             # TODO: TEST ME
             ::Appium::Core::Device.add_endpoint_method(:end_coverage) do
               def end_coverage(path, intent)

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

@@ -37,6 +37,23 @@ module Appium
           @bridge.dialect
         end
 
+        # Update `server_url` and HTTP clients following this arguments, protocol, host, port and path.
+        # After this method, `@bridge.http` will be a new instance following them instead of `server_url` which is
+        # set before creating session.
+        #
+        # @example
+        #
+        #     driver = core.start_driver server_url: 'http://example1.com:8000/wd/hub # @bridge.http is for `http://example1.com:8000/wd/hub/`
+        #     driver.update_sending_request_to protocol: 'https', host: 'example2.com', port: 9000, path: '/wd/hub'
+        #     driver.manage.timeouts.implicit_wait = 10 # @bridge.http is for `https://example2.com:9000/wd/hub/`
+        #
+        def update_sending_request_to(protocol:, host:, port:, path:)
+          @bridge.http.update_sending_request_to(scheme: protocol,
+                                                 host: host,
+                                                 port: port,
+                                                 path: path)
+        end
+
         ### Methods for Appium
 
         # Lock the device

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

@@ -12,6 +12,37 @@ module Appium
               "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common::DEFAULT_HEADERS['User-Agent']})"
           }.freeze
 
+          # Update `server_url` to.
+          # Set `@http` as nil to re-create http client for the server_url
+          # @private
+          #
+          # @param [string] scheme: A scheme to update server_url to
+          # @param [string] host: A host to update server_url to
+          # @param [string|integer] port: A port number to update server_url to
+          # @param [string] path: A path to update server_url to
+          #
+          # @return [URI] An instance of URI updated to. Returns default `server_url` if some of arguments are `nil`
+          def update_sending_request_to(scheme:, host:, port:, path:)
+            return @server_url unless validate_url_param(scheme, host, port, path)
+
+            Logger.debug("[experimental] This feature, #{__method__}, is an experimental")
+
+            # Add / if `path` does not have it
+            path = path.start_with?('/') ? path : "/#{path}"
+            path = path.end_with?('/') ? path : "#{path}/"
+
+            @http = nil
+            @server_url = URI.parse "#{scheme}://#{host}:#{port}#{path}"
+          end
+
+          private
+
+          def validate_url_param(scheme, host, port, path)
+            !(scheme.nil? || host.nil? || port.nil? || path.nil?)
+          end
+
+          public
+
           # override to use default header
           # https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/remote/http/common.rb#L46
           def call(verb, url, command_hash)

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

@@ -20,8 +20,9 @@ module Appium
             execute :app_strings, {}, opts
           end
 
-          def background_app(duration = 0)
-            execute :background_app, {}, seconds: duration
+          def background_app(duration = 0) # rubocop:disable Lint/UnusedMethodArgument
+            # Should override in each driver
+            raise NotImplementedError
           end
 
           def install_app(path,

data/lib/appium_lib_core/driver.rb

@@ -43,11 +43,12 @@ module Appium
       # @return [String] By default, session id is exported in '/tmp/appium_lib_session'
       attr_reader :export_session_path
 
-      # Default wait time for elements to appear
-      # Returns the default client side wait. 20 seconds is by default.
+      # Default wait time for elements to appear in Appium server side.
+      # Returns the default client side wait. 0 seconds is by default. Users should handle the timeout stuff in user-side.
       # Provide Appium::Drive like { appium_lib: { wait: 30 } }
       # @return [Integer]
       attr_reader :default_wait
+      DEFAULT_IMPLICIT_WAIT = 0
 
       # Appium's server port. 4723 is by default.
       # Provide Appium::Drive like { appium_lib: { port: 8080 } }
@@ -75,6 +76,16 @@ module Appium
       # @return [Appium::Core::Base::Driver]
       attr_reader :driver
 
+      # [Experimental feature]
+      # Enable an experimental feature updating Appium HTTP client following `directConnectProtocol`, `directConnectHost`,
+      # `directConnectPort` and `directConnectPath` after session creation if the server returns them as a part of the response
+      # capability in _create session_.
+      #
+      # Ignore them if this parameter is `false`. Defaults to false.
+      #
+      # @return [Bool]
+      attr_reader :direct_connect
+
       # Creates a new global driver and extend particular methods to `target`
       # @param [Class] target Extend particular methods to this target.
       # @param [Hash] opts A options include capabilities for the Appium Server and for the client.
@@ -244,6 +255,13 @@ module Appium
                                                      url: @custom_url,
                                                      listener: @listener)
 
+          if @direct_connect
+            @driver.update_sending_request_to(protocol: @driver.capabilities['directConnectProtocol'],
+                                              host: @driver.capabilities['directConnectHost'],
+                                              port: @driver.capabilities['directConnectPort'],
+                                              path: @driver.capabilities['directConnectPath'])
+          end
+
           # export session
           write_session_id(@driver.session_id, @export_session_path) if @export_session
         rescue Errno::ECONNREFUSED
@@ -448,12 +466,14 @@ module Appium
       # @private
       def set_appium_lib_specific_values(appium_lib_opts)
         @custom_url ||= appium_lib_opts.fetch :server_url, nil
-        @default_wait = appium_lib_opts.fetch :wait, 20
+        @default_wait = appium_lib_opts.fetch :wait, DEFAULT_IMPLICIT_WAIT
 
         # bump current session id into a particular file
         @export_session = appium_lib_opts.fetch :export_session, false
         @export_session_path = appium_lib_opts.fetch :export_session_path, default_tmp_appium_lib_session
 
+        @direct_connect = appium_lib_opts.fetch :direct_access, false
+
         @port = appium_lib_opts.fetch :port, DEFAULT_APPIUM_PORT
 
         # timeout and interval used in ::Appium::Comm.wait/wait_true

data/lib/appium_lib_core/ios.rb

@@ -2,4 +2,5 @@
 require_relative 'ios/device'
 
 require_relative 'ios/uiautomation/patch'
+require_relative 'ios/uiautomation/device'
 require_relative 'ios/uiautomation/bridge'

data/lib/appium_lib_core/ios/uiautomation/bridge.rb

@@ -7,6 +7,7 @@ module Appium
             target.extend Appium::Core::Ios::Device
 
             Core::Ios::Uiautomation.patch_webdriver_element
+            Core::Ios::Uiautomation::Device.add_methods
           end
         end
       end

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

@@ -0,0 +1,30 @@
+module Appium
+  module Core
+    module Ios
+      module Uiautomation
+        module Device
+          def self.add_methods
+            # UiAutomation, Override included method in bridge
+            ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
+              def hide_keyboard(close_key = nil, strategy = nil)
+                option = {}
+
+                option[:key] = close_key || 'Done'        # default to Done key.
+                option[:strategy] = strategy || :pressKey # default to pressKey
+
+                execute :hide_keyboard, {}, option
+              end
+            end
+
+            # UiAutomation, Override included method in bridge
+            ::Appium::Core::Device.add_endpoint_method(:background_app) do
+              def background_app(duration = 0)
+                execute :background_app, {}, seconds: duration
+              end
+            end
+          end
+        end # module Device
+      end # module Uiautomation
+    end # module Ios
+  end # module Core
+end # module Appium

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

@@ -150,7 +150,7 @@ module Appium
 
           class << self
             def extended(_mod)
-              # Override
+              # Xcuitest, Override included method in bridge
               ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
                 def hide_keyboard(close_key = nil, strategy = nil)
                   option = {}
@@ -162,7 +162,7 @@ module Appium
                 end
               end
 
-              # Override
+              # Xcuitest, Override included method in bridge
               ::Appium::Core::Device.add_endpoint_method(:background_app) do
                 def background_app(duration = 0)
                   # https://github.com/appium/ruby_lib/issues/500, https://github.com/appium/appium/issues/7741

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '2.3.4'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2019-01-31'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '3.0.0'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2019-02-06'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,13 @@
+#### v3.0.0 2019-02-06
+
+- [ba653c3](https://github.com/appium/ruby_lib_core/commit/ba653c3be70bad3b9a9e233121b4b3a9455fa287) Release 3.0.0
+- [77e7cd2](https://github.com/appium/ruby_lib_core/commit/77e7cd2f58bcc1fb368f9721fe071b210e071435) Release 3.0.0
+- [1315dae](https://github.com/appium/ruby_lib_core/commit/1315dae75712b65707b8b519228860d6d89ac96c) set default zero implicit wait (#186)
+- [61a927f](https://github.com/appium/ruby_lib_core/commit/61a927f6e6f15b718cf6b4bfb8a26242e571a2f9) Experimental add direct host (#189)
+- [c9fff7b](https://github.com/appium/ruby_lib_core/commit/c9fff7b3e12eaa20a55742460147d7694f61658d) Improve override background (#188)
+- [1e588c8](https://github.com/appium/ruby_lib_core/commit/1e588c87842f3844763e6c9559087302219280ab) update changelog
+
+
 #### v2.3.4 2019-01-31
 
 - [f217263](https://github.com/appium/ruby_lib_core/commit/f217263febd2bd3d6c8663f440d7959096492f7a) Release 2.3.4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -297,6 +297,7 @@ files:
 - lib/appium_lib_core/ios/device.rb
 - lib/appium_lib_core/ios/device/clipboard.rb
 - lib/appium_lib_core/ios/uiautomation/bridge.rb
+- lib/appium_lib_core/ios/uiautomation/device.rb
 - lib/appium_lib_core/ios/uiautomation/patch.rb
 - lib/appium_lib_core/ios/xcuitest/bridge.rb
 - lib/appium_lib_core/ios/xcuitest/device.rb