rubysl-net-http 0.0.1 → 1.0.0

data/spec/httpheader/shared/set_content_type.rb

@@ -0,0 +1,20 @@
+describe :net_httpheader_set_content_type, :shared => true do
+  describe "when passed type, params" do
+    before(:each) do
+      @headers = NetHTTPHeaderSpecs::Example.new
+    end
+
+    it "sets the 'Content-Type' header entry based on the passed type and params" do
+      @headers.send(@method, "text/html")
+      @headers["Content-Type"].should == "text/html"
+
+      @headers.send(@method, "text/html", "charset" => "utf-8")
+      @headers["Content-Type"].should == "text/html; charset=utf-8"
+
+      @headers.send(@method, "text/html", "charset" => "utf-8", "rubyspec" => "rocks")
+      @headers["Content-Type"].should =~ %r[text/html]
+      @headers["Content-Type"].should =~ %r[charset=utf-8]
+      @headers["Content-Type"].should =~ %r[rubyspec=rocks]
+    end
+  end
+end

data/spec/httpheader/shared/set_form_data.rb

@@ -0,0 +1,27 @@
+describe :net_httpheader_set_form_data, :shared => true do
+  before(:each) do
+    @headers = NetHTTPHeaderSpecs::Example.new
+  end
+
+  describe "when passed params" do
+    it "automatically set the 'Content-Type' to 'application/x-www-form-urlencoded'" do
+      @headers.send(@method, "cmd" => "search", "q" => "ruby", "max" => "50")
+      @headers["Content-Type"].should == "application/x-www-form-urlencoded"
+    end
+
+    it "sets self's body based on the passed form parameters" do
+      @headers.send(@method, "cmd" => "search", "q" => "ruby", "max" => "50")
+      @headers.body.split("&").sort.should == ["cmd=search", "max=50", "q=ruby"]
+    end
+  end
+
+  describe "when passed params, separator" do
+    it "sets self's body based on the passed form parameters and the passed separator" do
+      @headers.send(@method, {"cmd" => "search", "q" => "ruby", "max" => "50"}, "&")
+      @headers.body.split("&").sort.should == ["cmd=search", "max=50", "q=ruby"]
+
+      @headers.send(@method, {"cmd" => "search", "q" => "ruby", "max" => "50"}, ";")
+      @headers.body.split(";").sort.should == ["cmd=search", "max=50", "q=ruby"]
+    end
+  end
+end

data/spec/httpheader/shared/set_range.rb

@@ -0,0 +1,89 @@
+describe :net_httpheader_set_range, :shared => true do
+  before(:each) do
+    @headers = NetHTTPHeaderSpecs::Example.new
+  end
+
+  describe "when passed nil" do
+    it "returns nil" do
+      @headers.send(@method, nil).should be_nil
+    end
+
+    it "deletes the 'Range' header entry" do
+      @headers["Range"] = "bytes 0-499/1234"
+      @headers.send(@method, nil)
+      @headers["Range"].should be_nil
+    end
+  end
+
+  describe "when passed Numeric" do
+    it "sets the 'Range' header entry based on the passed Numeric" do
+      @headers.send(@method, 10)
+      @headers["Range"].should == "bytes=0-9"
+
+      @headers.send(@method, -10)
+      @headers["Range"].should == "bytes=-10"
+
+      @headers.send(@method, 10.9)
+      @headers["Range"].should == "bytes=0-9"
+    end
+  end
+
+  describe "when passed Range" do
+    it "sets the 'Range' header entry based on the passed Range" do
+      @headers.send(@method, 10..200)
+      @headers["Range"].should == "bytes=10-200"
+
+      @headers.send(@method, 1..5)
+      @headers["Range"].should == "bytes=1-5"
+
+      @headers.send(@method, 1...5)
+      @headers["Range"].should == "bytes=1-4"
+
+      @headers.send(@method, 234..567)
+      @headers["Range"].should == "bytes=234-567"
+
+      @headers.send(@method, -5..-1)
+      @headers["Range"].should == "bytes=-5"
+
+      @headers.send(@method, 1..-1)
+      @headers["Range"].should == "bytes=1-"
+    end
+
+    it "raises a Net::HTTPHeaderSyntaxError when the first Range element is negative" do
+      lambda { @headers.send(@method, -10..5) }.should raise_error(Net::HTTPHeaderSyntaxError)
+    end
+
+    it "raises a Net::HTTPHeaderSyntaxError when the last Range element is negative" do
+      lambda { @headers.send(@method, 10..-5) }.should raise_error(Net::HTTPHeaderSyntaxError)
+    end
+
+    it "raises a Net::HTTPHeaderSyntaxError when the last Range element is smaller than the first" do
+      lambda { @headers.send(@method, 10..5) }.should raise_error(Net::HTTPHeaderSyntaxError)
+    end
+  end
+
+  describe "when passed start, end" do
+    it "sets the 'Range' header entry based on the passed start and length values" do
+      @headers.send(@method, 10, 200)
+      @headers["Range"].should == "bytes=10-209"
+
+      @headers.send(@method, 1, 5)
+      @headers["Range"].should == "bytes=1-5"
+
+      @headers.send(@method, 234, 567)
+      @headers["Range"].should == "bytes=234-800"
+    end
+
+    it "raises a Net::HTTPHeaderSyntaxError when start is negative" do
+      lambda { @headers.send(@method, -10, 5) }.should raise_error(Net::HTTPHeaderSyntaxError)
+    end
+
+    it "raises a Net::HTTPHeaderSyntaxError when start + length is negative" do
+      lambda { @headers.send(@method, 10, -15) }.should raise_error(Net::HTTPHeaderSyntaxError)
+    end
+
+    it "raises a Net::HTTPHeaderSyntaxError when length is negative" do
+      lambda { @headers.send(@method, 10, -4) }.should raise_error(Net::HTTPHeaderSyntaxError)
+    end
+  end
+end

data/spec/httpheader/shared/size.rb

@@ -0,0 +1,18 @@
+describe :net_httpheader_size, :shared => true do
+  before(:each) do
+    @headers = NetHTTPHeaderSpecs::Example.new
+  end
+
+  it "returns the number of header entries in self" do
+    @headers.send(@method).should eql(0)
+
+    @headers["a"] = "b"
+    @headers.send(@method).should eql(1)
+
+    @headers["b"] = "b"
+    @headers.send(@method).should eql(2)
+
+    @headers["c"] = "c"
+    @headers.send(@method).should eql(3)
+  end
+end

data/spec/httpheader/size_spec.rb

@@ -0,0 +1,7 @@
+require 'net/http'
+require File.expand_path('../fixtures/classes', __FILE__)
+require File.expand_path('../shared/size', __FILE__)
+
+describe "Net::HTTPHeader#size" do
+  it_behaves_like :net_httpheader_size, :size
+end

data/spec/httpheader/sub_type_spec.rb

@@ -0,0 +1,31 @@
+require 'net/http'
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Net::HTTPHeader#sub_type" do
+  before(:each) do
+    @headers = NetHTTPHeaderSpecs::Example.new
+  end
+
+  it "returns the 'sub-content-type', as per 'Content-Type' header entry" do
+    @headers["Content-Type"] = "text/html"
+    @headers.sub_type.should == "html"
+
+    @headers["Content-Type"] = "application/pdf"
+    @headers.sub_type.should == "pdf"
+
+    @headers["Content-Type"] = "text/html;charset=utf-8"
+    @headers.sub_type.should == "html"
+  end
+
+  it "returns nil if no 'sub-content-type' is set" do
+    @headers["Content-Type"] = "text"
+    @headers.sub_type.should be_nil
+
+    @headers["Content-Type"] = "text;charset=utf-8"
+    @headers.sub_type.should be_nil
+  end
+
+  it "returns nil if the 'Content-Type' header entry does not exist" do
+    @headers.sub_type.should be_nil
+  end
+end

data/spec/httpheader/to_hash_spec.rb

@@ -0,0 +1,24 @@
+require 'net/http'
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Net::HTTPHeader#to_hash" do
+  before(:each) do
+    @headers = NetHTTPHeaderSpecs::Example.new
+  end
+
+  it "returns a Hash representing all Header entries (keys in lower case, values as arrays)" do
+    @headers.to_hash.should == {}
+
+    @headers["My-Header"] = "test"
+    @headers.to_hash.should == { "my-header" => ["test"] }
+
+    @headers.add_field("My-Header", "another test")
+    @headers.to_hash.should == { "my-header" => ["test", "another test"] }
+  end
+
+  it "does not allow modifying the headers from the returned hash" do
+    @headers.to_hash["my-header"] = ["test"]
+    @headers.to_hash.should == {}
+    @headers.key?("my-header").should be_false
+  end
+end

data/spec/httpheader/type_params_spec.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "Net::HTTPHeader#type_params" do
+  before(:each) do
+    @headers = NetHTTPHeaderSpecs::Example.new
+  end
+
+  it "returns additional 'Content-Type' information as a Hash" do
+    @headers["Content-Type"] = "text/html;charset=utf-8"
+    @headers.type_params.should == {"charset" => "utf-8"}
+
+    @headers["Content-Type"] = "text/html; charset=utf-8; rubyspec=rocks"
+    @headers.type_params.should == {"charset" => "utf-8", "rubyspec" => "rocks"}
+  end
+
+  it "returns an empty Hash when no additional 'Content-Type' information is set" do
+    @headers.type_params.should == {}
+
+    @headers["Content-Type"] = "text/html"
+    @headers.type_params.should == {}
+  end
+end

data/spec/httprequest/initialize_spec.rb

@@ -0,0 +1,44 @@
+require 'net/http'
+
+module NetHTTPRequestSpecs
+  class TestRequest < Net::HTTPRequest
+    METHOD = "TEST"
+    REQUEST_HAS_BODY  = false
+    RESPONSE_HAS_BODY = true
+  end
+end
+
+describe "Net::HTTPRequest#initialize" do
+  before(:each) do
+    @req = NetHTTPRequestSpecs::TestRequest.allocate
+  end
+
+  it "uses the METHOD constants to set the request method" do
+    @req.send(:initialize, "/some/path")
+    @req.method.should == "TEST"
+  end
+
+  it "uses the REQUEST_HAS_BODY to set whether the Request has a body or not" do
+    @req.send(:initialize, "/some/path")
+    @req.request_body_permitted?.should be_false
+  end
+
+  it "uses the RESPONSE_HAS_BODY to set whether the Response can have a body or not" do
+    @req.send(:initialize, "/some/path")
+    @req.response_body_permitted?.should be_true
+  end
+
+  describe "when passed path" do
+    it "sets self's path to the passed path" do
+      @req.send(:initialize, "/some/path")
+      @req.path.should == "/some/path"
+    end
+  end
+
+  describe "when passed path, headers" do
+    it "uses the passed headers Hash to initialize self's header entries" do
+      @req.send(:initialize, "/some/path", "Content-Type" => "text/html")
+      @req["Content-Type"].should == "text/html"
+    end
+  end
+end

data/spec/httpresponse/body_permitted_spec.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+
+describe "Net::HTTPResponse.body_permitted?" do
+  it "returns true if this response type can have a response body" do
+    Net::HTTPUnknownResponse.body_permitted?.should == true
+    Net::HTTPInformation.body_permitted?.should == false
+    Net::HTTPSuccess.body_permitted?.should == true
+    Net::HTTPRedirection.body_permitted?.should == true
+    Net::HTTPClientError.body_permitted?.should == true
+    Net::HTTPServerError.body_permitted?.should == true
+  end
+end

data/spec/httpresponse/body_spec.rb

@@ -0,0 +1,6 @@
+require 'net/http'
+require File.expand_path('../shared/body', __FILE__)
+
+describe "Net::HTTPResponse#body" do
+  it_behaves_like :net_httpresponse_body, :body
+end

data/spec/httpresponse/code_spec.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+
+describe "Net::HTTPResponse#code" do
+  it "returns the result code string" do
+    res = Net::HTTPUnknownResponse.new("1.0", "???", "test response")
+    res.code.should == "???"
+
+    res = Net::HTTPInformation.new("1.0", "1xx", "test response")
+    res.code.should == "1xx"
+
+    res = Net::HTTPSuccess.new("1.0", "2xx", "test response")
+    res.code.should == "2xx"
+
+    res = Net::HTTPRedirection.new("1.0", "3xx", "test response")
+    res.code.should == "3xx"
+
+    res = Net::HTTPClientError.new("1.0", "4xx", "test response")
+    res.code.should == "4xx"
+
+    res = Net::HTTPServerError.new("1.0", "5xx", "test response")
+    res.code.should == "5xx"
+  end
+end

data/spec/httpresponse/code_type_spec.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+
+describe "Net::HTTPResponse#code_type" do
+  it "returns self's class" do
+    res = Net::HTTPUnknownResponse.new("1.0", "???", "test response")
+    res.code_type.should == Net::HTTPUnknownResponse
+
+    res = Net::HTTPInformation.new("1.0", "1xx", "test response")
+    res.code_type.should == Net::HTTPInformation
+
+    res = Net::HTTPSuccess.new("1.0", "2xx", "test response")
+    res.code_type.should == Net::HTTPSuccess
+
+    res = Net::HTTPRedirection.new("1.0", "3xx", "test response")
+    res.code_type.should == Net::HTTPRedirection
+
+    res = Net::HTTPClientError.new("1.0", "4xx", "test response")
+    res.code_type.should == Net::HTTPClientError
+
+    res = Net::HTTPServerError.new("1.0", "5xx", "test response")
+    res.code_type.should == Net::HTTPServerError
+  end
+end

data/spec/httpresponse/entity_spec.rb

@@ -0,0 +1,6 @@
+require 'net/http'
+require File.expand_path('../shared/body', __FILE__)
+
+describe "Net::HTTPResponse#entity" do
+  it_behaves_like :net_httpresponse_body, :entity
+end

data/spec/httpresponse/error_spec.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+
+describe "Net::HTTPResponse#error!" do
+  it "raises self's class 'EXCEPTION_TYPE' Exception" do
+    res = Net::HTTPUnknownResponse.new("1.0", "???", "test response")
+    lambda { res.error! }.should raise_error(Net::HTTPError)
+
+    res = Net::HTTPInformation.new("1.0", "1xx", "test response")
+    lambda { res.error! }.should raise_error(Net::HTTPError)
+
+    res = Net::HTTPSuccess.new("1.0", "2xx", "test response")
+    lambda { res.error! }.should raise_error(Net::HTTPError)
+
+    res = Net::HTTPRedirection.new("1.0", "3xx", "test response")
+    lambda { res.error! }.should raise_error(Net::HTTPRetriableError)
+
+    res = Net::HTTPClientError.new("1.0", "4xx", "test response")
+    lambda { res.error! }.should raise_error(Net::HTTPServerException)
+
+    res = Net::HTTPServerError.new("1.0", "5xx", "test response")
+    lambda { res.error! }.should raise_error(Net::HTTPFatalError)
+  end
+end

data/spec/httpresponse/error_type_spec.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+
+describe "Net::HTTPResponse#error_type" do
+  it "returns self's class 'EXCEPTION_TYPE' constant" do
+    res = Net::HTTPUnknownResponse.new("1.0", "???", "test response")
+    res.error_type.should == Net::HTTPError
+
+    res = Net::HTTPInformation.new("1.0", "1xx", "test response")
+    res.error_type.should == Net::HTTPError
+
+    res = Net::HTTPSuccess.new("1.0", "2xx", "test response")
+    res.error_type.should == Net::HTTPError
+
+    res = Net::HTTPRedirection.new("1.0", "3xx", "test response")
+    res.error_type.should == Net::HTTPRetriableError
+
+    res = Net::HTTPClientError.new("1.0", "4xx", "test response")
+    res.error_type.should == Net::HTTPServerException
+
+    res = Net::HTTPServerError.new("1.0", "5xx", "test response")
+    res.error_type.should == Net::HTTPFatalError
+  end
+end

data/spec/httpresponse/exception_type_spec.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+
+describe "Net::HTTPResponse.exception_type" do
+  it "returns self's 'EXCEPTION_TYPE' constant" do
+    Net::HTTPUnknownResponse.exception_type.should == Net::HTTPError
+    Net::HTTPInformation.exception_type.should == Net::HTTPError
+    Net::HTTPSuccess.exception_type.should == Net::HTTPError
+    Net::HTTPRedirection.exception_type.should == Net::HTTPRetriableError
+    Net::HTTPClientError.exception_type.should == Net::HTTPServerException
+    Net::HTTPServerError.exception_type.should == Net::HTTPFatalError
+  end
+end

data/spec/httpresponse/header_spec.rb

@@ -0,0 +1,8 @@
+require 'net/http'
+
+describe "Net::HTTPResponse#header" do
+  it "returns self" do
+    res = Net::HTTPUnknownResponse.new("1.0", "???", "test response")
+    res.response.should equal(res)
+  end
+end