httpclient_link_header 0.0.1

data/lib/httpclient_link_header.rb

@@ -0,0 +1,77 @@
+require 'httpclient'
+
+module HTTP
+  class LinkHeaders
+    PARAM_REG = /(\w+)=['"](\w+)['"]/
+    LINK_REG = /<(.+)>((?:; \w+=['"]\w+['"])*)/
+
+    def self.parse(link_headers)
+      unless link_headers.empty?
+        new(parse_link_headers(link_headers))
+      end
+    end
+
+    def self.generate(links)
+      links.map do |link|
+        params = (link['params'] || []).map { |key, value| "; #{key}=\"#{value}\"" }.join
+        "<#{link['uri']}>#{params}"
+      end
+    end
+
+    def initialize(parsed_headers)
+      @parsed_headers = parsed_headers
+    end
+
+    def by(param)
+      index_by(param, @parsed_headers)
+    end
+
+    private
+
+    def self.parse_link_header(link_header)
+      parsed = {}
+      match = LINK_REG.match(link_header)
+      uri, params = match.captures
+      parsed['uri'] = uri
+      params_split = params.split(";").reject(&:empty?).map(&:strip)
+      parsed['params'] = params_split.inject({}) do |pout, param|
+        param_match = PARAM_REG.match(param)
+        key, value = param_match.captures
+        pout[key] = value
+        pout
+      end
+      parsed
+    end
+
+    def self.parse_link_headers(link_headers)
+      link_headers.map { |lh| parse_link_header(lh) }
+    end
+
+    def index_by(param, parsed_headers)
+      parsed_headers.inject({}) do |index, header|
+        param_value = header['params'][param]
+        if param_value
+          unless index.has_key?(param_value)
+            index[param_value] = []
+          end
+          index[param_value] << header
+        end
+        index
+      end
+    end
+  end
+
+  module MLinkHeaders
+    LINK_HEADER = "Link"
+
+    def links
+      LinkHeaders.parse(header[LINK_HEADER])
+    end
+
+    def links=(links)
+      header.set(LINK_HEADER, LinkHeaders.generate(links))
+    end
+  end
+end
+
+HTTP::Message.send(:include, HTTP::MLinkHeaders)

data/test/test_httpclient_link_header.rb

@@ -0,0 +1,36 @@
+require 'test/unit'
+require 'httpclient_link_header'
+require 'httpclient'
+
+class TestLinkHeader < Test::Unit::TestCase
+  def test_link_header_parsing
+    expected = "compact.css"
+    resp = HTTP::Message.new_response(nil)
+    resp.header['Link'] = '<compact.css>; rel="stylesheet"; title="hello"'
+
+    assert_equal(expected, resp.links.by('rel').fetch('stylesheet').first['uri'])
+    assert_equal(expected, resp.links.by('title').fetch('hello').first['uri'])
+  end
+
+  def test_link_header_parsing_with_no_links
+    resp = HTTP::Message.new_response(nil)
+
+    assert_equal(nil, resp.links)
+  end
+
+  def test_link_header_generation
+    with_params = '<compact.css>; rel="stylesheet"; title="hello"'
+    without_params = '<compact.css>'
+
+    resp = HTTP::Message.new_request('GET', '/')
+    resp.links = [
+      {'uri' => 'compact.css', 'params' => {'rel' => 'stylesheet', 'title' => 'hello'}},
+      {'uri' => 'compact.css'}
+    ]
+    links = resp.header['Link']
+
+    assert_equal(2, links.size)
+    assert_equal(with_params, links[0])
+    assert_equal(without_params, links[1])
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: httpclient_link_header
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- TempoDB, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parse and process W3C compliant Link headers within HTTPClient (http://www.w3.org/Protocols/9707-link-header.html)
+email: software@tempo-db.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/httpclient_link_header.rb
+- test/test_httpclient_link_header.rb
+homepage: http://tempo-db.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: HTTPClient Link Header Parser
+test_files:
+- test/test_httpclient_link_header.rb