asset_id 0.1.0 → 0.1.1

data/README.textile

@@ -1,36 +1,85 @@
-Asset ID
+h1. Asset ID - Asset stamping and uploading to S3 for Rails
 
-Only works with Rails 3 +
+h2. About
 
 Uploads static assets to Amazon S3 with unique identifiers encoded into the path of the asset. 
 
- - Assets served from a cookie-less domain
- - Unique identifier is not encoded into a query parameter (so it is cacheable by proxy servers)
- - All assets have far-future expires headers for caching
- - Assets have the Cache-Control: public header for caching
- - CSS and javascript is GZipped
+Only works with Rails 3.x because Rails 3 makes doing this sort of thing a lot easier and
+that is all I needed it for.
 
-config/environments/production.rb
+This library takes standard Rails asset paths such as <code>/stylesheets/main.css?1288717704</code> and converts them
+into <code>http://my_bucket.s3.amazonaws.com/stylesheets/main-id-95df8d9bf5237ad08df3115ee74dcb10.css</code>.
 
-config.action_controller.asset_host = Proc.new do |source|
+It uses an MD5 hash of the file contents to produce the id so the same asset will always have the same ID.
+
+In my quest to achieve a Google Page Speed score of 100, this library achieves the following:
+
+* Assets served from a cookie-less domain
+* Unique identifier is not encoded into a query parameter (so it is cacheable by proxy servers)
+* All assets have far-future expires headers for caching
+* Assets have the Cache-Control: public header for caching
+* CSS and javascript is GZipped and the correct headers are added
+
+As an added bonus, all your assets are available over <code>https://</code> as well.
+
+h2. Usage
+
+Add the gem to your <code>Gemfile</code>
+
+<code>gem "asset_id"</code>
+
+Configure <code>config/environments/production.rb</code> to use Amazon S3 as the asset host
+and to use the id-stamped asset paths in helpers
+
+<pre><code>config.action_controller.asset_host = Proc.new do |source|
  'http://my_bucket.s3.amazonaws.com'
 end
 config.action_controller.asset_path = Proc.new do |source|
  AssetID::S3.fingerprint(source)
 end
+</code></pre>
+
+Add your Amazon S3 configuration details to <code>config/asset_id.yml</code>
 
-lib/tasks/asset_id_tasks.rake
+<pre><code>production:
+  access_key_id: 'MY_ACCESS_KEY'
+  secret_access_key: 'MY_ACCESS_SECRET'
+  bucket: "my_live_bucket"
+</code></pre>
 
-namespace :asset do
+Optionally create a rake task in <code>lib/tasks/asset_id_tasks.rake</code> to
+perform the upload for use in your deploy scripts
+
+<pre><code>namespace :asset do
   namespace :id do
     
-    desc "uploads the current assets to s3 with fingerprints"
+    desc "uploads the current assets to s3 with stamped ids"
     task :upload do
-      AWS::S3::DEFAULT_HOST.replace "s3-eu-west-1.amazonaws.com"
-      AssetID::Base.asset_paths += ['favicon.png']
+      AWS::S3::DEFAULT_HOST.replace "s3-eu-west-1.amazonaws.com" # If using EU bucket
+      AssetID::Base.asset_paths += ['favicon.png'] # Configure additional asset paths
       AssetID::S3.upload
     end
     
   end
 end
+</code></pre>
+
+h2. SSL configuration
+
+If you want to use the SSL host in your configuration you can do so in <code>config/environments/production.rb</code>
+
+<pre><code>config.action_controller.asset_host = Proc.new do |source|
+  request.ssl? 'https://my_bucket.s3.amazonaws.com' : 'http://my_bucket.s3.amazonaws.com'
+end
+</code></pre>
+
+h2. Using Amazon CloudFront Content Delivery Network (CDN)
+
+To use Amazon CloudFront as a CDN for your assets all you need to do is "create a CloudFront distribution":http://docs.amazonwebservices.com/AmazonCloudFront/latest/GettingStartedGuide/ for the bucket you have defined your configuration and then substitute your unique CloudFront domain name in <code>config/environments/production.rb</code>
+
+<pre><code>config.action_controller.asset_host = Proc.new do |source|
+ 'http://my_domain.d374pjuyllr15e.cloudfront.net'
+end
+</code></pre>
 
+SSL works fine here as well.

data/lib/asset_id.rb

@@ -1,6 +1,7 @@
 require 'digest/md5'
 require 'mime/types'
 require 'aws/s3'
+require 'time'
 
 module AssetID
   
@@ -81,7 +82,7 @@ module AssetID
     end
     
     def self.cache_headers
-      {'Expires' => 1.year.from_now.httpdate, 'Cache-Control' => 'public'}
+      {'Expires' => (Time.now + (60*60*24*365)).httpdate, 'Cache-Control' => 'public'} # 1 year expiry
     end
     
     def self.gzip_headers

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: asset_id
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Richard Taylor