safety_cone 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50edbf10878fc56a14539cd41c4b70e879735b77
-  data.tar.gz: a57be06d86eb4e58aff4887ff32070e1f8541545
+  metadata.gz: b1a84c4f47818100346deb5406a5e31349fbe369
+  data.tar.gz: 1300636c1ce0920c16f9ecb14e727e373fc0fcaf
 SHA512:
-  metadata.gz: d106b281c7e3b23fd901b065aa11e7872b54e37908e72619a43d4912706bb016ea7760539982014482cf2d9297661918264941bca45ca90ecc4314438c9fb76f
-  data.tar.gz: 7398e5766be675c6bd19b9622731ae61cebc00211e478aaa6d9ec39156836a5a118b6b191f1e9308abc237cf0946928ce2594337bac0962607d5b4aa45fbafcc
+  metadata.gz: 391806f295ceb89632b0f65bf3b82be0a0230993c2a0fdf579176d4efd2265c9f3d9dcf352bc2dddefe22c8eb43f11b4333172486b204ae592fd7184609e76ee
+  data.tar.gz: 72411e11648c4774b0579870172235acd163db7d3cfbf740ffecb3e0dce14fb33b4ed20c428d24ebfddbde70da4af4ad2b79c75085bdfa7bc2ae8e7b980a86da

data/README.md

@@ -1,8 +1,7 @@
-# SafetyConeMountable
-Short description and motivation.
+![safety cone logo](https://raw.githubusercontent.com/boost/safety_cone/master/app/assets/images/safety_cone/logo.png)
+#  SafetyCone [![Gem Version](https://badge.fury.io/rb/safety_cone.svg)](https://badge.fury.io/rb/safety_cone)
 
-## Usage
-How to use my plugin.
+Safety Cone is a Rails gem that allows you to temporarily add warnings or block requests to specific pages through a simple interface. It's intended use case is primarily for maintenance.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -16,10 +15,115 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install safety_cone
+## Usage
+
+Create a safety_cone.rb file in config/initializers. The routes that needs to be managed can be added to this config file.
+
+```
+$redis = Redis::Namespace.new("app_name", :redis => Redis.new)
+
+SafetyCone.configure do |config|
+  # Redis connection for safety_cone
+  config.redis = $redis
+
+  # Http auth username and password for Safety Cone admin page
+  config.auth = { username: 'admin', password: 'admin-password' }
+
+  # To allow Safety Cone to manage a single controller action
+  config.add(
+    controller: :registrations,
+    action: :new,
+    name: 'User Registration'
+  )
+
+  # To allow Safety Cone to manage all POST requests
+  config.add(
+    method: 'POST',
+    name: 'All POST requests'
+  )
+end
+```
+
+In routes add
+
+```
+  mount SafetyCone::Engine, :at => '/safety_cone'
+```
+
+In ApplicationController
+
 ```
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  # Add this line
+  include SafetyCone::Filter
+end
+```
+
+In View
+
+```html
+<div class="container">
+  <% if safetycone_notice %>
+    <div class="notice"><%= safetycone_notice %></div>
+  <% end %>
+ 
+   <% if safetycone_alert %>
+    <div class="alert"><%= safetycone_alert %></div>
+  <% end %> 
+</div>
+```
+
+Now you should be able to go to http://localhost:3000/safety_cone and manage your routes.
+
+## For version 0.1.0 users
+
+This earlier version is not a mountable engine and it does not provide an admin interface. The configuration is as follows:
+
+```
+SafetyCone.configure do |config|
+  # disables Safety Cone. By default this value is true
+  config.enabled = false
+
+  # This config will block all POST requests and display this message.
+  config.add(
+    method: :POST,
+    message: 'We are unable to write any data to database now.',
+    type: :block
+  )
+
+  # This is a controller action specific warning. But with no measures to prevent this action
+  config.add(
+    controller: :users,
+    action: :new,
+    message: 'We are unable to register any user now. Please try after sometime.'
+    type: :notice
+  )
+
+  # This is a controller action specific block. This config will let the application
+  # to raise an alert message and block the request from hitting the controller action.
+  config.add(
+    controller: 'users',
+    action: 'create',
+    message: 'We are unable to register any user now. Please try after sometime.',
+    type: :block
+  )
+
+  # This is a controller action specific block with a redirect configured.
+  config.add(
+    controller: 'users',
+    action: 'create',
+    message: 'We are unable to register any user now. Please try after sometime.',
+    type: :block,
+    redirect: '/page/more_info'
+  )
+
+  # For :block flash message is an alert
+  # For :notice flash message is a notice
+end
+```
+
 
 ## Contributing
 Contribution directions go here.

data/app/helpers/safety_cone/cones_helper.rb

@@ -3,7 +3,7 @@ module SafetyCone
     def status(key)
       cone = Cone.new(key, {})
       cone.fetch
-      cone.measure
+      cone.type
     end
   end
 end

data/app/models/safety_cone/cone.rb

@@ -1,7 +1,7 @@
 module SafetyCone
   class Cone
     attr_accessor :name, :controller, :action,
-                  :method, :message, :measure,
+                  :method, :message, :type,
                   :key, :redis
 
     def initialize(key, params)
@@ -11,12 +11,12 @@ module SafetyCone
       @method = params[:action]
       @method = params[:method]
       @message = params[:message]
-      @measure = params[:measure] || 'disabled'
+      @type = params[:type] || 'disabled'
       @redis = SafetyCone.redis
     end
 
     def save
-      data = { message: @message, measure: @measure }.to_json
+      data = { message: @message, type: @type }.to_json
       @redis.set(redis_key, data)
     end
 
@@ -26,7 +26,7 @@ module SafetyCone
       if stored_data
         data = JSON.parse(stored_data)
         @message = data['message']
-        @measure = data['measure']
+        @type = data['type']
       end
     end
 

data/app/views/safety_cone/cones/edit.html.erb

@@ -11,14 +11,14 @@
           </div>
 
           <div class="input-field col s12">
-            <%= form.radio_button :measure, 'notice' %>
-            <%= form.label :measure_notice, 'Notice' %>
+            <%= form.radio_button :type, 'notice' %>
+            <%= form.label :type_notice, 'Notice' %>
 
-            <%= form.radio_button :measure, 'block' %>
-            <%= form.label :measure_block, 'Block' %>
+            <%= form.radio_button :type, 'block' %>
+            <%= form.label :type_block, 'Block' %>
 
-            <%= form.radio_button :measure, 'disabled' %>
-            <%= form.label :measure_disabled, 'Disable this Cone' %>
+            <%= form.radio_button :type, 'disabled' %>
+            <%= form.label :type_disabled, 'Disable this Cone' %>
           </div>
 
           <div class="input-field col s12">

data/lib/safety_cone/configuration.rb

@@ -1,10 +1,7 @@
 module SafetyCone
   # Module for configuring safety measures
   module Configuration
-    VALID_OPTION_KEYS = [
-      :method, :controller,
-      :action, :name
-    ].freeze
+    VALID_OPTION_KEYS = %i[method controller action name].freeze
 
     attr_accessor :cones, :options, :redis, :auth
 
@@ -32,7 +29,7 @@ module SafetyCone
     # Configuration method for Rails initializer
     def configure
       self.cones = {}
-      self.auth = { username: nil, password: nil}
+      self.auth = { username: nil, password: nil }
 
       yield self
     end

data/lib/safety_cone/filter.rb

@@ -12,12 +12,18 @@ module SafetyCone
     # based on the configuration.
     def safety_cone_filter
       if cone = fetch_cone
-        flash.clear
-        flash[notice_type(cone.measure)] = cone.message
-        redirect_to safety_redirect if cone.measure == 'block'
+        if cone.type == 'notice'
+          flash.now["safetycone_#{notice_type(cone.type)}"] = cone.message
+        else
+          flash["safetycone_#{notice_type(cone.type)}"] = cone.message
+        end
+
+        redirect_to safety_redirect if cone.type == 'block'
       end
     end
 
+    private
+
     # Fetches a configuration based on current request
     def fetch_cone
       cones = SafetyCone.cones
@@ -32,18 +38,18 @@ module SafetyCone
 
       cone = Cone.new(key, cone)
       cone.fetch
-      
-      %w(notice block).include?(cone.measure) ? cone : false
+
+      %w[notice block].include?(cone.type) ? cone : false
     end
 
     # Method to redirect a request
     def safety_redirect
-      request.env['HTTP_REFERER']
+      request.env['HTTP_REFERER'] || root_path
     end
 
     # Returns type of notice
-    def notice_type(measure)
-      measure == 'notice' ? 'notice' : 'alert'
+    def notice_type(type)
+      type == 'notice' ? 'notice' : 'alert'
     end
 
     # Returns the current request action as a symbol

data/lib/safety_cone/version.rb

@@ -1,3 +1,3 @@
 module SafetyCone
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'.freeze
 end

data/lib/safety_cone/view_helper.rb

@@ -0,0 +1,15 @@
+module SafetyCone
+  # Module for Filtering requests and raise notices
+  # and take measures
+  module Helper
+    def safetycone_notice
+      flash[:safetycone_notice]
+    end
+
+    def safetycone_alert
+      flash[:safetycone_alert]
+    end
+  end
+end
+
+ActionView::Base.send :include, SafetyCone::Helper

data/lib/safety_cone.rb

@@ -1,6 +1,7 @@
 require 'safety_cone/engine'
 require 'safety_cone/configuration'
 require 'safety_cone/filter'
+require 'safety_cone/view_helper'
 
 module SafetyCone
   extend Configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safety_cone
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Edwin Rozario
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "<="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +203,7 @@ files:
 - lib/safety_cone/engine.rb
 - lib/safety_cone/filter.rb
 - lib/safety_cone/version.rb
-- lib/tasks/safety_cone_tasks.rake
+- lib/safety_cone/view_helper.rb
 homepage: https://github.com/boost/safety_cone
 licenses:
 - MIT
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Blocks or warns requests as cofigured by the admin

data/lib/tasks/safety_cone_tasks.rake

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