not_found_catcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7991ac97bef725470d70a77ad378e7cbf4f24eeb
+  data.tar.gz: '0051002885918d4274ce36a530edea8dc18e0466'
+SHA512:
+  metadata.gz: 0f9e687d926cbcfcb0895b1f363cc7b501076a552aafe4cf18707e935e39c732874b88ff94f47b4997c7a451093075db508b858f312f2ef4e034a2462a3a1fa5
+  data.tar.gz: be2aeb383e882a90b850193da0eea12ee5e51e8b70ac7151c17c5c4bd0a709cbcc71ab05dfdc9e91c48697117e5a4d3dcb596776b268ac7c594a8b17f80ff7f2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Marino Bonetti
+
+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,39 @@
+# NotFoundCatcher
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'not_found_catcher'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Installazione dell'inizializzatore
+```bash
+bin/rails g not_found_catcher install
+```
+
+## Usage
+After installing go to /not_found_catcher and you will see the administration panel, it's a simple 
+wrapper around the yml file with the configurations.
+If an error occur of not_found inside the applicaion, the yml file will be populated.
+You can define simple redirects matching exat the value, or you can use regexp to catch more errors and
+redirect these to logic redirects:
+
+/category/(.*)  => http://example.com?category=$1
+
+	
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+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    = 'NotFoundCatcher'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/not_found_catcher_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/not_found_catcher .js
+//= link_directory ../stylesheets/not_found_catcher .css

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

@@ -0,0 +1,14 @@
+// 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .
+//= require rails-ujs

data/app/assets/stylesheets/not_found_catcher/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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/not_found_catcher/application_controller.rb

@@ -0,0 +1,5 @@
+module NotFoundCatcher
+  class ApplicationController < NotFoundCatcher.base_admin_controller.constantize
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/not_found_catcher/exceptions_controller.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+module NotFoundCatcher
+  class ExceptionsController < NotFoundCatcher.base_catcher_controller.constantize
+
+    def show
+      raise NotFoundRouteException.new(request)
+    end
+
+  end
+end

data/app/controllers/not_found_catcher/roles_controller.rb

@@ -0,0 +1,49 @@
+module NotFoundCatcher
+  class RolesController < NotFoundCatcher::ApplicationController
+
+    before_action :load_object, only: [:edit, :update, :destroy]
+
+    def index
+      @store = NotFoundCatcher.request_store
+    end
+
+    def edit
+    end
+
+    def update
+      @obj.assign_attributes(params.require(:role).permit(:role, :method, :redirect))
+
+
+      respond_to do |f|
+
+        if @obj.valid?
+
+          @obj.save
+          f.html {redirect_to root_path}
+        else
+          render :edit
+        end
+
+      end
+
+    end
+
+    def destroy
+      respond_to do |f|
+
+        if @obj.destroy
+          f.html {redirect_to root_path}
+        else
+          render :edit
+        end
+
+      end
+    end
+
+    private
+    def load_object
+      @obj = NotFoundCatcher.request_store.find(params[:id]).model
+    end
+
+  end
+end

data/app/helpers/not_found_catcher/application_helper.rb

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

data/app/jobs/not_found_catcher/application_job.rb

@@ -0,0 +1,4 @@
+module NotFoundCatcher
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/lib/not_found_catcher/not_found_route_exception.rb

@@ -0,0 +1,12 @@
+module NotFoundCatcher
+  class NotFoundRouteException < StandardError
+
+    attr_accessor :request
+
+    def initialize(request)
+      @request = request
+      super("Not Found Routes #{request.fullpath}")
+    end
+
+  end
+end

data/app/lib/not_found_catcher/request_parser.rb

@@ -0,0 +1,56 @@
+module NotFoundCatcher
+  class RequestParser < Struct.new(:role, :method, :redirect)
+
+
+    def considered?
+      !redirect.blank?
+    end
+
+    def build_redirect(request)
+
+      request.fullpath.gsub(Regexp.new(self.role),self.redirect.gsub(/\$([0-9]+)/,'$$$1').gsub('$$$','\\'))
+
+    end
+
+    ##
+    # Return the relative model for this record
+    def model
+
+      r = Role.new(
+        role: self.role,
+        http_method: self.method,
+        redirect: self.redirect
+      )
+      r.request_parser = self
+      r
+
+    end
+
+
+    ##
+    # Cerca se stesso all'interno dello store e si salva
+    def save
+      store = NotFoundCatcher.request_store.store
+      store.transaction do
+
+        store[self.role] = self
+
+      end
+
+
+    end
+
+    def id
+      Digest::MD5.hexdigest(self.role)
+    end
+
+    def destroy
+      store = NotFoundCatcher.request_store.store
+      store.transaction do
+        store.delete(self.role)
+      end
+    end
+
+
+  end
+end

data/app/lib/not_found_catcher/request_store.rb

@@ -0,0 +1,77 @@
+require 'yaml/store'
+class NotFoundCatcher::RequestStore
+
+  attr_accessor :path
+
+  def initialize(path)
+    self.path = path
+  end
+
+
+  def parse(request)
+
+    key = get_first_match(request.fullpath)
+
+    store.transaction do
+
+      if key
+        req = store[key]
+      else
+        req = store[request.fullpath] = NotFoundCatcher::RequestParser.new(request.fullpath, request.request_method, nil)
+      end
+
+      yield req
+
+    end
+
+
+  end
+
+  ##
+  # Restituisce la prima chiave matchata
+  def get_first_match(path)
+
+    store.transaction(true) do
+
+      store.roots.each do |k|
+
+        if path.match(k)
+          return k
+        end
+
+      end
+    end
+    false
+  end
+
+  def each
+
+    store.transaction(true) do
+
+      store.roots.each do |k|
+
+        yield store[k]
+
+      end
+
+    end
+
+  end
+
+  def find(key)
+    rule = nil
+    store.transaction(true) do
+      store.roots.each do |k|
+        rule = store[k] if store[k].id == key
+      end
+    end
+    rule
+  end
+
+  ##
+  # Store yaml
+  def store
+    @_store ||= YAML::Store.new self.path
+  end
+
+end

data/app/mailers/not_found_catcher/application_mailer.rb

@@ -0,0 +1,6 @@
+module NotFoundCatcher
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/middleware/not_found_catcher/middleware.rb

@@ -0,0 +1,46 @@
+module NotFoundCatcher
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    def exceptions_to_catch
+      @_exceptions_to_catch ||= NotFoundCatcher.exceptions_to_catch.collect {|v| v.is_a?(String) ? v.constantize : v}
+    end
+
+    def redirect_to(location, content_type: 'text/html', status: 301)
+      [status, {'Location' => location, 'Content-Type' => content_type}, ['Moved Permanently']]
+    end
+
+    def call(env)
+      begin
+        ris = @app.call(env)
+      rescue *exceptions_to_catch
+
+        begin
+          rs = NotFoundCatcher.request_store
+          request = ActionDispatch::Request.new(env)
+
+          rs.parse(request) do |req|
+
+            if req.considered?
+              redirect_path = req.build_redirect(request)
+              Rails.logger.info {"[NOT_FOUND_CATCHER] Catch #{request.fullpath} -> #{redirect_path}"}
+              ris = redirect_to redirect_path
+            else
+              Rails.logger.info {"[NOT_FOUND_CATCHER] Catch non gestito:#{request.fullpath}"}
+              ris = redirect_to NotFoundCatcher.if_not_considered_path.call(request), status: 302
+            end
+
+          end
+        rescue Exception => e
+          Rails.logger.info {"[NOT_FOUND_CATCHER] Problemi - #{e.message} - #{e.backtrace.join("\n")}"}
+        end
+
+      end
+      ris
+    end
+
+  end
+end

data/app/models/not_found_catcher/application_record.rb

@@ -0,0 +1,5 @@
+module NotFoundCatcher
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/not_found_catcher/role.rb

@@ -0,0 +1,32 @@
+module NotFoundCatcher
+  class Role < ActiveType::Object
+
+    attr_accessor :request_parser
+
+    attribute :role, :string
+    attribute :http_method, :string
+    attribute :redirect, :string
+
+
+    def persisted?
+      true
+    end
+
+    def id
+      self.request_parser.id
+    end
+
+    def save
+
+      request_parser.role = self.role
+      request_parser.method = self.http_method
+      request_parser.redirect = self.redirect
+
+      request_parser.save
+
+    end
+
+   delegate :destroy,to: :request_parser
+
+  end
+end

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

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

data/app/views/not_found_catcher/roles/edit.html.erb

@@ -0,0 +1,9 @@
+<%= form_for @obj do |f| %>
+
+  <%= f.text_field :role %>
+  <%= f.text_field :http_method %>
+  <%= f.text_field :redirect %>
+
+  <%= f.submit %>
+
+<% end %>

data/app/views/not_found_catcher/roles/index.html.erb

@@ -0,0 +1,24 @@
+<table border="1">
+  <tr>
+    <th>Rule</th>
+    <th>Method</th>
+    <th>Redirect</th>
+    <th></th>
+  </tr>
+
+
+  <% @store.each do |row| %>
+
+    <tr>
+      <td><%= row.role %></td>
+      <td><%= row.method %></td>
+      <td><%= row.redirect %></td>
+      <td>
+        <%= link_to 'edit', edit_role_path(row.id) %>
+        <%= link_to 'destroy', role_path(row.id), method: :delete, data: {confirm: "Are you sure?"} %>
+      </td>
+    </tr>
+
+  <% end %>
+
+</table>

data/config/routes.rb

@@ -0,0 +1,13 @@
+NotFoundCatcher::Engine.routes.draw do
+
+  resources :roles, only: [:index, :edit, :update, :destroy]
+
+  root to: 'roles#index'
+
+end
+
+##
+# Appendo una rotta finale per matchare tutto quello sbagliato
+Rails.application.routes.append do
+  match '*path', controller: 'not_found_catcher/exceptions', action: :show, via: [:get, :post, :put, :delete]
+end

data/lib/generators/not_found_catcher/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Execute the installation
+
+Example:
+    rails generate not_found_catcher install
+
+    This will create:
+        config/initializer/not_found_catcher.rb

data/lib/generators/not_found_catcher/not_found_catcher_generator.rb

@@ -0,0 +1,13 @@
+class NotFoundCatcherGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer
+    copy_file 'not_found_catcher.rb.erb', 'config/initializers/not_found_catcher.rb'
+  end
+
+  def install_routes
+    route 'mount NotFoundCatcher::Engine => "/not_found_catcher"'
+  end
+
+
+end

data/lib/generators/not_found_catcher/templates/not_found_catcher.rb.erb

@@ -0,0 +1,33 @@
+NotFoundCatcher.setup do |c|
+
+  # Posizione del file yml per salvare lo stato dei redirects
+  # c.request_db= -> {Rails.root.join('config', 'page_not_found.yml')}
+
+  # Redirect nel caso non abbiamo nessun match o regola di redirect nel DB
+  # c.if_not_considered_path = ->(env){ Rails.application.routes.url_helpers.root_path }
+
+  ##
+  # Se siamo in sviluppo e questa configurazione è a true, tutte le richieste non saranno locali
+  # altrimenti seguono lo standard della configurazione dell'applicativo
+  # c.dev_mode=false
+
+
+  ##
+  # Controller da cui derivare il lato amministrativo dell'engine
+  #c.base_admin_controller = "ActionController::Base"
+
+
+  ##
+  # Controller da cui derivare il lato catch_all delle chiamate
+  # c.base_catcher_controller = "ActionController::Base"
+
+
+  ##
+  # Catcher attivo o meno, utile per quando si è in sviluppo
+  c.enabled = Rails.env.production?
+
+  ##
+  # Elenco degli errori da ascoltare
+  # c.exceptions_to_catch << Exception # to catch all
+
+end

data/lib/not_found_catcher/engine.rb

@@ -0,0 +1,17 @@
+module NotFoundCatcher
+  class Engine < ::Rails::Engine
+    isolate_namespace NotFoundCatcher
+
+    require 'active_type'
+
+    # initializer 'not_found_catcher.set_error_catcher', before: "better_errors.configure_rails_initialization" do |app|
+    #   app.config.exceptions_app = ->(env) {NotFoundCatcher::ExceptionsController.action(:show).call(env)}
+    #   app.config.consider_all_requests_local = !NotFoundCatcher.dev_mode if Rails.env.development?
+    # end
+
+    initializer 'not_found_catcher.set_error_catcher_middleware' do |app|
+      app.config.middleware.use NotFoundCatcher::Middleware
+    end
+
+  end
+end

data/lib/not_found_catcher/version.rb

@@ -0,0 +1,3 @@
+module NotFoundCatcher
+  VERSION = '0.1.0'
+end

data/lib/not_found_catcher.rb

@@ -0,0 +1,64 @@
+require "not_found_catcher/engine"
+module NotFoundCatcher
+  extend ActiveSupport::Autoload
+
+  autoload :RequestStore
+  autoload :RequestParser
+
+  ##
+  # Posizione del file yml in cui registrare tutte le richieste andate male
+  # e le possibili risoluzioni
+  mattr_accessor :request_db
+  @@request_db = -> {Rails.root.join('config', 'page_not_found.yml')}
+
+
+  def self.request_store
+    @_req_st ||= (
+    path = NotFoundCatcher.request_db.()
+    FileUtils.touch path unless File.exists?(path)
+
+    RequestStore.new(path)
+    )
+  end
+
+  ##
+  # Controller da cui derivare il lato amministrativo dell'engine
+  mattr_accessor :base_admin_controller
+  @@base_admin_controller = "ActionController::Base"
+
+
+  ##
+  # Controller da cui derivare il lato catch_all delle chiamate
+  mattr_accessor :base_catcher_controller
+  @@base_catcher_controller = "ActionController::Base"
+
+
+  ##
+  # Se siamo in sviluppo e questa configurazione è a true, tutte le richieste non saranno locali
+  # altrimenti seguono lo standard della configurazione dell'applicativo
+  mattr_accessor :dev_mode
+  @@dev_mode = false
+
+  # Redirect nel caso non abbiamo nessun match o regola di redirect nel DB
+  mattr_accessor :if_not_considered_path
+  @@if_not_considered_path = ->(env) {Rails.application.routes.url_helpers.root_path}
+
+
+  ##
+  # Elenco degli errori da ascoltare
+  mattr_accessor :exceptions_to_catch
+  @@exceptions_to_catch = ['NotFoundCatcher::NotFoundRouteException']
+
+  ##
+  # Catcher attivo o meno, utile per quando si è in sviluppo
+  mattr_accessor :enabled
+  @@enabled = true
+
+  # Default way to setup TikalCore. Run "rails generate tikal_core_install" to create
+  # a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+
+
+end

data/lib/tasks/not_found_catcher_tasks.rake

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: not_found_catcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marino Bonetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: active_type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: 'Mountable Engine to catch not_found_errors and to administrate redirects '
+email:
+- marinobonetti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/not_found_catcher_manifest.js
+- app/assets/javascripts/not_found_catcher/application.js
+- app/assets/stylesheets/not_found_catcher/application.css
+- app/controllers/not_found_catcher/application_controller.rb
+- app/controllers/not_found_catcher/exceptions_controller.rb
+- app/controllers/not_found_catcher/roles_controller.rb
+- app/helpers/not_found_catcher/application_helper.rb
+- app/jobs/not_found_catcher/application_job.rb
+- app/lib/not_found_catcher/not_found_route_exception.rb
+- app/lib/not_found_catcher/request_parser.rb
+- app/lib/not_found_catcher/request_store.rb
+- app/mailers/not_found_catcher/application_mailer.rb
+- app/middleware/not_found_catcher/middleware.rb
+- app/models/not_found_catcher/application_record.rb
+- app/models/not_found_catcher/role.rb
+- app/views/layouts/not_found_catcher/application.html.erb
+- app/views/not_found_catcher/roles/edit.html.erb
+- app/views/not_found_catcher/roles/index.html.erb
+- config/routes.rb
+- lib/generators/not_found_catcher/USAGE
+- lib/generators/not_found_catcher/not_found_catcher_generator.rb
+- lib/generators/not_found_catcher/templates/not_found_catcher.rb.erb
+- lib/not_found_catcher.rb
+- lib/not_found_catcher/engine.rb
+- lib/not_found_catcher/version.rb
+- lib/tasks/not_found_catcher_tasks.rake
+homepage: http://gitbuh.com/oniram88/NotFoundCatcher
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Mountable Engine to catch not_found_errors and to administrate redirects
+test_files: []