tb_redirects 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c08fd185fa92c73e68ea44979aa6fe3e0984a41
+  data.tar.gz: 7a3713cc31a038e24c141252093af03aa96dd9c6
+SHA512:
+  metadata.gz: 74b120125a4444632c803f795d68cfe9d14e559666021bf6dae1d43d18939102e8695cf3a22fd6c35a66590b43afaee393aee39f443224d244d780d94453346f
+  data.tar.gz: c5be1b08dacf4caf5b391f71f965ce3694887cf0749e6ff310676bf6c9de4635d0006ee133514ba0c616f14508d1aa324a7c26558fe4da1c9826e3f499a32020

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Greg Woods
+
+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/Rakefile

@@ -0,0 +1,37 @@
+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    = 'TbRedirects'
+  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/admin/tb_redirects.js

@@ -0,0 +1,19 @@
+// Tb Redirects
+
+(function(){
+
+app.admin.tb_redirects = {
+  index: function(){
+
+  },
+
+  show: function(){
+
+  },
+
+  edit: function(){
+
+  }
+};
+
+})();

data/app/assets/javascripts/tb_redirects.js

@@ -0,0 +1,15 @@
+// Tb Redirects
+
+(function(){
+
+app.tb_redirects = {
+  index: function(){
+
+  },
+
+  show: function(){
+
+  }
+};
+
+})();

data/app/assets/stylesheets/admin/tb_redirects.scss

@@ -0,0 +1,2 @@
+// Place tb_redirects admin styles here
+

data/app/assets/stylesheets/tb_redirects.scss

@@ -0,0 +1,2 @@
+// Place tb_redirects styles here
+

data/app/controllers/admin/tb_redirects_controller.rb

@@ -0,0 +1,57 @@
+class Admin::TbRedirectsController < Admin::ApplicationController
+
+  belongs_to_app :tb_redirects
+  add_breadcrumb "Redirects", :admin_tb_redirects_path
+  before_action :load_tb_redirect, :only => [:show, :edit, :update, :destroy]
+
+  def index
+    @tb_redirects = TbRedirect.ordered.paginate(:page => params[:page])
+    if params[:search]
+      @tb_redirects = @tb_redirects.search(params[:search])
+    end
+    respond_with @tb_redirects
+  end
+
+  def show
+    respond_with @tb_redirect
+  end
+
+  def new
+    @tb_redirect = TbRedirect.new
+    respond_with @tb_redirect
+  end
+
+  def create
+    if @tb_redirect = TbRedirect.create_smart(tb_redirect_params.merge(:created_by => 'user'))
+      flash[:notice] = 'Redirect created successfully'
+    end
+    respond_with @tb_redirect, :location => admin_tb_redirects_path
+  end
+
+  def edit
+    respond_with @tb_redirect
+  end
+
+  def update
+    if @tb_redirect.update_attributes(tb_redirect_params)
+      flash[:notice] = 'Redirect updated successfully'
+    end
+    respond_with @tb_redirect, :location => admin_tb_redirects_path
+  end
+
+  def destroy
+    flash[:notice] = 'Redirect deleted successfully' if @tb_redirect.destroy
+    respond_with @tb_redirect, :location => admin_tb_redirects_path
+  end
+
+private
+
+  def load_tb_redirect
+    @tb_redirect = TbRedirect.find_by!(:id => params[:id])
+  end
+
+  def tb_redirect_params
+    params.require(:tb_redirect).permit(:source, :destination)
+  end
+
+end

data/app/controllers/concerns/tb_redirects/handle_redirects.rb

@@ -0,0 +1,16 @@
+module TbRedirects::HandleRedirects
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from Spud::NotFoundError, :with => :check_for_applicable_redirect
+  end
+
+  def check_for_applicable_redirect(error)
+    if redirect = TbRedirect.find_by_uri(request.original_url)
+      redirect_to redirect.destination, :status => :moved_permanently
+    else
+      handle_request_error(error)
+    end
+  end
+
+end

data/app/helpers/admin/tb_redirects_helper.rb

@@ -0,0 +1,11 @@
+module Admin::TbRedirectsHelper
+
+  def created_by_for_tb_redirect(created_by)
+    if created_by == 'user'
+      content_tag :span, created_by.titleize, :class => 'label label-info'
+    else
+      content_tag :span, created_by.titleize, :class => 'label label-default'
+    end
+  end
+
+end

data/app/jobs/tb_redirects/detect_redirect_loop_job.rb

@@ -0,0 +1,34 @@
+class TbRedirects::DetectRedirectLoopJob < ActiveJob::Base
+  queue_as :default
+
+  attr_reader :attempts
+  MAX_ATTEMPTS = 100
+
+  def initialize(*arguments)
+    super(*arguments)
+    @attempts = 0
+  end
+
+  def perform(redirect)
+    parents = TbRedirect.where(:destination => redirect.source)
+    parents.each{ |p| search_parent(p, redirect.destination) }
+  end
+
+private
+
+  class AttemptsExceeded < StandardError
+  end
+
+  def search_parent(parent, destination_to_check)
+    @attempts += 1
+    raise AttemptsExceeded, "Exceeded #{MAX_ATTEMPTS} max attempts" if @attempts > MAX_ATTEMPTS
+
+    if parent.source == destination_to_check
+      parent.destroy
+    else
+      parents = TbRedirect.where(:destination => parent.source)
+      parents.each{ |p| search_parent(p, destination_to_check) }
+    end
+  end
+
+end

data/app/models/concerns/tb_redirects/has_redirects.rb

@@ -0,0 +1,8 @@
+module TbRedirects::HasRedirects
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :tb_redirects, :dependent => :destroy, :as => :owner
+  end
+
+end

data/app/models/tb_redirect.rb

@@ -0,0 +1,57 @@
+class TbRedirect < ActiveRecord::Base
+  scope :ordered, ->{ order('source desc') }
+  scope :search, ->(term){ where('source LIKE ?', "%#{term}%") }
+
+  belongs_to :owner, :polymorphic => true, :inverse_of => :tb_redirects
+
+  validates :source, :destination, :presence => true
+  validates :source, :uniqueness => true
+  validate :source_not_equals_destination
+  after_save :destroy_opposite_redirect
+  after_save :schedule_loop_detection
+
+  def self.find_by_uri(uri)
+    path = URI(uri).path
+    uri_without_params = uri.split('?').first
+    find_by(
+      arel_table[:source].eq(path)
+      .or(arel_table[:source].eq(uri_without_params))
+    )
+  rescue URI::InvalidURIError => e
+    logger.debug e.message
+    return nil
+  end
+
+  def self.create_smart(params)
+    redirect = find_or_initialize_by(:source => params.delete(:source))
+    redirect.assign_attributes(params)
+    redirect.save()
+    return redirect
+  end
+
+private
+
+  def source_not_equals_destination
+    if self.source == self.destination
+      errors.add(:destination, 'cannot be the same as the source')
+    end
+    return true
+  end
+
+  def destroy_opposite_redirect
+    opposite = TbRedirect.find_by({
+      :source => self.destination,
+      :destination => self.source
+    })
+    opposite.destroy if opposite.present?
+    return true
+  end
+
+  def schedule_loop_detection
+    if TbRedirect.where(:destination => source).count > 0
+      TbRedirects::DetectRedirectLoopJob.perform_later(self)
+    end
+    return true
+  end
+
+end

data/app/views/admin/tb_redirects/_form.html.erb

@@ -0,0 +1,15 @@
+<%= tb_form_for [:admin, @tb_redirect], :remote => true, :data => {:errors => :inline, :success => admin_tb_redirects_path} do |f| %>
+  
+  <%= tb_form_errors(f.object, :base) %>
+
+  <%= f.tb_text_field :source %>
+
+  <%= f.tb_text_field :destination %>
+
+  <%= f.tb_save_buttons('Redirect', admin_tb_redirects_path) %>
+
+<% end %>
+
+<script>
+  $(document).ready(app.admin.tb_redirects.edit);
+</script>

data/app/views/admin/tb_redirects/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/app/views/admin/tb_redirects/index.html.erb

@@ -0,0 +1,39 @@
+<% content_for :data_controls do %>
+  <%= render :partial => '/layouts/admin/search', :locals => {:search_path => admin_tb_redirects_path } %>
+  <%= link_to "New Redirect", new_admin_tb_redirect_path, :class => "btn btn-primary", :title => "New Redirect" %>
+<% end %>
+
+<% content_for :detail do %>
+  <div class="table-responsive">
+    <table class="table table-striped table-hover">
+      <thead>
+        <tr>
+          <th>Source</th>
+          <th>Destination</th>
+          <th>Created By</th>
+          <th>&nbsp;</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @tb_redirects.each do |tb_redirect| %>
+          <tr>
+            <td><%= link_to tb_redirect.source, tb_redirect.source, :target => :blank %></td>
+            <td><%= link_to tb_redirect.destination, tb_redirect.destination, :target => :blank %></td>
+            <td><%= created_by_for_tb_redirect(tb_redirect.created_by) %></td>
+            <td class="table-actions">
+              <%= link_to 'Details', admin_tb_redirect_path(tb_redirect), :class => 'btn btn-default btn-sm' %>
+              <%= link_to 'Edit', edit_admin_tb_redirect_path(tb_redirect), :class => 'btn btn-default btn-sm' %>
+              <%= link_to 'Delete', admin_tb_redirect_path(tb_redirect), :method => :delete, :class => 'btn btn-danger btn-sm' %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+  <%= will_paginate @tb_redirects, :renderer => BootstrapPagination::Rails %>
+
+  <script>
+    $(document).ready(app.admin.tb_redirects.index);
+  </script>
+
+<% end %>

data/app/views/admin/tb_redirects/new.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/app/views/admin/tb_redirects/show.html.erb

@@ -0,0 +1,21 @@
+<% content_for :data_controls do %>
+  <%= link_to 'Edit', edit_admin_tb_redirect_path(@tb_redirect), :class => 'btn btn-default' %>
+  <%= link_to "Back", admin_tb_redirects_path, :class => "btn btn-default" %>
+<% end %>
+
+<dl class="dl-horizontal">
+  <dt>Owner Type:</dt>
+  <dd><%= @tb_redirect.owner_type %></dd>
+  <dt>Owner:</dt>
+  <dd><%= @tb_redirect.owner_id %></dd>
+  <dt>Source:</dt>
+  <dd><%= @tb_redirect.source %></dd>
+  <dt>Destination:</dt>
+  <dd><%= @tb_redirect.destination %></dd>
+  <dt>Created By:</dt>
+  <dd><%= @tb_redirect.created_by %></dd>
+</dl>
+
+<script>
+  $(document).ready(app.admin.tb_redirects.show);
+</script>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :admin do
+    resources :tb_redirects, :path => 'redirects'
+  end
+end

data/db/migrate/20160211162513_create_tb_redirects.rb

@@ -0,0 +1,14 @@
+class CreateTbRedirects < ActiveRecord::Migration
+  def change
+    create_table :tb_redirects do |t|
+      t.string :owner_type
+      t.integer :owner_id
+      t.string :source, :null => false
+      t.string :destination, :null => false
+      t.string :created_by
+      t.timestamps null: false
+    end
+    add_index :tb_redirects, [:owner_type, :owner_id]
+    add_index :tb_redirects, :source, :unique => true
+  end
+end

data/lib/tasks/tb_redirects_tasks.rake

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

data/lib/tb_redirects/engine.rb

@@ -0,0 +1,28 @@
+require 'tb_core'
+
+module TbRedirects
+  class Engine < ::Rails::Engine
+    engine_name 'tb_redirects'
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper true
+    end
+
+    initializer 'tb_redirects.admin', :before => 'tb_core.admin' do |config|
+      Spud::Core.admin_applications += [
+        {:name => 'Redirects', :key => :tb_redirects, :thumbnail => "admin/module_icon.png", :url => '/admin/redirects'},
+      ]
+    end
+
+    initializer 'tb_redirects.controllers' do |config|
+      ActiveSupport.on_load(:action_controller) do
+        Spud::ApplicationController.send :include, TbRedirects::HandleRedirects
+      end
+    end
+
+  end
+end

data/lib/tb_redirects/version.rb

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

data/lib/tb_redirects.rb

@@ -0,0 +1,4 @@
+require "tb_redirects/engine"
+
+module TbRedirects
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: tb_redirects
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Woods
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tb_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+description: TbRedirects provides a tool for creating and managing 301 redirects for
+  your website
+email:
+- greg@westlakedesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/admin/tb_redirects.js
+- app/assets/javascripts/tb_redirects.js
+- app/assets/stylesheets/admin/tb_redirects.scss
+- app/assets/stylesheets/tb_redirects.scss
+- app/controllers/admin/tb_redirects_controller.rb
+- app/controllers/concerns/tb_redirects/handle_redirects.rb
+- app/helpers/admin/tb_redirects_helper.rb
+- app/jobs/tb_redirects/detect_redirect_loop_job.rb
+- app/models/concerns/tb_redirects/has_redirects.rb
+- app/models/tb_redirect.rb
+- app/views/admin/tb_redirects/_form.html.erb
+- app/views/admin/tb_redirects/edit.html.erb
+- app/views/admin/tb_redirects/index.html.erb
+- app/views/admin/tb_redirects/new.html.erb
+- app/views/admin/tb_redirects/show.html.erb
+- config/application.rb
+- config/routes.rb
+- db/migrate/20160211162513_create_tb_redirects.rb
+- lib/tasks/tb_redirects_tasks.rake
+- lib/tb_redirects.rb
+- lib/tb_redirects/engine.rb
+- lib/tb_redirects/version.rb
+homepage: https://bitbucket.org/westlakedesign/tb_redirects
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple redirect management for Twice Baked
+test_files: []