headless-muse 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3ef46e8f92d17bf336aae8bab33f7e138dd4619
-  data.tar.gz: 36029054c983b680a1996121ae0256a52c5f034a
+  metadata.gz: a2bebc3311027182542cd8a5374d6f56074b9954
+  data.tar.gz: 9a26b8fb2b5b68ff99423af6501e2ceca992ec90
 SHA512:
-  metadata.gz: a4e524a612efbeab185f98efa58ba2c7490a391bc02bdee9a327b8760d62837ed76f575c4756c20aa3442978b17d0305bf0a261c8eb7e7391652c5e3b1006917
-  data.tar.gz: 0df9462f894b68182517fe89552b22fc5ce09f1143d44233efa46e9fd5dece0d559e049bb4311e752fb69757608871db0e0a922f1b4006cc087566d4b7b12254
+  metadata.gz: 976b2176d38bc395b96e574e6252a893f4e44df9d9d0920c5f46c542bbe1737b37725fb6f2d060672985fce9e88598bf8892861a6b02e29d0311dd741cb36d56
+  data.tar.gz: 0ee6c18e1b05285179dd1f884896d8fd39b2b496e628042a61237183b8dcdcb660329b1d55eb563337f5a9b2ff3aa21652310811ca21d6d00a375f3a758256c8

data/.travis/setup.sh

@@ -3,7 +3,7 @@ case "$FFMPEG_VERSION" in
     2.3)
         sudo add-apt-repository ppa:archivematica/externals -y
         sudo apt-get update -q
-        sudo apt-get install ffmpeg
+        sudo apt-get install ffmpeg fluxbox
         ;;
 
     1.2)
@@ -11,5 +11,5 @@ case "$FFMPEG_VERSION" in
         ;;
     *)
         sudo apt-get update -q
-        sudo apt-get install ffmpeg
+        sudo apt-get install ffmpeg fluxbox
 esac

data/README.md

@@ -1,10 +1,12 @@
 # Headless
+[![Gem Version](https://badge.fury.io/rb/headless-muse.svg)](http://badge.fury.io/rb/headless-muse)
 [![Build Status](https://travis-ci.org/pgeraghty/headless.svg?branch=master)](https://travis-ci.org/pgeraghty/headless)
 [![Coverage Status](https://img.shields.io/coveralls/pgeraghty/headless.svg)](https://coveralls.io/r/pgeraghty/headless?branch=master)
+[![Code Climate](https://codeclimate.com/github/pgeraghty/headless/badges/gpa.svg)](https://codeclimate.com/github/pgeraghty/headless)
 
 # This fork
 
-This fork is the source of the [headless-muse gem]().
+This fork is the source of the [headless-muse gem](https://rubygems.org/gems/headless-muse).
 
 ## Notes by original author (Leonid Shevtsov)
 

data/headless.gemspec

@@ -3,16 +3,16 @@ Gem::Specification.new do |s|
   s.email = 'muse@appsthatcould.be'
 
   s.name = 'headless-muse'
-  s.version = '1.1.0'
+  s.version = '1.1.1'
   s.summary = 'Ruby headless display interface'
 
   s.description = <<-EOF
     Headless is a Ruby interface for Xvfb. It allows you to create a headless display straight from Ruby code, hiding some low-level action.
-    It can also capture video and audio via ffmpeg and take screenshots.
+    It can also capture video and audio via ffmpeg (including the latest versions) and take screenshots using ImageMagick.
   EOF
   s.requirements = 'Xvfb'
   s.homepage = 'https://github.com/pgeraghty/headless'
-s.license = 'MIT'
+  s.license = 'MIT'
   s.files         = `git ls-files`.split("\n")
 
   s.add_development_dependency 'rake'

data/lib/headless/cli_util.rb

@@ -23,10 +23,8 @@ class Headless
           Process.kill(0, pid)
           pid
         rescue Errno::ESRCH
-          nil
+          false
         end
-      else
-        nil
       end
     end
 
@@ -43,9 +41,10 @@ class Headless
     end
 
     def self.kill_process(pid_filename, options={})
+      options[:sig] ||= 'TERM'
       if pid = self.read_pid(pid_filename)
         begin
-          Process.kill 'TERM', pid
+          Process.kill options[:sig], pid
           Process.wait pid if options[:wait]
         rescue Errno::ESRCH
           # no such process; assume it's already killed
@@ -60,5 +59,17 @@ class Headless
         # pid file already removed
       end
     end
+
+    def self.signal_process(pid_filename, signal, options={})
+      if pid = self.read_pid(pid_filename)
+        begin
+          Process.kill signal, pid
+          true
+        rescue Errno::ESRCH
+          # no such process; assume it's already killed
+          false
+        end
+      end
+    end
   end
 end

data/lib/headless/video/video_recorder.rb

@@ -58,8 +58,16 @@ class Headless
       end
     end
 
+    def pause
+      CliUtil.signal_process(@pid_file_path, 'STOP')
+    end
+
+    def resume
+      CliUtil.signal_process(@pid_file_path, 'CONT')
+    end
+
     def stop_and_save(path)
-      CliUtil.kill_process(@pid_file_path, :wait => true)
+      CliUtil.kill_process(@pid_file_path, :wait => true, :sig => 'INT')
       if File.exists? @tmp_file_path
         begin
           FileUtils.mv(@tmp_file_path, path)

data/spec/cli_util_spec.rb

@@ -57,9 +57,40 @@ describe Headless::CliUtil do
       subject.class.read_pid('/tmp/.headless_ffmpeg_99.pid').should eq(999999999999)
     end
 
-    it 'returns nil after a rescued error when process does not exist' do
+    it 'returns false after a rescued error when process does not exist' do
       Process.stub(:kill).and_raise(Errno::ESRCH)
-      subject.class.read_pid('/tmp/.headless_ffmpeg_99.pid').should eq(nil)
+      subject.class.read_pid('/tmp/.headless_ffmpeg_99.pid').should eq(false)
+    end
+  end
+
+  describe 'signal_process' do
+    let(:pidfile) { '/tmp/pid' }
+    let(:fakepid) { 999999999999 }
+
+    before do
+      Process.stub(:kill)
+      File.stub(:read).and_return(fakepid.to_s)
+    end
+
+    it 'reads PID file' do
+      #File.should_receive(:read).with(pidfile).and_return('')
+      File.stub(:read).and_return('')
+      subject.class.should_receive(:read_pid).with(pidfile).and_return(nil)
+      subject.class.signal_process(pidfile, 'CONT').should eq(nil)
     end
+
+    it 'sends signal to process' do
+      Process.should_receive(:kill).with('CONT', fakepid)
+      subject.class.should_receive(:read_pid).with(pidfile).and_return(fakepid)
+      subject.class.signal_process(pidfile, 'CONT').should eq(true)
+    end
+
+    it 'returns false after a rescued error when process does not exist' do
+      Process.stub(:kill).and_raise(Errno::ESRCH)
+      subject.class.should_receive(:read_pid).with(pidfile).and_return(fakepid)
+      subject.class.signal_process(pidfile, 'STOP').should eq(false)
+    end
+
+
   end
 end

data/spec/features/capture_video_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Headless::VideoRecorder do
+  it 'should capture 10s of video on request' do
+    h = Headless.new(:display => 99, :reuse => true, :dimensions => '1280x720x24')
+
+    capture_file = '/tmp/screen-capture-mpeg4.mkv'
+    log = '/tmp/ffmpeg_test.log'
+
+    sleep 5 # give Xvfb some time
+    `DISPLAY=:99 fluxbox > /dev/null 2>&1 &`
+    sleep 3
+    `ffmpeg -f x11grab -r 30 -s 1280x720 -i :99.0 -vcodec mpeg4 -qscale:v 2 -threads 1 -y -t 10 #{capture_file} > #{log} 2>&1`
+    expected_duration =
+        if h.video.guess_ffmpeg_version! > Gem::Version.new(1.2)
+          /time=00:00:10/
+        else
+          /time=10/
+        end
+    expect(File.read log).to match(expected_duration)
+    expect(`ffprobe #{capture_file} 2>&1 | grep Duration`).to match(/Duration: 00:00:10/)
+    `rm #{capture_file}`
+    expect { h.destroy }.not_to raise_error
+  end
+end if Headless::CliUtil.application_exists?('Xvfb') && Headless::CliUtil.application_exists?('ffmpeg')

data/spec/features/headless_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Headless do
+  let(:h) { Headless.new }
+
+  it 'should start Xvfb when instantiated' do
+    expect(h).to be_instance_of(Headless)
+  end
+
+  it 'should destroy Xvfb when requested' do
+    expect { h.destroy }.not_to raise_error
+  end
+end if Headless::CliUtil.application_exists?('Xvfb')

data/spec/video_recorder_spec.rb

@@ -32,7 +32,7 @@ describe Headless::VideoRecorder do
     end
   end
 
-  context "stopping video recording" do
+  context 'stopping, pausing and resuming video recording' do
     let(:tmpfile) { '/tmp/ci.mov' }
     let(:filename) { '/tmp/test.mov' }
     let(:pidfile) { '/tmp/pid' }
@@ -45,7 +45,7 @@ describe Headless::VideoRecorder do
 
     describe "using #stop_and_save" do
       it "stops video recording and saves file" do
-        Headless::CliUtil.should_receive(:kill_process).with(pidfile, :wait => true)
+        Headless::CliUtil.should_receive(:kill_process).with(pidfile, :wait => true, :sig => 'INT')
         File.should_receive(:exists?).with(tmpfile).and_return(true)
         FileUtils.should_receive(:mv).with(tmpfile, filename)
 
@@ -75,6 +75,22 @@ describe Headless::VideoRecorder do
       end
     end
 
+    describe 'using #pause' do
+      it 'pauses video recording' do
+        Headless::CliUtil.should_receive(:signal_process).with(pidfile, 'STOP')
+
+        expect(subject.pause).to eq(nil)
+      end
+    end
+
+    describe 'using #resume' do
+      it 'resumes video recording' do
+        Headless::CliUtil.should_receive(:signal_process).with(pidfile, 'CONT')
+
+        expect(subject.resume).to eq(nil)
+      end
+    end
+
     describe '#capture_running?' do
       it 'returns false unless the PID file exists' do
         Headless::CliUtil.should_receive(:read_pid).with(pidfile)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: headless-muse
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Leonid Shevtsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -56,7 +56,7 @@ dependencies:
         version: '0'
 description: |2
       Headless is a Ruby interface for Xvfb. It allows you to create a headless display straight from Ruby code, hiding some low-level action.
-      It can also capture video and audio via ffmpeg and take screenshots.
+      It can also capture video and audio via ffmpeg (including the latest versions) and take screenshots using ImageMagick.
 email: muse@appsthatcould.be
 executables: []
 extensions: []
@@ -75,6 +75,8 @@ files:
 - lib/headless/cli_util.rb
 - lib/headless/video/video_recorder.rb
 - spec/cli_util_spec.rb
+- spec/features/capture_video_spec.rb
+- spec/features/headless_spec.rb
 - spec/headless_spec.rb
 - spec/spec_helper.rb
 - spec/video_recorder_spec.rb