asset_sync 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,68 @@
+# Asset Sync
+
+Synchronises Assets between Rails and S3.
+
+Asset Sync is built to run with the new Rails Asset Pipeline feature of Rails 3.1.  After you run __bundle exec rake assets:precompile__ your assets will be synchronised to your S3 
+bucket, optionally deleting unused files and only uploading the files it needs to.
+
+This was initially built and is intended to work on [Heroku](http://heroku.com)
+
+## Installation
+
+Add the gem to your Gemfile
+
+    gem "asset_sync"
+
+Generate the rake task and config files
+
+    rails g asset_sync:install
+
+## Configuration
+
+Configure __config/environments/production.rb__ to use Amazon
+S3 as the asset host and ensure precompiling is enabled.
+
+    # config/environments/production.rb
+    config.action_controller.asset_host = Proc.new do |source|
+      request.ssl? 'https://my_bucket.s3.amazonaws.com' : 'http://my_bucket.s3.amazonaws.com'
+    end
+
+Add your Amazon S3 configuration details to
+    
+    # config/asset_sync.yml
+    development:
+      access_key_id: 'MY_ACCESS_KEY'
+      secret_access_key: 'MY_ACCESS_SECRET'
+      bucket: "my_bucket"
+      existing_remote_files: "keep"
+
+    production:
+      access_key_id: 'MY_ACCESS_KEY'
+      secret_access_key: 'MY_ACCESS_SECRET'
+      bucket: "my_bucket"
+      existing_remote_files: "delete"
+
+A rake task is installed with the generator to enhance the rails 
+precompile task by automatically running after it:
+
+    # lib/tasks/asset_sync.rake
+    Rake::Task["assets:precompile"].enhance do
+      AssetSync::Assets.sync
+    end
+
+## Todo
+
+1. Write some specs
+2. Add some before and after filters for deleting and uploading
+3. Provide more configuration options
+
+## Credits
+
+Have borrowed ideas from:
+
+ - [https://github.com/moocode/asset_id](https://github.com/moocode/asset_id)
+ - [https://gist.github.com/1053855](https://gist.github.com/1053855)
+
+## License
+
+MIT License. Copyright 2011 Rumble Labs Ltd. [rumblelabs.com](http://rumblelabs.com)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/asset_sync.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "asset_sync/version"
+
+Gem::Specification.new do |s|
+  s.name        = "asset_sync"
+  s.version     = AssetSync::VERSION
+  s.date        = "2011-07-30"
+  s.platform    = Gem::Platform::RUBY 
+  s.authors     = ["Simon Hamilton"]
+  s.email       = ["shamilton@rumblelabs.com"]
+  s.homepage    = ""
+  s.summary     = %q{Synchronises Assets between Rails and S3}
+  s.description = %q{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.}
+
+  s.rubyforge_project = "asset_sync"
+
+  s.add_dependency('fog')
+  
+  s.add_development_dependency "rspec"
+
+  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/lib/asset_sync.rb

@@ -0,0 +1,2 @@
+require 'fog'
+require "asset_sync/asset_sync"

data/lib/asset_sync/asset_sync.rb

@@ -0,0 +1,80 @@
+module AssetSync
+  class Assets
+
+    def self.s3_config
+      @config ||= YAML.load_file(File.join(Rails.root, "config/asset_sync.yml"))[Rails.env] rescue nil || {}
+    end
+
+    def self.connection
+      Fog::Storage.new(
+        :provider => 'AWS', 
+        :aws_access_key_id => s3_config["access_key_id"],
+        :aws_secret_access_key => s3_config["secret_access_key"]
+      )
+    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
+
+    def self.get_remote_files
+      return bucket.files.map { |f| f.key }
+    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
+    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
+    end
+
+    def self.upload_file(f)
+      STDERR.puts "Uploading: #{f}"
+      file = bucket.files.create(
+        :key => "#{f}",
+        :body => File.open("#{path}/#{f}"),
+        :public => true
+      )
+    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
+    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/version.rb

@@ -0,0 +1,3 @@
+module AssetSync
+  VERSION = "0.0.1"
+end

data/lib/generators/asset_sync/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+module AssetSync
+  class InstallGenerator < Rails::Generators::Base
+    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]
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def generate_config
+      copy_file "asset_sync.yml", "config/asset_sync.yml"
+    end
+    
+    def generate_rake_task
+      copy_file "asset_sync.rake", "lib/tasks/asset_sync.rake"
+    end
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+development:
+  access_key_id: 'MY_ACCESS_KEY'
+  secret_access_key: 'MY_ACCESS_SECRET'
+  bucket: "my_bucket"
+  existing_remote_files: keep
+
+production:
+  access_key_id: 'MY_ACCESS_KEY'
+  secret_access_key: 'MY_ACCESS_SECRET'
+  bucket: "my_bucket"
+  existing_remote_files: delete

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: asset_sync
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Simon Hamilton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fog
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- asset_sync.gemspec
+- lib/asset_sync.rb
+- lib/asset_sync/asset_sync.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.yml
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: asset_sync
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Synchronises Assets between Rails and S3
+test_files: []
+