simple-maintenance-mode 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30305a8b24e502f3a5cd27850b4b502d404956938048ce83fbe032e870a141f6
+  data.tar.gz: 7f3d7fbb8a872454dfacb16ee610d7984a6f98bbc8a782831074030579365040
+SHA512:
+  metadata.gz: 9961fcd7fc9b4d1526c2fa2b5c8df9bb4f443d70d2ea0ffeacd49b7b8b372e77acaac5e349ec37dfe53055e434afec9987eab8dfddba2b1e019168c62fae639d
+  data.tar.gz: 047e7d7f832eac94d81bc2bb6b49e193d4c3747f750330c797f69a9c0f2d7281abef7a0837e0ef05f99898212abbfc4550f24b82aab3b27c9c0f8cd66cd0425a

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+0.0.2 introducing 'simple' name prefix for the gem
+
+0.0.1 initial maintenance mode implementation
+- maintenance check filter
+- app config model
+- maintenance page
+- installation generator

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in maintenance_mode.gemspec
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+# Simple Maintenance Mode
+
+A simple maintenance mode gem for rails apps. If you need a mode/page for
+maintenance purposes, this is a gem for you. It provides a simple maintenance
+page, filter for your controllers and a fairly simple logic for 
+activation/deactivation.
+
+When activated, users will be redirected (maintenance_mode_check filter) to a
+static maintenance mode page (**/maintenance** route). The maintenance mode settings
+will be stored in a app settings model. Additionally each user will get a cookie
+when the mode is active and a redirection to the maintenance page will happen.
+
+To activate the maintenance mode simply run the rails console and do this:
+**SimpleMaintenanceMode::Model::AppSettings.maintenance_mode = true**
+
+As a rails app administrator, you will be always able to access the page by using
+the **maintenance_mode_override=1** GET parameter.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple-maintenance-mode'
+
+And then execute:
+
+    $ bundle
+    $ rails g simple_maintenance_mode:install
+
+Or install it yourself as:
+
+    $ gem install simple-maintenance-mode
+    
+## Usage
+
+Put this in your Application Controller
+````
+class ApplicationController <  ActionController::Base
+  include SimpleMaintenanceMode::Filter
+  before_action :check_maintenance_mode
+end
+````
+
+You can get/set the maintenance mode with the following method
+````
+# get current maintenance mode
+SimpleMaintenanceMode::Model::AppSettings.maintenance_mode
+# will return true|false
+
+# set maintenance mode
+SimpleMaintenanceMode::Model::AppSettings.maintenance_mode = true|false
+````

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/generators/simple_maintenance_mode/install/USAGE

@@ -0,0 +1,22 @@
+Description:
+  Install simple maintenance mode for your applications.
+  The installation will copy migrations and pages into your migrations/public
+  rails app folder.
+
+  What you have to do:
+    - Put the check_maintenance_mode filter in your application_controller.rb
+    - Integrate a maintenance mode checkbox in your rails app application for
+      convenience.
+
+  Final notes:
+    You will be able to access the website with the get parameter 
+    maintenance_mode_override=1 even if the maintenance mode is active. This is
+    an option for administrators, who want to test the side before turning off
+    the maintenance mode.
+
+Example:
+  rails generate simple_maintenance_mode:install
+
+  This will create following files in your rails app:
+    - db/migrations/..._create_app_config.rb
+    - public/maintenance.html

data/lib/generators/simple_maintenance_mode/install/install_generator.rb

@@ -0,0 +1,13 @@
+module SimpleMaintenanceMode
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_migration
+        timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+        template("create_app_settings.rb", "db/migrate/#{timestamp}_create_app_settings.rb")
+        template("maintenance.html", "public/maintenance.html")
+      end
+    end
+  end
+end

data/lib/generators/simple_maintenance_mode/install/templates/create_app_settings.rb

@@ -0,0 +1,9 @@
+class CreateAppSettings < ActiveRecord::Migration
+  def change
+    create_table :app_settings do |t|
+      t.boolean :maintenance_mode, :default => false
+      t.text :meta
+      t.timestamps
+    end
+  end
+end

data/lib/generators/simple_maintenance_mode/install/templates/maintenance.html

@@ -0,0 +1,152 @@
+<!DOCTYPE html>
+<html class="alfred">
+  <head>
+    <title>Maintenance</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <meta name="viewport" content="width=device-width; initial-scale=1.0;"/>
+
+    <style>
+      /*default*/
+      body, html {background:#f2f2f2; font-family: arial, sans-serif; font-size:18px; margin:0; padding:0;}
+      .wrapper {text-align:center; margin:70px auto 0 auto; color:#999; width:50%;}
+      .link a+a {margin-left:5px;}
+      .btn {background:#aaa; border:solid 1px #fff; color:#fff; display:inline-block; font-size:14px; text-decoration:none; margin-top:5px; padding:8px 12px; border-radius:4px;}
+      .btn:hover {background:#999; box-shadow:0 10px 10px rgba(0, 0, 0, 0.2);}
+      .bg {
+        padding:10px 0;
+        background: -moz-linear-gradient(left, #f2f2f2 0%, #f9f9f9 50%, #f2f2f2 100%);
+        background: -webkit-linear-gradient(left, #f2f2f2 0%, #f9f9f9 50%, #f2f2f2 100%);
+        background: -ms-linear-gradient(left, #f2f2f2 0%, #f9f9f9 50%, #f2f2f2 100%);
+        background: linear-gradient(left, #f2f2f2 0%, #f9f9f9 50%, #f2f2f2 100%);
+      }
+      h1 {color:#e5e5e5; font-size:90px; font-weight:bold; text-shadow: 0 -1px 0px rgba(0, 0, 0, 0.2), 0 1px 1px rgba(255, 255, 255, 0.8); margin:50px 0 0 0; padding:0;}
+      p {padding:10px 0; margin:0; letter-spacing:1px; line-height:25px;}
+      strong {white-space: nowrap;}
+      hr {background:none; box-shadow:none; border:none; border-top:solid 1px #ddd; border-bottom:solid 1px #fff; margin:0; padding:0;}
+
+      /*for alfred*/
+      html.alfred, .alfred body {background:#E3E0D8;}
+      .alfred .wrapper {color:#777;}
+      .alfred h1  {color:#cfccc5;}
+      .alfred hr {background:none; box-shadow:none; border:none; border-top:solid 1px #ccc; border-bottom:solid 1px #fff; margin:0; padding:0;}
+      .alfred .btn {background:#E79800;}
+      .alfred .bg {
+        padding:10px 0;
+        background: -moz-linear-gradient(left, #E3E0D8 0%, #ece9e1 50%, #E3E0D8 100%);
+        background: -webkit-linear-gradient(left, #E3E0D8 0%, #ece9e1 50%, #E3E0D8 100%);
+        background: -ms-linear-gradient(left, #E3E0D8 0%, #ece9e1 50%, #E3E0D8 100%);
+        background: linear-gradient(left, #E3E0D8 0%, #ece9e1 50%, #E3E0D8 100%);
+      }
+
+      @-webkit-keyframes fadeInDown {
+        0% {
+          opacity: 0;
+          -webkit-transform: translateY(-30px);
+        }
+
+        100% {
+          opacity: 1;
+          -webkit-transform: translateY(0);
+        }
+      }
+
+      @-moz-keyframes fadeInDown {
+        0% {
+          opacity: 0;
+          -moz-transform: translateY(-30px);
+        }
+
+        100% {
+          opacity: 1;
+          -moz-transform: translateY(0);
+        }
+      }
+
+      @-ms-keyframes fadeInDown {
+        0% {
+          opacity: 0;
+          -ms-transform: translateY(-30px);
+        }
+
+        100% {
+          opacity: 1;
+          -ms-transform: translateY(0);
+        }
+      }
+
+      @-o-keyframes fadeInDown {
+        0% {
+          opacity: 0;
+          -ms-transform: translateY(-30px);
+        }
+
+        100% {
+          opacity: 1;
+          -ms-transform: translateY(0);
+        }
+      }
+
+      @keyframes fadeInDown {
+        0% {
+          opacity: 0;
+          transform: translateY(-30px);
+        }
+
+        100% {
+          opacity: 1;
+          transform: translateY(0);
+        }
+      }
+
+      .animation{
+        -webkit-transition: all 0.1s linear;
+        -o-transition: all 0.1s linear;
+        -moz-transition: all 0.1s linear;
+        -ms-transition: all 0.1s linear;
+        -kthtml-transition: all 0.1s linear;
+        transition: all 0.1s linear;
+        transition-delay:0.0s;
+      }
+      .animated {
+        -webkit-animation: 1s ease;
+        -moz-animation: 1s ease;
+        -ms-animation: 1s ease;
+        -o-animation: 1s ease;
+        animation: 1s ease;
+      }
+      .fadeInDown {
+        -webkit-animation-name: fadeInDown;
+        -moz-animation-name: fadeInDown;
+        -ms-animation-name: fadeInDown;
+        -o-animation-name: fadeInDown;
+        animation-name: fadeInDown;
+      }
+      @media (max-width: 800px) {
+        h1 {font-size:40px;}
+      }
+
+    </style>
+
+  </head>
+
+  <body class="animated fadeInDown">
+
+    <div class="wrapper">
+      <h1>Maintenance</h1>
+      <hr />
+      <div class="bg">
+        <p>
+          The website is currently in maintenance.
+        </p>
+        <p>
+          Sorry for the inconvenience.
+        </p>
+        <p class="link">
+          <a href="your-website-url" title="website title" class="animation btn">Your Website URL</a>
+        </p>
+      </div>
+      <hr />
+    </div>
+
+  </body>
+</html>

data/lib/simple-maintenance-mode/filter.rb

@@ -0,0 +1,26 @@
+module SimpleMaintenanceMode
+  module Filter
+    
+    def check_maintenance_mode(override = false)
+      maintenance_mode_override = override
+      if params[:maintenance_mode_override].present?
+        maintenance_mode_override = true
+        cookies[:maintenance_mode_override] = true
+      end
+      if cookies[:maintenance_mode_override].present?
+        maintenance_mode_override = true
+      end
+
+      if app_settings.maintenance_mode.present? && !maintenance_mode_override
+        redirect_to '/maintenance'
+      end
+      if app_settings.maintenance_mode.blank?
+        cookies.delete(:maintenance_mode_override) # cleanup unused cookie
+      end
+    end
+    
+    def app_settings
+      @app_settings ||= SimpleMaintenanceMode::Model::AppSettings.instance
+    end
+  end
+end

data/lib/simple-maintenance-mode/model/app_settings.rb

@@ -0,0 +1,28 @@
+require 'active_record'
+require 'acts_as_singleton'
+
+module SimpleMaintenanceMode
+  module Model
+    class AppSettings < ActiveRecord::Base
+      
+      acts_as_singleton
+      
+      def self.maintenance_mode=(active=false)
+        app_settings = SimpleMaintenanceMode::Model::AppSettings.instance
+        app_settings.maintenance_mode = active
+        app_settings.save
+      end
+
+      def self.maintenance_mode
+        SimpleMaintenanceMode::Model::AppSettings.instance.maintenance_mode
+      end
+      
+      def as_json
+        {
+          maintenance_mode: self.maintenance_mode
+        }
+      end
+
+    end
+  end
+end

data/lib/simple-maintenance-mode/version.rb

@@ -0,0 +1,3 @@
+module SimpleMaintenanceMode
+  VERSION = "0.0.2"
+end

data/lib/simple-maintenance-mode.rb

@@ -0,0 +1,6 @@
+require 'simple-maintenance-mode/version'
+require 'simple-maintenance-mode/model/app_settings'
+require 'simple-maintenance-mode/filter'
+
+module SimpleMaintenanceMode
+end

data/simple-maintenance-mode.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple-maintenance-mode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-maintenance-mode"
+  spec.version       = SimpleMaintenanceMode::VERSION
+  spec.authors       = ["Adam Musial-Bright"]
+  spec.summary       = %q{Simple maintenance mode for production rails apps.}
+  spec.description   = %q{Use simple model and before filter to activate the maintenance mode.}
+  spec.homepage      = "https://github.com/musial-bright/simple-maintenance-mode"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'acts_as_singleton'
+  
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/spec/filter_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'SimpleMaintenanceMode::Filter' do
+  
+  let(:app_settings) do
+    double(SimpleMaintenanceMode::Model::AppSettings)
+  end
+  
+  let(:generic_controller) do
+    class GenericController
+      include SimpleMaintenanceMode::Filter
+      
+      attr_accessor :cookies, :params
+      
+      def initialize
+        @cookies = Hash.new
+        @params = Hash.new
+      end
+      
+      def redirect_to
+      end
+    end
+    gc = GenericController.new
+    gc.stub(:app_settings).and_return(app_settings)
+    gc
+  end
+  
+  def maintenace_mode_activated
+    app_settings.stub(maintenance_mode: true)
+  end
+
+  def maintenace_mode_deactivated
+    app_settings.stub(maintenance_mode: false)
+  end
+  
+  describe 'with deactivated maintenance mode' do
+    before :each do
+      maintenace_mode_deactivated
+    end
+    it 'should not redirect' do
+      generic_controller.should_not_receive(:redirect_to)
+      generic_controller.check_maintenance_mode
+    end
+  end
+  
+  describe 'with activated maintenance mode' do
+    before :each do
+      maintenace_mode_activated
+    end
+    
+    it 'should redirect' do
+      generic_controller.should_receive(:redirect_to)
+      generic_controller.check_maintenance_mode
+    end
+    
+    describe 'overridden check with method attribute' do
+      it 'should not redirect' do
+        generic_controller.should_not_receive(:redirect_to)
+        generic_controller.check_maintenance_mode(true)
+      end 
+    end
+    
+    describe 'overridden check with get params' do
+      it 'should not redirect' do
+        generic_controller.should_not_receive(:redirect_to)
+        generic_controller.params[:maintenance_mode_override] = true
+        generic_controller.check_maintenance_mode
+        generic_controller.cookies[:maintenance_mode_override].should be_present
+      end 
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'simple-maintenance-mode'

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: simple-maintenance-mode
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Adam Musial-Bright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: activemodel
+  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: activerecord
+  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: acts_as_singleton
+  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: bundler
+  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: '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: '0'
+  type: :development
+  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: Use simple model and before filter to activate the maintenance mode.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/generators/simple_maintenance_mode/install/USAGE
+- lib/generators/simple_maintenance_mode/install/install_generator.rb
+- lib/generators/simple_maintenance_mode/install/templates/create_app_settings.rb
+- lib/generators/simple_maintenance_mode/install/templates/maintenance.html
+- lib/simple-maintenance-mode.rb
+- lib/simple-maintenance-mode/filter.rb
+- lib/simple-maintenance-mode/model/app_settings.rb
+- lib/simple-maintenance-mode/version.rb
+- simple-maintenance-mode.gemspec
+- spec/filter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/musial-bright/simple-maintenance-mode
+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: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Simple maintenance mode for production rails apps.
+test_files:
+- spec/filter_spec.rb
+- spec/spec_helper.rb