asset_sync 0.3.2 → 0.4.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.swp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 1.8.7
+ - 1.9.2
+ - 1.9.3

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/rumblelabs/asset_sync.png)](http://travis-ci.org/rumblelabs/asset_sync)
+
 # Asset Sync
 
 Synchronises Assets between Rails and S3.
@@ -179,10 +181,16 @@ defaults: &defaults
   existing_remote_files: keep # Existing pre-compiled assets on S3 will be kept
   # To delete existing remote files.
   # existing_remote_files: delete
+  # To ignore existing remote files and overwrite.
+  # existing_remote_files: ignore
   # Automatically replace files with their equivalent gzip compressed version
   # gzip_compression: true
   # Fail silently.  Useful for environments such as Heroku
   # fail_silently = true
+  # Always upload. Useful if you want to overwrite specific remote assets regardless of their existence
+  #  eg: Static files in public often reference non-fingerprinted application.css
+  #  note: You will still need to expire them from the CDN's edge cache locations
+  # always_upload: ['application.js', 'application.css']
 
 development:
   <<: *defaults
@@ -210,12 +218,12 @@ AssetSync.config.gzip_compression == ENV['ASSET_SYNC_GZIP_COMPRESSION']
 
 #### AssetSync (optional)
 
-* **existing_remote_files**: (`'keep', 'delete'`) what to do with previously precompiled files. **default:** `'keep'`
+* **existing_remote_files**: (`'keep', 'delete', 'ignore'`) what to do with previously precompiled files. **default:** `'keep'`
 * **gzip\_compression**: (`true, false`) when enabled, will automatically replace files that have a gzip compressed equivalent with the compressed version. **default:** `'false'`
 * **manifest**: (`true, false`) when enabled, will use the `manifest.yml` generated by Rails to get the list of local files to upload. **experimental**. **default:** `'false'`
 
 #### Fog (Required)
-* **fog\_provider**: your storage provider *AWS* (S3) or *Rackspace* (Cloud Files)
+* **fog\_provider**: your storage provider *AWS* (S3) or *Rackspace* (Cloud Files) or *Google* (Google Storage)
 * **fog\_directory**: your bucket name
 
 #### Fog (Optional)
@@ -232,6 +240,10 @@ AssetSync.config.gzip_compression == ENV['ASSET_SYNC_GZIP_COMPRESSION']
 * **rackspace\_username**: your Rackspace username
 * **rackspace\_api\_key**: your Rackspace API Key.
 
+#### Google Storage
+* **google\_storage\_access\_key\_id**: your Google Storage access key
+* **google\_storage\_secret\_access\_key**: your Google Storage access secret
+
 #### Rackspace (Optional)
 
 * **rackspace\_auth\_url**: Rackspace auth URL, for Rackspace London use: lon.auth.api.rackspacecloud.com

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/asset_sync/config.rb

@@ -9,6 +9,7 @@ module AssetSync
     attr_accessor :gzip_compression
     attr_accessor :manifest
     attr_accessor :fail_silently
+    attr_accessor :always_upload
 
     # FOG configuration
     attr_accessor :fog_provider          # Currently Supported ['AWS', 'Rackspace']
@@ -21,7 +22,10 @@ module AssetSync
     # Rackspace
     attr_accessor :rackspace_username, :rackspace_api_key, :rackspace_auth_url
 
-    validates :existing_remote_files, :inclusion => { :in => %w(keep delete) }
+    # Google Storage
+    attr_accessor :google_storage_secret_access_key, :google_storage_access_key_id
+
+    validates :existing_remote_files, :inclusion => { :in => %w(keep delete ignore) }
 
     validates :fog_provider,          :presence => true
     validates :fog_directory,         :presence => true
@@ -30,6 +34,8 @@ module AssetSync
     validates :aws_secret_access_key, :presence => true, :if => :aws?
     validates :rackspace_username,    :presence => true, :if => :rackspace?
     validates :rackspace_api_key,     :presence => true, :if => :rackspace?
+    validates :google_storage_secret_access_key,  :presence => true, :if => :google?
+    validates :google_storage_access_key_id,      :presence => true, :if => :google?
 
     def initialize
       self.fog_region = nil
@@ -37,6 +43,7 @@ module AssetSync
       self.gzip_compression = false
       self.manifest = false
       self.fail_silently = false
+      self.always_upload = []
       load_yml! if yml_exists?
     end
 
@@ -51,7 +58,7 @@ module AssetSync
     end
 
     def existing_remote_files?
-      (self.existing_remote_files == "keep")
+      ['keep', 'ignore'].include?(self.existing_remote_files)
     end
 
     def aws?
@@ -66,6 +73,10 @@ module AssetSync
       fog_provider == 'Rackspace'
     end
 
+    def google?
+      fog_provider == 'Google'
+    end
+
     def yml_exists?
       File.exists?(self.yml_path)
     end
@@ -92,10 +103,13 @@ module AssetSync
       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")
       self.gzip_compression       = yml["gzip_compression"] if yml.has_key?("gzip_compression")
       self.manifest               = yml["manifest"] if yml.has_key?("manifest")
       self.fail_silently          = yml["fail_silently"] if yml.has_key?("fail_silently")
+      self.always_upload          = yml["always_upload"] if yml.has_key?("always_upload")
 
       # 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")
@@ -123,9 +137,12 @@ module AssetSync
           :rackspace_username => rackspace_username,
           :rackspace_api_key => rackspace_api_key
         })
-
         options.merge!({ :rackspace_auth_url => rackspace_auth_url }) if rackspace_auth_url
-
+      elsif google?
+        options.merge!({
+          :google_storage_secret_access_key => google_storage_secret_access_key,
+          :google_storage_access_key_id => google_storage_access_key_id
+        })
       else
         raise ArgumentError, "AssetSync Unknown provider: #{fog_provider} only AWS and Rackspace are supported currently."
       end

data/lib/asset_sync/engine.rb

@@ -21,6 +21,10 @@ class Engine < Rails::Engine
 
         config.rackspace_username = ENV['RACKSPACE_USERNAME']
         config.rackspace_api_key = ENV['RACKSPACE_API_KEY']
+
+        config.google_storage_access_key_id = ENV['GOOGLE_STORAGE_ACCESS_KEY_ID']
+        config.google_storage_secret_access_key = ENV['GOOGLE_STORAGE_SECRET_ACCESS_KEY']
+
         config.existing_remote_files = ENV['ASSET_SYNC_EXISTING_REMOTE_FILES'] || "keep"
         config.gzip_compression = ENV['ASSET_SYNC_GZIP_COMPRESSION'] == 'true'
         config.manifest = ENV['ASSET_SYNC_MANIFEST'] == 'true'

data/lib/asset_sync/storage.rb

@@ -34,6 +34,10 @@ module AssetSync
       @local_files ||= get_local_files
     end
 
+    def always_upload_files
+      self.config.always_upload.map { |f| File.join(self.config.assets_prefix, f) }
+    end
+
     def get_local_files
       if self.config.manifest
         if File.exists?(self.config.manifest_path)
@@ -132,9 +136,9 @@ module AssetSync
 
     def upload_files
       # get a fresh list of remote files
-      remote_files = get_remote_files
+      remote_files = ignore_existing_remote_files? ? [] : get_remote_files
       # fixes: https://github.com/rumblelabs/asset_sync/issues/19
-      local_files_to_upload = local_files - remote_files
+      local_files_to_upload = local_files - remote_files + always_upload_files
 
       # Upload new files
       local_files_to_upload.each do |f|
@@ -151,5 +155,10 @@ module AssetSync
       log "AssetSync: Done."
     end
 
+    private
+
+    def ignore_existing_remote_files?
+      self.config.existing_remote_files == 'ignore'
+    end
   end
 end

data/lib/asset_sync/version.rb

@@ -1,3 +1,3 @@
 module AssetSync
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/generators/asset_sync/install_generator.rb

@@ -5,7 +5,7 @@ module AssetSync
 
     # Commandline options can be defined here using Thor-like options:
     class_option :use_yml,   :type => :boolean, :default => false, :desc => "Use YML file instead of Rails Initializer"
-    class_option :provider,  :type => :string,  :default => "AWS",  :desc => "Generate with support for 'AWS' or 'Rackspace'"
+    class_option :provider,  :type => :string,  :default => "AWS",  :desc => "Generate with support for 'AWS', 'Rackspace', or 'Google'"
 
     def self.source_root
       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
@@ -15,6 +15,10 @@ module AssetSync
       options[:provider] == 'AWS'
     end
 
+    def google?
+      options[:provider] == 'Google'
+    end
+
     def rackspace?
       options[:provider] == 'Rackspace'
     end
@@ -27,6 +31,14 @@ module AssetSync
       "<%= ENV['AWS_SECRET_ACCESS_KEY'] %>"
     end
 
+    def google_storage_access_key_id
+      "<%= ENV['GOOGLE_STORAGE_ACCESS_KEY_ID'] %>"
+    end
+
+    def google_storage_secret_access_key
+      "<%= ENV['GOOGLE_STORAGE_SECRET_ACCESS_KEY'] %>"
+    end
+
     def rackspace_username
       "<%= ENV['RACKSPACE_USERNAME'] %>"
     end

data/lib/generators/asset_sync/templates/asset_sync.rb

@@ -3,6 +3,10 @@ AssetSync.configure do |config|
   config.fog_provider = 'AWS'
   config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
   config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+  <%- elsif google? -%>
+  config.fog_provider = 'Google'
+  config.google_storage_access_key_id = ENV['GOOGLE_STORAGE_ACCESS_KEY_ID']
+  config.google_storage_secret_access_key = ENV['GOOGLE_STORAGE_SECRET_ACCESS_KEY']
   <%- elsif rackspace? -%>
   config.fog_provider = 'Rackspace'
   config.rackspace_username = ENV['RACKSPACE_USERNAME']
@@ -28,4 +32,4 @@ AssetSync.configure do |config|
   #
   # Fail silently.  Useful for environments such as Heroku
   # config.fail_silently = true
-end
+end

data/lib/generators/asset_sync/templates/asset_sync.yml

@@ -3,6 +3,10 @@ defaults: &defaults
   fog_provider: 'AWS'
   aws_access_key_id: "<%= aws_access_key_id %>"
   aws_secret_access_key: "<%= aws_secret_access_key %>"
+  <%- elsif google? -%>
+  fog_provider: 'Google'
+  google_storage_access_key_id: "<%= google_storage_access_key_id %>"
+  google_storage_secret_access_key: "<%= google_storage_secret_access_key %>"
   <%- elsif rackspace? -%>
   fog_provider: 'Rackspace'
   rackspace_username: "<%= rackspace_username %>"

data/spec/asset_sync_spec.rb

@@ -29,7 +29,7 @@ describe AssetSync do
       AssetSync.config.aws_access_key_id.should == "aaaa"
     end
 
-    it "should configure aws_access_key" do
+    it "should configure aws_secret_access_key" do
       AssetSync.config.aws_secret_access_key.should == "bbbb"
     end
 
@@ -37,11 +37,11 @@ describe AssetSync do
       AssetSync.config.fog_directory.should == "mybucket"
     end
 
-    it "should configure aws_access_key" do
+    it "should configure fog_region" do
       AssetSync.config.fog_region.should == "eu-west-1"
     end
 
-    it "should configure aws_access_key" do
+    it "should configure existing_remote_files" do
       AssetSync.config.existing_remote_files.should == "keep"
     end
 
@@ -68,15 +68,15 @@ describe AssetSync do
       AssetSync.config.aws_secret_access_key.should == "zzzz"
     end
 
-    it "should configure aws_access_key" do
+    it "should configure fog_directory" do
       AssetSync.config.fog_directory.should == "rails_app_test"
     end
 
-    it "should configure aws_access_key" do
+    it "should configure fog_region" do
       AssetSync.config.fog_region.should == "eu-west-1"
     end
 
-    it "should configure aws_access_key" do
+    it "should configure existing_remote_files" do
       AssetSync.config.existing_remote_files.should == "keep"
     end
 

data/spec/google_spec.rb

@@ -0,0 +1,141 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe AssetSync do
+  include_context "mock Rails without_yml"
+
+  describe 'with initializer' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fog_provider = 'Google'
+        config.google_storage_access_key_id = 'aaaa'
+        config.google_storage_secret_access_key = 'bbbb'
+        config.fog_directory = 'mybucket'
+        config.existing_remote_files = "keep"
+      end
+    end
+
+    it "should configure provider as Google" do
+      AssetSync.config.fog_provider.should == 'Google'
+      AssetSync.config.should be_google
+    end
+
+    it "should should keep existing remote files" do
+      AssetSync.config.existing_remote_files?.should == true
+    end
+
+    it "should configure google_storage_access_key_id" do
+      AssetSync.config.google_storage_access_key_id.should == "aaaa"
+    end
+
+    it "should configure google_storage_secret_access_key" do
+      AssetSync.config.google_storage_secret_access_key.should == "bbbb"
+    end
+
+    it "should configure fog_directory" do
+      AssetSync.config.fog_directory.should == "mybucket"
+    end
+
+    it "should configure existing_remote_files" do
+      AssetSync.config.existing_remote_files.should == "keep"
+    end
+
+    it "should default gzip_compression to false" do
+      AssetSync.config.gzip_compression.should be_false
+    end
+
+    it "should default manifest to false" do
+      AssetSync.config.manifest.should be_false
+    end
+  end
+
+  describe 'from yml' do
+    before(:each) do
+      set_rails_root('google_with_yml')
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should configure google_storage_access_key_id" do
+      AssetSync.config.google_storage_access_key_id.should == "xxxx"
+    end
+
+    it "should configure google_storage_secret_access_key" do
+      AssetSync.config.google_storage_secret_access_key.should == "zzzz"
+    end
+
+    it "should configure google_storage_access_key" do
+      AssetSync.config.fog_directory.should == "rails_app_test"
+    end
+
+    it "should configure google_storage_access_key" do
+      AssetSync.config.existing_remote_files.should == "keep"
+    end
+
+    it "should default gzip_compression to false" do
+      AssetSync.config.gzip_compression.should be_false
+    end
+
+    it "should default manifest to false" do
+      AssetSync.config.manifest.should be_false
+    end
+  end
+
+  describe 'with no configuration' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should be invalid" do
+      lambda{ AssetSync.sync }.should raise_error(AssetSync::Config::Invalid)
+    end
+  end
+
+  describe 'with fail_silent configuration' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fail_silently = true
+      end
+    end
+
+    it "should not raise an invalid exception" do
+      lambda{ AssetSync.sync }.should_not raise_error(AssetSync::Config::Invalid)
+    end
+  end
+
+  describe 'with gzip_compression enabled' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.config.gzip_compression = true
+    end
+
+    it "config.gzip? should be true" do
+      AssetSync.config.gzip?.should be_true
+    end
+  end
+
+  describe 'with manifest enabled' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.config.manifest = true
+    end
+
+    it "config.manifest should be true" do
+      AssetSync.config.manifest.should be_true
+    end
+
+    it "config.manifest_path should default to public/assets.." do
+      AssetSync.config.manifest_path.should =~ /public\/assets\/manifest.yml/
+    end
+
+    it "config.manifest_path should default to public/assets.." do
+      Rails.application.config.assets.manifest = "/var/assets"
+      AssetSync.config.manifest_path.should == "/var/assets/manifest.yml"
+    end
+
+    it "config.manifest_path should default to public/custom_assets.." do
+      Rails.application.config.assets.prefix = 'custom_assets'
+      AssetSync.config.manifest_path.should =~ /public\/custom_assets\/manifest.yml/
+    end
+  end
+end

data/spec/google_with_yml/config/asset_sync.yml

@@ -0,0 +1,19 @@
+defaults: &defaults
+  fog_provider: "Google"
+  google_storage_access_key_id: 'xxxx'
+  google_storage_secret_access_key: 'zzzz'
+
+development:
+  <<: *defaults
+  fog_directory: "rails_app_development"
+  existing_remote_files: keep
+
+test:
+  <<: *defaults
+  fog_directory: "rails_app_test"
+  existing_remote_files: keep
+
+production:
+  <<: *defaults
+  fog_directory: "rails_app_production"
+  existing_remote_files: delete

data/spec/storage_spec.rb

@@ -0,0 +1,40 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe AssetSync::Storage do
+  include_context "mock Rails without_yml"
+
+  describe '#upload_files' do
+    before(:each) do
+      @local_files = ["local_image2.jpg", "local_image1.jpg", "local_stylesheet1.css", "local_stylesheet2.css"]
+      @remote_files = ["local_image.jpg", "local_stylesheet1.css"]
+      @config = AssetSync::Config.new
+    end
+
+    it 'should overwrite all remote files if set to ignore' do
+      @config.existing_remote_files = 'ignore'
+      storage = AssetSync::Storage.new(@config)
+      storage.stub(:local_files).and_return(@local_files)
+      File.stub(:file?).and_return(true) # Pretend they all exist
+
+      @local_files.each do |file|
+        storage.should_receive(:upload_file).with(file)
+      end
+      storage.upload_files
+    end
+
+    it 'should allow force overwriting of specific files' do
+      @config.always_upload = ['local_image.jpg']
+
+      storage = AssetSync::Storage.new(@config)
+      storage.stub(:local_files).and_return(@local_files)
+      storage.stub(:get_remote_files).and_return(@remote_files)
+      File.stub(:file?).and_return(true) # Pretend they all exist
+
+      (@local_files - @remote_files + storage.always_upload_files).each do |file|
+        storage.should_receive(:upload_file).with(file)
+      end
+      storage.upload_files
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_sync
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70129442881380 !ruby/object:Gem::Requirement
+  requirement: &70252796863900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129442881380
+  version_requirements: *70252796863900
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70129442880400 !ruby/object:Gem::Requirement
+  requirement: &70252796862460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129442880400
+  version_requirements: *70252796862460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70129442879500 !ruby/object:Gem::Requirement
+  requirement: &70252796896120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70129442879500
+  version_requirements: *70252796896120
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70129442879060 !ruby/object:Gem::Requirement
+  requirement: &70252796894920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70129442879060
+  version_requirements: *70252796894920
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70129442878560 !ruby/object:Gem::Requirement
+  requirement: &70252796893900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,7 +67,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70129442878560
+  version_requirements: *70252796893900
 description: After you run assets:precompile your compiled assets will be synchronised
   with your S3 bucket.
 email:
@@ -79,6 +79,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -97,9 +98,12 @@ files:
 - lib/tasks/asset_sync.rake
 - spec/asset_sync_spec.rb
 - spec/aws_with_yml/config/asset_sync.yml
+- spec/google_spec.rb
+- spec/google_with_yml/config/asset_sync.yml
 - spec/rackspace_spec.rb
 - spec/rackspace_with_yml/config/asset_sync.yml
 - spec/spec_helper.rb
+- spec/storage_spec.rb
 homepage: https://github.com/rumblelabs/asset_sync
 licenses: []
 post_install_message: 
@@ -128,7 +132,9 @@ summary: Synchronises Assets in a Rails 3 application and Amazon S3/Cloudfront a
 test_files:
 - spec/asset_sync_spec.rb
 - spec/aws_with_yml/config/asset_sync.yml
+- spec/google_spec.rb
+- spec/google_with_yml/config/asset_sync.yml
 - spec/rackspace_spec.rb
 - spec/rackspace_with_yml/config/asset_sync.yml
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/storage_spec.rb