format_restricter_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4d7d23d624a097eadc3686966910b7289a5176c
+  data.tar.gz: ede176de4c1a46d0d18698a09059f9fe52d05507
+SHA512:
+  metadata.gz: 40d3b502fb25e361bd161d1a2428f6cb889d1d61d41478760206f607ecb07b932162db92b563e0c22474d694c4f5a1498fded65419077bcaa86e5902eb95a186
+  data.tar.gz: 663264cc3a72ebb7e3e64597aacf6d515c7dd253688c52b630ea5ef85a56e6236d2e107b30fe7cac0545d06eaf5097e4c668eebbff7f1bfcbe449976fcdbab91

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,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0 (May 11, 2016)
+
+1. Initial Release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Roberts
+
+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,74 @@
+# format_restricter_rails
+
+This gem provides a simple way to block your Rails controller actions from trying to process unsupported formats.  Without this, you'll eventually start seeing the following errors on your production site:
+
+````
+ActionView::MissingTemplate (Missing template tasks/index, application/index with {:locale=>[:en], :formats=>[:json], :variants=>[], :handlers=>[:erb, :builder, :raw, :ruby, :coffee, :jbuilder]}
+````
+
+Why are you getting these errors?  Because you designed your sweet little controller action to only process html requests and someone decided to send it a .json request.  Rails happily obliged, processed the action and failed when it couldn't find a corresponding json template to render.
+
+When this happens, you may think to start defining `respond_to` calls in your actions.  Once you realize that's going to explode your code base, you'll probably try to call `respond_to :html` at the top of your controller class in hopes that will help.  Sadly, it won't; and that's where this gem comes in.  It provides a single controller class method, called `restrict_formats_to` that you can add to your controller to declare the formats that it is allowed to process.  When unallowed formats are requested, halts execution and returns an **HTTP Error 406 Not acceptable**.
+
+## Versioning Scheme
+
+This gem uses [semver](http:/semver.org).
+
+## Supported Rails Versions
+
+Currently tested with Rails 4+.
+Not tested in Rails 5 yet.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'format_restricter_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The `restrict_formats_to` is just a wrapper around a `before_action` helper and you can use the standard `only:` and `except:` options.
+
+#### Example 1: Restrict all actions 
+
+````ruby
+class MySnazzyController < ApplicationController
+  restrict_formats_to :html, :json
+
+  def my_action_1
+  end
+
+  def my_action_2
+  end  
+end
+````
+
+#### Example 2: Mix and match
+
+````ruby
+class MySnazzyController < ApplicationController
+  restrict_formats_to :html, only: :my_action_1
+  restrict_formats_to :json, only: :my_action_2
+
+  def my_action_1
+  end
+
+  def my_action_2
+  end  
+end
+````
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/corlewsolutions/format_restricter_rails.
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "pry -r format_restricter_rails -I ./lib"
+  #exec "irb -r format_restricter_rails -I ./lib"
+end

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "format_restricter_rails"
+
+# 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.
+
+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/format_restricter_rails/engine.rb

@@ -0,0 +1,4 @@
+module FormatRestricterRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/format_restricter_rails/includes.rb

@@ -0,0 +1,31 @@
+module FormatRestricterRails
+  module Includes
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.instance_eval do
+        private_class_method :normalize_option
+      end
+    end
+
+    module ClassMethods
+      def restrict_formats_to(*args)
+        options = args.extract_options!
+        except_list = normalize_option(options, :except)
+        only_list = normalize_option(options, :only)
+        allowed_formats = args
+        before_action(only: only_list, except: except_list) do |controller|
+         	unless allowed_formats.include?(request.format.symbol)
+            render nothing: true, status: 406
+          end
+        end
+      end
+
+      def normalize_option(options, key)
+        value = options.fetch(key, [])
+        value = [value] unless value.is_a?(Array)
+        value.collect {|e| e.to_sym}      
+      end
+    end
+  end
+end

data/lib/format_restricter_rails/railtie.rb

@@ -0,0 +1,38 @@
+module FormatRestricterRails
+
+  def self.include_modules_into_host_app
+    ApplicationController.include FormatRestricterRails::Includes
+  end
+
+  def self.was_eager_loaded?
+    @was_eager_loaded ||= false
+  end
+
+  def self.was_eager_loaded=value
+    @was_eager_loaded = value
+  end
+
+  class Railtie < Rails::Railtie
+    # This code will be run before Rails eager loads all of the application code. This method will typically only fire
+    # in production-like environments, however, it could happen in development if the necessary config options are set for the
+    # development.rb.
+    config.before_eager_load do
+      FormatRestricterRails.include_modules_into_host_app
+      FormatRestricterRails.was_eager_loaded = true
+    end
+
+    config.after_initialize do
+      # Don't rerun some setup code if eager loading occured.  It can result in weird things happening.
+      unless FormatRestricterRails.was_eager_loaded?
+        FormatRestricterRails.include_modules_into_host_app
+      end
+
+      # Make sure the code is reloaded in development
+      if Rails.env.development?
+        ActionDispatch::Callbacks.before do
+          FormatRestricterRails.include_modules_into_host_app
+        end
+      end
+    end
+  end
+end

data/lib/format_restricter_rails/version.rb

@@ -0,0 +1,3 @@
+module FormatRestricterRails
+  VERSION = "1.0.0"
+end

data/lib/format_restricter_rails.rb

@@ -0,0 +1,13 @@
+require "rails"
+require "format_restricter_rails/version"
+require "format_restricter_rails/engine"
+require "format_restricter_rails/includes"
+require "format_restricter_rails/railtie"
+
+# Setup pry for development when running "rake console". Guard against load
+# errors in production (since pry is only loaded as a DEVELOPMENT dependency
+# in the .gemspec)
+begin
+  require "pry"
+rescue LoadError
+end

data/respond_to_by_controller.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'format_restricter_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "format_restricter_rails"
+  spec.version       = FormatRestricterRails::VERSION
+  spec.authors       = ["Roberts"]
+  spec.email         = ["roberts@corlewsolutions.com"]
+
+  spec.summary       = "Restrict the formats that your Rails controller actions are allowed to process"
+  spec.description   = "Restrict the formats that your Rails controller actions are allowed to process"
+  spec.homepage      = "https://github.com/corlewsolutions/format_restricter_rails"
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+
+  spec.add_dependency "rails", ">= 4"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: format_restricter_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roberts
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Restrict the formats that your Rails controller actions are allowed to
+  process
+email:
+- roberts@corlewsolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/format_restricter_rails.rb
+- lib/format_restricter_rails/engine.rb
+- lib/format_restricter_rails/includes.rb
+- lib/format_restricter_rails/railtie.rb
+- lib/format_restricter_rails/version.rb
+- respond_to_by_controller.gemspec
+homepage: https://github.com/corlewsolutions/format_restricter_rails
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Restrict the formats that your Rails controller actions are allowed to process
+test_files: []