http_headers 0.0.2.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin S. Leitgeb
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,61 @@
+= HttpHeaders
+
+HttpHeaders is a library for parsing HTTP-compliant header strings.  It was designed to process the 
+results from the header_str method on Curl::Easy objects in Ruby, but should work for other HTTP-compliant
+string formats. 
+
+It correctly parses the content type, response code and most other key-value fields from the HTTP response header,
+including keys that may appear multiple times in the header such as Set-Cookie.
+
+While parsing these header strings seems a very easy thing to do, the small variances in HTTP server responses make 
+it more challenging to process these strings than it may initially appear.  This library tries to account for these
+server variances by including a comprehensive test suite of HTTP header strings that the library has been tested
+against.
+
+== Installation
+
+Set up your machine to pull gems from gems.github.com if you haven't already.  Then:
+  
+  sudo gem install jsl-http_headers
+
+== Quick Start
+
+Just require the library, create a new HttpHeaders object with the header string and start invoking methods.
+
+  require 'http_headers'
+  h = HttpHeaders.new(header_str)
+  h.content_type
+  h.etag
+  h.set_cookie # Will return an Array of String values if more than one match is found
+
+Other methods should just work for arbitrary attributes by lowercasing the attribute name and substituting 
+hyphens with underscores.
+
+== Implementation Notes
+
+HttpHeaders uses ruby's +method_missing+ in order to build queries for the given parameter dynamically, so
+it doesn't need to parse values for every field at the time that the HttpHeader object is instantiated with 
+a HTTP header string.
+
+== Possible Limitations
+
+Some attributes, such as Set-Cookie, may appear listed multiple times in the header.  Where this occurs, 
+we try to find all instances of the key and return an Array if multiple occurrences are found.  Otherwise,
+nothing is done in the case where there are multiple values for a cookie given as values of a particular key - 
+at this point the values won't be magically turned into an Array and it will be up to the user to program the
+desired behavior in a client library.  
+
+== Feedback
+
+Please write the author if you have any questions or feedback about this library.  Patches are welcome if you have ideas 
+about how the behavior of HttpHeaders can be improved for particular cases.  Please include specs using the associated 
+test suite if you make improvements, and I would also be happy to receive more fixtures consisting of HTTP strings of 
+failure cases indicating where the library can be improved.
+
+== References
+
+* The HTTP Header Field Definitions - http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
+
+== Author
+
+Justin S. Leitgeb, <justin@phq.org>

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'spec'
+
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc 'Test the plugin.'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts  = ["--format", "specdoc", "--colour"]
+  t.libs << 'lib'
+  t.verbose = true
+end
+
+desc "Run all the tests"
+task :default => :spec
+
+desc 'Generate documentation for the hashback plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HTTP Headers'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/http_headers.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |s|
+  s.name     = "http_headers"
+  s.version  = "0.0.2.2"
+  s.date     = "2009-05-25"
+  s.summary  = "Library for parsing the Curl header_str into attributes"
+  s.email    = "justin@phq.org"
+  s.homepage = "http://github.com/jsl/http_headers"
+  s.description = "Parses a HTTP header string into individual header fields"
+  s.has_rdoc = true
+  s.authors  = ["Justin Leitgeb"]
+  s.files    = [
+    "Rakefile",
+    "http_headers.gemspec",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "spec/http_headers_spec.rb",
+    "spec/fixtures/headers.txt",
+    "spec/fixtures/headers2.txt",
+    "spec/fixtures/headers3.txt",
+    "lib/http_headers.rb"
+  ]
+  s.test_files = [
+    "spec/http_headers_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  
+  s.extra_rdoc_files = [ "README.rdoc" ]
+  
+  s.rdoc_options += [
+    '--title', 'HttpHeaders',
+    '--main', 'README.rdoc',
+    '--line-numbers',
+    '--inline-source'
+   ]
+end

data/lib/http_headers.rb

@@ -0,0 +1,44 @@
+# Class HttpHeaders parses a http header_str from Curl::Easy into component parts.
+class HttpHeaders
+  
+  attr_reader :content
+    
+  def initialize(str)
+    @content = str.split(/\\r\\n|\n|\r/)
+  end
+
+  def version
+    @content[0].match(/HTTP\/\d\.\d/)[0]
+  end
+  
+  def response_code
+    @content[0].match(/HTTP\/\d\.\d (\d{3}.*)/)[1]
+  end
+
+  def method_missing(sym, *args)
+    detect_multi_value_keys(sym)
+  end
+  
+  private
+  
+  # Turns the given sym into a String after replacing the '_' character with the '-'
+  def method_sym_to_http_key(sym)
+    sym.to_s.gsub('_', '-')
+  end
+  
+  def detect_multi_value_keys(tag)
+    tag = method_sym_to_http_key(tag)
+    regexp = /^#{tag}:/i
+    results = @content.select{|e| e =~ regexp }.map{|e| value_from(e)}
+    results.size <= 1 ? results.first : results
+  end
+  
+  # Returns the key from this tag, which should be a string with key separated
+  # from val by ':'
+  def value_from(tag)
+    val = tag.split(/:\s+/)[1]
+    
+    # Value may be surrounded by quotes in some cases.  Remove these extra quotes here.
+    val =~ /^\"(.*)\"$/ ? $1 : val
+  end
+end

data/spec/fixtures/headers.txt

@@ -0,0 +1 @@
+HTTP/1.1 200 OK\r\nServer: Sun-ONE-Web-Server/6.1\r\nDate: Fri, 22 May 2009 12:53:02 GMT\r\nContent-type: text/html\r\nSet-cookie: RMID=21167df34c454a16a02ee2e1; expires=Saturday, 22-May-2010 12:53:02 GMT; path=/; domain=.nytimes.com\r\nSet-cookie: adxcs=-; path=/; domain=.nytimes.com\r\nSet-cookie: adxcs=-; path=/; domain=.nytimes.com\r\nExpires: Thu, 01 Dec 1994 16:00:00 GMT\r\nCache-control: no-cache\r\nPragma: no-cache\r\nTransfer-encoding: chunked\r\n\r\n

data/spec/fixtures/headers2.txt

@@ -0,0 +1,11 @@
+HTTP/1.1 200 OK
+Last-Modified: Fri, 22 May 2009 15:35:08 GMT
+ETag: pnDSjJtGvlc2WrX6VND/w0qxEc8
+Content-Type: text/xml; charset=utf-8
+Date: Fri, 22 May 2009 18:18:08 GMT
+Expires: Fri, 22 May 2009 18:18:08 GMT
+Cache-Control: private, max-age=0
+X-Content-Type-Options: nosniff
+Server: GFE/2.0
+Transfer-Encoding: chunked
+

data/spec/fixtures/headers3.txt

@@ -0,0 +1,13 @@
+HTTP/1.1 200 OK
+Date: Mon, 25 May 2009 12:36:53 GMT
+Server: Apache/2
+Last-Modified: Wed, 01 Sep 2004 13:24:52 GMT
+ETag: "1edec-3e3073913b100"
+Accept-Ranges: bytes
+Content-Length: 126444
+Cache-Control: max-age=21600
+Expires: Mon, 25 May 2009 18:36:53 GMT
+P3P: policyref="http://www.w3.org/2001/05/P3P/p3p.xml"
+Connection: close
+Content-Type: text/html; charset=iso-8859-1
+

data/spec/http_headers_spec.rb

@@ -0,0 +1,77 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe HttpHeaders do
+  before do
+    @h  = HttpHeaders.new(File.read(File.join(File.dirname(__FILE__), %w[fixtures headers.txt])))
+    @h2 = HttpHeaders.new(File.read(File.join(File.dirname(__FILE__), %w[fixtures headers2.txt])))
+    @h3 = HttpHeaders.new(File.read(File.join(File.dirname(__FILE__), %w[fixtures headers3.txt])))
+  end
+  
+  it "should have text/html as the content_type" do
+    @h.version.should == 'HTTP/1.1'
+  end
+  
+  it "should have 200 OK as the response code" do 
+    @h.response_code.should == '200 OK'
+  end
+  
+  it "should have a nil etag for the first header file" do
+    @h.etag.should be_nil
+  end
+  
+  it "should have an etag of pnDSjJtGvlc2WrX6VND/w0qxEc8" do
+    @h2.etag.should == 'pnDSjJtGvlc2WrX6VND/w0qxEc8'
+  end
+  
+  # @h3 tests stripping an etag from a value section of a header where the value is wrapped in 
+  # quotes as given by the HTTP server.
+  it "should have an etag of 1edec-3e3073913b100 for headers3" do
+    @h3.etag.should == '1edec-3e3073913b100'
+  end
+  
+  it "should have Fri, 22 May 2009 18:18:08 GMT for date" do
+    @h2.date.should == 'Fri, 22 May 2009 18:18:08 GMT'
+  end
+  
+  it "should have Fri, 22 May 2009 18:18:08 GMT for expires" do
+    @h2.expires.should == 'Fri, 22 May 2009 18:18:08 GMT'
+  end
+  
+  it "should have private, max-age=0 for cache_control" do
+    @h2.cache_control.should == 'private, max-age=0'
+  end
+  
+  it "should have Fri, 22 May 2009 15:35:08 GMT for last_modified" do
+    @h2.last_modified.should == 'Fri, 22 May 2009 15:35:08 GMT'
+  end
+  
+  it "should have GFE/2.0 for server" do
+    @h2.server.should == 'GFE/2.0'
+  end  
+  
+  it "should have no-cache for pragma" do
+    @h.pragma.should == 'no-cache'
+  end
+  
+  it "should have chunked for transfer_encoding" do
+    @h2.transfer_encoding.should == 'chunked'
+  end
+  
+  describe "multi-valued keys like Set-cookie:" do
+    before do
+      @c = @h.set_cookie
+    end
+    
+    it "should return an Array if multiple values are present" do
+      @c.should be_a(Array)
+    end
+    
+    it "should have three cookies" do
+      @c.size.should == 3
+    end
+    
+    it "should have adxcs=-; path=/; domain=.nytimes.com as value for one cookie" do
+      @c.include?("adxcs=-; path=/; domain=.nytimes.com").should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'mocha'
+require 'spec'
+
+Spec::Runner.configure do |config|
+  config.mock_with(:mocha)
+end
+
+require File.join(File.dirname(__FILE__), %w[.. lib http_headers])

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: http_headers
+version: !ruby/object:Gem::Version 
+  hash: 67
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  - 2
+  version: 0.0.2.2
+platform: ruby
+authors: 
+- Justin Leitgeb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Parses a HTTP header string into individual header fields
+email: justin@phq.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- http_headers.gemspec
+- LICENSE
+- README.rdoc
+- spec/http_headers_spec.rb
+- spec/fixtures/headers.txt
+- spec/fixtures/headers2.txt
+- spec/fixtures/headers3.txt
+- lib/http_headers.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jsl/http_headers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- HttpHeaders
+- --main
+- README.rdoc
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Library for parsing the Curl header_str into attributes
+test_files: 
+- spec/http_headers_spec.rb
+- spec/spec_helper.rb