sq-asset_sync 2.0.0

data/Rakefile

@@ -0,0 +1,44 @@
+#!/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'
+require 'sq/gem_tasks'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |spec|
+    spec.pattern = 'spec/unit/*_spec.rb'
+    spec.rspec_opts = ['--backtrace']
+
+    rbx = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+    jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    if RUBY_VERSION == '1.8.7' && !(rbx || jruby)
+      spec.rcov = true
+      spec.rcov_opts = %w{--exclude gems\/,spec\/}
+    end
+  end
+  RSpec::Core::RakeTask.new(:integration) do |spec|
+    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
+
+    # Travis CI does not expose encrypted ENV variables for pull requests, so
+    # do not run integration specs
+    # http://about.travis-ci.org/docs/user/build-configuration/#Set-environment-variables
+    #
+    pull_request = ENV['TRAVIS_PULL_REQUEST'] == 'true'
+    ci_build = ENV['TRAVIS'] == 'true'
+    if !ci_build || (ci_build && pull_request)
+      Rake::Task['spec:integration'].execute
+    end
+  end
+end
+
+task :default => 'spec:all'

data/asset_sync.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "asset_sync/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sq-asset_sync"
+  s.version     = AssetSync::VERSION
+  s.date        = "2013-08-26"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Simon Hamilton", "David Rice", "Phil McClure", "Toby Osbourn"]
+  s.email       = ["shamilton@rumblelabs.com", "me@davidjrice.co.uk", "pmcclure@rumblelabs.com", "tosbourn@rumblelabs.com"]
+  s.homepage    = "https://github.com/rumblelabs/asset_sync"
+  s.summary     = %q{Synchronises Assets in a Rails 3 application and Amazon S3/Cloudfront and Rackspace Cloudfiles}
+  s.description = %q{After you run assets:precompile your compiled assets will be synchronised with your S3 bucket.}
+
+  s.license = 'MIT'
+
+  s.rubyforge_project = "asset_sync"
+
+  s.add_dependency('fog-core', ">= 1.8.0")
+  s.add_dependency('unf')
+  s.add_dependency('activemodel')
+  s.add_dependency('activesupport')
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "fog-aws"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "jeweler"
+
+  s.add_development_dependency "uglifier"
+  s.add_development_dependency "appraisal"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/docs/heroku.md

@@ -0,0 +1,36 @@
+The following issues are currently present in Heroku if you are not following the steps outlined in the main [README](http://github.com/rumblelabs/asset_sync)
+
+## KNOWN ISSUES (IMPORTANT)
+
+We are currently trying to talk with Heroku to iron these out.
+
+1. Will not work on heroku on an application with a *RAILS_ENV* configured as anything other than production
+2. Will not work on heroku using ENV variables with the configuration as described below, you must hardcode all variables
+
+### 1. RAILS_ENV
+
+When you see `rake assets:precompile` during deployment. Heroku is actually running something like
+
+    env RAILS_ENV=production DATABASE_URL=scheme://user:pass@127.0.0.1/dbname bundle exec rake assets:precompile 2>&1
+
+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 configure `AssetSync` to not delete existing files:
+
+    AssetSync.configure do |config|
+      ...
+      config.fog_directory = 'app-assets'
+      config.existing_remote_files = "keep"
+    end
+
+### 2. ENV varables not available
+
+Currently when heroku runs `rake assets:precompile` during deployment. It does not load your Rails application's environment config. This means using any **ENV** variables you could normally depend on are not available. For now you can just run `heroku run rake assets:precompile` after deploy.
+
+**Workaround:** you could just hardcode your AWS credentials in the initializer or yml
+
+    AssetSync.configure do |config|
+      config.aws_access_key_id = 'xxx'
+      config.aws_secret_access_key = 'xxx'
+      config.fog_directory = 'mybucket'
+    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/gemfiles/rails_4.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", "~> 4.1.0"
+
+gemspec :path => "../"

data/kochiku.yml

@@ -0,0 +1,7 @@
+ruby:
+ - 2.3.0
+test_command: script/ci
+targets:
+  - type: spec
+    glob: spec/unit/**/*_spec.rb
+    workers: 1

data/lib/asset_sync.rb

@@ -0,0 +1,15 @@
+require 'fog/core'
+require 'active_model'
+require 'active_support/time'
+require 'active_support/time_with_zone'
+require 'active_support/values/time_zone'
+require 'erb'
+require "asset_sync/asset_sync"
+require 'asset_sync/config'
+require 'asset_sync/storage'
+require 'asset_sync/multi_mime'
+
+if defined?(Rails)
+  require 'asset_sync/railtie'
+  require 'asset_sync/engine'
+end

data/lib/asset_sync/asset_sync.rb

@@ -0,0 +1,73 @@
+module AssetSync
+
+  class << self
+
+    def config=(data)
+      @config = data
+    end
+
+    def config
+      @config ||= Config.new
+      @config
+    end
+
+    def reset_config!
+      remove_instance_variable :@config if defined?(@config)
+    end
+
+    def configure(&proc)
+      @config ||= Config.new
+      yield @config
+    end
+
+    def storage
+      @storage ||= Storage.new(self.config)
+    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(', ')
+
+      if !(config && config.valid?)
+        if config.fail_silently?
+          self.warn(errors)
+        else
+          raise Config::Invalid.new(errors)
+        end
+      else
+        block.call
+      end
+    end
+
+    def warn(msg)
+      stderr.puts msg
+    end
+
+    def log(msg)
+      stdout.puts msg unless config.log_silently?
+    end
+
+    def enabled?
+      config.enabled?
+    end
+
+    # easier to stub
+    def stderr ; STDERR ; end
+    def stdout ; STDOUT ; end
+
+  end
+
+end

data/lib/asset_sync/config.rb

@@ -0,0 +1,226 @@
+module AssetSync
+  class Config
+    include ActiveModel::Validations
+
+    class Invalid < StandardError; end
+
+    # AssetSync
+    attr_accessor :existing_remote_files # What to do with your existing remote files? (keep or delete)
+    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']
+    attr_accessor :fog_directory         # e.g. 'the-bucket-name'
+    attr_accessor :fog_region            # e.g. 'eu-west-1'
+
+    # Amazon AWS
+    attr_accessor :aws_access_key_id, :aws_secret_access_key, :aws_reduced_redundancy, :aws_iam_roles
+
+    # Rackspace
+    attr_accessor :rackspace_username, :rackspace_api_key, :rackspace_auth_url
+
+    # 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
+
+    validates :aws_access_key_id,     :presence => true, :if => proc {aws? && !aws_iam?}
+    validates :aws_secret_access_key, :presence => true, :if => proc {aws? && !aws_iam?}
+    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
+      self.existing_remote_files = 'keep'
+      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
+
+    def manifest_digest_path
+      manifest_path = Dir["#{default_manifest_directory}/manifest-*.json"].try(:last)
+      if manifest_path
+        "#{assets_prefix}/#{File.basename(manifest_path)}"
+      end
+    end
+
+    def manifest_path
+      directory =
+        Rails.application.config.assets.manifest || default_manifest_directory
+      File.join(directory, "manifest.yml")
+    end
+
+    def gzip?
+      self.gzip_compression
+    end
+
+    def existing_remote_files?
+      ['keep', 'ignore'].include?(self.existing_remote_files)
+    end
+
+    def aws?
+      fog_provider =~ /aws/i
+    end
+
+    def aws_rrs?
+      aws_reduced_redundancy == true
+    end
+
+    def aws_iam?
+      aws_iam_roles == true
+    end
+
+    def fail_silently?
+      fail_silently || !enabled?
+    end
+
+    def log_silently?
+      ENV['RAILS_GROUPS'] == 'assets' || !!self.log_silently
+    end
+
+    def enabled?
+      enabled == true
+    end
+
+    def rackspace?
+      fog_provider =~ /rackspace/i
+    end
+
+    def google?
+      fog_provider =~ /google/i
+    end
+
+    def yml_exists?
+      defined?(Rails.root) ? File.exist?(self.yml_path) : false
+    end
+
+    def yml
+      begin
+        @yml ||= YAML.load(ERB.new(IO.read(yml_path)).result)[Rails.env] rescue nil || {}
+      rescue Psych::SyntaxError
+        @yml = {}
+      end
+    end
+
+    def yml_path
+      Rails.root.join("config", "asset_sync.yml").to_s
+    end
+
+    def assets_prefix
+      # Fix for Issue #38 when Rails.config.assets.prefix starts with a slash
+      self.prefix || Rails.application.config.assets.prefix.sub(/^\//, '')
+    end
+
+    def public_path
+      @public_path || Rails.public_path
+    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.aws_reduced_redundancy = yml["aws_reduced_redundancy"]
+      self.aws_iam_roles          = yml["aws_iam_roles"]
+      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")
+      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")
+      self.aws_secret_access_key  = yml["aws_access_secret"] if yml.has_key?("aws_access_secret")
+      self.fog_directory          = yml["aws_bucket"] if yml.has_key?("aws_bucket")
+      self.fog_region             = yml["aws_region"] if yml.has_key?("aws_region")
+
+      # TODO deprecate old style config settings
+      self.aws_access_key_id      = yml["access_key_id"] if yml.has_key?("access_key_id")
+      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
+
+
+    def fog_options
+      options = { :provider => fog_provider }
+      if aws?
+        if aws_iam?
+          options.merge!({
+            :use_iam_profile => true
+          })
+        else
+          options.merge!({
+            :aws_access_key_id => aws_access_key_id,
+            :aws_secret_access_key => aws_secret_access_key
+          })
+        end
+      elsif rackspace?
+        options.merge!({
+          :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!({
+          :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, Rackspace and Google are supported currently."
+      end
+
+      options.merge!({:region => fog_region}) if fog_region && !rackspace?
+      return options
+    end
+
+  private
+
+    def default_manifest_directory
+      File.join(Rails.public_path, assets_prefix)
+    end
+  end
+end