mobile-emulator-screencapture 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc0449def559a85389fd5d0fbe0b60671bab7da1fa58920f85e35d364dd52782
+  data.tar.gz: a5a7cf70881b017dc4f23cdcc918df3614b122e55f773da5f17cd4e497ed9037
+SHA512:
+  metadata.gz: df46951b4ed41f4cf886f81fd35bb674a7dd5b0c55b4312cd9a7730a447c113cf410e264921ed31563a627d44ae27b9affee7e44d22936fc66b8f2769088a937
+  data.tar.gz: 07b3b44e00462530d67d4396064cc74017d190ae8f9c47d3f9fffb42eb3f5147002ed8a7145df4bc567b9b2d25c9986ecd5fd9e6b482a6559df1c653b0c2b675

data/.gitignore

@@ -0,0 +1,41 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+
+# Created by https://www.gitignore.io/api/macos
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+# End of https://www.gitignore.io/api/macos

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+    TargetRubyVersion: 2.4
+Style/FrozenStringLiteralComment:
+    Enabled: false
+Style/StringLiterals:
+    Enabled: false
+Metrics/LineLength:
+    Enabled: false
+Style/Documentation:
+    Enabled: false
+
+Style/ClassAndModuleChildren:
+    Enabled: true
+    Exclude:
+      - test/**/*
+Metrics/MethodLength:
+    Enabled: true
+    Exclude:
+      - test/**/*

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+os:
+  - linux
+  - osx
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mobile-emulator-screencapture.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    mobile-emulator-screencapture (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    metaclass (0.0.4)
+    minitest (5.11.3)
+    mocha (1.3.0)
+      metaclass (~> 0.0.1)
+    parallel (1.12.1)
+    parser (2.5.0.4)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest
+  mobile-emulator-screencapture!
+  mocha
+  rake (~> 10.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kenta Kase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Mobile::Emulator::Screencapture
+
+Ruby wrapper for take screenshot and screenrecord on ios/android emulators.
+
+## How to work
+### Android
+Using `adb screencap` and `adb screenrecord`  
+see: https://developer.android.com/studio/command-line/adb.html
+
+`adb screenrcord` is only supported: Android >= 4.4（API Level 19）
+
+### iOS
+**Not supported yet**
+
+Using `xcrun simctl io screenshot` and `xcrun simctl io recordVideo`
+
+see: `xcrun simctl io --help`
+
+`xcrun simctl io screenshot` is only supported: Xcode >= 8.2
+
+## Installation
+
+```ruby
+gem 'mobile-emulator-screencapture'
+```
+
+## Usage
+### Android
+
+```ruby
+require 'mobile/emulator/screencapture'
+
+android = Mobile::Emulator::Screencapture.create(
+  platform: "android",
+  screenshot_dir: "./screenshot",
+  screenrecord_dir: "./screenrecord",
+
+  # options for adb screenrecord
+  width: 720,
+  height: 360
+  bit_rate: 6_000_000,
+  time_limit: 180
+)
+
+android.screenshot("test")
+# > ./screenshot/test.png
+
+android.start_screenrecord("test")
+sleep 30
+android.stop_screenrecord
+# > ./screenrecord/test.mp4
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Kesin11/mobile-emulator-screencapture.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task :lint_test do
+  Rake::Task['rubocop'].invoke
+  Rake::Task['test'].invoke
+end
+
+task default: :lint_test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mobile/emulator/screencapture"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mobile/emulator/screencapture.rb

@@ -0,0 +1,21 @@
+require "mobile/emulator/screencapture/version"
+require "mobile/emulator/screencapture/android"
+require "mobile/emulator/screencapture/ios"
+
+module Mobile
+  module Emulator
+    module Screencapture
+      class << self
+        def create(**args)
+          if args[:platform] == "android"
+            Mobile::Emulator::Screencapture::Android.new(args)
+          elsif args[:platform] == "ios"
+            Mobile::Emulator::Screencapture::Ios.new(args)
+          else
+            raise "Not support platform: #{args[:platform]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mobile/emulator/screencapture/android.rb

@@ -0,0 +1,98 @@
+require 'mobile/emulator/screencapture/base'
+
+module Mobile
+  module Emulator
+    module Screencapture
+      class Android < Base
+        DEVICE_SCREENSHOT_PATH = '/sdcard/screenshot.png'.freeze
+        DEVICE_SCREENRECORD_PATH = '/sdcard/screenrecord.mp4'.freeze
+
+        attr_reader :width, :height, :bit_rate, :time_limit
+        def initialize(**args)
+          super(args)
+          @width = args[:width]
+          @height = args[:height]
+          @bit_rate = args[:bit_rate]
+          @time_limit = args[:time_limit]
+
+          @screenrecord_path = nil
+        end
+
+        def screenshot(image_name)
+          raise "Argument image_name is nil" if image_name.nil?
+
+          screenshot_path = File.join(@screenshot_dir, "#{image_name}.png")
+          _native_screenshot
+          _pull_screenshot(screenshot_path)
+
+          screenshot_path
+        end
+
+        def start_screenrecord(video_name)
+          raise "Argument video_name is nil" if video_name.nil?
+          raise "Screenrecord process already started. pid: #{@screenrecord_pid}" if @screenrecord_pid
+
+          @screenrecord_path = File.join(@screenrecord_dir, "#{video_name}.mp4")
+          @screenrecord_pid = _native_start_screenrecord
+
+          @screenrecord_path
+        end
+
+        def stop_screenrecord
+          raise 'Any screenrecord process did not started' unless @screenrecord_pid
+          screenrecord_path = @screenrecord_path
+
+          _native_stop_screenrecord
+          _pull_screenrecord(screenrecord_path)
+
+          @screenrecord_pid = nil
+          @screenrecord_path = nil
+
+          screenrecord_path
+        end
+
+        private
+
+        def _adb(command)
+          `adb #{command}`
+        end
+
+        def _adb_spawn(command)
+          pid = spawn("adb #{command}", out: '/dev/null')
+          Process.detach(pid)
+          pid
+        end
+
+        def _native_screenshot
+          _adb("shell screencap #{DEVICE_SCREENSHOT_PATH}")
+        end
+
+        def _pull_screenshot(screenshot_path)
+          _adb("pull #{DEVICE_SCREENSHOT_PATH} #{screenshot_path}")
+          _adb("shell rm #{DEVICE_SCREENSHOT_PATH}")
+        end
+
+        def _native_start_screenrecord
+          command = ["shell screenrecord #{DEVICE_SCREENRECORD_PATH}"]
+          command << "--size #{@width}x#{@height}" if @width && @height
+          command << "--bit-rate #{@bit_rate}" if @bit_rate
+          command << "--time-limit #{@time_limit}" if @time_limit
+          _adb_spawn(command.join(' '))
+        end
+
+        def _native_stop_screenrecord
+          killed_process_num = Process.kill('SIGINT', @screenrecord_pid)
+          raise "Kill pid: #{@screenrecord_pid} did not end correctly." unless killed_process_num.positive?
+
+          # If 'adb pull' after kill recording process soon, the video will be broken.
+          sleep 2
+        end
+
+        def _pull_screenrecord(screenrecord_path)
+          _adb("pull #{DEVICE_SCREENRECORD_PATH} #{screenrecord_path}")
+          _adb("shell rm #{DEVICE_SCREENRECORD_PATH}")
+        end
+      end
+    end
+  end
+end

data/lib/mobile/emulator/screencapture/base.rb

@@ -0,0 +1,20 @@
+require 'fileutils'
+
+module Mobile
+  module Emulator
+    module Screencapture
+      class Base
+        attr_reader :screenshot_dir, :screenrecord_dir
+        def initialize(**args)
+          @screenshot_dir = args[:screenshot_dir] || Bundler.root
+          @screenrecord_dir = args[:screenrecord_dir] || Bundler.root
+
+          @screenrecord_pid = nil
+
+          FileUtils.mkdir_p(@screenshot_dir)
+          FileUtils.mkdir_p(@screenrecord_dir)
+        end
+      end
+    end
+  end
+end

data/lib/mobile/emulator/screencapture/ios.rb

@@ -0,0 +1,13 @@
+require 'mobile/emulator/screencapture/base'
+
+module Mobile
+  module Emulator
+    module Screencapture
+      class Ios < Base
+        def initialize(**args)
+          super(args)
+        end
+      end
+    end
+  end
+end

data/lib/mobile/emulator/screencapture/version.rb

@@ -0,0 +1,7 @@
+module Mobile
+  module Emulator
+    module Screencapture
+      VERSION = "0.1.0".freeze
+    end
+  end
+end

data/mobile-emulator-screencapture.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mobile/emulator/screencapture/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mobile-emulator-screencapture"
+  spec.version       = Mobile::Emulator::Screencapture::VERSION
+  spec.authors       = ["Kenta Kase"]
+  spec.email         = ["kesin1202000@gmail.com"]
+
+  spec.summary       = 'Ruby wrapper for ios/android screen capture'
+  spec.description   = 'Ruby wrapper for ios/android screen capture using simctl/adb screenshot/screenrecord.'
+  spec.homepage      = "https://github.com/Kesin11/mobile-emulator-screencapture"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: mobile-emulator-screencapture
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kenta Kase
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for ios/android screen capture using simctl/adb screenshot/screenrecord.
+email:
+- kesin1202000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mobile/emulator/screencapture.rb
+- lib/mobile/emulator/screencapture/android.rb
+- lib/mobile/emulator/screencapture/base.rb
+- lib/mobile/emulator/screencapture/ios.rb
+- lib/mobile/emulator/screencapture/version.rb
+- mobile-emulator-screencapture.gemspec
+homepage: https://github.com/Kesin11/mobile-emulator-screencapture
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for ios/android screen capture
+test_files: []