rest-client-components 0.2.1 → 0.2.2

data/README.rdoc

@@ -6,16 +6,19 @@ Want to add transparent HTTP caching to the rest-client[http://github.com/archil
   require 'restclient/components'
   require 'rack/cache'
   RestClient.enable Rack::Cache
+  RestClient.get "http://some/cacheable/resource"
 
 Want to log the requests in the commonlog format ?
   require 'restclient/components'
   RestClient.enable Rack::CommonLogger, STDOUT
+  RestClient.get "http://some/resource"
 
 Want to enable both ?
   require 'restclient/components'
   require 'rack/cache'
   RestClient.enable Rack::CommonLogger, STDOUT
   RestClient.enable Rack::Cache
+  RestClient.get "http://some/cacheable/resource"
   
 This works with any Rack middleware, thus you can reuse the wide range of existing Rack middleware to add functionalities to RestClient with very little effort.
 The order in which you enable components will be respected.
@@ -26,6 +29,8 @@ Note that the rest-client behaviour is also respected: you'll get back a RestCli
   status, header, body = RestClient.get('http://some/url')
 In that case, you will only get exceptions for connection or timeout errors (RestClient::ServerBrokeConnection or RestClient::RequestTimeout)
 
+See the examples folder for more details.
+
 = Installation
 
   gem install rest-client-components

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/examples/parsing.rb

@@ -10,7 +10,9 @@ module Rack
     
     def call(env)
       status, header, body = @app.call env
-      parsed_body = ::JSON.parse body.join if header['Content-Type'] =~ /^application\/.*json/i
+      content = ""
+      body.each{|line| content << line}
+      parsed_body = ::JSON.parse content if header['Content-Type'] =~ /^application\/.*json/i
       [status, header, parsed_body]
     end
   end

data/examples/twitter_caching.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../lib/restclient/components'
+require 'rack/cache'
+require 'json'
+
+
+RestClient.log = 'stdout'
+RestClient.enable Rack::Cache, :allow_reload => true, :allow_revalidate => true
+
+2.times do 
+  resp = RestClient::Resource.new("https://localhost:3443/sid/grid5000").get(:accept => "application/json")
+  p ["Cache-Control", resp.headers[:cache_control]]
+end
+
+__END__
+RestClient.get "https://localhost:3443/sid/grid5000", headers: {"Accept-encoding"=>"gzip, deflate", "Accept"=>"application/json"}
+# => 200 OK | application/vnd.fr.grid5000.api.grid+json 998 bytes
+cache: [GET /sid/grid5000] miss, store
+["Cache-Control", "public, must-revalidate"]
+RestClient.get "https://localhost:3443/sid/grid5000", headers: {"If-none-match"=>"\"ef6d9ea6d7d00299dd59a025fa84c19b4e69fafe\"", "Accept-encoding"=>"gzip, deflate", "Accept"=>"application/json", "If-modified-since"=>"Wed, 09 Dec 2009 13:58:54 GMT"}
+cache: [GET /sid/grid5000] stale, valid, store
+["Cache-Control", "public, must-revalidate"]

data/lib/restclient/components.rb

@@ -14,7 +14,9 @@ module RestClient
           raise e
         else
           response = RestClient::MockNetHTTPResponse.new(body, status, header)
-          RestClient::Response.new(response.body.join, response)
+          content = ""
+          response.body.each{|line| content << line}
+          RestClient::Response.new(content, response)
         end
       end
     end
@@ -136,17 +138,26 @@ module RestClient
   
   RACK_APP = Proc.new { |env|
     begin
-      # get the original request and execute it
-      response = env['restclient.request'].original_execute
-      # to satisfy Rack::Lint
-      response.headers.delete(:status)
-      [response.code, RestClient.debeautify_headers( response.headers ), [response.to_s]]
+      # get the original request, replace headers with those of env, and execute it
+      request = env['restclient.request']
+      additional_headers = env.keys.select{|k| k=~/^HTTP_/}.inject({}){|accu, k|
+        accu[k.gsub("HTTP_", "")] = env[k]
+        accu
+      }
+      request.processed_headers.replace(request.make_headers(additional_headers))
+      response = request.original_execute
     rescue RestClient::ExceptionWithResponse => e  
       env['restclient.error'] = e
        # e is a Net::HTTPResponse
       response = RestClient::Response.new(e.response.body, e.response)
-      [response.code, RestClient.debeautify_headers( response.headers ), [response.to_s]]
     end
+    # to satisfy Rack::Lint
+    response.headers.delete(:status)
+    header = RestClient.debeautify_headers( response.headers )
+    body = response.to_s
+    # return the real content-length since RestClient does not do it when decoding gzip responses
+    header['Content-Length'] = body.length.to_s if header.has_key?('Content-Length')
+    [response.code, header, [body]]
   }
 
-end
+end

data/rest-client-components.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rest-client-components}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
@@ -37,7 +37,8 @@ Gem::Specification.new do |s|
     "spec/components_spec.rb",
      "spec/spec_helper.rb",
      "examples/caching.rb",
-     "examples/parsing.rb"
+     "examples/parsing.rb",
+     "examples/twitter_caching.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/components_spec.rb

@@ -37,7 +37,6 @@ describe "Components for RestClient" do
   
   describe "usage" do
     before do
-
       @expected_args = {:url=>"http://domain.tld:8888/some/cacheable/resource?q1=a&q2=b", :method=>:get, :headers=>{:additional_header=>"whatever"}}
       @expected_request = RestClient::Request.new(@expected_args)
     end
@@ -58,6 +57,47 @@ describe "Components for RestClient" do
         body.each{|part| content << part}
         content.should == "body"
       end
+      
+      it "should cif the requested resource is not in the cache" do
+        @expected_request.should_receive(:original_execute).and_return(
+          mock('rest-client response', 
+            :headers => {:content_type => "text/plain, */*", :date => "Mon, 04 Jan 2010 13:37:18 GMT"}, 
+            :code => 200, 
+            :to_s => 'body'))
+        status, header, body = Rack::Lint.new(Rack::CommonLogger.new(Rack::Cache.new(RestClient::RACK_APP))).call(@env.merge(
+          'restclient.request' => @expected_request
+        ))
+        status.should == 200
+        header.should == {"Content-Type"=>"text/plain, */*", "X-Rack-Cache"=>"miss", "Date"=>"Mon, 04 Jan 2010 13:37:18 GMT"}
+        content = ""
+        body.each{|part| content << part}
+        content.should == "body"
+      end
+
+      
+      it "should add HTTP headers set by Rack middleware to the list of request headers" do
+        module Rack
+          class AddRequestHeader
+            def initialize(app)
+              @app = app
+            end
+            def call(env)
+              env['HTTP_X_HEADER'] = "hello"
+              @app.call(env)
+            end
+          end
+        end
+        @expected_request.should_receive(:processed_headers).and_return(processed_headers=mock("hash processed headers"))
+        processed_headers.should_receive(:replace).with(hash_including("X-header" => "hello"))
+        @expected_request.should_receive(:original_execute).and_return(
+          mock('rest-client response', 
+            :headers => {:content_type => "text/plain, */*", :date => "Mon, 04 Jan 2010 13:37:18 GMT"}, 
+            :code => 200, 
+            :to_s => 'body'))
+        status, header, body = Rack::Lint.new(Rack::AddRequestHeader.new(RestClient::RACK_APP)).call(@env.merge(
+          'restclient.request' => @expected_request
+        ))
+      end
 
       it "should return a 304 not modified response if the call to the backend returned a 304 not modified response" do
         @expected_request.should_receive(:original_execute).and_raise(RestClient::NotModified.new(@mock_304_net_http_response))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rest-client-components
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -85,3 +85,4 @@ test_files:
 - spec/spec_helper.rb
 - examples/caching.rb
 - examples/parsing.rb
+- examples/twitter_caching.rb