asset_sync 0.5.4 → 1.0.0

data/.gitignore

@@ -9,4 +9,7 @@ coverage/*
 spec/dummy_app/public/*
 spec/dummy_app/log/*
 spec/dummy_app/tmp/*
-.rbx
+.rbx
+gemfiles/*.lock
+.rvmrc
+.idea

data/.travis.yml

@@ -1,19 +1,34 @@
 language: ruby
 rvm:
- - 1.8.7
- - 1.9.2
- - 1.9.3
- - jruby-18mode
- - jruby-19mode
- - rbx-18mode
- - rbx-19mode
- - ruby-head
- - jruby-head
- - ree
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+gemfile:
+  - gemfiles/rails_3.1.gemfile
+  - gemfiles/rails_3.2.gemfile
+before_install:
+  - gem install bundler
 env:
- - ["FOG_DIRECTORY=asset-sync-travis","FOG_PROVIDER=AWS", {secure: "dy8Fqlg3b1ZMK1BY5z6NMQLbzAVd7GWVYY0MeCQALz76zRac0z8MyU8hkv6h\nozFry7DSdbGehGT9foOnkWTwzGzf1rzdd5cmWrUPk1wDTRgMM9SrwodPj1TU\nzsq2EFx0a79vADQN8JXkpLC1YD6kEb9aWkTxrIT9KBgw+J5H32o="}, {secure: "Hmx7D7/p2LlA2ya/xBIz21s/8MLIQCjvfYB7RWBNlWk1PfqRLAz8wX6TUVWy\nfAFktMjLnpRLRYO7AgQS4jcfQ/k0HYK9IXzqXzeI00TNm0Vwp0TCXhawiOFT\nSvUMhs2/1vRfjN0HOJ75XlWRhJzV/G5rOMiafAZLsVzN/0iiB8g="}]
+  global:
+    - FOG_DIRECTORY=asset-sync-travis
+    - FOG_PROVIDER=AWS
+    - secure: "dy8Fqlg3b1ZMK1BY5z6NMQLbzAVd7GWVYY0MeCQALz76zRac0z8MyU8hkv6h\nozFry7DSdbGehGT9foOnkWTwzGzf1rzdd5cmWrUPk1wDTRgMM9SrwodPj1TU\nzsq2EFx0a79vADQN8JXkpLC1YD6kEb9aWkTxrIT9KBgw+J5H32o="
+    - secure: "Hmx7D7/p2LlA2ya/xBIz21s/8MLIQCjvfYB7RWBNlWk1PfqRLAz8wX6TUVWy\nfAFktMjLnpRLRYO7AgQS4jcfQ/k0HYK9IXzqXzeI00TNm0Vwp0TCXhawiOFT\nSvUMhs2/1vRfjN0HOJ75XlWRhJzV/G5rOMiafAZLsVzN/0iiB8g="
 matrix:
+  include:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: rbx-19mode
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_4.0.gemfile
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails-3.1" do
+  gem "rails", "~> 3.1.0"
+end
+
+appraise "rails-3.2" do
+  gem "rails", "~> 3.2.0"
+end
+
+appraise "rails-4.0" do
+  gem "rails", "~> 4.0.0"
+end

data/Gemfile

@@ -1,5 +1,5 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 gem 'rcov',      :platforms => :mri_18, :group => [:development, :test]
-gem 'simplecov', :platforms => [:jruby, :mri_19, :ruby_19, :rbx], :group => [:development, :test], :require => false
-gem 'jruby-openssl', :platform => :jruby
+gem 'simplecov', :platforms => [:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group => [:development, :test], :require => false
+gem 'jruby-openssl', :platform => :jruby

data/README.md

@@ -16,7 +16,7 @@ If you are upgrading from a version of asset_sync **< 0.2.0** (i.e. 0.1.x). All
 
 ## Heroku Labs (BETA)
 
-Previously there were [several issues](http://github.com/rumblelabs/asset_sync/blob/master/docs/heroku.md) with using asset_sync on Heroku as described in our [Heroku dev centre article](http://devcenter.heroku.com/articles/cdn-asset-host-rails31).
+Previously there were [several issues](http://github.com/rumblelabs/asset_sync/blob/master/docs/heroku.md) with using asset_sync on Heroku as described in our [Heroku dev center article](http://devcenter.heroku.com/articles/cdn-asset-host-rails31).
 
 Now to get everything working smoothly with using **ENV** variables to configure `asset_sync` we just need to enable the [user-env-compile](http://devcenter.heroku.com/articles/labs-user-env-compile) functionality. In short:
 
@@ -29,7 +29,7 @@ Hopefully this will make it's way into the platform as standard.
 Add the gem to your Gemfile
 
 ``` ruby
-gem "asset_sync"
+gem 'asset_sync'
 ```
 
 If you want, you can put it within your **:assets** group in your Gemfile.
@@ -39,7 +39,7 @@ group :assets do
   gem 'sass-rails',   '~> 3.2.3'
   gem 'coffee-rails', '~> 3.2.1'
   gem 'uglifier', '>= 1.0.3'
-  gem "asset_sync"
+  gem 'asset_sync'
 end
 ```
 
@@ -50,6 +50,16 @@ if defined?(AssetSync)
 ...
 end
 ```
+### Extended Installation (Faster sync with turbosprockets)
+
+It's possible to improve **asset:precompile** time if you are using Rails 3.2.x
+the main source of which being compilation of **non-digest** assets.
+
+[turbo-sprockets-rails3](https://github.com/ndbroadbent/turbo-sprockets-rails3)
+solves this by only compiling **digest** assets. Thus cutting compile time in half.
+
+> NOTE: It will be **deprecated in Rails 4** as sprockets-rails has been extracted
+out of Rails and will only compile **digest** assets by default.
 
 ## Configuration
 
@@ -78,13 +88,21 @@ On **HTTPS**: the exclusion of any protocol in the asset host declaration above
 > The only caveat with this is that your S3 bucket name **must not contain any periods** so, mydomain.com.s3.amazonaws.com for example would not work under HTTPS as SSL certificates from Amazon would interpret our bucket name as **not** a subdomain of s3.amazonaws.com, but a multi level subdomain. To avoid this don't use a period in your subdomain or switch to the other style of S3 URL.
 
 ``` ruby
-  config.action_controller.asset_host = "//s3.amazonaws.com/#{ENV['FOG_DIRECTORY']}" 
+  config.action_controller.asset_host = "//s3.amazonaws.com/#{ENV['FOG_DIRECTORY']}"
 ```
 Or
 
 ``` ruby
-  config.action_controller.asset_host = "//storage.googleapis.com/#{ENV['FOG_DIRECTORY']}" 
+  config.action_controller.asset_host = "//storage.googleapis.com/#{ENV['FOG_DIRECTORY']}"
 ```
+On **non default S3 bucket region**: If your bucket is set to a region that is not the default US Standard (us-east-1) you must use the first style of url ``//#{ENV['FOG_DIRECTORY']}.s3.amazonaws.com`` or amazon will return a 301 permanently moved when assets are requested. Note the caveat above about bucket names and periods. 
+
+If you wish to have your assets sync to a sub-folder of your bucket instead of into the root add the following to your ``production.rb`` file
+
+```ruby
+  # store assets in a 'folder' instead of bucket root
+  config.assets.prefix = "/production/assets"
+````
 
 Also, ensure the following are defined (in production.rb or application.rb)
 
@@ -99,7 +117,7 @@ Additionally, if you depend on any configuration that is setup in your `initiali
 
 **AssetSync** supports the following methods of configuration.
 
-* [Built-in Initializer](/rumblelabs/asset_sync/blob/master/lib/asset_sync/engine.rb) (configured through environment variables)
+* [Built-in Initializer](https://github.com/rumblelabs/asset_sync/blob/master/lib/asset_sync/engine.rb) (configured through environment variables)
 * Rails Initializer
 * A YAML config file
 
@@ -108,7 +126,7 @@ Using the **Built-in Initializer** is the default method and is supposed to be u
 
 If you need more control over configuration you will want to use a **custom rails initializer**.
 
-Configuration using a **YAML** file (a common strategy for Capistrano deployments) is also suppored.
+Configuration using a **YAML** file (a common strategy for Capistrano deployments) is also supported.
 
 The recommend way to configure **asset_sync** is by using **environment variables** however it's up to you, it will work fine if you hard code them too. The main reason is that then your access keys are not checked into version control.
 
@@ -150,8 +168,8 @@ heroku config:add FOG_PROVIDER=Rackspace
 Google Storage Cloud configuration is supported as well
 ``` bash
 heroku config:add FOG_PROVIDER=Google
-heroku config:add GOOGLE_STORAGE_ACCESS_KEY_ID=xxxx 
-heroku config:add GOOGLE_STORAGE_SECRET_ACCESS_KEY=xxxx 
+heroku config:add GOOGLE_STORAGE_ACCESS_KEY_ID=xxxx
+heroku config:add GOOGLE_STORAGE_SECRET_ACCESS_KEY=xxxx
 heroku config:add FOG_DIRECTORY=xxxx
 ```
 
@@ -176,7 +194,7 @@ AssetSync.configure do |config|
   config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
 
   # Don't delete files from the store
-  # config.existing_remote_files = "keep"
+  # config.existing_remote_files = 'keep'
   #
   # Increase upload performance by configuring your region
   # config.fog_region = 'eu-west-1'
@@ -283,7 +301,7 @@ AssetSync.config.gzip_compression == ENV['ASSET_SYNC_GZIP_COMPRESSION']
 
 #### Rackspace (Optional)
 
-* **rackspace\_auth\_url**: Rackspace auth URL, for Rackspace London use: lon.auth.api.rackspacecloud.com
+* **rackspace\_auth\_url**: Rackspace auth URL, for Rackspace London use: `https://lon.identity.api.rackspacecloud.com/v2.0`
 
 ## Amazon S3 Multiple Region Support
 
@@ -307,7 +325,7 @@ Or via YAML
 ``` yaml
 production:
   # ...
-  aws_region: 'eu-west-1'
+  fog_region: 'eu-west-1'
 ```
 
 
@@ -329,21 +347,33 @@ With the new **user_env_compile** feature of Heroku (see above), this is no long
 
 ## Rake Task
 
-A rake task is included within the **asset_sync** gem to enhance the rails precompile task by automatically running after it.
+A rake task is included within the **asset_sync** gem to perform the sync:
+
+``` ruby
+  namespace :assets do
+    desc "Synchronize assets to S3"
+    task :sync => :environment do
+      AssetSync.sync
+    end
+  end
+```
+
+If `AssetSync.config.run_on_precompile` is `true` (default), then assets will be uploaded to S3 automatically after the `assets:precompile` rake task is invoked:
 
 ``` ruby
-  # asset_sync/lib/tasks/asset_sync.rake
   if Rake::Task.task_defined?("assets:precompile:nondigest")
     Rake::Task["assets:precompile:nondigest"].enhance do
-      AssetSync.sync
+      Rake::Task["assets:sync"].invoke if defined?(AssetSync) && AssetSync.config.run_on_precompile
     end
   else
     Rake::Task["assets:precompile"].enhance do
-      AssetSync.sync
+      Rake::Task["assets:sync"].invoke if defined?(AssetSync) && AssetSync.config.run_on_precompile
     end
   end
 ```
 
+You can disable this behavior by setting `AssetSync.config.run_on_precompile = false`.
+
 ## Sinatra/Rack Support
 
 You can use the gem with any Rack application, but you must specify two
@@ -355,8 +385,8 @@ AssetSync.configure do |config|
   config.fog_directory = ENV['FOG_DIRECTORY']
   config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
   config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
-  config.prefix = "assets"
-  config.public_path = Pathname("./public")
+  config.prefix = 'assets'
+  config.public_path = Pathname('./public')
 end
 ```
 
@@ -365,10 +395,10 @@ task.
 
 ```ruby
 namespace :assets do
-  desc "Precompile assets"
+  desc 'Precompile assets'
   task :precompile do
     target = Pathname('./public/assets')
-    manifest = Sprockets::Manifest.new(sprockets, "./public/assets/manifest.json")
+    manifest = Sprockets::Manifest.new(sprockets, './public/assets/manifest.json')
 
     sprockets.each_logical_path do |logical_path|
       if (!File.extname(logical_path).in?(['.js', '.css']) || logical_path =~ /application\.(css|js)$/) && asset = sprockets.find_asset(logical_path)

data/Rakefile

@@ -1,3 +1,10 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require 'appraisal'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
@@ -17,6 +24,7 @@ namespace :spec do
     spec.pattern = 'spec/integration/*_spec.rb'
     spec.rspec_opts = ['--backtrace']
   end
+  desc "run spec:unit and spec:integration tasks"
   task :all do
     Rake::Task['spec:unit'].execute
 

data/asset_sync.gemspec

@@ -6,7 +6,7 @@ require "asset_sync/version"
 Gem::Specification.new do |s|
   s.name        = "asset_sync"
   s.version     = AssetSync::VERSION
-  s.date        = "2013-01-16"
+  s.date        = "2013-08-26"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Simon Hamilton", "David Rice", "Phil McClure"]
   s.email       = ["shamilton@rumblelabs.com", "me@davidjrice.co.uk", "pmcclure@rumblelabs.com"]
@@ -16,16 +16,16 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "asset_sync"
 
-  s.add_dependency('fog')
+  s.add_dependency('fog', ">= 1.8.0")
   s.add_dependency('activemodel')
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "bundler"
   s.add_development_dependency "jeweler"
-  
-  s.add_development_dependency "rails"
+
   s.add_development_dependency "uglifier"
   s.add_development_dependency "asset_sync"
+  s.add_development_dependency "appraisal"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/docs/heroku.md

@@ -15,7 +15,7 @@ When you see `rake assets:precompile` during deployment. Heroku is actually runn
 
 This means the *RAILS_ENV* you have set via *heroku:config* is not used.
 
-**Workaround:** you could have just one S3 bucket dedicated to assets and ensure to set keep the existing remote files
+**Workaround:** you could have just one S3 bucket dedicated to assets and configure `AssetSync` to not delete existing files:
 
     AssetSync.configure do |config|
       ...
@@ -33,4 +33,4 @@ Currently when heroku runs `rake assets:precompile` during deployment. It does n
       config.aws_access_key_id = 'xxx'
       config.aws_secret_access_key = 'xxx'
       config.fog_directory = 'mybucket'
-    end
+    end

data/gemfiles/rails_3.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rcov", :platforms=>:mri_18, :group=>[:development, :test]
+gem "simplecov", :platforms=>[:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group=>[:development, :test], :require=>false
+gem "jruby-openssl", :platform=>:jruby
+gem "rails", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rcov", :platforms=>:mri_18, :group=>[:development, :test]
+gem "simplecov", :platforms=>[:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group=>[:development, :test], :require=>false
+gem "jruby-openssl", :platform=>:jruby
+gem "rails", "~> 3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rcov", :platforms=>:mri_18, :group=>[:development, :test]
+gem "simplecov", :platforms=>[:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group=>[:development, :test], :require=>false
+gem "jruby-openssl", :platform=>:jruby
+gem "rails", "~> 4.0.0"
+
+gemspec :path=>"../"

data/lib/asset_sync/asset_sync.rb

@@ -11,6 +11,10 @@ module AssetSync
       @config
     end
 
+    def reset_config!
+      remove_instance_variable :@config if defined?(@config)
+    end
+
     def configure(&proc)
       @config ||= Config.new
       yield @config
@@ -21,6 +25,18 @@ module AssetSync
     end
 
     def sync
+      with_config do
+        self.storage.sync
+      end
+    end
+
+    def clean
+      with_config do
+        self.storage.delete_extra_remote_files
+      end
+    end
+
+    def with_config(&block)
       return unless AssetSync.enabled?
 
       errors = config.valid? ? "" : config.errors.full_messages.join(', ')
@@ -32,7 +48,7 @@ module AssetSync
           raise Config::Invalid.new(errors)
         end
       else
-        self.storage.sync
+        block.call
       end
     end
 
@@ -41,7 +57,7 @@ module AssetSync
     end
 
     def log(msg)
-      stdout.puts msg if ENV["RAILS_GROUPS"] == "assets"
+      stdout.puts msg if config.log_silently?
     end
 
     def enabled?

data/lib/asset_sync/config.rb

@@ -9,11 +9,16 @@ module AssetSync
     attr_accessor :gzip_compression
     attr_accessor :manifest
     attr_accessor :fail_silently
+    attr_accessor :log_silently
     attr_accessor :always_upload
     attr_accessor :ignored_files
     attr_accessor :prefix
     attr_accessor :public_path
     attr_accessor :enabled
+    attr_accessor :custom_headers
+    attr_accessor :run_on_precompile
+    attr_accessor :invalidate
+    attr_accessor :cdn_distribution_id
 
     # FOG configuration
     attr_accessor :fog_provider          # Currently Supported ['AWS', 'Rackspace']
@@ -21,7 +26,7 @@ module AssetSync
     attr_accessor :fog_region            # e.g. 'eu-west-1'
 
     # Amazon AWS
-    attr_accessor :aws_access_key_id, :aws_secret_access_key
+    attr_accessor :aws_access_key_id, :aws_secret_access_key, :aws_reduced_redundancy
 
     # Rackspace
     attr_accessor :rackspace_username, :rackspace_api_key, :rackspace_auth_url
@@ -47,9 +52,14 @@ module AssetSync
       self.gzip_compression = false
       self.manifest = false
       self.fail_silently = false
+      self.log_silently = true
       self.always_upload = []
       self.ignored_files = []
+      self.custom_headers = {}
       self.enabled = true
+      self.run_on_precompile = true
+      self.cdn_distribution_id = nil
+      self.invalidate = []
       load_yml! if defined?(Rails) && yml_exists?
     end
 
@@ -71,8 +81,16 @@ module AssetSync
       fog_provider == 'AWS'
     end
 
+    def aws_rrs?
+      aws_reduced_redundancy == true
+    end
+
     def fail_silently?
-      fail_silently == true
+      fail_silently || !enabled?
+    end
+
+    def log_silently?
+      ENV['RAILS_GROUPS'] == 'assets' || self.log_silently == false
     end
 
     def enabled?
@@ -88,11 +106,15 @@ module AssetSync
     end
 
     def yml_exists?
-      File.exists?(self.yml_path)
+      defined?(Rails.root) ? File.exists?(self.yml_path) : false
     end
 
     def yml
-      @yml ||= YAML.load(ERB.new(IO.read(yml_path)).result)[Rails.env] rescue nil || {}
+      begin
+        @yml ||= YAML.load(ERB.new(IO.read(yml_path)).result)[Rails.env] rescue nil || {}
+      rescue Psych::SyntaxError
+        @yml = {}
+      end
     end
 
     def yml_path
@@ -109,15 +131,16 @@ module AssetSync
     end
 
     def load_yml!
-      self.enabled               = yml["enabled"] if yml.has_key?('enabled')
-      self.fog_provider          = yml["fog_provider"]
-      self.fog_directory         = yml["fog_directory"]
-      self.fog_region            = yml["fog_region"]
-      self.aws_access_key_id     = yml["aws_access_key_id"]
-      self.aws_secret_access_key = yml["aws_secret_access_key"]
-      self.rackspace_username    = yml["rackspace_username"]
-      self.rackspace_auth_url    = yml["rackspace_auth_url"] if yml.has_key?("rackspace_auth_url")
-      self.rackspace_api_key     = yml["rackspace_api_key"]
+      self.enabled                = yml["enabled"] if yml.has_key?('enabled')
+      self.fog_provider           = yml["fog_provider"]
+      self.fog_directory          = yml["fog_directory"]
+      self.fog_region             = yml["fog_region"]
+      self.aws_access_key_id      = yml["aws_access_key_id"]
+      self.aws_secret_access_key  = yml["aws_secret_access_key"]
+      self.aws_reduced_redundancy = yml["aws_reduced_redundancy"]
+      self.rackspace_username     = yml["rackspace_username"]
+      self.rackspace_auth_url     = yml["rackspace_auth_url"] if yml.has_key?("rackspace_auth_url")
+      self.rackspace_api_key      = yml["rackspace_api_key"]
       self.google_storage_secret_access_key = yml["google_storage_secret_access_key"]
       self.google_storage_access_key_id     = yml["google_storage_access_key_id"]
       self.existing_remote_files  = yml["existing_remote_files"] if yml.has_key?("existing_remote_files")
@@ -126,6 +149,10 @@ module AssetSync
       self.fail_silently          = yml["fail_silently"] if yml.has_key?("fail_silently")
       self.always_upload          = yml["always_upload"] if yml.has_key?("always_upload")
       self.ignored_files          = yml["ignored_files"] if yml.has_key?("ignored_files")
+      self.custom_headers          = yml["custom_headers"] if yml.has_key?("custom_headers")
+      self.run_on_precompile      = yml["run_on_precompile"] if yml.has_key?("run_on_precompile")
+      self.invalidate             = yml["invalidate"] if yml.has_key?("invalidate")
+      self.cdn_distribution_id    = yml['cdn_distribution_id'] if yml.has_key?("cdn_distribution_id")
 
       # TODO deprecate the other old style config settings. FML.
       self.aws_access_key_id      = yml["aws_access_key"] if yml.has_key?("aws_access_key")
@@ -138,6 +165,8 @@ module AssetSync
       self.aws_secret_access_key  = yml["secret_access_key"] if yml.has_key?("secret_access_key")
       self.fog_directory          = yml["bucket"] if yml.has_key?("bucket")
       self.fog_region             = yml["region"] if yml.has_key?("region")
+
+      self.public_path            = yml["public_path"] if yml.has_key?("public_path")
     end
 
 
@@ -153,6 +182,9 @@ module AssetSync
           :rackspace_username => rackspace_username,
           :rackspace_api_key => rackspace_api_key
         })
+        options.merge!({
+          :rackspace_region => fog_region
+        }) if fog_region
         options.merge!({ :rackspace_auth_url => rackspace_auth_url }) if rackspace_auth_url
       elsif google?
         options.merge!({
@@ -163,7 +195,7 @@ module AssetSync
         raise ArgumentError, "AssetSync Unknown provider: #{fog_provider} only AWS and Rackspace are supported currently."
       end
 
-      options.merge!({:region => fog_region}) if fog_region
+      options.merge!({:region => fog_region}) if fog_region && !rackspace?
       return options
     end