safety_cone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cab14d4acefb71708d80cb908f282070cad9e383
+  data.tar.gz: 4a74b048ef23b6a107b3b6b51569f8e43d1d57b3
+SHA512:
+  metadata.gz: 88740dc9991f8a65131ff701fe7a9e756942cd1fb883e1c7a1085bc63e47cb5d2990627d8259e904a42aae8eb85cbeb0e097e1234d9745df9e573c28d1324ad0
+  data.tar.gz: 7484bad29aa9c4e47f0bdd701ac44988cabff87e5ed2f8cd72d6c59842e0757cc868ee8e8f2909176437178a5b5a930c59ed85bc2e344f431f7568dac3d1265d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at edwin@boost.co.nz. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Edwin Rozario
+
+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,84 @@
+# SafetyCone
+
+Safety Cone is a Rails gem that lets an application to temporarily warn/block requests to pages in case of maintenance. Safety Cone allows the application raise warnings or custom messages which can be configured from the application initializer. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safety_cone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safety_cone
+
+## Usage
+
+Create a safety_con.rb file in config/initializer/
+
+```
+SafetyCone.configure do |config|
+	# disables safety_cone. By default this value is true
+	config.enable = 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.',
+		measure: :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.'
+		measure: :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.',
+		measure: :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.',
+		measure: :block,
+		redirect: '/page/more_info'
+	)
+
+	# For :block flash message is an alert
+	# For :notice flash message is a notice
+end
+```
+
+SafetyCone uses flash messages. So its expected that flash messages are rendered in view for all pages. 
+
+<Development>
+
+<After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.>
+
+<To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).>
+
+<Contributing>
+
+<Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/safety_cone. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.>
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safety_cone"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/safety_cone/configuration.rb

@@ -0,0 +1,62 @@
+module SafetyCone
+  # Module for configuring safety measures
+  module Configuration
+    VALID_MEASURES = [
+      :block, :warn,
+      :notice, :alert
+    ].freeze
+
+    VALID_OPTION_KEYS = [
+      :method, :controller,
+      :action, :message,
+      :measure, :redirect
+    ].freeze
+
+    attr_accessor :enabled, :cones, :options
+
+    # Method add a safety measure
+    def add(options = {})
+      self.options = options
+      valid?
+      cones[make_key] = options
+    end
+
+    # Method to generate a key from the options
+    def make_key
+      if options.key? :method
+        options[:method].to_sym
+      elsif options.include?(:controller) && options.include?(:action)
+        "#{options[:controller]}_#{options[:action]}".to_sym
+      else
+        raise(ArgumentError,
+              'Options should contain :controller and :action or :method.')
+      end
+    end
+
+    # Checks the validity of configuration params
+    def valid?
+      invalid_options = (options.keys - VALID_OPTION_KEYS)
+      unless invalid_options.empty?
+        raise ArgumentError, "Options #{invalid_options} are not valid."
+      end
+
+      unless options.key? :message
+        raise ArgumentError, 'Option :message is mandatory.'
+      end
+
+      if options[:measure]
+        unless VALID_MEASURES.include? options[:measure]
+          raise(ArgumentError,
+                "Option #{options[:measure]} is not a valid :measure")
+        end
+      end
+    end
+
+    # Configuration method for Rails initializer
+    def configure
+      self.enabled = true
+      self.cones = {}
+      yield self
+    end
+  end
+end

data/lib/safety_cone/filter.rb

@@ -0,0 +1,49 @@
+module SafetyCone
+  # Module for Filtering requests and raise notices
+  # and take measures
+  module Filter
+    # Method to include to base class.
+    # This lets declare a before filter here
+    def self.included(base)
+      base.before_filter :safety_cone_filter
+    end
+
+    # Filter method that does the SafetyCone action
+    # based on the configuration.
+    def safety_cone_filter
+      return unless SafetyCone.enabled
+
+      if cone = fetch_cone
+        flash.clear
+        flash[notice_type(cone[:measure])] = cone[:message]
+        redirect_to safety_redirect(cone[:redirect]) if cone[:measure] == :block
+      end
+    end
+
+    # Fetches a configuration based on current request
+    def fetch_cone
+      cones = SafetyCone.cones
+      cones[request_method] || cones[request_action]
+    end
+
+    # Method to redirect a request
+    def safety_redirect(path)
+      path ? path : request.env['HTTP_REFERER']
+    end
+
+    # Returns type of notice
+    def notice_type(measure)
+      measure == :notice ? :notice : :alert
+    end
+
+    # Returns the current request action as a symbol
+    def request_method
+      request.method.to_sym
+    end
+
+    # Returns the current controller_action as a symbol
+    def request_action
+      "#{controller_name}_#{action_name}".to_sym
+    end
+  end
+end

data/lib/safety_cone/version.rb

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

data/lib/safety_cone.rb

@@ -0,0 +1,8 @@
+require 'safety_cone/version'
+require 'safety_cone/configuration'
+require 'safety_cone/filter'
+
+# SafetyCone
+module SafetyCone
+  extend Configuration
+end

data/safety_cone.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safety_cone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'safety_cone'
+  spec.version       = SafetyCone::VERSION
+  spec.authors       = ['Edwin Rozario']
+  spec.email         = ['edwin@boost.co.nz']
+
+  spec.summary       = 'Blocks or warns requests as per configuration'
+  spec.description   = 'At times we would want to block certain requests.
+                        SafetyCone allows this to be configued.'
+  spec.homepage      = 'https://github.com/boost/safety_cone'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: safety_cone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edwin Rozario
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  At times we would want to block certain requests.
+                          SafetyCone allows this to be configued.
+email:
+- edwin@boost.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safety_cone.rb
+- lib/safety_cone/configuration.rb
+- lib/safety_cone/filter.rb
+- lib/safety_cone/version.rb
+- safety_cone.gemspec
+homepage: https://github.com/boost/safety_cone
+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.1
+signing_key: 
+specification_version: 4
+summary: Blocks or warns requests as per configuration
+test_files: []