asset_sync 2.4.0 → 2.15.2

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', 'Rackspace', 'Google', or 'AzureRM"
+    class_option :provider,  :type => :string,  :default => "AWS",  :desc => "Generate with support for 'AWS', 'Rackspace', 'Google', 'AzureRM', or 'Backblaze'"
 
     def self.source_root
       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
@@ -27,6 +27,10 @@ module AssetSync
       options[:provider] == 'AzureRM'
     end
 
+    def backblaze?
+      options[:provider] == 'Backblaze'
+    end
+
     def aws_access_key_id
       "<%= ENV['AWS_ACCESS_KEY_ID'] %>"
     end
@@ -35,6 +39,10 @@ module AssetSync
       "<%= ENV['AWS_SECRET_ACCESS_KEY'] %>"
     end
 
+    def aws_session_token
+      "<%= ENV['AWS_SESSION_TOKEN'] %>"
+    end
+
     def google_storage_access_key_id
       "<%= ENV['GOOGLE_STORAGE_ACCESS_KEY_ID'] %>"
     end
@@ -59,6 +67,18 @@ module AssetSync
       "<%= ENV['AZURE_STORAGE_ACCESS_KEY'] %>"
     end
 
+    def b2_key_id
+      "<%= ENV['B2_KEY_ID'] %>"
+    end
+
+    def b2_key_token
+      "<%= ENV['B2_KEY_TOKEN'] %>"
+    end
+
+    def b2_bucket_id
+      "<%= ENV['B2_BUCKET_ID'] %>"
+    end
+
     def app_name
       @app_name ||= Rails.application.is_a?(Rails::Application) && Rails.application.class.name.sub(/::Application$/, "").downcase
     end

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

@@ -4,15 +4,24 @@ if defined?(AssetSync)
     config.fog_provider = 'AWS'
     config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
     config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    config.aws_session_token = ENV['AWS_SESSION_TOKEN'] if ENV.key?('AWS_SESSION_TOKEN')
     # To use AWS reduced redundancy storage.
     # config.aws_reduced_redundancy = true
     #
     # Change AWS signature version. Default is 4
     # config.aws_signature_version = 4
     #
+    # Change canned ACL of uploaded object. Default is unset. Will override fog_public if set.
+    # Choose from: private | public-read | public-read-write | aws-exec-read |
+    #              authenticated-read | bucket-owner-read | bucket-owner-full-control 
+    # config.aws_acl = nil 
+    #
     # Change host option in fog (only if you need to)
     # config.fog_host = "s3.amazonaws.com"
     #
+    # Change port option in fog (only if you need to)
+    # config.fog_port = "9000"
+    #
     # Use http instead of https. Default should be "https" (at least for fog-aws)
     # config.fog_scheme = "http"
     <%- elsif google? -%>
@@ -31,6 +40,12 @@ if defined?(AssetSync)
     config.azure_storage_account_name = ENV['AZURE_STORAGE_ACCOUNT_NAME']
     config.azure_storage_access_key = ENV['AZURE_STORAGE_ACCESS_KEY']
 
+    <%- elsif backblaze? -%>
+    config.fog_provider = 'Backblaze'
+    config.b2_key_id      = ENV['B2_KEY_ID']
+    config.b2_key_token   = ENV['B2_KEY_TOKEN']
+    config.b2_bucket_id   = ENV['B2_BUCKET_ID']
+
     # config.fog_directory specifies container name of Azure Blob storage
     <%- end -%>
     config.fog_directory = ENV['FOG_DIRECTORY']
@@ -42,6 +57,11 @@ if defined?(AssetSync)
     # Increase upload performance by configuring your region
     # config.fog_region = 'eu-west-1'
     #
+    # Set `public` option when uploading file depending on value,
+    # Setting to "default" makes asset sync skip setting the option
+    # Possible values: true, false, "default" (default: true)
+    # config.fog_public = true
+    #
     # Don't delete files from the store
     # config.existing_remote_files = "keep"
     #
@@ -55,6 +75,12 @@ if defined?(AssetSync)
     # Upload the manifest file also.
     # config.include_manifest = false
     #
+    # Upload files concurrently
+    # config.concurrent_uploads = false
+    #
+    # Path to cache file to skip scanning remote
+    # config.remote_file_list_cache_file_path = './.asset_sync_remote_file_list_cache.json'
+    #
     # Fail silently.  Useful for environments such as Heroku
     # config.fail_silently = true
     #

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

@@ -3,15 +3,24 @@ defaults: &defaults
   fog_provider: 'AWS'
   aws_access_key_id: "<%= aws_access_key_id %>"
   aws_secret_access_key: "<%= aws_secret_access_key %>"
+
   # To use AWS reduced redundancy storage.
   # aws_reduced_redundancy: true
   #
   # Change AWS signature version. Default is 4
   # aws_signature_version: 4
   #
+  # Change canned ACL of uploaded object. Default is unset. Will override fog_public if set.
+  # Choose from: private | public-read | public-read-write | aws-exec-read |
+  #              authenticated-read | bucket-owner-read | bucket-owner-full-control 
+  # aws_acl: null
+  #
   # Change host option in fog (only if you need to)
   # fog_host: "s3.amazonaws.com"
   #
+  # Change port option in fog (only if you need to)
+  # fog_port: "9000"
+  #
   # Use http instead of https. Default should be "https" (at least for fog-aws)
   # fog_scheme: "http"
   <%- elsif google? -%>
@@ -28,19 +37,34 @@ defaults: &defaults
   fog_provider: 'AzureRM'
   azure_storage_account_name: "<%= azure_storage_account_name %>"
   azure_storage_access_key: "<%= azure_storage_access_key %>"
-
   # fog_directory specifies container name of Azure Blob storage
+  <%- elsif backblaze? -%>
+  fog_provider:   Backblaze
+  b2_key_id:      "<%= b2_key_id %>"
+  b2_key_token:   "<%= b2_key_token %>"
+  b2_bucket_id:   "<%= b2_bucket_id %>"
+  # fog_directory specifies container name of Backblaze B2 Bucket
   <%- end -%>
   fog_directory: "<%= app_name %>-assets"
+
   # You may need to specify what region your storage bucket is in
   # fog_region: "eu-west-1"
+
+  # Set `public` option when uploading file depending on value,
+  # Setting to "default" makes asset sync skip setting the option
+  # Possible values: true, false, "default" (default: true)
+  # fog_public: "true"
+
   existing_remote_files: keep
   # To delete existing remote files.
   # existing_remote_files: delete
+
   # Automatically replace files with their equivalent gzip compressed version
   # gzip_compression: true
+
   # Fail silently.  Useful for environments such as Heroku
   # fail_silently: true
+
   # Allow custom assets to be cacheable. Note: The base filename will be matched
   # cache_asset_regexps: ['cache_me.js', !ruby/regexp '/cache_some\.\d{8}\.css/']
 

data/lib/tasks/asset_sync.rake

@@ -19,7 +19,7 @@ if Rake::Task.task_defined?("assets:precompile:nondigest")
     # will get executed before yaml or Rails initializers.
     Rake::Task["assets:sync"].invoke if defined?(AssetSync) && AssetSync.config.run_on_precompile
   end
-else
+elsif Rake::Task.task_defined?("assets:precompile")
   Rake::Task["assets:precompile"].enhance do
     # rails 3.1.1 will clear out Rails.application.config if the env vars
     # RAILS_GROUP and RAILS_ENV are not defined. We need to reload the
@@ -27,4 +27,6 @@ else
     # Rake::Task["assets:environment"].invoke if Rake::Task.task_defined?("assets:environment")
     Rake::Task["assets:sync"].invoke if defined?(AssetSync) && AssetSync.config.run_on_precompile
   end
+else
+  # Nothing to be enhanced
 end

data/spec/fixtures/backblaze_with_yml/config/asset_sync.yml

@@ -0,0 +1,20 @@
+defaults: &defaults
+  fog_provider: "Backblaze"
+  b2_key_id: 'xxxx'
+  b2_key_token: 'zzzz'
+  b2_bucket_id: '1234'
+
+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/fixtures/google_with_service_account_yml/config/asset_sync.yml

@@ -0,0 +1,19 @@
+defaults: &defaults
+  fog_provider: "Google"
+  google_json_key_location: 'gcs.json'
+  google_project: 'some-project'
+
+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/integration/backblaze_intergration_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require "fog/backblaze"
+
+def bucket(name)
+  options = {
+    :provider       => 'Backblaze',
+    :b2_key_id      => ENV['B2_KEY_ID'],
+    :b2_key_token   => ENV['B2_KEY_TOKEN'],
+    :b2_bucket_id   => ENV['B2_BUCKET_ID']
+  }
+  options.merge!({ :environment => ENV['FOG_REGION'] }) if ENV.has_key?('FOG_REGION')
+
+  connection = Fog::Storage.new(options)
+  connection.directories.get(ENV['FOG_DIRECTORY'])
+end
+
+def execute(command)
+  app_path = File.expand_path("../../dummy_app", __FILE__)
+  Dir.chdir app_path
+  `#{command}`
+end
+
+describe "AssetSync" do
+
+  before(:each) do
+    @prefix = SecureRandom.hex(6)
+  end
+
+  let(:app_js_regex){
+    /#{@prefix}\/application-[a-zA-Z0-9]*.js$/
+  }
+
+  let(:app_js_gz_regex){
+    /#{@prefix}\/application-[a-zA-Z0-9]*.js.gz$/
+  }
+
+  let(:files){ bucket(@prefix).files }
+
+
+  after(:each) do
+    @directory = bucket(@prefix)
+    @directory.files.each do |f|
+      f.destroy
+    end
+  end
+
+  it "sync" do
+    execute "rake ASSET_SYNC_PREFIX=#{@prefix} assets:precompile"
+
+    files = bucket(@prefix).files
+
+    app_js = files.select{ |f| f.key =~ app_js_regex }.first
+    expect(app_js.content_type).to eq("application/javascript")
+
+    app_js_gz = files.select{ |f| f.key =~ app_js_gz_regex }.first
+    expect(app_js_gz.content_type).to eq("application/javascript")
+    expect(app_js_gz.content_encoding).to eq("gzip")
+  end
+
+  it "sync with enabled=false" do
+    execute "rake ASSET_SYNC_PREFIX=#{@prefix} ASSET_SYNC_ENABLED=false assets:precompile"
+    expect(bucket(@prefix).files.size).to eq(0)
+  end
+
+  it "sync with gzip_compression=true" do
+    execute "rake ASSET_SYNC_PREFIX=#{@prefix} ASSET_SYNC_GZIP_COMPRESSION=true assets:precompile"
+    # bucket(@prefix).files.size.should == 3
+
+    app_js_path = files.select{ |f| f.key =~ app_js_regex }.first
+    app_js = files.get( app_js_path.key )
+    expect(app_js.content_type).to eq("application/javascript")
+  end
+
+end

data/spec/spec_helper.rb

@@ -10,6 +10,12 @@ rescue LoadError
   # SimpleCov ain't available - continue
 end
 
+if ENV["TRAVIS"]
+  require "coveralls"
+  Coveralls.wear!("rails")
+end
+
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e

data/spec/unit/asset_sync_spec.rb

@@ -145,7 +145,7 @@ describe AssetSync do
 
     it "should default asset_regexps to match regexps" do
       expect(AssetSync.config.cache_asset_regexps).to eq(['cache_me.js', /cache_some\.\d{8}\.css/])
-    end    
+    end
   end
 
   describe 'from yml, exporting to a mobile hybrid development directory' do
@@ -255,12 +255,12 @@ describe AssetSync do
       expect(AssetSync.config.manifest_path).to match(/public\/custom_assets\/manifest.yml/)
     end
   end
-  
+
   describe 'with cache_asset_regexps' do
     before(:each) do
       AssetSync.config = AssetSync::Config.new
     end
-    
+
     it "config.cache_asset_regexp should set cache_asset_regexps" do
       AssetSync.config.cache_asset_regexp = /\.[a-f0-9]{8}/i
       expect(AssetSync.config.cache_asset_regexps.size).to eq(1)
@@ -283,4 +283,36 @@ describe AssetSync do
       expect{ AssetSync::Config.new }.to raise_error(Psych::SyntaxError)
     end
   end
+
+  describe 'FogPublicValue' do
+    describe "#to_bool" do
+      it "true should be converted to true" do
+        expect(AssetSync::Config::FogPublicValue.new(true).to_bool).to be_truthy
+      end
+      it "false should be converted to false" do
+        expect(AssetSync::Config::FogPublicValue.new(false).to_bool).to be_falsey
+      end
+      it "nil should be converted to false" do
+        expect(AssetSync::Config::FogPublicValue.new(nil).to_bool).to be_falsey
+      end
+      it "'default' should be converted to false" do
+        expect(AssetSync::Config::FogPublicValue.new("default").to_bool).to be_truthy
+      end
+    end
+
+    describe "#use_explicit_value?" do
+      it "true should be converted to true" do
+        expect(AssetSync::Config::FogPublicValue.new(true).use_explicit_value?).to be_truthy
+      end
+      it "false should be converted to true" do
+        expect(AssetSync::Config::FogPublicValue.new(false).use_explicit_value?).to be_truthy
+      end
+      it "nil should be converted to true" do
+        expect(AssetSync::Config::FogPublicValue.new(nil).use_explicit_value?).to be_truthy
+      end
+      it "'default' should be converted to false" do
+        expect(AssetSync::Config::FogPublicValue.new("default").use_explicit_value?).to be_falsey
+      end
+    end
+  end
 end

data/spec/unit/backblaze_spec.rb

@@ -0,0 +1,150 @@
+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 = 'Backblaze'
+        config.b2_key_id = 'aaaa'
+        config.b2_key_token = 'bbbb'
+        config.b2_bucket_id = '4567'
+        config.fog_directory = 'mybucket'
+        config.existing_remote_files = "keep"
+      end
+    end
+
+    it "should configure provider as Backblaze" do
+      expect(AssetSync.config.fog_provider).to eq('Backblaze')
+    end
+
+    it "should should keep existing remote files" do
+      expect(AssetSync.config.existing_remote_files?).to eq(true)
+    end
+
+    it "should configure b2_key_id" do
+      expect(AssetSync.config.b2_key_id).to eq("aaaa")
+    end
+
+    it "should configure b2_key_token" do
+      expect(AssetSync.config.b2_key_token).to eq("bbbb")
+    end
+
+    it "should configure b2_bucket_id" do
+      expect(AssetSync.config.b2_bucket_id).to eq("4567")
+    end
+
+    it "should configure fog_directory" do
+      expect(AssetSync.config.fog_directory).to eq("mybucket")
+    end
+
+    it "should configure existing_remote_files" do
+      expect(AssetSync.config.existing_remote_files).to eq("keep")
+    end
+
+    it "should default gzip_compression to false" do
+      expect(AssetSync.config.gzip_compression).to be_falsey
+    end
+
+    it "should default manifest to false" do
+      expect(AssetSync.config.manifest).to be_falsey
+    end
+  end
+
+  describe 'from yml' do
+    before(:each) do
+      set_rails_root('backblaze_with_yml')
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should configure b2_key_id" do
+      expect(AssetSync.config.b2_key_id).to eq("xxxx")
+    end
+
+    it "should configure b2_key_token" do
+      expect(AssetSync.config.b2_key_token).to eq("zzzz")
+    end
+
+    it "should configure b2_bucket_id" do
+      expect(AssetSync.config.b2_bucket_id).to eq("1234")
+    end
+
+    it "should configure fog_directory" do
+      expect(AssetSync.config.fog_directory).to eq("rails_app_test")
+    end
+
+    it "should configure existing_remote_files" do
+      expect(AssetSync.config.existing_remote_files).to eq("keep")
+    end
+
+    it "should default gzip_compression to false" do
+      expect(AssetSync.config.gzip_compression).to be_falsey
+    end
+
+    it "should default manifest to false" do
+      expect(AssetSync.config.manifest).to be_falsey
+    end
+  end
+
+  describe 'with no configuration' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should be invalid" do
+      expect{ AssetSync.sync }.to raise_error(::AssetSync::Config::Invalid)
+    end
+  end
+
+  describe 'with fail_silent configuration' do
+    before(:each) do
+      allow(AssetSync).to receive(:stderr).and_return(StringIO.new)
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fail_silently = true
+      end
+    end
+
+    it "should not raise an invalid exception" do
+      expect{ AssetSync.sync }.not_to raise_error
+    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
+      expect(AssetSync.config.gzip?).to be_truthy
+    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
+      expect(AssetSync.config.manifest).to be_truthy
+    end
+
+    it "config.manifest_path should default to public/assets.." do
+      expect(AssetSync.config.manifest_path).to match(/public\/assets\/manifest.yml/)
+    end
+
+    it "config.manifest_path should default to public/assets.." do
+      Rails.application.config.assets.manifest = "/var/assets"
+      expect(AssetSync.config.manifest_path).to eq("/var/assets/manifest.yml")
+    end
+
+    it "config.manifest_path should default to public/custom_assets.." do
+      Rails.application.config.assets.prefix = 'custom_assets'
+      expect(AssetSync.config.manifest_path).to match(/public\/custom_assets\/manifest.yml/)
+    end
+  end
+end