asset_sync 0.0.6 → 0.1.0

data/README.md

@@ -16,6 +16,10 @@ Add the gem to your Gemfile
 Generate the rake task and config files
 
     rails g asset_sync:install
+    
+If you would like to use a YAML file for configuration instead of the default (Rails Initializer) then 
+
+    rails g asset_sync:install --use-yml
 
 ## Configuration
 
@@ -27,31 +31,56 @@ S3 as the asset host and ensure precompiling is enabled.
       request.ssl? ? 'https://my_bucket.s3.amazonaws.com' : 'http://my_bucket.s3.amazonaws.com'
     end
 
-### asset_sync.yml
+We support two methods of configuration.
+
+* Rails Initializer
+* A YAML config file
+
+Using an **Initializer** is the default method and is best used with **environment** variables. It's the recommended approach for deployments on Heroku.
+
+Using a **YAML** config file is a traditional strategy for Capistrano deployments. If you are using [Moonshine](https://github.com/railsmachine/moonshine) (which we would recommend) then it is best used with [shared configuration files](https://github.com/railsmachine/moonshine/wiki/Shared-Configuration-Files).
+
+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.
+
+### Initializer (config/initializers/asset_sync.rb)
+
+The generator will create a Rails initializer at `config/initializers/asset_sync.rb`.
+
+    AssetSync.configure do |config|
+      config.aws_access_key = ENV['AWS_ACCESS_KEY']
+      config.aws_access_secret = ENV['AWS_ACCESS_SECRET']
+      config.aws_bucket = ENV['AWS_BUCKET']
+      # config.aws_region = 'eu-west-1'
+      config.existing_remote_files = "keep"
+    end
+
+
+### YAML (config/asset_sync.yml)
 
-The recommend way to configure your **asset_sync.yml** is by adding an environment variable. That way your access keys are not checked into version control.
+If you used the `--use-yml` flag, the generator will create a YAML file at `config/initializers/asset_sync.rb`.
 
     defaults: &defaults
-      access_key_id: "<%= ENV['AWS_ACCESS_KEY'] %>"
-      secret_access_key: "<%= ENV['AWS_ACCESS_SECRET'] %>"
+      aws_access_key: "<%= ENV['AWS_ACCESS_KEY'] %>"
+      aws_access_secret: "<%= ENV['AWS_ACCESS_SECRET'] %>"
       # You may need to specify what region your S3 bucket is in
-      # region: "eu-west-1"
+      # aws_region: "eu-west-1"
 
     development:
       <<: *defaults
-      bucket: "backoffice_development"
+      aws_bucket: "rails_app_development"
       existing_remote_files: keep # Existing pre-compiled assets on S3 will be kept
 
     test:
       <<: *defaults
-      bucket: "backoffice_test"
+      aws_bucket: "rails_app_test"
       existing_remote_files: keep
 
     production:
       <<: *defaults
-      bucket: "backoffice_production"
+      aws_bucket: "rails_app_production"
       existing_remote_files: delete # Existing pre-compiled assets on S3 will be deleted
 
+### Environment Variables
 
 Add your Amazon S3 configuration details to **heroku**
 
@@ -63,13 +92,6 @@ Or add to a traditional unix system
     export AWS_ACCESS_KEY=xxxx
     export AWS_ACCESS_SECRET=xxxx
 
-If you are using anything other than the US buckets with S3 then you'll want to set the **region**. For example with an EU bucket you could set the following
-
-    production:
-      access_key_id: 'MY_ACCESS_KEY'
-      secret_access_key: 'MY_ACCESS_SECRET'
-      region: 'eu-west-1'
-
 ### Available Configuration Options
 
 * **access\_key\_id**: your Amazon S3 access key
@@ -77,6 +99,22 @@ If you are using anything other than the US buckets with S3 then you'll want to
 * **region**: the region your S3 bucket is in e.g. *eu-west-1*
 * **existing_remote_files**: what to do with previously precompiled files, options are **keep** or **delete**
 
+## Amazon S3 Multiple Region Support
+
+If you are using anything other than the US buckets with S3 then you'll want to set the **region**. For example with an EU bucket you could set the following with YAML.
+
+    production:
+      # ...
+      region: 'eu-west-1'
+
+Or via the initializer
+
+    AssetSync.configure do |config|
+      # ...
+      config.aws_region = 'eu-west-1'
+    end
+
+
 ## Rake Task
 
 A rake task is installed with the generator to enhance the rails 
@@ -84,14 +122,14 @@ precompile task by automatically running after it:
 
     # lib/tasks/asset_sync.rake
     Rake::Task["assets:precompile"].enhance do
-      AssetSync::Assets.sync
+      AssetSync.sync
     end
 
 ## Todo
 
-1. Write some specs
-2. Add some before and after filters for deleting and uploading
-3. Provide more configuration options
+1. Add some before and after filters for deleting and uploading
+2. Support more cloud storage providers
+3. Better test coverage
 
 ## Credits
 

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        = "2011-08-06"
+  s.date        = "2011-08-22"
   s.platform    = Gem::Platform::RUBY 
   s.authors     = ["Simon Hamilton", "David Rice"]
   s.email       = ["shamilton@rumblelabs.com", "me@davidjrice.co.uk"]
@@ -17,8 +17,10 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "asset_sync"
 
   s.add_dependency('fog')
-  
+
   s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "jeweler"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/asset_sync.rb

@@ -1,2 +1,5 @@
 require 'fog'
+require 'erb'
 require "asset_sync/asset_sync"
+require 'asset_sync/config'
+require 'asset_sync/storage'

data/lib/asset_sync/asset_sync.rb

@@ -1,83 +1,30 @@
 module AssetSync
-  class Assets
 
-    def self.s3_config
-      @config ||= YAML.load(ERB.new(IO.read(File.join(Rails.root, "config/asset_sync.yml"))).result)[Rails.env] rescue nil || {}
-    end
-
-    def self.connection
-      storage = {
-        :provider => 'AWS', 
-        :aws_access_key_id => s3_config["access_key_id"],
-        :aws_secret_access_key => s3_config["secret_access_key"]
-      }
-      storage.merge!({:region => s3_config["region"]}) if s3_config.has_key?("region")
-
-      Fog::Storage.new(storage)
-    end
-
-    def self.bucket
-      @bucket ||= connection.directories.get(s3_config["bucket"])
-    end
-    
-    def self.keep_existing_remote_files
-      (s3_config["existing_remote_files"]) ? (s3_config["existing_remote_files"] == "keep") : true 
-    end
-    
-    def self.path
-      "#{Rails.root.to_s}/public"
-    end
-    
-    def self.local_files
-      Dir["#{path}/assets/**/**"].map { |f| f[path.length+1,f.length-path.length] }
-    end
+  class << self
 
-    def self.get_remote_files
-      return bucket.files.map { |f| f.key }
+    def config=(data)
+      @config = data
     end
 
-    def self.delete_file(f, remote_files_to_delete)
-      if remote_files_to_delete.include?(f.key)
-        STDERR.puts "Deleting: #{f.key}"
-        f.destroy
-      end
+    def config
+      @config ||= Config.new
+      raise Config::Invalid("Your configuration in (config/asset_sync.yml or config/initializers/asset_sync.rb) is missing or invalid, please refer to the documention and emend") unless @config && @config.valid?
+      @config
     end
 
-    def self.delete_extra_remote_files
-      remote_files = get_remote_files
-      from_remote_files_to_delete = (local_files | remote_files) - (local_files & remote_files)
-
-      # Delete unneeded remote files
-      bucket.files.each do |f|
-        delete_file(f, from_remote_files_to_delete)
-      end
+    def configure(&proc)
+      @config ||= Config.new
+      yield @config
     end
 
-    def self.upload_file(f)
-      STDERR.puts "Uploading: #{f}"
-      file = bucket.files.create(
-        :key => "#{f}",
-        :body => File.open("#{path}/#{f}"),
-        :public => true
-      )
+    def storage
+      @storage ||= Storage.new(self.config)
     end
 
-    def self.upload_files
-      # get a fresh list of remote files
-      remote_files = get_remote_files
-      local_files_to_upload = (remote_files | local_files) - (remote_files & local_files)
-
-      # Upload new files
-      local_files_to_upload.each do |f|
-        next unless File.file? "#{path}/#{f}" # Only files.
-        upload_file f
-      end
+    def sync
+      self.storage.sync
     end
 
-    def self.sync
-       delete_extra_remote_files unless keep_existing_remote_files
-       upload_files
-       STDERR.puts "Done."
-    end    
   end
+
 end

data/lib/asset_sync/config.rb

@@ -0,0 +1,64 @@
+module AssetSync
+  class Config
+
+    class Invalid < StandardError; end
+
+    attr_accessor :provider
+    attr_accessor :aws_access_key, :aws_access_secret
+    attr_accessor :aws_bucket
+    attr_accessor :aws_region
+    attr_accessor :existing_remote_files
+
+    def initialize
+      self.provider = 'AWS'
+      self.aws_region = nil
+      self.existing_remote_files = 'keep'
+      load_yml! if yml_exists?
+    end
+
+    def existing_remote_files?
+      (self.existing_remote_files) ? (self.existing_remote_files == "keep") : true 
+    end
+
+
+    def yml_exists?
+      File.exists?(self.yml_path)
+    end
+
+    def yml
+      y ||= YAML.load(ERB.new(IO.read(yml_path)).result)[Rails.env] rescue nil || {}
+    end
+
+    def yml_path
+      File.join(Rails.root, "config/asset_sync.yml")
+    end
+
+    def load_yml!
+      self.aws_access_key    = yml["aws_access_key"]
+      self.aws_access_secret = yml["aws_access_secret"]
+      self.aws_bucket        = yml["aws_bucket"]
+      self.aws_region        = yml["aws_region"]
+
+      # TODO deprecate old style config settings
+      self.aws_access_key    = yml["access_key_id"] if yml.has_key?("access_key_id")
+      self.aws_access_secret = yml["secret_access_key"] if yml.has_key?("secret_access_key")
+      self.aws_bucket        = yml["bucket"] if yml.has_key?("bucket")
+      self.aws_region        = yml["region"] if yml.has_key?("region")
+    end
+
+    def fog_options
+      options = {
+        :provider => provider, 
+        :aws_access_key_id => aws_access_key,
+        :aws_secret_access_key => aws_access_secret
+      }
+      options.merge!({:region => aws_region}) if aws_region
+      return options
+    end
+
+    def valid?
+      true
+    end
+
+  end
+end

data/lib/asset_sync/storage.rb

@@ -0,0 +1,80 @@
+module AssetSync
+  class Storage
+
+    attr_accessor :config
+
+    def initialize(cfg)
+      @config = cfg
+    end
+
+    def connection
+      @connection ||= Fog::Storage.new(self.config.fog_options)
+    end
+
+    def bucket
+      @bucket ||= connection.directories.get(self.config.aws_bucket)
+    end
+
+    def keep_existing_remote_files
+      self.config.existing_remote_files?
+    end
+
+    def path
+      "#{Rails.root.to_s}/public"
+    end
+
+    def local_files
+      Dir["#{path}/assets/**/**"].map { |f| f[path.length+1,f.length-path.length] }
+    end
+
+    def get_remote_files
+      return bucket.files.map { |f| f.key }
+    end
+
+    def delete_file(f, remote_files_to_delete)
+      if remote_files_to_delete.include?(f.key)
+        STDERR.puts "Deleting: #{f.key}"
+        f.destroy
+      end
+    end
+
+    def delete_extra_remote_files
+      remote_files = get_remote_files
+      from_remote_files_to_delete = (local_files | remote_files) - (local_files & remote_files)
+
+      # Delete unneeded remote files
+      bucket.files.each do |f|
+        delete_file(f, from_remote_files_to_delete)
+      end
+    end
+
+    def upload_file(f)
+      STDERR.puts "Uploading: #{f}"
+      file = bucket.files.create(
+        :key => "#{f}",
+        :body => File.open("#{path}/#{f}"),
+        :public => true,
+        'Cache-Control' => 'max-age=29030400, public'
+      )
+    end
+
+    def upload_files
+      # get a fresh list of remote files
+      remote_files = get_remote_files
+      local_files_to_upload = (remote_files | local_files) - (remote_files & local_files)
+
+      # Upload new files
+      local_files_to_upload.each do |f|
+        next unless File.file? "#{path}/#{f}" # Only files.
+        upload_file f
+      end
+    end
+
+    def sync
+       delete_extra_remote_files unless keep_existing_remote_files
+       upload_files
+       STDERR.puts "Done."
+    end
+
+  end
+end

data/lib/asset_sync/version.rb

@@ -1,3 +1,3 @@
 module AssetSync
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/lib/generators/asset_sync/install_generator.rb

@@ -4,10 +4,7 @@ module AssetSync
     desc "Install a config/asset_sync.yml and the asset:precompile rake task enhancer"
 
     # Commandline options can be defined here using Thor-like options:
-    class_option :my_opt, :type => :boolean, :default => false, :desc => "My Option"
-
-    # I can later access that option using:
-    # options[:my_opt]
+    class_option :use_yml, :type => :boolean, :default => false, :desc => "Use YML file instead of Rails Initializer"
 
     def self.source_root
       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
@@ -26,9 +23,17 @@ module AssetSync
     end
 
     def generate_config
-      template "asset_sync.yml", "config/asset_sync.yml"
+      if options[:use_yml]
+        template "asset_sync.yml", "config/asset_sync.yml"
+      end
+    end
+
+    def generate_initializer
+      unless options[:use_yml]
+        template "asset_sync.rb", "config/initializers/asset_sync.rb"
+      end
     end
-    
+
     def generate_rake_task
       template "asset_sync.rake", "lib/tasks/asset_sync.rake"
     end

data/lib/generators/asset_sync/templates/asset_sync.rake

@@ -1,3 +1,3 @@
 Rake::Task["assets:precompile"].enhance do
-  AssetSync::Assets.sync
+  AssetSync.sync
 end

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

@@ -0,0 +1,7 @@
+AssetSync.configure do |config|
+  config.aws_access_key = ENV['AWS_ACCESS_KEY']
+  config.aws_access_secret = ENV['AWS_ACCESS_SECRET']
+  config.aws_bucket = ENV['AWS_BUCKET']
+  # config.aws_region = "eu-west-1"
+  config.existing_remote_files = "keep"
+end

data/spec/asset_sync_spec.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe AssetSync, 'with initializer' do
+
+  before(:all) do
+    AssetSync.configure do |config|
+      config.aws_access_key = 'aaaa'
+      config.aws_access_secret = 'bbbb'
+      config.aws_bucket = 'mybucket'
+      config.aws_region = 'eu-west-1'
+      config.existing_remote_files = "keep"
+    end
+  end
+
+  it "should should keep existing remote files" do
+    AssetSync.config.keep_existing_remote_files?.should == true
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_access_key.should == "aaaa"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_access_secret.should == "bbbb"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_bucket.should == "mybucket"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_region.should == "eu-west-1"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.existing_remote_files.should == "keep"
+  end
+
+end
+
+
+describe AssetSync, 'from yml' do
+
+  before(:all) do
+    AssetSync.config = AssetSync::Config.new
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_access_key.should == "xxxx"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_access_secret.should == "zzzz"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_bucket.should == "rails_app_test"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.aws_region.should == "eu-west-1"
+  end
+
+  it "should configure aws_access_key" do
+    AssetSync.config.existing_remote_files.should == "keep"
+  end
+
+end

data/spec/rails_app/config/asset_sync.yml

@@ -0,0 +1,20 @@
+defaults: &defaults
+  access_key_id: "xxxx"
+  secret_access_key: "zzzz"
+  region: "eu-west-1"
+
+development:
+  <<: *defaults
+  bucket: "rails_app_development"
+  existing_remote_files: keep
+
+test:
+  <<: *defaults
+  bucket: "rails_app_test"
+  existing_remote_files: keep
+
+production:
+  <<: *defaults
+  bucket: "rails_app_production"
+  existing_remote_files: delete
+

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'asset_sync'
+
+class Rails
+
+  def self.env
+    "test"
+  end
+
+  def self.root
+    File.expand_path(File.join('spec', 'rails_app'))
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: asset_sync
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Simon Hamilton
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-06 00:00:00 Z
+date: 2011-08-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fog
@@ -35,6 +35,28 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: After you run assets:precompile your assets will be synchronised with your S3 bucket, deleting unused files and only uploading the files it needs to.
 email: 
 - shamilton@rumblelabs.com
@@ -53,10 +75,16 @@ files:
 - asset_sync.gemspec
 - lib/asset_sync.rb
 - lib/asset_sync/asset_sync.rb
+- lib/asset_sync/config.rb
+- lib/asset_sync/storage.rb
 - lib/asset_sync/version.rb
 - lib/generators/asset_sync/install_generator.rb
 - lib/generators/asset_sync/templates/asset_sync.rake
+- lib/generators/asset_sync/templates/asset_sync.rb
 - lib/generators/asset_sync/templates/asset_sync.yml
+- spec/asset_sync_spec.rb
+- spec/rails_app/config/asset_sync.yml
+- spec/spec_helper.rb
 homepage: https://github.com/rumblelabs/asset_sync
 licenses: []
 
@@ -80,9 +108,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: asset_sync
-rubygems_version: 1.7.2
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: Synchronises Assets between Rails and S3
-test_files: []
-
+test_files: 
+- spec/asset_sync_spec.rb
+- spec/rails_app/config/asset_sync.yml
+- spec/spec_helper.rb