appium_lib_core 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97e009bff9dd6292e1a2628aede232c17410d775
-  data.tar.gz: 50c61ce75653198f2a07a1241771ac757b0d2aca
+  metadata.gz: beb4e9d4de4aee51d10e20d5928b5643eb11718e
+  data.tar.gz: 8b84e2bf079a746c6dcfe8fda67ae20043c0abd5
 SHA512:
-  metadata.gz: c542eff950fb4ef3b69c018eb560a2b4aa06b26896f92bccd0f2c0d1f4409b7aba82f9f3f9d3f8abc84a7c0613929996a401bbb862f168c11d4586f3b98defef
-  data.tar.gz: ce4db6a5dfb62b3efe19fc639282a84c85acc38f68e9ad956a3407ed8f4a8f5c8704578efe304685a18e830f53d7198b53630be34b09495c9657849dc3091e12
+  metadata.gz: 46386acb4309665c91025d6e3dff55d91eed8a453d31deac7a018bd55d66148f7218189323fab82fb40938206b1195736bd19af0678985cc1a72e20ced113e1d
+  data.tar.gz: 431ad7793eb318ffff75fb8d97862977a16c0cfa55ddc4db9d2c3143f24a085563baa72eecf27a16cf8c2ac86fddc793835a77fa0591109097efdcf8cf808ab6

data/CHANGELOG.md

@@ -3,11 +3,29 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 ### Enhancements
+
+### Bug fixes
+
+### Deprecations
+
+## [1.3.0] - 2018-01-28
+### Enhancements
+- `start_recording_screen`/`stop_recording_screen` support iOS from `Appium 1.8.0` [#48](https://github.com/appium/ruby_lib_core/issues/48)
+    - **Breaking Changes**
+        - `start_recording_screen`
+            - The argument, `file_path`, was removed.
+
+### Bug fixes
+
+### Deprecations
+
+## [1.2.7] - 2018-01-25
+### Enhancements
 - Print warning messages to use camelCase if capability key names are snake_case
     - For W3C adaption for Appium Server
 
 ### Bug fixes
-- make `@driver.automation_name` downcase
+- Make `@driver.automation_name` downcase [#50](https://github.com/appium/ruby_lib_core/issues/50)
 
 ### Deprecations
 
@@ -16,7 +34,7 @@ All notable changes to this project will be documented in this file.
 - Add `window_rect`
 
 ### Bug fixes
-- Make `@driver.automation_name` symbol when someone define the `automationName` with the server argument.
+- Make `@driver.automation_name` symbol when someone define the `automationName` with the server argument. [#50](https://github.com/appium/ruby_lib_core/issues/50)
 
 ### Deprecations
 

data/lib/appium_lib_core.rb

@@ -8,6 +8,7 @@ require_relative 'appium_lib_core/driver'
 # for multi touch related methods
 require_relative 'appium_lib_core/device/touch_actions'
 require_relative 'appium_lib_core/device/multi_touch'
+require_relative 'appium_lib_core/device/screen_record'
 
 require_relative 'appium_lib_core/android'
 require_relative 'appium_lib_core/android_uiautomator2'

data/lib/appium_lib_core/android/device.rb

@@ -78,26 +78,36 @@ module Appium
       #   @driver.get_performance_data package_name: package_name, data_type: data_type, data_read_timeout: 2
       #
 
-      # @!method start_recording_screen(package_name:, data_type:, data_read_timeout: 1000)
-      #   Record the display of devices running Android 4.4 (API level 19) and higher.
-      #   It records screen activity to an MPEG-4 file. Audio is not recorded with the video file.
-      # @param [String] file_path A path to save the video. `/sdcard/default.mp4` is by default.
-      # @param [String] video_size A video size. '1280x720' is by default.
-      # @param [String] time_limit Recording time. 180 second is by default.
-      # @param [String] bit_rate The video bit rate for the video, in megabits per second. 3000000(3Mbps) is by default.
+      # @!method start_recording_screen(remote_path:, user:, pass:, method:, force_restart:,
+      #                                 video_size:, time_limit:, bit_rate:)
+      #
+      # @option [String] remote_path The path to the remote location, where the resulting video should be uploaded.
+      #                             The following protocols are supported: http/https, ftp.
+      #                             Null or empty string value (the default setting) means the content of resulting
+      #                             file should be encoded as Base64 and passed as the endpoint response value.
+      #                             An exception will be thrown if the generated media file is too big to
+      #                             fit into the available process memory.
+      #                             This option only has an effect if there is screen recording process in progress
+      #                             and `forceRestart` parameter is not set to `true`.
+      # @option [String] user The name of the user for the remote authentication.
+      # @option [String] pass The password for the remote authentication.
+      # @option [String] method The http multipart upload method name. The 'PUT' one is used by default.
+      # @option [Boolean] force_restart Whether to try to catch and upload/return the currently running screen recording
+      #                                 (`false`, the default setting on server) or ignore the result of it
+      #                                 and start a new recording immediately (`true`).
+      #
+      # @option [String] video_size The format is widthxheight.
+      #                             The default value is the device's native display resolution (if supported),
+      #                             1280x720 if not. For best results,
+      #                             use a size supported by your device's Advanced Video Coding (AVC) encoder.
+      #                             For example, "1280x720"
+      # @param [String] time_limit Recording time. 180 seconds is by default.
+      # @param [String] bit_rate The video bit rate for the video, in megabits per second. 4 Mbps(4000000) is by default.
       #
       # @example
       #
-      #   @driver.start_recording_screen(file_path: '/sdcard/default.mp4', video_size: '1280x720',
-      #                                  time_limit: '180', bit_rate: '3000000')
-      #
-
-      # @!method stop_recording_screen
-      #   Stop recording the screen.
-      #
-      # @example
-      #
-      #   @driver.stop_recording_screen
+      #    @driver.start_recording_screen
+      #    @driver.start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000'
       #
 
       ####
@@ -161,12 +171,27 @@ module Appium
             end
           end
 
+          add_screen_recording
+        end
+
+        private
+
+        def add_screen_recording
           Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
-            def start_recording_screen(file_path: '/sdcard/default.mp4', video_size: '1280x720',
-                                       time_limit: '180', bit_rate: '3000000')
-              execute(:start_recording_screen, {},
-                      filePath: file_path, videoSize: video_size, timeLimit: time_limit, bitRate: bit_rate)
+            # rubocop:disable Metrics/ParameterLists
+            def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil,
+                                       video_size: nil, time_limit: '180', bit_rate: '4000000')
+              option = ::Appium::Core::Device::ScreenRecord.new(
+                remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
+              ).upload_option
+
+              option[:videoSize] = video_size unless video_size.nil?
+              option[:timeLimit] = time_limit
+              option[:bitRate] = bit_rate
+
+              execute(:start_recording_screen, {}, { options: option })
             end
+            # rubocop:enable Metrics/ParameterLists
           end
         end
       end

data/lib/appium_lib_core/common/command.rb

@@ -24,8 +24,7 @@ module Appium
         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],
         get_network_connection:     [:get,  'session/:session_id/network_connection'.freeze], # defined also in OSS
-        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze],
-        stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'.freeze]
+        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze]
         # iOS
       }.freeze
 
@@ -53,15 +52,16 @@ module Appium
         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]
+        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'.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]
       }.freeze
 
       COMMAND_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], # defined also in OSS
-        get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'.freeze],
-        start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'.freeze]
+        get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'.freeze]
       }.freeze
 
       COMMAND_IOS = {

data/lib/appium_lib_core/common/device.rb

@@ -402,6 +402,33 @@ module Appium
       #   @driver.take_element_screenshot(element, "fine_name.png")
       #
 
+      # @!method stop_recording_screen(remote_path:, user:, pass:, method:)
+      #
+      # @option [String] remote_path The path to the remote location, where the resulting video should be uploaded.
+      #                             The following protocols are supported: http/https, ftp.
+      #                             Null or empty string value (the default setting) means the content of resulting
+      #                             file should be encoded as Base64 and passed as the endpoint response value.
+      #                             An exception will be thrown if the generated media file is too big to
+      #                             fit into the available process memory.
+      # @option [String] user The name of the user for the remote authentication.
+      # @option [String] pass The password for the remote authentication.
+      # @option [String] method The http multipart upload method name. The 'PUT' one is used by default.
+      #
+      # @example
+      #
+      #    @driver.stop_recording_screen
+      #    @driver.stop_recording_screen remote_path: 'https://example.com', user: 'example', pass: 'pass', method: 'POST'
+      #
+
+      # @!method stop_and_save_recording_screen(file_path)
+      #
+      # @option [String] file_path The path to save video decoded from base64 from Appium server.
+      #
+      # @example
+      #
+      #    @driver.stop_and_save_recording_screen 'example.mp4'
+      #
+
       ####
       ## class << self
       ####
@@ -540,6 +567,7 @@ module Appium
           add_touch_actions
           add_ime_actions
           add_handling_context
+          add_screen_recording
         end
 
         # def extended
@@ -680,6 +708,27 @@ module Appium
             end
           end
         end
+
+        def add_screen_recording
+          add_endpoint_method(:stop_recording_screen) do
+            def stop_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT')
+              option = ::Appium::Core::Device::ScreenRecord.new(
+                remote_path: remote_path, user: user, pass: pass, method: method
+              ).upload_option
+
+              params = option.empty? ? {} : { options: option }
+
+              execute(:stop_recording_screen, {}, params)
+            end
+          end
+
+          add_endpoint_method(:stop_and_save_recording_screen) do
+            def stop_and_save_recording_screen(file_path)
+              base64data = execute(:stop_recording_screen, {}, {})
+              File.open(file_path, 'wb') { |f| f << Base64.decode64(base64data) }
+            end
+          end
+        end
       end # class << self
     end # module Device
   end # module Core

data/lib/appium_lib_core/device/screen_record.rb

@@ -0,0 +1,35 @@
+module Appium
+  module Core
+    module Device
+      class ScreenRecord
+        #
+        # @api private
+        #
+
+        attr_reader :upload_option
+
+        METHOD = %w(POST PUT).freeze
+
+        def initialize(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil)
+          @upload_option = if remote_path.nil?
+                             {}
+                           else
+                             raise 'method should be POST or PUT' unless METHOD.member?(method.to_s.upcase)
+
+                             option = {}
+                             option[:remotePath] = remote_path
+                             option[:user] = user unless user.nil?
+                             option[:pass] = pass unless pass.nil?
+                             option[:method] = method
+                             option
+                           end
+
+          return if force_restart.nil?
+
+          raise 'force_restart should be true or false' unless [true, false].member?(force_restart)
+          @upload_option[:forceRestart] = force_restart
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/driver.rb

@@ -30,7 +30,7 @@ module Appium
       attr_reader :export_session_path
 
       # Default wait time for elements to appear
-      # Returns the default client side wait. 20 second is by default.
+      # Returns the default client side wait. 20 seconds is by default.
       # Provide Appium::Drive like { appium_lib: { wait: 30 } }
       # @return [Integer]
       attr_reader :default_wait
@@ -40,13 +40,13 @@ module Appium
       # @return [Integer]
       attr_reader :port
 
-      # Return a time wait timeout. 30 second is by default.
+      # Return a time wait timeout. 30 seconds is by default.
       # Wait time for ::Appium::Core::Base::Wait, wait and wait_true
       # Provide Appium::Drive like { appium_lib: { wait_timeout: 20 } }
       # @return [Integer]
       attr_reader :wait_timeout
 
-      # Return a time to wait interval. 0.5 second is by default.
+      # Return a time to wait interval. 0.5 seconds is by default.
       # Wait interval time for ::Appium::Core::Base::Wait, wait and wait_true
       # Provide Appium::Drive like { appium_lib: { wait_interval: 0.1 } }
       # @return [Integer]

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

@@ -29,6 +29,37 @@ module Appium
         #   @driver.background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
         #
 
+        # @!method start_recording_screen(remote_path:, user:, pass:, method:, force_restart:,
+        #                                 video_type:, time_limit:, video_quality:)
+        #
+        # @option [String] remote_path The path to the remote location, where the resulting video should be uploaded.
+        #                             The following protocols are supported: http/https, ftp.
+        #                             Null or empty string value (the default setting) means the content of resulting
+        #                             file should be encoded as Base64 and passed as the endpount response value.
+        #                             An exception will be thrown if the generated media file is too big to
+        #                             fit into the available process memory.
+        #                             This option only has an effect if there is screen recording process in progreess
+        #                             and `forceRestart` parameter is not set to `true`.
+        # @option [String] user The name of the user for the remote authentication.
+        # @option [String] pass The password for the remote authentication.
+        # @option [String] method The http multipart upload method name. The 'PUT' one is used by default.
+        # @option [Boolean] force_restart Whether to try to catch and upload/return the currently running screen recording
+        #                                 (`false`, the default setting on server) or ignore the result of it
+        #                                 and start a new recording immediately (`true`).
+        #
+        # @param [String] video_type The format of the screen capture to be recorded.
+        #                            Available formats: "h264", "mp4" or "fmp4". Default is "mp4".
+        #                            Only works for Simulator.
+        # @param [String] time_limit Recording time. 180 seconds is by default.
+        # @param [String] video_quality The video encoding quality (low, medium, high, photo - defaults to medium).
+        #                               Only works for real devices.
+        #
+        # @example
+        #
+        #    @driver.start_recording_screen
+        #    @driver.start_recording_screen video_type: 'h264', time_limit: '260'
+        #
+
         ####
         ## class << self
         ####
@@ -58,6 +89,29 @@ module Appium
                 execute :background_app, {}, seconds: { timeout: duration_milli_sec }
               end
             end
+
+            add_screen_recording
+          end
+
+          private
+
+          def add_screen_recording
+            Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
+              # rubocop:disable Metrics/ParameterLists
+              def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: nil, force_restart: nil,
+                                         video_type: 'mp4', time_limit: '180', video_quality: 'medium')
+                option = ::Appium::Core::Device::ScreenRecord.new(
+                  remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
+                ).upload_option
+
+                option[:videoType] = video_type
+                option[:timeLimit] = time_limit
+                option[:videoQuality] = video_quality
+
+                execute(:start_recording_screen, {}, { options: option })
+              end
+              # rubocop:enable Metrics/ParameterLists
+            end
           end
         end # class << self
       end # module Device

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.2.7'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-01-25'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.3.0'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-01-28'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,11 @@
+#### v1.3.0 2018-01-28
+
+- [b7a994b](https://github.com/appium/ruby_lib_core/commit/b7a994ba29b3870257cf7e8af602deb147afd791) Release 1.3.0
+- [f421cad](https://github.com/appium/ruby_lib_core/commit/f421cad6a1941eb51837a8a2e5b4c403ae2aba42) add error message assertion
+- [9864037](https://github.com/appium/ruby_lib_core/commit/9864037619e102decdf5e8f888352eb355193f65) move screen recording command to common (#55)
+- [8cffce7](https://github.com/appium/ruby_lib_core/commit/8cffce73ec45443dcc037b9b440de44e946ba13a) Update CHANGELOG.md
+
+
 #### v1.2.7 2018-01-25
 
 - [02b3845](https://github.com/appium/ruby_lib_core/commit/02b3845a58afb349f62e5d699cfcccee20810665) Release 1.2.7

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -218,6 +218,7 @@ files:
 - lib/appium_lib_core/common/log.rb
 - lib/appium_lib_core/common/logger.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