rack-canonical-header 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a2d22d823f08b477a257089f36a0847de6d2b2faefae85f203afdc8a98bde02
-  data.tar.gz: 98381e2a9cb18e50dd9ca3b6408a8e68815877a125be901cb03ab5001abc6a40
+  metadata.gz: 327b53d961290667f3ef172e3a520eecdef838b1e2823aeff10523c916703935
+  data.tar.gz: 9b1b4bc6cfe2ab6b3651f0bf9e8e2b45e784fc4e5ffbcfc8a8648e7996b647ae
 SHA512:
-  metadata.gz: f605ff888c956625e3df737478740c67369330f420e5085cb0d790715deb75e278f98408510afbd7071bcb4db0e278abeafbcee0be5392d632b409665f644dee
-  data.tar.gz: 70c1577a139d55e5a153fb61402f6edbc3faa18ac3c214b22faa743971bb41425cc6a77c6dbba6f83dfd533f2abe911c9540698c3148c853fcf7ab435f35ad9e
+  metadata.gz: 9d8475fbddca0a0e95e485f278a8d5f5adebd84ff367a7f500f6aa1bcf41d01f5f32c5db45ad13178b77eaa0aea1a8b132554506e0066283c94f57df14359bef
+  data.tar.gz: 632225ba447529878b0abda0bb7aae0725f790b14c576f343c1a7483071bf5adbabfc23680fb154b47c25043d367bbfd9bded51bd7e7449e7fbc6acd5ce01536

data/README.md

@@ -23,10 +23,35 @@ And then execute `bundle install`
 
 ## Usage
 
-Set the `CANONICAL_HOST` env variable
+Set the `CANONICAL_HOST` env variable to the desired host
+(i.e. set it to the domain of your website like `CANONICAL_HOST=example.com`)
+
+The gem will inject a header of the format
+`Link: <http[s]://CANONICAL_HOST[/path]>; rel=canonical` as soon as the env is present.
+The path and the scheme will be replaced
+with what was requested on the original domain.
+
+Note that the gem does *no* redirects.
+Therefore, your non-canonical urls will still work if you access them directly.
+However, search engines will not list them.
 
 ### Non-Rails frameworks
 
 If you're using a framework which uses Rack (like Hanami)
 you have to require and insert the middleware
 `Canonical::Middleware` manually into the rack stack.
+
+For example:
+
+```ruby
+require 'rack/auth/basic'
+require 'rack-canonical-header'
+
+module Web
+  class Application < Hanami::Application
+    configure do
+      middleware.use Canonical::Middleware
+    end
+  end
+end
+```

data/lib/rack-canonical-header/middleware.rb

@@ -20,6 +20,8 @@ module Canonical
       "<#{canonical}>; rel=\"canonical\""
     end
 
+    private
+
     def html?
       @headers['Content-Type'] =~ /html/
     end

data/lib/rack-canonical-header/version.rb

@@ -1,3 +1,3 @@
 module Canonical
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-canonical-header
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lukas Bischof
@@ -122,7 +122,7 @@ files:
 - lib/rack-canonical-header/middleware.rb
 - lib/rack-canonical-header/rails.rb
 - lib/rack-canonical-header/version.rb
-homepage: https://renuo.ch
+homepage: https://github.com/renuo/rack-canonical-header
 licenses:
 - MIT
 metadata: {}