openlogic-resourceful 1.2.0

data/spec/resourceful/header_spec.rb

@@ -0,0 +1,153 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+
+module Resourceful
+  describe Header do 
+    def self.should_support_header(name)
+      const_name = name.upcase.gsub('-', '_')
+      meth_name  = name.downcase.gsub('-', '_')
+
+      eval <<-RUBY
+      it "should have constant `#{const_name}` for header `#{name}`" do 
+        Resourceful::Header::#{const_name}.should == '#{name}'
+      end
+
+      it "should have accessor method `#{meth_name}` for header `#{name}`" do 
+        Resourceful::Header.new.should respond_to(:#{meth_name})
+      end
+
+    RUBY
+    end
+
+    should_support_header('Accept')
+    should_support_header('Accept-Charset')
+    should_support_header('Accept-Encoding')
+    should_support_header('Accept-Language')
+    should_support_header('Accept-Ranges')
+    should_support_header('Age')
+    should_support_header('Allow')
+    should_support_header('Authorization')
+    should_support_header('Cache-Control')
+    should_support_header('Connection')
+    should_support_header('Content-Encoding')
+    should_support_header('Content-Language')
+    should_support_header('Content-Length')
+    should_support_header('Content-Location')
+    should_support_header('Content-MD5')
+    should_support_header('Content-Range')
+    should_support_header('Content-Type')
+    should_support_header('Date')
+    should_support_header('ETag')
+    should_support_header('Expect')
+    should_support_header('Expires')
+    should_support_header('From')
+    should_support_header('Host')
+    should_support_header('If-Match')
+    should_support_header('If-Modified-Since')
+    should_support_header('If-None-Match')
+    should_support_header('If-Range')
+    should_support_header('If-Unmodified-Since')
+    should_support_header('Keep-Alive')
+    should_support_header('Last-Modified')
+    should_support_header('Location')
+    should_support_header('Max-Forwards')
+    should_support_header('Pragma')
+    should_support_header('Proxy-Authenticate')
+    should_support_header('Proxy-Authorization')
+    should_support_header('Range')
+    should_support_header('Referer')
+    should_support_header('Retry-After')
+    should_support_header('Server')
+    should_support_header('TE')
+    should_support_header('Trailer')
+    should_support_header('Transfer-Encoding')
+    should_support_header('Upgrade')
+    should_support_header('User-Agent')
+    should_support_header('Vary')
+    should_support_header('Via')
+    should_support_header('Warning')
+    should_support_header('WWW-Authenticate')
+
+
+    it "should be instantiatable w/ single valued header fields" do 
+      Header.new('Host' => 'foo.example').
+        host.should eql('foo.example')
+    end
+
+    it "should gracefully handle repeated values for single valued header fields" do 
+      lambda {
+        Header.new('Host' => ['foo.example', 'bar.example'])
+      }.should raise_error(ArgumentError, 'Host field may only have one value')
+    end
+
+    it "should provide #each_fields to iterate through all header fields and values as strings" do 
+      field_names = []
+      Header.new('Accept' => "this", :content_type => "that", 'pragma' => 'test').each_field do |fname, _|
+        field_names << fname
+      end
+
+      field_names.should include('Accept')
+      field_names.should include('Content-Type')
+      field_names.should include('Pragma')
+      field_names.should have(3).items
+    end
+
+    it "should provide #to_hash as a way to dump the header fields" do 
+      Header.new('Accept' => "this", :content_type => "that", 'date' => 'today').to_hash.tap do |h|
+        h.should have_pair('Accept', ['this'])
+        h.should have_pair('Content-Type', 'that')
+        h.should have_pair('Date', 'today')
+      end
+    end
+
+    it "should provide a list of hop-by-hop fields" do
+      Header.header_field('X-Hop-By-Hop-Header', :hop_by_hop => true)
+      Header.hop_by_hop_fields.should include('X-Hop-By-Hop-Header')
+    end
+
+    it "should provide a list of not modified fields" do
+      Header.header_field('X-Dont-Modify-Me', :modifiable => false)
+      Header.non_modifiable_fields.should include('X-Dont-Modify-Me')
+    end
+
+    describe "multi-valued fields" do
+      it "should be instantiatable w/ repeated multi-valued header fields" do
+        Header.new('Accept' => ['application/foo', 'application/bar']).
+          accept.should eql(['application/foo', 'application/bar'])
+      end
+
+      it "should be instantiatable w/ repeated multi-valued header fields w/ multiple values" do
+        Header.new('Accept' => ['application/foo, application/bar', 'text/plain']).
+          accept.should eql(['application/foo', 'application/bar', 'text/plain'])
+      end
+
+      it "should be instantiatable w/ multi-valued header fields w/ multiple values" do
+        Header.new('Accept' => 'application/foo, application/bar').
+          accept.should eql(['application/foo', 'application/bar'])
+      end
+
+      it "should be instantiatable w/ multi-valued header fields w/ one value" do 
+        Header.new('Accept' => 'application/foo').
+          accept.should eql(['application/foo'])
+      end
+
+      it "should provide values to #each_field as a comma separated string" do 
+        Header.new('Accept' => ['this', 'that']).each_field do |fname, fval|
+          fval.should == 'this, that'
+        end
+      end
+
+      it "should provide #each as a way to iterate through fields as w/ higher level values" do
+        Header.new('Accept' => ['this', 'that']).each do |fname, fval|
+          fval.should == ['this', 'that']
+        end
+      end
+    end
+
+    Spec::Matchers.define :have_pair do |name, value|
+      match do |header_hash|
+        header_hash.has_key?(name)
+        header_hash[name] == value
+      end
+    end    
+  end
+end

data/spec/resourceful/http_accessor_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+require "resourceful/http_accessor"
+
+module Resourceful
+  describe HttpAccessor do 
+    describe "instantiation" do 
+      it "should accept logger option" do 
+        test_logger = stub('logger', :debug => false)
+        ha = HttpAccessor.new(:logger => test_logger)
+        ha.logger.should equal(test_logger)
+      end
+
+      it "should accept array user_agent option" do 
+        ha = HttpAccessor.new(:user_agent => ['foo/3.2', 'bar/1.0'])
+        ha.user_agent_string.should match(/^foo\/3.2 bar\/1.0 Resourceful/)
+      end
+
+      it "should accept string user_agent option" do 
+        ha = HttpAccessor.new(:user_agent => 'foo')
+        ha.user_agent_string.should match(/^foo Resourceful/)
+      end
+
+      it "should accept cache_manager option" do 
+        test_cache_manager = stub('cache_manager', :debug => false)
+        ha = HttpAccessor.new(:cache_manager => test_cache_manager)
+        ha.cache_manager.should equal(test_cache_manager)
+      end
+
+      it "should accept http_adapter option" do 
+        test_http_adapter = stub('http_adapter', :debug => false)
+        ha = HttpAccessor.new(:http_adapter => test_http_adapter)
+        ha.http_adapter.should equal(test_http_adapter)
+      end
+
+      it "should accept authenticator option" do 
+        test_authenticator = stub('authenticator', :debug => false)
+        ha = HttpAccessor.new(:authenticator => test_authenticator)
+        # cannot really be tested safely so we just rely on the fact that the option was accepted
+      end
+
+      it "should accept authenticators option" do 
+        test_authenticator1 = stub('authenticator1', :debug => false)
+        test_authenticator2 = stub('authenticator2', :debug => false)
+        ha = HttpAccessor.new(:authenticator => [test_authenticator1, test_authenticator2])
+        # cannot really be tested safely so we just rely on the fact that the option was accepted
+      end
+
+      it "should reject unrecognized options" do 
+        lambda {
+          HttpAccessor.new(:not_a_valid_option => "this")
+        }.should raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/resourceful/multipart_form_data_spec.rb

@@ -0,0 +1,84 @@
+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
+
+  it "should allow simple parameters to be added" do 
+    @form_data.add(:foo, "testing")
+  end
+
+  describe "with multiple simple parameters" do 
+    before do 
+      @form_data.add('foo', 'bar')
+      @form_data.add('baz', 'this')
+    end
+
+    it "should render a multipart form-data document when #read is called" do 
+      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
+
+    it "should be rewindable" do 
+      first_read = @form_data.read
+      @form_data.rewind
+      @form_data.read.should eql(first_read)
+    end
+
+    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
+  end
+
+  describe "with file parameter" do 
+    before do 
+      @file_to_upload = Tempfile.new('resourceful-post-file-tests')
+      @file_to_upload << "This is a test"
+      @file_to_upload.flush
+        
+      @form_data.add_file(:foo, @file_to_upload.path)
+    end
+
+    it "should render a multipart form-data document when #read is called" do 
+      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
+

data/spec/resourceful/promiscuous_basic_authenticator_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+describe Resourceful::PromiscuousBasicAuthenticator do 
+  before do 
+    @authenticator = Resourceful::PromiscuousBasicAuthenticator.new('jim', 'mypasswd')
+  end
+
+  it "should always claim to be valid for a challenge response" do 
+    challenge_resp = mock("a challenge response")
+    @authenticator.valid_for?(challenge_resp).should eql(true)
+  end
+
+  it "should always claim to handle any request" do 
+    a_req = mock("a  request")
+    @authenticator.valid_for?(a_req).should eql(true)
+  end
+
+  it "be creatable with just a username and password" do 
+    Resourceful::PromiscuousBasicAuthenticator.new('jim', 'mypasswd').should be_instance_of(Resourceful::PromiscuousBasicAuthenticator)
+  end
+
+  it "add credentials to request" do 
+    header = mock('header')
+    header.should_receive(:[]=).with("Authorization", "Basic amltOm15cGFzc3dk")
+    a_req = mock("a  request", :header => header)
+
+    @authenticator.add_credentials_to(a_req)
+  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/response_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+require 'resourceful/response'
+require 'resourceful/header'
+
+module Resourceful
+  describe Response do 
+    
+    it "should know when it is expired" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=2', 'Date' => (Time.now - 2).httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.expired?.should be_true
+    end
+
+    it "should know when it is not expired" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=1', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.expired?.should be_false
+    end
+
+    it "know when it is stale due to expiration" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=1', 'Date' => (Time.now - 2).httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_true
+    end
+
+    it "know when it is stale due to no-cache" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'no-cache', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_true
+    end
+
+    it "know when it is stale due to must-revalidate" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'must-revalidate', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_true
+    end
+
+    it "know when it is not stale" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=1', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_false
+    end
+  end
+end

data/spec/resourceful/urlencoded_form_data_spec.rb

@@ -0,0 +1,64 @@
+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
+
+  it "should allow simple parameters to be added" do 
+    @form_data.add(:foo, "testing")
+  end
+
+  describe "with multiple items" do 
+    before do 
+      @form_data.add('foo', 'bar')
+      @form_data.add('baz', 'this')
+    end
+
+    it "should render itself correctly" do 
+      @form_data.read.should eql("foo=bar&baz=this")
+    end
+
+    it "should be rewindable" do 
+      first = @form_data.read
+      @form_data.rewind
+      
+      @form_data.read.should eql(first)
+    end    
+  end
+
+  describe "with unsafe characters in name" do 
+    before do 
+      @form_data.add('foo=bar', 'this')
+    end
+
+    it "should render itself correctly" do 
+      @form_data.read.should eql("foo%3Dbar=this")
+    end
+  end
+
+
+  describe "with unsafe characters in value" do 
+    before do 
+      @form_data.add('foo', 'this & that')
+    end
+
+    it "should render itself correctly" do 
+      @form_data.read.should eql("foo=this+%26+that")
+    end
+  end
+
+end