resourceful 0.5.4 → 0.6.0

data/spec/acceptance/caching_spec.rb

@@ -30,9 +30,7 @@ describe Resourceful do
     end
 
     def uri_for_code(code, params = {})
-      template = Addressable::Template.new("http://localhost:3000/code/{code}")
-      uri = template.expand("code" => code.to_s)
-
+      uri = Addressable::Template.new("http://localhost:42682/code/{code}").expand("code" => code.to_s)
       uri_plus_params(uri, params)
     end
 
@@ -106,7 +104,7 @@ describe Resourceful do
 
       it 'should revalidate the cached response if the response is expired' do
         in_the_past = (Time.now - 60).httpdate
-        resource = @http.resource(uri_for_code(200, "Expire" => in_the_past))
+        resource = @http.resource(uri_for_code(200, "Expires" => in_the_past))
 
         resp = resource.get
         resp.should be_expired
@@ -121,7 +119,7 @@ describe Resourceful do
 
       it "should be authoritative if the response is directly from the server" do
         resource = @http.resource(
-          uri_plus_params('http://localhost:3000/', "Cache-Control" => 'max-age=10')
+          uri_plus_params('http://localhost:42682/', "Cache-Control" => 'max-age=10')
         )
 
         response  = resource.get
@@ -131,7 +129,7 @@ describe Resourceful do
       it "should be authoritative if a cached response was revalidated with the server" do
         now = Time.now.httpdate
         resource = @http.resource(
-          uri_plus_params('http://localhost:3000/cached', 
+          uri_plus_params('http://localhost:42682/cached', 
                           "modified" => now, 
                           "Cache-Control" => 'max-age=0')
         )
@@ -144,7 +142,7 @@ describe Resourceful do
       it "should not be authoritative if the cached response was not revalidated" do
         now = Time.now.httpdate
         resource = @http.resource(
-          uri_plus_params('http://localhost:3000/cached', 
+          uri_plus_params('http://localhost:42682/cached', 
                           "modified" => now, 
                           "Cache-Control" => 'max-age=10')
         )
@@ -162,7 +160,7 @@ describe Resourceful do
         now = Time.now.httpdate
 
         resource = @http.resource(
-          uri_plus_params('http://localhost:3000/cached', 
+          uri_plus_params('http://localhost:42682/cached', 
                           "modified" => now, 
                           "Cache-Control" => 'max-age=0')
         )

data/spec/acceptance/header_spec.rb

@@ -6,7 +6,7 @@ describe Resourceful do
   describe 'setting headers' do
     before do
       @http = Resourceful::HttpAccessor.new
-      @resource = @http.resource("http://localhost:3000/header")
+      @resource = @http.resource("http://localhost:42682/header")
     end
 
     it 'should handle "Content-Type"' do

data/spec/acceptance/resource_spec.rb

@@ -7,12 +7,12 @@ describe Resourceful do
   describe "working with a resource" do
     before do 
       @http = Resourceful::HttpAccessor.new
-      @resource = @http.resource('http://localhost:3000/')
+      @resource = @http.resource('http://localhost:42682/')
     end
 
     it 'should make the original uri available' do 
-      @resource.effective_uri.should == 'http://localhost:3000/'
-      @resource.uri.should == 'http://localhost:3000/'
+      @resource.effective_uri.should == 'http://localhost:42682/'
+      @resource.uri.should == 'http://localhost:42682/'
     end
 
     it 'should set the user agent string on the default header' do

data/spec/caching_spec.rb

@@ -0,0 +1,89 @@
+
+require 'rubygems'
+require 'fakeweb'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
+require 'resourceful'
+
+describe "Caching" do
+
+  before do
+    FakeWeb.allow_net_connect = false
+    FakeWeb.clean_registry
+
+    @http = Resourceful::HttpAccessor.new(:cache_manager => Resourceful::InMemoryCacheManager.new)
+    if ENV['SPEC_LOGGING']
+      @http.logger = Resourceful::StdOutLogger.new
+    end
+  end
+
+  describe "should cache" do
+
+    before do
+      FakeWeb.register_uri(:get, "http://example.com/cache",
+                           [{:body => "Original response", :cache_control => "private,max-age=15"},
+                            {:body => "Overrode cached response"}]
+                          )
+
+      @resource = @http.resource("http://example.com/cache")
+    end
+
+    it "should cache the response" do
+      resp = @resource.get
+      resp.body.should == "Original response"
+
+      resp = @resource.get
+      resp.body.should == "Original response"
+    end
+
+  end
+
+  describe "updating headers" do
+    before do
+      FakeWeb.register_uri(:get, "http://example.com/override",
+                           [{:body => "Original response", :cache_control => "private,max-age=0", :x_updateme => "foo"},
+                            {:body => "Overrode cached response", :status => 304, :x_updateme => "bar"} ]
+                          )
+
+      @resource = @http.resource("http://example.com/override")
+    end
+
+    it "should update headers from the 304" do
+      resp = @resource.get
+      resp.headers['X-Updateme'].should == ["foo"]
+
+      resp = @resource.get
+      resp.headers['X-Updateme'].should == ["bar"]
+      resp.headers['Cache-Control'].should == ["private,max-age=0"]
+    end
+
+  end
+
+  describe "updating expiration" do
+    before do
+      FakeWeb.register_uri(:get, "http://example.com/timeout",
+                           [{:body => "Original response", :cache_control => "private,max-age=1"},
+                            {:body => "cached response",   :cache_control => "private,max-age=1"}]
+                          )
+
+      @resource = @http.resource("http://example.com/timeout")
+    end
+
+    it "should refresh the expiration timer" do
+      resp = @resource.get
+      resp.should_not be_stale
+
+      sleep 2
+
+      resp.should be_stale
+
+      resp = @resource.get
+      resp.should_not be_stale
+
+      resp = @resource.get
+    end
+
+  end
+
+
+end

data/spec/resourceful/header_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+
+
+describe Resourceful::Header do 
+  it "should have constants for header names" do 
+    Resourceful::Header::CONTENT_TYPE.should == 'Content-Type'
+  end
+end

data/spec/resourceful/multipart_form_data_spec.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'tempfile'
+require "resourceful/multipart_form_data.rb"
+
+describe Resourceful::MultipartFormData do
+
+  before do 
+    @form_data = Resourceful::MultipartFormData.new
+  end
+
+  it "should know its content-type" do 
+    @form_data.content_type.should match(/^multipart\/form-data/i)
+  end
+
+  it "should know its boundary string" do 
+    @form_data.content_type.should match(/; boundary=[0-9A-Za-z]{10,}/i)
+  end
+
+
+  describe "with simple parameters" do 
+
+    it "should all simple parameters to be added" do 
+      @form_data.add(:foo, "testing")
+    end
+
+    it "should render a multipart form-data document when #read is called" do 
+      @form_data.add('foo', 'bar')
+      @form_data.add('baz', 'this')
+      
+      boundary = /boundary=(\w+)/.match(@form_data.content_type)[1]
+      @form_data.read.should eql(<<MPFD[0..-2])
+--#{boundary}\r
+Content-Disposition: form-data; name="foo"\r
+\r
+bar\r
+--#{boundary}\r
+Content-Disposition: form-data; name="baz"\r
+\r
+this\r
+--#{boundary}--
+MPFD
+
+    end
+
+    describe "with file parameter" do 
+      it "should add file parameters to be added" do 
+        Tempfile.open('resourceful-post-file-tests') do |file_to_upload|
+          file_to_upload << "This is a test"
+          file_to_upload.flush
+          
+          @form_data.add_file(:foo, file_to_upload.path)
+        end
+      end
+
+      it "should render a multipart form-data document when #read is called" do 
+        Tempfile.open('resourceful-post-file-tests') do |file_to_upload|
+          file_to_upload << "This is a test"
+          file_to_upload.flush
+          
+          @form_data.add_file(:foo, file_to_upload.path)
+      
+          boundary = /boundary=(\w+)/.match(@form_data.content_type)[1]
+          @form_data.read.should eql(<<MPFD[0..-2])
+--#{boundary}\r
+Content-Disposition: form-data; name="foo"; filename="#{File.basename(file_to_upload.path)}"\r
+Content-Type: application/octet-stream\r
+\r
+This is a test\r
+--#{boundary}--
+MPFD
+
+        end
+      
+      end
+    end
+  end
+end

data/spec/resourceful/resource_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+module Resourceful
+  describe Resource do 
+    before do 
+      @http_adapter = stub(:http_adapter)
+      http = Resourceful::HttpAccessor.new(:http_adapter => @http_adapter)
+      @resource = http.resource('http://foo.example')
+    end
+    
+    describe "POSTing" do 
+      it "should use bodies content type as the request content-type if it is known" do 
+        @http_adapter.should_receive(:make_request).with(anything, anything, anything, hash_including('Content-Type' => 'application/x-special-type')).and_return([200, {}, ""])
+        body = stub(:body, :content_type => 'application/x-special-type', :read => "hello there")
+        @resource.post(body)
+      end
+    end
+  
+  end
+end

data/spec/resourceful/urlencoded_form_data_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'tempfile'
+require "resourceful/urlencoded_form_data.rb"
+
+describe Resourceful::UrlencodedFormData do
+
+  before do 
+    @form_data = Resourceful::UrlencodedFormData.new
+  end
+
+  it "should know its content-type" do 
+    @form_data.content_type.should match(/^application\/x-www-form-urlencoded$/i)
+  end
+
+  describe "instantiation" do 
+    it "should be creatable with hash" do 
+      Resourceful::UrlencodedFormData.new(:foo => 'testing').read.should eql("foo=testing")
+    end
+  end
+
+  describe "with simple parameters" do 
+    it "should all simple parameters to be added" do 
+      @form_data.add(:foo, "testing")
+    end
+
+    it "should render a multipart form-data document when #read is called" do 
+      @form_data.add('foo', 'bar')
+      @form_data.add('baz', 'this')
+      
+      @form_data.read.should eql("foo=bar&baz=this")
+    end
+
+    it "should escape character in values that are unsafe" do 
+      @form_data.add('foo', 'this & that')
+      
+      @form_data.read.should eql("foo=this+%26+that")
+    end
+
+    it "should escape character in names that are unsafe" do 
+      @form_data.add('foo=bar', 'this')      
+      @form_data.read.should eql("foo%3Dbar=this")
+    end
+  end
+end

data/spec/simple_sinatra_server.rb

@@ -69,6 +69,6 @@ get '/cached' do
 end
 
 Sinatra::Default.set(
-  :port => 3000
+  :port => 42682
 )
 

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'spec'
+require 'pp'
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
 require 'resourceful'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resourceful
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors: 
 - Paul Sadauskas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-11 00:00:00 -06:00
+date: 2009-08-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.1.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: httpauth
@@ -81,34 +81,42 @@ extensions: []
 extra_rdoc_files: 
 - lib/resourceful.rb
 - lib/resourceful/net_http_adapter.rb
+- lib/resourceful/options_interpretation.rb
 - lib/resourceful/stubbed_resource_proxy.rb
+- lib/resourceful/urlencoded_form_data.rb
 - lib/resourceful/header.rb
 - lib/resourceful/memcache_cache_manager.rb
 - lib/resourceful/response.rb
 - lib/resourceful/util.rb
-- lib/resourceful/options_interpreter.rb
+- lib/resourceful/abstract_form_data.rb
 - lib/resourceful/cache_manager.rb
 - lib/resourceful/request.rb
 - lib/resourceful/resource.rb
 - lib/resourceful/exceptions.rb
+- lib/resourceful/multipart_form_data.rb
 - lib/resourceful/http_accessor.rb
 - lib/resourceful/authentication_manager.rb
 - README.markdown
 files: 
 - lib/resourceful.rb
 - lib/resourceful/net_http_adapter.rb
+- lib/resourceful/options_interpretation.rb
 - lib/resourceful/stubbed_resource_proxy.rb
+- lib/resourceful/urlencoded_form_data.rb
 - lib/resourceful/header.rb
 - lib/resourceful/memcache_cache_manager.rb
 - lib/resourceful/response.rb
 - lib/resourceful/util.rb
-- lib/resourceful/options_interpreter.rb
+- lib/resourceful/abstract_form_data.rb
 - lib/resourceful/cache_manager.rb
 - lib/resourceful/request.rb
 - lib/resourceful/resource.rb
 - lib/resourceful/exceptions.rb
+- lib/resourceful/multipart_form_data.rb
 - lib/resourceful/http_accessor.rb
 - lib/resourceful/authentication_manager.rb
+- History.txt
+- resourceful.gemspec
 - README.markdown
 - MIT-LICENSE
 - Rakefile
@@ -123,8 +131,12 @@ files:
 - spec/acceptance/resource_spec.rb
 - spec/acceptance/caching_spec.rb
 - spec/acceptance/redirecting_spec.rb
+- spec/resourceful/multipart_form_data_spec.rb
+- spec/resourceful/header_spec.rb
+- spec/resourceful/resource_spec.rb
+- spec/resourceful/urlencoded_form_data_spec.rb
+- spec/caching_spec.rb
 - spec/spec.opts
-- resourceful.gemspec
 has_rdoc: true
 homepage: http://github.com/paul/resourceful
 licenses: []

data/lib/resourceful/options_interpreter.rb

@@ -1,78 +0,0 @@
-require 'set'
-
-module Resourceful
-  # Class that supports a declarative way to pick apart an options
-  # hash.
-  #
-  #     OptionsInterpreter.new do 
-  #       option(:accept) { |accept| [accept].flatten.map{|m| m.to_str} }
-  #       option(:http_header_fields, :default => {})
-  #     end.interpret(:accept => 'this/that')
-  #     # => {:accept => ['this/that'], :http_header_fields => { } }
-  #
-  # The returned hash contains :accept with the pass accept option
-  # value transformed into an array and :http_header_fields with its
-  # default value.
-  #     
-  #     OptionsInterpreter.new do 
-  #       option(:max_redirects)
-  #     end.interpret(:foo => 1, :bar => 2)
-  #     # Raises ArgumentError: Unrecognized options: foo, bar
-  #
-  # If options are passed that are not defined an exception is raised.
-  #
-  class OptionsInterpreter
-    def self.interpret(options_hash, &block)
-      interpreter = self.new(options_hash)
-      interpreter.instance_eval(&block)
-      
-      interpreter.interpret
-    end      
-    
-    def initialize(&block)
-      @handlers = Hash.new
-      
-      instance_eval(&block) if block_given?
-    end
-    
-    def interpret(options_hash, &block) 
-      unless (unrecognized_options = (options_hash.keys - supported_options)).empty?
-        raise ArgumentError, "Unrecognized options: #{unrecognized_options.join(", ")}"
-      end
-      
-      options = Hash.new
-      handlers.each do |opt_name, a_handler|
-        opt_val = a_handler.call(options_hash)
-        options[opt_name] = opt_val if opt_val
-      end
-      
-      yield(options) if block_given?
-      
-      options
-    end
-    
-    def option(name, opts = {}, &block)
-
-      passed_value_fetcher = if opts[:default] 
-                               default_value = opts[:default]
-                               lambda{|options_hash| options_hash[name] || default_value}
-                             else
-                               lambda{|options_hash| options_hash[name]}
-                             end
-      
-      handlers[name] = if block_given?
-                         lambda{|options_hash| (val = passed_value_fetcher.call(options_hash)) ? block.call(val) : nil}
-                       else
-                         passed_value_fetcher
-                       end
-    end
-    
-    def supported_options
-      handlers.keys
-    end
-    
-    private
-    
-    attr_reader :handlers
-  end
-end