add viewportScreen (#63)

Author: KazuCocoa

CHANGELOG.md

@@ -3,6 +3,8 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 ### Enhancements
+- Add `save_viewport_screenshot` which get screenshot except for status bar. 
+    - https://github.com/search?q=org%3Aappium+viewportScreenshot&type=Code
 
 ### Bug fixes
 

lib/appium_lib_core/common/device.rb

@@ -369,6 +369,14 @@ module Device
       #   @driver.pull_folder '/data/local/tmp' #=> Get the folder at that path
       #
 
+      # @!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 +638,18 @@ def update_settings(settings)
             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

test/functional/android/android/device_test.rb

@@ -328,6 +328,15 @@ def test_take_element_screenshot
         File.delete 'take_element_screenshot.png'
       end
 
+      def test_viewport_screenshot
+        file = @@driver.save_viewport_screenshot './ios_viewport_screenshot_test.png'
+
+        assert File.exist?(file.path)
+
+        File.delete file.path
+        assert !File.exist?(file.path)
+      end
+
       private
 
       def scroll_to(text)

test/functional/ios/ios/device_test.rb

@@ -228,6 +228,15 @@ def test_within_context
 
         assert_equal 'Buttons', result.name
       end
+
+      def test_viewport_screenshot
+        file = @@driver.save_viewport_screenshot './ios_viewport_screenshot_test.png'
+
+        assert File.exist?(file.path)
+
+        File.delete file.path
+        assert !File.exist?(file.path)
+      end
     end
   end
 end