asset_id 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Richard Taylor
+
+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.textile

@@ -0,0 +1,36 @@
+Asset ID
+
+Only works with Rails 3 +
+
+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
+
+config/environments/production.rb
+
+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
+
+lib/tasks/asset_id_tasks.rake
+
+namespace :asset do
+  namespace :id do
+    
+    desc "uploads the current assets to s3 with fingerprints"
+    task :upload do
+      AWS::S3::DEFAULT_HOST.replace "s3-eu-west-1.amazonaws.com"
+      AssetID::Base.asset_paths += ['favicon.png']
+      AssetID::S3.upload
+    end
+    
+  end
+end
+

data/lib/asset_id.rb

@@ -0,0 +1,132 @@
+require 'digest/md5'
+require 'mime/types'
+require 'aws/s3'
+
+module AssetID
+  
+  class Base
+    DEFAULT_ASSET_PATHS = ['favicon.ico', 'images', 'javascripts', 'stylesheets']
+    @@asset_paths = DEFAULT_ASSET_PATHS
+    
+    def self.path_prefix
+      File.join Rails.root, 'public'
+    end
+    
+    def self.asset_paths=(paths)
+      @@asset_paths = paths
+    end
+    
+    def self.asset_paths
+      @@asset_paths
+    end
+    
+    def self.assets
+      a = []
+      asset_paths.each do |asset_path|
+        path = File.join path_prefix, asset_path
+        next unless File.exists? path
+        if File.directory? path
+          a += gather_assets_for(path)
+        else
+          a << path
+        end
+      end
+      a
+    end
+    
+    def self.gather_assets_for(dir)
+      a = []
+      Dir.glob(File.join dir, '/*').each do |file|
+        if File.directory? file
+          a += gather_assets_for(file)
+        else
+          a << file
+        end
+      end
+      a
+    end
+    
+    def self.fingerprint(path)
+      path = File.join path_prefix, path unless path =~ /#{path_prefix}/
+      #d = File.mtime(path).to_i.to_s
+      d = Digest::MD5.hexdigest(File.read(path))
+      path = path.gsub(path_prefix, '')
+      File.join File.dirname(path), "#{File.basename(path, File.extname(path))}-id-#{d}#{File.extname(path)}"
+    end
+    
+  end
+  
+  class S3 < AssetID::Base
+    
+    DEFAULT_GZIP_TYPES = ['text/css', 'application/javascript']
+    @@gzip_types = DEFAULT_GZIP_TYPES
+    
+    def self.gzip_types=(types)
+      @@gzip_types = types
+    end
+    
+    def self.gzip_types
+      @@gzip_types
+    end
+    
+    def self.s3_config
+      @@config ||= YAML.load_file(File.join(Rails.root, "config/asset_id.yml"))[Rails.env] rescue nil || {}
+    end
+    
+    def self.connect_to_s3
+      AWS::S3::Base.establish_connection!(
+        :access_key_id => s3_config['access_key_id'],
+        :secret_access_key => s3_config['secret_access_key']
+      )
+    end
+    
+    def self.cache_headers
+      {'Expires' => 1.year.from_now.httpdate, 'Cache-Control' => 'public'}
+    end
+    
+    def self.gzip_headers
+      {'Content-Encoding' => 'gzip', 'Vary' => 'Accept-Encoding'}
+    end
+    
+    def self.s3_permissions
+      :public_read
+    end
+    
+    def self.s3_bucket
+      s3_config['bucket']
+    end
+    
+    def self.fingerprint(path)
+      #File.join "/#{self.s3_bucket}", fingerprint(path)
+      super(path)
+    end
+    
+    def self.upload(options={})
+      connect_to_s3
+      assets.each do |asset|
+        puts "Uploading #{asset} as #{fingerprint(asset)}"
+        mime_type = MIME::Types.of(asset).first
+        
+        headers = {
+          :content_type => mime_type,
+          :access => s3_permissions,
+        }.merge(cache_headers)
+        
+        if gzip_types.include? mime_type
+          data = `gzip -c #{asset}`
+          headers.merge!(gzip_headers)
+        else
+          data = File.read(asset)
+        end
+        
+        AWS::S3::S3Object.store(
+          fingerprint(asset),
+          data,
+          s3_bucket,
+          headers
+        ) unless options[:dry_run]
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: asset_id
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Richard Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-04 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 1
+        - 16
+        version: "1.16"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 6
+        - 2
+        version: 0.6.2
+  type: :runtime
+  version_requirements: *id002
+description: asset_id is a library for uploading static assets to Amazon S3.
+email: moomerman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.textile
+- lib/asset_id.rb
+has_rdoc: true
+homepage: http://github.com/moomerman/asset_id
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: asset_id
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: asset_id is a library for uploading static assets to Amazon S3.
+test_files: []
+