feat: define Appium::Location (#447)

Author: KazuCocoa

CHANGELOG.md

@@ -6,10 +6,15 @@ Read `release_notes.md` for commit level details.
 
 ### Enhancements
 
+- Add `::Appium::Location` since `::Selenium::WebDriver::Location` no longer exists
+
 ### Bug fixes
 
 ### Deprecations
 
+- `::Selenium::WebDriver::Location` is deprecated in favor of `::Appium::Location` in Appium Ruby binding
+
+
 ## [6.1.0] - 2023-01-18
 
 ### Bug fixes

appium_lib_core.gemspec

@@ -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', '~> 4.2', '< 4.8'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.2', '< 4.9'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
   spec.add_development_dependency 'rake', '~> 13.0'

lib/appium_lib_core/common/base/bridge.rb

@@ -302,7 +302,7 @@ def network_connection=(type)
         # called in 'extend DriverExtensions::HasLocation'
         def location
           obj = execute(:get_location) || {}
-          ::Selenium::WebDriver::Location.new obj['latitude'], obj['longitude'], obj['altitude']
+          ::Appium::Location.new obj['latitude'], obj['longitude'], obj['altitude']
         end
 
         # For Appium

lib/appium_lib_core/common/base/has_location.rb

@@ -21,27 +21,27 @@ class Base
       module HasLocation
         # Get the location of the device.
         #
-        # @return [::Selenium::WebDriver::Location]
+        # @return [::Appium::Location]
         #
         # @example
         #
-        #   driver.location #=> ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #   driver.location #=> ::Appium::Location.new(10, 10, 10)
         #
         def location
           @bridge.location
         end
 
         # Set the location of the device.
         #
-        # @param [::Selenium::WebDriver::Location] location Set the location.
+        # @param [::Appium::Location] location Set the location.
         #
         # @example
         #
-        #   driver.location = ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #   driver.location = ::Appium::Location.new(10, 10, 10)
         #
         def location=(location)
-          unless location.is_a?(::Selenium::WebDriver::Location)
-            raise TypeError, "expected #{::Selenium::WebDriver::Location}, got #{location.inspect}:#{location.class}"
+          unless location.is_a?(::Appium::Location)
+            raise TypeError, "expected #{::Appium::Location}, got #{location.inspect}:#{location.class}"
           end
 
           @bridge.set_location location.latitude, location.longitude, location.altitude
@@ -56,17 +56,17 @@ def location=(location)
         #                               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 [::Selenium::WebDriver::Location]
+        # @param [::Appium::Location]
         #
         # @example
         #
-        #   driver.location = ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #   driver.location = ::Appium::Location.new(10, 10, 10)
         #
         def set_location(latitude, longitude, altitude, speed: nil, satellites: nil)
           if speed.nil? && satellites.nil?
-            self.location = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
+            self.location = ::Appium::Location.new(Float(latitude), Float(longitude), Float(altitude))
           else
-            loc = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
+            loc = ::Appium::Location.new(Float(latitude), Float(longitude), Float(altitude))
 
             speed = Float(speed) unless speed.nil?
             satellites = Integer(satellites) unless satellites.nil?

lib/appium_lib_core/driver.rb

@@ -15,6 +15,9 @@
 require 'uri'
 
 module Appium
+  # The struct for 'location'
+  Location = Struct.new(:latitude, :longitude, :altitude)
+
   module Core
     module Android
       autoload :Uiautomator1, 'appium_lib_core/android'

test/unit/android/webdriver/w3c/commands_test.rb

@@ -184,7 +184,7 @@ def test_set_location
               .with(body: { location: { latitude: 1.0, longitude: 1.0, altitude: 1.0 } }.to_json)
               .to_return(headers: HEADER, status: 200, body: { value: nil }.to_json)
 
-            @driver.location = ::Selenium::WebDriver::Location.new(1.0, 1.0, 1.0)
+            @driver.location = ::Appium::Location.new(1.0, 1.0, 1.0)
             @driver.set_location 1, 1, 1
 
             assert_requested(:post, "#{SESSION}/location", times: 2)