vncrec 1.0.1

data/spec/writers_spec.rb

@@ -0,0 +1,121 @@
+require "vncrec"
+
+
+describe VNCRec::Writers do
+
+  describe ".get_writer" do
+    after(:all) {|| `rm -f *.raw *.mp4`}
+    after(:each) {|| begin $w.close; rescue NoMethodError; end; $w = nil}
+    it "handles no extension correctly" do
+      $w = VNCRec::Writers.get_writer("somefile", geometry: "1920x1080",pix_fmt: "bgr8")
+      expect($w).to be_kind_of(VNCRec::Writers::RawVideo)
+      field = $w.instance_variable_get(:@filename)
+      fn = File.basename(field)
+      expect(fn).to eq("somefile.raw")
+    end
+    it "handles raw extension correctly" do
+      $w = VNCRec::Writers.get_writer("somefile.raw", geometry: "1920x1080",pix_fmt: "bgr8")
+      expect($w).to be_kind_of(VNCRec::Writers::RawVideo)
+      field = $w.instance_variable_get(:@filename)
+      fn = File.basename(field)
+      expect(fn).to eq("somefile.raw")
+    end
+    it "handles mp4 extension correctly" do
+      $w = VNCRec::Writers.get_writer("somefile.mp4", geometry: "1920x1080",pix_fmt: "bgr8")
+      expect($w).to be_kind_of(VNCRec::Writers::FFmpeg)
+      field = $w.instance_variable_get(:@filename)
+      fn = File.basename(field)
+      expect(fn).to eq("somefile.mp4")
+    end
+    it "handles /dev/null correctly" do
+      $w = VNCRec::Writers.get_writer("somefile.mp4", geometry: "1920x1080",pix_fmt: "bgr8")
+      expect($w).to be_kind_of(VNCRec::Writers::FFmpeg)
+      field = $w.instance_variable_get(:@filename)
+      fn = File.basename(field)
+      expect(fn).to eq("somefile.mp4")
+    end
+    context "when file cannot be created" do
+      it "raises error" do
+        expect do
+          VNCRec::Writers.get_writer("/root/somefile")
+        end.to raise_error "Cannot create output file"
+      end
+    end
+  end
+
+  describe VNCRec::Writers::RawVideo do
+    after(:each) {|| begin subject.close(); rescue IOError; end; `rm -f *.raw`}
+    subject {VNCRec::Writers::RawVideo.new("file.raw")}
+    it "initializes" do
+      subject.inspect
+    end
+    it "closes correctly" do
+      expect do
+        subject.inspect
+        subject.close
+      end.not_to raise_error
+    end
+    it "#write" do
+      expect(subject).to respond_to(:write)
+      subject.inspect
+      filesize = File.size("file.raw")
+      expect do 
+        subject.write("\xFF"*10e+6)
+        filesize = File.size("file.raw")
+      end.to change{filesize}.from(0).to(10e+6)
+    end
+  end
+  
+  describe VNCRec::Writers::FFmpeg do
+
+    context "initialization" do
+    after(:all) { `rm -f *.mp4`}
+      it "Raises exception in case of wrong args" do
+        expect { || VNCRec::Writers::FFmpeg.new}.to raise_error(ArgumentError)
+        expect { || VNCRec::Writers::FFmpeg.new("somefile.mp4", pix_fmt: "bgr8")}.to raise_error("Undefined frame size")
+        expect { || VNCRec::Writers::FFmpeg.new("somefile.mp4", geometry: "1920x1080")}
+        expect {VNCRec::Writers::FFmpeg.new("somefile.mp4", geometry: "1920x1080")}.to raise_error("Undefined pixel format")
+      end
+      it "Raises nothing given correct args" do
+        expect { || VNCRec::Writers::FFmpeg.new("somefile.mp4", geometry: "1920x1080",pix_fmt: "bgr8").close}.not_to raise_error
+      end
+      context "when passed pixel format" do
+        subject {VNCRec::Writers::FFmpeg.new("somefile.mp4", geometry: "1920x1080", pix_fmt: "bgra")}
+        after(:each) {subject.close; `killall ffmpeg`}
+        it "sets @pix_fmt correspondingly" do
+          expect(subject.instance_variable_get(:@pix_fmt)).to eq VNCRec::PIX_FMT_BGRA
+          expect(subject.instance_variable_get(:@cmd)).to include("-pix_fmt bgra")
+        end
+      end
+    end
+
+    context "Closing:" do
+      w = VNCRec::Writers::FFmpeg.new("somefile.mp4", geometry: "1920x1080",pix_fmt: "bgr8")
+      w.close
+      it "#close closes" do 
+        expect(w.closed?).to be_truthy
+      end
+      it "double #close raises" do
+        expect do
+          w.close
+        end.to raise_error
+      end
+    end
+
+    describe "Writing" do
+      subject {|| VNCRec::Writers::FFmpeg.new("somefile.mp4", geometry: "300x300",pix_fmt: "bgr8") }
+      after(:each) {|| begin; subject.close; rescue ;end }
+      context "when closed" do
+        it "raises error" do
+          subject.close
+          expect{ || subject.write("somedata") }.to raise_error("No writer running")
+        end
+      end
+      it "creates exactly one file w/ exact name" do
+        subject.write("\x00"*(300*300*3))
+        expect(File.exists?("somefile.mp4")).to be_truthy
+      end
+    end
+  end
+
+end

data/vncrec.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vncrec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vncrec'
+  spec.version       = VNCRec::VERSION
+  spec.authors       = ['d-theus']
+  spec.email         = ['slma0x02@gmail.com']
+  spec.summary       = 'VNC session recording'
+  spec.description   = 'Connect to/receive reverse-connect
+  from VNC server and record session as raw video or any video
+  format FFmpeg supports'
+  spec.homepage      = ""
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.extensions = 'ext/enchex_c/extconf.rb'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'activesupport'
+
+  spec.requirements << 'ffmpeg'
+  spec.requirements << 'x11vnc'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: vncrec
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- d-theus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rake-compiler
+  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: rspec
+  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: rspec-its
+  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: activesupport
+  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: |-
+  Connect to/receive reverse-connect
+    from VNC server and record session as raw video or any video
+    format FFmpeg supports
+email:
+- slma0x02@gmail.com
+executables:
+- vncrec
+extensions:
+- ext/enchex_c/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/vncrec
+- examples/exit.rb
+- examples/mp4.rb
+- examples/mp4audio.rb
+- ext/enchex_c/ReadRect.c
+- ext/enchex_c/extconf.rb
+- lib/vncrec.rb
+- lib/vncrec/constants.rb
+- lib/vncrec/recorder.rb
+- lib/vncrec/rfb/enchex.rb
+- lib/vncrec/rfb/encraw.rb
+- lib/vncrec/rfb/enczrle.rb
+- lib/vncrec/rfb/proxy.rb
+- lib/vncrec/version.rb
+- lib/vncrec/writers.rb
+- spec/executable_spec.rb
+- spec/recorder_spec.rb
+- spec/spec_helper.rb
+- spec/writers_spec.rb
+- vncrec.gemspec
+homepage: ''
+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:
+- ffmpeg
+- x11vnc
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: VNC session recording
+test_files:
+- spec/executable_spec.rb
+- spec/recorder_spec.rb
+- spec/spec_helper.rb
+- spec/writers_spec.rb