appium_lib_core 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c10b3d610607f773263b41a6fcc8a1ef3486214
-  data.tar.gz: 36827f23fa7146ef3311e5b87ec3154cbea0b70b
+  metadata.gz: 33533e8d7934610ad0c43c6957765e40aab65f45
+  data.tar.gz: e73ee98770907974b2220e57f9b949bd657d9beb
 SHA512:
-  metadata.gz: ad6af80ee422db86a404ab8fb5fce1ce832c10e2c7cd0f90c4fca6e9a87796bea12a9e8cbd6f47591d1bbf23194fffa013877dd3d0ac69f4ea286b3789762152
-  data.tar.gz: 2798ad4bb81887889cbb2e393aa6546b3c1830eb85006128645faeafe565b5cd1f11ed2eb38185452cb6fbed9d24a2ac268eb9cfc89d70e7add781ec5bfd7038
+  metadata.gz: aaac599d8a33199041357f09d9ddb9355c1bb8bc6c0b04f8edbed7ebb5ed39c7caf99fd7f9254e939b1f5392582c6738f467039fb0982542a8132a40b279c668
+  data.tar.gz: 58b70225c898eba780f5f4df8fc7d8ad1ed3edbe5e51b62df6f547774a2295e297d9a41efff8c3aed59f5354d6433e4a3910acd23b57464fe4bf18ca6f4a2cdb

data/CHANGELOG.md

@@ -9,6 +9,18 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [2.3.2] - 2019-01-20
+### Enhancements
+- Add alias for some method calls
+    1. IME: e.g. `@driver.ime.activate` in addition to  `@driver.ime_activate` [rubydoc](https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Base/Driver#ime-instance_method)
+    2. Settings: e.g. `@driver.settings = { ... }` and  `@driver.settings.update(...)` in addition to `@driver.update_settings(...)` [rubydoc](https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Base/Driver#settings-instance_method)
+    3. Locked: `@driver.locked?` in addition to `@driver.device_locked?`
+
+### Bug fixes
+- Inherit CoreError for ServerError in order to handle it as an exception
+
+### Deprecations
+
 ## [2.3.1] - 2019-01-13
 ### Enhancements
 - `set_network_connection` accepts keys as same as `network_connection_type` in addition to numbers

data/lib/appium_lib_core/common/base/driver.rb

@@ -57,10 +57,12 @@ module Appium
         # @example
         #
         #   @driver.device_locked?
+        #   @driver.locked?
         #
-        def device_locked?
+        def locked?
           @bridge.device_locked?
         end
+        alias device_locked? locked?
 
         # Unlock the device
         #
@@ -115,56 +117,136 @@ module Appium
         end
         alias type send_keys
 
-        # Get appium Settings for current test session
+        class DriverSettings
+          # @private this class is private
+          def initialize(bridge)
+            @bridge = bridge
+          end
+
+          def get
+            @bridge.get_settings
+          end
+
+          def update(settings)
+            @bridge.update_settings(settings)
+          end
+        end
+        private_constant :DriverSettings
+
+        # Returns an instance of DriverSettings to call get/update.
+        #
+        # @example
+        #
+        #   @driver.settings.get
+        #   @driver.settings.update('allowInvisibleElements': true)
+        #
+        def settings
+          @driver_settings ||= DriverSettings.new(@bridge)
+        end
+
+        # Get appium Settings for current test session.
+        # Alias of @driver.settings.get
         #
         # @example
         #
         #   @driver.get_settings
+        #   @driver.settings.get
         #
         def get_settings
-          @bridge.get_settings
+          settings.get
         end
 
         # Update Appium Settings for current test session
-        # @param [Hash] settings Settings to update, keys are settings, values to value to set each setting to
+        # Alias of @driver.settings#update
+        #
+        # @param [Hash] value Settings to update, keys are settings, values to value to set each setting to
         #
         # @example
         #
         #   @driver.update_settings('allowInvisibleElements': true)
+        #   @driver.settings.update('allowInvisibleElements': true)
+        #   @driver.settings = { 'allowInvisibleElements': true }
+        #
+        def settings=(value)
+          settings.update(value)
+        end
+        alias update_settings settings=
+
+        class DeviceIME
+          # @private this class is private
+          def initialize(bridge)
+            @bridge = bridge
+          end
+
+          def activate(ime_name)
+            @bridge.ime_activate(ime_name)
+          end
+
+          def available_engines
+            @bridge.ime_available_engines
+          end
+
+          def active_engine
+            @bridge.ime_active_engine
+          end
+
+          def activated?
+            @bridge.ime_activated
+          end
+
+          def deactivate
+            @bridge.ime_deactivate
+          end
+        end
+        private_constant :DeviceIME
+
+        # Returns an instance of DeviceIME
         #
-        def update_settings(settings)
-          @bridge.update_settings(settings)
+        # @example
+        #
+        #   @driver.ime.activate engine: 'com.android.inputmethod.latin/.LatinIME'
+        #   @driver.ime.available_engines #=> Get the list of IME installed in the target device
+        #   @driver.ime.active_engine #=> Get the current active IME such as 'com.android.inputmethod.latin/.LatinIME'
+        #   @driver.ime.activated #=> True if IME is activated
+        #   @driver.ime.deactivate #=> Deactivate current IME engine
+        #
+        def ime
+          @device_ime ||= DeviceIME.new(@bridge)
         end
 
         # Android only. Make an engine that is available active.
+        #
         # @param [String] ime_name The IME owning the activity [required]
         #
         # @example
         #
-        #   ime_activate engine: 'com.android.inputmethod.latin/.LatinIME'
+        #   @driver.ime_activate engine: 'com.android.inputmethod.latin/.LatinIME'
+        #   @driver.ime.activate engine: 'com.android.inputmethod.latin/.LatinIME'
         #
         def ime_activate(ime_name)
-          @bridge.ime_activate(ime_name)
+          ime.activate(ime_name)
         end
 
         # Android only. List all available input engines on the machine.
         #
         # @example
         #
-        #   ime_available_engines #=> Get the list of IME installed in the target device
+        #   @driver.ime_available_engines #=> Get the list of IME installed in the target device
+        #   @driver.ime.available_engines #=> Get the list of IME installed in the target device
         #
         def ime_available_engines
-          @bridge.ime_available_engines
+          ime.available_engines
         end
 
         # Android only. Get the name of the active IME engine.
         #
         # @example
         #
-        #   ime_active_engine #=> Get the current active IME such as 'com.android.inputmethod.latin/.LatinIME'
+        #   @driver.ime_active_engine #=> Get the current active IME such as 'com.android.inputmethod.latin/.LatinIME'
+        #   @driver.ime.active_engine #=> Get the current active IME such as 'com.android.inputmethod.latin/.LatinIME'
         #
         def ime_active_engine
-          @bridge.ime_active_engine
+          ime.active_engine
         end
 
         # @!method ime_activated
@@ -172,20 +254,22 @@ module Appium
         #
         # @example
         #
-        #   ime_activated #=> True if IME is activated
+        #   @driver.ime_activated #=> True if IME is activated
+        #   @driver.ime.activated #=> True if IME is activated
         #
         def ime_activated
-          @bridge.ime_activated
+          ime.activated?
         end
 
         # Android only. De-activates the currently-active IME engine.
         #
         # @example
         #
-        #   ime_deactivate #=> Deactivate current IME engine
+        #   @driver.ime_deactivate #=> Deactivate current IME engine
+        #   @driver.ime.deactivate #=> Deactivate current IME engine
         #
         def ime_deactivate
-          @bridge.ime_deactivate
+          ime.deactivate
         end
 
         # Perform a block within the given context, then switch back to the starting context.

data/lib/appium_lib_core/common/error.rb

@@ -14,7 +14,7 @@ module Appium
       class UnsupportedOperationError < CoreError; end
 
       # Server side error
-      class ServerError; end
+      class ServerError < CoreError; end
     end
   end
 end

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '2.3.1'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2019-01-13'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '2.3.2'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2019-01-20'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,12 @@
+#### v2.3.2 2019-01-20
+
+- [77aa44a](https://github.com/appium/ruby_lib_core/commit/77aa44a930335d64dd8f8107f93f131f4983c578) Release 2.3.2
+- [d6967b1](https://github.com/appium/ruby_lib_core/commit/d6967b193cc4b5d040bccf6290fadc566c14aa3b) Add alias for ime, settings and device locked (#183)
+- [9abb158](https://github.com/appium/ruby_lib_core/commit/9abb158510ce871d4d3a2b35eb3aed7e43344c20) Server error (#182)
+- [76b1cc2](https://github.com/appium/ruby_lib_core/commit/76b1cc2d42e953b6dc7800549ad664262acca717) add a comment for creating session without deleting previous session
+- [e304e54](https://github.com/appium/ruby_lib_core/commit/e304e54c9e0c5e043fdb943c7eff952d2cd5a1fe) add teardown
+
+
 #### v2.3.1 2019-01-13
 
 - [12ace90](https://github.com/appium/ruby_lib_core/commit/12ace906df63a8e4d4377b402ada2d90bd7509af) Release 2.3.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-13 00:00:00.000000000 Z
+date: 2019-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver