vnctools 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in vnctools.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2011] [Jari Bakken]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+

data/lib/vnctools/recorder.rb

@@ -0,0 +1,37 @@
+module VncTools
+  class Recorder
+
+    attr_reader :display, :output
+
+    def initialize(display, output, opts = {})
+      @display = display
+      @output  = output
+      @options = opts
+    end
+
+    def start
+      @process = ChildProcess.build(
+        "ffmpeg",
+        "-an",                                      # no audio,
+        "-f", "x11grab",                            # force format
+        "-y",                                       # overwrite output files
+        "-r", @options[:frame_rate] || "5",         # frame rate
+        "-s", @options[:frame_size] || "1024x768",  # frame size
+        "-i", "#{display}.0+0,0",                   # display :1
+        "-vcodec", @options[:codec] || "mpeg4",     # video codec
+        "-sameq", output            # output
+      )
+
+      @process.io.inherit! if $DEBUG
+      @process.start
+
+      if @process.crashed?
+        raise Error, "ffmpeg failed, run with $DEBUG = true for full output"
+      end
+    end
+
+    def stop
+      @process && @process.stop
+    end
+  end
+end

data/lib/vnctools/server.rb

@@ -0,0 +1,68 @@
+require "socket"
+
+module VncTools
+  class Server
+
+    class Error < StandardError
+    end
+
+    class << self
+      def displays
+        Dir[File.expand_path("~/.vnc/*.pid")].map { |e| e[/(\d+)\.pid/, 1] }.compact
+      end
+
+      def all
+        displays.map { |display| new ":#{display}" }
+      end
+
+      attr_writer :executable
+
+      def executable
+        @executable ||= "tightvncserver"
+      end
+    end
+
+    attr_reader :display
+
+    def initialize(display = nil)
+      @display = display
+    end
+
+    def start
+      if display
+        server display
+      else
+        output = server
+        @display = output[/desktop is #{host}(\S+)/, 1]
+      end
+    end
+
+    def stop
+      server "-kill", display.to_s
+    end
+
+    private
+
+    def server(*args)
+      cmd = [self.class.executable, args, '2>&1'].flatten.compact
+      out = `#{cmd.join ' '}`
+
+      unless last_status.success?
+        raise Error, "could not run #{self.class.executable}: #{out.inspect}"
+      end
+
+      out
+    end
+
+    def last_status
+      $?
+    end
+
+    def host
+      @host ||= Socket.gethostname
+    end
+  end # VncServer
+end # CukeForker
+
+
+

data/lib/vnctools/server_pool.rb

@@ -0,0 +1,68 @@
+module VncTools
+  class ServerPool
+    include Observable
+
+    def initialize(capacity, klass = Server)
+      @capacity = capacity
+      @servers  = Array.new(capacity) { klass.new }
+      @running  = []
+    end
+
+    def stop
+      running.each do |s|
+        fire :on_display_stopping, s
+        s.stop
+      end
+    end
+
+    def size
+      @servers.size
+    end
+
+    def get
+      raise OutOfDisplaysError if @servers.empty?
+
+      server = next_server
+      fire :on_display_fetched, server
+
+      server
+    end
+
+    def release(server)
+      raise TooManyDisplaysError if size == @capacity
+      fire :on_display_released, server
+
+      @servers.unshift server
+    end
+
+    private
+
+    def fire(*args)
+      changed
+      notify_observers(*args)
+    end
+
+    def running
+      @running
+    end
+
+    def next_server
+      server = @servers.shift
+
+      if server.display.nil?
+        fire :on_display_starting, server
+        server.start
+        @running << server
+      end
+
+      server
+    end
+
+    class TooManyDisplaysError < StandardError
+    end
+
+    class OutOfDisplaysError < StandardError
+    end
+
+  end # DisplayPool
+end # CukeForker

data/lib/vnctools/version.rb

@@ -0,0 +1,3 @@
+module VncTools
+  VERSION = "0.0.1"
+end

data/lib/vnctools.rb

@@ -0,0 +1,11 @@
+module Vnctools
+  # Your code goes here...
+end
+
+require 'observer'
+require 'childprocess'
+require 'vnctools/version'
+require 'vnctools/server'
+require 'vnctools/server_pool'
+require 'vnctools/recorder'
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+if ENV['COVERAGE']
+  raise "simplecov only works on 1.9" unless RUBY_PLATFORM >= "1.9"
+  require 'simplecov'
+  SimpleCov.start {
+    add_filter "spec/"
+  }
+end
+
+
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'vnctools'

data/spec/vnctools/recorder_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module VncTools
+  describe Recorder do
+    context "given a display string" do
+      let(:process)  { mock(ChildProcess, :crashed? => false, :start => nil, :stop => nil) }
+      let(:recorder) { Recorder.new ":1", "out.mp4"  }
+
+      it "knows its display" do
+        recorder.display.should == ":1"
+      end
+
+      it "knows its output" do
+        recorder.output.should == "out.mp4"
+      end
+
+      it "starts and stops recording on the given display" do
+        ChildProcess.should_receive(:build).with(
+          "ffmpeg",
+          "-an",               # no audio,
+          "-f", "x11grab",     # force format
+          "-y",                # overwrite output files
+          "-r", "5",           # frame rate
+          "-s", "1024x768",    # size
+          "-i", ":1.0+0,0",    # display :1
+          "-vcodec", "mpeg4",  # default encoding
+          "-sameq", "out.mp4"  # output
+        ).and_return process
+
+        process.should_receive(:start)
+        recorder.start
+
+        process.should_receive(:stop)
+        recorder.stop
+      end
+
+      it "raises an error if the process crashed" do
+        ChildProcess.stub :build => mock(:start => nil, :crashed? => true)
+
+        lambda { recorder.start }.should raise_error
+      end
+    end
+  end # Recorder
+end # VncTools

data/spec/vnctools/server_pool_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module VncTools
+  describe ServerPool do
+    let(:server) { mock(Server, :start => nil, :stop => nil) }
+    let(:fake_server_class) { mock(:new => server)}
+    let(:pool)  { ServerPool.new(3, fake_server_class) }
+
+    it "creates 3 instances of the given display class" do
+      fake_server_class.should_receive(:new).exactly(3).times
+
+      pool = ServerPool.new(3, fake_server_class)
+      pool.size.should == 3
+    end
+
+    it "can fetch a server from the pool" do
+      pool.get.should == server
+      pool.size.should == 2
+    end
+
+    it "can release a server" do
+      obj = pool.get
+      pool.size.should == 2
+
+      pool.release obj
+    end
+
+    it "can stop the pool" do
+      pool.stub(:running => [server])
+      server.should_receive(:stop)
+
+      pool.stop
+    end
+
+    it "raises a TooManyDisplaysError if the pool is over capacity" do
+      lambda { pool.release "foo" }.should raise_error(ServerPool::TooManyDisplaysError)
+    end
+
+    it "raises a OutOfDisplaysError if the pool is empty" do
+      3.times { pool.get }
+      lambda { pool.get }.should raise_error(ServerPool::OutOfDisplaysError)
+    end
+
+    it "notifies observers" do
+      observer = mock(Observable)
+
+      observer.should_receive(:update).with :on_display_starting, server
+      observer.should_receive(:update).with :on_display_fetched , server
+      observer.should_receive(:update).with :on_display_released, server
+      observer.should_receive(:update).with :on_display_stopping , server
+
+      pool.add_observer observer
+
+      pool.release pool.get
+      pool.stop
+    end
+
+  end # ServerPool
+end # VncTools

data/spec/vnctools/server_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module VncTools
+  describe Server do
+    context "managing new displays" do
+      let(:server) { Server.new }
+      before { server.stub :last_status => mock(:success? => true) }
+
+      it "starts a new server" do
+        server.should_receive(:`).with("tightvncserver 2>&1").and_return("desktop is #{Socket.gethostname}:1")
+        server.start
+        server.display.should == ":1"
+      end
+
+      it "stops the server" do
+        server.should_receive(:`).with("tightvncserver -kill :5 2>&1")
+        server.stub :display => ":5"
+        server.stop
+      end
+
+      it "raises Server::Error if the server could not be started" do
+        server.should_receive(:`).and_return("oops")
+        server.stub :last_status => mock(:success? => false)
+
+        lambda { server.start }.should raise_error(Server::Error, /oops/)
+      end
+    end
+
+    context "controlling an existing display" do
+      let(:server) { Server.new ":5" }
+      before { server.stub :last_status => mock(:success? => true) }
+
+      it "starts the server on the given display" do
+        server.should_receive(:`).with("tightvncserver :5 2>&1").and_return("desktop is #{Socket.gethostname}:5")
+        server.start
+        server.display.should == ":5"
+      end
+    end
+
+    it "returns an instance for all existing displays" do
+      Dir.stub(:[]).and_return [".vnc/qa1:1.pid", ".vnc/qa1:2.pid", ".vnc/qa1:3.pid"]
+
+      all = Server.all
+      all.size.should == 3
+      all.map { |e| e.display }.should == [":1", ":2", ":3"]
+    end
+
+  end # Server
+end # VncTools

data/vnctools.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "vnctools/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vnctools"
+  s.version     = VncTools::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jari Bakken"]
+  s.email       = ["jari.bakken@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple CLI wrappers to control and record VNC displays from Ruby.}
+  s.description = %q{Simple CLI wrappers to control and record VNC displays from Ruby.}
+
+  s.rubyforge_project = "vnctools"
+
+  s.add_dependency "childprocess"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "rspec", "~> 2.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: vnctools
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jari Bakken
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: childprocess
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id003
+description: Simple CLI wrappers to control and record VNC displays from Ruby.
+email: 
+- jari.bakken@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- lib/vnctools.rb
+- lib/vnctools/recorder.rb
+- lib/vnctools/server.rb
+- lib/vnctools/server_pool.rb
+- lib/vnctools/version.rb
+- spec/spec_helper.rb
+- spec/vnctools/recorder_spec.rb
+- spec/vnctools/server_pool_spec.rb
+- spec/vnctools/server_spec.rb
+- vnctools.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: vnctools
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Simple CLI wrappers to control and record VNC displays from Ruby.
+test_files: 
+- spec/spec_helper.rb
+- spec/vnctools/recorder_spec.rb
+- spec/vnctools/server_pool_spec.rb
+- spec/vnctools/server_spec.rb