asset_sync 0.0.3 → 0.0.4

data/README.md

@@ -23,24 +23,45 @@ 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'
+    config.action_controller.asset_host = Proc.new do |source, request|
+      request.ssl? ? 'https://my_bucket.s3.amazonaws.com' : 'http://my_bucket.s3.amazonaws.com'
     end
 
-Add your Amazon S3 configuration details to **asset_sync.yml**
-    
-    # config/asset_sync.yml
+### 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.
+
+    defaults: &defaults
+      access_key_id: "<%= ENV['AWS_ACCESS_KEY'] %>"
+      secret_access_key: "<%= ENV['AWS_ACCESS_SECRET'] %>"
+      # You may need to specify what region your S3 bucket is in
+      # region: "eu-west-1"
+
     development:
-      access_key_id: 'MY_ACCESS_KEY'
-      secret_access_key: 'MY_ACCESS_SECRET'
-      bucket: "my_bucket"
-      existing_remote_files: "keep"
+      <<: *defaults
+      bucket: "backoffice_development"
+      existing_remote_files: keep # Existing pre-compiled assets on S3 will be kept
+
+    test:
+      <<: *defaults
+      bucket: "backoffice_test"
+      existing_remote_files: keep
 
     production:
-      access_key_id: 'MY_ACCESS_KEY'
-      secret_access_key: 'MY_ACCESS_SECRET'
-      bucket: "my_bucket"
-      existing_remote_files: "delete"
+      <<: *defaults
+      bucket: "backoffice_production"
+      existing_remote_files: delete # Existing pre-compiled assets on S3 will be deleted
+
+
+Add your Amazon S3 configuration details to **heroku**
+
+    heroku config:add AWS_ACCESS_KEY=xxxx
+    heroku config:add AWS_ACCESS_KEY=xxxx
+
+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
 
@@ -49,6 +70,15 @@ If you are using anything other than the US buckets with S3 then you'll want to
       secret_access_key: 'MY_ACCESS_SECRET'
       region: 'eu-west-1'
 
+### Available Configuration Options
+
+* **access\_key\_id**: your Amazon S3 access key
+* **secret_access\_key**: your Amazon S3 access secret
+* **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**
+
+## Rake Task
+
 A rake task is installed with the generator to enhance the rails 
 precompile task by automatically running after it:
 

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-07-30"
+  s.date        = "2011-08-05"
   s.platform    = Gem::Platform::RUBY 
   s.authors     = ["Simon Hamilton", "David Rice"]
   s.email       = ["shamilton@rumblelabs.com", "me@davidjrice.co.uk"]

data/lib/asset_sync/version.rb

@@ -1,3 +1,3 @@
 module AssetSync
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/generators/asset_sync/install_generator.rb

@@ -13,12 +13,24 @@ module AssetSync
       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
     end
 
+    def aws_access_key
+      "<%= ENV['AWS_ACCESS_KEY'] %>"
+    end
+
+    def aws_access_secret
+      "<%= ENV['AWS_ACCESS_SECRET'] %>"
+    end
+
+    def app_name
+      @app_name ||= Rails.application.is_a?(Rails::Application) && Rails.application.class.name.sub(/::Application$/, "").downcase
+    end
+
     def generate_config
-      copy_file "asset_sync.yml", "config/asset_sync.yml"
+      template "asset_sync.yml", "config/asset_sync.yml"
     end
     
     def generate_rake_task
-      copy_file "asset_sync.rake", "lib/tasks/asset_sync.rake"
+      template "asset_sync.rake", "lib/tasks/asset_sync.rake"
     end
   end
 end

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

@@ -1,11 +1,21 @@
+defaults: &defaults
+  access_key_id: "<%= aws_access_key %>"
+  secret_access_key: "<%= aws_access_secret %>"
+  # You may need to specify what region your S3 bucket is in
+  # region: "eu-west-1"
+
 development:
-  access_key_id: 'MY_ACCESS_KEY'
-  secret_access_key: 'MY_ACCESS_SECRET'
-  bucket: "my_bucket"
+  <<: *defaults
+  bucket: "<%= app_name %>_development"
+  existing_remote_files: keep # Existing pre-compiled assets on S3 will be kept
+
+test:
+  <<: *defaults
+  bucket: "<%= app_name %>_test"
   existing_remote_files: keep
 
 production:
-  access_key_id: 'MY_ACCESS_KEY'
-  secret_access_key: 'MY_ACCESS_SECRET'
-  bucket: "my_bucket"
-  existing_remote_files: delete
+  <<: *defaults
+  bucket: "<%= app_name %>_production"
+  existing_remote_files: delete # Existing pre-compiled assets on S3 will be deleted
+

metadata

@@ -2,7 +2,7 @@
 name: asset_sync
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Simon Hamilton
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-30 00:00:00 Z
+date: 2011-08-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fog