asset_oss 0.3.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.md

@@ -0,0 +1,44 @@
+Asset OSS -  上传Rails项目静态文件到Aliyun OSS
+===
+
+关于
+---
+
+基于[asset_id](https://github.com/moocode/asset_id),[aset_sync](https://github.com/rumblelabs/asset_sync)也许是更好的选择
+
+一个简单的上传Rails assets目录里静态文件到Aliyun OSS工具  
+
+使用和配置
+---
+
+添加`gem "asset_oss"`到你的Gemfile
+
+修改`config/environments/production.rb`文件, `config.action_controller.asset_host = "http://my_live_bucket.oss.aliyuncs.com"`
+
+新建一个`config/asset_oss.yml`文件
+```
+production:
+  host: 'oss.aliyuncs.com'
+  access_key_id: 'MY_ACCESS_KEY'
+  cret_access_key: 'MY_ACCESS_SECRET'
+  bucket: "my_live_bucket"
+```
+
+创建rake任务, `lib/tasks/asset_oss.rake`
+```
+namespace :asset do
+  namespace :oss do
+    
+    desc "uploads the current assets to aliyun oss with stamped ids"
+    task :upload do
+      AssetOSS::Asset.asset_paths += ['assets'] # Configure additional asset paths
+      AssetOSS::OSS.upload
+    end
+    
+  end
+end
+```
+
+其它
+---
+也许可以通过修改Rails `config.assets.prefix`实现缓存过期,记得prefix要是assets开头,同时修改`AssetOSS::Asset.asset_paths`

data/README_EN.textile

@@ -0,0 +1,90 @@
+h1. Asset OSS - Asset stamping and uploading to Aliyun OSS for Rails
+
+h2. About
+
+基于asset_id修改,aset_sync也许是更好的选择
+
+Uploads static assets to Aliyun OSS with unique identifiers encoded into the path of the asset. 
+
+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.
+
+This library takes standard Rails asset paths such as <code>/stylesheets/main.css?1288717704</code> and converts them
+into <code>http://my_bucket.oss.aliyuncs.com/stylesheets/main-id-95df8d9bf5237ad08df3115ee74dcb10.css</code>.
+
+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_oss"</code>
+
+Configure <code>config/environments/production.rb</code> to use Aliyun OSS 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.oss.aliyuncs.com'
+end
+config.action_controller.asset_path = Proc.new do |source|
+ AssetOSS::Asset.fingerprint(source)
+end
+</code></pre>
+
+Add your Aliyun OSS configuration details to <code>config/asset_oss.yml</code>
+
+<pre><code>production:
+  access_key_id: 'MY_ACCESS_KEY'
+  secret_access_key: 'MY_ACCESS_SECRET'
+  bucket: "my_live_bucket"
+</code></pre>
+
+Optionally create a rake task in <code>lib/tasks/asset_oss.rake</code> to
+perform the upload for use in your deploy scripts
+
+<pre><code>namespace :asset do
+  namespace :oss do
+    
+    desc "uploads the current assets to aliyun oss with stamped ids"
+    task :upload do
+      Aliyun::OSS::DEFAULT_HOST.replace "oss-internal.aliyuncs.com"
+      AssetOSS::Asset.asset_paths += ['assets'] # Configure additional asset paths
+      AssetOSS::OSS.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.oss.aliyuncs.com' : 'http://my_bucket.oss.aliyuncs.com'
+end
+</code></pre>
+
+h2. CSS Images
+
+By default any relative CSS images that match files on the filesystem are converted to AssetOSS paths as well.  
+
+For aliyun oss, if you don't specify a <code>prefix</code> it will use the <code>http://</code> bucket URL by default.  You can override this in <code>config/asset_oss.yml</code>.  For example if you wanted to use the <code>https://</code> url:
+
+<pre><code>production:
+  host: 'oss-internal.aliyuncs.com'
+  access_key_id: 'MY_ACCESS_KEY'
+  secret_access_key: 'MY_ACCESS_SECRET'
+  bucket: "my_live_bucket"
+  prefix: "https://my_bucket.oss.aliyuncs.com"
+</code></pre>

data/lib/asset_oss.rb

@@ -0,0 +1,3 @@
+require 'asset_oss/asset'
+require 'asset_oss/cache'
+require 'asset_oss/backend/oss'

data/lib/asset_oss/asset.rb

@@ -0,0 +1,168 @@
+require 'digest/md5'
+require 'mime/types'
+require 'time'
+require 'zlib'
+
+module AssetOSS
+  class Asset
+    
+    DEFAULT_ASSET_PATHS = ['favicon.ico', 'images', 'javascripts', 'stylesheets']
+    @@asset_paths = DEFAULT_ASSET_PATHS
+    
+    #DEFAULT_GZIP_TYPES = ['text/css', 'application/javascript']
+    DEFAULT_GZIP_TYPES = []
+    @@gzip_types = DEFAULT_GZIP_TYPES
+    
+    @@debug = false
+    @@nocache = false
+    @@nofingerprint = false
+    
+    def self.init(options)
+      @@debug = options[:debug] if options[:debug]
+      @@nocache = options[:nocache] if options[:nocache]
+      @@nofingerprint = options[:nofingerprint] if options[:nofingerprint]
+      @@nofingerprint ||= []
+    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)
+        #TODO 暂时不上传gz文件,相好解决ie6 gzip的问题再说
+        assets << a if a.is_file? and !a.cache_hit? and !a.gz_file?
+        assets += Dir.glob(path+'/**/*').inject([]) {|m, file|
+          a = Asset.new(file); m << a if a.is_file? and !a.cache_hit? and !a.gz_file?; m 
+        }
+      }
+    end
+    
+    def self.fingerprint(path)
+      asset = Asset.new(path)
+      hit = Cache.get(asset)
+      return hit[:fingerprint] if hit
+      return asset.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
+      return p if relative_path =~ /^\/assets.*\//
+      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)
+            # TODO: Check the referenced asset is in the asset_paths
+            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 "AssetOSS: #{relative_path} - Cache Hit" 
+      return true 
+    end
+
+    def gz_file?
+      path =~ /\.gz$/
+    end
+    
+  end
+end

data/lib/asset_oss/backend/oss.rb

@@ -0,0 +1,87 @@
+require 'aliyun/oss'
+
+module AssetOSS
+  class OSS
+  
+    def self.oss_config
+      @@config ||= YAML.load_file(File.join(Rails.root, "config/asset_oss.yml"))[Rails.env] rescue nil || {}
+    end
+  
+    def self.connect_to_oss
+      Aliyun::OSS::Base.establish_connection!(
+        :server => oss_config['host'] || Aliyun::OSS::DEFAULT_HOST,
+        :access_key_id => oss_config['access_key_id'],
+        :secret_access_key => oss_config['secret_access_key']
+      )
+    end
+  
+    def self.oss_permissions
+      :public_read
+    end
+  
+    def self.oss_bucket
+      oss_config['bucket']
+    end
+    
+    def self.oss_folder
+      oss_config['folder']
+    end
+    
+    def self.oss_prefix
+      oss_config['prefix'] || oss_bucket_url
+    end
+    
+    def self.oss_bucket_url
+      "http://#{oss_bucket}.oss.aliyuncs.com#{oss_folder ? "/#{oss_folder}" : '' }"
+    end
+    
+    def self.full_path(asset)
+      oss_folder ? "/#{oss_folder}#{asset.fingerprint}" : asset.fingerprint
+    end
+    
+    def self.upload(options={})
+      Asset.init(:debug => options[:debug], :nofingerprint => options[:nofingerprint])
+      
+      assets = Asset.find
+      return if assets.empty?
+    
+      connect_to_oss
+
+      Aliyun::OSS::Bucket.create(oss_bucket, :access => oss_permissions)
+    
+      assets.each do |asset|
+      
+        puts "AssetOSS: #{asset.relative_path}" if options[:debug]
+      
+        headers = {
+          :content_type => asset.mime_type,
+        }.merge(asset.cache_headers)
+        
+        asset.replace_css_images!(:prefix => oss_prefix) if asset.css?
+        
+        if asset.gzip_type?
+          headers.merge!(asset.gzip_headers)
+          asset.gzip!
+        end
+        
+        if options[:debug]
+          puts "  - Uploading: #{full_path(asset)} [#{asset.data.size} bytes]"
+          puts "  - Headers: #{headers.inspect}"
+        end
+        
+        unless options[:dry_run]
+          res = Aliyun::OSS::OSSObject.store(
+            full_path(asset),
+            asset.data,
+            oss_bucket,
+            headers
+          ) 
+          puts "  - Response: #{res.inspect}" if options[:debug]
+        end
+      end
+    
+      Cache.save! unless options[:dry_run]
+    end
+  
+  end
+end

data/lib/asset_oss/cache.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+
+module AssetOSS
+  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_oss_cache.yml')
+    end
+    
+    def self.get(asset)
+      cache[asset.relative_path]
+    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

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: asset_oss
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Richard Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aliyun-oss
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: asset_oss is a library for uploading static assets to Amazon S3.
+email: moomerman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- README_EN.textile
+- lib/asset_oss.rb
+- lib/asset_oss/cache.rb
+- lib/asset_oss/asset.rb
+- lib/asset_oss/backend/oss.rb
+homepage: http://github.com/mangege/asset_oss
+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
+      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: asset_oss is a library for uploading static assets to Aliyun OSS.
+test_files: []