appium_lib 9.8.1 → 9.8.2

data/docs/w3c.md

@@ -0,0 +1,30 @@
+Perform touch actions for W3C module. Generate `touch` pointer action here and users can use this via `driver.action`
+
+[Documentation](http://www.rubydoc.info/github/appium/ruby_lib_core/Appium%2FCore%2FBase%2FCoreBridgeW3C:action)
+
+# Example
+
+```ruby
+dialect #=> :w3c
+
+# then
+el = find_element(:name, 'Pickers')
+driver.action.click(el).perform #=> work
+
+driver.action
+      .move_to_location(500, 500).pointer_down(:left)
+      .move_to_location(0, 700)
+      .release.perform
+```
+
+# Note
+## Coordinate points
+- jsonwp
+    - Relative action coordinates are counted relatively to the **top left point** of element's rectangle
+- W3C
+    - Relative action coordinates are counted relatively to the **center** of element's rectangle
+
+## 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) 

data/lib/appium_lib/android/android.rb

@@ -1,4 +1,5 @@
 require_relative 'common/helper'
+require_relative 'common/command/command'
 
 require_relative 'element/alert'
 require_relative 'element/button'
@@ -17,6 +18,7 @@ module Appium
     class Bridge
       def self.for(target)
         target.extend Appium::Android
+        target.extend Appium::Android::Command
       end
     end
   end

data/lib/appium_lib/android/common/command/command.rb

@@ -0,0 +1,21 @@
+module Appium
+  module Android
+    module Command
+      # Conduct an adb shell script on Appium server.
+      # Require `--relaxed-security` arguments when run Appium server as server side arguments.
+      #
+      # @param [String] command Command for "adb shell"
+      # @param [Array] arguments Arguments for the adb command
+      #
+      # @example
+      #
+      #   shell "echo", "list" #=> "list"
+      #
+      def shell(command, arguments)
+        args = { command: command, args: arguments }
+        # --relaxed-security
+        @driver.execute_script 'mobile: shell', args
+      end
+    end
+  end
+end

data/lib/appium_lib/android/espresso/bridge.rb

@@ -6,6 +6,7 @@ module Appium
       class Bridge
         def self.for(target)
           target.extend Appium::Android
+          target.extend Appium::Android::Command
           target.extend Appium::Android::Espresso
         end
       end

data/lib/appium_lib/android/uiautomator2/bridge.rb

@@ -6,6 +6,7 @@ module Appium
       class Bridge
         def self.for(target)
           target.extend Appium::Android
+          target.extend Appium::Android::Command
           target.extend Appium::Android::Uiautomator2
           target.extend Appium::Android::Uiautomator2::Helper
           target.extend Appium::Android::Uiautomator2::Element

data/lib/appium_lib/driver.rb

@@ -282,6 +282,26 @@ module Appium
       !@core.automation_name.nil? && @core.automation_name == :xcuitest
     end
 
+    # Get the dialect value whether current driver is OSS or W3C
+    #
+    # @return [:oss | :w3c]
+    #
+    #  @example
+    #
+    #      if dialect == :w3c
+    #        driver.action
+    #              .move_to_location(500, 500).pointer_down(:left)
+    #              .move_to_location(0, 700)
+    #              .release.perform
+    #      else
+    #        action = TouchAction.new(driver).press(x: 500, y: 500).move_to(500, 700).release
+    #        action.perform
+    #      end
+    #
+    def dialect
+      @driver.dialect
+    end
+
     # Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST.
     # If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised.
     # @return [Boolean]
@@ -395,9 +415,23 @@ module Appium
     #   screenshot '/tmp/hi.png'
     #
     # @param png_save_path [String] the full path to save the png
-    # @return [nil]
+    # @return [File]
     def screenshot(png_save_path)
       @driver.save_screenshot png_save_path
+    end
+
+    # Takes a png screenshot of particular element's area
+    #
+    # @example
+    #
+    #   el = find_element :accessibility_id, zzz
+    #   element_screenshot el, '/tmp/hi.png'
+    #
+    # @param [String] element Element take a screenshot
+    # @param [String] png_save_path the full path to save the png
+    # @return [File]
+    def element_screenshot(element, png_save_path)
+      @driver.take_element_screenshot element, png_save_path
       nil
     end
 
@@ -467,8 +501,6 @@ module Appium
       @appium_server_status = appium_server_version
       check_server_version_xcuitest
 
-      set_implicit_wait(@core.default_wait)
-
       @driver
     end
 

data/lib/appium_lib/ios/xcuitest/bridge.rb

@@ -8,10 +8,11 @@ module Appium
           target.extend Appium::Ios
           target.extend Appium::Ios::Device
           target.extend Appium::Ios::Xcuitest
-          target.extend Appium::Ios::Xcuitest::Command
+          target.extend Appium::Ios::Xcuitest::PasteBoard
           target.extend Appium::Ios::Xcuitest::Source
           target.extend Appium::Ios::Xcuitest::Helper
           target.extend Appium::Ios::Xcuitest::Gesture
+          target.extend Appium::Ios::Xcuitest::MultiAppHandler
           target.extend Appium::Ios::Xcuitest::Element
         end
       end

data/lib/appium_lib/ios/xcuitest/command.rb

@@ -1,6 +1,7 @@
 require_relative 'command/pasteboard'
 require_relative 'command/gestures'
 require_relative 'command/source'
+require_relative 'command/multi_app_handler'
 
 module Appium
   module Ios

data/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb

@@ -0,0 +1,125 @@
+module Appium
+  module Ios
+    module Xcuitest
+      # **Note** Works only for Xcode 9+.
+      # Instance methods have `xcuitest_` prefix to prevent conflicts for core commands.
+      # see: https://github.com/appium/ruby_lib_core/blob/82e2526de95b05e8a49872e0b69835e99acc66e5/lib/appium_lib_core/common/command.rb#L39
+      module MultiAppHandler
+        # Installs given application to the device under test. If the same application is already installed
+        # then it's going to be installed over it, which allows to test upgrades.
+        # Be careful while reinstalling the main application under test - make sure you called terminateApp
+        # for it first, otherwise WebDriverAgent will detect it as a potential application crash.
+        #
+        # @param [String] app The path to an existing .ipa/.app file on the server file system, zipped .app file
+        #                     or an URL pointing to a remote .ipa/.zip file. Mandatory argument.
+        # @return {}
+        #
+        # @example
+        #
+        #     xcuitest_install_app(app: "path/to/app.app")
+        #
+        def xcuitest_install_app(app:)
+          args = { app: app }
+          @driver.execute_script 'mobile: installApp', args
+        end
+
+        # Verifies whether the application with given bundle identifier is installed on the device.
+        #
+        # @param [String] bundle_id The bundle identifier of the application, which is going to be verified.
+        # @return [boolean]
+        #
+        # @example
+        #
+        #     xcuitest_app_installed?(bundle_id: "io.appium.bundle") #=> true or false
+        #
+        def xcuitest_app_installed?(bundle_id:)
+          args = { bundleId: bundle_id }
+          @driver.execute_script 'mobile: isAppInstalled', args
+        end
+
+        # Uninstalls an existing application from the device under test. This endpoint does not verify
+        # whether the application is already installed or not before uninstalling it.
+        #
+        # @param [String] bundle_id The bundle identifier of the application, which is going to be uninstalled.
+        # @return {}
+        #
+        # @example
+        #
+        #     xcuitest_remove_app(bundle_id: "io.appium.bundle") #=> 1
+        #
+        def xcuitest_remove_app(bundle_id:)
+          args = { bundleId: bundle_id }
+          @driver.execute_script 'mobile: removeApp', args
+        end
+
+        # Executes an existing application on the device. If the application is already running then
+        # it will be brought to the foreground.
+        #
+        # @param [String] bundle_id The bundle identifier of the application, which is going to be executed.
+        # @return {}
+        #
+        # @example
+        #
+        #     xcuitest_launch_app(bundle_id: "io.appium.bundle") #=> 1
+        #
+        def xcuitest_launch_app(bundle_id:)
+          args = { bundleId: bundle_id }
+          @driver.execute_script 'mobile: launchApp', args
+        end
+
+        # Terminates an existing application on the device. If the application is not running then
+        # the returned result will be false, otherwise true.
+        #
+        # @param [String] bundle_id The bundle identifier of the application, which is going to be terminated.
+        # @return {}
+        #
+        # @example
+        #
+        #     xcuitest_terminate_app(bundle_id: "io.appium.bundle") #=> 1
+        #
+        def xcuitest_terminate_app(bundle_id:)
+          args = { bundleId: bundle_id }
+          @driver.execute_script 'mobile: terminateApp', args
+        end
+
+        # Get the status of an existing application on the device.
+        # State:
+        #   0: The current application state cannot be determined/is unknown
+        #   1: The application is not running
+        #   2: The application is running in the background and is suspended
+        #   3: The application is running in the background and is not suspended
+        #   4: The application is running in the foreground
+        #
+        # For more details: https://developer.apple.com/documentation/xctest/xcuiapplicationstate
+        #
+        # @param [String] bundle_id A target app's bundle id
+        # @return [0|1|2|3|4] A number of the state
+        #
+        # @example
+        #
+        #     xcuitest_query_app_status(bundle_id: "io.appium.bundle") #=> 1
+        #
+        def xcuitest_query_app_status(bundle_id:)
+          args = { bundleId: bundle_id }
+          @driver.execute_script 'mobile: queryAppState', args
+        end
+
+        # Activates an existing application on the device under test and moves it to the foreground.
+        # The application should be already running in order to activate it.
+        # The call is ignored if the application is already in foreground.
+        #
+        # @param [String] bundle_id The bundle identifier of the application, which is going to be brought to the foreground.
+        # @return {}
+        #
+        # @example
+        #
+        #     xcuitest_activate_app(bundle_id: "io.appium.bundle") #=> 1
+        #
+        def xcuitest_activate_app(bundle_id:)
+          args = { bundleId: bundle_id }
+          @driver.execute_script 'mobile: activateApp', args
+        end
+      end
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

data/lib/appium_lib/ios/xcuitest/command/pasteboard.rb

@@ -1,7 +1,7 @@
 module Appium
   module Ios
     module Xcuitest
-      module Command
+      module PasteBoard
         # @param [string] content The content of the pasteboard. The previous content is going to be overridden.
         #                         The parameter is mandatory
         # @option opts [string] :encoding Encoding of the given content. UTF-8 by default.

data/lib/appium_lib/ios/xcuitest/command/source.rb

@@ -1,6 +1,7 @@
 module Appium
   module Ios
     module Xcuitest
+      # Instance method have `xcuitest_` prefix to prevent conflicts for core commands.
       module Source
         # @param [String|Symbol] format :xml or :json. :xml is by default.
         # @option opts [Element] :element Element to swipe on

data/lib/appium_lib/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '9.8.1'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2017-12-16'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.8.2'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2017-12-27'.freeze unless defined? ::Appium::DATE
 end

data/release_notes.md

@@ -1,3 +1,12 @@
+#### v9.8.1 2017-12-17
+
+- [1081ae0](https://github.com/appium/ruby_lib/commit/1081ae01e7cf5c4682cadcf0219b07912cc3734f) [Release 9 8 1 (#731)](https://github.com/appium/ruby_lib/issues/731)
+- [8212de4](https://github.com/appium/ruby_lib/commit/8212de4037f8c0bcd0c9a5d828dec6db32ace697) [update ruby_core to fix creating session for the W3C createSession for Appium (#730)](https://github.com/appium/ruby_lib/issues/730)
+- [e12787d](https://github.com/appium/ruby_lib/commit/e12787dc1ebd35a9760e9e59e094bc30b2dfe627) [add alias (#725)](https://github.com/appium/ruby_lib/issues/725)
+- [047ed32](https://github.com/appium/ruby_lib/commit/047ed3296ce5a33a4ea9814348dc4b8af2fbebcc) [Release 9 8 0 (#724)](https://github.com/appium/ruby_lib/issues/724)
+- [9dfa0b9](https://github.com/appium/ruby_lib/commit/9dfa0b9c0c3df6f7ec88d578e304ad1fd3704742) [refactor: replace core directory to core library (#718)](https://github.com/appium/ruby_lib/issues/718)
+
+
 #### v9.7.5 2017-11-04
 
 - [1e1bb7e](https://github.com/appium/ruby_lib/commit/1e1bb7e3f1f500fa0dffe361b875b6b16941e290) [Release 9 7 5 (#717)](https://github.com/appium/ruby_lib/issues/717)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.8.1
+  version: 9.8.2
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-16 00:00:00.000000000 Z
+date: 2017-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: tomlrb
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +140,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -217,10 +217,12 @@ files:
 - docs/migration.md
 - docs/parallel.md
 - docs/travis.sample.yml
+- docs/w3c.md
 - docs_gen/docs_from_js.md
 - docs_gen/make_docs.rb
 - lib/appium_lib.rb
 - lib/appium_lib/android/android.rb
+- lib/appium_lib/android/common/command/command.rb
 - lib/appium_lib/android/common/helper.rb
 - lib/appium_lib/android/element/alert.rb
 - lib/appium_lib/android/element/button.rb
@@ -255,6 +257,7 @@ files:
 - lib/appium_lib/ios/xcuitest/bridge.rb
 - lib/appium_lib/ios/xcuitest/command.rb
 - lib/appium_lib/ios/xcuitest/command/gestures.rb
+- lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb
 - lib/appium_lib/ios/xcuitest/command/pasteboard.rb
 - lib/appium_lib/ios/xcuitest/command/source.rb
 - lib/appium_lib/ios/xcuitest/element.rb