appium_lib 9.3.0 → 9.3.1

data/ios_tests/appium.txt

@@ -4,6 +4,7 @@ platformVersion = "10.2"
 deviceName ="iPhone Simulator"
 automationName = 'XCUITest'
 app = "./UICatalog.app"
+some_capability = "some_capability"
 
 [appium_lib]
 sauce_username = ""

data/ios_tests/lib/ios/specs/driver.rb

@@ -30,18 +30,37 @@ describe 'driver' do
     assert_equal expected, actual
   end
 
+  t 'verify Appium::Driver::Capabilities.init_caps_for_appium' do
+    expected_app = File.absolute_path('UICatalog.app')
+    caps = ::Appium::Driver::Capabilities.init_caps_for_appium(platformName:    'ios',
+                                                               platformVersion: '10.2',
+                                                               automationName:  'XCUITest',
+                                                               deviceName:      'iPhone Simulator',
+                                                               app:             expected_app,
+                                                               some_capability: 'some_capability')
+    caps_with_json = JSON.parse(caps.to_json)
+    caps_with_json['platformName'].must_equal 'ios'
+    caps_with_json['platformVersion'].must_equal '10.2'
+    caps_with_json['app'].must_equal expected_app
+    caps_with_json['automationName'].must_equal 'XCUITest'
+    caps_with_json['deviceName'].must_equal 'iPhone Simulator'
+    caps_with_json['someCapability'].must_equal 'some_capability'
+
+    caps[:platformName].must_equal 'ios'
+    caps[:platformVersion].must_equal '10.2'
+    caps[:app].must_equal expected_app
+    caps[:automationName].must_equal 'XCUITest'
+    caps[:deviceName].must_equal 'iPhone Simulator'
+    caps[:some_capability].must_equal 'some_capability'
+  end
+
   describe 'Appium::Driver attributes' do
     t 'verify all attributes' do
       actual                = driver_attributes
       caps_app_for_teardown = actual[:caps][:app]
       expected_app = File.absolute_path('UICatalog.app')
-      expected_caps       = ::Appium::Driver::Capabilities.init_caps_for_appium(platformName:    'ios',
-                                                                                platformVersion: '10.1',
-                                                                                automationName:  'XCUITest',
-                                                                                deviceName:      'iPhone Simulator',
-                                                                                app:             expected_app)
-      expected            = { caps:             expected_caps,
-                              automation_name:  'XCUITest',
+
+      expected            = { automation_name:  'XCUITest',
                               custom_url:       false,
                               export_session:   false,
                               default_wait:     30,
@@ -54,7 +73,26 @@ describe 'driver' do
                               wait_timeout:     20,  # defined in appium.txt
                               wait_interval:    1 }  # defined in appium.txt
 
-      if actual != expected
+      # actual[:caps].to_json send to Appium server
+      caps_with_json = JSON.parse(actual[:caps].to_json)
+      caps_with_json['platformName'].must_equal 'ios'
+      caps_with_json['platformVersion'].must_equal '10.2'
+      caps_with_json['app'].must_equal expected_app
+      caps_with_json['automationName'].must_equal 'XCUITest'
+      caps_with_json['deviceName'].must_equal 'iPhone Simulator'
+      caps_with_json['someCapability'].must_equal 'some_capability'
+
+      actual[:caps][:platformName].must_equal 'ios'
+      actual[:caps][:platformVersion].must_equal '10.2'
+      actual[:caps][:app].must_equal expected_app
+      actual[:caps][:automationName].must_equal 'XCUITest'
+      actual[:caps][:deviceName].must_equal 'iPhone Simulator'
+      actual[:caps][:some_capability].must_equal 'some_capability'
+
+      dup_actual = actual.dup
+      dup_actual.delete(:caps)
+
+      if dup_actual != expected
         diff    = HashDiff.diff expected, actual
         diff    = "diff (expected, actual):\n#{diff}"
 

data/lib/appium_lib/common/command.rb

@@ -3,52 +3,54 @@ module Appium
     module Commands
       COMMAND_NO_ARG = {
         # common
-        shake:                  [:post, 'session/:session_id/appium/device/shake'.freeze],
-        launch_app:             [:post, 'session/:session_id/appium/app/launch'.freeze],
-        close_app:              [:post, 'session/:session_id/appium/app/close'.freeze],
-        reset:                  [:post, 'session/:session_id/appium/app/reset'.freeze],
-        device_locked?:         [:post, 'session/:session_id/appium/device/is_locked'.freeze],
+        shake:                      [:post, 'session/:session_id/appium/device/shake'.freeze],
+        launch_app:                 [:post, 'session/:session_id/appium/app/launch'.freeze],
+        close_app:                  [:post, 'session/:session_id/appium/app/close'.freeze],
+        reset:                      [:post, 'session/:session_id/appium/app/reset'.freeze],
+        device_locked?:             [:post, 'session/:session_id/appium/device/is_locked'.freeze],
 
         # Android
-        open_notifications:     [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
-        toggle_airplane_mode:   [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
-        current_activity:       [:get,  'session/:session_id/appium/device/current_activity'.freeze],
-        get_network_connection: [:get,  'session/:session_id/network_connection'.freeze],
+        open_notifications:         [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
+        toggle_airplane_mode:       [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
+        current_activity:           [:get,  'session/:session_id/appium/device/current_activity'.freeze],
+        get_network_connection:     [:get,  'session/:session_id/network_connection'.freeze],
+        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze],
 
         # iOS
-        device_time:            [:get,  'session/:session_id/appium/device/system_time'.freeze],
-        current_context:        [:get,  'session/:session_id/context'.freeze]
+        device_time:                [:get,  'session/:session_id/appium/device/system_time'.freeze],
+        current_context:            [:get,  'session/:session_id/context'.freeze]
       }.freeze
 
       COMMAND = {
         # common
-        available_contexts:     [:get,  'session/:session_id/contexts'.freeze],
-        set_context:            [:post, 'session/:session_id/context'.freeze],
-        app_strings:            [:post, 'session/:session_id/appium/app/strings'.freeze],
-        lock:                   [:post, 'session/:session_id/appium/device/lock'.freeze],
-        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],
-        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],
-        long_press_keycode:     [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
-        set_immediate_value:    [:post, 'session/:session_id/appium/element/:id/value'.freeze],
-        push_file:              [:post, 'session/:session_id/appium/device/push_file'.freeze],
-        pull_file:              [:post, 'session/:session_id/appium/device/pull_file'.freeze],
-        pull_folder:            [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
-        get_settings:           [:get,  'session/:session_id/appium/settings'.freeze],
-        update_settings:        [:post, 'session/:session_id/appium/settings'.freeze],
-        touch_actions:          [:post, 'session/:session_id/touch/perform'.freeze],
-        multi_touch:            [:post, 'session/:session_id/touch/multi/perform'.freeze],
+        available_contexts:         [:get,  'session/:session_id/contexts'.freeze],
+        set_context:                [:post, 'session/:session_id/context'.freeze],
+        app_strings:                [:post, 'session/:session_id/appium/app/strings'.freeze],
+        lock:                       [:post, 'session/:session_id/appium/device/lock'.freeze],
+        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],
+        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],
+        long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
+        set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
+        push_file:                  [:post, 'session/:session_id/appium/device/push_file'.freeze],
+        pull_file:                  [:post, 'session/:session_id/appium/device/pull_file'.freeze],
+        pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
+        get_settings:               [:get,  'session/:session_id/appium/settings'.freeze],
+        update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
+        touch_actions:              [:post, 'session/:session_id/touch/perform'.freeze],
+        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'.freeze],
 
         # Android
-        start_activity:         [:post, 'session/:session_id/appium/device/start_activity'.freeze],
-        end_coverage:           [:post, 'session/:session_id/appium/app/end_test_coverage'.freeze],
-        set_network_connection: [:post, 'session/:session_id/network_connection'.freeze],
+        start_activity:             [:post, 'session/:session_id/appium/device/start_activity'.freeze],
+        end_coverage:               [:post, 'session/:session_id/appium/app/end_test_coverage'.freeze],
+        set_network_connection:     [:post, 'session/:session_id/network_connection'.freeze],
+        get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'.freeze],
 
         # iOS
-        touch_id:               [:post, 'session/:session_id/appium/simulator/touch_id'.freeze]
+        touch_id:                   [:post, 'session/:session_id/appium/simulator/touch_id'.freeze]
       }.merge(COMMAND_NO_ARG).merge(::Selenium::WebDriver::Remote::Bridge::COMMANDS).freeze
     end
   end

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '9.3.0'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2017-01-22'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.3.1'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2017-02-05'.freeze unless defined? ::Appium::DATE
 end

data/lib/appium_lib/device/device.rb

@@ -135,6 +135,26 @@ module Appium
     #   ```ruby
     #   set_immediate_value element, 'hello'
     #   ```
+
+    # @!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)
         extend_webdriver_with_forwardable
@@ -308,6 +328,14 @@ module Appium
           end
         end
 
+        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
+
         add_touch_actions
         add_ime_actions
         extend_search_contexts

data/lib/appium_lib/driver.rb

@@ -55,7 +55,8 @@ end
 module Appium
   REQUIRED_VERSION_XCUITEST = '1.6.0'.freeze
 
-  # Load arbitrary text (toml format)
+  # Load arbitrary text ([toml format](https://github.com/toml-lang/toml))
+  # The toml is parsed by https://github.com/fbernier/tomlrb .
   #
   # ```
   # [caps]
@@ -76,7 +77,7 @@ module Appium
     raise 'opts must not be empty' if opts.empty?
 
     toml = opts[:file]
-    raise 'Must pass file' unless toml
+    raise 'Must pass a capability file which has [caps] and [appium_lib]' unless toml
     verbose = opts.fetch :verbose, false
 
     Appium::Logger.info "appium settings path: #{toml}" if verbose
@@ -121,7 +122,7 @@ module Appium
 
       File.exist?(file) ? file : nil
     end
-    r.compact! # remove nils
+    file_paths.compact! # remove nils
 
     files = []
 
@@ -251,6 +252,9 @@ module Appium
       # except for browser_name, default capability is equal to ::Selenium::WebDriver::Remote::Capabilities.firefox
       # Because Selenium::WebDriver::Remote::Bridge uses Capabilities.firefox by default
       # https://github.com/SeleniumHQ/selenium/blob/selenium-3.0.1/rb/lib/selenium/webdriver/remote/bridge.rb#L67
+      # @param [Hash] opts_caps Capabilities for Appium server. All capability keys are converted to lowerCamelCase when
+      #                         this client sends capabilities to Appium server as JSON format.
+      # @return [Selenium::WebDriver::Remote::Capabilities] Return instance of Selenium::WebDriver::Remote::Capabilities
       def self.init_caps_for_appium(opts_caps = {})
         default_caps_opts_firefox = {
           javascript_enabled: true,
@@ -281,9 +285,9 @@ module Appium
     # This value is independent of what the server is using
     # @return [Integer]
     attr_reader :default_wait
-    # Username for use on Sauce Labs
+    # Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV.
     attr_accessor :sauce_username
-    # Access Key for use on Sauce Labs
+    # Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
     attr_accessor :sauce_access_key
     # Appium's server port
     attr_accessor :appium_port

data/readme.md

@@ -45,6 +45,8 @@ gem install --no-rdoc --no-ri appium_lib
 - `SAUCE_USERNAME` Sauce username
 - `SAUCE_ACCESS_KEY` Sauce API key
 
+(Note: If these variables are set, all tests will use Sauce Labs unless over-ridden in configuration.)
+
 #### Troubleshooting
 
 1. Does `adb kill-server; adb devices` list an active Android device?

data/release_notes.md

@@ -1,3 +1,15 @@
+#### v9.3.0 2017-01-22
+
+- [a1c2872](https://github.com/appium/ruby_lib/commit/a1c287296c9eace08ef19449998fba7229b65697) Release 9 3 0 (#474)
+- [23d937a](https://github.com/appium/ruby_lib/commit/23d937a60da55c2d95ccbbda07ad23bda1b53a7b) update changelogs for v9.3.0 (#472)
+- [34803ef](https://github.com/appium/ruby_lib/commit/34803ef6b7b94df9ef4e147ba8fec5c1d2cfaada) arrange docs (#470)
+- [c1106aa](https://github.com/appium/ruby_lib/commit/c1106aaa6f48a4ed22dc1a7e55c9c4119cdef15c) fix returning only visible elements (#465)
+- [0104a87](https://github.com/appium/ruby_lib/commit/0104a87fad933598bb2b8ac1174319857494ba21) add capability to be able to set default timeout/interval for wait/wait_true (#468)
+- [1372e64](https://github.com/appium/ruby_lib/commit/1372e6453536eb64829825b5bf405ad0f11a9a46) fix typo (#467)
+- [a5ddd4a](https://github.com/appium/ruby_lib/commit/a5ddd4aa1d5f009b9024ee5aa5434805ba73895c) fix swipe, pinch, zoom (#466)
+- [a1c2e9e](https://github.com/appium/ruby_lib/commit/a1c2e9e815e9f85c929da857e26f419629d760df) fix appium server's version check (#464)
+
+
 #### v9.2.0 2017-01-09
 
 - [958ae3e](https://github.com/appium/ruby_lib/commit/958ae3e2fc84b78191baf22e967c8a2fb7eded22) Release 9 2 0 (#460)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.3.0
+  version: 9.3.1
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-22 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -216,6 +216,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby library for Appium.
 email:
 - code@bootstraponline.com
@@ -396,7 +410,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby library for Appium