refinerycms-redirections 2.0.10.0

data/README.md

@@ -0,0 +1,28 @@
+This a RefineryCMS plugin for managing redirections from the backend.
+
+Installing
+==========
+
+In Gemfile `gem "refinerycms-redirections", "~> 2.0.10.0"`
+
+Run `bundle install`
+
+And then run `rails g refinery:redirections` to install migrations and a configuration initializer.
+
+Current status
+==============
+
+The plugin includes a back section for managing the redirections where you can set the original URL, the URL we want to redirect to and the HTTP status code we want to return.
+
+It also includes a set of url params which should be avoided when comparing urls (cause we don't want any campaign params to ruin our redirections, right?).
+
+Redirections are performed with a mix of rack-rewrite rules and a plain old controller. Each option had its drawbacks so we thought it would be great to have both and being able to disable each of them from the config file.
+
+Wishlist
+========
+
+* Redirections are quite regular data and they could be managed through a CSV or XLS file. It would be great *to import such a file with redirections*
+
+* *Priority*
+
+* Support Regexp redirections: Right now, regexp are supported (I think) via rack rewrite, but if we want regexp supported in the controller version we should research about database regexp support

data/app/controllers/refinery/redirections/admin/redirections_controller.rb

@@ -0,0 +1,11 @@
+module Refinery
+  module Redirections
+    module Admin
+      class RedirectionsController < ::Refinery::AdminController
+
+        crudify :'refinery/redirections/redirection', title_attribute: :from_url
+
+      end
+    end
+  end
+end

data/app/controllers/refinery/redirections/redirections_controller.rb

@@ -0,0 +1,8 @@
+class Refinery::Redirections::RedirectionsController < ActionController::Base
+
+  def redirect
+    redirection = Refinery::Redirections::Redirection.from_url(request.fullpath).first
+      redirect_to redirection.to_url, status: redirection.status_code unless redirection.nil?
+  end
+
+end

data/app/models/refinery/redirections/redirection.rb

@@ -0,0 +1,35 @@
+class Refinery::Redirections::Redirection < ActiveRecord::Base
+  extend Enumerize
+
+  attr_accessible :from_url, :status_code, :to_url
+
+  enumerize :status_code, in: ["301", "302", "303", "307"]
+
+  validates :from_url, :status_code, :to_url, presence: true
+
+  before_save :sanitize_path
+
+  def sanitize_path
+    self.from_url = self.class.sanitize_path from_url
+  end
+
+  scope :from_url, ->(path) { where from_url: sanitize_path(path) }
+
+  # This method gets a path and 'sanitizes it'. This means that all the params that we don't want (Google Analytics params, testing params...) are stripped out and params are sorted so '/en?a=1&b=1' and '/en?b=1&a=1' are the same
+  def self.sanitize_path path, ignored_path_params = Refinery::Redirections.ignored_path_params
+    path, params = path.split("?")
+    if params.blank?
+      path
+    else
+      # We split the params
+      params = params.split('&')
+      # And then get those ignored and remove them
+      not_ignored_params = params.reject{|p| ignored_path_params.detect{|ignored| p.start_with?("#{ignored}=") || (p == ignored)}}
+
+      not_ignored_params.blank? ? path : "#{path}?#{not_ignored_params.sort.join('&')}"
+
+    end
+
+  end
+
+end

data/app/views/refinery/redirections/admin/redirections/_actions.html.erb

@@ -0,0 +1,11 @@
+<ul>
+  <li>
+    <%= link_to t('.create_new'), refinery.new_redirections_admin_redirection_path,
+                 :class => "add_icon" %>
+  </li>
+  <li>
+    <%= link_to t('.list'), refinery.redirections_admin_redirections_path,
+                 :class => "manage_icon" %>
+  </li>
+</ul>
+

data/app/views/refinery/redirections/admin/redirections/_form.html.erb

@@ -0,0 +1,12 @@
+<%= form_for [refinery, :redirections_admin, object],  html: {multipart: true} do |f| -%>
+  <%= render '/refinery/admin/error_messages',
+              :object => object,
+              :include_object_name => true %>
+
+  <%= render "/refinery/redirections/admin/redirections/inner_form", f: f, object: object %>
+
+  <%= render '/refinery/admin/form_actions', :f => f,
+             :continue_editing => true,
+             :delete_title => t('delete', :scope => "refinery.redirections.admin.redirections"),
+             :delete_confirmation => t('message', :scope => 'refinery.admin.delete', :title => object.from_url) %>
+<% end -%>

data/app/views/refinery/redirections/admin/redirections/_index.html.erb

@@ -0,0 +1,6 @@
+<section id='records'>
+  <%= render 'refinery/redirections/admin/redirections/records', records: records %>
+</section>
+<aside id='actions'>
+  <%= render 'actions' %>
+</aside>

data/app/views/refinery/redirections/admin/redirections/_inner_form.html.erb

@@ -0,0 +1,15 @@
+<div class='field'>
+  <%= f.label :from_url -%>
+  <%= f.text_field :from_url, :class => 'larger widest'  -%>
+</div>
+
+<div class='field'>
+  <%= f.label :to_url -%>
+  <%= f.text_field :to_url, :class => 'larger widest'  -%>
+</div>
+
+<div class='field'>
+  <%= f.label :status_code -%>
+
+  <%= f.select :status_code, Refinery::Redirections::Redirection.status_code.options, class: 'widest'  -%>
+</div>

data/app/views/refinery/redirections/admin/redirections/_records.html.erb

@@ -0,0 +1,15 @@
+<div class='pagination_container'>
+  <% if records.any? %>
+
+    <%= will_paginate records if controller.class.pageable? %>
+    <ul id='sortable_list'>
+      <%= render partial: "/refinery/redirections/admin/redirections/redirection", collection: records, as: 'redirection' %>
+    </ul>
+  <% else %>
+    <p>
+      <strong>
+        <%= t('.no_items_yet') %>
+      </strong>
+    </p>
+  <% end %>
+</div>

data/app/views/refinery/redirections/admin/redirections/_redirection.html.erb

@@ -0,0 +1,18 @@
+<li class='clearfix record <%= cycle("on", "on-hover") %>' id="<%= dom_id(redirection) -%>">
+  <span class='title'>
+    <%= redirection.from_url %>
+  </span>
+  <span>
+    <%= redirection.to_url %>
+  </span>
+  <span class='actions'>
+
+    <%= link_to refinery_icon_tag("application_edit.png"), refinery.edit_redirections_admin_redirection_path(redirection),
+         :title => t('.edit') %>
+    <%= link_to refinery_icon_tag("delete.png"), refinery.redirections_admin_redirection_path(redirection),
+        :class => "cancel confirm-delete",
+        :title => t('.delete'),
+        :confirm => t('message', :scope => 'refinery.admin.delete', :title => redirection.from_url),
+        :method => :delete %>
+  </span>
+</li>

data/app/views/refinery/redirections/admin/redirections/_redirections.html.erb

@@ -0,0 +1 @@
+<%= render 'refinery/redirections/admin/redirections/records', records: @redirections %>

data/app/views/refinery/redirections/admin/redirections/edit.html.erb

@@ -0,0 +1,3 @@
+<%= render 'refinery/redirections/admin/redirections/form', object: @redirection %>
+
+

data/app/views/refinery/redirections/admin/redirections/index.html.erb

@@ -0,0 +1 @@
+<%= render 'refinery/redirections/admin/redirections/index', records: @redirections %>

data/app/views/refinery/redirections/admin/redirections/new.html.erb

@@ -0,0 +1,2 @@
+<%= render 'refinery/redirections/admin/redirections/form', object: @redirection %>
+

data/config/locales/en/models/redirections.yml

@@ -0,0 +1,16 @@
+en:
+  activerecord:
+    attributes:
+      refinery/redirections/redirection:
+        from_url: Url we redirect from
+        to_url: Url we redirect to
+        status_code: Redirection type
+    models:
+      refinery/redirections/redirection: 'Redirection'
+  enumerize:
+    refinery/redirections/redirection:
+      status_code:
+        "301": "Permanente redirection (301)"
+        "302": "Found (302)"
+        "303": "See Other (303)"
+        "307": "Temporary redirect (307)"

data/config/locales/en/plugin.yml

@@ -0,0 +1,5 @@
+en:
+  refinery:
+    plugins:
+      refinerycms_redirections:
+        title: Redirecciones

data/config/locales/en/views/admin/redirections.yml

@@ -0,0 +1,14 @@
+en:
+  refinery:
+    redirections:
+      admin:
+        redirections:
+          actions:
+            create_new: Create new redirection
+            list: View all redirections
+          records:
+            title: Redirections
+            no_items_yet: "There are no redirections yet. click on 'Create new redirection' to create your first redirection."
+          redirection:
+            edit: Edit this redirection
+            delete: Delete this redirection

data/config/locales/es/models/redirections.yml

@@ -0,0 +1,16 @@
+es:
+  activerecord:
+    attributes:
+      refinery/redirections/redirection:
+        from_url: Url original
+        to_url: Url a la que redirigir
+        status_code: Tipo de redirección
+    models:
+      refinery/redirections/redirection: 'Redirección'
+  enumerize:
+    refinery/redirections/redirection:
+      status_code:
+        "301": "Redirección permanente (301)"
+        "302": "Redirección temporal (302)"
+        "303": "Vea Otra (303)"
+        "307": "Redirección temporal (307)"

data/config/locales/es/plugin.yml

@@ -0,0 +1,5 @@
+es:
+  refinery:
+    plugins:
+      refinerycms_redirections:
+        title: Redirecciones

data/config/locales/es/views/admin/redirections.yml

@@ -0,0 +1,14 @@
+es:
+  refinery:
+    redirections:
+      admin:
+        redirections:
+          actions:
+            create_new: Crear nueva redirección
+            list: Ver todas las redirecciones
+          records:
+            title: Redirecciones
+            no_items_yet: "No hay redirecciones todavía. Pulsa en 'Crear nuevo redirección' para crear tu primer redirección."
+          redirection:
+            edit: Editar esta redirección
+            delete: Borrar esta redirección para siempre

data/config/routes.rb

@@ -0,0 +1,13 @@
+Refinery::Core::Engine.routes.prepend do
+
+  if Refinery::Redirections.enable_route_redirection
+    match "/*path" => 'redirections/redirections#redirect', constraints: Refinery::Redirections::RoutesConstraint
+  end
+
+  namespace :redirections, path: '' do
+    namespace :admin, :path => 'refinery' do
+      resources :redirections, :except => :show
+    end
+  end
+
+end

data/db/migrate/20130826114744_create_redirections.rb

@@ -0,0 +1,11 @@
+class CreateRedirections < ActiveRecord::Migration
+  def change
+    create_table Refinery::Redirections::Redirection.table_name do |t|
+      t.string :from_url
+      t.string :to_url
+      t.integer :status_code, default: 301
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/refinery/redirections/redirections_generator.rb

@@ -0,0 +1,15 @@
+module Refinery
+  class RedirectionsGenerator < Rails::Generators::Base
+
+    source_root File.expand_path("../templates/", __FILE__)
+
+    def generate_ue_core_initializer
+      template "config/initializers/refinery/redirections.rb.erb", File.join(destination_root, "config", "initializers", "refinery", "redirections.rb")
+    end
+
+    def rake_db
+      rake("refinery_redirections:install:migrations")
+    end
+
+  end
+end

data/lib/generators/refinery/redirections/templates/config/initializers/refinery/redirections.rb.erb

@@ -0,0 +1,17 @@
+Refinery::Redirections.configure do |config|
+
+  # Here we include params in the path that must be ignored when looking for a redirection
+  config.ignored_path_params = <%= Refinery::Redirections.ignored_path_params.inspect %>
+
+  # Here we enable rack rewrite redirection. This will create rack rewrite rules on startup and enable its redirections.
+  # WARNING: Any new redirection in the back requires the app to restart
+  # WARNING: Changing this setting requires the app to restart
+  config.enable_rack_redirection = <%= Refinery::Redirections.enable_rack_redirection.inspect %>
+
+  # Here we enable the redirections controller through a route in the config/routes.rb file. This will create a redirection route that will match every request
+  # WARNING: Any new redirection will be applied inmediately
+  # WARNING: This will execute one database query per request to check if a redirection is present, increasing DB load
+  # WARNING: Changing this setting requires the app to restart
+  config.enable_route_redirection = <%= Refinery::Redirections.enable_route_redirection.inspect %>
+
+end

data/lib/refinery/redirections.rb

@@ -0,0 +1,28 @@
+require 'refinerycms-core'
+require 'rack/rewrite'
+require 'enumerize'
+
+module Refinery
+
+  autoload :RedirectionsGenerator, 'generators/refinery/redirections/redirections_generator'
+
+  module Redirections
+
+    require 'refinery/redirections/engine'
+    require 'refinery/redirections/configuration'
+    require 'refinery/redirections/routes_constraint'
+
+    attr_writer :root
+
+    class << self
+      def root
+        @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+      end
+
+      def factory_paths
+        @factory_paths ||= [ root.join("spec/factories").to_s ]
+      end
+    end
+  end
+end
+

data/lib/refinery/redirections/configuration.rb

@@ -0,0 +1,14 @@
+module Refinery
+  module Redirections
+    include ActiveSupport::Configurable
+
+    config_accessor :ignored_path_params
+    config_accessor :enable_rack_redirection
+    config_accessor :enable_route_redirection
+
+    self.ignored_path_params = ["utm_medium","utm_source","utm_campaign","utm_content","utm_term"]
+    self.enable_rack_redirection = true
+    self.enable_route_redirection = true
+
+  end
+end

data/lib/refinery/redirections/engine.rb

@@ -0,0 +1,42 @@
+module Refinery
+  module Redirections
+    class Engine < Rails::Engine
+      include Refinery::Engine
+
+      isolate_namespace Refinery::Redirections
+
+      initializer "register refinerycms_redirections plugin" do
+        Refinery::Plugin.register do |plugin|
+          plugin.pathname = root
+          plugin.name = "refinerycms_redirections"
+          plugin.url = proc { Refinery::Core::Engine.routes.url_helpers.redirections_admin_redirections_path }
+          plugin.menu_match = /refinery\/redirections\/?/
+          plugin.activity = { :class_name => :'refinery/redirections/redirection' }
+        end
+      end
+
+      config.after_initialize do
+        Refinery.register_engine(Refinery::Redirections)
+      end
+
+
+      initializer 'add rack rewrite rules' do |app|
+
+        if Refinery::Redirections.enable_rack_redirection
+          app.config.middleware.insert_before(Rack::Lock, Rack::Rewrite) do
+            Refinery::Redirections::Redirection.all.each do |redirection|
+              if self.respond_to? "r#{redirection.status_code}"
+                send("r#{redirection.status_code}", redirection.from_url, redirection.to_url)
+              end
+            end
+          end
+        end
+
+      end
+
+      paths["config/locales"] << "config/locales/**"
+
+
+    end
+  end
+end

data/lib/refinery/redirections/routes_constraint.rb

@@ -0,0 +1,20 @@
+module Refinery::Redirections
+  class RoutesConstraint
+
+    # A redirection must be found in the database
+    def self.matches?(request)
+
+      redirection = Refinery::Redirections::Redirection.from_url(request.fullpath).first
+
+      if redirection.nil?
+        Rails.logger.info "[Redirections] Redirection not found for: #{request.fullpath.inspect}"
+      else
+        Rails.logger.info "[Redirections] Redirection found from: #{request.fullpath.inspect} to #{redirection.to_url} with status #{redirection.status_code}"
+      end
+
+      !redirection.nil?
+
+    end
+
+  end
+end

data/lib/refinerycms-redirections.rb

@@ -0,0 +1 @@
+require 'refinery/redirections'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: refinerycms-redirections
+version: !ruby/object:Gem::Version
+  version: 2.0.10.0
+  prerelease: 
+platform: ruby
+authors:
+- david.brenes@the-cocktail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refinerycms-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.10
+- !ruby/object:Gem::Dependency
+  name: refinerycms-i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rack-rewrite
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: enumerize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: refinerycms-testing
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.10
+description: RefineryCMS plugin for managing HTTP redirections
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/refinery/redirections/redirection.rb
+- app/views/refinery/redirections/admin/redirections/_actions.html.erb
+- app/views/refinery/redirections/admin/redirections/new.html.erb
+- app/views/refinery/redirections/admin/redirections/_redirections.html.erb
+- app/views/refinery/redirections/admin/redirections/_redirection.html.erb
+- app/views/refinery/redirections/admin/redirections/_inner_form.html.erb
+- app/views/refinery/redirections/admin/redirections/edit.html.erb
+- app/views/refinery/redirections/admin/redirections/index.html.erb
+- app/views/refinery/redirections/admin/redirections/_records.html.erb
+- app/views/refinery/redirections/admin/redirections/_form.html.erb
+- app/views/refinery/redirections/admin/redirections/_index.html.erb
+- app/controllers/refinery/redirections/admin/redirections_controller.rb
+- app/controllers/refinery/redirections/redirections_controller.rb
+- config/routes.rb
+- config/locales/es/models/redirections.yml
+- config/locales/es/plugin.yml
+- config/locales/es/views/admin/redirections.yml
+- config/locales/en/models/redirections.yml
+- config/locales/en/plugin.yml
+- config/locales/en/views/admin/redirections.yml
+- db/migrate/20130826114744_create_redirections.rb
+- lib/refinerycms-redirections.rb
+- lib/generators/refinery/redirections/redirections_generator.rb
+- lib/generators/refinery/redirections/templates/config/initializers/refinery/redirections.rb.erb
+- lib/refinery/redirections.rb
+- lib/refinery/redirections/routes_constraint.rb
+- lib/refinery/redirections/engine.rb
+- lib/refinery/redirections/configuration.rb
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: RefineryCMS plugin for managing HTTP redirections
+test_files: []