katgut 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 042b13c3474e8a85d7bfa2d7491b8c6232ea4ffa
+  data.tar.gz: a4ccdcfe656a435c6c5c8be9f84a20a20da0ce1d
+SHA512:
+  metadata.gz: b52ff06cb0d08a8131affd2d5d1f9a4ae1af0326206980f295d7fbb7e0181dbb92da3dec5a7273600142e994f7b5922852677ffa8c2369e8bd356ab99f89b721
+  data.tar.gz: 3e55f17958e6709406a3fb35ffc254d96286919ce4dc9754d27062ab8a98c954219dee7e9ef756d1a6b99bfbe16e5503cc64956cd578f9681053858e9eea72f4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 HAMADA Kazuki
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Katgut
+Katgut is a Rails Engine for adding simple url redirection features to your apps.
+
+The gem provides:
+* Dynamic redirection rules on DB
+* After redirection callbacks
+
+# Requirements
+* Ruby 2.3 or later
+* Rails 4.2.6 or later
+
+# Installation
+Add `katgut` to your Gemfile
+
+```ruby
+gem 'katgut', '~> 0.0.1'
+```
+
+Then install the migration files by running:
+
+```bash
+$ rake katgut:install:migrations
+```
+
+And apply them to your database.
+
+```bash
+$ rake db:migrate
+```
+
+Katgut is implemented as an Rails Engine. You can mount it anywhere you like:
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  mount Katgut::Engine => "/katgut"  # /katgut/xxxxxx will be the redirection path
+end
+```
+
+# Usage
+## Defining the redirection rules
+The redirection rules will be stored in `katgut_rules` table. A rule is a set of following parameters:
+
+Example:
+
+```ruby
+# Define a rule...
+Katgut::Rule.new(source: "go-to-google", destination: "https://www.google.co.jp/").save
+
+# ... to create this redirection
+# GET /katgut/go-to-google => GET https://www.google.co.jp/
+```
+
+You can set these 3 attributes to each redirection rule.
+
+* source
+* destination
+* active
+
+### `source`
+Set a unique key to determine which rule should be used to redirect the request.
+Only word characters and hyphens\(`[^a-zA-Z0-9_\-]`) are allowed and at least 5 characters needed.
+
+```
+/mount_point/:source
+```
+
+### `destination`
+Set the desination url.
+
+* You can omit `http://` scheme.
+* Only `http` and `https` schemes are allowed.
+* Urls begin with `/` will be assumed as a same-origin path.
+
+### `active`
+Set `false` to ignore the rule.
+
+## Customization
+You can customize the behavour of the gem through the initializer script.
+
+```bash
+$ rails g katgut:initializer
+# => config/initializers/katgut.rb
+```
+
+### Fallback path
+You can set a alternative destination url for the case the given source url does not exist.
+
+```ruby
+Katgut.configure do |config|
+  config.fall_back_path = '/not_found.html'  # default: '/'
+end
+```
+
+### Custom codes after redirection
+You can define a custom block that will be called after every redirection.
+The block should have 3 argumets: `request`, `parameters` and `rule`.
+The `rule` will be `nil` when the specified source url on the request was not valid.
+
+```ruby
+Katgut.configure do |config|
+  config.after_refirection_callback = do |request, parameters, rule|
+    # add custom behaviour here, such as logging, overwriting the rule, etc...
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Katgut'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/katgut/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/katgut/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/katgut/application_controller.rb

@@ -0,0 +1,5 @@
+module Katgut
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/katgut/rules_controller.rb

@@ -0,0 +1,21 @@
+module Katgut
+  class RulesController < ApplicationController
+    def show
+      @rule = Rule.active.find_by!(source: params[:id])
+      redirect_to @rule.regular_destination
+    rescue => e
+      redirect_to Katgut.config.fall_back_path
+    ensure
+      after_redirection_callback
+    end
+
+    private
+
+    def after_redirection_callback
+      cb = Katgut.config.after_redirection_callback
+      return unless cb
+
+      instance_exec(request, params, @rule, &cb)
+    end
+  end
+end

data/app/helpers/katgut/application_helper.rb

@@ -0,0 +1,4 @@
+module Katgut
+  module ApplicationHelper
+  end
+end

data/app/models/katgut/rule.rb

@@ -0,0 +1,57 @@
+module Katgut
+  class Rule < ActiveRecord::Base
+    ALLOWED_SCHEMES       = [:https, :http]
+    DEFAULT_SCHEME        = :http
+    MINIMUM_SOURCE_LENGTH = 5
+
+    scope :active, -> { where(active: true) }
+
+    validates :source,
+      uniqueness: true,
+      presence:   true,
+      format:     { with: /\A[a-zA-Z0-9\-_]*\z/ },
+      length:     { in: MINIMUM_SOURCE_LENGTH .. 255 }
+    validates :destination,
+      presence: true,
+      format:   { without: URI::UNSAFE },
+      length:   { maximum: 255 }
+    validate :ensure_destination_has_no_unallowed_scheme
+
+    def regular_destination
+      if URI.extract(destination).present?
+        destination
+      else
+        case destination
+        when /\A\//
+          destination
+        else
+          "#{self.class::DEFAULT_SCHEME}://#{destination}"
+        end
+      end
+    end
+
+    private
+
+    class << self
+      def allowed_schemes_with_suffix
+        ALLOWED_SCHEMES.map {|s| "#{s}://" }
+      end
+
+      def unallowed_scheme_in?(url)
+        if url.present?
+          !URI.extract(url).all? do |str|
+            ALLOWED_SCHEMES.include? URI.split(str)[0].to_sym
+          end
+        else
+          false
+        end
+      end
+    end
+
+    def ensure_destination_has_no_unallowed_scheme
+      if self.class.unallowed_scheme_in?(destination)
+        errors.add(:destination, "has unallowed scheme.")
+      end
+    end
+  end
+end

data/app/views/layouts/katgut/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Katgut</title>
+  <%= stylesheet_link_tag    "katgut/application", media: "all" %>
+  <%= javascript_include_tag "katgut/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Katgut::Engine.routes.draw do
+  get '/:id', to: 'rules#show'
+end

data/db/migrate/20160704065128_create_katgut_rules.rb

@@ -0,0 +1,13 @@
+class CreateKatgutRules < ActiveRecord::Migration
+  def change
+    create_table :katgut_rules do |t|
+      t.string :source, null: false
+      t.string :destination, null: false
+      t.boolean :active, null: false, default: false
+
+      t.timestamps null: false
+    end
+
+    add_index :katgut_rules, :source, unique: true, name: 'idx_katgut_source'
+  end
+end

data/lib/generators/katgut/initializer/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a boilerplate of config file for Katgut.
+    You can modify the generated file to change the behaviour of the engine.
+
+Example:
+    rails generate katgut:initializer
+
+    This will create:
+        config/initializers/katgut.rb

data/lib/generators/katgut/initializer/initializer_generator.rb

@@ -0,0 +1,9 @@
+module Katgut
+  class InitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_initializer_file
+      copy_file "initializer.rb", "config/initializers/katgut.rb"
+    end
+  end
+end

data/lib/generators/katgut/initializer/templates/initializer.rb

@@ -0,0 +1,4 @@
+Katgut.configure do |config|
+  config.after_redirection_callback = nil
+  config.fall_back_path = ''
+end if defined?(Katgut)

data/lib/katgut.rb

@@ -0,0 +1,12 @@
+require "katgut/engine"
+require "katgut/config"
+
+module Katgut
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config if block_given?
+  end
+end

data/lib/katgut/config.rb

@@ -0,0 +1,11 @@
+module Katgut
+  class Config
+    include ActiveSupport::Configurable
+    config_accessor :after_redirection_callback, :fall_back_path
+
+    configure do |config|
+      config.after_redirection_callback = nil
+      config.fall_back_path = '/'
+    end
+  end
+end

data/lib/katgut/engine.rb

@@ -0,0 +1,14 @@
+module Katgut
+  class Engine < ::Rails::Engine
+    isolate_namespace Katgut
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: "spec/factories"
+    end
+
+    initializer "static assets" do |app|
+      app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public")
+    end
+  end
+end

data/lib/katgut/version.rb

@@ -0,0 +1,3 @@
+module Katgut
+  VERSION = "0.0.1"
+end

data/lib/tasks/katgut_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :katgut do
+#   # Task goes here
+# end

data/public/katgut_success.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta charset="utf-8">
+    <title>Katgut works perfectly!</title>
+    <meta name="description" content="Katgut test page">
+    <meta name="author" content="hello">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+  </head>
+  <body>
+    It works!
+  </body>
+</html>

data/spec/controllers/rules_controller_spec.rb

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+module Katgut
+  describe RulesController do
+    routes { Engine.routes }
+
+    describe "#after_redirection_callback" do
+      let!(:rule) { create(:rule, destination: "/advice") }
+      let!(:callback) { -> (request, params, rule) { throw :called } }
+
+      context "after redirection callback is not set in config" do
+        it "doesn't calls the after redirection callback" do
+          expect {
+            get :show, id: 'advice'
+          }.not_to throw_symbol :called
+        end
+      end
+
+      context "after redirection callback is set" do
+        before do
+          allow(Katgut.config).to(
+            receive(:after_redirection_callback)
+              .and_return(callback)
+          )
+        end
+
+        it "calls the after redirection callback" do
+          expect {
+            get :show, id: 'advice'
+          }.to throw_symbol :called
+        end
+      end
+    end
+  end
+end