appium_lib 13.0.2 → 15.0.0

data/docs/w3c.md

@@ -11,11 +11,15 @@ dialect #=> :w3c
 el = find_element(:name, 'Pickers')
 driver.action.click(el).perform #=> work
 
+
+# Scroll/Swipe
 driver.action
       .move_to_location(500, 500).pointer_down(:left)
       .move_to_location(0, 700)
       .release.perform
 
+
+# Zoom in
 # multiple action chains
 f1 = driver.action.add_pointer_input(:touch, 'finger1')
 f1.create_pointer_move(duration: 1, x: 200, y: 500,
@@ -48,4 +52,4 @@ driver.perform_actions [f1, f2]
 ## Limitations
 - WebDriverAgent support only `touch` as a `pointer type`.
     - By default, [ruby_lib_core](https://github.com/appium/ruby_lib_core/blob/ab5d7c5ed31f318a9395e5aeafe1d0d655d3cff4/lib/appium_lib_core/common/base/w3c_bridge.rb#L26) generate `touch` based actions.
-    - About `pointer type` => [W3C](https://www.w3.org/TR/webdriver/#perform-actions) and [Simple WD Spec](https://github.com/jlipps/simple-wd-spec#perform-actions) 
+    - About `pointer type` => [W3C](https://www.w3.org/TR/webdriver/#perform-actions) and [Simple WD Spec](https://github.com/jlipps/simple-wd-spec#perform-actions)

data/lib/appium_lib/appium.rb

@@ -26,8 +26,6 @@ require_relative 'sauce_labs'
 require_relative 'common/wait'
 require_relative 'common/log'
 require_relative 'common/helper'
-require_relative 'common/multi_touch'
-require_relative 'common/touch_actions'
 require_relative 'common/http_client'
 require_relative 'common/device'
 require_relative 'common/command'

data/lib/appium_lib/common/device.rb

@@ -15,29 +15,5 @@
 module Appium
   module Device
     extend Forwardable
-
-    class << self
-      def extended(_mod)
-        add_touch_actions
-      end
-
-      private
-
-      def add_touch_actions
-        actions = Appium::TouchAction::COMPLEX_ACTIONS
-        actions.each do |method|
-          delegate_from_appium_driver(method, Appium::TouchAction)
-        end
-
-        # To keep compatibility
-        # pinch and zoom are defined in Appium::MultiTouch.
-        delegate_from_appium_driver(:pinch, Appium::MultiTouch)
-        delegate_from_appium_driver(:zoom, Appium::MultiTouch)
-      end
-
-      def delegate_from_appium_driver(method, delegation_target)
-        def_delegator delegation_target, method
-      end
-    end # class << self
   end # module Device
 end # module Appium

data/lib/appium_lib/driver.rb

@@ -64,8 +64,6 @@ module Appium
     # read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver
     attr_reader :caps
     attr_reader :custom_url
-    attr_reader :export_session
-    attr_reader :export_session_path
     attr_reader :default_wait
     attr_reader :appium_port
     attr_reader :appium_device
@@ -168,8 +166,6 @@ module Appium
 
       @caps = @core.caps
       @custom_url = @core.custom_url
-      @export_session = @core.export_session
-      @export_session_path = @core.export_session_path
       @default_wait = @core.default_wait || 0
       @appium_port = @core.port
       @appium_wait_timeout = @core.wait_timeout
@@ -279,8 +275,6 @@ module Appium
         caps:                @core.caps,
         automation_name:     @core.automation_name,
         custom_url:          @core.custom_url,
-        export_session:      @core.export_session,
-        export_session_path: @core.export_session_path,
         default_wait:        @default_wait,
         sauce_username:      @sauce.username,
         sauce_access_key:    @sauce.access_key,
@@ -327,7 +321,7 @@ module Appium
     # An entry point to chain W3C actions
     # Read https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Bridge/W3C#action-instance_method
     #
-    # @return [TouchAction|Selenium::WebDriver::PointerActions]
+    # @return [Selenium::WebDriver::PointerActions]
     #
     # @example
     #
@@ -364,7 +358,7 @@ module Appium
     def platform_version
       return [] if @driver.nil?
 
-      p_version = @driver.capabilities['platformVersion'] || @driver.session_capabilities['platformVersion']
+      p_version = @driver.capabilities['platformVersion']
       p_version.split('.').map(&:to_i)
     end
 
@@ -785,8 +779,7 @@ module Appium
 
     # @since Appium 1.16.0
     #
-    # Logs a custom event. The event is available via {::Appium::Core::Events#get} or
-    # <code>driver.session_capabilities['events']</code> with <code>eventTimings</code> capabilities.
+    # Logs a custom event. The event is available via {::Appium::Core::Events#get}.
     #
     # @param [String] vendor The vendor prefix for the event
     # @param [String] event The name of event

data/lib/appium_lib/version.rb

@@ -14,6 +14,6 @@
 
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '13.0.2' unless defined? ::Appium::VERSION
-  DATE    = '2024-01-25' unless defined? ::Appium::DATE
+  VERSION = '15.0.0' unless defined? ::Appium::VERSION
+  DATE    = '2024-04-11' unless defined? ::Appium::DATE
 end

data/release_notes.md

@@ -1,3 +1,24 @@
+#### v15.0.0 2024-04-11
+
+- [203a605](https://github.com/appium/ruby_lib/commit/203a6052db42039c89cd000f245f1534379bc86b) Release 15.0.0
+- [7ab9f44](https://github.com/appium/ruby_lib/commit/7ab9f442ee9a9d22ad021316171e6824628eeb99) chore: Update rubocop requirement from = 1.62.1 to = 1.63.0 (#1023)
+- [ad20d82](https://github.com/appium/ruby_lib/commit/ad20d828e8124f37c3ab3055c744c2c76c74f563) ci: add 3.3
+- [df9752c](https://github.com/appium/ruby_lib/commit/df9752c5176db395e7a427a77c4755293ff75cee) feat: remove "spec" deps (#1022)
+- [c5a7216](https://github.com/appium/ruby_lib/commit/c5a7216c005bb819ff7bc3fe313e7400777b9587) test: add empty test code (#1021)
+- [c450c20](https://github.com/appium/ruby_lib/commit/c450c20bae801e2f9f9ce66a9df2e352a614f73f) feat: bump ruby lib core v8 (#1018)
+- [9d40e0e](https://github.com/appium/ruby_lib/commit/9d40e0e2c2cbe571fd788c12565b3cb3d92f16a4) chore: Update rubocop requirement from = 1.62.0 to = 1.62.1 (#1020)
+- [98861af](https://github.com/appium/ruby_lib/commit/98861af3d779ce288937344a63aec7cbefed9db1) chore: Update rubocop requirement from = 1.61.0 to = 1.62.0 (#1017)
+- [1b385bc](https://github.com/appium/ruby_lib/commit/1b385bc2bab3f45d38a4f58e8c79ddbbe58d5596) chore: Update rubocop requirement from = 1.60.2 to = 1.61.0 (#1016)
+- [612d944](https://github.com/appium/ruby_lib/commit/612d944fc60b202d3e24c7e052004cef1b69c8d0) chore: Update rubocop requirement from = 1.60.1 to = 1.60.2 (#1013)
+
+
+#### v14.0.0 2024-01-25
+
+- [50cf980](https://github.com/appium/ruby_lib/commit/50cf980b570acd7d2d95ea64d1d1b0225f96c73b) Release 14.0.0
+- [978ed76](https://github.com/appium/ruby_lib/commit/978ed769120338d817fd69dadeb3894549021245) bump the major version as deprecation code removal
+- [ea3cc5d](https://github.com/appium/ruby_lib/commit/ea3cc5d41653f1df4b8bdad1ec36f142c1430e47) feat: remove deprecated export_session (#1015)
+
+
 #### v13.0.2 2024-01-25
 
 - [9c52fd3](https://github.com/appium/ruby_lib/commit/9c52fd3a8f0ef88d7c4e83f210ab22f817a30632) Release 13.0.2

data/test/first_test.rb

@@ -0,0 +1,29 @@
+# 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.
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest'
+
+begin
+  Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new]
+rescue Errno::ENOENT
+  # Ignore since Minitest::Reporters::JUnitReporter.new fails in deleting files, sometimes
+end
+
+class SampleTest < Minitest::Test
+  def test_test
+    assert(true)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 13.0.2
+  version: 15.0.0
 platform: ruby
 authors:
 - code@bootstraponline.com
@@ -9,28 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.4.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.4.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -167,48 +161,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.60.1
+        version: 1.63.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.60.1
+        version: 1.63.0
 - !ruby/object:Gem::Dependency
-  name: spec
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.4
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.4
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '1.1'
 description: Ruby library for Appium.
 email:
 - code@bootstraponline.com
@@ -265,8 +267,6 @@ files:
 - lib/appium_lib/common/helper.rb
 - lib/appium_lib/common/http_client.rb
 - lib/appium_lib/common/log.rb
-- lib/appium_lib/common/multi_touch.rb
-- lib/appium_lib/common/touch_actions.rb
 - lib/appium_lib/common/wait.rb
 - lib/appium_lib/driver.rb
 - lib/appium_lib/ios/common/errors.rb
@@ -296,6 +296,7 @@ files:
 - lib/appium_lib/version.rb
 - readme.md
 - release_notes.md
+- test/first_test.rb
 homepage: https://github.com/appium/ruby_lib
 licenses:
 - Apache-2.0

data/lib/appium_lib/common/multi_touch.rb

@@ -1,198 +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
-  # MultiTouch actions allow for multiple touches to happen at the same time,
-  # for instance, to simulate multiple finger swipes.
-  #
-  # Create a series of touch actions by themselves (without a `prepare()`), then
-  # add to a new MultiTouch action.  When ready, call `prepare()` and all
-  # actions will be executed simultaneously.
-  #
-  # @example
-  #
-  #   action_1 = TouchAction.new.press(x: 45, y: 100).wait(5).release
-  #   action_2 = TouchAction.new.tap(element: el, x: 50, y:5, count: 3)
-  #
-  #   multi_touch_action = MultiTouch.new
-  #   multi_touch_action.add action_1
-  #   multi_touch_action.add action_2
-  #   multi_touch_action.perform
-  #
-  #   # with an arbitrary driver
-  #   driver = Appium::Driver.new(opts, false).start_driver # return an Appium::Core::Base::Driver instance
-  #   multi_touch_action = MultiTouch.new(driver)
-  #   multi_touch_action.add action_1
-  #   multi_touch_action.add action_2
-  #   multi_touch_action.perform
-  #
-  class MultiTouch < Core::MultiTouch
-    class << self
-      # Convenience method for pinching the screen.
-      # Places two fingers at the edges of the screen and brings them together.
-      # @param percentage (int) The percent size by which to shrink the screen when pinched.
-      # @param auto_perform (boolean) Whether to perform the action immediately (default true)
-      # @param driver (Driver) Set a driver to conduct the action. DEfault is global driver($driver)
-      #
-      # @example
-      #
-      #   pinch 75 #=> Pinch the screen from the top right and bottom left corners
-      #
-      # Without auto_perform
-      #
-      # @example
-      #
-      #   action = pinch 75, false #=> Pinch the screen from the top right and bottom left corners
-      #   action.perform    #=> to 25% of its size.
-      #
-      # With driver
-      #
-      # @example
-      #   driver =  Appium::Driver.new(opts, false).start_driver
-      #   pinch 75, true, driver #=> Pinch the screen from the top right and bottom left corners
-      #
-      def pinch(percentage = 25, auto_perform = true, driver = $driver)
-        raise ArgumentError("Can't pinch to greater than screen size.") if percentage > 100
-
-        rate = Float(percentage) / 100
-        pinch = MultiTouch.new(driver)
-
-        if driver.device_is_android?
-          top, bottom = pinch_android(rate, pinch.driver)
-        else
-          top, bottom = pinch_ios(rate, pinch.driver)
-        end
-
-        pinch.add top
-        pinch.add bottom
-        return pinch unless auto_perform
-
-        pinch.perform
-      end
-
-      # Convenience method for zooming the screen.
-      # Places two fingers at the edges of the screen and brings them together.
-      # @param percentage (int) The percent size by which to shrink the screen when pinched.
-      # @param auto_perform (boolean) Whether to perform the action immediately (default true)
-      # @param driver (Driver) Set a driver to conduct the action. DEfault is global driver($driver)
-      #
-      # @example
-      #
-      #   action = zoom 200 #=> Zoom in the screen from the center until it doubles in size.
-      #
-      # Without auto_perform
-      #
-      # @example
-      #
-      #   action = zoom 200, false #=> Zoom in the screen from the center until it doubles in size.
-      #   action.perform    #=> to 25% of its size.
-      #
-      # With driver
-      #
-      # @example
-      #
-      #   driver =  Appium::Driver.new(opts, false).start_driver
-      #   pinch 200, true, driver #=> Zoom in the screen from the center until it doubles in size.
-      #
-      def zoom(percentage = 200, auto_perform = true, driver = $driver)
-        raise ArgumentError("Can't zoom to smaller then screen size.") if percentage < 100
-
-        rate = 100 / Float(percentage)
-        zoom = MultiTouch.new(driver)
-
-        if driver.device_is_android?
-          top, bottom = zoom_android(rate, zoom.driver)
-        else
-          top, bottom = zoom_ios(rate, zoom.driver)
-        end
-
-        zoom.add top
-        zoom.add bottom
-        return zoom unless auto_perform
-
-        zoom.perform
-      end
-
-      private
-
-      # @private
-      def pinch_android(rate, driver)
-        height = 100
-        offset = 100
-
-        top = ::Appium::Core::TouchAction.new(driver)
-        top.swipe start_x: offset, start_y: 1.0 * height + offset,
-                  end_x: 0.0, end_y: (rate - 1) * height, duration: 1_000
-
-        bottom = ::Appium::Core::TouchAction.new(driver)
-        bottom.swipe start_x: offset, start_y: 0.0 + offset,
-                     end_x: 0.0, end_y: (1 - rate) * height, duration: 1_000
-
-        [top, bottom]
-      end
-
-      # @private
-      def pinch_ios(rate, driver)
-        height = 100
-        offset = 100
-
-        top = ::Appium::Core::TouchAction.new(driver)
-        top.swipe start_x: 0.5, start_y: 0.0 + offset,
-                  end_x: 0.0, end_y: (1 - rate) * height, duration: 1_000
-
-        bottom = ::Appium::Core::TouchAction.new(driver)
-        bottom.swipe start_x: 0.5, start_y: 1.0 + offset,
-                     end_x: 0.0, end_y: rate * height, duration: 1_000
-
-        [top, bottom]
-      end
-
-      # @private
-      def zoom_android(rate, driver)
-        height = 100
-        offset = 100
-
-        top = ::Appium::Core::TouchAction.new(driver)
-        top.swipe start_x: offset, start_y: (1.0 - rate) * height + offset,
-                  end_x: 0.0, end_y: (rate - 1.0) * height, duration: 1_000
-
-        bottom = ::Appium::Core::TouchAction.new(driver)
-        bottom.swipe start_x: offset, start_y: rate * height + offset,
-                     end_x: 0.0, end_y: (1.0 - rate) * height, duration: 1_000
-
-        [top, bottom]
-      end
-
-      # @private
-      def zoom_ios(rate, driver)
-        height = 100
-        offset = 100
-
-        top = ::Appium::Core::TouchAction.new(driver)
-        top.swipe start_x: 0.5, start_y: (1 - rate) * height + offset,
-                  end_x: 0.0, end_y: - (1 - rate) * height, duration: 1_000
-
-        bottom = ::Appium::Core::TouchAction.new(driver)
-        bottom.swipe start_x: 0.5, start_y: rate * height + offset,
-                     end_x: 0.0, end_y: (1 - rate) * height, duration: 1_000
-
-        [top, bottom]
-      end
-    end # self
-
-    def initialize(driver = $driver)
-      super(driver)
-    end
-  end # class MultiTouch
-end # module Appium

data/lib/appium_lib/common/touch_actions.rb

@@ -1,76 +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
-  # Perform a series of gestures, one after another.  Gestures are chained
-  # together and only performed when `perform()` is called. Default is conducted by global driver.
-  #
-  # Each method returns the object itself, so calls can be chained.
-  #
-  # @example
-  #
-  #   action = TouchAction.new.press(x: 45, y: 100).wait(5).release
-  #   action.perform
-  #   action = TouchAction.new.swipe(....)
-  #   action.perform
-  #
-  # Or each methods can call without `TouchAction.new` as the following.
-  # In this case, `perform` is called automatically.
-  #
-  # @example
-  #
-  #   # called `swipe(...).perform` in this method.
-  #   swipe(start_x: 75, start_y: 500, end_x: 75, end_y: 20, duration: 500)
-  #
-  # If you'd like to perform the chain with an arbitrary driver:
-  #
-  # @example
-  #
-  #   driver =  Appium::Driver.new(opts, false).start_driver # return an Appium::Core::Base::Driver instance
-  #   action = TouchAction.new(driver).press(x: 45, y: 100).wait(5).release
-  #   action.perform
-  #   action = TouchAction.new(driver).swipe(....)
-  #   action.perform
-  #
-  class TouchAction < ::Appium::Core::TouchAction
-    COMPLEX_ACTIONS = ::Appium::Core::TouchAction::COMPLEX_ACTIONS
-
-    class << self
-      COMPLEX_ACTIONS.each do |action|
-        define_method(action) do |opts|
-          auto_perform = opts.delete(:auto_perform) { |_k| true }
-          ta = ::Appium::TouchAction.new($driver)
-          ta.send(action, opts)
-          return ta unless auto_perform
-
-          ta.perform
-        end
-      end
-    end
-
-    def initialize(driver = $driver)
-      super driver
-    end
-
-    def swipe(opts)
-      start_x = opts.fetch :start_x, 0
-      start_y = opts.fetch :start_y, 0
-      end_x = opts.fetch :end_x, 0
-      end_y = opts.fetch :end_y, 0
-      duration = opts.fetch :duration, 200
-
-      super(start_x: start_x, start_y: start_y, end_x: end_x, end_y: end_y, duration: duration)
-    end
-  end # class TouchAction
-end # module Appium