spectate 0.0.0

data/lib/spectate/encode.rb

@@ -0,0 +1,23 @@
+require 'cgi'
+
+module Spectate
+  # A convenience module to provide URI-safe versions of spectator names.  It essentially
+  # just uses URI::Escape on the strings, but with the additional conversion of spaces to
+  # underscores (and underscores to double underscores) because having lots of '%20' blobs
+  # in a URL is painful on the eyes. 
+  module Encode
+    # Makes a name URI-safe, with the minor cosmetic tweak of underscoring spaces.
+    def encode(name)
+      name.gsub!(/_/,'__')
+      name.tr!(' ','_')
+      CGI::escape(name)
+    end
+    
+    # Turns a URI-safe name generated by 'encode' back into a reasonable string.
+    def decode(name)
+      name.gsub!(/_(?!_)/,' ')
+      name.gsub!(/_ /,'_')
+      CGI::unescape(name)
+    end
+  end
+end

data/lib/spectate/ping.rb

@@ -0,0 +1,8 @@
+module Spectate
+  module Ping
+    def ping
+      c = Spectate::Client.new
+      c.get
+    end
+  end
+end

data/lib/spectate/server.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'sinatra/base'
+require 'rufus-tokyo'
+require 'json'
+
+module Spectate
+  class Server < Sinatra::Base
+    
+    def initialize
+      Spectate::Config.load_configuration
+      Rufus::Tokyo::Cabinet.open(File.join(Spectate::Config.basedir, 'spectate.tcb'), :opts => 'b') do |db|
+        nil
+      end
+      super
+    end
+    
+    get '/' do
+      {:summary => "Spectate v#{VERSION}"}.to_json
+    end
+  end
+end

data/lib/spectate/status.rb

@@ -0,0 +1,43 @@
+module Spectate
+  class Status
+    include Encode
+    attr_reader :server, :source
+    def initialize(server, source, properties = {})
+      @server, @source = server, source
+      @status = properties.inject({}) do |status, (key, value)|  # Shamelessly lifted from ActiveSupport
+        status[(key.to_sym rescue key) || key] = value
+        status
+      end
+    end
+    
+    # An array of all the properties contained in this Status object.
+    def properties
+      @status.keys
+    end
+    
+    # Returns the path of the spectator that owns this source. In practical 
+    # terms, this simply truncates to the next-to-last element on the path; so
+    # if the source is '/examples/foo/re_bar' the parent would be
+    # '/examples/foo'.
+    def parent
+      @source.slice %r{^/.*(?=/)}
+    end
+    
+    # The English representation of the name of the spectator belonging to this source.
+    def name
+      decode @source.slice(%r{/[^/]+$}).delete('/')  # Ruby 1.8 doesn't support lookbehind
+    end
+    
+    def [](key)
+      @status[key]
+    end
+      
+    def method_missing(method, *args, &block)
+      if @status.has_key?(method)
+        @status[method]
+      else
+        super
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,150 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spectate/client'
+
+describe Spectate::Client do
+  include Spectate::Spec::ServerHelpers
+  
+  before(:all) do
+    start_server
+  end
+  describe "configuration" do
+    it "loads configuration if it has to" do
+      Spectate::Config.clear!
+      Spectate::Config.expects(:load_configuration).returns(true)
+      @this = Spectate::Client.new
+    end
+  
+    it "doesn't reload the configuration if it doesn't have to" do
+      Spectate::Config.expects(:load_configuration).never
+      Spectate::Config.expects(:loaded?).returns(true)
+      @this = Spectate::Client.new
+    end
+    
+    it "knows its host" do
+      @this = Spectate::Client.new
+      @this.host.should == 'localhost'
+    end
+  
+    it "can override its host on creation" do
+      @this = Spectate::Client.new(:host => 'example.com')
+      @this.host.should == 'example.com'
+    end
+  
+    it "can override its host at any time" do
+      @this = Spectate::Client.new
+      @this.host = 'example.org'
+      @this.host.should == 'example.org'
+    end
+  
+    it "knows its port" do
+      @this = Spectate::Client.new
+      @this.port.should == 47502
+    end
+  
+    it "can override its port on creation" do
+      @this = Spectate::Client.new(:port => 8888)
+      @this.port.should == 8888
+    end
+  
+    it "can override its port at any time" do
+      @this = Spectate::Client.new
+      @this.port = 9999
+      @this.port.should == 9999
+    end
+
+    it "knows its protocol" do
+      @this = Spectate::Client.new
+      @this.protocol.should == 'http'
+    end
+  
+    it "can override its protocol on creation" do
+      @this = Spectate::Client.new(:protocol => 'https')
+      @this.protocol.should == 'https'
+    end
+  
+    it "can override its protocol at any time" do
+      @this = Spectate::Client.new
+      @this.protocol = 'ftp'
+      @this.protocol.should == 'ftp'
+    end
+
+    it "defaults to accepting JSON" do
+      @this = Spectate::Client.new
+      @this.accept.should == 'application/json'
+    end
+
+    it "can override its accept on creation" do
+      @this = Spectate::Client.new(:accept => 'text/html')
+      @this.accept.should == 'text/html'
+    end
+
+    it "can override its accept at any time" do
+      @this = Spectate::Client.new
+      @this.accept = 'application/xml'
+      @this.accept.should == 'application/xml'
+    end
+    
+    it "knows its root with a port" do
+      @this = Spectate::Client.new(:protocol => 'https', :host => 'example.org', :port => 777)
+      @this.root.should == 'https://example.org:777'
+    end
+    
+    it "knows its root without a port or protocol" do
+      @this = Spectate::Client.new(:host => '10.0.1.5', :port => 0)
+      @this.root.should == 'http://10.0.1.5'
+    end
+    
+  end
+  
+  shared_examples_for "a Rest-Client proxy method" do
+    STATUS_JSON = '{"uptime":"23h 14m 11s","summary":"Spectate v0.0.0.0"}'
+    before(:each) do
+      method = @method
+      @dummy = stub('Rest Client') do
+        stubs(method).returns(STATUS_JSON)
+        stubs(:[]).returns(@dummy)
+      end
+      @this.instance_variable_set(:@driver, @dummy)
+    end
+    it "calls the method in the RestClient resource" do
+      @dummy.expects(@method).returns(STATUS_JSON)
+      @this.send(@method).should_not be_nil
+    end
+    it "parses the result when accepting JSON" do
+      @this.send(@method).should be_a_kind_of(Spectate::Status)
+    end
+    it "includes the appropriate fields" do
+      s = @this.send(@method)
+      s[:summary].should =~ /Spectate/
+    end
+    it "returns nil on a Resource Not Found error" do
+      @dummy.expects(@method).raises(RestClient::ResourceNotFound)
+      @this.send(@method).should be_nil
+    end
+    it "returns nil on a Connection Refused error" do
+      @dummy.expects(@method).raises(Errno::ECONNREFUSED)
+      @this.send(@method).should be_nil
+    end
+    it "raises any other exception" do
+      @dummy.expects(@method).raises(RestClient::RequestFailed)
+      lambda{@this.send(@method)}.should raise_error(RestClient::RequestFailed)
+    end
+  end
+  
+  describe 'calling method' do
+    before(:each) do
+      @this = Spectate::Client.new
+    end
+    
+    describe "get" do
+      before(:each) do
+        @method = :get
+      end
+      it_should_behave_like "a Rest-Client proxy method"
+    end
+  end
+  
+  after(:all) do
+    stop_server
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Command 'spectate'" do
+  include Spectate::Spec::ConfigHelpers
+  
+  before(:all) do
+    create_config
+  end
+  
+  it "gets its base directory from the SPECTATE_DIR environment variable if specified" do
+    unmade_dir = File.expand_path("~/blahhhhh")
+    ENV['SPECTATE_DIR'] = unmade_dir
+    `spectate`.should =~ /Directory #{Regexp.escape(unmade_dir)} not found!/
+    ENV['SPECTATE_DIR'] = @tempdir
+  end
+  
+  it "executes" do
+    `spectate --help`.should =~ /Spectate/i
+  end
+  
+  # We have several options for displaying help
+  %w{-h -? --help --usage}.each do |option|
+    it "displays its usage when called with #{option}" do
+      `spectate #{option}`.should =~ /Usage:/
+    end
+    
+    it "does not attempt to start the server if called with #{option}" do
+      `spectate #{option}`.should_not =~ /Starting Spectate/
+    end 
+    
+  end
+  
+  it "displays its usage when given parameters it doesn't understand" do
+    `spectate --blah1234`.should =~ /invalid option: --blah1234.*Usage:/m
+  end
+  
+  
+  %w{-d --directory}.each do |option|
+    it "requires a directory parameter" do
+      `spectate #{option}`.should =~ /missing argument: #{option}.*Usage:/m
+    end
+    
+    it "sets a different base directory when called with #{option} dirname" do
+      tmpdir = Dir.mktmpdir
+      `spectate #{option} #{tmpdir}`.should =~ /Directory set to #{Regexp.escape(tmpdir)}/
+      # Ensure cleanup
+      FileUtils.rm_r tmpdir, :force => true, :secure => true
+    end
+  end
+
+  describe "starting" do
+    it "attempts to start Spectate if not already running" do
+      `spectate`.should =~ /Starting Spectate/
+    end
+    it "complains if Spectate is already running" do
+      `spectate`
+      `spectate`.should =~ /already running/
+    end
+    
+    it "creates a PID file in the base directory" do
+      `spectate`
+      File.exists?(File.join(@tempdir,'spectate.pid')).should be_true
+    end
+    after(:each) do
+      `spectate --stop`
+    end
+  end
+  
+  describe "--stop" do
+    before(:each) do
+      `spectate`
+    end
+    it "stops the server" do
+      `spectate --stop`.should =~ /stopped./
+    end
+    it "complains if the server wasn't running" do
+      `spectate --stop`
+      `spectate --stop`.should =~ /wasn't running!/
+    end
+  end
+  
+  
+  after(:all) do
+    remove_config
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,247 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Configuration" do
+  describe "version" do
+    it "is a proper major.minor.build number" do
+      Spectate::VERSION.should =~ /\d+\.\d+\.\d+/
+    end
+  end
+  
+  describe "variables" do
+    it "can be set" do
+      Spectate::Config['foo'] = 'bar'
+      Spectate::Config['foo'].should == 'bar'
+      Spectate::Config.delete('foo')
+    end
+    
+    it "can be displayed as a hash" do
+      Spectate::Config['bar'] = 'foo'
+      hash = Spectate::Config.to_hash
+      hash['bar'].should == 'foo'
+      Spectate::Config.delete('bar')
+    end
+    
+    it "can be deleted" do
+      Spectate::Config['foo'] = 'bar'
+      Spectate::Config.delete('foo')
+      Spectate::Config.to_hash.should_not have_key('foo')
+    end
+    
+    it "can be cleared" do
+      Spectate::Config['something'] = 'something else'
+      Spectate::Config.clear!
+      Spectate::Config.to_hash.size.should == 0
+    end
+  end
+  
+  describe "defaults" do
+    before(:each) do
+      @defhash = {'aloha' => 'hello'}
+    end
+    
+    it "will merge in if they don't exist" do
+      Spectate::Config.default(@defhash)
+      Spectate::Config['aloha'].should == 'hello'
+    end
+    
+    it "will not merge in if they do exist" do
+      Spectate::Config['aloha'] = "goodbye"
+      Spectate::Config.default(@defhash)
+      Spectate::Config['aloha'].should == 'goodbye'
+    end
+    
+    after(:each) do
+      Spectate::Config.delete('aloha')
+    end
+  end
+  
+  describe "file setup" do
+    include Spectate::Spec::ConfigHelpers
+    
+    # We don't want to mess up anyone's actual configuration
+    before(:all) do
+      set_tempdir # Sets @tempparent, @tempdir, @configfile
+    end
+
+    describe "without a .spectate directory" do
+      before(:each) do
+        FileUtils.rm_r @tempdir, :force => true, :secure => true
+      end
+      
+      it "tells the user to run spectate --setup" do
+        `spectate -d #{@tempdir}`.should =~ /Directory #{Regexp.escape(@tempdir)} not found!\nRun spectate --setup to initialize things\./m
+      end
+    end
+
+    describe "without a config.yml file" do
+      before(:each) do
+        FileUtils.mkdir @tempdir
+        File.delete(@configfile) if File.exists?(@configfile)
+      end
+      
+      it "tells the user to run spectate --setup" do
+        `spectate -d #{@tempdir}`.should =~ /File #{Regexp.escape(@tempdir)}\/config\.yml not found!\nRun spectate --setup to initialize things\./m
+      end
+    end
+    
+    
+    shared_examples_for "a valid setup option" do
+      it "complains if config.yml already exists" do
+        FileUtils.mkdir @tempdir
+        FileUtils.touch @configfile
+        `spectate -d #{@tempdir} --setup #{@option}`.should =~ /You already have a config\.yml file!  We don't want to mess with a good thing\.\nIf you really want to start over, delete #{Regexp.escape(@tempdir)}\/config\.yml and run spectate --setup again\./m
+        
+      end
+      
+      it "tells the user a config.yml file is being made" do
+        `spectate -d #{@tempdir}  --setup #{@option}`.should =~ /Creating config.yml file/
+      end
+
+      it "creates the file" do
+        `spectate -d #{@tempdir}  --setup #{@option}`
+        File.exists?(@configfile).should be_true
+      end
+      
+      it "writes the server value to the file" do
+        `spectate -d #{@tempdir} --setup #{@option}`
+        File.read(@configfile).should =~ /server: #{@option}/
+      end
+      
+      it "writes the host if given" do
+        `spectate -d #{@tempdir} -h foo.bar.local --setup #{@option}`
+        File.read(@configfile).should =~ /host: foo\.bar\.local/
+      end
+      
+      it "writes the port if given" do
+        `spectate -d #{@tempdir} -p 55555 --setup #{@option}`
+        File.read(@configfile).should =~ /port: 55555/
+      end
+      
+      it "creates a rackup file" do
+        `spectate -d #{@tempdir} --setup #{@option}`
+        File.read(File.join(@tempdir,'config.ru')).should =~ /run Spectate::Server/
+      end
+    end
+    
+    describe "with spectate --setup" do
+      
+      describe "(no parameters)" do
+        it "tells the user to specify a parameter" do
+          `spectate -d #{@tempdir} --setup`.should =~ /missing argument/
+        end
+      end
+      
+      describe "passenger" do
+        before(:each) do
+          @option = "passenger"
+        end
+        it_should_behave_like "a valid setup option"
+        
+        it "sets rackup to false" do
+          `spectate -d #{@tempdir} --setup #{@option}`
+          File.read(@configfile).should =~ /rackup: false/
+        end
+        
+        it "doesn't set a port" do
+          `spectate -d #{@tempdir} --setup #{@option}`
+          File.read(@configfile).should_not =~ /port/
+        end
+        
+        it "defaults the host to spectate.local" do
+          `spectate -d #{@tempdir} --setup #{@option}`
+          File.read(@configfile).should =~ /host: spectate\.local/
+        end
+      end
+
+      %w[thin webrick mongrel].each do |server|
+        describe "#{server}" do
+          before(:each) do
+            @option = "#{server}"
+          end
+
+          it_should_behave_like "a valid setup option"
+
+          it "sets rackup to true" do
+            `spectate -d #{@tempdir} --setup #{@option}`
+            File.read(@configfile).should =~ /rackup: true/
+          end
+
+          it "sets the port to the default of 20574" do
+            `spectate -d #{@tempdir} --setup #{@option}`
+            File.read(@configfile).should =~ /port: 20574/
+          end
+
+          it "defaults the host to localhost" do
+            `spectate -d #{@tempdir} --setup #{@option}`
+            File.read(@configfile).should =~ /host: localhost/
+          end
+        end
+      end
+      after(:each) do
+        FileUtils.rm_r @tempdir, :force => true, :secure => true
+      end
+    end
+
+    
+    after(:all) do
+      FileUtils.rm_r @tempparent, :force => true, :secure => true
+    end
+  end
+  
+  describe "loading" do
+    include Spectate::Spec::ConfigHelpers
+    before(:each) do
+      Spectate::Config.clear!
+      create_config
+      ENV["SPECTATE_DIR"] = nil
+    end
+    
+    it "gets its values from the environment variable if set" do
+      ENV["SPECTATE_DIR"] = @tempdir
+      Spectate::Config.load_configuration
+      Spectate::Config['port'].should == 47502
+    end
+    
+    it "gets its values from the method parameter if given" do
+      Spectate::Config.load_configuration(@tempdir)
+      Spectate::Config['port'].should == 47502
+    end
+    
+    it "gets its values from Spectate::Config['basedir'] if given" do
+      Spectate::Config['basedir'] = @tempdir
+      Spectate::Config.load_configuration
+      Spectate::Config['port'].should == 47502
+    end
+    
+    it "gets its values from ROOT_DIR as a last resort" do
+      Spectate.send(:remove_const, :ROOT_DIR)  # To suppress warnings
+      Spectate.const_set(:ROOT_DIR,@tempdir)
+      Spectate::Config.load_configuration
+      Spectate::Config['port'].should == 47502
+      Spectate.send(:remove_const, :ROOT_DIR)  # To suppress warnings
+      Spectate.const_set(:ROOT_DIR,nil)
+    end
+    
+    it "complains if no base directory can be found" do
+      lambda{Spectate::Config.load_configuration}.should raise_error(RuntimeError, /could not find/i)
+    end
+    
+    it "knows when it hasn't been loaded yet" do
+      Spectate::Config.loaded?.should be_false
+    end
+    
+    it "knows when it has been loaded" do
+      Spectate::Config.load_configuration(@tempdir)
+      Spectate::Config.loaded?.should be_true
+    end
+    
+    it "knows its basedir" do
+      Spectate::Config.load_configuration(@tempdir)
+      Spectate::Config.basedir.should == @tempdir
+    end
+      
+    after(:each) do
+      remove_config
+    end
+  end
+end