rack-link_headers 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rbx
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-link-headers.gemspec
+gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Graichen
+
+MIT License
+
+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.md

@@ -0,0 +1,54 @@
+# Rack::LinkHeaders
+
+Easy Link header management for rack responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-link_headers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-link_headers
+
+## Usage
+
+```ruby
+response.headers.link "rel", "http://abc.de/"
+response.headers.link "rss", "http://test.host/feed.xml"
+```
+```
+Link: <http://abc.de/> rel="rel", <http://test.host/feed.xml> rel="rss"
+```
+
+Manual set Link header will be overridden. All links can be
+accessed via `links`:
+
+```ruby
+response.headers.link "rel", "http://abc.de/"
+response.headers.link "rss", "http://test.host/feed.xml"
+
+response.headers.links
+# => [{:rel=>"rel", :url=>"http://abc.de/"}, {:rel=>"rss", :url=>"http://test.host/feed.xml"}]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add tests for your features.
+4. Add your features.
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## License
+
+[MIT License](http://www.opensource.org/licenses/mit-license.php)
+
+Copyright (c) 2013, Jan Graichen

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/rack/link_headers/header_hash_helper.rb

@@ -0,0 +1,29 @@
+require 'rack/utils'
+
+module Rack
+  module LinkHeaders
+    # Helper for easy adding link headers to rack responses.
+    module HeaderHashHelper
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        # Add a new Link header to response headers. Requires
+        # a rel string and a URL. Does not escape or sanitize
+        # anything. Manual added Link headers will be
+        # overridden.
+        def link(rel, url)
+          links << {:rel => rel.to_s, :url => url.to_s }
+          self["Link"] = links.to_a.map{|link| "<#{link[:url]}> rel=\"#{link[:rel]}\""}.join(', ')
+        end
+
+        def links
+          @__links ||= []
+        end
+      end
+    end
+  end
+end
+
+Rack::Utils::HeaderHash.send :include, Rack::LinkHeaders::HeaderHashHelper

data/lib/rack/link_headers/version.rb

@@ -0,0 +1,14 @@
+module Rack
+  module LinkHeaders
+    module VERSION
+      MAJOR = 1
+      MINOR = 0
+      PATCH = 0
+      STAGE = nil
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join '.'
+      end
+    end
+  end
+end

data/lib/rack-link_headers.rb

@@ -0,0 +1,7 @@
+require 'rack/link_headers/header_hash_helper'
+
+module Rack
+  module LinkHeaders
+    autoload :VERSION, 'rack-link_headers/version'
+  end
+end

data/rack-link-headers.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack/link_headers/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'rack-link_headers'
+  gem.version       = Rack::LinkHeaders::VERSION
+  gem.authors       = ["Jan Graichen"]
+  gem.email         = ["jg@altimos.de"]
+  gem.description   = %q{Easy Link header management for rack responses.}
+  gem.summary       = %q{Easy Link header management for rack responses.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rack'
+end

data/test/header_hash_helper_test.rb

@@ -0,0 +1,40 @@
+require 'minitest/autorun'
+
+require 'rack/utils'
+require 'rack-link_headers'
+
+class HeaderHashHelperTest < MiniTest::Unit::TestCase
+  def setup
+    @headers = Rack::Utils::HeaderHash.new
+  end
+
+  def test_link_writes_header
+    @headers.link "search", "http://google.com/path?query=5#frag"
+
+    assert_equal "<http://google.com/path?query=5#frag> rel=\"search\"", @headers["Link"]
+  end
+
+  def test_multiple_link_writes_header
+    @headers.link "search", "http://google.com/path?query=5#frag"
+    @headers.link "rss", "http://test.host/feed.rss"
+
+    assert_equal "<http://google.com/path?query=5#frag> rel=\"search\", <http://test.host/feed.rss> rel=\"rss\"", @headers["Link"]
+  end
+
+  def test_links
+    @headers.link "search", "http://google.com/path?query=5#frag"
+    @headers.link "rss", "http://test.host/feed.rss"
+
+    assert_equal @headers.links, [{:rel=>"search", :url=> "http://google.com/path?query=5#frag"}, {:rel=>"rss", :url=>"http://test.host/feed.rss"}]
+  end
+
+  def test_overrides_manual_headers
+    @headers["Link"] = "http://abc.de/"
+
+    assert_equal "http://abc.de/", @headers["Link"]
+
+    @headers.link "search", "http://google.com/path?query=5#frag"
+
+    assert_equal "<http://google.com/path?query=5#frag> rel=\"search\"", @headers["Link"]
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rack-link_headers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: Easy Link header management for rack responses.
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-link_headers.rb
+- lib/rack/link_headers/header_hash_helper.rb
+- lib/rack/link_headers/version.rb
+- rack-link-headers.gemspec
+- test/header_hash_helper_test.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -2482873367989671441
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2482873367989671441
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy Link header management for rack responses.
+test_files:
+- test/header_hash_helper_test.rb