rack-link_headers 2.0.0 → 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 923b708b4765a8eb504d6d4337de4bcc21abd40a0509c0c7851e649b23777fe2
+  data.tar.gz: c4634d4822bf971fe5ed4c9af90e9756942b3d47c05024444e94c7d68ce951bb
+SHA512:
+  metadata.gz: a0deb2f9e6382622c350932f7f42cecec4a7ecba8b82182aac914fffe1d74538b99d25195932eba609ed8e39389ff1fc23baf57970a9224253bc82d6675b1dff
+  data.tar.gz: 5e1ee525a5f8a6595c152bee35b4b6ae4be63e970a393e29d66b005bf7fe9c27bd3287c310c220e60b53d748656b965061d41e5c26f627a4497a530133b3e118

data/README.md

@@ -1,5 +1,6 @@
 # Rack::LinkHeaders
-[![Build Status](https://travis-ci.org/jgraichen/rack-link_headers.png?branch=master)](https://travis-ci.org/jgraichen/rack-link_headers)
+
+[![Build Status](https://github.com/jgraichen/rack-link_headers/workflows/Build/badge.svg?event=push)](https://github.com/jgraichen/rack-link_headers/actions?query=workflow%3ABuild)
 
 Easy Link header management for rack responses.
 
@@ -20,23 +21,28 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-response.link "rel", "http://abc.de/"
-response.link "rss", "http://test.host/feed.xml"
+response.link "http://abc.de/", rel: :search
+response.link "http://test.host/feed.xml", rel: :rss, type: "application/rss+xml"
 ```
 ```
 response.headers["Link"]
-# => <http://abc.de/> rel="rel", <http://test.host/feed.xml> rel="rss"
+# => <http://abc.de/>; rel="rel", <http://test.host/feed.xml>; rel="rss"; type="application/rss+xml"
 ```
 
 Manual set Link header will be overridden. All links can be
 accessed via `links`:
 
 ```ruby
-response.link "rel", "http://abc.de/"
-response.link "rss", "http://test.host/feed.xml"
+response.link "http://abc.de/", rel: :search
+response.link "http://test.host/feed.xml", rel: :rss, type: "application/rss+xml"
 
 response.links
-# => [{:rel=>"rel", :url=>"http://abc.de/"}, {:rel=>"rss", :url=>"http://test.host/feed.xml"}]
+# => [
+#  {:url=>"http://abc.de/",
+#   :params=>{:ref=>:search}},
+#  {:url=>"http://test.host/feed.xml",
+#   :params=>{:rel=>:rss, :type=>"application/rss+xml"}}
+# ]
 ```
 
 ## Contributing

data/lib/rack-link_headers.rb

@@ -1,4 +1,6 @@
-require 'rack/link_headers/header_hash_helper'
+# frozen_string_literal: true
+
+require 'rack/link_headers/helper'
 
 module Rack
   module LinkHeaders

data/lib/rack/link_headers/helper.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module Rack
+  module LinkHeaders
+    # Helper for easy adding link headers to rack responses.
+    module Helper
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        # Add a new Link header to response headers. Requires
+        # a URL and a params hash. Does not escape or
+        # sanitize anything. Manual added Link headers will be
+        # overridden.
+        def link(url, params = {})
+          links << {url: url.to_s, params: params}
+
+          self['Link'] = links.to_a.map do |link|
+            "<#{link[:url]}>" + link[:params].keys.sort.map do |k|
+              "; #{k}=\"#{link[:params][k]}\""
+            end.join
+          end.join(', ')
+        end
+
+        def links
+          @links ||= []
+        end
+      end
+    end
+  end
+end
+
+Rack::Response.include Rack::LinkHeaders::Helper
+Rack::Response::Helpers.include Rack::LinkHeaders::Helper
+
+if defined?(ActionDispatch::Response)
+  ActionDispatch::Response.include Rack::LinkHeaders::Helper
+end
+if defined?(ActionController::TestResponse)
+  ActionController::TestResponse.include Rack::LinkHeaders::Helper
+end

data/lib/rack/link_headers/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Rack
   module LinkHeaders
     module VERSION
       MAJOR = 2
-      MINOR = 0
+      MINOR = 3
       PATCH = 0
       STAGE = nil
 

data/rack-link-headers.gemspec

@@ -1,22 +1,26 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $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::Specification.new do |spec|
+  spec.name          = 'rack-link_headers'
+  spec.version       = Rack::LinkHeaders::VERSION
+  spec.authors       = ['Jan Graichen']
+  spec.email         = ['jgraichen@altimos.de']
+  spec.summary       = 'Easy Link header management for rack responses.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
-  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"]
+  spec.files         = Dir['**/*'].grep(%r{^(
+    (bin|lib|test|spec|features)/|
+    (.*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)
+  )}x)
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 
-  gem.add_dependency 'rack'
+  spec.add_runtime_dependency 'rack'
 end

data/test/helper_test.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+
+ACTIONPACK = !ENV['ACTIONPACK'].to_s.empty?
+
+if ACTIONPACK
+  # For testing ActionDispatch::Response
+  require 'action_dispatch'
+end
+
+require 'rack-link_headers'
+
+class HelperTest < MiniTest::Unit::TestCase
+  def setup
+    @response = Rack::Response.new
+  end
+
+  def test_link_writes_header
+    @response.link 'http://google.com/path?query=5#frag', rel: :search
+
+    assert_equal '<http://google.com/path?query=5#frag>; rel="search"', @response.headers['Link']
+  end
+
+  def test_multiple_link_writes_header
+    @response.link 'http://google.com/path?query=5#frag', rel: :search
+    @response.link 'http://test.host/feed.rss', rel: :rss, type: 'application/rss+xml'
+
+    assert_equal '<http://google.com/path?query=5#frag>; rel="search", <http://test.host/feed.rss>; rel="rss"; type="application/rss+xml"', @response.headers['Link']
+  end
+
+  def test_links
+    @response.link 'http://google.com/path?query=5#frag', rel: :search
+    @response.link 'http://test.host/feed.rss', rel: :rss, type: 'application/rss+xml'
+
+    assert_equal @response.links, [{url: 'http://google.com/path?query=5#frag', params: {rel: :search}},
+                                   {url: 'http://test.host/feed.rss', params: {rel: :rss, type: 'application/rss+xml'}}]
+  end
+
+  def test_overrides_manual_headers
+    @response.headers['Link'] = 'http://abc.de/'
+
+    assert_equal 'http://abc.de/', @response.headers['Link']
+
+    @response.link 'http://google.com/path?query=5#frag', rel: :search
+
+    assert_equal '<http://google.com/path?query=5#frag>; rel="search"', @response.headers['Link']
+  end
+
+  if ACTIONPACK
+    def test_dyn_inject_action_dispatch_response
+      assert ActionDispatch::Response.new.respond_to? :link
+    end
+  end
+end

metadata

@@ -1,79 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: rack-link_headers
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 2.3.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-17 00:00:00.000000000 Z
+date: 2020-12-13 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.
+description: 
 email:
-- jg@altimos.de
+- jgraichen@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/helper.rb
 - lib/rack/link_headers/version.rb
 - rack-link-headers.gemspec
-- test/header_hash_helper_test.rb
+- test/helper_test.rb
 homepage: ''
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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: -121590991522842654
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -121590991522842654
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Easy Link header management for rack responses.
 test_files:
-- test/header_hash_helper_test.rb
+- test/helper_test.rb

data/.gitignore

@@ -1,18 +0,0 @@
-*.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

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

data/Gemfile

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

data/Rakefile

@@ -1,10 +0,0 @@
-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

@@ -1,30 +0,0 @@
-require 'rack/response'
-
-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::Response.send :include, Rack::LinkHeaders::HeaderHashHelper
-Rack::Response::Helpers.send :include, Rack::LinkHeaders::HeaderHashHelper

data/test/header_hash_helper_test.rb

@@ -1,40 +0,0 @@
-require 'minitest/autorun'
-
-require 'rack/response'
-require 'rack-link_headers'
-
-class HeaderHashHelperTest < MiniTest::Unit::TestCase
-  def setup
-    @response = Rack::Response.new
-  end
-
-  def test_link_writes_header
-    @response.link "search", "http://google.com/path?query=5#frag"
-
-    assert_equal "<http://google.com/path?query=5#frag> rel=\"search\"", @response.headers["Link"]
-  end
-
-  def test_multiple_link_writes_header
-    @response.link "search", "http://google.com/path?query=5#frag"
-    @response.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\"", @response.headers["Link"]
-  end
-
-  def test_links
-    @response.link "search", "http://google.com/path?query=5#frag"
-    @response.link "rss", "http://test.host/feed.rss"
-
-    assert_equal @response.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
-    @response.headers["Link"] = "http://abc.de/"
-
-    assert_equal "http://abc.de/", @response.headers["Link"]
-
-    @response.link "search", "http://google.com/path?query=5#frag"
-
-    assert_equal "<http://google.com/path?query=5#frag> rel=\"search\"", @response.headers["Link"]
-  end
-end