appium_lib_core 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: beb4e9d4de4aee51d10e20d5928b5643eb11718e
-  data.tar.gz: 8b84e2bf079a746c6dcfe8fda67ae20043c0abd5
+  metadata.gz: c04b7c34dd2c6871b41e81187a83b88ff5d88d1d
+  data.tar.gz: 2cb5ab6893ac740b4302364110a8b4fdf67afcbd
 SHA512:
-  metadata.gz: 46386acb4309665c91025d6e3dff55d91eed8a453d31deac7a018bd55d66148f7218189323fab82fb40938206b1195736bd19af0678985cc1a72e20ced113e1d
-  data.tar.gz: 431ad7793eb318ffff75fb8d97862977a16c0cfa55ddc4db9d2c3143f24a085563baa72eecf27a16cf8c2ac86fddc793835a77fa0591109097efdcf8cf808ab6
+  metadata.gz: e246e7f8d8c553bf034a90fc9a11678c50e4a171c77cc1ea9cb1a74bc4600a7e176908f70c30edd5c93d3c12519794aa2ff6135d8844215d82b489a9460a5f35
+  data.tar.gz: 49060b3ba5fd7bc18ada2e6f01f4e3e5e9021759d6d4f9ed208f54ce01a9173298b329d04306db627d8745b73c41ae071a70441c52092dc4d9f121d4bc24fde7

data/CHANGELOG.md

@@ -8,6 +8,31 @@ All notable changes to this project will be documented in this file.
 
 ### Deprecations
 
+## [1.3.1] - 2018-02-14
+### Enhancements
+- add some app management commands [#58](https://github.com/appium/ruby_lib_core/pull/58)
+    - Require Appium 1.8.0+
+- Both platforms work absolute based axis for `move_to` and `swipe`
+    - **Breaking Changes**
+        - Android was relevant, previously.
+        - e.g.:
+            ```ruby
+            # Do not move because of the start and end point is the same
+            # Tap (75, 500) and move the point to (75, 500) with duration 500ms.
+            Appium::Core::TouchAction.new(@driver)
+              .swipe(start_x: 75, start_y: 500, offset_x: 75, offset_y: 500, duration: 500)
+              .perform
+        
+            # Tap (75, 500) and move the point to (75, 1000) with duration 500ms.
+            Appium::Core::TouchAction.new(@driver)
+              .swipe(start_x: 75, start_y: 500, offset_x: 75, offset_y: 1000, duration: 500)
+              .perform
+            ```
+
+### Bug fixes
+
+### Deprecations
+
 ## [1.3.0] - 2018-01-28
 ### Enhancements
 - `start_recording_screen`/`stop_recording_screen` support iOS from `Appium 1.8.0` [#48](https://github.com/appium/ruby_lib_core/issues/48)

data/lib/appium_lib_core.rb

@@ -9,6 +9,7 @@ require_relative 'appium_lib_core/driver'
 require_relative 'appium_lib_core/device/touch_actions'
 require_relative 'appium_lib_core/device/multi_touch'
 require_relative 'appium_lib_core/device/screen_record'
+require_relative 'appium_lib_core/device/app_state'
 
 require_relative 'appium_lib_core/android'
 require_relative 'appium_lib_core/android_uiautomator2'

data/lib/appium_lib_core/android.rb

@@ -1,5 +1,4 @@
 # loaded in common/driver.rb
 require_relative 'android/search_context'
 require_relative 'android/device'
-require_relative 'android/touch'
 require_relative 'android/uiautomator1/bridge'

data/lib/appium_lib_core/android/device.rb

@@ -3,6 +3,8 @@ module Appium
     module Device
       extend Forwardable
 
+      # rubocop:disable Metrics/LineLength
+
       # @!method hide_keyboard(close_key = nil, strategy = nil)
       # Hide the onscreen keyboard
       # @param [String] close_key The name of the key which closes the keyboard.
@@ -27,10 +29,11 @@ module Appium
       # @!method start_activity(opts)
       # Android only. Start a new activity within the current app or launch a new app and start the target activity.
       #
-      # @option [String] The package owning the activity [required]
-      # @option [String] The target activity [required]
-      # @option opts [String] The package to start before the target package [optional]
-      # @option opts [String] The activity to start before the target activity [optional]
+      # @param opts [Hash] Options
+      # @option opts [String] :app_package The package owning the activity [required]
+      # @option opts [String] :app_activity The target activity [required]
+      # @option opts [String] :app_wait_package The package to start before the target package [optional]
+      # @option opts [String] :app_wait_activity The activity to start before the target activity [optional]
       #
       # @example
       #
@@ -69,19 +72,17 @@ module Appium
       # @!method get_performance_data(package_name:, data_type:, data_read_timeout: 1000)
       #   Get the resource usage information of the application.
       #   https://github.com/appium/appium-base-driver/blob/be29aec2318316d12b5c3295e924a5ba8f09b0fb/lib/mjsonwp/routes.js#L303
-      # @param [String] package_name Package name
-      # @param [String] data_type Data type get with `get_performance_data_types`
-      # @param [String] data_read_timeout Command timeout. Default is 2.
+      # @param [String] package_name: Package name
+      # @param [String] data_type: Data type get with `get_performance_data_types`
+      # @param [String] data_read_timeout: Command timeout. Default is 2.
       #
       # @example
       #
       #   @driver.get_performance_data package_name: package_name, data_type: data_type, data_read_timeout: 2
       #
 
-      # @!method start_recording_screen(remote_path:, user:, pass:, method:, force_restart:,
-      #                                 video_size:, time_limit:, bit_rate:)
-      #
-      # @option [String] remote_path The path to the remote location, where the resulting video should be uploaded.
+      # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil, video_size: nil, time_limit: '180', bit_rate: '4000000')
+      # @param [String] remote_path: The path to the remote location, where the resulting video should be uploaded.
       #                             The following protocols are supported: http/https, ftp.
       #                             Null or empty string value (the default setting) means the content of resulting
       #                             file should be encoded as Base64 and passed as the endpoint response value.
@@ -89,20 +90,20 @@ module Appium
       #                             fit into the available process memory.
       #                             This option only has an effect if there is screen recording process in progress
       #                             and `forceRestart` parameter is not set to `true`.
-      # @option [String] user The name of the user for the remote authentication.
-      # @option [String] pass The password for the remote authentication.
-      # @option [String] method The http multipart upload method name. The 'PUT' one is used by default.
-      # @option [Boolean] force_restart Whether to try to catch and upload/return the currently running screen recording
+      # @param [String] user: The name of the user for the remote authentication.
+      # @param [String] pass: The password for the remote authentication.
+      # @param [String] method: The http multipart upload method name. The 'PUT' one is used by default.
+      # @param [Boolean] force_restart: Whether to try to catch and upload/return the currently running screen recording
       #                                 (`false`, the default setting on server) or ignore the result of it
       #                                 and start a new recording immediately (`true`).
       #
-      # @option [String] video_size The format is widthxheight.
+      # @param [String] video_size: The format is widthxheight.
       #                             The default value is the device's native display resolution (if supported),
       #                             1280x720 if not. For best results,
       #                             use a size supported by your device's Advanced Video Coding (AVC) encoder.
       #                             For example, "1280x720"
-      # @param [String] time_limit Recording time. 180 seconds is by default.
-      # @param [String] bit_rate The video bit rate for the video, in megabits per second. 4 Mbps(4000000) is by default.
+      # @param [String] time_limit: Recording time. 180 seconds is by default.
+      # @param [String] bit_rate: The video bit rate for the video, in megabits per second. 4 Mbps(4000000) is by default.
       #
       # @example
       #
@@ -114,6 +115,8 @@ module Appium
       ## class << self
       ####
 
+      # rubocop:enable Metrics/LineLength
+
       class << self
         def extended(_mod)
           Appium::Core::Device.extend_webdriver_with_forwardable

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

@@ -6,8 +6,6 @@ module Appium
           def self.for(target)
             target.extend Appium::Android::Device
             Core::Android::SearchContext.extend
-
-            Core::Android::Touch.extend_touch_actions
           end
         end
       end

data/lib/appium_lib_core/android/uiautomator1/bridge.rb

@@ -6,8 +6,6 @@ module Appium
           def self.for(target)
             target.extend Appium::Android::Device
             Core::Android::SearchContext.extend
-
-            Core::Android::Touch.extend_touch_actions
           end
         end
       end

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

@@ -6,8 +6,6 @@ module Appium
           def self.for(target)
             target.extend Appium::Android::Device
             Core::Android::SearchContext.extend
-
-            Core::Android::Touch.extend_touch_actions
           end
         end
       end

data/lib/appium_lib_core/android_espresso.rb

@@ -1,5 +1,4 @@
 # loaded in common/driver.rb
 require_relative 'android/search_context'
 require_relative 'android/device'
-require_relative 'android/touch'
 require_relative 'android/espresso/bridge'

data/lib/appium_lib_core/android_uiautomator2.rb

@@ -1,5 +1,4 @@
 # loaded in common/driver.rb
 require_relative 'android/search_context'
 require_relative 'android/device'
-require_relative 'android/touch'
 require_relative 'android/uiautomator2/bridge'

data/lib/appium_lib_core/common/command.rb

@@ -38,6 +38,9 @@ module Appium
         install_app:                [:post, 'session/:session_id/appium/device/install_app'.freeze],
         remove_app:                 [:post, 'session/:session_id/appium/device/remove_app'.freeze],
         app_installed?:             [:post, 'session/:session_id/appium/device/app_installed'.freeze],
+        activate_app:               [:post, 'session/:session_id/appium/device/activate_app'.freeze],
+        terminate_app:              [:post, 'session/:session_id/appium/device/terminate_app'.freeze],
+        app_state:                  [:post, 'session/:session_id/appium/device/app_state'.freeze],
         background_app:             [:post, 'session/:session_id/appium/app/background'.freeze],
         hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
         press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'.freeze],

data/lib/appium_lib_core/common/device.rb

@@ -5,6 +5,8 @@ module Appium
     module Device
       extend Forwardable
 
+      # rubocop:disable Metrics/LineLength
+
       ####
       ## No argument
       ####
@@ -47,7 +49,7 @@ module Appium
 
       # @!method is_keyboard_shown
       # Get whether keyboard is displayed or not.
-      # @return [Bool] Return true if keyboard is shown. Return false if keyboard is hidden.
+      # @return [Boolean] Return true if keyboard is shown. Return false if keyboard is hidden.
       #
       # @example
       #   @driver.is_keyboard_shown # false
@@ -140,31 +142,83 @@ module Appium
       ## With arguments
       ####
 
-      # @!method install_app(path)
+      # @!method install_app(path, replace: nil, timeout: nil, allow_test_packages: nil, use_sdcard: nil, grant_permissions: nil)
       # Install the given app onto the device
       #
+      # @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 on the device under test. `true` by default
+      # @param [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 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 on Android 6+ after the installation completes. `false` by default
+      #
       # @example
       #
       #   @driver.install_app("/path/to/test.apk")
+      #   @driver.install_app("/path/to/test.apk", replace: true, timeout: 20000, allow_test_packages: true, use_sdcard: false, grant_permissions: false)
       #
 
-      # @!method remove_app(app_id)
-      # Install the given app onto the device
+      # @!method remove_app(app_id, keep_data: nil, timeout: nil)
+      #
+      # @param [Strong] app_id BundleId for iOS or package name for Android
+      # @param [Boolean] keep_data: Only for Android. Whether to keep application data and caches after it is uninstalled. `false` by default
+      # @param [Integer] timeout: Only for Android. How much time to wait for the uninstall to complete. 20000ms by default.
       #
       # @example
       #
       #   @driver.remove_app("io.appium.bundle")
+      #   @driver.remove_app("io.appium.bundle", keep_data: false, timeout, 10000)
       #
 
       # @!method app_installed?(app_id)
       # Check whether the specified app is installed on the device
-      # @return [bool]
+      # @return [Boolean]
       #
       # @example
       #
       #   @driver.app_installed?("io.appium.bundle")
       #
 
+      # @!method terminate_app(app_id)
+      # Terminate the specified app.
+      #
+      # @param [Strong] app_id BundleId for iOS or package name for Android
+      # @param [Integer] timeout: Only for Android. How much time to wait for the application termination to complete. 500ms by default.
+      # @return [Boolean]
+      #
+      # @example
+      #
+      #   @driver.terminate_app("io.appium.bundle") # true
+      #   @driver.terminate_app("io.appium.bundle", timeout: 500)
+      #
+
+      # @!method activate_app(app_id)
+      # Activate(Launch) the specified app.
+      # @return [Hash]
+      #
+      # @example
+      #
+      #   @driver.activate_app("io.appium.bundle") #=> {}
+      #
+
+      # Get the status of an existing application on the device.
+      # State:
+      #   AppState::NOT_INSTALLED : The current application state cannot be determined/is unknown
+      #   AppState::NOT_RUNNING : The application is not running
+      #   AppState::RUNNING_IN_BACKGROUND_SUSPENDED : The application is running in the background and is suspended
+      #   AppState::RUNNING_IN_BACKGROUND : The application is running in the background and is not suspended
+      #   AppState::RUNNING_IN_FOREGROUND : 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 [AppManagement::APP_STATE_NOT_INSTALLED|AppManagement::APP_STATE_NOT_RUNNING|APP_STATE_RUNNING_IN_BACKGROUND_SUSPEND|AppManagement::APP_STATE_RUNNING_IN_BACKGROUND|AppManagement::APP_STATE_RUNNING_IN_FOREGROUND] A number of the state
+      #
+      # @example
+      #
+      #      @driver.app_state("io.appium.bundle") #=> 1
+      #
+
       # @!method app_strings(language = nil)
       # Return the hash of all localization strings.
       # @return [Hash]
@@ -402,17 +456,16 @@ module Appium
       #   @driver.take_element_screenshot(element, "fine_name.png")
       #
 
-      # @!method stop_recording_screen(remote_path:, user:, pass:, method:)
-      #
-      # @option [String] remote_path The path to the remote location, where the resulting video should be uploaded.
+      # @!method stop_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT')
+      # @param [String] remote_path: The path to the remote location, where the resulting video should be uploaded.
       #                             The following protocols are supported: http/https, ftp.
       #                             Null or empty string value (the default setting) means the content of resulting
       #                             file should be encoded as Base64 and passed as the endpoint response value.
       #                             An exception will be thrown if the generated media file is too big to
       #                             fit into the available process memory.
-      # @option [String] user The name of the user for the remote authentication.
-      # @option [String] pass The password for the remote authentication.
-      # @option [String] method The http multipart upload method name. The 'PUT' one is used by default.
+      # @param [String] user: The name of the user for the remote authentication.
+      # @param [String] pass: The password for the remote authentication.
+      # @param [String] method: The http multipart upload method name. The 'PUT' one is used by default.
       #
       # @example
       #
@@ -421,14 +474,15 @@ module Appium
       #
 
       # @!method stop_and_save_recording_screen(file_path)
-      #
-      # @option [String] file_path The path to save video decoded from base64 from Appium server.
+      # @param [String] file_path The path to save video decoded from base64 from Appium server.
       #
       # @example
       #
       #    @driver.stop_and_save_recording_screen 'example.mp4'
       #
 
+      # rubocop:enable Metrics/LineLength
+
       ####
       ## class << self
       ####
@@ -462,24 +516,6 @@ module Appium
             end
           end
 
-          add_endpoint_method(:install_app) do
-            def install_app(path)
-              execute :install_app, {}, appPath: path
-            end
-          end
-
-          add_endpoint_method(:remove_app) do
-            def remove_app(id)
-              execute :remove_app, {}, appId: id
-            end
-          end
-
-          add_endpoint_method(:app_installed?) do
-            def app_installed?(app_id)
-              execute :app_installed?, {}, bundleId: app_id
-            end
-          end
-
           add_endpoint_method(:background_app) do
             def background_app(duration = 0)
               execute :background_app, {}, seconds: duration
@@ -568,6 +604,7 @@ module Appium
           add_ime_actions
           add_handling_context
           add_screen_recording
+          add_app_management
         end
 
         # def extended
@@ -609,6 +646,100 @@ module Appium
           end
         end
 
+        # rubocop:disable Metrics/ParameterLists,Metrics/PerceivedComplexity,Metrics/CyclomaticComplexity
+        def add_app_management
+          add_endpoint_method(:install_app) do
+            def install_app(path,
+                            replace: nil,
+                            timeout: nil,
+                            allow_test_packages: nil,
+                            use_sdcard: nil,
+                            grant_permissions: nil)
+              args = { appPath: path }
+
+              args[:options] = {} unless options?(replace, timeout, allow_test_packages, use_sdcard, grant_permissions)
+
+              args[:options][:replace] = replace unless replace.nil?
+              args[:options][:timeout] = timeout unless timeout.nil?
+              args[:options][:allowTestPackages] = allow_test_packages unless allow_test_packages.nil?
+              args[:options][:useSdcard] = use_sdcard unless use_sdcard.nil?
+              args[:options][:grantPermissions] = grant_permissions unless grant_permissions.nil?
+
+              execute :install_app, {}, args
+            end
+
+            private
+
+            def options?(replace, timeout, allow_test_packages, use_sdcard, grant_permissions)
+              replace.nil? || timeout.nil? || allow_test_packages.nil? || use_sdcard.nil? || grant_permissions.nil?
+            end
+          end
+
+          add_endpoint_method(:remove_app) do
+            def remove_app(id, keep_data: nil, timeout: nil)
+              # required: [['appId'], ['bundleId']]
+              args = { appId: id }
+
+              args[:options] = {} unless keep_data.nil? || timeout.nil?
+              args[:options][:keepData] = keep_data unless keep_data.nil?
+              args[:options][:timeout] = timeout unless timeout.nil?
+
+              execute :remove_app, {}, args
+            end
+          end
+
+          add_endpoint_method(:app_installed?) do
+            def app_installed?(app_id)
+              # required: [['appId'], ['bundleId']]
+              execute :app_installed?, {}, bundleId: app_id
+            end
+          end
+
+          add_endpoint_method(:activate_app) do
+            def activate_app(app_id)
+              # required: [['appId'], ['bundleId']]
+              execute :activate_app, {}, bundleId: app_id
+            end
+          end
+
+          add_endpoint_method(:terminate_app) do
+            def terminate_app(app_id, timeout: nil)
+              # required: [['appId'], ['bundleId']]
+              #
+              args = { appId: app_id }
+
+              args[:options] = {} unless timeout.nil?
+              args[:options][:timeout] = timeout unless timeout.nil?
+
+              execute :terminate_app, {}, args
+            end
+          end
+
+          add_endpoint_method(:app_state) do
+            def app_state(app_id)
+              # required: [['appId'], ['bundleId']]
+              response = execute :app_state, {}, appId: app_id
+
+              case response
+              when 0
+                Appium::Core::Device::AppState::NOT_INSTALLED
+              when 1
+                Appium::Core::Device::AppState::NOT_RUNNING
+              when 2
+                Appium::Core::Device::AppState::RUNNING_IN_BACKGROUND_SUSPENDED
+              when 3
+                Appium::Core::Device::AppState::RUNNING_IN_BACKGROUND
+              when 4
+                Appium::Core::Device::AppState::RUNNING_IN_FOREGROUND
+              else
+                Appium::Logger.debug("Unexpected status in app_state: #{response}")
+                response
+              end
+            end
+          end
+        end
+        # rubocop:enable Metrics/ParameterLists,Metrics/PerceivedComplexity,Metrics/CyclomaticComplexity
+
         def add_keyevent
           # Only for Selendroid
           add_endpoint_method(:keyevent) do

data/lib/appium_lib_core/device/app_state.rb

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Device
+      class AppState
+        NOT_INSTALLED = 0
+        NOT_RUNNING = 1
+        RUNNING_IN_BACKGROUND_SUSPENDED = 2
+        RUNNING_IN_BACKGROUND = 3
+        RUNNING_IN_FOREGROUND = 4
+      end
+    end
+  end
+end

data/lib/appium_lib_core/device/touch_actions.rb

@@ -4,6 +4,11 @@ module Appium
   #
   # Each method returns the object itself, so calls can be chained.
   #
+  # Consider to use W3C spec touch action like the followings.
+  # https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
+  # https://github.com/appium/ruby_lib_core/blob/master/test/functional/android/webdriver/w3c_actions_test.rb
+  # https://github.com/appium/ruby_lib_core/blob/master/test/functional/ios/webdriver/w3c_actions_test.rb
+  #
   # @example
   #
   #   @driver = Appium::Core.for(self, opts).start_driver
@@ -28,6 +33,7 @@ module Appium
       #
       # `move_to`'s `x` and `y` have two case. One is working as coordinate, the other is working as offset.
       #
+      # @param opts [Hash] Options
       # @option opts [integer] :x x co-ordinate to move to if element isn't set. Works as an offset if x is set with Element.
       # @option opts [integer] :y y co-ordinate to move to if element isn't set. Works as an offset if y is set with Element.
       # @option opts [WebDriver::Element] Element to scope this move within.
@@ -41,19 +47,20 @@ module Appium
       # https://github.com/appium/ruby_lib/issues/231#issuecomment-269895512
       # e.g. Appium::TouchAction.new.press(x: 280, y: 530).wait(2000).release.perform
       #
-      # @option element [WebDriver::Element] the element to press.
-      # @option x [integer] x co-ordinate to press on.
-      # @option y [integer] y co-ordinate to press on.
-      # @option duration [integer] Number of milliseconds to press.
+      # @param opts [Hash] Options
+      # @option opts [WebDriver::Element] element the element to press.
+      # @option opts [integer] x X co-ordinate to press on.
+      # @option opts [integer] y Y co-ordinate to press on.
+      # @option opts [integer] duration Number of milliseconds to press.
       def long_press(opts)
         args = opts.select { |k, _v| %i(element x y duration).include? k }
         args = args_with_ele_ref(args)
         chain_method(:longPress, args) # longPress is what the appium server expects
       end
 
-      # Press a finger onto the screen.  Finger will stay down until you call
-      # `release`.
+      # Press a finger onto the screen.  Finger will stay down until you call `release`.
       #
+      # @param opts [Hash] Options
       # @option opts [WebDriver::Element] :element (Optional) Element to press within.
       # @option opts [integer] :x x co-ordinate to press on
       # @option opts [integer] :y y co-ordinate to press on
@@ -65,6 +72,7 @@ module Appium
 
       # Remove a finger from the screen.
       #
+      # @param opts [Hash] Options
       # @option opts [WebDriver::Element] :element (Optional) Element to release from.
       # @option opts [integer] :x x co-ordinate to release from
       # @option opts [integer] :y y co-ordinate to release from
@@ -76,6 +84,7 @@ module Appium
       # Touch a point on the screen.
       # Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`.
       #
+      # @param opts [Hash] Options
       # @option opts [WebDriver::Element] :element (Optional) Element to restrict scope too.
       # @option opts [integer] :x x co-ordinate to tap
       # @option opts [integer] :y y co-ordinate to tap
@@ -89,6 +98,7 @@ module Appium
 
       # Double tap an element on the screen
       #
+      # @param opts [Hash] Options
       # @option opts [WebDriver::Element] :element (Optional) Element to restrict scope too.
       # @option opts [integer] :x x co-ordinate to tap
       # @option opts [integer] :y y co-ordinate to tap
@@ -101,6 +111,7 @@ module Appium
 
       # Two finger tap an element on the screen
       #
+      # @param opts [Hash] Options
       # @option opts [WebDriver::Element] :element (Optional) Element to restrict scope too.
       # @option opts [integer] :x x co-ordinate to tap
       # @option opts [integer] :y y co-ordinate to tap
@@ -117,21 +128,13 @@ module Appium
         chain_method(:wait, args)
       end
 
-      # Convenience method to peform a swipe.
-      #
-      # Note that iOS 7 simulators have broken swipe.
-      #
-      # For iOS: Use `offset_x` and `offset_y` to define the end point.
-      #
-      # For Android: Use `end_x` and `end_y` to define the end point.
-      #
-      # If you'd like more details, please read tests and its log samples in
-      # `ios_tests/lib/ios/specs/device/touch_actions.rb` and `ios_tests/lib/ios/specs/device/touch_actions.rb`
+      # Convenience method to perform a swipe.
       #
+      # @param opts [Hash] Options
       # @option opts [int] :start_x Where to start swiping, on the x axis.  Default 0.
       # @option opts [int] :start_y Where to start swiping, on the y axis.  Default 0.
-      # @option opts [int] :offset_x Offset, on the x axis.  Default 0.
-      # @option opts [int] :offset_y Offset, on the y axis.  Default 0.
+      # @option opts [int] :offset_x Move to the end, on the x axis.  Default 0.
+      # @option opts [int] :offset_y Move to the end, on the y axis.  Default 0.
       # @option opts [int] :duration How long the actual swipe takes to complete in milliseconds. Default 200.
       def swipe(opts, ele = nil)
         start_x  = opts.fetch :start_x, 0
@@ -140,15 +143,13 @@ module Appium
         offset_y = opts.fetch :offset_y, 0
         duration = opts.fetch :duration, 200
 
-        coordinates = swipe_coordinates(start_x: start_x, start_y: start_y, offset_x: offset_x, offset_y: offset_y)
-
         if ele # pinch/zoom for XCUITest
           press x: start_x, y: start_y, element: ele
-          move_to x: coordinates[:offset_x], y: coordinates[:offset_y], element: ele
+          move_to x: offset_x, y: offset_y, element: ele
         else
           press x: start_x, y: start_y
           wait(duration) if duration
-          move_to x: coordinates[:offset_x], y: coordinates[:offset_y]
+          move_to x: offset_x, y: offset_y
         end
         release
 
@@ -169,13 +170,6 @@ module Appium
         self
       end
 
-      # Visible for testing
-      # @private
-      def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
-        Appium::Logger.info "start_x: #{start_x}, start_y: #{start_y}, offset_x: #{offset_x}, offset_y: #{offset_y}"
-        { offset_x: offset_x, offset_y: offset_y }
-      end
-
       private
 
       def chain_method(method, args = nil)

data/lib/appium_lib_core/driver.rb

@@ -19,7 +19,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.
-      # False is by default and then "http://127.0.0.1:#{@port}/wd/hub" is used.
+      # False is by default and then "http://127.0.0.1:#{port}/wd/hub" is used.
       # @return [String]
       attr_reader :custom_url
 
@@ -116,6 +116,7 @@ module Appium
       # 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 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.
       # @option http_client_ops [Hash] :read_timeout Custom read timeout for http client.

data/lib/appium_lib_core/ios.rb

@@ -1,7 +1,6 @@
 # loaded in common/driver.rb
 require_relative 'ios/search_context'
 require_relative 'ios/device'
-require_relative 'ios/touch'
 
 require_relative 'ios/uiautomation/patch'
 require_relative 'ios/uiautomation/bridge'

data/lib/appium_lib_core/ios/uiautomation/bridge.rb

@@ -8,8 +8,6 @@ module Appium
             target.extend Appium::Ios::Device
 
             Core::Ios::Uiautomation.patch_webdriver_element
-
-            Core::Ios::Touch.extend_touch_actions
           end
         end
       end

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

@@ -8,8 +8,6 @@ module Appium
             Core::Ios::Xcuitest::SearchContext.extend
             target.extend Appium::Ios::Device
             target.extend Appium::Ios::Xcuitest::Device
-
-            Core::Ios::Touch.extend_touch_actions
           end
         end
       end

data/lib/appium_lib_core/ios/xcuitest/device.rb

@@ -4,6 +4,8 @@ module Appium
       module Device
         extend Forwardable
 
+        # rubocop:disable Metrics/LineLength
+
         # @!method hide_keyboard(close_key = nil, strategy = nil)
         # Hide the onscreen keyboard
         # @param [String] close_key The name of the key which closes the keyboard.
@@ -29,10 +31,8 @@ module Appium
         #   @driver.background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
         #
 
-        # @!method start_recording_screen(remote_path:, user:, pass:, method:, force_restart:,
-        #                                 video_type:, time_limit:, video_quality:)
-        #
-        # @option [String] remote_path The path to the remote location, where the resulting video should be uploaded.
+        # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: nil, force_restart: nil, video_type: 'mp4', time_limit: '180', video_quality: 'medium')
+        # @param [String] remote_path: The path to the remote location, where the resulting video should be uploaded.
         #                             The following protocols are supported: http/https, ftp.
         #                             Null or empty string value (the default setting) means the content of resulting
         #                             file should be encoded as Base64 and passed as the endpount response value.
@@ -40,18 +40,17 @@ module Appium
         #                             fit into the available process memory.
         #                             This option only has an effect if there is screen recording process in progreess
         #                             and `forceRestart` parameter is not set to `true`.
-        # @option [String] user The name of the user for the remote authentication.
-        # @option [String] pass The password for the remote authentication.
-        # @option [String] method The http multipart upload method name. The 'PUT' one is used by default.
-        # @option [Boolean] force_restart Whether to try to catch and upload/return the currently running screen recording
+        # @param [String] user: The name of the user for the remote authentication.
+        # @param [String] pass: The password for the remote authentication.
+        # @param [String] method: The http multipart upload method name. The 'PUT' one is used by default.
+        # @param [Boolean] force_restart: Whether to try to catch and upload/return the currently running screen recording
         #                                 (`false`, the default setting on server) or ignore the result of it
         #                                 and start a new recording immediately (`true`).
-        #
-        # @param [String] video_type The format of the screen capture to be recorded.
+        # @param [String] video_type: The format of the screen capture to be recorded.
         #                            Available formats: "h264", "mp4" or "fmp4". Default is "mp4".
         #                            Only works for Simulator.
-        # @param [String] time_limit Recording time. 180 seconds is by default.
-        # @param [String] video_quality The video encoding quality (low, medium, high, photo - defaults to medium).
+        # @param [String] time_limit: Recording time. 180 seconds is by default.
+        # @param [String] video_quality: The video encoding quality (low, medium, high, photo - defaults to medium).
         #                               Only works for real devices.
         #
         # @example
@@ -60,6 +59,8 @@ module Appium
         #    @driver.start_recording_screen video_type: 'h264', time_limit: '260'
         #
 
+        # rubocop:enable Metrics/LineLength
+
         ####
         ## class << self
         ####

data/lib/appium_lib_core/ios_xcuitest.rb

@@ -1,7 +1,6 @@
 # loaded in common/driver.rb
 require_relative 'ios/search_context'
 require_relative 'ios/device'
-require_relative 'ios/touch'
 
 require_relative 'ios/xcuitest/search_context'
 require_relative 'ios/xcuitest/device'

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.3.0'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-01-28'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.3.1'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-02-14'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,14 @@
+#### v1.3.1 2018-02-14
+
+- [d107749](https://github.com/appium/ruby_lib_core/commit/d107749782e3eae49aeb9c17411a120eecb5a242) Release 1.3.1
+- [9dc38d6](https://github.com/appium/ruby_lib_core/commit/9dc38d65a1c0d8975fc67a8274c1d2ebd43e7e5d) remove unused method
+- [3ca89ff](https://github.com/appium/ruby_lib_core/commit/3ca89ff6a81e016739f602a1cc60c4a7538ae96a) remove corrdinator for moveTo in swipe (#57)
+- [29c528e](https://github.com/appium/ruby_lib_core/commit/29c528e8b407591072a65d4a544af65413a93b9d) arrange consts names and add some options for app management (#59)
+- [da7fd55](https://github.com/appium/ruby_lib_core/commit/da7fd55fb7a8330e778fe7295807646e984f262a) Update CHANGELOG.md
+- [b1b484d](https://github.com/appium/ruby_lib_core/commit/b1b484ddced5011daedca6c0546d236624511d1a) add terminate, app_state and activate app (#58)
+- [0ba7b1c](https://github.com/appium/ruby_lib_core/commit/0ba7b1c726f02e11d6daa46481309b1e0e54b00e) fix documentation
+
+
 #### v1.3.0 2018-01-28
 
 - [b7a994b](https://github.com/appium/ruby_lib_core/commit/b7a994ba29b3870257cf7e8af602deb147afd791) Release 1.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-28 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -196,7 +196,6 @@ files:
 - lib/appium_lib_core/android/device.rb
 - lib/appium_lib_core/android/espresso/bridge.rb
 - lib/appium_lib_core/android/search_context.rb
-- lib/appium_lib_core/android/touch.rb
 - lib/appium_lib_core/android/uiautomator1/bridge.rb
 - lib/appium_lib_core/android/uiautomator2/bridge.rb
 - lib/appium_lib_core/android_espresso.rb
@@ -217,6 +216,7 @@ files:
 - lib/appium_lib_core/common/error.rb
 - lib/appium_lib_core/common/log.rb
 - lib/appium_lib_core/common/logger.rb
+- lib/appium_lib_core/device/app_state.rb
 - lib/appium_lib_core/device/multi_touch.rb
 - lib/appium_lib_core/device/screen_record.rb
 - lib/appium_lib_core/device/touch_actions.rb
@@ -224,7 +224,6 @@ files:
 - lib/appium_lib_core/ios.rb
 - lib/appium_lib_core/ios/device.rb
 - lib/appium_lib_core/ios/search_context.rb
-- lib/appium_lib_core/ios/touch.rb
 - lib/appium_lib_core/ios/uiautomation/bridge.rb
 - lib/appium_lib_core/ios/uiautomation/patch.rb
 - lib/appium_lib_core/ios/xcuitest/bridge.rb

data/lib/appium_lib_core/android/touch.rb

@@ -1,19 +0,0 @@
-module Appium
-  module Core
-    module Android
-      module Touch
-        def self.extend_touch_actions
-          ::Appium::Core::TouchAction.class_eval do
-            # Visible for testing
-            # @private
-            def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
-              Appium::Logger.info "extended Appium::Core::Android::Touch, start_x: #{start_x},"\
-                " start_y: #{start_y}, offset_x: #{offset_x}, offset_y: #{offset_y}"
-              { offset_x: (start_x + offset_x), offset_y: (start_y + offset_y) }
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/appium_lib_core/ios/touch.rb

@@ -1,19 +0,0 @@
-module Appium
-  module Core
-    module Ios
-      module Touch
-        def self.extend_touch_actions
-          ::Appium::Core::TouchAction.class_eval do
-            # Visible for testing
-            # @private
-            def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
-              Appium::Logger.info "extended Appium::Core::Ios::Touch, start_x: #{start_x},"\
-                " start_y: #{start_y}, offset_x: #{offset_x}, offset_y: #{offset_y}"
-              { offset_x: offset_x, offset_y: offset_y }
-            end
-          end
-        end
-      end
-    end
-  end
-end