asset_id 0.2.0 → 0.2.1

data/lib/asset_id/asset.rb

@@ -0,0 +1,154 @@
+require 'digest/md5'
+require 'mime/types'
+require 'time'
+require 'zlib'
+
+module AssetID
+  class Asset
+    
+    DEFAULT_ASSET_PATHS = ['favicon.ico', 'images', 'javascripts', 'stylesheets']
+    @@asset_paths = DEFAULT_ASSET_PATHS
+    
+    DEFAULT_GZIP_TYPES = ['text/css', 'application/javascript']
+    @@gzip_types = DEFAULT_GZIP_TYPES
+    
+    @@debug = false
+    @@nocache = false
+    
+    def self.init(options)
+      @@debug = options[:debug] if options[:debug]
+      @@nocache = options[:nocache] if options[:nocache]
+    end
+    
+    def self.asset_paths
+      @@asset_paths
+    end
+
+    def self.gzip_types
+      @@gzip_types
+    end
+    
+    def self.asset_paths=(paths)
+      @@asset_paths = paths
+    end
+    
+    def self.gzip_types=(types)
+      @@gzip_types = types
+    end
+    
+    def self.find(paths=Asset.asset_paths)
+      paths.inject([]) {|assets, path|
+        path = File.join Rails.root, 'public', path
+        a = Asset.new(path)
+        assets << a if a.is_file? and !a.cache_hit?
+        assets += Dir.glob(path+'/**/*').inject([]) {|m, file|
+          a = Asset.new(file); m << a if a.is_file? and !a.cache_hit?; m 
+        }
+      }
+    end
+    
+    def self.fingerprint(path)
+      Asset.new(path).fingerprint
+    end
+    
+    attr_reader :path
+    
+    def initialize(path)
+      @path = path
+      @path = absolute_path
+    end
+    
+    def path_prefix
+      File.join Rails.root, 'public'
+    end
+    
+    def absolute_path
+      path =~ /#{path_prefix}/ ? path : File.join(path_prefix, path)
+    end
+    
+    def relative_path
+      path.gsub(path_prefix, '')
+    end
+    
+    def gzip_type?
+      Asset.gzip_types.include? mime_type
+    end
+    
+    def data
+      @data ||= File.read(path)
+    end
+    
+    def md5
+      @digest ||= Digest::MD5.hexdigest(data)
+    end
+    
+    def fingerprint
+      p = relative_path
+      File.join File.dirname(p), "#{File.basename(p, File.extname(p))}-id-#{md5}#{File.extname(p)}"
+    end
+    
+    def mime_type
+      MIME::Types.of(path).first.to_s
+    end
+    
+    def css?
+      mime_type == 'text/css'
+    end
+    
+    def replace_css_images!(options={})
+      options[:prefix] ||= ''
+      # adapted from https://github.com/blakink/asset_id
+      data.gsub! /url\((?:"([^"]*)"|'([^']*)'|([^)]*))\)/mi do |match|
+        begin
+          # $1 is the double quoted string, $2 is single quoted, $3 is no quotes
+          uri = ($1 || $2 || $3).to_s.strip
+          uri.gsub!(/^\.\.\//, '/')
+          
+          # if the uri appears to begin with a protocol then the asset isn't on the local filesystem
+          if uri =~ /[a-z]+:\/\//i
+            "url(#{uri})"
+          else
+            asset = Asset.new(uri)
+            puts "  - Changing CSS URI #{uri} to #{options[:prefix]}#{asset.fingerprint}" if @@debug
+            "url(#{options[:prefix]}#{asset.fingerprint})"
+          end
+        rescue Errno::ENOENT => e
+          puts "  - Warning: #{uri} not found" if @@debug
+          "url(#{uri})"
+        end
+      end
+    end
+    
+    def gzip!
+      # adapted from https://github.com/blakink/asset_id
+      @data = returning StringIO.open('', 'w') do |gz_data|
+        gz = Zlib::GzipWriter.new(gz_data, nil, nil)
+        gz.write(data)
+        gz.close
+      end.string
+    end
+    
+    def expiry_date
+      @expiry_date ||= (Time.now + (60*60*24*365)).httpdate
+    end
+    
+    def cache_headers
+      {'Expires' => expiry_date, 'Cache-Control' => 'public'} # 1 year expiry
+    end
+    
+    def gzip_headers
+      {'Content-Encoding' => 'gzip', 'Vary' => 'Accept-Encoding'}
+    end
+    
+    def is_file?
+      File.exists? absolute_path and !File.directory? absolute_path
+    end
+    
+    def cache_hit?
+      return false if @@nocache or Cache.miss? self
+      puts "AssetID: #{relative_path} - Cache Hit" 
+      return true 
+    end
+    
+  end
+end

data/lib/asset_id/backend/s3.rb

@@ -0,0 +1,73 @@
+require 'aws/s3'
+
+module AssetID
+  class S3
+  
+    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.s3_permissions
+      :public_read
+    end
+  
+    def self.s3_bucket
+      s3_config['bucket']
+    end
+    
+    def self.s3_prefix
+      s3_config['prefix']
+    end
+    
+    def self.upload(options={})
+      Asset.init(:debug => options[:debug])
+      
+      assets = Asset.find
+      return if assets.empty?
+    
+      connect_to_s3
+    
+      assets.each do |asset|
+      
+        puts "AssetID: #{asset.relative_path}" if options[:debug]
+      
+        headers = {
+          :content_type => asset.mime_type,
+          :access => s3_permissions,
+        }.merge(asset.cache_headers)
+        
+        asset.replace_css_images!(:prefix => s3_prefix) if asset.css?
+        
+        if asset.gzip_type?
+          headers.merge!(asset.gzip_headers)
+          asset.gzip!
+        end
+        
+        if options[:debug]
+          puts "  - Uploading: #{asset.fingerprint} [#{asset.data.size} bytes]"
+          puts "  - Headers: #{headers.inspect}"
+        end
+        
+        unless options[:dry_run]
+          res = AWS::S3::S3Object.store(
+            asset.fingerprint,
+            asset.data,
+            s3_bucket,
+            headers
+          ) 
+          puts "  - Response: #{res.inspect}" if options[:debug]
+        end
+      end
+    
+      Cache.save! unless options[:dry_run]
+    end
+  
+  end
+end

data/lib/asset_id/cache.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+module AssetID
+  class Cache
+    
+    def self.empty
+      @cache = {}
+    end
+    
+    def self.cache
+      @cache ||= YAML.load_file(cache_path) rescue {}
+    end
+    
+    def self.cache_path
+      File.join(Rails.root, 'log', 'asset_id_cache.yml')
+    end
+    
+    def self.hit?(asset)
+      return true if cache[asset.relative_path] and cache[asset.relative_path][:fingerprint] == asset.fingerprint
+      cache[asset.relative_path] = {:expires => asset.expiry_date.to_s, :fingerprint => asset.fingerprint}
+      false
+    end
+  
+    def self.miss?(asset)
+      !hit?(asset)
+    end
+    
+    def self.save!
+      File.open(cache_path, 'w') {|f| f.write(YAML.dump(cache))}
+    end
+  
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: asset_id
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Richard Taylor
@@ -47,6 +47,9 @@ files:
 - LICENSE
 - README.textile
 - lib/asset_id.rb
+- lib/asset_id/asset.rb
+- lib/asset_id/cache.rb
+- lib/asset_id/backend/s3.rb
 has_rdoc: true
 homepage: http://github.com/moomerman/asset_id
 licenses: []