webspeak 0.0.1

data/spec/http_dialect_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe WebSpeak::HTTP::Dialect do
+
+  before(:each) do
+    @interpreter = WebSpeak::HTTP::Base.new
+    @request = mock(:request)
+    WebSpeak::Request.should_receive(:new).any_number_of_times.and_return(@request)
+  end
+
+  def check_common_parameter_based_spec_with_hash_passed(function_name)
+    check_common_parameter_based_spec(function_name, " => ")
+  end
+    
+  def check_common_parameter_based_spec_with_list_passed(function_name)
+    check_common_parameter_based_spec(function_name, ", ")
+  end
+    
+  def check_common_parameter_based_spec(function_name, param_join)
+    hash = {}
+    @request.should_receive("#{function_name.to_s}s").and_return(hash)
+    @interpreter.instance_eval("#{function_name} 'param_name'#{param_join}'param_value'")
+    hash['param_name'].should eql("param_value")
+  end
+
+  it "should set header values with hash style call" do
+    check_common_parameter_based_spec_with_hash_passed(:header)
+  end
+  
+  it "should set header values with list style call" do
+    check_common_parameter_based_spec_with_list_passed(:header)
+  end
+  
+  it "should set query params with hash style call" do
+    check_common_parameter_based_spec_with_hash_passed(:query_param)
+  end
+
+  it "should set query params with list style call" do
+    check_common_parameter_based_spec_with_list_passed(:query_param)
+  end
+
+  it "should set params with hash style call" do
+    check_common_parameter_based_spec_with_hash_passed(:param)
+  end
+
+  it "should set params with list style call" do
+    check_common_parameter_based_spec_with_list_passed(:param)
+  end
+  
+  it "should set cookies with hash style call" do
+    check_common_parameter_based_spec_with_hash_passed(:cookie)
+  end
+
+  it "should set cookies with list style call" do
+    check_common_parameter_based_spec_with_list_passed(:cookie)
+  end
+  
+  it "should set host in request" do
+    @request.should_receive(:host=).with("test.com")
+    @interpreter.host "test.com"
+  end
+  
+  it "should set port in request" do
+    @request.should_receive(:port=).with(83)
+    @interpreter.port 83
+  end
+  
+  it "should set path in request" do
+    @request.should_receive(:path=).with("/test/path")
+    @interpreter.path "/test/path"
+  end
+  
+  it "should report an error with invalid call" do
+    lambda {@interpreter.header "foo"}.should raise_error()
+  end
+  
+  it "should do a POST with post" do
+    @request.should_receive(:post).once.with(no_args)
+    @interpreter.post
+  end
+  
+  it "should do a GET with a get" do 
+    @request.should_receive(:get).once.with(no_args)
+    @interpreter.get
+  end
+  
+  it "should return a ResponseAccessor with response" do
+    @request.should_receive(:response).once.with(no_args).and_return(nil)
+    ra = @interpreter.response
+    ra.should be_instance_of(WebSpeak::ResponseAccessor)
+  end
+  
+end

data/spec/http_listener_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require 'logger'
+
+describe WebSpeak::HTTPListener do
+  
+  before do
+    @server = mock(:server)
+    @server.should_receive(:start)
+    @real_stdout = $stdout
+    $stdout = StringIO.new
+  end
+  
+  after do
+    $stdout = @real_stdout
+  end
+  
+  it "should listen on correct default port" do
+    WEBrick::HTTPServer.should_receive(:new) do |opts|
+      opts[:Port].should eql(8080)
+      @server
+    end
+    @server.should_receive(:mount)
+    listener = WebSpeak::HTTPListener.new
+    listener.listen
+  end
+  
+  it "should listen on configurable port" do
+    WEBrick::HTTPServer.should_receive(:new) do |opts|
+      opts[:Port].should eql(80)
+      @server
+    end
+    @server.should_receive(:mount)
+    listener = WebSpeak::HTTPListener.new(80)
+    listener.listen
+  end
+  
+  it "should listen on '/' with a ParseRequestServlet" do
+    WEBrick::HTTPServer.should_receive(:new).and_return(@server)
+    @server.should_receive(:mount).with('/', WebSpeak::ParseRequestServlet)
+    listener = WebSpeak::HTTPListener.new
+    listener.listen
+  end
+  
+end
+

data/spec/parse_request_servlet_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require 'logger'
+  
+def setup_generic_request_response_mocks
+  @request = mock(:request)
+  @request.should_receive(:path).and_return('/')
+  @request.should_receive(:request_uri).at_least(:once).and_return(URI::parse("http://foo.com/?query_param=query_param_value"))
+  @request.should_receive(:header).and_return({
+      'header' => 'value', 'repeated_header' => ['value_1', 'value_2']})
+  @request.should_receive(:query).and_return({'param_name' => 'param_value'})
+  @request.should_receive(:cookies).and_return([mock_cookie('cookie_name', 'cookie_value')])
+
+  @response = mock(:response)
+  @response.should_receive(:body=) {|body| @body = body}
+end
+
+describe "WebSpeak::ParseRequestServlet POSTing a standard request" do
+  
+  before do
+    setup_generic_request_response_mocks
+    @server = mock(:server, :null_object => true)
+    @servlet = WebSpeak::ParseRequestServlet.new(@server)
+  end
+  
+  it "should parse query params" do
+    @servlet.do_POST(@request, @response)
+    @body.should include("query_param 'query_param' => 'query_param_value'")
+  end
+  
+  it "should parse headers" do 
+    @servlet.do_POST(@request, @response)
+    @body.should include("header 'header' => 'value'")
+    @body.should include("header 'repeated_header' => 'value_1'")
+    @body.should include("header 'repeated_header' => 'value_2'")
+  end
+  
+  it "should parse params" do
+    @servlet.do_POST(@request, @response)
+    @body.should include("param 'param_name' => 'param_value'")
+  end
+  
+  it "should parse cookies" do
+    @servlet.do_POST(@request, @response)
+    @body.should include("cookie 'cookie_name' => 'cookie_value'")
+  end
+    
+  it "should post the request" do
+    @servlet.do_POST(@request, @response)
+    @body.should include("post\n")
+  end
+  
+end
+
+describe WebSpeak::ParseRequestServlet do
+  # firefox likes to ask for the favicon.ico, so...
+  it "should ignore requests for favicon.ico" do
+    @request = mock(:request)
+    @request.should_receive(:path).and_return('/favicon.ico')
+    @response = mock(:response)
+    @server = mock(:server, :null_object => true)
+    @servlet = WebSpeak::ParseRequestServlet.new(@server)
+    @servlet.do_POST(@request, @response)
+  end
+  
+  it "should ignore requests for favicon.ico" do
+    setup_generic_request_response_mocks
+    @server = mock(:server)
+    @server.should_receive(:shutdown)
+    null_mock = mock(:null_mock, :null => true)
+    @server.should_receive(:[]).and_return(null_mock)
+    @servlet = WebSpeak::ParseRequestServlet.new(@server)
+    @servlet.do_POST(@request, @response)
+  end
+  
+end

data/spec/request_spec.rb

@@ -0,0 +1,127 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.rubyforge.org/
+describe "Initial creation of ", WebSpeak::Request do
+
+  before :each do 
+    @request = WebSpeak::Request.new
+  end
+  
+  it "should not have any cookies" do
+    @request.cookies.should be_empty
+  end
+  
+  it "should not have any headers" do
+    @request.headers.should be_empty
+  end
+  
+  it "should not have any params" do
+    @request.params.should be_empty
+  end
+  
+  it "should not have any query_params" do
+    @request.query_params.should be_empty
+  end
+   
+  it "should have appropriate default connection values" do
+    @request.host.should eql("localhost")
+    @request.port.should eql(80)
+    @request.path.should eql("/")
+  end
+    
+end
+
+describe "Posting a ", WebSpeak::Request do
+  
+  before :each do 
+    @request = WebSpeak::Request.new
+    @mock_http = mock(:http)
+  end
+  
+  it "should post properly" do
+    @mock_http.should_receive(:post).with('/', '', {}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('localhost', 80).and_yield(@mock_http)
+    @request.post
+    @request.response.should eql(:response)
+  end
+   
+  it "should post to different host information" do
+    @request.host = 'foo.bar'
+    @request.port = 1234
+    @request.path = '/other/path'
+    @mock_http.should_receive(:post).with('/other/path', '', {}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('foo.bar', 1234).and_yield(@mock_http)
+    @request.post
+  end
+  
+  it "should contain headers when provided" do
+    @request.headers['header_name'] = 'header_value'
+    @mock_http.should_receive(:post).with('/', '', {'header_name' => 'header_value'}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('localhost', 80).and_yield(@mock_http)
+    @request.post
+  end
+    
+  it "should contain cookies when provided" do
+    @request.cookies['cookie_name'] = 'cookie_value'
+    @mock_http.should_receive(:post).with('/', '', {'Cookie' => 'cookie_name=cookie_value; '}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('localhost', 80).and_yield(@mock_http)
+    @request.post
+  end
+  
+  it "should contain query_params in the url when provided" do
+    @request.query_params['param_name'] = 'param_value'
+    @mock_http.should_receive(:post).with('/?param_name=param_value', '', {}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('localhost', 80).and_yield(@mock_http)
+    @request.post
+  end
+  
+  it "should contain params in the body when provided" do
+    @request.params['param_name'] = 'param_value'
+    @mock_http.should_receive(:post).with('/', 'param_name=param_value', {}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('localhost', 80).and_yield(@mock_http)
+    @request.post
+  end
+    
+end
+
+
+describe "GETing a ", WebSpeak::Request do
+  before :each do 
+    @request = WebSpeak::Request.new
+    @mock_http = mock(:http)
+  end
+  
+  it "should get a simple URL" do
+    @request.host = 'foo.bar'
+    @request.port = 1234
+    @request.path = '/get/path'
+    @mock_http.should_receive(:get).with('/get/path', {}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('foo.bar', 1234).and_yield(@mock_http)
+    @request.get
+  end
+  
+  it "should add headers and cookies" do
+    @request.headers['header_name'] = 'header_value'
+    @request.cookies['cookie_name'] = 'cookie_value'
+    @mock_http.should_receive(:get).with('/', 
+      {'header_name' => 'header_value', 'Cookie' => 'cookie_name=cookie_value; '}).and_return(:response)
+    Net::HTTP.should_receive(:start).with('localhost', 80).and_yield(@mock_http)
+    @request.get
+  end
+
+  it "should add params and query_params to the path" do
+    @request.params['param_name'] = 'param_value'
+    @request.query_params['query_param_name'] = 'query_param_value'
+    @mock_http.should_receive(:get) do |path, hdrs|
+      path.should match(/^\/\?/)
+      path.should include("query_param_name=query_param_value")
+      path.should include("param_name=param_value")
+      hdrs.should be_empty
+      :response
+    end
+    Net::HTTP.should_receive(:start).with('localhost', 80).and_yield(@mock_http)
+    @request.get
+  end
+  
+end

data/spec/response_accessor_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe WebSpeak::ResponseAccessor, "when the response is nil" do
+
+  before(:each) do
+    @response = mock(:response)
+    @ra = WebSpeak::ResponseAccessor.new(@response)
+  end
+  
+  it "should return the response with http_response" do
+    @ra.http_response.should be(@response)
+  end
+  
+  it "should return the headers" do
+    @response.should_receive(:each_header).and_yield('content-type', ['text/html'])
+    headers = @ra.headers
+    headers.should eql("content-type => text/html\n")
+  end
+  
+  it "should not include cookies in headers" do
+    @response.should_receive(:each_header).and_yield('set-cookie', ['Foo=Bar; ', 'Jack=Frost; '])
+    headers = @ra.headers
+    headers.should eql("")
+  end
+    
+  it "should return cookies" do
+    @response.should_receive(:get_fields).with('set-cookie').and_return(
+        ['Foo=Bar; expires=someday; domain=.foo.com', 'Jack=Frost; domain=.com'])
+    cookies = @ra.cookies
+    cookies.should eql("Foo => Bar\n  expires: someday\n  domain: .foo.com\nJack => Frost\n  domain: .com\n")
+  end
+  
+  it "should return the body" do
+    @response.should_receive(:body).and_return("the body")
+    body = @ra.body
+    body.should eql("the body")
+  end
+  
+  
+end

data/spec/session_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "A brand new session" do
+
+  before :each do
+    @session = WebSpeak::Session.new(:test)
+  end
+
+  it "should contain a request" do
+    @session.request.should_not be_nil
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require File.dirname(__FILE__) + "/../lib/webspeak"
+require 'stringio'
+require 'pp'
+require 'ostruct'
+
+def mock_cookie(name, value)
+  OpenStruct.new({'name' => name, 'value' => value})
+end
+  

data/spec/webspeak_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# # Time to add your specs!
+# # http://rspec.rubyforge.org/
+# describe "Place your specs here" do
+#   
+#   it "find this spec in spec directory"
+#   
+# end

data/tasks/deployment.rake

@@ -0,0 +1,27 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end