bust_rails_etags 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 nate
+
+MIT License
+
+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,70 @@
+# BustRailsEtags
+
+Helps bust http caching on new deploys of a Rails app using the environment variable: 
+
+ENV["ETAG_VERSION_ID"]
+
+Rails has awesome http caching abilities. However, when you deploy a new version of your Rails app, there isn't a good way to have that http cache get busted. And so browsers end up carrying around an old version. 
+
+One way of busting the cache is using: 
+
+ENV["RAILS_CACHE_ID"] = release_version["name"]
+
+But changing that environment variable on deploys also busts things like your action and fragment caches. That's a bit too destructive. 
+
+So this gem creates a new environment variable you can use to bust only your http caches.              
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bust_rails_etags'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bust_rails_etags
+
+## Usage
+
+The goal of this gem is to provide an environment variable you can change that will bust all of your http caches for you app on deployments. 
+
+The recommended way of doing that is to create an initializer file in your Rails app's config/initializers folder. You can call it bust_http_cache.rb
+
+Your goal in that file is to set ENV["ETAG_VERSION_ID"] to something that will change on each Rails deployment. 
+
+On Heroku I can use the release numbers. So in my bust_http_cache.rb I can do: 
+
+```
+require 'heroku-api'
+
+heroku = Heroku::API.new(:api_key => "2304u34oisefiou34342k3mdsd")
+release_version = heroku.get_releases('myappname').body.last
+
+ENV["ETAG_VERSION_ID"] = release_version["name"]
+```
+
+Your process can be different depending on your deployment environment. What's important is that the deploy changes the value of ENV["ETAG_VERSION_ID"] across all nodes of your application, and that every node also has the same value of ENV["ETAG_VERSION_ID"]. So you probably wouldn't want to do something like this: 
+
+```
+ENV["ETAG_VERSION_ID"] = Time.now
+```
+
+Because that will cause different servers to have different values of ENV["ETAG_VERSION_ID"] if they were initialized at even slightly different times. 
+
+
+
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bust_rails_etags.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bust_rails_etags/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["nate"]
+  gem.email         = ["nate@cityposh.com"]
+  gem.description   = %q{Helps you bust your rails etags on new deploys.}
+  gem.summary       = %q{Allows you to set ENV["ETAG_VERSION_ID"] in an initializer to that deploys will create new versions of your etags.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "bust_rails_etags"
+  gem.require_paths = ["lib"]
+  gem.version       = BustRailsEtags::VERSION
+end

data/lib/bust_rails_etags.rb

@@ -0,0 +1,32 @@
+require "bust_rails_etags/version"
+
+module BustRailsEtags
+  extend ActiveSupport::Concern
+
+  included do
+    alias_method_chain :etag=, :version_id
+  end
+
+  private
+    def etag_with_version_id=(etag)
+
+      etag_elements = []
+
+      if etag.is_a?(Array)
+        etag_elements = ENV['ETAG_VERSION_ID'] + etag
+      else
+        etag_elements << ENV['ETAG_VERSION_ID']
+        etag_elements << etag
+      end
+    
+      self.etag_without_version_id = etag_elements
+    end
+
+  class Railtie < Rails::Railtie
+    initializer "etag_version_ids.initialize" do |app|
+      ActionDispatch::Response.class_eval do
+        include BustRailsEtags
+      end
+    end
+  end
+end

data/lib/bust_rails_etags/version.rb

@@ -0,0 +1,3 @@
+module BustRailsEtags
+  VERSION = "0.0.3"
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: bust_rails_etags
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- nate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-18 00:00:00.000000000 Z
+dependencies: []
+description: Helps you bust your rails etags on new deploys.
+email:
+- nate@cityposh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bust_rails_etags.gemspec
+- lib/bust_rails_etags.rb
+- lib/bust_rails_etags/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows you to set ENV["ETAG_VERSION_ID"] in an initializer to that deploys
+  will create new versions of your etags.
+test_files: []