rails_response_headers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41f72d60f9a51cd28ccb3052db35d716e32b9ad9
+  data.tar.gz: 61a5d98218975f0732b550674b7badac427b449b
+SHA512:
+  metadata.gz: 29528a4c232ff44d5ec64e4317841523fcdc81243002fedff0079899a0b6b531a7a6c5cc6dd143e4526b3015d4d41c4d7eb09d49df85926a68e4a20c40e015c1
+  data.tar.gz: d045ff0828d01bce503a3015b328c0502be28c3388e0782a556a5048b391f11f93eb8ad49e14bb8a4b84417c68326625c3616349adeeec6992dc5e63cffdc1b1

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.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Peter Woo
+
+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,38 @@
+# RailsResponseHeaders
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_response_headers'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create a YAML file at `config/response-headers.yml` with a mapping from your controller actions
+to the set of headers which should be set in the response. For example:
+
+```
+# config/response-headers.yml
+
+welcome#index:
+  Surrogate-Control: public, max-age=120
+  Vary: Accept-Encoding, Accept-Language
+```
+
+When the `index` action of `WelcomeController` is hit, `Surrogate-Control` and `Vary` headers will
+be included in the response.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/efforg/rails_response_headers.
+
+## 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 "rails_response_headers"
+
+# 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/rails_response_headers.rb

@@ -0,0 +1,5 @@
+require "rails_response_headers/version"
+require "rails_response_headers/railtie" if defined?(Rails)
+
+module RailsResponseHeaders
+end

data/lib/rails_response_headers/filter.rb

@@ -0,0 +1,34 @@
+module RailsResponseHeaders
+  module Filter
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :rails_response_headers
+
+      before_filter :set_rails_response_headers
+    end
+
+    class_methods do
+      def load_rails_response_headers
+        config_file = Rails.application.config.response_headers.config
+
+        if File.exists?(config_file)
+          self.rails_response_headers = YAML.load_file(config_file)
+        else
+          self.rails_response_headers = {}
+        end
+      end
+    end
+
+    private
+
+    def set_rails_response_headers
+      controller_map = rails_response_headers[controller_name] || {}
+      action_headers = controller_map[action_name] || {}
+
+      action_headers.each do |name, value|
+        response.headers[name] ||= value
+      end
+    end
+  end
+end

data/lib/rails_response_headers/railtie.rb

@@ -0,0 +1,21 @@
+require "rails_response_headers/filter"
+
+module RailsResponseHeaders
+  class Railtie < Rails::Railtie
+    config.response_headers = ActiveSupport::OrderedOptions.new
+
+    initializer "rails_response_headers.extend_action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send(:include, RailsResponseHeaders::Filter)
+      end
+    end
+
+    initializer "rails_response_headers.configure" do
+      config.response_headers.config ||= Rails.root.join("config/response-headers.yml")
+    end
+
+    config.to_prepare do
+      ActionController::Base.load_rails_response_headers
+    end
+  end
+end

data/lib/rails_response_headers/version.rb

@@ -0,0 +1,3 @@
+module RailsResponseHeaders
+  VERSION = "0.1.0"
+end

data/rails_response_headers.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_response_headers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_response_headers"
+  spec.version       = RailsResponseHeaders::VERSION
+  spec.authors       = ["Peter Woo"]
+  spec.email         = ["peterw@eff.org"]
+
+  spec.summary       = %q{Configure ActionController response headers with YAML.}
+  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,100 @@
+--- !ruby/object:Gem::Specification
+name: rails_response_headers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Woo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-07 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: 
+email:
+- peterw@eff.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_response_headers.rb
+- lib/rails_response_headers/filter.rb
+- lib/rails_response_headers/railtie.rb
+- lib/rails_response_headers/version.rb
+- rails_response_headers.gemspec
+homepage: 
+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: Configure ActionController response headers with YAML.
+test_files: []