kerryb-fakettp 0.1.2 → 0.2

data/README.html

@@ -47,7 +47,7 @@
   end
 </code></pre>
 <p>The label on the first line is used in error reporting.</p>
-<p>The expectation code has access to the underlying Sinatra/Rack stuff (this will be tidied up at some point), as well as <a href="http://rspec.info">RSpec</a> matchers.</p>
+<p>The expectation code has access to the underlying Sinatra request and response objects etc, as well as <a href="http://rspec.info">RSpec</a> matchers.</p>
 <h3>Verifying</h3>
 <p>To verify that all expectations have been met, make an <span class="caps">HTTP</span> <span class="caps">GET</span> request to <code>http://fakettp.local/verify</code>.</p>
 <p>If all is well, the response will be a <em>200 OK</em> with a body of &#8216;OK&#8217;. Otherwise the status will be <em>400 Bad Request</em>, with a list of failures in the body. The failure messages include the complete details of the unexpected request that was received, to assist debugging.</p>
@@ -55,6 +55,11 @@
 <p>To have FakeTTP respond to multiple hostnames, create the appropriate hosts entries. If you&#8217;re using name-based virtual hosts in Apache, add a <em>ServerAlias</em> entry to the virtual host config, under the <em>ServerName</em> line, eg:</p>
 <p><code>ServerAlias foo.com bar.com</code></p>
 <h2>Change log</h2>
+<p>0.2 (14 Mar 2009)</p>
+<ul>
+	<li>Complete rewrite, with tests and classes and stuff this time.</li>
+</ul>
+<p>If you get an &#8216;unexpected return&#8217; error, remove the return statement from your expectation, and just put the return value on the last line of the <em>expect</em> block.</p>
 <p>0.1.2 (13 Feb 2009)</p>
 <ul>
 	<li>Make sure <span class="caps">README</span>.html appears in generated gem</li>
@@ -69,10 +74,8 @@
 </ul>
 <h2>To Do</h2>
 <ul>
-	<li>Increase test coverage</li>
-	<li>Refactor to be OO rather than dumping everything in Kernel</li>
 	<li>Add examples</li>
-	<li>Only respond to control requests (reset/expect/verify) on main hostname only</li>
+	<li>Only respond to control requests (reset/expect/verify) on main hostname</li>
 	<li>Make control requests RESTful?</li>
 	<li>Make main hostname configurable?</li>
 	<li>Show label in verification error for expected requests that weren&#8217;t received</li>
@@ -80,4 +83,6 @@
 	<li>Allow more flexibility in request ordering</li>
 	<li>Allow user-specific helper files in installation dir</li>
 	<li>Check install/run behaviour when development dependencies are not installed</li>
+	<li>Provide Ruby <span class="caps">API</span> to set expectations etc</li>
+	<li>Return the expected content type even if expectation fails</li>
 </ul>

data/lib/fakettp.rb

@@ -1,30 +1,3 @@
-$:.unshift(File.dirname(__FILE__))
-
-require 'sinatra'
-require 'fakettp/helper'
-require 'fakettp/commands/fakettp_command'
-
-Sinatra::Default.set :run, false
-Sinatra::Default.set :environment, ENV['RACK_ENV']
-
-error do
-  request.env['sinatra.error'].inspect
-end
-
-post '/expect' do
-  set_expectation
-end
-
-post '/reset' do
-  reset_expectations
-end
-
-get '/verify' do
-  verify_expectations
-end
-
-[:get, :post, :put, :delete, :head].each do |method|
-  send method, '/**' do
-    run_expectation
-  end
-end
+$LOAD_PATH << File.dirname(__FILE__)
+require 'fakettp/controller'
+require 'fakettp/commands/fakettp_command'

data/lib/fakettp/commands/fakettp_command.rb

@@ -11,8 +11,9 @@ module Fakettp
         case command
         when 'install' then
           return install
+        else
+          return usage
         end
-        return 0
       end
   
       private

data/lib/fakettp/config.ru

@@ -3,4 +3,4 @@ require 'rubygems'
 FAKETTP_BASE = File.expand_path(File.dirname(__FILE__))
 require 'fakettp'
 
-run Sinatra.application
+run Sinatra::Application

data/lib/fakettp/controller.rb

@@ -0,0 +1,42 @@
+require 'sinatra'
+require 'spec'
+Sinatra::Default.set :run, false
+Sinatra::Default.set :environment, ENV['RACK_ENV']
+
+require 'fakettp/expectation_helper'
+require 'fakettp/simulator'
+require 'fakettp/expectation'
+
+include Fakettp::ExpectationHelper
+
+post '/expect' do
+  Fakettp::Simulator << request.body.read
+  content_type 'text/plain'
+  "Expect OK\n"
+end
+
+post '/reset' do
+  Fakettp::Simulator.reset
+  content_type 'text/plain'
+  "Reset OK\n"
+end
+
+get '/verify' do
+  content_type 'text/plain'
+  if Fakettp::Simulator.verify
+    "Verify OK\n"
+  else
+    throw :halt, [500, Fakettp::Simulator.list_errors]
+  end
+end
+
+[:get, :post, :put, :delete, :head].each do |method|
+  send method, '/**' do
+    begin
+      Fakettp::Simulator.handle_request binding
+    rescue Fakettp::Expectation::Error => e
+      content_type 'text/plain'
+      throw :halt, [500, "Simulator received mismatched request\n"]
+    end
+  end
+end

data/lib/fakettp/error.rb

@@ -0,0 +1,23 @@
+module Fakettp
+  class Error
+    ERROR_FILE = File.join FAKETTP_BASE, 'tmp', 'errors'
+    
+    def self.clear_all
+      FileUtils.rm_rf ERROR_FILE
+    end
+    
+    def self.<< message
+      File.open ERROR_FILE, 'a' do |f|
+        f.puts message
+      end
+    end
+    
+    def self.empty?
+      !File.exists? ERROR_FILE
+    end
+    
+    def self.list
+      empty? ? '' : File.read(ERROR_FILE)
+    end
+  end
+end

data/lib/fakettp/expectation.rb

@@ -0,0 +1,56 @@
+module Fakettp
+  class Expectation
+    class Error < Exception; end
+    
+    EXPECTATION_DIR = File.join FAKETTP_BASE, 'tmp', 'expectations'
+    
+    def initialize contents
+      @contents = contents
+    end
+    
+    def execute binding
+      eval @contents, binding
+      # TODO: Include context of expectation file
+    end
+    
+    def self.clear_all
+      FileUtils.rm_rf Dir.glob(File.join(EXPECTATION_DIR, '*'))
+    end
+    
+    def self.empty?
+      files.empty?
+    end
+    
+    def self.<< expectation
+      File.open next_file_to_create, 'w' do |f|
+        f.write expectation
+      end
+    end
+    
+    def self.next
+      file = next_file_to_read
+      contents = File.read file
+      FileUtils.rm file
+      Expectation.new contents
+    end
+    
+    private
+    
+    def self.next_file_to_create
+      name = (files.last.to_i + 1).to_s
+      File.join EXPECTATION_DIR, name
+    end
+    
+    def self.next_file_to_read
+      name = files.first
+      raise Error.new('Received unexpected request') unless name
+      File.join EXPECTATION_DIR, name
+    end
+    
+    def self.files
+      Dir.entries(EXPECTATION_DIR) - ['.', '..']
+    end
+  
+    private_class_method :next_file_to_create, :next_file_to_read, :files
+  end
+end

data/lib/fakettp/expectation_helper.rb

@@ -0,0 +1,13 @@
+require 'fakettp/expectation'
+
+module Fakettp
+  module ExpectationHelper
+    def expect label
+      begin
+        yield
+      rescue Exception => e
+        raise Fakettp::Expectation::Error.new("Error in #{label}: #{e.message}")
+      end
+    end
+  end
+end

data/lib/fakettp/simulator.rb

@@ -0,0 +1,33 @@
+require 'fakettp/expectation'
+require 'fakettp/error'
+
+module Fakettp
+  class Simulator    
+    def self.reset
+      Expectation.clear_all
+      Error.clear_all
+    end
+    
+    def self.verify
+      Error << 'Expected request not received' unless Expectation.empty?
+      Error.empty?
+    end
+    
+    def self.<< expectation
+      Expectation << expectation
+    end
+    
+    def self.handle_request binding
+      begin
+        Expectation.next.execute binding
+      rescue Fakettp::Expectation::Error => e
+        Error << e.message
+        raise e
+      end
+    end
+    
+    def self.list_errors
+      Error.list
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kerryb-fakettp
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: "0.2"
 platform: ruby
 authors: 
 - Kerry Buckley
@@ -9,20 +9,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-13 00:00:00 -08:00
+date: 2009-03-14 00:00:00 -07:00
 default_executable: fakettp
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.0
+        version: 0.9.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -30,8 +32,19 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.12
     version: 
+- !ruby/object:Gem::Dependency 
+  name: spicycode-rcov
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -41,6 +54,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: RedCloth
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -61,8 +75,11 @@ files:
 - lib/fakettp/commands
 - lib/fakettp/commands/fakettp_command.rb
 - lib/fakettp/config.ru
-- lib/fakettp/helper.rb
-- lib/fakettp/Rakefile.rb
+- lib/fakettp/controller.rb
+- lib/fakettp/error.rb
+- lib/fakettp/expectation.rb
+- lib/fakettp/expectation_helper.rb
+- lib/fakettp/simulator.rb
 - lib/fakettp.rb
 - bin/fakettp
 - README.html

data/lib/fakettp/Rakefile.rb

@@ -1,7 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'cucumber/rake/task'
-
-task :default => :features
-Cucumber::Rake::Task.new do |t|
-  t.cucumber_opts = "--format pretty"
-end

data/lib/fakettp/helper.rb

@@ -1,76 +0,0 @@
-require 'spec'
-include Spec::Matchers
-
-TMP_DIR = File.join FAKETTP_BASE, 'tmp'
-ERROR_FILE = File.join TMP_DIR, 'errors'
-EXPECTATION_DIR = File.join TMP_DIR, 'expectations'
-
-def expect label
-  begin
-    yield
-  rescue Exception => e
-    File.open(ERROR_FILE, 'a') do |f|
-      f.puts "\nError in #{label}: #{e.message}\n\nRequest: #{request.inspect}"
-    end
-    throw :halt, [500, "Simulator received mismatched request\n"]
-  end
-end
-
-# Note: client *must* send a Content-Type header of 'text/plain'. Probably.
-def set_expectation
-  content_type 'text/plain'
-  expectation = request.body.read
-  File.open(next_expectation_file, 'w') do |f|
-    f.write expectation
-  end
-  "Expect OK\n"
-end
-
-def run_expectation
-  content_type 'text/plain'
-  files = Dir.glob(EXPECTATION_DIR + '/*.rb').sort
-  if files.empty?
-    File.open(ERROR_FILE, 'a') do |f|
-      f.puts "\nReceived unexpected request: #{request.inspect}"
-    end
-    throw :halt, [500, "Simulator received unexpected request\n"]
-  end
-  expectation = File.read files.first
-  FileUtils.rm files.first
-  eval(expectation)
-end
-
-def reset_expectations
-  content_type 'text/plain'
-  FileUtils.rm_f(Dir.glob(EXPECTATION_DIR + '/*'))
-  File.open(ERROR_FILE, 'w') {|f|}
-  "Reset OK\n"
-end
-
-def verify_expectations
-  content_type 'text/plain'
-  check_for_non_received_requests
-  errors = File.read ERROR_FILE
-  throw :halt, [400, errors] unless errors.empty?
-  "Verify OK\n"
-end
-
-private
-
-def next_expectation_file
-  files = Dir.glob(EXPECTATION_DIR + '/*.rb').sort
-  if files.empty?
-    "#{EXPECTATION_DIR}/1.rb"
-  else
-    "#{EXPECTATION_DIR}/#{File.basename(files.last, '.rb').to_i + 1}.rb"
-  end
-end
-
-def check_for_non_received_requests
-  Dir.glob(EXPECTATION_DIR + '/*.rb').each do |f|
-    File.open(ERROR_FILE, 'a') do |f|
-      f.puts "\nExpected request not received."
-      # TODO: Grab label from expectation (redefine expect?)
-    end
-  end
-end