appium_lib 9.7.5 → 9.8.1

data/docs/ios_xcuitest.md

@@ -82,7 +82,7 @@ xpaths("//some xpaths")
 ## Gesture
 - `mobile:` commands are provided by WDA.
 - Documentations
-    - https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios-xctest-mobile-gestures.md
+    - https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md
 - Specs by test code
     - https://github.com/appium/appium-xcuitest-driver/blob/master/test/functional/basic/gesture-e2e-specs.js
 

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

@@ -109,36 +109,6 @@ module Appium
       nil
     end
 
-    # Lists package, activity, and adb shell am start -n value for current app.
-    # Works on local host only (not remote).
-
-    # example line:
-    # "mFocusedApp=AppWindowToken{b1420058 token=Token{b128add0
-    #  ActivityRecord{b1264d10 u0 com.example.android.apis/.ApiDemos t23}}}"
-    def current_app
-      warn '[DEPRECATION] current_app will be removed since it work only local.' \
-             'Please use current_activity and current_app to know package and activity for current app'
-
-      line = `adb shell dumpsys window windows`.each_line.grep(/mFocusedApp/).first.strip
-
-      _parse_current_app_line line
-    end
-
-    # @private
-    # noinspection RubyArgCount
-    def _parse_current_app_line(line)
-      match = line.match(/ ([^\/ ]+\/[^ }]+)[ }]/)
-      return nil unless match && match[1]
-
-      pair = match[1].split '/'
-      pkg  = pair.first
-      act  = pair.last
-      OpenStruct.new(line:     line,
-                     package:  pkg,
-                     activity: act,
-                     am_start: pkg + '/' + act)
-    end
-
     # Find the first matching element by id
     # @param id [String] the id to search for
     # @return [Element]

data/lib/appium_lib/appium.rb

@@ -2,6 +2,8 @@ require 'rubygems'
 require 'selenium-webdriver'
 require 'nokogiri'
 
+require 'appium_lib_core'
+
 # base
 require_relative 'driver'
 require_relative 'sauce_labs'
@@ -15,9 +17,6 @@ require_relative 'common/touch_actions'
 require_relative 'common/http_client'
 require_relative 'common/device'
 
-# core
-require_relative 'core/core'
-
 # ios
 require_relative 'ios/ios'
 
@@ -62,7 +61,7 @@ module Appium
 
       data = Tomlrb.load_file(toml, symbolize_keys: true)
       if verbose
-        Appium::Logger.ap_info data unless data.empty?
+        Appium::Logger.info data unless data.empty?
       end
 
       if data && data[:caps] && data[:caps][:app] && !data[:caps][:app].empty?

data/lib/appium_lib/common/helper.rb

@@ -53,7 +53,6 @@ module Appium
 
     # json and ap are required for the source method.
     require 'json'
-    require 'ap' # awesome print
 
     # @private
     # http://nokogiri.org/Nokogiri/XML/SAX.html

data/lib/appium_lib/common/http_client.rb

@@ -1,4 +1,4 @@
-require_relative '../core/core'
+require 'appium_lib_core'
 require_relative '../version'
 
 module Appium

data/lib/appium_lib/common/touch_actions.rb

@@ -24,10 +24,10 @@ module Appium
   # @example
   #
   #   driver =  Appium::Driver.new(opts, false).start_driver
-  #   action = TouchAction.new.press(x: 45, y: 100).wait(5).release
-  #   action.perform(@driver)
-  #   action = TouchAction.new.swipe(....)
-  #   action.perform(@driver)
+  #   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

data/lib/appium_lib/common/wait.rb

@@ -1,4 +1,4 @@
-require_relative '../core/common/base/wait'
+require 'appium_lib_core'
 
 module Appium
   module Common

data/lib/appium_lib/driver.rb

@@ -9,7 +9,7 @@ module Minitest
   end
 end
 
-require_relative 'core/core'
+require 'appium_lib_core'
 
 module Appium
   REQUIRED_VERSION_XCUITEST = '1.6.0'.freeze
@@ -36,6 +36,7 @@ module Appium
     attr_reader :sauce_endpoint
 
     # from Core
+    # read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver
     attr_reader :caps
     attr_reader :custom_url
     attr_reader :export_session
@@ -172,7 +173,7 @@ module Appium
       # for command
 
       if @appium_debug
-        Appium::Logger.ap_debug opts unless opts.empty?
+        Appium::Logger.debug opts unless opts.empty?
         Appium::Logger.debug "Debug is: #{@appium_debug}"
         Appium::Logger.debug "Device is: #{@core.device}"
       end
@@ -312,6 +313,7 @@ module Appium
       # server (TestObject for instance) does not respond to status call
       {}
     end
+    alias remote_status appium_server_version
 
     # Return the platform version as an array of integers
     # @return [Array<Integer>]
@@ -319,12 +321,6 @@ module Appium
       @core.platform_version
     end
 
-    # @private
-    def ios_version
-      warn '[DEPRECATION] ios_version will be removed. Please use platform_version instead.'
-      platform_version
-    end
-
     # Returns the client's version info
     #
     # @example
@@ -428,6 +424,9 @@ module Appium
     # Creates a new global driver and quits the old one if it exists.
     # You can customise http_client as the following
     #
+    # Read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device to understand more what the driver
+    # can call instance methods.
+    #
     # @example
     #
     #   require 'rubygems'

data/lib/appium_lib/ios/common/helper.rb

@@ -69,7 +69,7 @@ module Appium
         parser.parse s
         parser.document.result
       else
-        s = source_window
+        s = get_source
         parser = Nokogiri::XML::SAX::Parser.new(UITestElementsPrinter.new)
         if class_name
           parser.document.filter = class_name.is_a?(Symbol) ? class_name.to_s : class_name
@@ -79,13 +79,6 @@ module Appium
       end
     end
 
-    # Gets the JSON source of window number
-    # @return [JSON]
-    def source_window(_window_number = nil)
-      warn '[DEPRECATION] source_window will be removed. Please use source instead.'
-      get_source
-    end
-
     # Find by id
     # @param id [String] the id to search for
     # @return [Element]

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.7.5'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2017-11-04'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.8.1'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2017-12-16'.freeze unless defined? ::Appium::DATE
 end

data/readme.md

@@ -1,4 +1,4 @@
-#### appium_lib
+# appium_lib
 
 [![Gem Version](https://badge.fury.io/rb/appium_lib.svg)](http://badge.fury.io/rb/appium_lib)
 [![Dependency Status](https://gemnasium.com/appium/ruby_lib.svg)](https://gemnasium.com/appium/ruby_lib)
@@ -10,22 +10,29 @@
 
 - [appium_lib on RubyGems](https://rubygems.org/gems/appium_lib)
 - [Documentation for appium_lib](https://github.com/appium/ruby_lib/tree/master/docs)
-- [Appium Ruby Console](https://github.com/appium/ruby_console)
+    - [Documentation for core lib](http://www.rubydoc.info/github/appium/ruby_lib_core)
+        - Especially [driver method for Appium](http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device)
 - [Getting Started](https://github.com/appium/appium/blob/master/docs/en/about-appium/getting-started.md)
 - [code examples](https://github.com/appium/sample-code/tree/master/sample-code/examples/ruby)
 
 Helper methods for writing cross platform (iOS, Android) tests in Ruby using Appium. Note that user waits should not exceed 120 seconds if they're going to run on Sauce Labs.
 
-Make sure you're using Appium 1.0.0 or newer and Ruby 2.2+ with upgraded rubygems and bundler.
+[Ruby_lib_core](https://github.com/appium/ruby_lib_core) is the core driver library which provide `selenium-webdriver` related features and driver methods for Appium.
+The `ruby_lib` wrap the driver and serve many helpful methods for users.
 
-#### Start appium server
+# Setup
+## Requirement
+- [Appium](https://github.com/appium/appium#requirements)
+- Ruby: 2.2+
+
+## Start appium server
 
 ```bash
 $ npm install -g appium
 $ appium
 ```
 
-#### Install / Upgrade
+## Install / Upgrade
 - Update rubygems and bundler
 ```bash
 $ gem update --system
@@ -38,7 +45,7 @@ gem uninstall -aIx appium_lib
 gem install --no-rdoc --no-ri appium_lib
 ```
 
-#### [Sauce Labs env vars](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/sauce_labs.rb)
+## [Sauce Labs env vars](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/sauce_labs.rb)
 
 - `SAUCE_USERNAME` Sauce username
 - `SAUCE_ACCESS_KEY` Sauce API key
@@ -46,7 +53,7 @@ gem install --no-rdoc --no-ri appium_lib
 
 (Note: If these variables are set, all tests will use Sauce Labs unless over-ridden in configuration.)
 
-#### Documentation
+# Documentation
 
 - [Installing Appium on OS X](https://github.com/appium/ruby_console/blob/master/osx.md)
 - [Overview](https://github.com/appium/ruby_lib/blob/master/docs/docs.md)
@@ -55,5 +62,19 @@ gem install --no-rdoc --no-ri appium_lib
     - [Tips for XCUITest for iOS](https://github.com/appium/ruby_lib/blob/master/docs/ios_xcuitest.md)
 - [Appium Server docs](https://github.com/appium/appium/tree/master/docs)
 
-#### Load Pry
+# Related libraries
+- [ruby_lib_core](https://github.com/appium/ruby_lib_core): Bridged commands, WebDriver dependencies
+    - We add new endpoints for Appium in the core library, and `ruby_lib` call the methods.
+- [ruby_console](https://github.com/appium/ruby_console): Appium Ruby Console
+- [appium_capybara](https://github.com/appium/appium_capybara): Gem enabling appium support in capybara
+
+# Load Pry
 `Pry.config.pager = false` is set if you have no `.pryrc` files and `Pry` is defined.
+
+
+# Contribute
+## How to add new commands for `driver`
+- Add the new commands in [ruby_lib_core](https://github.com/appium/ruby_lib_core). [An example](https://github.com/appium/ruby_lib_core/commit/cdb02c29c8663d22d643b52fd65c8b2d1373bebb)
+
+## How to add new helpful methods
+- Add the new methods in this library

data/release_notes.md

@@ -1,3 +1,9 @@
+#### 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)
+- [6a6d07e](https://github.com/appium/ruby_lib/commit/6a6d07e80686a171f76ea4fa013996e7f81f6fb9) [fix: take care capybara case (#716)](https://github.com/appium/ruby_lib/issues/716)
+
+
 #### v9.7.4 2017-10-28
 
 - [8522f49](https://github.com/appium/ruby_lib/commit/8522f496eff2a72648a563af8ce06cb8c7270256) [Release 9 7 4 (#715)](https://github.com/appium/ruby_lib/issues/715)

metadata

@@ -1,63 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.7.5
+  version: 9.8.1
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: appium_lib_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.1
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: tomlrb
   requirement: !ruby/object:Gem::Requirement
@@ -276,44 +242,6 @@ files:
 - lib/appium_lib/common/multi_touch.rb
 - lib/appium_lib/common/touch_actions.rb
 - lib/appium_lib/common/wait.rb
-- lib/appium_lib/core/android.rb
-- 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
-- lib/appium_lib/core/android_uiautomator2.rb
-- lib/appium_lib/core/common.rb
-- lib/appium_lib/core/common/base.rb
-- lib/appium_lib/core/common/base/bridge.rb
-- lib/appium_lib/core/common/base/capabilities.rb
-- lib/appium_lib/core/common/base/command.rb
-- lib/appium_lib/core/common/base/driver.rb
-- lib/appium_lib/core/common/base/http_default.rb
-- lib/appium_lib/core/common/base/search_context.rb
-- lib/appium_lib/core/common/base/wait.rb
-- lib/appium_lib/core/common/command.rb
-- lib/appium_lib/core/common/device.rb
-- 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/core.rb
-- lib/appium_lib/core/device/multi_touch.rb
-- lib/appium_lib/core/device/touch_actions.rb
-- lib/appium_lib/core/driver.rb
-- 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
-- lib/appium_lib/core/ios/xcuitest/device.rb
-- lib/appium_lib/core/ios/xcuitest/search_context.rb
-- lib/appium_lib/core/ios_xcuitest.rb
-- lib/appium_lib/core/patch.rb
 - lib/appium_lib/driver.rb
 - lib/appium_lib/ios/common/errors.rb
 - lib/appium_lib/ios/common/helper.rb

data/lib/appium_lib/core/android.rb

@@ -1,5 +0,0 @@
-# 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

@@ -1,142 +0,0 @@
-module Appium
-  module Android
-    module Device
-      extend Forwardable
-
-      # @!method background_app
-      #  Backgrounds the app for a set number of seconds.
-      #  This is a blocking application
-      # @param [Integer] seconds How many seconds to background the app for.
-      #
-      #   ```ruby
-      #   background_app
-      #   background_app(5)
-      #   background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
-      #   ```
-
-      # @!method hide_keyboard
-      #   Hide the onscreen keyboard
-      #   @param [String] close_key The name of the key which closes the keyboard.
-      #     Defaults to 'Done' for iOS(except for XCUITest).
-      #   @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
-      #     XCUITest ignore this argument.
-      #     Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
-      #  ```ruby
-      #  hide_keyboard # Close a keyboard with the 'Done' button
-      #  hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
-      #  hide_keyboard(nil, :tapOutside) # Close a keyboard with tapping out side of keyboard
-      #  ```
-
-      # @!method end_coverage
-      #   Android only;  Ends the test coverage and writes the results to the given path on device.
-      #   @param [String] path Path on the device to write too.
-      #   @param [String] intent Intent to broadcast when ending coverage.
-
-      # @!method start_activity
-      #   Start a new activity within the current app or launch a new app and start the target activity.
-      #
-      #   Android only.
-      #   @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]
-      #
-      #   ```ruby
-      #   start_activity app_package: 'io.appium.android.apis',
-      #     app_activity: '.accessibility.AccessibilityNodeProviderActivity'
-      #   ```
-
-      # @!method set_network_connection
-      #   Set the device network connection mode
-      #   @param [String] path Bit mask that represent the network mode
-      #
-      #   Value (Alias)      | Data | Wifi | Airplane Mode
-      #   -------------------------------------------------
-      #   1 (Airplane Mode)  | 0    | 0    | 1
-      #   6 (All network on) | 1    | 1    | 0
-      #   4 (Data only)      | 1    | 0    | 0
-      #   2 (Wifi only)      | 0    | 1    | 0
-      #   0 (None)           | 0    | 0    | 0
-      #
-
-      # @!method get_performance_data_types
-      #   Get the information type of the system state which is supported to read such as
-      #   cpu, memory, network, battery via adb commands.
-      #   https://github.com/appium/appium-base-driver/blob/be29aec2318316d12b5c3295e924a5ba8f09b0fb/lib/mjsonwp/routes.js#L300
-      #
-      #   ```ruby
-      #   get_performance_data_types #=> ["cpuinfo", "batteryinfo", "networkinfo", "memoryinfo"]
-      #   ```
-
-      # @!method get_performance_data
-      #   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.
-      #
-      #   ```ruby
-      #   get_performance_data package_name: package_name, data_type: data_type, data_read_timeout: 2
-      #   ```
-      class << self
-        def extended(_mod)
-          Appium::Core::Device.extend_webdriver_with_forwardable
-
-          # Android
-          Appium::Core::Device.add_endpoint_method(:start_activity) do
-            def start_activity(opts)
-              raise 'opts must be a hash' unless opts.is_a? Hash
-              app_package = opts[:app_package]
-              raise 'app_package is required' unless app_package
-              app_activity = opts[:app_activity]
-              raise 'app_activity is required' unless app_activity
-              app_wait_package  = opts.fetch(:app_wait_package, '')
-              app_wait_activity = opts.fetch(:app_wait_activity, '')
-
-              unknown_opts = opts.keys - [:app_package, :app_activity, :app_wait_package, :app_wait_activity]
-              raise "Unknown options #{unknown_opts}" unless unknown_opts.empty?
-
-              execute :start_activity, {}, appPackage: app_package,
-                                           appActivity: app_activity,
-                                           appWaitPackage: app_wait_package,
-                                           appWaitActivity: app_wait_activity
-            end
-          end
-
-          # Android, Override
-          Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
-            def hide_keyboard(close_key = nil, strategy = nil)
-              option = {}
-
-              option[:key] = close_key if close_key
-              option[:strategy] = strategy || :tapOutside # default to pressKey
-
-              execute :hide_keyboard, {}, option
-            end
-          end
-
-          # TODO: TEST ME
-          Appium::Core::Device.add_endpoint_method(:end_coverage) do
-            def end_coverage(path, intent)
-              execute :end_coverage, {}, path: path, intent: intent
-            end
-          end
-
-          Appium::Core::Device.add_endpoint_method(:set_network_connection) do
-            def set_network_connection(mode)
-              execute :set_network_connection, {}, type: mode
-            end
-          end
-
-          Appium::Core::Device.add_endpoint_method(:get_performance_data) do
-            def get_performance_data(package_name:, data_type:, data_read_timeout: 1000)
-              execute :get_performance_data, {}, packageName: package_name,
-                                                 dataType: data_type,
-                                                 dataReadTimeout: data_read_timeout
-            end
-          end
-        end
-      end
-    end # module Device
-  end # module Android
-end # module Appium