simple-maintenance-mode 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30305a8b24e502f3a5cd27850b4b502d404956938048ce83fbe032e870a141f6
-  data.tar.gz: 7f3d7fbb8a872454dfacb16ee610d7984a6f98bbc8a782831074030579365040
+  metadata.gz: a078d20b7bf9b245d3a0ca0158f8cefcb7fba3cd61049ea3db4c2eb94b7d315d
+  data.tar.gz: 6b0b1a2fd65d2bdff317770de88cb85137ecfae3a7d80d817ba10dd57d8abc49
 SHA512:
-  metadata.gz: 9961fcd7fc9b4d1526c2fa2b5c8df9bb4f443d70d2ea0ffeacd49b7b8b372e77acaac5e349ec37dfe53055e434afec9987eab8dfddba2b1e019168c62fae639d
-  data.tar.gz: 047e7d7f832eac94d81bc2bb6b49e193d4c3747f750330c797f69a9c0f2d7281abef7a0837e0ef05f99898212abbfc4550f24b82aab3b27c9c0f8cd66cd0425a
+  metadata.gz: 415dda6ba31c6b8f91ad96bc480253fd9d429f76d60b4988b9cdf117679eee54a3c2a1345245011e46dea1a1b761b50628f7587e14e85f20943837d3c9c65c5d
+  data.tar.gz: e7653aacb426bba403fa3d5a0cea2fd4b3e98404f33e0358ee6d2c463c7b3025f531c81acda3d3e1fdc6e69c31a01a7789877cb6d7f2620d236a79fae11be6f2

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+0.0.3 support for any content in app settings, i.e. for maintenance info
+
 0.0.2 introducing 'simple' name prefix for the gem
 
 0.0.1 initial maintenance mode implementation

data/README.md

@@ -10,11 +10,16 @@ static maintenance mode page (**/maintenance** route). The maintenance mode sett
 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.
 
+## Usage
+
+### Activating/deactivating the maintenance mode
 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.
+### Overriding maintenance mode for adminis
+As a rails app administrator, you will be always able to access the page by using the **maintenance_mode_override=1** GET parameter. This will set a cookie and allow administrators to see the app without beeing redirected to the maintenance page. To activate the override access you webapp similar to this: `https://<you-app-domain>/?maintenance_mode_override=1`. 
+
+To remove the override, simply delete the `maintenance_mode_override` cookie.
 
 
 ## Installation
@@ -50,4 +55,11 @@ SimpleMaintenanceMode::Model::AppSettings.maintenance_mode
 
 # set maintenance mode
 SimpleMaintenanceMode::Model::AppSettings.maintenance_mode = true|false
+
+# use content for custom contents, i.e.
+SimpleMaintenanceMode::Model::AppSettings.content.maintenance_info = {
+    title: 'This website is in maintenance',
+    message: 'The maintenace will take 10min.'
+}
+# later you can use it in 
 ````

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

@@ -3,6 +3,7 @@ class CreateAppSettings < ActiveRecord::Migration
     create_table :app_settings do |t|
       t.boolean :maintenance_mode, :default => false
       t.text :meta
+      t.text :content, limit: 1.megabyte
       t.timestamps
     end
   end

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

@@ -6,7 +6,9 @@ module SimpleMaintenanceMode
     class AppSettings < ActiveRecord::Base
       
       acts_as_singleton
-      
+
+      store :content, accessors: [ :maintenance_message ], coder: JSON
+
       def self.maintenance_mode=(active=false)
         app_settings = SimpleMaintenanceMode::Model::AppSettings.instance
         app_settings.maintenance_mode = active

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-maintenance-mode
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Adam Musial-Bright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport