appium_lib 9.12.0 → 9.12.1

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

@@ -1,5 +1,3 @@
-require_relative 'ws_logcat'
-
 module Appium
   module Android
     module Command
@@ -31,7 +29,7 @@ module Appium
         @driver.execute_script 'mobile: startLogsBroadcast'
 
         socket_url = "ws://#{URI.parse(server_url).host}:#{@core.port}/ws/session/#{@driver.session_id}/appium/device/logcat"
-        @logcat_client = Command::WsLogcat.new(url: socket_url, output_file: logcat_file)
+        @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: logcat_file)
       end
 
       # Stop Android logcat broadcast websocket

data/lib/appium_lib/appium.rb

@@ -16,6 +16,7 @@ require_relative 'common/multi_touch'
 require_relative 'common/touch_actions'
 require_relative 'common/http_client'
 require_relative 'common/device'
+require_relative 'common/command'
 
 # ios
 require_relative 'ios/ios'

data/lib/appium_lib/common/command.rb

@@ -0,0 +1,9 @@
+require_relative 'command/ws_logcat'
+
+module Appium
+  module Common
+    module Command
+      # parent
+    end
+  end
+end

data/lib/appium_lib/{android/common → common}/command/ws_logcat.rb

@@ -1,5 +1,5 @@
 module Appium
-  module Android
+  module Common
     module Command
       class WsLogcat < ::Appium::Core::WebSocket
         def initialize(url:, output_file: 'logcat.log')

data/lib/appium_lib/common/wait.rb

@@ -16,12 +16,20 @@ module Appium
     #
     # If only a number is provided then it's treated as the timeout value.
     #
-    # @param [Hash] opts Options
+    # @param [Hash|Numeric] opts Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
     # @option opts [Numeric] :timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
     # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
+    #
+    # @example
+    #
+    #     wait_true(timeout: 20, interval: 0.2, message: 'custom message') { button_exact('Back') }.click
+    #     wait_true(20) { button_exact('Back') }.click
+    #
     def wait_true(opts = {})
+      opts = opts.is_a?(Numeric) ? { timeout: opts } : opts
+
       if opts.is_a? Hash
         opts.empty? ? @core.wait_true { yield } : @core.wait_true(opts) { yield }
       else
@@ -37,12 +45,20 @@ module Appium
     #
     # If only a number is provided then it's treated as the timeout value.
     #
-    # @param [Hash] opts Options
+    # @param [Hash|Numeric] opts Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
     # @option opts [Numeric] :timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
     # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
+    #
+    # @example
+    #
+    #     wait(timeout: 20, interval: 0.2, message: 'custom message') { button_exact('Back') }.click
+    #     wait(20) { button_exact('Back') }.click
+    #
     def wait(opts = {})
+      opts = opts.is_a?(Numeric) ? { timeout: opts } : opts
+
       if opts.is_a? Hash
         opts.empty? ? @core.wait { yield } : @core.wait(opts) { yield }
       else

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

@@ -14,6 +14,7 @@ module Appium
           target.extend Appium::Ios::Xcuitest::Gesture
           target.extend Appium::Ios::Xcuitest::MultiAppHandler
           target.extend Appium::Ios::Xcuitest::Element
+          target.extend Appium::Ios::Xcuitest::Command
         end
       end
     end

data/lib/appium_lib/ios/xcuitest/command.rb

@@ -7,6 +7,32 @@ module Appium
   module Ios
     module Xcuitest
       module Command
+        # Starts iOS syslog broadcast websocket
+        #
+        # @param [String] syslog_file A file path to write messages from a syslog WebSocket client
+        #
+        # @example
+        #
+        #   start_logs_broadcast 'outputfile.log' #=> #<Appium::Android::Command::WsLogcat:...>
+        #
+        def start_logs_broadcast(syslog_file = 'syslog.log')
+          @driver.execute_script 'mobile: startLogsBroadcast'
+
+          socket_url = "ws://#{URI.parse(server_url).host}:#{@core.port}/ws/session/#{@driver.session_id}/appium/device/syslog"
+          @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: syslog_file)
+        end
+
+        # Stop iOS syslog broadcast websocket
+        #
+        # @example
+        #
+        #   stop_logs_broadcast #=> nil
+        #
+        def stop_logs_broadcast
+          @logcat_client.close
+
+          @driver.execute_script 'mobile: stopLogsBroadcast'
+        end
       end
     end
   end

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.12.0'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2018-04-25'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.12.1'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2018-05-06'.freeze unless defined? ::Appium::DATE
 end

data/release_notes.md

@@ -1,3 +1,9 @@
+#### v9.12.0 2018-04-25
+
+- [7a5a12c](https://github.com/appium/ruby_lib/commit/7a5a12ce78ce0a8154ea55ff7f44ecd10ba5b771) [Release 9 12 0 (#775)](https://github.com/appium/ruby_lib/issues/775)
+- [7dcb4fa](https://github.com/appium/ruby_lib/commit/7dcb4fa287e61c813ab8f522e5a4d397a95f5039) [remove hot fix actions (#773)](https://github.com/appium/ruby_lib/issues/773)
+
+
 #### v9.11.1 2018-04-22
 
 - [778aaf4](https://github.com/appium/ruby_lib/commit/778aaf4dfd5879759fd296f770aef59a6eca685e) [Release 9 11 1 (#772)](https://github.com/appium/ruby_lib/issues/772)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.12.0
+  version: 9.12.1
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
@@ -222,7 +222,6 @@ files:
 - lib/appium_lib.rb
 - lib/appium_lib/android/android.rb
 - lib/appium_lib/android/common/command/command.rb
-- lib/appium_lib/android/common/command/ws_logcat.rb
 - lib/appium_lib/android/common/helper.rb
 - lib/appium_lib/android/element/alert.rb
 - lib/appium_lib/android/element/button.rb
@@ -237,6 +236,8 @@ files:
 - lib/appium_lib/android/uiautomator2/element/button.rb
 - lib/appium_lib/android/uiautomator2/helper.rb
 - lib/appium_lib/appium.rb
+- lib/appium_lib/common/command.rb
+- lib/appium_lib/common/command/ws_logcat.rb
 - lib/appium_lib/common/device.rb
 - lib/appium_lib/common/helper.rb
 - lib/appium_lib/common/http_client.rb