appium_lib_core 4.5.0 → 5.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d5a8e4018e381172273c5b705a2166e8f47530101eed83ffd0ddf83e93653d
-  data.tar.gz: 78ceb26083c9ae018101180cf13c91cd28f363e819119b6500b2d48a28273474
+  metadata.gz: fd462f64262abe99f03dd5a421f2a2dd9c8064f1d44eff47bc1872a834793d27
+  data.tar.gz: 1a1ca492c3551d8c992e9f2b740460e67239887400602351423062e49912b73f
 SHA512:
-  metadata.gz: 5d07ce477474a38c3df1fb1bd989d9e6b28188ab21d7851bec98443940b0ea5d8b358c628998aeb1f62ca93be783c617dab3b4cf4fdf26e47e97def6467dca97
-  data.tar.gz: 29634dc748e222cf65bc6af144656f291815e4c5eaea1fa177aa7e1543752ffbcbac0d4b206f4169ab306dd25e1d5a36c2a1b3d9b51cdef438456c27e52a7bea
+  metadata.gz: d9e4977dfb93ce734c59af5053a6331bfc2038bd3a03757a31fd7e48c3cdcc810204fb6f3027a1120afe91eda31ad61aa504fa25fdf2a2a21d36638c27982f8e
+  data.tar.gz: 3e23c561984a3ad4bf4214aad79fc730f8673d0bc29c81d26ff5143c0dbeb38d6eacc9278ba0caa11e4dfc51f82267f79b97efe6937ad8315c837e64876df162

data/.github/workflows/unittest.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
+        ruby: [2.5, 2.6, 2.7, 3.0]
 
     runs-on: ubuntu-latest
 
@@ -38,7 +38,7 @@ jobs:
       fail-fast: false
       matrix:
         # Does not add 2.7 on Windows so far since a command fails only on Windows
-        ruby: [2.4, 2.5, 2.6]
+        ruby: [2.5, 2.6]
 
     runs-on: windows-latest
 

data/CHANGELOG.md

@@ -10,6 +10,12 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [5.0.0.beta1]
+
+- Update base selenium webdriver version to `4.0.0.beta2`
+- Support only W3C spec
+- Support Ruby 2.5+
+
 ## [4.5.0] - 2021-03-14
 
 ### Enhancements

data/appium_lib_core.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appium_lib_core/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.name          = 'appium_lib_core'
   spec.version       = Appium::Core::VERSION
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 3.14', '>= 3.14.1'
+  spec.add_runtime_dependency 'selenium-webdriver', '4.0.0.beta2'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
   spec.add_development_dependency 'bundler', '>= 1.14'
@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9.11'
   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.8.1'
+  spec.add_development_dependency 'webmock', '~> 3.12.1'
+  spec.add_development_dependency 'rubocop', '1.11.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/common/base.rb

@@ -34,7 +34,6 @@ require_relative 'device/orientation'
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'
 require_relative 'base/bridge'
-require_relative 'base/bridge/mjsonwp'
 require_relative 'base/bridge/w3c'
 require_relative 'base/capabilities'
 require_relative 'base/http_default'

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

@@ -16,52 +16,16 @@ module Appium
   module Core
     class Base
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
+        # TODO: Move W3C module to here
+
         # Prefix for extra capability defined by W3C
         APPIUM_PREFIX = 'appium:'
 
-        # TODO: Remove the forceMjsonwp after Appium server won't need it
-        FORCE_MJSONWP = :forceMjsonwp
-
-        # Almost same as self.handshake in ::Selenium::WebDriver::Remote::Bridge
-        #
-        # Implements protocol handshake which:
-        #
-        #   1. Creates session with driver.
-        #   2. Sniffs response.
-        #   3. Based on the response, understands which dialect we should use.
-        #
-        # @return [Bridge::MJSONWP, Bridge::W3C]
-        #
-        def self.handshake(**opts)
-          desired_capabilities = opts.delete(:desired_capabilities) { ::Selenium::WebDriver::Remote::Capabilities.new }
-
-          if desired_capabilities.is_a?(Symbol)
-            unless ::Selenium::WebDriver::Remote::Capabilities.respond_to?(desired_capabilities)
-              raise ::Selenium::WebDriver::Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
-            end
-
-            desired_capabilities = ::Selenium::WebDriver::Remote::Capabilities.__send__(desired_capabilities)
-          end
-
-          bridge = new(opts)
-          capabilities = bridge.create_session(desired_capabilities)
-
-          case bridge.dialect
-          when :oss # for MJSONWP
-            Bridge::MJSONWP.new(capabilities, bridge.session_id, **opts)
-          when :w3c
-            Bridge::W3C.new(capabilities, bridge.session_id, **opts)
-          else
-            raise CoreError, 'cannot understand dialect'
-          end
-        end
-
         # Override
         # Creates session handling both OSS and W3C dialects.
-        # Copy from Selenium::WebDriver::Remote::Bridge to keep using +merged_capabilities+ for Appium
         #
-        # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] desired_capabilities A capability
-        # @return [::Selenium::WebDriver::Remote::Capabilities, ::Selenium::WebDriver::Remote::W3C::Capabilities]
+        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] desired_capabilities A capability
+        # @return [::Selenium::WebDriver::Remote::Capabilities]
         #
         # @example
         #
@@ -79,37 +43,27 @@ module Appium
         #     }
         #   }
         #   core = ::Appium::Core.for(caps)
-        #   driver = core.start_driver #=> driver.dialect == :w3c if the Appium server support W3C.
+        #   driver = core.start_driver
         #
         def create_session(desired_capabilities)
-          response = execute(:new_session, {}, merged_capabilities(desired_capabilities))
+          caps = add_appium_prefix(desired_capabilities)
+          response = execute(:new_session, {}, { capabilities: { firstMatch: [caps] } })
 
           @session_id = response['sessionId']
-          oss_status = response['status'] # for compatibility with Appium 1.7.1-
-          value = response['value']
-
-          if value.is_a?(Hash) # include for W3C format
-            @session_id = value['sessionId'] if value.key?('sessionId')
-
-            if value.key?('capabilities')
-              value = value['capabilities']
-            elsif value.key?('value')
-              value = value['value']
-            end
-          end
+          capabilities = response['capabilities']
 
           raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
 
-          json_create(oss_status, value)
+          @capabilities = json_create(capabilities)
         end
 
         # Append +appium:+ prefix for Appium following W3C spec
         # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities
         #
-        # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] capabilities A capability
-        # @return [::Selenium::WebDriver::Remote::W3C::Capabilities]
+        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
+        # @return [::Selenium::WebDriver::Remote::Capabilities]
         def add_appium_prefix(capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.new
+          w3c_capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
 
           capabilities = capabilities.__send__(:capabilities) unless capabilities.is_a?(Hash)
 
@@ -133,56 +87,17 @@ module Appium
         end
 
         def extension_prefix?(capability_name)
-          snake_cased_capability_names = ::Selenium::WebDriver::Remote::W3C::Capabilities::KNOWN.map(&:to_s)
+          snake_cased_capability_names = ::Selenium::WebDriver::Remote::Capabilities::KNOWN.map(&:to_s)
           camel_cased_capability_names = snake_cased_capability_names.map { |v| camel_case(v) }
 
+          # Check 'EXTENSION_CAPABILITY_PATTERN'
           snake_cased_capability_names.include?(capability_name) ||
             camel_cased_capability_names.include?(capability_name) ||
-            capability_name.match(::Selenium::WebDriver::Remote::W3C::Capabilities::EXTENSION_CAPABILITY_PATTERN)
+            capability_name.match(':')
         end
 
-        def json_create(oss_status, value)
-          if oss_status
-            ::Selenium::WebDriver.logger.info 'Detected OSS dialect.'
-            @dialect = :oss
-            ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
-          else
-            ::Selenium::WebDriver.logger.info 'Detected W3C dialect.'
-            @dialect = :w3c
-            ::Selenium::WebDriver::Remote::W3C::Capabilities.json_create(value)
-          end
-        end
-
-        def delete_force_mjsonwp(capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.new
-
-          capabilities = capabilities.__send__(:capabilities) unless capabilities.is_a?(Hash)
-          capabilities.each do |name, value|
-            next if value.nil?
-            next if value.is_a?(String) && value.empty?
-            next if name == FORCE_MJSONWP
-
-            w3c_capabilities[name] = value
-          end
-
-          w3c_capabilities
-        end
-
-        def merged_capabilities(desired_capabilities)
-          force_mjsonwp = desired_capabilities[FORCE_MJSONWP]
-          desired_capabilities = delete_force_mjsonwp(desired_capabilities) unless force_mjsonwp.nil?
-
-          ::Appium::Logger.warn "'forceMjsonwp' no longer works. Sending both W3C and MJSONWP capabilities" if force_mjsonwp
-
-          new_caps = add_appium_prefix(desired_capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
-
-          {
-            desiredCapabilities: desired_capabilities,
-            capabilities: {
-              firstMatch: [w3c_capabilities]
-            }
-          }
+        def json_create(value)
+          ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
         end
       end # class Bridge
     end # class Base

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

@@ -16,7 +16,7 @@ module Appium
   module Core
     class Base
       class Bridge
-        class W3C < ::Selenium::WebDriver::Remote::W3C::Bridge
+        class W3C < ::Selenium::WebDriver::Remote::Bridge
           include Device::DeviceLock
           include Device::Keyboard
           include Device::ImeActions
@@ -34,6 +34,106 @@ module Appium
           include Device::ExecuteDriver
           include Device::Orientation
 
+          # TODO: For compatibility. Should remove.
+          def dialect
+            :w3c
+          end
+
+          # TODO: fixme
+          def browser
+            @browser ||= begin
+              name = @capabilities.browser_name
+              name ? name.tr(' ', '_').downcase.to_sym : 'unknown'
+            rescue KeyError
+              'unknown'
+            end
+          end
+
+          # Prefix for extra capability defined by W3C
+          APPIUM_PREFIX = 'appium:'
+
+          # Override
+          # Creates session handling both OSS and W3C dialects.
+          #
+          # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] desired_capabilities A capability
+          # @return [::Selenium::WebDriver::Remote::Capabilities]
+          #
+          # @example
+          #
+          #   opts = {
+          #     caps: {
+          #       platformName: :ios,
+          #       automationName: 'XCUITest',
+          #       app: 'test/functional/app/UICatalog.app.zip',
+          #       platformVersion: '11.4',
+          #       deviceName: 'iPhone Simulator',
+          #       useNewWDA: true,
+          #     },
+          #     appium_lib: {
+          #       wait: 30
+          #     }
+          #   }
+          #   core = ::Appium::Core.for(caps)
+          #   driver = core.start_driver #=> driver.dialect == :w3c if the Appium server support W3C.
+          #
+          def create_session(desired_capabilities)
+            caps = add_appium_prefix(desired_capabilities)
+            response = execute(:new_session, {}, { capabilities: { firstMatch: [caps] } })
+
+            @session_id = response['sessionId']
+            capabilities = response['capabilities']
+
+            raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
+
+            @capabilities = json_create(capabilities)
+          end
+
+          # Append +appium:+ prefix for Appium following W3C spec
+          # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities
+          #
+          # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
+          # @return [::Selenium::WebDriver::Remote::Capabilities]
+          def add_appium_prefix(capabilities)
+            w3c_capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
+
+            capabilities = capabilities.__send__(:capabilities) unless capabilities.is_a?(Hash)
+
+            capabilities.each do |name, value|
+              next if value.nil?
+              next if value.is_a?(String) && value.empty?
+
+              capability_name = name.to_s
+              w3c_name = extension_prefix?(capability_name) ? name : "#{APPIUM_PREFIX}#{capability_name}"
+
+              w3c_capabilities[w3c_name] = value
+            end
+
+            w3c_capabilities
+          end
+
+          private
+
+          def camel_case(str)
+            str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+          end
+
+          def extension_prefix?(capability_name)
+            snake_cased_capability_names = ::Selenium::WebDriver::Remote::Capabilities::KNOWN.map(&:to_s)
+            camel_cased_capability_names = snake_cased_capability_names.map { |v| camel_case(v) }
+
+            # Check 'EXTENSION_CAPABILITY_PATTERN'
+            snake_cased_capability_names.include?(capability_name) ||
+              camel_cased_capability_names.include?(capability_name) ||
+              capability_name.match(':')
+          end
+
+          def json_create(value)
+            @dialect = :w3c
+            ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
+          end
+
+          public
+
           def commands(command)
             ::Appium::Core::Commands::W3C::COMMANDS[command]
           end
@@ -76,7 +176,7 @@ module Appium
 
           # Port from MJSONWP
           def session_capabilities
-            ::Selenium::WebDriver::Remote::W3C::Capabilities.json_create execute(:get_capabilities)
+            ::Selenium::WebDriver::Remote::Capabilities.json_create execute(:get_capabilities)
           end
 
           # Port from MJSONWP

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

@@ -19,10 +19,10 @@ module Appium
         # @private
         # @param [Hash] opts_caps Capabilities for Appium server. All capability keys are converted to lowerCamelCase when
         #                         this client sends capabilities to Appium server as JSON format.
-        # @return [::Selenium::WebDriver::Remote::W3C::Capabilities] Return instance of Appium::Core::Base::Capabilities
-        #                         inherited ::Selenium::WebDriver::Remote::W3C::Capabilities
+        # @return [::Selenium::WebDriver::Remote::Capabilities] Return instance of Appium::Core::Base::Capabilities
+        #                         inherited ::Selenium::WebDriver::Remote::Capabilities
         def self.create_capabilities(opts_caps = {})
-          ::Selenium::WebDriver::Remote::W3C::Capabilities.new(opts_caps)
+          ::Selenium::WebDriver::Remote::Capabilities.new(opts_caps)
         end
       end
     end

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

@@ -16,8 +16,129 @@ module Appium
   module Core
     class Base
       module Commands
-        OSS = ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS.freeze
-        W3C = ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS.freeze
+        W3C = {
+          status: [:get, 'status'],
+
+          #
+          # session handling
+          #
+
+          new_session: [:post, 'session'],
+          delete_session: [:delete, 'session/:session_id'],
+
+          #
+          # basic driver
+          #
+
+          get: [:post, 'session/:session_id/url'],
+          get_current_url: [:get, 'session/:session_id/url'],
+          back: [:post, 'session/:session_id/back'],
+          forward: [:post, 'session/:session_id/forward'],
+          refresh: [:post, 'session/:session_id/refresh'],
+          get_title: [:get, 'session/:session_id/title'],
+
+          #
+          # window and Frame handling
+          #
+
+          get_window_handle: [:get, 'session/:session_id/window'],
+          new_window: [:post, 'session/:session_id/window/new'],
+          close_window: [:delete, 'session/:session_id/window'],
+          switch_to_window: [:post, 'session/:session_id/window'],
+          get_window_handles: [:get, 'session/:session_id/window/handles'],
+          fullscreen_window: [:post, 'session/:session_id/window/fullscreen'],
+          minimize_window: [:post, 'session/:session_id/window/minimize'],
+          maximize_window: [:post, 'session/:session_id/window/maximize'],
+          set_window_size: [:post, 'session/:session_id/window/size'],
+          get_window_size: [:get, 'session/:session_id/window/size'],
+          set_window_position: [:post, 'session/:session_id/window/position'],
+          get_window_position: [:get, 'session/:session_id/window/position'],
+          set_window_rect: [:post, 'session/:session_id/window/rect'],
+          get_window_rect: [:get, 'session/:session_id/window/rect'],
+          switch_to_frame: [:post, 'session/:session_id/frame'],
+          switch_to_parent_frame: [:post, 'session/:session_id/frame/parent'],
+
+          #
+          # element
+          #
+
+          find_element: [:post, 'session/:session_id/element'],
+          find_elements: [:post, 'session/:session_id/elements'],
+          find_child_element: [:post, 'session/:session_id/element/:id/element'],
+          find_child_elements: [:post, 'session/:session_id/element/:id/elements'],
+          get_active_element: [:get, 'session/:session_id/element/active'],
+          is_element_selected: [:get, 'session/:session_id/element/:id/selected'],
+          get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'],
+          get_element_property: [:get, 'session/:session_id/element/:id/property/:name'],
+          get_element_css_value: [:get, 'session/:session_id/element/:id/css/:property_name'],
+          get_element_text: [:get, 'session/:session_id/element/:id/text'],
+          get_element_tag_name: [:get, 'session/:session_id/element/:id/name'],
+          get_element_rect: [:get, 'session/:session_id/element/:id/rect'],
+          is_element_enabled: [:get, 'session/:session_id/element/:id/enabled'],
+
+          #
+          # document handling
+          #
+
+          get_page_source: [:get, 'session/:session_id/source'],
+          execute_script: [:post, 'session/:session_id/execute/sync'],
+          execute_async_script: [:post, 'session/:session_id/execute/async'],
+
+          #
+          # cookies
+          #
+
+          get_all_cookies: [:get, 'session/:session_id/cookie'],
+          get_cookie: [:get, 'session/:session_id/cookie/:name'],
+          add_cookie: [:post, 'session/:session_id/cookie'],
+          delete_cookie: [:delete, 'session/:session_id/cookie/:name'],
+          delete_all_cookies: [:delete, 'session/:session_id/cookie'],
+
+          #
+          # timeouts
+          #
+
+          set_timeout: [:post, 'session/:session_id/timeouts'],
+
+          #
+          # actions
+          #
+
+          actions: [:post, 'session/:session_id/actions'],
+          release_actions: [:delete, 'session/:session_id/actions'],
+          print_page: [:post, 'session/:session_id/print'],
+
+          #
+          # Element Operations
+          #
+
+          element_click: [:post, 'session/:session_id/element/:id/click'],
+          element_tap: [:post, 'session/:session_id/element/:id/tap'],
+          element_clear: [:post, 'session/:session_id/element/:id/clear'],
+          element_send_keys: [:post, 'session/:session_id/element/:id/value'],
+
+          #
+          # alerts
+          #
+
+          dismiss_alert: [:post, 'session/:session_id/alert/dismiss'],
+          accept_alert: [:post, 'session/:session_id/alert/accept'],
+          get_alert_text: [:get, 'session/:session_id/alert/text'],
+          send_alert_text: [:post, 'session/:session_id/alert/text'],
+
+          #
+          # screenshot
+          #
+
+          take_screenshot: [:get, 'session/:session_id/screenshot'],
+          take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'],
+
+          #
+          # server extensions
+          #
+
+          upload_file: [:post, 'session/:session_id/se/file']
+        }.freeze
       end # module Commands
     end # module Base
   end # module Core

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

@@ -18,6 +18,7 @@ require_relative 'screenshot'
 require_relative 'rotable'
 require_relative 'remote_status'
 require_relative 'has_location'
+require_relative 'has_network_connection'
 
 module Appium
   module Core
@@ -27,23 +28,55 @@ module Appium
         include ::Selenium::WebDriver::DriverExtensions::HasSessionId
         include ::Selenium::WebDriver::DriverExtensions::HasRemoteStatus
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
-        include ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
-        include  ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
 
         include ::Appium::Core::Base::Rotatable
         include ::Appium::Core::Base::SearchContext
         include ::Appium::Core::Base::TakesScreenshot
         include ::Appium::Core::Base::HasRemoteStatus
         include ::Appium::Core::Base::HasLocation
+        include ::Appium::Core::Base::HasNetworkConnection
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
         attr_reader :bridge
 
-        def initialize(opts = {})
-          listener = opts.delete(:listener)
-          @bridge = ::Appium::Core::Base::Bridge.handshake(**opts)
-          super(@bridge, listener: listener)
+        # Almost same as self.handshake in ::Selenium::WebDriver::Remote::Bridge
+        #
+        # Implements protocol handshake which:
+        #
+        #   1. Creates session with driver.
+        #   2. Sniffs response.
+        #   3. Based on the response, understands which dialect we should use.
+        #
+        # @return [Bridge::W3C]
+        #
+        # TODO: Fixme
+        def create_bridge(**opts)
+          opts[:url] ||= service_url(opts)
+          caps = opts.delete(:capabilities)
+          # NOTE: This is deprecated
+          cap_array = caps.is_a?(Hash) ? [caps] : Array(caps)
+
+          desired_capabilities = opts.delete(:desired_capabilities)
+          if desired_capabilities
+            if desired_capabilities.is_a?(Hash)
+              desired_capabilities = ::Selenium::WebDriver::Remote::Capabilities(desired_capabilities)
+            end
+            cap_array << desired_capabilities
+          end
+
+          options = opts.delete(:options)
+          cap_array << options if options
+
+          capabilities = generate_capabilities(cap_array)
+
+          bridge_opts = { http_client: opts.delete(:http_client), url: opts.delete(:url) }
+          raise ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
+
+          bridge = ::Appium::Core::Base::Bridge::W3C.new(**bridge_opts)
+
+          bridge.create_session(capabilities)
+          bridge
         end
 
         # Get the dialect value
@@ -164,10 +197,24 @@ module Appium
             @bridge = bridge
           end
 
+          # Get appium Settings for current test session.
+          #
+          # @example
+          #
+          #   @driver.settings.get
+          #
           def get
             @bridge.get_settings
           end
 
+          # Update Appium Settings for current test session
+          #
+          # @param [Hash] settings Settings to update, keys are settings, values to value to set each setting to
+          #
+          # @example
+          #
+          #   @driver.settings.update({'allowInvisibleElements': true})
+          #
           def update(settings)
             @bridge.update_settings(settings)
           end
@@ -204,8 +251,8 @@ module Appium
         #
         # @example
         #
-        #   @driver.update_settings('allowInvisibleElements': true)
-        #   @driver.settings.update('allowInvisibleElements': true)
+        #   @driver.update_settings({ 'allowInvisibleElements': true })
+        #   @driver.settings.update({ 'allowInvisibleElements': true })
         #   @driver.settings = { 'allowInvisibleElements': true }
         #
         def settings=(value)
@@ -887,13 +934,13 @@ module Appium
         # Retrieve the capabilities of the specified session.
         # It's almost same as +@driver.capabilities+ but you can get more details.
         #
-        # @return [Selenium::WebDriver::Remote::Capabilities, Selenium::WebDriver::Remote::W3C::Capabilities]
+        # @return [Selenium::WebDriver::Remote::Capabilities, Selenium::WebDriver::Remote::Capabilities]
         #
         # @example
         #   @driver.session_capabilities
         #
         #   #=> uiautomator2
-        #   # <Selenium::WebDriver::Remote::W3C::Capabilities:0x007fa38dae1360
+        #   # <Selenium::WebDriver::Remote::Capabilities:0x007fa38dae1360
         #   # @capabilities=
         #   #     {:proxy=>nil,
         #   #      :browser_name=>nil,
@@ -943,7 +990,7 @@ module Appium
         #   #      "viewportRect"=>{"left"=>0, "top"=>63, "width"=>1080, "height"=>1731}}>
         #   #
         #   #=> XCUITest
-        #   # <Selenium::WebDriver::Remote::W3C::Capabilities:0x007fb15dc01370
+        #   # <Selenium::WebDriver::Remote::Capabilities:0x007fb15dc01370
         #   # @capabilities=
         #   #     {:proxy=>nil,
         #   #      :browser_name=>"UICatalog",

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

@@ -0,0 +1,56 @@
+# 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 HasNetworkConnection
+        def network_connection_type
+          connection_value = @bridge.network_connection
+
+          connection_type = values_to_type[connection_value]
+
+          # In case the connection type is not recognized return the
+          # connection value.
+          connection_type || connection_value
+        end
+
+        def network_connection_type=(connection_type)
+          raise ArgumentError, 'Invalid connection type' unless valid_type? connection_type
+
+          connection_value = type_to_values[connection_type]
+
+          @bridge.network_connection = connection_value
+        end
+
+        private
+
+        def type_to_values
+          { airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0 }
+        end
+
+        def values_to_type
+          type_to_values.invert
+        end
+
+        def valid_type?(type)
+          type_to_values.keys.include? type
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/common/command.rb

@@ -14,5 +14,4 @@
 
 require_relative 'base/command'
 require_relative 'command/common'
-require_relative 'command/mjsonwp'
 require_relative 'command/w3c'

data/lib/appium_lib_core/device.rb

@@ -79,10 +79,6 @@ module Appium
         end
 
         def create_bridge_command(method, &block)
-          ::Appium::Core::Base::Bridge::MJSONWP.class_eval do
-            undef_method method if method_defined? method
-            block_given? ? class_eval(&block) : define_method(method) { execute method }
-          end
           ::Appium::Core::Base::Bridge::W3C.class_eval do
             undef_method method if method_defined? method
             block_given? ? class_eval(&block) : define_method(method) { execute method }

data/lib/appium_lib_core/driver.rb

@@ -368,10 +368,10 @@ module Appium
 
         begin
           # included https://github.com/SeleniumHQ/selenium/blob/43f8b3f66e7e01124eff6a5805269ee441f65707/rb/lib/selenium/webdriver/remote/driver.rb#L29
-          @driver = ::Appium::Core::Base::Driver.new(http_client: @http_client,
-                                                     desired_capabilities: @caps,
-                                                     url: @custom_url,
-                                                     listener: @listener)
+          @driver = ::Appium::Core::Base::Driver.new(listener: @listener,
+                                                     http_client: @http_client,
+                                                      desired_capabilities: @caps,
+                                                      url: @custom_url)
 
           if @direct_connect
             d_c = DirectConnections.new(@driver.capabilities)

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '4.5.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-03-14' unless defined? ::Appium::Core::DATE
+    VERSION = '5.0.0.beta1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-03-21' unless defined? ::Appium::Core::DATE
   end
 end

data/script/commands.rb

@@ -18,25 +18,21 @@ require './lib/appium_lib_core'
 module Script
   class CommandsChecker
     attr_reader :spec_commands,
-                :implemented_mjsonwp_commands, :implemented_w3c_commands, :implemented_core_commands,
-                :webdriver_oss_commands, :webdriver_w3c_commands
+                :implemented_w3c_commands, :implemented_core_commands,
+                :webdriver_w3c_commands
 
     # Set commands implemented in this core library.
     #
-    # - implemented_mjsonwp_commands:  All commands include ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS
     # - implemented_w3c_commands:  All commands include ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS
     # - implemented_core_commands:  All commands except for selenium-webdriver's commands
-    # - webdriver_oss_commands: ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS
     # - webdriver_w3c_commands: ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS
     #
     def initialize
       @spec_commands = nil
 
-      @implemented_mjsonwp_commands = convert_driver_commands Appium::Core::Commands::MJSONWP::COMMANDS
       @implemented_w3c_commands = convert_driver_commands Appium::Core::Commands::W3C::COMMANDS
       @implemented_core_commands = convert_driver_commands Appium::Core::Commands::COMMANDS
 
-      @webdriver_oss_commands = convert_driver_commands Appium::Core::Base::Commands::OSS
       @webdriver_w3c_commands = convert_driver_commands Appium::Core::Base::Commands::W3C
     end
 
@@ -80,18 +76,6 @@ module Script
       end
     end
 
-    # All commands which haven't been implemented in ruby core library yet.
-    # @return [Hash]
-    #
-    def all_diff_commands_mjsonwp
-      result = compare_commands(@spec_commands, @implemented_mjsonwp_commands)
-
-      white_list.each { |v| result.delete v }
-      w3c_spec.each { |v| result.delete v }
-
-      result
-    end
-
     # All commands which haven't been implemented in ruby core library yet.
     # @return [Hash]
     #
@@ -111,13 +95,6 @@ module Script
       result
     end
 
-    def diff_webdriver_oss
-      result = compare_commands(@spec_commands, @webdriver_oss_commands)
-      white_list.each { |v| result.delete v }
-      w3c_spec.each { |v| result.delete v }
-      result
-    end
-
     def diff_webdriver_w3c
       result = compare_commands(@spec_commands, @webdriver_w3c_commands)
       white_list.each { |v| result.delete v }

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 5.0.0.beta1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.14'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.1
+        version: 4.0.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.14'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.1
+        version: 4.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -262,12 +256,12 @@ files:
 - lib/appium_lib_core/common.rb
 - lib/appium_lib_core/common/base.rb
 - lib/appium_lib_core/common/base/bridge.rb
-- lib/appium_lib_core/common/base/bridge/mjsonwp.rb
 - lib/appium_lib_core/common/base/bridge/w3c.rb
 - lib/appium_lib_core/common/base/capabilities.rb
 - lib/appium_lib_core/common/base/command.rb
 - lib/appium_lib_core/common/base/driver.rb
 - lib/appium_lib_core/common/base/has_location.rb
+- lib/appium_lib_core/common/base/has_network_connection.rb
 - lib/appium_lib_core/common/base/http_default.rb
 - lib/appium_lib_core/common/base/platform.rb
 - lib/appium_lib_core/common/base/remote_status.rb
@@ -276,7 +270,6 @@ files:
 - lib/appium_lib_core/common/base/search_context.rb
 - lib/appium_lib_core/common/command.rb
 - lib/appium_lib_core/common/command/common.rb
-- lib/appium_lib_core/common/command/mjsonwp.rb
 - lib/appium_lib_core/common/command/w3c.rb
 - lib/appium_lib_core/common/device/app_management.rb
 - lib/appium_lib_core/common/device/app_state.rb
@@ -342,12 +335,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: 

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

@@ -1,91 +0,0 @@
-# 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
-      class Bridge
-        class MJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
-          include Device::DeviceLock
-          include Device::Keyboard
-          include Device::ImeActions
-          include Device::Setting
-          include Device::Context
-          include Device::Value
-          include Device::FileManagement
-          include Device::KeyEvent
-          include Device::ImageComparison
-          include Device::AppManagement
-          include Device::AppState
-          include Device::ScreenRecord::Command
-          include Device::Device
-          include Device::TouchActions
-          include Device::ExecuteDriver
-
-          def commands(command)
-            ::Appium::Core::Commands::MJSONWP::COMMANDS[command]
-          end
-
-          # Returns all available sessions on the Appium server instance
-          def sessions
-            execute :get_all_sessions
-          end
-
-          def status
-            execute :status
-          end
-
-          # For Appium
-          def log_event(vendor, event)
-            execute :post_log_event, {}, { vendor: vendor, event: event }
-          end
-
-          # For Appium
-          def log_events(type = nil)
-            args = {}
-            args['type'] = type unless type.nil?
-
-            execute :get_log_events, {}, args
-          end
-
-          def take_element_screenshot(element)
-            execute :take_element_screenshot, id: element.ref
-          end
-
-          def take_viewport_screenshot
-            # TODO: this hasn't been supported by Espresso driver
-            execute_script('mobile: viewportScreenshot')
-          end
-
-          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
-
-          def set_location(lat, lon, alt = 0.0, speed: nil)
-            loc = { latitude: lat, longitude: lon, altitude: alt }
-            loc[:speed] = speed unless speed.nil?
-            execute :set_location, {}, { location: loc }
-          end
-        end # class MJSONWP
-      end # class Bridge
-    end # class Base
-  end # module Core
-end # module Appium

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

@@ -1,28 +0,0 @@
-# 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
-    module Commands
-      module MJSONWP
-        COMMANDS = ::Appium::Core::Commands::COMMANDS.merge(::Appium::Core::Base::Commands::OSS).merge(
-          {
-            # W3C already has.
-            take_element_screenshot:    [:get, 'session/:session_id/element/:id/screenshot']
-          }
-        ).freeze
-      end # module MJSONWP
-    end # module Commands
-  end # module Core
-end # Appium