appium_lib_core 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9bb0e41715b40a247cce0ca6c129aa782269d21
-  data.tar.gz: 88cf6d66bdc6ad88e83971ab6234279e703a2203
+  metadata.gz: 703373935a027f386911efb13088fbcc09e655a2
+  data.tar.gz: 0aa3d1af1e2fe7f5ef1c81d05564698b744b5c8e
 SHA512:
-  metadata.gz: 2df417c53c2e9001002bd23f00ccd3938d436a4736914fb372b3978f968e1d87f247fd1b4d6706bbd67b3bf50b77abefdcdeb7ab3838bee9b257e8f1f74cec34
-  data.tar.gz: 88eb0ca4828ea2bbf052012557b204a0346d0a205485804e4e6c68bea7f70d960ada2e91835d262f4dc594a1e463738c3e55868e612012e7152ed890d332a6ae
+  metadata.gz: eba28378ec06ae4dd9475478aedb90d8eed232fe5d5c2b4f0e5b285dc1709ae5febab7e878bd0d0fb33c40c8f282a805fddc8b8936a9f10c4732f3cf44afadd4
+  data.tar.gz: da507de703f77f94d00a3182476ca7fca9933a1f6481dc3c1498ec93121c3e03584763e3d00f440e150c6cddfc70aeb4986a552bdfa08cd5b85aa4be041521af

data/CHANGELOG.md

@@ -8,6 +8,21 @@ All notable changes to this project will be documented in this file.
 
 ### Deprecations
 
+## [1.6.0] - 2018-05-08
+### Enhancements
+- **Breaking Change**
+    - Change the results of `app_state`.
+        - Before: A number or const.
+            - `0, 1, 2, 3, 4` or `NOT_INSTALLED, NOT_RUNNING, RUNNING_IN_BACKGROUND_SUSPENDED, RUNNING_IN_BACKGROUND, RUNNING_IN_FOREGROUND`
+        - After: Symbol.
+            - `:not_installed, :not_running, :running_in_background_suspended, :running_in_background, :running_in_foreground`
+- add `battery_info` to get battery information
+- add `is_keyboard_shown` for iOS ( see also https://github.com/appium/appium-xcuitest-driver/pull/664/files )
+
+### Bug fixes
+
+### Deprecations
+
 ## [1.5.1] - 2018-04-25
 ### Enhancements
 

data/lib/appium_lib_core/android/device.rb

@@ -52,14 +52,6 @@ module Appium
       #   @driver.get_display_density # 320
       #
 
-      # @!method is_keyboard_shown
-      # Get whether keyboard is displayed or not.
-      # @return [Boolean] Return true if keyboard is shown. Return false if keyboard is hidden.
-      #
-      # @example
-      #   @driver.is_keyboard_shown # false
-      #
-
       # @!method get_network_connection
       #   Get the device network connection current status
       #   See set_network_connection method for return value
@@ -286,12 +278,6 @@ module Appium
             end
           end
 
-          Appium::Core::Device.add_endpoint_method(:is_keyboard_shown) do
-            def is_keyboard_shown # rubocop:disable Naming/PredicateName for compatibility
-              execute :is_keyboard_shown
-            end
-          end
-
           Appium::Core::Device.add_endpoint_method(:get_network_connection) do
             def get_network_connection
               execute :get_network_connection

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

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

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

@@ -0,0 +1,50 @@
+module Appium
+  module Core
+    module Android
+      module Uiautomator2
+        module Device
+          extend Forwardable
+
+          # @since 1.6.0
+          # @!method battery_info
+          #
+          # Get battery information.
+          #
+          # @return [Hash]  Return battery level and battery state.
+          #                 Battery level in range [0.0, 1.0], where 1.0 means 100% charge. -1 is returned
+          #                 if the actual value cannot be retrieved from the system.
+          #                 Battery state. The following symbols are possible
+          #                 `:unknown, :charging, :discharging, :not_charging, :full`
+          #
+          # @example
+          #
+          #   @driver.battery_info #=> { state: :charging, level: 0.7 }
+          #
+
+          ####
+          ## class << self
+          ####
+
+          class << self
+            def extended(_mod)
+              ::Appium::Core::Device.add_endpoint_method(:battery_info) do
+                def battery_info
+                  response = execute_script 'mobile: batteryInfo', {}
+
+                  state = case response['state']
+                          when 2, 3, 4, 5
+                            ::Appium::Core::Device::BatteryStatus::ANDROID[response['state']]
+                          else
+                            Appium::Logger.warn("The state is unknown or undefined: #{response['state']}")
+                            ::Appium::Core::Device::BatteryStatus::ANDROID[1] # :unknown
+                          end
+                  { state: state, level: response['level'] }
+                end
+              end
+            end
+          end # class << self
+        end # module Device
+      end # module Uiautomator2
+    end # module Android
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/android_uiautomator2.rb

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

data/lib/appium_lib_core/common/command/common.rb

@@ -46,7 +46,8 @@ module Appium
         update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
         stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'.freeze],
         start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'.freeze],
-        compare_images:             [:post, 'session/:session_id/appium/compare_images'.freeze]
+        compare_images:             [:post, 'session/:session_id/appium/compare_images'.freeze],
+        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'.freeze]
       }.freeze
 
       COMMAND_ANDROID = {
@@ -57,7 +58,6 @@ module Appium
         current_package:            [:get,  'session/:session_id/appium/device/current_package'.freeze],
         get_system_bars:            [:get,  'session/:session_id/appium/device/system_bars'.freeze],
         get_display_density:        [:get,  'session/:session_id/appium/device/display_density'.freeze],
-        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'.freeze],
         toggle_wifi:                [:post, 'session/:session_id/appium/device/toggle_wifi'.freeze],
         toggle_data:                [:post, 'session/:session_id/appium/device/toggle_data'.freeze],
         toggle_location_services:   [:post, 'session/:session_id/appium/device/toggle_location_services'.freeze],

data/lib/appium_lib_core/{device → common/touch_action}/touch_actions.rb

@@ -1,23 +1,23 @@
 module Appium
-  # Perform a series of gestures, one after another.  Gestures are chained
-  # together and only performed when `perform()` is called. Default is conducted by global driver.
-  #
-  # Each method returns the object itself, so calls can be chained.
-  #
-  # 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
-  #   action = TouchAction.new(@driver).press(x: 45, y: 100).wait(5).release
-  #   action.perform
-  #   action = TouchAction.new(@driver).swipe(....)
-  #   action.perform
-  #
   module Core
+    # Perform a series of gestures, one after another.  Gestures are chained
+    # together and only performed when `perform()` is called. Default is conducted by global driver.
+    #
+    # Each method returns the object itself, so calls can be chained.
+    #
+    # 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
+    #   action = TouchAction.new(@driver).press(x: 45, y: 100).wait(5).release
+    #   action.perform
+    #   action = TouchAction.new(@driver).swipe(....)
+    #   action.perform
+    #
     class TouchAction
       ACTIONS = %i(move_to long_press double_tap two_finger_tap press release tap wait perform).freeze
       COMPLEX_ACTIONS = %i(swipe).freeze

data/lib/appium_lib_core/device.rb

@@ -1,5 +1,5 @@
-require_relative 'device/touch_actions'
-require_relative 'device/multi_touch'
+require_relative 'common/touch_action/touch_actions'
+require_relative 'common/touch_action/multi_touch'
 require_relative 'device/screen_record'
 require_relative 'device/app_state'
 require_relative 'device/clipboard_content_type'
@@ -141,20 +141,20 @@ module Appium
 
       # 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
+      #   :not_installed : The current application state cannot be determined/is unknown
+      #   :not_running : The application is not running
+      #   :running_in_background_suspended : The application is running in the background and is suspended
+      #   :running_in_background : The application is running in the background and is not suspended
+      #   :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
+      # @return [AppState::STATUS] A number of the state
       #
       # @example
       #
-      #      @driver.app_state("io.appium.bundle") #=> 1
+      #      @driver.app_state("io.appium.bundle") #=> :not_running
       #
 
       # @!method app_strings(language = nil)
@@ -205,6 +205,14 @@ module Appium
       #   @driver.hide_keyboard(nil, :tapOutside) # Close a keyboard with tapping out side of keyboard
       #
 
+      # @!method is_keyboard_shown
+      # Get whether keyboard is displayed or not.
+      # @return [Boolean] Return true if keyboard is shown. Return false if keyboard is hidden.
+      #
+      # @example
+      #   @driver.is_keyboard_shown # false
+      #
+
       # @!method keyevent(key, metastate = nil)
       # Send keyevent on the device.(Only for Selendroid)
       # http://developer.android.com/reference/android/view/KeyEvent.html
@@ -450,17 +458,6 @@ module Appium
             end
           end
 
-          add_endpoint_method(:hide_keyboard) do
-            def hide_keyboard(close_key = nil, strategy = nil)
-              option = {}
-
-              option[:key] = close_key || 'Done'        # default to Done key.
-              option[:strategy] = strategy || :pressKey # default to pressKey
-
-              execute :hide_keyboard, {}, option
-            end
-          end
-
           add_endpoint_method(:take_element_screenshot) do
             def take_element_screenshot(element, png_path)
               result = execute :take_element_screenshot, id: element.ref
@@ -520,6 +517,7 @@ module Appium
           add_app_management
           add_device_lock
           add_file_management
+          add_keyboard
           Core::Device::ImageComparison.extended
         end
 
@@ -719,16 +717,8 @@ module Appium
               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
+              when 0, 1, 2, 3, 4
+                ::Appium::Core::Device::AppState::STATUS[response]
               else
                 ::Appium::Logger.debug("Unexpected status in app_state: #{response}")
                 response
@@ -765,6 +755,25 @@ module Appium
           end
         end
 
+        def add_keyboard
+          add_endpoint_method(:hide_keyboard) do
+            def hide_keyboard(close_key = nil, strategy = nil)
+              option = {}
+
+              option[:key] = close_key || 'Done'        # default to Done key.
+              option[:strategy] = strategy || :pressKey # default to pressKey
+
+              execute :hide_keyboard, {}, option
+            end
+          end
+
+          add_endpoint_method(:is_keyboard_shown) do
+            def is_keyboard_shown # rubocop:disable Naming/PredicateName for compatibility
+              execute :is_keyboard_shown
+            end
+          end
+        end
+
         def add_touch_actions
           add_endpoint_method(:touch_actions) do
             def touch_actions(actions)

data/lib/appium_lib_core/device/app_state.rb

@@ -2,11 +2,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
+        STATUS = [
+          :not_installed,                   # 0
+          :not_running,                     # 1
+          :running_in_background_suspended, # 2
+          :running_in_background,           # 3
+          :running_in_foreground            # 4
+        ].freeze
       end
     end
   end

data/lib/appium_lib_core/device/battery_status.rb

@@ -0,0 +1,23 @@
+module Appium
+  module Core
+    module Device
+      module BatteryStatus
+        ANDROID = [
+          :undefined,    # 0, dummy
+          :unknown,      # 1
+          :charging,     # 2
+          :discharging,  # 3
+          :not_charging, # 4
+          :full          # 5
+        ].freeze
+
+        IOS = [
+          :unknown,      # 0
+          :unplugged,    # 1
+          :charging,     # 2
+          :full          # 3
+        ].freeze
+      end
+    end
+  end
+end

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

@@ -109,6 +109,23 @@ module Appium
         #   @driver.get_performance_record
         #   @driver.get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor')
 
+        # @since 1.6.0
+        # @!method battery_info
+        #
+        # Get battery information.
+        #
+        # @return [Hash]  Return battery level and battery state from the target real device. (Simulator has no battery.)
+        #                 https://developer.apple.com/documentation/uikit/uidevice/ 's `batteryLevel` and `batteryState`.
+        #                 Battery level in range [0.0, 1.0], where 1.0 means 100% charge. -1 is returned
+        #                 if the actual value cannot be retrieved from the system.
+        #                 Battery state. The following symbols are possible
+        #                 `:unplugged, :charging, :full`
+        #
+        # @example
+        #
+        #   @driver.battery_info #=> { state: :full, level: 0.7 }
+        #
+
         # rubocop:enable Metrics/LineLength
 
         ####
@@ -117,8 +134,6 @@ module Appium
 
         class << self
           def extended(_mod)
-            ::Appium::Core::Device.extend_webdriver_with_forwardable
-
             # Override
             ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
               def hide_keyboard(close_key = nil, strategy = nil)
@@ -143,10 +158,28 @@ module Appium
 
             add_performance
             add_screen_recording
+            add_battery_info
           end
 
           private
 
+          def add_battery_info
+            Appium::Core::Device.add_endpoint_method(:battery_info) do
+              def battery_info
+                response = execute_script 'mobile: batteryInfo', {}
+
+                state = case response['state']
+                        when 1, 2, 3
+                          ::Appium::Core::Device::BatteryStatus::IOS[response['state']]
+                        else
+                          Appium::Logger.warn("The state is unknown or undefined: #{response['state']}")
+                          ::Appium::Core::Device::BatteryStatus::IOS[0] # :unknown
+                        end
+                { state: state, level: response['level'] }
+              end
+            end
+          end
+
           def add_performance
             Appium::Core::Device.add_endpoint_method(:start_performance_record) do
               def start_performance_record(timeout: 300_000, profile_name: 'Activity Monitor', pid: nil)

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

@@ -19,7 +19,7 @@ module Appium
           #   find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
           #
           #   # matching predicate. <code>`</code> is the mark.
-          #   find_elements :class_chain, 'XCUIElementTypeWindow[`visible = 1][`name = \"bla\"`]'
+          #   find_elements :class_chain, 'XCUIElementTypeWindow[`visible = 1][`name = "bla"`]'
           #
           #   # containing predicate. `$` is the mark.
           #   # Require appium-xcuitest-driver 2.54.0+

data/lib/appium_lib_core/ios_xcuitest.rb

@@ -5,3 +5,5 @@ require_relative 'ios/device'
 require_relative 'ios/xcuitest/search_context'
 require_relative 'ios/xcuitest/device'
 require_relative 'ios/xcuitest/bridge'
+
+require_relative 'device/battery_status'

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.5.1'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-04-25'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.6.0'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-05-08'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,13 @@
+#### v1.6.0 2018-05-08
+
+- [37a35f0](https://github.com/appium/ruby_lib_core/commit/37a35f022d35f43a9770c17e25b8fa3c57737dd6) Release 1.6.0
+- [0a5134c](https://github.com/appium/ruby_lib_core/commit/0a5134c80939484301250331bc77b384bc01cf1c) fix an example
+- [59a920f](https://github.com/appium/ruby_lib_core/commit/59a920fc6a8e42503f4314f6cfd1242326573559) Add battery info (#85)
+- [1e9717f](https://github.com/appium/ruby_lib_core/commit/1e9717fae8231b87c906ade40cea4ca4bebe5262) add is_keyboard_shown for iOS (#86)
+- [48ae579](https://github.com/appium/ruby_lib_core/commit/48ae57975dbf17d0d097d49a6b8598ad18cf4c63) Update CHANGELOG.md
+- [9ae597c](https://github.com/appium/ruby_lib_core/commit/9ae597c6fdea0abb5f7292bb2c3e02dc859ecb3d) change the response of app_state (#84)
+
+
 #### v1.5.1 2018-04-25
 
 - [27f6149](https://github.com/appium/ruby_lib_core/commit/27f6149f330137bc1d6350271c246ebe0346122b) Release 1.5.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -228,6 +228,7 @@ files:
 - lib/appium_lib_core/android/search_context.rb
 - lib/appium_lib_core/android/uiautomator1/bridge.rb
 - lib/appium_lib_core/android/uiautomator2/bridge.rb
+- lib/appium_lib_core/android/uiautomator2/device.rb
 - lib/appium_lib_core/android_espresso.rb
 - lib/appium_lib_core/android_uiautomator2.rb
 - lib/appium_lib_core/common.rb
@@ -247,16 +248,17 @@ 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/common/touch_action/multi_touch.rb
+- lib/appium_lib_core/common/touch_action/touch_actions.rb
 - lib/appium_lib_core/common/wait.rb
 - lib/appium_lib_core/common/wait/timer.rb
 - lib/appium_lib_core/common/ws/websocket.rb
 - lib/appium_lib_core/device.rb
 - lib/appium_lib_core/device/app_state.rb
+- lib/appium_lib_core/device/battery_status.rb
 - lib/appium_lib_core/device/clipboard_content_type.rb
 - lib/appium_lib_core/device/image_comparison.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
 - lib/appium_lib_core/driver.rb
 - lib/appium_lib_core/ios.rb
 - lib/appium_lib_core/ios/device.rb