sham_rack 1.3.2 → 1.3.3

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+## 18-Oct-2010 [mdub@dogbiscuit.org]
+
+* Add support for Patron.
+
 ## 02-Sep-2010 [mdub@dogbiscuit.org]
 
 * Fixes to support Ruby-1.9.x.

data/README.markdown

@@ -1,14 +1,14 @@
 ShamRack
 ========
 
-ShamRack plumbs Net:HTTP into [Rack][rack].
+ShamRack plumbs HTTP requests into [Rack][rack].
 
 What's it for, again?
 ---------------------
 
 Well, it makes it easy to _stub out external (HTTP) services_, which is handy in development and testing environments, or when you want to _test your HTTP client code_.
 
-You can also use it to _test your Rack application_ (or Sinatra, or Rails, or Merb) using arbitrary HTTP client libraries, to check interoperability. For instance, you could test your app using:
+You can also use it to _test your Rack application_ (or Sinatra, or Rails, or Merb) using a variety of HTTP client libraries, to check interoperability. For instance, you could test your app using:
 
 * [`rest-client`][rest-client]
 * [`httparty`][httparty]
@@ -28,12 +28,12 @@ Using it
 
     require 'sham_rack'
 
-    ShamRack.at("www.example.com") do |env|
+    ShamRack.at("www.greetings.com") do |env|
       ["200 OK", { "Content-type" => "text/plain" }, "Hello, world!"]
     end
       
     require 'open-uri'
-    open("http://www.example.com/").read            #=> "Hello, world!"
+    open("http://www.greetings.com/").read            #=> "Hello, world!"
 
 ### Sinatra integration
 
@@ -67,6 +67,40 @@ Using it
 
 Or, just use Sinatra, as described above ... it's almost as succinct, and heaps more powerful.
 
+### When you're done testing
+
+    ShamRack.unmount_all
+
+    open("http://stubbed.com/greeting").read       #=> OpenURI::HTTPError
+
+Supported HTTP client libraries
+-------------------------------
+
+### Net::HTTP and friends
+
+ShamRack supports requests made using Net::HTTP, or any of the numerous APIs built on top of it:
+
+    uri = URI.parse("http://www.greetings.com/")
+    Net::HTTP.get_response(uri).body                      #=> "Hello, world!"
+    
+    require 'open-uri'
+    open("http://www.greetings.com/").read                #=> "Hello, world!"
+
+    require 'restclient'
+    RestClient.get("http://www.greetings.com/").to_s      #=> "Hello, world!"
+
+    require 'mechanize'
+    Mechanize.new.get("http://www.greetings.com/").body   #=> "Hello, world!"
+
+### Patron (experimental)
+
+We've recently added support for [Patron][patron]:
+
+    require 'sham_rack/patron'
+
+    patron = Patron::Session.new
+    patron.get("http://www.greetings.com/").body          #=> "Hello, world!"
+
 What's the catch?
 -----------------
 
@@ -85,3 +119,5 @@ Thanks to
 [httparty]: http://github.com/jnunemaker/httparty
 [oauth]: http://oauth.rubyforge.org/
 [fakeweb]: http://fakeweb.rubyforge.org/
+[mechanize]: http://mechanize.rubyforge.org
+[patron]: http://github.com/toland/Patron

data/Rakefile

@@ -6,6 +6,10 @@ require "spec/rake/spectask"
 task "default" => "spec"
 
 Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ["--colour", "--format", "progress"]
+  t.spec_opts = ["--colour", "--format", "nested"]
   t.spec_files = FileList['spec/**/*_spec.rb']
 end
+
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/lib/sham_rack/net_http.rb

@@ -33,66 +33,41 @@ module ShamRack
         end
       end
 
-      def request(req, body = nil)
-        env = default_env
-        env.merge!(path_env(req.path))
-        env.merge!(method_env(req))
-        env.merge!(header_env(req))
-        env.merge!(io_env(req, body))
-        response = build_response(@rack_app.call(env))
-        yield response if block_given?
-        return response
+      def request(request, body = nil)
+        rack_response = @rack_app.call(rack_env(request, body))
+        net_http_response = build_response(rack_response)
+        yield net_http_response if block_given?
+        return net_http_response
       end
 
       private
 
-      def default_env
-        {
-          "SCRIPT_NAME" => "",
-          "SERVER_NAME" => @address,
-          "SERVER_PORT" => @port.to_s,   
-          "rack.version" => [0,1],
-          "rack.url_scheme" => "http",
-          "rack.multithread" => true,
-          "rack.multiprocess" => true,
-          "rack.run_once" => false
-        }
+      def rack_env(request, body)
+        rack_env = request_env(request, body)
+        rack_env.merge!(header_env(request))
+        rack_env.merge!(server_env)
       end
-
-      def method_env(request)
+      
+      def server_env
         {
-          "REQUEST_METHOD" => request.method
+          "SERVER_NAME" => @address, 
+          "SERVER_PORT" => @port.to_s
         }
       end
-
-      def io_env(request, body)
-        raise(ArgumentError, "both request.body and body argument were provided") if (request.body && body)
-        body ||= request.body || ""
-        body = body.to_s
-        body = body.encode("ASCII-8BIT") if body.respond_to?(:encode)
-        { 
-          "rack.input" => StringIO.new(body),
-          "rack.errors" => $stderr
-        }
-      end
-
-      def path_env(path)
-        uri = URI.parse(path)
-        {
-          "PATH_INFO" => uri.path,
-          "QUERY_STRING" => (uri.query || ""),
-        }
-      end
-
+      
       def header_env(request)
-        result = {}
-        request.each do |header, content|
-          result["HTTP_" + header.upcase.gsub('-', '_')] = content
+        env = {}
+        request.each_header do |header, content|
+          key = header.upcase.gsub('-', '_')
+          key = "HTTP_" + key unless key =~ /^CONTENT_(TYPE|LENGTH)$/
+          env[key] = content
         end
-        %w(TYPE LENGTH).each do |x|
-          result["CONTENT_#{x}"] = result.delete("HTTP_CONTENT_#{x}") if result.has_key?("HTTP_CONTENT_#{x}")
-        end
-        return result
+        env
+      end
+
+      def request_env(request, body)
+        body ||= request.body || ""
+        Rack::MockRequest.env_for(request.path, :method => request.method, :input => body.to_s)
       end
 
       def build_response(rack_response)
@@ -111,7 +86,7 @@ module ShamRack
       def assemble_body(body)
         content = ""
         body.each { |fragment| content << fragment }
-        return content
+        content
       end
 
     end

data/lib/sham_rack/patron.rb

@@ -0,0 +1,64 @@
+require "patron"
+require "sham_rack/registry"
+require "uri"
+
+module Patron
+
+  class Session
+
+    alias :handle_request_without_sham_rack :handle_request
+
+    def handle_request(patron_request)
+      uri = URI.parse(patron_request.url)
+      rack_app = ShamRack.application_for(uri.host, uri.port)
+      if rack_app
+        handle_request_with_rack(patron_request, rack_app)
+      else
+        handle_request_without_sham_rack(patron_request)
+      end
+    end
+
+    private
+
+    def handle_request_with_rack(patron_request, rack_app)
+      env = rack_env_for(patron_request)
+      rack_response = rack_app.call(env)
+      patron_response(rack_response)
+    end
+
+    def rack_env_for(patron_request)
+      env = Rack::MockRequest.env_for(patron_request.url, :method => patron_request.action, :input => patron_request.upload_data)
+      env.merge!(header_env(patron_request))
+      env
+    end
+
+    def patron_response(rack_response)
+      status, headers, body = rack_response
+      status_code = Rack::Utils::HTTP_STATUS_CODES[status.to_i]
+      res = Patron::Response.new
+      res.instance_variable_set(:@status, status)
+      res.instance_variable_set(:@status_line, "HTTP/1.1 #{status} #{status_code}")
+      res.instance_variable_set(:@body, assemble_body(body))
+      res.instance_variable_set(:@headers, headers)
+      res
+    end
+
+    def header_env(patron_request)
+      env = {}
+      patron_request.headers.each do |header, content|
+        key = header.upcase.gsub('-', '_')
+        key = "HTTP_" + key unless key =~ /^CONTENT_(TYPE|LENGTH)$/
+        env[key] = content
+      end
+      env
+    end
+
+    def assemble_body(body)
+      content = ""
+      body.each { |fragment| content << fragment }
+      content
+    end
+
+  end
+
+end

data/lib/sham_rack/version.rb

@@ -1,3 +1,3 @@
 module ShamRack
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

data/spec/sham_rack_spec.rb

@@ -1,62 +1,12 @@
 require "spec_helper"
 
 require "sham_rack"
+require "sham_rack/patron"
 require "open-uri"
 require "restclient"
 require "mechanize"
 require "rack"
 
-class PlainTextApp
-
-  def call(env)
-    [
-      "200 OK", 
-      { "Content-Type" => "text/plain", "Content-Length" => message.length.to_s },
-      [message]
-    ]
-  end
-
-end
-
-class SimpleMessageApp < PlainTextApp
-
-  def initialize(message)
-    @message = message
-  end
-
-  attr_reader :message
-
-end
-
-class EnvRecordingApp < PlainTextApp
-
-  def call(env)
-    @last_env = env
-    super
-  end
-
-  attr_reader :last_env
-
-  def message
-    "env stored for later perusal"
-  end
-
-end
-
-class UpcaseBody
-
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    status, headers, body = @app.call(env)
-    upcased_body = Array(body).map { |x| x.upcase }
-    [status, headers, upcased_body]
-  end
-
-end
-
 describe ShamRack do
 
   after(:each) do
@@ -66,71 +16,46 @@ describe ShamRack do
   describe "mounted Rack application" do
 
     before(:each) do
-      ShamRack.mount(SimpleMessageApp.new("Hello, world"), "www.test.xyz")
+      ShamRack.mount(GreetingApp.new, "www.greetings.com")
     end
 
     it "can be accessed using Net::HTTP" do
-      response = Net::HTTP.start("www.test.xyz") do |http|
+      response = Net::HTTP.start("www.greetings.com") do |http|
         http.request(Net::HTTP::Get.new("/"))
       end
       response.body.should == "Hello, world"
     end
 
     it "can be accessed using Net::HTTP#get_response" do
-      response = Net::HTTP.get_response(URI.parse("http://www.test.xyz/"))
+      response = Net::HTTP.get_response(URI.parse("http://www.greetings.com/"))
       response.body.should == "Hello, world"
     end
 
     it "can be accessed using open-uri" do
-      response = open("http://www.test.xyz")
+      response = open("http://www.greetings.com")
       response.status.should == ["200", "OK"]
       response.read.should == "Hello, world"
     end
 
     it "can be accessed using RestClient" do
-      response = RestClient.get("http://www.test.xyz")
+      response = RestClient.get("http://www.greetings.com")
       response.code.should == 200
       response.to_s.should == "Hello, world"
     end
 
-    it "can be accessed using WWW::Mechanize" do
-      response = Mechanize.new.get("http://www.test.xyz")
+    it "can be accessed using Mechanize" do
+      response = Mechanize.new.get("http://www.greetings.com")
       response.body.should == "Hello, world"
     end
 
-  end
-
-  describe "response" do
-    
-    before(:each) do
-      ShamRack.at("www.test.xyz") do
-        [
-          "201 Created", 
-          { "Content-Type" => "text/plain", "X-Foo" => "bar" },
-          ["BODY"]
-        ]
-      end
-      @response = Net::HTTP.get_response(URI.parse("http://www.test.xyz/"))
-    end
-    
-    it "has status returned by app" do
-      @response.code.should == "201"
+    it "can be accessed using Patron" do
+      patron = Patron::Session.new
+      response = patron.get("http://www.greetings.com/foo/bar")
+      response.body.should == "Hello, world"
     end
 
-    it "has body returned by app" do
-      @response.body.should == "BODY"
-    end
-    
-    it "has Content-Type returned by app" do
-      @response.content_type.should == "text/plain"
-    end
-    
-    it "has other headers returned by app" do
-      @response["x-foo"].should =="bar"
-    end
-    
   end
-  
+
   describe ".at" do
 
     describe "with a block" do
@@ -152,12 +77,12 @@ describe ShamRack do
       before do
         @return_value = ShamRack.at("rackup.xyz").rackup do
           use UpcaseBody
-          run SimpleMessageApp.new("Racked!")
+          run GreetingApp.new
         end
       end
 
       it "mounts an app created using Rack::Builder" do
-        open("http://rackup.xyz").read.should == "RACKED!"
+        open("http://rackup.xyz").read.should == "HELLO, WORLD"
       end
 
       it "returns the app" do
@@ -204,10 +129,41 @@ describe ShamRack do
     
   end
 
+  describe "response" do
+    
+    before(:each) do
+      ShamRack.at("www.greetings.com") do
+        [
+          "201 Created", 
+          { "Content-Type" => "text/plain", "X-Foo" => "bar" },
+          ["BODY"]
+        ]
+      end
+      @response = Net::HTTP.get_response(URI.parse("http://www.greetings.com/"))
+    end
+    
+    it "has status returned by app" do
+      @response.code.should == "201"
+    end
+
+    it "has body returned by app" do
+      @response.body.should == "BODY"
+    end
+    
+    it "has Content-Type returned by app" do
+      @response.content_type.should == "text/plain"
+    end
+    
+    it "has other headers returned by app" do
+      @response["x-foo"].should =="bar"
+    end
+    
+  end
+  
   describe "Rack environment" do
 
     before(:each) do
-      @env_recorder = recorder = EnvRecordingApp.new
+      @env_recorder = recorder = EnvRecorder.new(GreetingApp.new)
       ShamRack.at("env.xyz").rackup do
         use Rack::Lint
         run recorder
@@ -229,7 +185,7 @@ describe ShamRack do
       env["SERVER_NAME"].should == "env.xyz"
       env["SERVER_PORT"].should == "80"
 
-      env["rack.version"].should == [0,1]
+      env["rack.version"].should be_kind_of(Array)
       env["rack.url_scheme"].should == "http"
 
       env["rack.multithread"].should == true
@@ -271,6 +227,19 @@ describe ShamRack do
 
     end
 
+    it "supports POST using Patron" do
+
+      patron = Patron::Session.new
+      response = patron.post("http://env.xyz/resource", "<xml/>", "Content-Type" => "application/xml")
+
+      response.status.should == "200 OK"
+      
+      env["REQUEST_METHOD"].should == "POST"
+      env["rack.input"].read.should == "<xml/>"
+      env["CONTENT_TYPE"].should == "application/xml"
+
+    end
+
     it "supports PUT" do
 
       RestClient.put("http://env.xyz/thing1", "stuff", :content_type => "text/plain")
@@ -281,6 +250,17 @@ describe ShamRack do
 
     end
 
+    it "supports PUT using Patron" do
+
+      patron = Patron::Session.new
+      response = patron.put("http://env.xyz/resource", "stuff", "Content-Type" => "text/plain")
+
+      env["REQUEST_METHOD"].should == "PUT"
+      env["CONTENT_TYPE"].should == "text/plain"
+      env["rack.input"].read.should == "stuff"
+
+    end
+
     it "supports DELETE" do
 
       RestClient.delete("http://env.xyz/thing/1")
@@ -290,6 +270,16 @@ describe ShamRack do
 
     end
 
+    it "supports DELETE using Patron" do
+
+      patron = Patron::Session.new
+      response = patron.delete("http://env.xyz/resource")
+
+      env["REQUEST_METHOD"].should == "DELETE"
+      env["PATH_INFO"].should == "/resource"
+
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -2,10 +2,8 @@ require "rubygems"
 require "spec"
 require "rr"
 
-project_root = File.expand_path("#{__FILE__}/../..")
-$LOAD_PATH << "#{project_root}/lib"
-$LOAD_PATH << "#{project_root}/spec/support/lib"
-
 Spec::Runner.configure do |config|
   config.mock_with RR::Adapters::Rspec
 end
+
+require "test_apps"

data/spec/test_apps.rb

@@ -0,0 +1,48 @@
+require "rack"
+
+class GreetingApp
+
+  include Rack::Utils
+  
+  def call(env)
+    params = parse_nested_query(env["QUERY_STRING"])
+    salutation = params[:salutation] || "Hello"
+    subject = params[:subject] || "world"
+    message = "#{salutation}, #{subject}"
+    [
+      "200 OK", 
+      { "Content-Type" => "text/plain", "Content-Length" => message.length.to_s },
+      [message]
+    ]
+  end
+  
+end
+
+class EnvRecorder
+
+  def initialize(app)
+    @app = app
+  end
+  
+  def call(env)
+    @last_env = env
+    @app.call(env)
+  end
+
+  attr_reader :last_env
+
+end
+
+class UpcaseBody
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    status, headers, body = @app.call(env)
+    upcased_body = Array(body).map { |x| x.upcase }
+    [status, headers, upcased_body]
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sham_rack
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 1
   - 3
-  - 2
-  version: 1.3.2
+  - 3
+  version: 1.3.3
 platform: ruby
 authors: 
 - Mike Williams
@@ -15,10 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 +10:00
+date: 2010-12-22 00:00:00 +11:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: ShamRack plumbs Net::HTTP directly into Rack, for quick and easy HTTP testing.
 email: mdub@dogbiscuit.org
 executables: []
@@ -29,6 +42,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/sham_rack/net_http.rb
+- lib/sham_rack/patron.rb
 - lib/sham_rack/registry.rb
 - lib/sham_rack/stub_web_service.rb
 - lib/sham_rack/version.rb
@@ -38,6 +52,7 @@ files:
 - spec/sham_rack/stub_web_service_spec.rb
 - spec/sham_rack_spec.rb
 - spec/spec_helper.rb
+- spec/test_apps.rb
 - Rakefile
 - benchmark/benchmark.rb
 - benchmark/hello_app.rb
@@ -79,6 +94,7 @@ test_files:
 - spec/sham_rack/stub_web_service_spec.rb
 - spec/sham_rack_spec.rb
 - spec/spec_helper.rb
+- spec/test_apps.rb
 - Rakefile
 - benchmark/benchmark.rb
 - benchmark/hello_app.rb