webmachine-test 0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rake'
+gem 'rspec'
+gem 'ZenTest'
+gem 'webmachine', :git => 'https://github.com/seancribbs/webmachine-ruby'

data/README.md

@@ -0,0 +1,100 @@
+# Webmachine::Test
+
+[![travis](https://secure.travis-ci.org/bernd/webmachine-test.png)](http://travis-ci.org/bernd/webmachine-test)
+
+## WARNING
+
+This library is still under development and incomplete!
+
+It will be merged into [webmachine-ruby](https://github.com/seancribbs/webmachine-ruby)
+when it's ready.
+
+## Description
+
+Webmachine::Test provides a testing API for
+[webmachine-ruby](https://github.com/seancribbs/webmachine-ruby) inspired by
+[rack-test](https://github.com/brynary/rack-test).
+
+## Example Usage
+
+### Application
+
+```ruby
+    require 'webmachine'
+
+    class MyResource < Webmachine::Resource
+      def content_types_provided
+        [['text/plain', :to_text]]
+      end
+
+      def to_text
+        'OK'
+      end
+    end
+
+    MyApp = Webmachine::Application.new.tap do |app|
+      app.add_route(['*'], MyResource)
+    end
+
+    # decouple runner from application so that adapter
+    # does not start and block test thread
+    #
+    # MyApp.run
+```
+
+### Test with Test::Unit
+
+```ruby
+    class MyAppTest < Test::Unit::TestCase
+      include Webmachine::Test
+
+      def test_get_root_succeeds
+        get '/'
+        assert_equal 200, response.code
+      end
+
+      def test_get_root_replies_with_string_ok
+        get '/'
+        assert_equal 'OK', response.body
+      end
+
+      def test_get_root_replies_with_content_type_of_text_plain
+        get '/'
+        assert_equal 'text/plain', response.headers['Content-Type']
+      end
+
+      def app
+        MyApp
+      end
+    end
+```
+
+### Test with RSpec
+
+```ruby
+    require 'webmachine/test'
+    require 'myapp'
+
+    describe MyApp do
+      include Webmachine::Test
+
+      let(:app) { MyApp }
+
+      describe 'GET /' do
+        it 'succeeds' do
+          get '/'
+          response.code.should == 200
+        end
+
+        it 'replies with the string OK' do
+          get '/'
+          response.body.should == 'OK'
+        end
+
+        it 'replies with a content type of text/plain' do
+          get '/'
+          response.headers['Content-Type'].should == 'text/plain'
+        end
+      end
+    end
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/webmachine/test/backports/uri.rb

@@ -0,0 +1,46 @@
+# :stopdoc:
+
+# Stolen from ruby core's uri/common.rb, with modifications to support 1.8.x
+#
+# https://github.com/ruby/ruby/blob/trunk/lib/uri/common.rb
+#
+# (via rack)
+
+module URI
+  TBLENCWWWCOMP_ = {} # :nodoc:
+  256.times do |i|
+    TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
+  end
+  TBLENCWWWCOMP_[' '] = '+'
+  TBLENCWWWCOMP_.freeze
+  TBLDECWWWCOMP_ = {} # :nodoc:
+  256.times do |i|
+    h, l = i>>4, i&15
+    TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+  end
+  TBLDECWWWCOMP_['+'] = ' '
+  TBLDECWWWCOMP_.freeze
+
+  # Encode given +s+ to URL-encoded form data.
+  #
+  # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
+  # (ASCII space) to + and converts others to %XX.
+  #
+  # This is an implementation of
+  # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+  #
+  # See URI.decode_www_form_component, URI.encode_www_form
+  def self.encode_www_form_component(s)
+    str = s.to_s
+    if RUBY_VERSION < "1.9" && $KCODE =~ /u/i
+      str.gsub(/([^ a-zA-Z0-9_.-]+)/) do
+        '%' + $1.unpack('H2' * Rack::Utils.bytesize($1)).join('%').upcase
+      end.tr(' ', '+')
+    else
+      str.gsub(/[^*\-.0-9A-Z_a-z]/) {|m| TBLENCWWWCOMP_[m]}
+    end
+  end
+end

data/lib/webmachine/test/session.rb

@@ -0,0 +1,90 @@
+require 'stringio'
+require 'uri'
+
+# Ruby 1.8 does not have URI.encode_www_form_component.
+unless URI.respond_to?(:encode_www_form_component)
+  require 'webmachine/test/backports/uri'
+end
+
+module Webmachine
+  module Test
+    class Session
+      HTTP_METHODS = %W(HEAD GET PUT POST PATCH DELETE OPTIONS)
+
+      def initialize(app)
+        @headers = Webmachine::Headers.new
+        @body = nil
+        @req = nil
+        @res = nil
+        @app = app
+      end
+
+      # Returns the request object.
+      def request
+        @req || webmachine_test_error('No request object yet. Issue a request first.')
+      end
+
+      # Returns the response object after a request has been made.
+      def response
+        @res || webmachine_test_error('No response yet. Issue a request first!')
+      end
+
+      # Set a single header for the next request.
+      def header(name, value)
+        @headers[name] = value
+      end
+
+      # Set the request body.
+      def body(value)
+        @body = value.respond_to?(:read) ? value : StringIO.new(value.to_s)
+      end
+
+      HTTP_METHODS.each do |method|
+        class_eval <<-__RUBY
+          def #{method.downcase}(uri, options = {})
+            do_request('#{method.upcase}', uri, options)
+          end
+        __RUBY
+      end
+
+      private
+      def webmachine_test_error(msg)
+        raise Webmachine::Test::Error.new(msg)
+      end
+
+      def do_request(method, uri, options)
+        uri = URI.parse(uri)
+        uri.scheme ||= 'http'
+        uri.host ||= 'localhost'
+
+        add_query_params(uri, options[:params])
+
+        # Set some default headers and merge the provided ones.
+        @headers['Host'] = [uri.host, uri.port].compact.join(':') unless @headers['Host']
+        @headers['Accept'] = '*/*' unless @headers['Accept']
+
+        options[:headers] ||= {}
+        options[:headers].each { |k, v| @headers[k] = v }
+
+        @body ||= options[:body] || StringIO.new
+
+        @req = Webmachine::Request.new(method, uri, @headers, @body)
+        @res = Webmachine::Response.new
+
+        @app.dispatcher.dispatch(@req, @res)
+        return @res
+      end
+
+      def add_query_params(uri, params)
+        if params
+          q = params.map do |k, v|
+            k, v = URI.encode_www_form_component(k), URI.encode_www_form_component(v)
+            "#{k}=#{v}"
+          end.join('&')
+
+          uri.query = uri.query ? [uri.query, q].join('&') : q
+        end
+      end
+    end
+  end
+end

data/lib/webmachine/test/version.rb

@@ -0,0 +1,5 @@
+module Webmachine
+  module Test
+    VERSION = '0.1.0'
+  end
+end

data/lib/webmachine/test.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+require 'webmachine'
+require 'webmachine/test/session'
+
+module Webmachine
+  module Test
+    extend Forwardable
+
+    # Exception class for Test errors.
+    class Error < StandardError
+    end
+
+    def current_session
+      @session ||= Webmachine::Test::Session.new(app)
+    end
+
+    def_delegators :current_session, :request, :header, :headers, :body, :response,
+                                     :get, :post, :put, :patch, :delete,
+                                     :options, :head
+  end
+end
+

data/spec/fixtures/test_resource.rb

@@ -0,0 +1,11 @@
+require 'webmachine'
+
+class TestResource < Webmachine::Resource
+  def content_types_provided
+    [['text/plain', :to_text]]
+  end
+
+  def to_text
+    'OK'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'webmachine/application'
+require 'webmachine/test'
+require 'fixtures/test_resource'
+
+module WebmachineTestApplication
+  def app
+    @app ||= Webmachine::Application.new.tap do |test_app|
+      test_app.add_route(['*'], TestResource)
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include WebmachineTestApplication
+end
+

data/spec/webmachine/test/session_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+describe Webmachine::Test::Session do
+  include Webmachine::Test
+
+  describe "#request" do
+    it "returns the Webmachine::Request object" do
+      get '/'
+      request.should be_a(Webmachine::Request)
+    end
+
+    context "without a request" do
+      it "raises an exception" do
+        expect { request }.to raise_error(Webmachine::Test::Error)
+      end
+    end
+  end
+
+  describe "#response" do
+    it "returns the Webmachine::Response object" do
+      get '/'
+      response.should be_a(Webmachine::Response)
+    end
+
+    context "without a request" do
+      it "raises an exception" do
+        expect { response }.to raise_error(Webmachine::Test::Error)
+      end
+    end
+  end
+
+  shared_examples_for "a HTTP verb" do
+    it "executes a GET request" do
+      send verb, '/'
+      request.method.should == verb.upcase
+    end
+
+    it "sets the provided header" do
+      send verb, '/', :headers => {'Accept' => 'application/x-gunzip'}
+      request.headers['Accept'].should == 'application/x-gunzip'
+    end
+
+    context "with a complete URI" do
+      it "sets the correct host header" do
+        send verb, 'http://example.com:3000/foo'
+        request.headers['Host'].should == 'example.com:3000'
+      end
+    end
+
+    context "with an incomplete URI" do
+      it "sets the correct host header" do
+        send verb, '/foo'
+        request.headers['Host'].should == 'localhost'
+      end
+    end
+
+    it "accepts query parameters in the path" do
+      send verb,'/?lang=en&foo=bar'
+      request.query['lang'].should == 'en'
+      request.query['foo'].should == 'bar'
+    end
+
+    it "accepts query parameters in the options hash" do
+      send verb, '/?foo=bar', :params => {'lang' => 'en'}
+      request.query['lang'].should == 'en'
+      request.query['foo'].should == 'bar'
+    end
+
+    it "escapes the query parameters" do
+      expect {
+        send verb, '/', :params => {'test' => 'foo bar'}
+      }.to_not raise_error(URI::InvalidComponentError)
+    end
+
+    it "encodes the query key and value." do
+      send verb, '/', :params => { "foo=" => "bar=" }
+      request.uri.query.should == "foo%3D=bar%3D"
+    end
+
+    it "returns the Webmachine::Request object" do
+      send(verb, '/').should be_a(Webmachine::Response)
+    end
+  end
+
+  describe "#get" do
+    let(:verb) { 'get' }
+    it_should_behave_like "a HTTP verb"
+  end
+
+  describe "#post" do
+    let(:verb) { 'post' }
+    it_should_behave_like "a HTTP verb"
+  end
+
+  describe "#put" do
+    let(:verb) { 'put' }
+    it_should_behave_like "a HTTP verb"
+  end
+
+  describe "#patch" do
+    let(:verb) { 'patch' }
+    it_should_behave_like "a HTTP verb"
+  end
+
+  describe "#delete" do
+    let(:verb) { 'delete' }
+    it_should_behave_like "a HTTP verb"
+  end
+
+  describe "#head" do
+    let(:verb) { 'head' }
+    it_should_behave_like "a HTTP verb"
+  end
+
+  describe "#options" do
+    let(:verb) { 'options' }
+    it_should_behave_like "a HTTP verb"
+  end
+
+  describe "#header" do
+    it "sets the given header value" do
+      header('Foo', 'bar-baz')
+      get '/'
+      request.headers['Foo'].should == 'bar-baz'
+    end
+  end
+
+  describe "#body" do
+    context "given a string" do
+      it "sets the body" do
+        body('test body')
+        get '/'
+        request.body.read.should == 'test body'
+      end
+    end
+
+    context "given an IO object" do
+      it "sets the body" do
+        body(StringIO.new('foo'))
+        get '/'
+        request.body.read.should == 'foo'
+      end
+    end
+  end
+end

data/webmachine-test.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "webmachine/test/version"
+
+Gem::Specification.new do |s|
+  s.name        = "webmachine-test"
+  s.version     = Webmachine::Test::VERSION
+  s.authors     = ["Bernd Ahlers"]
+  s.email       = ["bernd@tuneafish.de"]
+  s.homepage    = ""
+  s.summary     = %q{Test API for webmachine-ruby}
+  s.description = <<-DESC.gsub(/\s+/, ' ')
+    Webmachine::Test provides a testing API for webmachine-ruby inspired
+    by rack-test.
+  DESC
+
+  s.rubyforge_project = "webmachine-test"
+
+  s.files         = `git ls-files`.split("\n").reject {|f| f =~ /^\./ }
+  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"]
+
+  s.add_runtime_dependency(%q<webmachine>)
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: webmachine-test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bernd Ahlers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Webmachine::Test provides a testing API for webmachine-ruby inspired
+  by rack-test. '
+email:
+- bernd@tuneafish.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/webmachine/test.rb
+- lib/webmachine/test/backports/uri.rb
+- lib/webmachine/test/session.rb
+- lib/webmachine/test/version.rb
+- spec/fixtures/test_resource.rb
+- spec/spec_helper.rb
+- spec/webmachine/test/session_spec.rb
+- webmachine-test.gemspec
+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: webmachine-test
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Test API for webmachine-ruby
+test_files: []