appium_lib_core 9.5.1 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65d659dce3980c45c306b4e6e2da0f9e089428b2de1bd881bf8a276f37e66900
-  data.tar.gz: 6d8e9e621366cef67cbd8e40ddbe8e1a79eb0e191cb5295bdd19e583dfc770fa
+  metadata.gz: 12d386d3e8769c8292b096b65b8de708fcecea995775f50e3dbc1a7025b97c42
+  data.tar.gz: '096f64ed445ce70b10f49873e627cdcfdbf5431a718615a68089333a18b4ad13'
 SHA512:
-  metadata.gz: fbd3f5b0aa25fbb1ca35ef4002a1a49470a329bcab6d0ea12c01679cb3ee8834f41f33b702fa31caaa44e80236b8e6cd2d07c74c3dec54711a1b68a128243475
-  data.tar.gz: bbab7740cde1fd3995a1c55dcf46ff8452f1db4286b595995c0840a3a81947acc7245b97a1bd2667ca514b5b52466f1fbdb1b4e1ba9d58c00f9eef8d35903615
+  metadata.gz: 784554dc3954ff170b3f79c50cda1a23bcaaeaf55a349d4a2a0ecb12db5b6f7c908f4e882de6e9a5b2afd42c9d87a2815c414e16181f680f92b91f3f7bedef18
+  data.tar.gz: 9e71aa8a9a7093a607c4d2aa17b72b1f16c5eabe0b5fcc1e8ed34c4c16d18ddc80a411d748c5cbde82d38756eb540c8c355ccb4339c62864733b50e521e43d00

data/CHANGELOG.md

@@ -2,13 +2,14 @@
 All notable changes to this project will be documented in this file.
 Read `release_notes.md` for commit level details.
 
-## [Unreleased]
+## [10.0.0] - 2025-02-16
 
 ### Enhancements
+- Use `http://127.0.0.1:4723` as the default url destination instead of `http://127.0.0.1:4723/wd/hub`
+    - `--base-path` in appium server may need to drop the `/wd/hub`
 
-### Bug fixes
-
-### Deprecations
+## [9.5.2] - 2025-01-30
+- Fix yardoc
 
 ## [9.5.1] - 2025-01-29
 

data/Gemfile

@@ -8,8 +8,8 @@ gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'parallel_tests'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.71.0'
+gem 'rubocop', '1.71.2'
 gem 'simplecov'
 gem 'steep', '~> 1.9.3'
-gem 'webmock', '~> 3.24.0'
+gem 'webmock', '~> 3.25.0'
 gem 'yard', '~> 0.9.11'

data/README.md

@@ -49,7 +49,7 @@ Run functional tests which require the Appium server and real device, Simulator/
 $ npm install --location=global appium
 $ appium driver install xcuitest
 $ appium driver install uiautomator2 # etc
-$ appium --base-path=/wd/hub --relaxed-security # To run all tests in local
+$ appium --relaxed-security # To run all tests in local
 ```
 
 - Conduct tests
@@ -146,7 +146,7 @@ As of version 5.8.0, the client can attach to an existing session. The main purp
 
 ```ruby
 # @driver is the driver instance of an existing session
-attached_driver = ::Appium::Core::Driver.attach_to @driver.session_id, url: 'http://127.0.0.1:4723/wd/hub', automation_name: 'XCUITest', platform_name: 'ios'
+attached_driver = ::Appium::Core::Driver.attach_to @driver.session_id, url: 'http://127.0.0.1:4723', automation_name: 'XCUITest', platform_name: 'ios'
 assert attached_driver.session_id == @driver.session_id
 attached_driver.page_source
 ```

data/lib/appium_lib_core/android/device.rb

@@ -126,16 +126,14 @@ module Appium
         #
 
         # @!method location=
-        # Set the location of the device.
-        #
-        # @param [::Appium::Location] location Set the location.
+        # Set the [::Appium::Location] of the device.
         #
         # @example
         #
         #   driver.location = ::Appium::Location.new(10, 10, 10)
         #
 
-        # @!method set_location
+        # @!method set_location(latitude, longitude, altitude, speed: nil, satellites: nil)
         # Set the location of the device.
         #
         # @param [String, Number] latitude Set the latitude.
@@ -145,7 +143,6 @@ module Appium
         #                               in meters/second @since Appium 1.21.0 and in knots for emulators @since Appium 1.22.0.
         # @param [String, Number] satellites Sets the count of geo satellites being tracked in range 1..12 @since Appium 1.22.0.
         #                                    This number is respected on Emulators.
-        # @param [::Appium::Location]
         #
         # @example
         #

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

@@ -59,16 +59,16 @@ module Appium
         # Appium only.
         # Attach to an existing session.
         #
-        # @param [String] The session id to attach to.
+        # @param [String] session_id The session id to attach to.
         # @param [String] platform_name The platform name to keep in the dummy capabilities
-        # @param [String] platform_name The automation name to keep in the dummy capabilities
+        # @param [String] automation_name The automation name to keep in the dummy capabilities
         # @return [::Appium::Core::Base::Capabilities]
         #
         # @example
         #
         #   new_driver = ::Appium::Core::Driver.attach_to(
         #     driver.session_id,
-        #     url: 'http://127.0.0.1:4723/wd/hub', automation_name: 'UiAutomator2', platform_name: 'Android'
+        #     url: 'http://127.0.0.1:4723', automation_name: 'UiAutomator2', platform_name: 'Android'
         #   )
         #
         def attach_to(session_id, platform_name, automation_name)

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

@@ -625,14 +625,14 @@ module Appium
         #
         # @param [String] path The absolute local path or remote http URL to an .ipa or .apk file,
         #                      or a .zip containing one of these.
-        # @param [Boolean] replace Only for Android. Whether to reinstall/upgrade the package if it is already present
+        # @option [Boolean] replace Only for Android. Whether to reinstall/upgrade the package if it is already present
         #                          on the device under test. +true+ by default
-        # @param [Integer] timeout Only for Android. How much time to wait for the installation to complete.
+        # @option [Integer] timeout Only for Android. How much time to wait for the installation to complete.
         #                          60000ms by default.
-        # @param [Boolean] allow_test_packages Only for Android. Whether to allow installation of packages marked as test
+        # @option [Boolean] allow_test_packages Only for Android. Whether to allow installation of packages marked as test
         #                                      in the manifest. +false+ by default
-        # @param [Boolean] use_sdcard Only for Android. Whether to use the SD card to install the app. +false+ by default
-        # @param [Boolean] grant_permissions Only for Android. whether to automatically grant application permissions
+        # @option [Boolean] use_sdcard Only for Android. Whether to use the SD card to install the app. +false+ by default
+        # @option [Boolean] grant_permissions Only for Android. whether to automatically grant application permissions
         #                                    on Android 6+ after the installation completes. +false+ by default
         #
         # Other parameters such as https://github.com/appium/appium-xcuitest-driver#mobile-installapp also can be set.
@@ -1014,7 +1014,7 @@ module Appium
 
         # Convert vanilla element response to ::Appium::Core::Element
         #
-        # @param [Hash] id The id which can get as a response from server
+        # @param [Hash] response_id id The id which can get as a response from server
         # @return [::Appium::Core::Element]
         #
         # @example

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

@@ -56,7 +56,6 @@ module Appium
         #                               in meters/second @since Appium 1.21.0 and in knots for emulators @since Appium 1.22.0.
         # @param [String, Number] satellites Sets the count of geo satellites being tracked in range 1..12 @since Appium 1.22.0.
         #                                    This number is respected on Emulators.
-        # @param [::Appium::Location]
         #
         # @example
         #

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

@@ -46,18 +46,7 @@ module Appium
         # Can be fully qualified, or simple, and simple defaults to <code>androidx.test.espresso.matcher</code> package
         # (e.g.: <code>class=CursorMatchers</code> fully qualified is <code>class=androidx.test.espresso.matcher.CursorMatchers</code>
         #
-        # See example how to send viewmatcher and datamatcher in Ruby client
-        #
-        #
-        # @overload find_element(how, what)
-        #   @param [Symbol, String] how The method to find the element by
-        #   @param [String] what The locator to use
-        #
-        # @overload find_element(opts)
-        #   @param [Hash] opts Find options
-        #   @option opts [Symbol] :how Key named after the method to find the element by, containing the locator
-        # @return [Element]
-        # @raise [Error::NoSuchElementError] if the element doesn't exist
+        # See test code in the client repository to see how to send viewmatcher and datamatcher in Ruby client
         #
         # @example Find element with each keys
         #
@@ -101,7 +90,6 @@ module Appium
         #     e.tag_name #=> "XCUIElementTypeStaticText"
         #
         # rubocop:enable Layout/LineLength
-
         APPIUM_EXTRA_FINDERS = {
           accessibility_id:     'accessibility id',
           image:                '-image',

data/lib/appium_lib_core/driver.rb

@@ -129,7 +129,7 @@ module Appium
       attr_reader :automation_name
 
       # Custom URL for the selenium server. If set this attribute, ruby_lib_core try to handshake to the custom url.<br>
-      # Defaults to false. Then try to connect to <code>http://127.0.0.1:#{port}/wd/hub</code>.
+      # Defaults to false. Then try to connect to <code>http://127.0.0.1:#{port}</code>.
       # @return [String]
       attr_reader :custom_url
 
@@ -196,7 +196,7 @@ module Appium
       #     # format 1
       #     @core = Appium::Core.for caps: {...}, appium_lib: {...}
       #     # format 2. 'capabilities:' is also available instead of 'caps:'.
-      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", capabilities: {...}, appium_lib: {...}
+      #     @core = Appium::Core.for url: "http://127.0.0.1:8080", capabilities: {...}, appium_lib: {...}
       #
       #
       #     require 'rubygems'
@@ -220,7 +220,7 @@ module Appium
       #              }
       #            }
       #     @core = Appium::Core.for(opts) # create a core driver with 'opts' and extend methods into 'self'
-      #     @core.start_driver # Connect to 'http://127.0.0.1:8080/wd/hub' because of 'port: 8080'
+      #     @core.start_driver # Connect to 'http://127.0.0.1:8080' because of 'port: 8080'
       #
       #     # Start iOS driver with .zip file over HTTP
       #     # 'capabilities:' is also available instead of 'caps:'. Either is fine.
@@ -233,7 +233,7 @@ module Appium
       #                app: 'http://example.com/path/to/MyiOS.app.zip'
       #              },
       #              appium_lib: {
-      #                server_url: 'http://custom-host:8080/wd/hub.com',
+      #                server_url: 'http://custom-host:8080/wd/hub',
       #                wait: 0,
       #                wait_timeout: 20,
       #                wait_interval: 0.3,
@@ -241,11 +241,11 @@ module Appium
       #              }
       #            }
       #     @core = Appium::Core.for(opts)
-      #     @core.start_driver # Connect to 'http://custom-host:8080/wd/hub.com'
+      #     @core.start_driver # Connect to 'http://custom-host:8080/wd/hub'
       #
       #     # Start iOS driver as another format. 'url' is available like below
       #     opts = {
-      #              url: "http://custom-host:8080/wd/hub.com",
+      #              url: "http://custom-host:8080/wd/hub",
       #              capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
@@ -261,7 +261,7 @@ module Appium
       #              }
       #            }
       #     @core = Appium::Core.for(opts) # create a core driver with 'opts' and extend methods into 'self'
-      #     @core.start_driver # start driver with 'url'. Connect to 'http://custom-host:8080/wd/hub.com'
+      #     @core.start_driver # start driver with 'url'. Connect to 'http://custom-host:8080/wd/hub'
       #
       #     # With a custom listener
       #     class CustomListener < ::Selenium::WebDriver::Support::AbstractEventListener
@@ -290,7 +290,7 @@ module Appium
       # an endpoint to get running session's capabilities.
       #
       #
-      # @param [String] The session id to attach to.
+      # @param [String] session_id The session id to attach to.
       # @param [String] url The WebDriver URL to attach to with the session_id.
       # @param [String] automation_name The platform name to keep in the dummy capabilities
       # @param [String] platform_name The automation name to keep in the dummy capabilities
@@ -300,7 +300,7 @@ module Appium
       #
       #   new_driver = ::Appium::Core::Driver.attach_to(
       #     driver.session_id,  # The 'driver' has an existing session id
-      #     url: 'http://127.0.0.1:4723/wd/hub', automation_name: 'UiAutomator2', platform_name: 'Android'
+      #     url: 'http://127.0.0.1:4723', automation_name: 'UiAutomator2', platform_name: 'Android'
       #   )
       #   new_driver.page_source # for example
       #
@@ -352,7 +352,7 @@ module Appium
       # Creates a new global driver and quits the old one if it exists.
       # You can customise http_client as the following
       #
-      # @param [String] server_url Custom server url to send to requests. Default is "http://127.0.0.1:4723/wd/hub".
+      # @param [String] server_url Custom server url to send to requests. Default is "http://127.0.0.1:4723".
       # @param http_client_ops [Hash] Options for http client
       # @option http_client_ops [Hash] :http_client Custom HTTP Client
       # @option http_client_ops [Hash] :open_timeout Custom open timeout for http client.
@@ -383,10 +383,10 @@ module Appium
       #            }
       #
       #     @core = Appium::Core.for(opts) # create a core driver with 'opts' and extend methods into 'self'
-      #     @driver = @core.start_driver server_url: "http://127.0.0.1:8000/wd/hub"
+      #     @driver = @core.start_driver server_url: "http://127.0.0.1:8000"
       #
       #     # Attach custom HTTP client
-      #     @driver = @core.start_driver server_url: "http://127.0.0.1:8000/wd/hub",
+      #     @driver = @core.start_driver server_url: "http://127.0.0.1:8000",
       #                                  http_client_ops: { http_client: Your:Http:Client.new,
       #                                                     open_timeout: 1_000,
       #                                                     read_timeout: 1_000 }
@@ -394,7 +394,7 @@ module Appium
 
       def start_driver(server_url: nil,
                        http_client_ops: { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 })
-        @custom_url ||= "http://127.0.0.1:#{@port}/wd/hub"
+        @custom_url ||= "http://127.0.0.1:#{@port}"
         @custom_url = server_url unless server_url.nil?
 
         @http_client = get_http_client http_client: http_client_ops.delete(:http_client),

data/lib/appium_lib_core/mac2/device.rb

@@ -23,7 +23,7 @@ module Appium
         # rubocop:disable Layout/LineLength
 
         # @since Appium 1.20.0
-        # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil, fps: nil, preset: nil, video_filter: nil, enable_capture_clicks: nil, enable_cursor_capture: nil, device_id: nil)
+        # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil, fps: nil, preset: nil, video_filter: nil, enable_capture_clicks: nil, enable_cursor_capture: nil, device_id: nil, time_limit: nil)
         #
         # Record the display of devices running iOS Simulator since Xcode 9 or real devices since iOS 11
         # (ffmpeg utility is required: 'brew install ffmpeg').

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '9.5.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2025-01-29' unless defined? ::Appium::Core::DATE
+    VERSION = '10.0.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2025-02-16' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core.rb

@@ -27,7 +27,8 @@ module Appium
   # @param [Hash] hash Hash value to make symbolise
   #
   # @example
-  # opts = Appium.symbolize_keys(opts)
+  #
+  #   opts = Appium.symbolize_keys(opts)
   #
   def self.symbolize_keys(hash, nested: false, enable_deprecation_msg: true)
     # FIXME: As https://github.com/appium/ruby_lib/issues/945, we must remove this implicit string to symbol.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 9.5.1
+  version: 10.0.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket