appium_lib_core 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5508c27e048a97c7cada6eaadf5508571ecc3922
-  data.tar.gz: 1f11cc39e8b4ae69da7d148b7c412d3c6b82ee1e
+  metadata.gz: aaa0d993203afcfa428e6e478416365588854f88
+  data.tar.gz: f087a75d818f5b888d09d606d1f60660caee5ca4
 SHA512:
-  metadata.gz: 6959fb85dff564a612fc218e64abfdc13bfa625f13fb1a20d0cc41cff7d74b4e60eb334cd81e2ddbc87e7fca8db8461bd319c348d51f7623a143695e00abc434
-  data.tar.gz: b2237a2d4d6b017cbe4d1ea5f9fd9e8b5fcfecfe5634878364b1db8e31f1544cfd3f6d2e1400c136cbb807db809d53b19bef6a92c49691da168d35b77f3dbcbd
+  metadata.gz: 59d58196a9e24a24d51636f1c744ca75317b9101971602efc8f5a5d21dcd9111d5f20a85da93e9c04c0edb514217888b532709a0445e7fb5e6d1e2313626c892
+  data.tar.gz: 5f3d0e30943a11ea5df3258a8b68680f9571717c89f9d595a6ea82bd4b2555057112afaf372ff81785892558c7b29373c501049b5564600b4b55bd4af1991004

data/CHANGELOG.md

@@ -8,6 +8,17 @@ All notable changes to this project will be documented in this file.
 
 ### Deprecations
 
+## [1.3.4] - 2018-03-21
+### Enhancements
+- Add `save_viewport_screenshot` which get screenshot except for status bar. 
+    - https://github.com/search?q=org%3Aappium+viewportScreenshot&type=Code
+- [iOS] Add `start_performance_record` and `get_performance_record`
+
+### Bug fixes
+- Fix _create_session attempt to throw non-existent error type Appium::Core::Error::WebDriverError_ [#66](https://github.com/appium/ruby_lib_core/issues/66)
+
+### Deprecations
+
 ## [1.3.3] - 2018-03-03
 ### Enhancements
 - add `session_capabilities`: https://appium.io/docs/en/commands/session/get/

data/Rakefile

@@ -51,7 +51,7 @@ end
 
 desc('Generate yardoc')
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
+  t.files   = %w(lib/**/*.rb)
 end
 
 desc('Execute RuboCop static code analysis')

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

@@ -22,7 +22,7 @@ module Appium
 
           if desired_capabilities.is_a?(Symbol)
             unless ::Selenium::WebDriver::Remote::Capabilities.respond_to?(desired_capabilities)
-              raise Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
+              raise ::Selenium::WebDriver::Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
             end
             desired_capabilities = Remote::Capabilities.__send__(desired_capabilities)
           end
@@ -105,7 +105,7 @@ module Appium
           end
 
           unless @session_id
-            raise Error::WebDriverError, 'no sessionId in returned payload'
+            raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload'
           end
 
           json_create(oss_status, value)

data/lib/appium_lib_core/common/device.rb

@@ -369,6 +369,15 @@ module Appium
       #   @driver.pull_folder '/data/local/tmp' #=> Get the folder at that path
       #
 
+      # @since 1.3.4
+      # @!method save_viewport_screenshot
+      # Save screenshot except for status bar while `@driver.save_screenshot` save entire screen.
+      #
+      # @example
+      #
+      #   @driver.save_viewport_screenshot 'path/to/save.png' #=> Get the File instance of viewport_screenshot
+      #
+
       # @!method update_settings(settings)
       # Update Appium Settings for current test session
       # @param [Hash] settings Settings to update, keys are settings, values to value to set each setting to
@@ -630,6 +639,18 @@ module Appium
             end
           end
 
+          add_endpoint_method(:save_viewport_screenshot) do
+            def save_viewport_screenshot(png_path)
+              extension = File.extname(png_path).downcase
+              if extension != '.png'
+                WebDriver.logger.warn 'name used for saved screenshot does not match file type. '\
+                                  'It should end with .png extension'
+              end
+              viewport_screenshot_encode64 = execute_script('mobile: viewportScreenshot')
+              File.open(png_path, 'wb') { |f| f << viewport_screenshot_encode64.unpack('m')[0] }
+            end
+          end
+
           add_keyevent
           add_touch_actions
           add_ime_actions

data/lib/appium_lib_core/driver.rb

@@ -190,14 +190,14 @@ module Appium
       # Ignore setting default wait if the target driver has no implementation
       def set_implicit_wait_by_default(wait)
         @driver.manage.timeouts.implicit_wait = wait
-      rescue Selenium::WebDriver::Error::UnknownError => e
+      rescue ::Selenium::WebDriver::Error::UnknownError => e
         unless e.message.include?('The operation requested is not yet implemented')
           raise e.message, ::Appium::Core::Error::ServerError
         end
 
         Appium::Logger.debug(e.message)
         {}
-      rescue Selenium::WebDriver::Error::WebDriverError => e
+      rescue ::Selenium::WebDriver::Error::WebDriverError => e
         # FIXME: Temporary rescue until Appium support W3C's implicit wait
         # https://github.com/jlipps/simple-wd-spec#set-timeouts
         unless e.message.include?('Parameters were incorrect. We wanted {"required":["type","ms"]} and you sent ["implicit"]')

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

@@ -59,6 +59,56 @@ module Appium
         #    @driver.start_recording_screen video_type: 'h264', time_limit: '260'
         #
 
+        # @since 1.3.4
+        # @!method start_performance_record(timeout: 300000, profile_name: 'Activity Monitor')
+        #
+        # This is a blocking application.
+        # @param [Integer|String] timeout: The maximum count of milliseconds to record the profiling information.
+        # @param [String] profile_name: The name of existing performance profile to apply.
+        #                               Execute `instruments -s` to show the list of available profiles.
+        #                               Note, that not all profiles are supported on mobile devices.
+        # @param [Integer|String] pid: The ID of the process to measure the performance for.
+        #                              Set it to `current` in order to measure the performance of
+        #                              the process, which belongs to the currently active application.
+        #                              All processes running on the device are measured if
+        #                              pid is unset (the default setting). Setting process ID while
+        #                              device under test is Simulator might require `instruments` to be launched
+        #                              with sudo privileges, which is not supported and will throw a timeout exception.
+        # @return nil
+        #
+        # @example
+        #
+        #   @driver.start_performance_record # default: (timeout: 300000, profile_name: 'Activity Monitor')
+        #   @driver.start_performance_record(timeout: 300000, profile_name: 'Activity Monitor')
+        #
+
+        # @since 1.3.4
+        # @!method get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor', remote_path: nil, user: nil, pass: nil, method: 'PUT')
+        #
+        # This is a blocking application.
+        #
+        # @param [String] save_file_path: A path to save data as zipped .trace file
+        # @param [String] profile_name: The name of existing performance profile to apply.
+        #                               Execute `instruments -s` to show the list of available profiles.
+        #                               Note, that not all profiles are supported on mobile devices.
+        # @param [String] save_file_path: The name of existing performance profile to apply.
+        #                              Execute `instruments -s` to show the list of available profiles.
+        #                              Note, that not all profiles are supported on mobile devices.
+        # @param [String] remote_path: The path to the remote location, where the resulting zipped .trace file 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 zipped, encoded as Base64 and passed as the endpount response value.
+        #                              An exception will be thrown if the generated file is too big to
+        #                              fit into the available process memory.
+        # @param [String] user: The name of the user for the remote authentication. Only works if `remotePath` is provided.
+        # @param [String] pass: The password for the remote authentication. Only works if `remotePath` is provided.
+        # @param [String] method: The http multipart upload method name. Only works if `remotePath` is provided.
+        #
+        # @example
+        #
+        #   @driver.get_performance_record
+        #   @driver.get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor')
+
         # rubocop:enable Metrics/LineLength
 
         ####
@@ -91,11 +141,41 @@ module Appium
               end
             end
 
+            add_performance
             add_screen_recording
           end
 
           private
 
+          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)
+                option = {}
+                option[:timeout] = timeout
+                option[:profileName] = profile_name
+                option[:pid] = pid if pid
+
+                execute_script 'mobile: startPerfRecord', option
+              end
+            end
+
+            Appium::Core::Device.add_endpoint_method(:get_performance_record) do
+              # rubocop:disable Metrics/ParameterLists
+              def get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor',
+                                         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
+
+                option[:profileName] = profile_name
+                result = execute_script 'mobile: stopPerfRecord', option
+
+                File.open("#{save_file_path}.zip", 'wb') { |f| f << result.unpack('m')[0] }
+              end
+              # rubocop:enable Metrics/ParameterLists
+            end
+          end
+
           def add_screen_recording
             Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
               # rubocop:disable Metrics/ParameterLists

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.3.3'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-03-03'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.3.4'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-03-21'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,14 @@
+#### v1.3.4 2018-03-21
+
+- [053458e](https://github.com/appium/ruby_lib_core/commit/053458e8c766c2f83c7025251e1aeebb1a2da4d5) Release 1.3.4
+- [0987ba3](https://github.com/appium/ruby_lib_core/commit/0987ba361f276c9cdbbf6d400201ec49316a09f6) Fix error initialisation (#67)
+- [0064cee](https://github.com/appium/ruby_lib_core/commit/0064cee5a9077858f4903e325471405aefb51fbd) append pid
+- [73185aa](https://github.com/appium/ruby_lib_core/commit/73185aa548e4118f19f23f46814dc2ed52f77b53) apply https://github.com/appium/appium-xcuitest-driver/pull/638
+- [2b46bcf](https://github.com/appium/ruby_lib_core/commit/2b46bcf168dc6bd4524749beaa9aa5676b65a0cb) add getting performance in core as same as Android (#65)
+- [d7335ee](https://github.com/appium/ruby_lib_core/commit/d7335ee5a2c18b8d1a61b125858b825d196c72d1) rename
+- [443394d](https://github.com/appium/ruby_lib_core/commit/443394dc0de09929866f70aea983c77b556b924a) add viewportScreen (#63)
+
+
 #### v1.3.3 2018-03-03
 
 - [bf9a6a3](https://github.com/appium/ruby_lib_core/commit/bf9a6a357f7c318fd3aae489552964e6dc847a8e) Release 1.3.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -205,6 +205,7 @@ files:
 - appium_lib_core.gemspec
 - bin/console
 - bin/setup
+- docs/mobile_command.md
 - lib/appium_lib_core.rb
 - lib/appium_lib_core/android.rb
 - lib/appium_lib_core/android/device.rb