wire_tap 0.0.2 → 0.0.3

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.swp
 .rvmrc

data/lib/wire_tap/listener.rb

@@ -1,10 +1,34 @@
+require 'cgi'
+require 'wire_tap/parsers/request_parser'
 module WireTap
 	class Listener
+		attr_reader :transactions
 		def initialize app
 			@app = app	
+			@transactions = []
 		end
 		def call(env)
-			@app.call(env)		
+			response = @app.call(env)		
+			@transactions << parse_transaction(env, response)
+			response
+		end
+		def parse_request(request)
+			RequestParser.parse(request)
+		end
+		def parse_response(response)
+			status,headers,body = response
+			{
+				:status => status,
+				:content_type => headers["Content-Type"],
+				:body => body
+			}
+		end
+		def parse_transaction(env, response)
+			{
+				:method=>env["REQUEST_METHOD"],
+				:path=>env["PATH_INFO"],
+				:request => parse_request(env["rack.input"].read)	
+			}.merge(parse_response(response))
 		end
 	end
 end

data/lib/wire_tap/parsers/request_parser.rb

@@ -0,0 +1,19 @@
+require 'cgi'
+module WireTap
+	class RequestParser
+		class << self 
+			def parse request
+				clean(CGI.parse(request))
+			end
+			def clean kv_pairs
+				kv_pairs.reduce({}) do |result, kv|
+					key,value = kv
+					value = value.first if value.length <=1
+					result[key] = value
+					result
+				end
+				
+			end
+		end
+	end
+end

data/lib/wire_tap/version.rb

@@ -1,3 +1,3 @@
 module WireTap
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/sample_output.md

@@ -0,0 +1,50 @@
+Sample API documentation
+========================
+
+Todo: review content. layout probably unimportant at this stage.
+We will probably need one feature per API call. The feature description can provide the heading. Would probably need one scenario covering the 200 'happy' path and a scenario for each error code.
+
+I don't think we should document the authentication failures for every API call - maybe just for the authentication docs.
+
+
+Retrieving all child records 
+----------------------------
+
+* Path: /children/
+* Method: GET
+* Accept headers: application/json
+* Parameters:
+  * imei_number: Handset identifier
+* Status code: 200
+
+Sample response:
+
+```json
+[
+  {
+    "ID" : 1234,
+    "Location" : "UK"
+  }
+]
+```
+
+* Alternative status codes:
+ * 403: Not authenticated 
+ * 401: User account is blocked
+
+Updating a child record
+-----------------------
+
+* Path: /children/:id
+* Method: POST
+* Accept headers: application/json
+* Parameters:
+  * id : ID of the record to be updated
+* Return status code: 204
+
+Sample request:
+
+```
+location=UK
+has_siblings=TRUE
+```

data/spec/spec_helper.rb

@@ -1,10 +1,14 @@
 require 'rspec'
 require "factory_girl"
-require "factories" #wtf
+require 'rack/test'
 require 'wire_tap'
 
+Dir['./lib/**/*.rb'].map {|f| require f}
+Dir['./spec/support/**/*.rb'].map {|f| require f}
+
 class FakeRackApp
 	def call(env)
+		[200, {"Content-Type" => "text/plain"}, ["Hello world!"]]
 	end
 end
 

data/spec/support/basic_web_app.rb

@@ -0,0 +1,3 @@
+require 'sinatra/base'
+class BasicWebApp < Sinatra::Base
+end

data/spec/wire_tap/listener_spec.rb

@@ -1,9 +1,48 @@
+
 require 'spec_helper'
 describe WireTap::Listener do
-	it "should delegate to the wrapped application when we call" do
-		wrapped_app = stub()
-		wrapped_app.should_receive(:call).with(:env)
-		listener = WireTap::Listener.new wrapped_app
-		listener.call(:env)
+	context "saving request details" do
+		include Rack::Test::Methods
+		let(:app){
+			WireTap::Listener.new(wrapped_app)
+		}
+		context "for a get request" do
+			before(:each) do
+				get "/foo"
+			end
+			let(:wrapped_app){ 
+				class SinatraApp < BasicWebApp
+					get("/foo") { "Hello world"}
+				end
+			  SinatraApp.new
+			}
+			describe "the recorded transaction" do
+				subject {app.transactions.last}
+				its([:method]) { should == "GET"}
+				its([:path]) { should == "/foo"}
+				its([:request]) { should be_empty}
+				its([:status]) { should == 200}
+				its([:content_type]) { should match /^text\/html/}
+				its([:body]) { should==["Hello world"]}
+			end
+		end
+		context "for a post request" do
+			before(:each) do
+				post "/bar",{:id=>123, :name=>"bob"}
+			end
+			let(:wrapped_app) {
+				class SinatraApp < BasicWebApp
+					post("/bar") do
+						"#{params[:id]} : Hello, #{params[:name]}"
+					end
+				end
+				SinatraApp.new
+			}
+			describe "the recorded transaction" do
+				subject{app.transactions.last}
+				its([:method]){ should == "POST"}
+				its([:request]){ should == {"id"=>"123", "name"=>"bob"}}
+			end
+		end
 	end
 end

data/spec/wire_tap/parsers/request_parser_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+module WireTap
+	describe RequestParser do
+		subject {RequestParser.parse(request)}
+		context "parsing an empty request" do
+			let(:request) {""}
+			it { should be_empty}
+		end
+		context "parsing a request with two strings" do
+			let(:request) {"foo=bar&bob=bill"}
+			its(["foo"]){ should == "bar"}
+			its(["bob"]){ should == "bill"}
+		end
+		context "parsing a request with two values for the same key" do
+			let(:request) {"foo=bar&foo=bob"}
+			its(["foo"]){ should == ["bar", "bob"]}
+		end
+	end
+end

data/wire_tap.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "wire_tap"
   s.version     = WireTap::VERSION
   s.authors     = ["Jennifer Smith"]
-  s.email       = ["jennifer@home"]
+  s.email       = ["jensmith@thoughtworks.com"]
   s.homepage    = "https://github.com/jennifersmith/wire_tap"
   s.summary     = "Rack middleware that logs API calls made to a file for documentation"
   s.description = "Rack middleware that logs API calls made to a file for documentation. This gem is being developed for the RapidFTR project - www.rapidftr.com"
@@ -20,9 +20,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
 	s.add_runtime_dependency "rack"
-  # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "contracted"
+  
+	s.add_development_dependency "rspec"
+	s.add_development_dependency "rack-test"
 	s.add_development_dependency "factory_girl"
-  s.add_development_dependency "i18n"
-	# s.add_runtime_dependency "rest-client"
+	s.add_development_dependency "i18n"
+	s.add_development_dependency "sinatra"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wire_tap
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jennifer Smith
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-27 00:00:00 -05:00
+date: 2011-11-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: contracted
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -44,10 +44,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: factory_girl
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -61,7 +61,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: i18n
+  name: rack-test
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -74,9 +74,51 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: Rack middleware that logs API calls made to a file for documentation. This gem is being developed for the RapidFTR project - www.rapidftr.com
 email: 
-- jennifer@home
+- jensmith@thoughtworks.com
 executables: []
 
 extensions: []
@@ -90,10 +132,13 @@ files:
 - Rakefile
 - lib/wire_tap.rb
 - lib/wire_tap/listener.rb
+- lib/wire_tap/parsers/request_parser.rb
 - lib/wire_tap/version.rb
-- spec/factories.rb
+- sample_output.md
 - spec/spec_helper.rb
+- spec/support/basic_web_app.rb
 - spec/wire_tap/listener_spec.rb
+- spec/wire_tap/parsers/request_parser_spec.rb
 - spec/wire_tap_spec.rb
 - wire_tap.gemspec
 has_rdoc: true
@@ -131,7 +176,8 @@ signing_key:
 specification_version: 3
 summary: Rack middleware that logs API calls made to a file for documentation
 test_files: 
-- spec/factories.rb
 - spec/spec_helper.rb
+- spec/support/basic_web_app.rb
 - spec/wire_tap/listener_spec.rb
+- spec/wire_tap/parsers/request_parser_spec.rb
 - spec/wire_tap_spec.rb

data/spec/factories.rb

@@ -1,5 +0,0 @@
-FactoryGirl.define do
-	factory :rack_app do
-		foo :bar
-	end
-end