rack-canonical-header 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a2d22d823f08b477a257089f36a0847de6d2b2faefae85f203afdc8a98bde02
+  data.tar.gz: 98381e2a9cb18e50dd9ca3b6408a8e68815877a125be901cb03ab5001abc6a40
+SHA512:
+  metadata.gz: f605ff888c956625e3df737478740c67369330f420e5085cb0d790715deb75e278f98408510afbd7071bcb4db0e278abeafbcee0be5392d632b409665f644dee
+  data.tar.gz: 70c1577a139d55e5a153fb61402f6edbc3faa18ac3c214b22faa743971bb41425cc6a77c6dbba6f83dfd533f2abe911c9540698c3148c853fcf7ab435f35ad9e

data/README.md

@@ -0,0 +1,32 @@
+# rack-canonical-header
+
+Inserts a canonical url with a predefined host to prevent
+search engines from crawling domains like `herokuapp.com`
+
+## Setup
+
+```
+git clone git@github.com:renuo/rack-canonical-header.git
+cd rack-canonical-header
+bin/setup
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-canonical-header'
+```
+
+And then execute `bundle install`
+
+## Usage
+
+Set the `CANONICAL_HOST` env variable
+
+### 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.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'rack-canonical-header'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rack-canonical-header.rb

@@ -0,0 +1,3 @@
+require 'rack-canonical-header/middleware'
+require 'rack-canonical-header/version'
+require 'rack-canonical-header/rails' if defined?(Rails) && ENV['CANONICAL_HOST'].present?

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

@@ -0,0 +1,27 @@
+module Canonical
+  class Middleware
+    def initialize(app)
+      @app = app
+      @status, @headers, @body = nil
+    end
+
+    def call(env)
+      @status, @headers, @body = @app.call(env)
+      canonical_host = ENV['CANONICAL_HOST']
+      return [@status, @headers, @body] unless html? && canonical_host
+
+      @headers['Link'] = Middleware.canonical_tag(env, canonical_host)
+
+      [@status, @headers, @body]
+    end
+
+    def self.canonical_tag(env, canonical_host)
+      canonical = "#{env['rack.url_scheme']}://#{canonical_host}#{env['REQUEST_URI']}"
+      "<#{canonical}>; rel=\"canonical\""
+    end
+
+    def html?
+      @headers['Content-Type'] =~ /html/
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Canonical
+  class Railtie < Rails::Railtie
+    initializer 'canonical.configure_rack_middleware' do |app|
+      app.middleware.use Canonical::Middleware
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rack-canonical-header
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lukas Bischof
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A canonical URL tag for better SEO and to prevent search engines from
+  crawling different hosts
+email:
+- lukas.bischof@renuo.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rack-canonical-header.rb
+- lib/rack-canonical-header/middleware.rb
+- lib/rack-canonical-header/rails.rb
+- lib/rack-canonical-header/version.rb
+homepage: https://renuo.ch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A gem that inserts a canonical http header
+test_files: []