sprockets-redirect 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Prem Sichanugrist
+
+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,88 @@
+Sprockets::Redirect [![Build Status](https://secure.travis-ci.org/thoughtbot/paperclip.png?branch=master)](http://travis-ci.org/thoughtbot/paperclip)
+===================
+
+A Rack middleware for [Rails](https://github.com/rails/rails) >= 3.1.0 with asset pipeline and asset digest enabled. This middleware is used to redirect any request to static asset without a digest to the version with digest in its filename by reading the `manifest.yml` file generated after you run `rake assets:precompile`
+
+For example, if a browser is requesting this URL:
+
+    http://example.org/assets/application.js
+
+They will get redirected to:
+
+    http://example.org/assets/application-faa42cf2fd5db7e7290baa07109bc82b.js
+
+This gem is designed to run on your staging or production environment, where you already precompile all your assets, turn on your asset digest, and turn of asset compilation. This is useful if you're having a static page or E-Mail which refers to static assets in the asset pipeline, which might be impossible and impractical for you to use an URL with a digest in it.
+
+
+Requirements
+------------
+
+* Application running on [Ruby on Rails](http://github.com/rails/rails) version >= 3.1.0.
+* Enable asset digest by setting `config.assets.digest = true` in your production or staging environment configuration file.
+* Running `rake assets:precompile` to precompile your static assets after deploy to your production or staging server.
+
+
+Installation
+------------
+
+Insert this line into your Gemfile:
+
+    group :production, :staging do
+      gem 'sprockets-redirect'
+    end
+
+
+Usage
+-----
+
+This middleware will be enabled by default if you set `config.assets.compile = false` and `config.assets.digest = true` in your configuration file. It will automatically retrieve your asset prefix and the list of your digests automatically from Rails.
+
+You could also config this middle ware at a class level, or at middleware initialization.
+
+
+### Configuration at class level:
+
+You can set these configurations at your initializer file:
+
+#### Sprockets::Redirect.enabled = (true|false)
+
+Set this to `false` to override the auto detection and turn off this middleware. Default value is `true`.
+
+#### Sprockets::Redirect.manifest = [path to your manifest.yml]
+
+Set this to another YAML file which override Rails' default digests manifest. Default value is `nil`.
+
+#### Sprockets::Redirect.redirect_status = (301|302)
+
+Set this to override the redirection status. By default, this middleware will use `302` status to prevent any proxy server to cache your redirection, as the target might be changed later.
+
+
+### Configuration at class initialization:
+
+These configurations are configured via an option hash:
+
+* `:digests` - Set a hash used for file name lookup. This will be default to Rails' manifest at `Rails.configuration.assets.digests`.
+* `:prefix` - Set a path prefix of your assets file. This will be default to `Rails.configuration.assets.prefix` (usually at `/assets`.)
+* `:manifest` - Set a path to your own manifest file to use for lookup. This will override both `:digest` hash and `Sprockets::Redirect.manifest` setting.
+
+You can swap out the middleware inserted automatically by the gem by using `config.middleware.swap` in your configuration file:
+
+    config.middleware.swap Sprockets::Redirect, Sprockets::Redirect, :manifest => Rails.root.join('assets', 'manifest.yml').to_s
+
+
+Contributing
+------------
+
+If you found any bug or would like to request a feature, please use Github's [issue tracker](https://github.com/sikachu/sprockets-redirect/issues) to report them. [Pull requests](https://github.com/sikachu/sprockets-redirect/pulls) are always welcomed if you also want to help me fix it. Please make sure to include a test to make sure that I don't break it in the future.
+
+
+License
+-------
+
+This gem is released under MIT license. Please see [LICENSE](https://github.com/sikachu/sprockets-redirect/blob/master/LICENSE) file for more information.
+
+
+Credit
+------
+
+This gem is maintained by [Prem Sichanugrist](http://sikachu.com) ([@sikachu](http://twitter.com/sikachu)) and supported by [thoughtbot, inc](http://thoughtbot.com).

data/lib/sprockets-redirect.rb

@@ -0,0 +1,12 @@
+require 'sprockets/redirect'
+
+module Sprockets
+  class RedirectRailtie < ::Rails::Railtie
+    initializer "my_railtie.configure_rails_initialization" do |app|
+      if ::Rails.configuration.assets.enabled && !::Rails.configuration.assets.compile && ::Rails.configuration.assets.digest
+        app.middleware.insert_before Rack::Lock, Sprockets::Redirect, :digests => ::Rails.configuration.assets.digests,
+                                                                      :prefix  => ::Rails.configuration.assets.prefix
+      end
+    end
+  end
+end

data/lib/sprockets/redirect.rb

@@ -0,0 +1,82 @@
+require 'rack'
+require 'rack/request'
+require 'rack/mime'
+require 'active_support/core_ext/class/attribute'
+require 'yaml'
+
+module Sprockets
+  # A Rack middleware for Rails >= 3.1.0 with asset pipeline and asset digest
+  # enabled. This middleware is used to redirect any request to static asset
+  # without a digest to the version with digest in its filename by reading the
+  # manifest.yml file generated after you run rake assets:precompile
+  #
+  # For example, if a browser is requesting this URL:
+  #
+  #   http://example.org/assets/application.js
+  #
+  # They will get redirected to:
+  #
+  #   http://example.org/assets/application-faa42cf2fd5db7e7290baa07109bc82b.js
+  #
+  # This middleware is designed to run on your staging or production environment,
+  # where you already precompile all your assets, turn on your asset digest, and
+  # turn of asset compilation. This is useful if you're having a static page or
+  # E-Mail which refers to static assets in the asset pipeline, which might be
+  # impossible and impractical for you to use an URL with a digest in it.
+  class Redirect
+
+    # Set a path to manifest file, which will be used for lookup
+    class_attribute :manifest
+    self.manifest = nil
+
+    # Set this to false to disable middleware's redirection
+    class_attribute :enabled
+    self.enabled = true
+
+    # Set the status code use for redirection
+    class_attribute :redirect_status
+    self.redirect_status = 302
+
+    def initialize(app, options = {})
+      @app = app
+      @digests = options[:digests] || []
+      @prefix = options[:prefix] || "/assets"
+      if manifest = options[:manifest] || self.class.manifest
+        @digests = YAML.load_file manifest
+      end
+    end
+
+    def call(env)
+      if self.class.enabled && !@digests.empty? && asset_match?(env)
+        redirect_to_digest_version(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    protected
+
+    # This will returns true if a requested path is matched in the digests hash
+    def asset_match?(env)
+      @request = Rack::Request.new(env)
+      @request.path.match(/^#{@prefix}/) && @digests.has_key?(@request.path.sub(/^#{@prefix}\//, ""))
+    end
+
+    # Sends a redirect header back to browser
+    def redirect_to_digest_version(env)
+      url = URI(@request.url)
+      filename = @digests[@request.path.sub("#{@prefix}/", "")]
+      url.path = "#{@prefix}/#{filename}"
+      headers = { 'Location'      => url.to_s,
+                  'Content-Type'  => Rack::Mime.mime_type(::File.extname(filename)),
+                  'Pragma'        => 'no-cache',
+                  'Cache-Control' => 'no-cache; max-age=0' }
+      [self.class.redirect_status, headers, [redirect_message(url.to_s)]]
+    end
+
+    # Create a default redirect message
+    def redirect_message(location)
+      %Q(Redirecting to <a href="#{location}">#{location}</a>)
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-redirect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Prem Sichanugrist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70163961784520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70163961784520
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70163961783480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70163961783480
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70163961774060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70163961774060
+description: ! "    Rack middleware which will look up your `public/assets/manifest.yml`
+  and\n    redirect a request with no digest in the file name to the version with\n
+  \   digest in the file name.\n"
+email: s@sikac.hu
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/sprockets-redirect.rb
+- lib/sprockets/redirect.rb
+- LICENSE
+- README.md
+homepage: https://github.com/sikachu/sprockets-redirect
+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.10
+signing_key: 
+specification_version: 3
+summary: Redirect assets with no digest request to a filename with digest version.
+test_files: []