link_header 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.1 2009-04-04
+
+* Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+link_header, Copyright (c) 2009 Mike Burrows
+ 
+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/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/link_header.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_link_header.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+link-header gem installed.  See README.rdoc in the installation directory or at http://github.com/asplake/link_header.

data/README.rdoc

@@ -0,0 +1,15 @@
+= link_header README
+
+Parse and format HTTP link headers as described in the draft spec http://tools.ietf.org/id/draft-nottingham-http-link-header-06.txt
+
+== Description
+
+Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations.
+
+== Installation
+
+  sudo gem install link-header
+
+== Author
+
+Mike Burrows (asplake), email mailto:mjb@asplake.co.uk, website positiveincline.com[http://positiveincline.com]

data/Rakefile

@@ -0,0 +1,36 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+$:.push File.dirname(__FILE__) + '/lib'
+require 'link_header'
+require 'hoe'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'link_header' do
+  developer('Mike Burrows', 'mjb@asplake.co.uk')
+  self.version = LinkHeader::VERSION
+  self.readme_file          = "README.rdoc"
+  self.changes              = paragraphs_of("History.txt", 0..1).join("\n\n")
+  self.rubyforge_name       = 'link-header'
+  self.url = 'http://github.com/asplake/link_header/tree'
+  self.extra_deps         = [
+  ]
+  self.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  self.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (rubyforge_name == name) ? rubyforge_name : "\#{rubyforge_name}/\#{name}"
+  self.remote_rdoc_dir = File.join(path.gsub(/^#{rubyforge_name}\/?/,''), 'rdoc')
+  self.rsync_args = '-av --delete --ignore-errors'
+end
+
+task :info do
+  puts "version=#{LinkHeader::VERSION}"
+  [:description, :summary, :changes, :author, :url].each do |attr|
+    puts "#{attr}=#{$hoe.send(attr)}\n"
+  end
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+

data/lib/link_header.rb

@@ -0,0 +1,104 @@
+require "strscan"
+
+class LinkHeader
+  VERSION = "0.0.1"
+  
+  # an array of Link objects
+  attr_reader :links
+  
+  #
+  # Initialize from array of Link objects or the data from which said Link objects can be created
+  #
+  def initialize(links=[])
+    @links= links.map{|l| l.kind_of?(Link) ? l : Link.new(*l)}
+  end
+  
+  #
+  # Convert to a JSON-friendly array
+  #
+  def to_a
+    links.map{|l| l.to_a}
+  end
+  
+  #
+  # Convert to string representation as per the link header spec
+  #
+  def to_s
+    links.join(', ')
+  end
+  
+  HREF   = / *<([^>]*)> *;? */
+  TOKEN  = /([a-zA-Z0-9_\-]+)/
+  QUOTED = /"([^"]*)"/
+  ATTR   = /#{TOKEN} *= *(#{TOKEN}|#{QUOTED}) */
+  SEMI   = /; */
+  COMMA  = /, */
+
+  #
+  # Parse a link header, returning a new LinkHeader object
+  #
+  def self.parse(link_header)
+    return new unless link_header
+    
+    scanner = StringScanner.new(link_header)
+    links = []
+    while scanner.scan(HREF)
+      href = scanner[1]
+      attrs = []
+      while scanner.scan(ATTR)
+        attrs.push([scanner[1], scanner[3] || scanner[4]])
+        break unless scanner.scan(SEMI)
+      end
+      links.push(Link.new(href, attrs))
+      break unless scanner.scan(COMMA)
+    end
+
+    new(links)
+  end
+    
+  #
+  # Represents a link - an href and a list of attributes (key value pairs)
+  #
+  class Link
+    # The Link's href (a URI string)
+    attr_reader :href
+    
+    # The link's attributes, an array of key-value pairs
+    attr_reader :attr_pairs
+    
+    #
+    # Initialize a Link from an href and attribute list
+    #
+    def initialize(href, attr_pairs)
+      @href, @attr_pairs = href, attr_pairs
+    end
+    
+    #
+    # Lazily convert the attribute list to a Hash
+    #
+    def attrs
+      @attrs ||= Hash[*attr_pairs.flatten]
+    end
+    
+    #
+    # Access an attribute by key
+    #
+    def [](key)
+      attrs[key]
+    end
+    
+    #
+    # Convert to a JSON-friendly Array
+    #
+    def to_a
+      [href, attr_pairs]
+    end
+    
+    #
+    # Convert to string representation as per the link header spec
+    #
+    def to_s
+      (["<#{href}>"] + attr_pairs.map{|k, v| "#{k}=\"#{v}\""}).join('; ')
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/link_header.rb'}"
+puts "Loading link_header gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/link_header'

data/test/test_link_header.rb

@@ -0,0 +1,52 @@
+require "test/unit"
+
+LINK_HEADER_S_A = [
+  %Q(<http://example.com/>; rel="up"; meta="bar"),
+  %Q(<http://example.com/foo>; rel="self"),
+  %Q(<http://example.com/>)
+]
+LINK_HEADER_S = LINK_HEADER_S_A.join(', ')
+
+LINK_HEADER_A = [
+  ["http://example.com/", [["rel", "up"], ["meta", "bar"]]],
+  ["http://example.com/foo", [["rel", "self"]]],
+  ["http://example.com/", []]
+]
+
+class TestLinkHeader < Test::Unit::TestCase
+  def test_new_link
+    link = LinkHeader::Link.new(*LINK_HEADER_A[0])
+    assert_equal("http://example.com/", link.href)
+    assert_equal([["rel", "up"], ["meta", "bar"]], link.attr_pairs)
+    assert_equal({"rel"=>"up", "meta"=>"bar"}, link.attrs)
+  end
+  
+  def test_link_to_a
+    assert_equal(LINK_HEADER_A[0], LinkHeader::Link.new(*LINK_HEADER_A[0]).to_a)
+  end
+  
+  def test_link_to_s
+    assert_equal(LINK_HEADER_S_A[0], LinkHeader::Link.new(*LINK_HEADER_A[0]).to_s)
+  end
+  
+  def test_new_link_header
+    link_header = LinkHeader.new(LINK_HEADER_A)
+    assert_equal(LINK_HEADER_A.length, link_header.links.length)
+    link = link_header.links[0]
+    assert_equal("http://example.com/", link.href)
+    assert_equal([["rel", "up"], ["meta", "bar"]], link.attr_pairs)
+    assert_equal({"rel"=>"up", "meta"=>"bar"}, link.attrs)
+  end
+  
+  def test_link_header_to_a
+    assert_equal(LINK_HEADER_A, LinkHeader.new(LINK_HEADER_A).to_a)
+  end
+  
+  def test_parse_link_header
+    assert_equal(LINK_HEADER_A, LinkHeader.parse(LINK_HEADER_S).to_a)
+  end
+  
+  def test_link_header_to_s
+    assert_equal(LINK_HEADER_S, LinkHeader.new(LINK_HEADER_A).to_s)
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: link_header
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Burrows
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations.
+email: 
+- mjb@asplake.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/link_header.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_link_header.rb
+has_rdoc: true
+homepage: http://github.com/asplake/link_header/tree
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: link-header
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations.
+test_files: 
+- test/test_helper.rb
+- test/test_link_header.rb