link-header-parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af19382d4d537959b66ca55c6fcfab4cc52cb552748e6cc9cbf7d18176491e1
-  data.tar.gz: f576800eaa08e75441edf34b65bac17302cbff52ad161ad84e5604fdd8a66890
+  metadata.gz: 39406f09a5e4cfecc6d2e1918b947b4fef83ce65915f93af711fc816b92d3760
+  data.tar.gz: 10e5a92616f6db295efbeb544dd650b2ca8099f98bb269c4dc8ec45540ee4fc7
 SHA512:
-  metadata.gz: d0823f00fe68edffc867354972a4e3efa4f7f4ebe5cd4ba14ff0dbefe7a291531daca5b789f3392d0b53a9231edc1261f4ea01c094545a74119aed0c9c7f668d
-  data.tar.gz: 9bf55d725122524374d47024900768bb497239422e826a0d07f66052e091dc950f982e8df3d4275d75837d8e4b3e19bbaa92a8aa5f937299f2429b66e02ee215
+  metadata.gz: 9d64a96e22925e26599216e3c6e3e27f90b546a9dea6d7aba08fd6566240ec25688e674424d2803eed7d63c424477c8f02841b9f0061e0100928f3c37d146628
+  data.tar.gz: 6d2951bdd0d745f7ae9176f63bb0e5f7c9f2ecab722252f8f5c557e03ebb2afea6a41494a0d697f7ef9e73eb699150d4763d31e2246ae1ebf970ba19f0ac7e26

data/.rubocop.yml

@@ -8,6 +8,10 @@ Layout/AlignHash:
 Metrics/LineLength:
   Enabled: false
 
+Metrics/ModuleLength:
+  Exclude:
+    - spec/support/**/*.rb
+
 Naming/FileName:
   Exclude:
     - lib/link-header-parser.rb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
-0.1.0 / 2019-06-06
+## 0.2.0 / 2019-07-02
+
+- Add support for the `anchor` parameter to `ParsedHeader` exposed via `context` and `context_uri` methods ([d2dff52](https://github.com/jgarber623/link-header-parser-ruby/commit/d2dff52)).
+
+## 0.1.0 / 2019-06-06
 
 - Initial release!

data/README.md

@@ -44,14 +44,34 @@ response = HTTP.get('https://sixtwothree.org')
 link_headers = response.headers.get('link')
 
 collection = LinkHeaderParser.parse(link_headers, base: response.uri.to_s)
+```
+
+The `parse` method accepts two arguments:
+
+1. an `Array` of strings representing HTTP Link headers (e.g. `['</>; rel="home"', '</chapters/1>; anchor="#copyright"; rel="license"']`)
+1. a `String` representing the absolute URL of the resource providing the HTTP Link headers
+
+In the example above, `collection` is an instance of `ParsedHeaderCollection` which includes Ruby's [`Enumerable`](https://ruby-doc.org/core/Enumerable.html) mixin. This mixin allows for use of common methods like `each`, `first`/`last`, and `map`.
 
-puts collection.relation_types    # => ["preconnect", "webmention"]
+For example, you could retrieve an array of `target_uri`s:
+
+```ruby
 puts collection.map(&:target_uri) # => ["https://assets.sixtwothree.org/", "https://fonts.googleapis.com/", "https://fonts.gstatic.com/", "https://sixtwothree.org/webmentions"]
 ```
 
-In the example above, `collection` is an instance of `ParsedHeaderCollection` which includes Ruby's [Enumerable](https://ruby-doc.org/core/Enumerable.html) mixin. This mixin allows for use of common methods like `each`, `first`/`last`, and `map` (as demonstrated above).
+### Working with a `ParsedHeaderCollection`
+
+In addition to the included `Enumerable` methods, the following methods may be used to interact with a `ParsedHeaderCollection`:
 
-Additionally, `collection.by_relation_type` returns an `OpenStruct` with the following attributes:
+#### The `relation_types` Method
+
+```ruby
+puts collection.relation_types # => ["preconnect", "webmention"]
+```
+
+#### The `by_relation_type` Method
+
+Using the `collection` from above, the `by_relation_type` method returns an `OpenStruct` with the following attributes:
 
 ```ruby
 {
@@ -66,18 +86,43 @@ Additionally, `collection.by_relation_type` returns an `OpenStruct` with the fol
 }
 ```
 
-Building on this example, you may interact with one or more `ParsedHeader`s in a `ParsedHeaderCollection`:
+### Working with a `ParsedHeader`
+
+You may interact with one or more `ParsedHeader`s in a `ParsedHeaderCollection` using the methods outlined below. The naming conventions for these methods draws heavily on the terminology established in [RFC-5988](https://tools.ietf.org/html/rfc5988) and [RFC-8288](https://tools.ietf.org/html/rfc8288).
+
+#### Link Target ([§ 3.1](https://tools.ietf.org/html/rfc8288#section-3.1))
+
+```ruby
+link_headers = ['</index.html>; rel="home"']
+parsed_header = LinkHeaderParser.parse(link_headers, base: 'https://example.com/').first
+
+parsed_header.target     # => '/index.html'
+parsed_header.target_uri # => 'https://example.com/index.html'
+```
+
+The `target` method returns a string of the value between the opening and closing angle brackets at the beginning of the Link header. The `target_uri` method returns a string representing the resolved URL.
+
+#### Link Context ([§ 3.2](https://tools.ietf.org/html/rfc8288#section-3.2))
 
 ```ruby
-parsed_header = collection.first
+link_headers = ['<https://example.com/chapters/1>; anchor="#copyright"; rel="license"']
+parsed_header = LinkHeaderParser.parse(link_headers, base: 'https://example.com/').first
 
-parsed_header.relation_types # => ['preconnect']
-parsed_header.relations      # => 'preconnect'
-parsed_header.target         # => 'https://assets.sixtwothree.org/'
-parsed_header.target_uri     # => 'https://assets.sixtwothree.org/'
+parsed_header.context     # => '#copyright'
+parsed_header.context_uri # => 'https://example.com/chapters/1#copyright'
 ```
 
-The naming conventions for these methods draws heavily on the terminology established in [RFC-5988](https://tools.ietf.org/html/rfc5988) and [RFC-8288](https://tools.ietf.org/html/rfc8288).
+The `anchor` parameter's value may be a fragment identifier (e.g. `#foo`), a relative URL (e.g. `/foo`), or an absolute URL (e.g. `https://context.example.com`). The `context` method returns the `anchor` parameter's value (when present) and defaults to the `target` value.
+
+#### Relation Type ([§ 3.3](https://tools.ietf.org/html/rfc8288#section-3.3))
+
+```ruby
+link_headers = ['<https://example.com/chapters/1>; rel="prev start"']
+parsed_header = LinkHeaderParser.parse(link_headers, base: 'https://example.com/').first
+
+parsed_header.relations      # => 'prev start'
+parsed_header.relation_types # => ['prev', 'start']
+```
 
 ## Contributing
 

data/lib/link_header_parser/parsed_header.rb

@@ -10,6 +10,15 @@ module LinkHeaderParser
       @base = base
     end
 
+    # https://tools.ietf.org/html/rfc8288#section-3.2
+    def context
+      @context ||= parameters.anchor || target
+    end
+
+    def context_uri
+      @context_uri ||= Absolutely.to_abs(base: target_uri, relative: context)
+    end
+
     def inspect
       format(%(#<#{self.class.name}:%#0x @header="#{header.gsub('"', '\"')}">), object_id)
     end
@@ -22,10 +31,12 @@ module LinkHeaderParser
       @relation_types ||= relations&.split(' ') || nil
     end
 
+    # https://tools.ietf.org/html/rfc8288#section-3.3
     def relations
       @relations ||= parameters.rel || nil
     end
 
+    # https://tools.ietf.org/html/rfc8288#section-3.1
     def target
       @target ||= header_match_data[:target]
     end
@@ -38,6 +49,8 @@ module LinkHeaderParser
       {
         target: target,
         target_uri: target_uri,
+        context: context,
+        context_uri: context_uri,
         relations: relations,
         relation_types: relation_types,
         parameters: parameters.to_h

data/lib/link_header_parser/parsed_header_collection.rb

@@ -47,12 +47,12 @@ module LinkHeaderParser
       @mapped_relation_types ||= relation_types.map { |relation_type| [relation_type, find_all_by_relation_type(relation_type)] }.to_h
     end
 
-    def uniq_headers
-      @uniq_headers ||= headers.map { |header| header.split(/,(?=[\s|<])/) }.flatten.map(&:strip)
-    end
-
     def parsed_headers
       @parsed_headers ||= uniq_headers.map { |header| ParsedHeader.new(header, base: @base) }
     end
+
+    def uniq_headers
+      @uniq_headers ||= headers.map { |header| header.split(/,(?=[\s|<])/) }.flatten.map(&:strip)
+    end
   end
 end

data/lib/link_header_parser/version.rb

@@ -1,3 +1,3 @@
 module LinkHeaderParser
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/link-header-parser.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'reek', '~> 5.4'
   spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.71.0'
+  spec.add_development_dependency 'rubocop', '~> 0.72.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.3'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.33'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: link-header-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.72.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.72.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +169,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/link-header-parser-ruby/issues
-  changelog_uri: https://github.com/jgarber623/link-header-parser-ruby/blob/v0.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/link-header-parser-ruby/blob/v0.2.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: