appium_lib_core 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620f9c1100bd3c5d4740a3b0fd39e7fc4741e318ba97c9b637e14f5e9c9cf34d
-  data.tar.gz: 3e38c30b744ee54906fa4887fdf6cbd49cd2326e9e6c55e4891c834fbf7d1955
+  metadata.gz: 3e0458e9ee6c35f13a6d635ef3e1fd866681c78c0d113fc16f86effcce612f6e
+  data.tar.gz: ed0ba7a35963aac68ee274118633149ea37102cb1581a9acc3b2acb18cc4ca10
 SHA512:
-  metadata.gz: d8646d2aac462bd1ad46af62c1a7017b8fdf0e23b4f3d7f966113b8967217b5c6fcece219fea630b6218ca139bee039a056cdab375f3675b9a66ed982a9a8a77
-  data.tar.gz: 61e9c47729367969d1b029fd875e5aa1e11bec27460a0c607cbbb93cf842694f6e581ec72235252013323ada858e72182d799f2726feb19251d47cc9ab620eff
+  metadata.gz: 730ea372f1b8f7aaba235f9fa9ff9276aaf930190a11a53c95f5c345d3b17cca4583bb02fa9c2079e02f9ebffccbf60f8fd418116f4d62014ad3d2c6513fbb9c
+  data.tar.gz: 63aaca4c4608dbf988037e7e452f0d6aeb85d93b61d9c0fbb0f50fa89e0c975626466ddbd36c019fa71c6fb0d04227255ae3f25bc4f611f5a2a3a745ede610f0

data/CHANGELOG.md

@@ -10,6 +10,16 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [3.3.0] - 2019-11-08
+
+### Enhancements
+- Add `Logs#event` to post a custom log by `@driver.logs.event vendor: 'appium', event: 'funEvent'`
+- Add `Logs#events` to get events by `@driver.logs.events`. It is equal to  `@driver.session_capabilities['events']`
+
+### Bug fixes
+
+### Deprecations
+
 ## [3.2.3] - 2019-09-30
 
 ### Enhancements

data/lib/appium_lib_core/common/base/bridge/mjsonwp.rb

@@ -42,6 +42,19 @@ module Appium
             execute :get_all_sessions
           end
 
+          # For Appium
+          def log_event(vendor, event)
+            execute :post_log_event, {}, { vendor: vendor, event: event }
+          end
+
+          # For Appium
+          def log_events(type = nil)
+            args = {}
+            args['type'] = type unless type.nil?
+
+            execute :get_log_events, {}, args
+          end
+
           def take_element_screenshot(element)
             execute :take_element_screenshot, id: element.ref
           end

data/lib/appium_lib_core/common/base/bridge/w3c.rb

@@ -204,6 +204,19 @@ module Appium
             end
           end
 
+          # For Appium
+          def log_event(vendor, event)
+            execute :post_log_event, {}, { vendor: vendor, event: event }
+          end
+
+          # For Appium
+          def log_events(type = nil)
+            args = {}
+            args['type'] = type unless type.nil?
+
+            execute :get_log_events, {}, args
+          end
+
           def take_viewport_screenshot
             execute_script('mobile: viewportScreenshot')
           end

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

@@ -65,7 +65,9 @@ module Appium
         start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'],
         compare_images:             [:post, 'session/:session_id/appium/compare_images'],
         is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'],
-        execute_driver:             [:post, 'session/:session_id/appium/execute_driver']
+        execute_driver:             [:post, 'session/:session_id/appium/execute_driver'],
+        post_log_event:             [:post, 'session/:session_id/appium/log_event'],
+        get_log_events:             [:post, 'session/:session_id/appium/events']
       }.freeze
 
       COMMAND_ANDROID = {

data/lib/appium_lib_core/common/log.rb

@@ -24,7 +24,7 @@ module Appium
       #
       # @example
       #
-      #   @driver.logs.get "syslog" # []
+      #   @driver.logs.get 'syslog' # []
       #   @driver.logs.get :syslog # []
       #
       def get(type)
@@ -41,6 +41,49 @@ module Appium
       def available_types
         @bridge.available_log_types
       end
+
+      # @since Appium 1.16.0
+      #
+      # Logs a custom event. The event is available via {::Appium::Core::Events#get} or
+      # <code>@driver.session_capabilities['events']</code> with <code>eventTimings</code> capabilities.
+      #
+      # @param [String] vendor The vendor prefix for the event
+      # @param [String] event The name of event
+      # @returns [nil]
+      #
+      # @example
+      #
+      #   @driver.logs.event vendor: 'appium', event: 'funEvent'
+      #   @driver.session_capabilities['events'] #=> {...., 'appium:funEvent' => 1572957315}
+      #
+      #   @driver.logs.event = { vendor: 'appium', event: 'anotherEvent' }
+      #   @driver.logs.events #=> {...., 'appium:funEvent' => [1572957315, 1572960305],
+      #                  #          'appium:anotherEvent' => 1572959315}
+      #
+      def event(vendor:, event:)
+        @bridge.log_event vendor, event
+      end
+
+      def event=(log_event)
+        raise ArgumentError('log_event should be Hash like { vendor: "appium", event: "funEvent"}') unless log_event.is_a?(Hash)
+
+        event vendor: log_event[:vendor], event: log_event[:event]
+      end
+
+      # @since Appium 1.16.0
+      # Returns events with filtering with 'type'. Defaults to all available events.
+      #
+      # @param [String] type The type of events to get
+      # @return [Hash]
+      #
+      # @example
+      #
+      #   @driver.logs.events #=> {}
+      #   @driver.logs.events #=> {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }
+      #
+      def events(type = nil)
+        @bridge.log_events(type)
+      end
     end
   end # module Core
 end # module Appium

data/lib/appium_lib_core/driver.rb

@@ -93,6 +93,7 @@ module Appium
 
     class Driver
       include Waitable
+
       # Selenium webdriver capabilities
       # @return [Core::Base::Capabilities]
       attr_reader :caps

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '3.2.3' unless defined? ::Appium::Core::VERSION
-    DATE    = '2019-09-30' unless defined? ::Appium::Core::DATE
+    VERSION = '3.3.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2019-11-08' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,9 @@
+#### v3.3.0 2019-11-08
+
+- [7fb0371](https://github.com/appium/ruby_lib_core/commit/7fb03712bb9a743c41aded5348e3c15160ef25cc) Release 3.3.0
+- [c232888](https://github.com/appium/ruby_lib_core/commit/c232888f1479c3d2b240bff2ca00835b238a5cb2) feat: add posting log event/getting events (#242)
+
+
 #### v3.2.3 2019-09-30
 
 - [9af149b](https://github.com/appium/ruby_lib_core/commit/9af149bd3b086e7cb8ac07470c5d097e46ac0b65) Release 3.2.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-29 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -335,7 +335,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Minimal Ruby library for Appium.