http_header_link 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e867bd978028405d356dd834248d7f7fcadf78e7caf6e668da2b6ed517e71624
+  data.tar.gz: dd1f43402be3a14f5275093737118018913af44f3ab30b0695aa0e71aecb23c1
+SHA512:
+  metadata.gz: 68ac72d5939c710c984de4c0e69f57aa3102203856bb83eb31bbb69f17fca489c651ce35a85fef9b54dd1a05ee49e8b283d2e562c06939096f95a6a66f2143ae
+  data.tar.gz: d0566b0c8d4c758414abf355a424d290ed575637d259f3e0a36b98f9ed4e5243886033af113498818ead2334e1d2f76d14376394e0bdd9924e4b8c3727194365

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in http_header_link.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'rspec-parameterized-context'
+gem "pry"

data/README.md

@@ -0,0 +1,62 @@
+# HttpHeaderLink
+
+The library handling the Link header, written in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http_header_link', git: 'git@github.com:sainu/http_header_link.git', branch: 'master'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install http_header_link git@github.com:sainu/http_header_link.git master
+
+## Usage
+
+### Generating Link Header
+
+#### Basic
+
+```rb
+link_header = HttpHeaderLink::LinkHeader.new
+link_header.add_link('/?page=1', rel: 'previous')
+link_header.add_link('/?page=3', rel: 'next')
+link_header.generate
+=> "</?page=1>; rel=\"previous\", </?page=3>; rel=\"next\""
+```
+
+#### Configure Base URL
+
+```rb
+link_header = HttpHeaderLink::LinkHeader.new(base_url: 'http://localhost')
+link_header.add_link('/?page=1', rel: 'previous')
+link_header.add_link('/?page=3', rel: 'next')
+link_header.generate
+=> "<http://localhost/?page=1>; rel=\"previous\", <http://localhost/?page=3>; rel=\"next\""
+```
+
+### Parsing Link Header
+
+```rb
+link_header = HttpHeaderLink::LinkHeader.parse('</?page=2>; rel="next"')
+next_page = link_header.find_by(:rel, 'next')&.get_query(:page)&.to_i
+=> 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sainuio/http_header_link.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "http_header_link"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/http_header_link.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/http_header_link/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "http_header_link"
+  spec.version       = HttpHeaderLink::VERSION
+  spec.authors       = ["sainu"]
+  spec.email         = ["katsutoshi.saino@gmail.com"]
+
+  spec.summary       = %q{The library handling the Link header, written in Ruby.}
+  spec.description   = %q{The library handling the Link header, written in Ruby.}
+  spec.homepage      = "https://github.com/sainuio/http_header_link/"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sainuio/http_header_link/"
+  spec.metadata["changelog_uri"] = "https://github.com/sainuio/http_header_link/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/http_header_link.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'http_header_link/version'
+require 'http_header_link/link'
+require 'http_header_link/link_header'

data/lib/http_header_link/link.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module HttpHeaderLink
+  class Link
+    # @return [String]
+    attr_reader :url
+    attr_reader :attributes
+
+    # @param [String] url
+    # @param [Hash] options
+    # @option options [String] :rel
+    # @option options [String] :title
+    # @option options [String] :hreflang
+    # @option options [String] :media
+    # @option options [String] :type
+    def initialize(url, **options)
+      @url = url
+      @attributes = options.slice(:rel, :title, :hreflang, :media, :type)
+    end
+
+    # @param [String] base_url
+    # @return [String]
+    def generate(base_url: nil)
+      src = base_url ? URI.join(base_url, url) : url
+      str = "<#{src}>"
+      attributes.each do |name, value|
+        str += %(; #{name}="#{value}")
+      end
+      str
+    end
+
+    # @param [Symbol] name
+    # @return [String, nil]
+    def get_query(name)
+      query_hash[name.to_s]
+    end
+
+    # @return [String, nil]
+    def rel
+      attributes[:rel]
+    end
+
+    # @return [String, nil]
+    def hreflang
+      attributes[:hreflang]
+    end
+
+    # @return [String, nil]
+    def title
+      attributes[:title]
+    end
+
+    # @return [String, nil]
+    def media
+      attributes[:media]
+    end
+
+    # @return [String, nil]
+    def type
+      attributes[:type]
+    end
+
+    private
+
+    # @return [URI]
+    def uri
+      URI.parse(url)
+    end
+
+    # @return [Hash{ String => String }]
+    def query_hash
+      URI::decode_www_form(uri.query || '').to_h
+    end
+  end
+end

data/lib/http_header_link/link_header.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module HttpHeaderLink
+  class LinkHeader
+    class << self
+      # @param [String] target
+      # @return [HttpHeaderLink::ParseResult]
+      def parse(target)
+        parts = target.split(',')
+        links = parts.map do |part|
+          sections = part.split(';')
+          url = sections.shift[/<(.*)>/, 1]
+          options = {}
+          sections.each do |section|
+            name, val = section.split('=').map(&:strip)
+            val.slice!(0, 1) if val.start_with?('"')
+            val.slice!(-1, 1) if val.end_with?('"')
+            options[name.to_sym] = val
+          end
+          Link.new(url, **options)
+        end
+
+        new(links)
+      end
+    end
+
+    # @return [Array<HttpHeaderLink::Link>]
+    attr_reader :links
+
+    # @param [Array<HttpHeaderLink::Link>] links
+    # @param [Hash] options
+    # @option options [String] :base_url
+    def initialize(*links, **options)
+      _links = links.flatten
+      @links = _links.empty? ? [] : _links
+      @base_url = options.delete(:base_url)
+    end
+
+    # @return [String]
+    def generate
+      links.flatten.compact.map { |l| l.generate(base_url: base_url) }.join(', ')
+    end
+
+    # @param [String] url
+    # @param [Hash] options
+    # @option options [String] :rel
+    # @option options [String] :title
+    # @option options [String] :hreflang
+    # @option options [String] :media
+    # @option options [String] :type
+    def add_link(url, **options)
+      links << Link.new(url, options)
+    end
+
+    # @return [Boolean]
+    def present?
+      !links.empty?
+    end
+
+    # @param [Symbol] attribute
+    # @param [String] value
+    def find_by(attribute, value)
+      links.find { |link| link.public_send(attribute) == value }
+    end
+
+    private
+
+    attr_reader :base_url
+  end
+end

data/lib/http_header_link/version.rb

@@ -0,0 +1,3 @@
+module HttpHeaderLink
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: http_header_link
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- sainu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-18 00:00:00.000000000 Z
+dependencies: []
+description: The library handling the Link header, written in Ruby.
+email:
+- katsutoshi.saino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- http_header_link.gemspec
+- lib/http_header_link.rb
+- lib/http_header_link/link.rb
+- lib/http_header_link/link_header.rb
+- lib/http_header_link/version.rb
+homepage: https://github.com/sainuio/http_header_link/
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sainuio/http_header_link/
+  source_code_uri: https://github.com/sainuio/http_header_link/
+  changelog_uri: https://github.com/sainuio/http_header_link/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: The library handling the Link header, written in Ruby.
+test_files: []