refinerycms-s3assets 0.1.0 → 0.2.0

data/README.md

@@ -7,14 +7,14 @@ This gem adds a rake task to your Refinery CMS project which copies your product
 
 1. Mac OS X, Linux, or UNIX.
 2. A Heroku account (or S3 credentials).
-3. A Refinery CMS project
+3. A Refinery CMS 2.x project (RefineryCMS 1.x not currently supported)
 
 ## Installation
 
 Open up your Gemfile and add at the bottom this line:
 
 ```ruby
-gem 'refinerycms-s3assets'
+gem 'refinerycms-s3assets', :group => :development
 ```
 
 Now, run:
@@ -29,6 +29,8 @@ This gem assumes that your production Heroku app is storing assets on Amazon s3
 and that your Heroku app has the following three config vars properly defined:
 `S3_BUCKET`, `S3_KEY` and `S3_SECRET` ( see http://devcenter.heroku.com/articles/config-vars for more info).
 
+### Copying production data to development
+
 Start by copying your production database to your local database:
 
 ```shell
@@ -38,20 +40,40 @@ heroku db:pull
 To copy all Image and Resource files from S3 you can now run the following:
 
 ```shell
-bundle exec rake refinery:download_s3_assets
+bundle exec rake refinery_s3assets:pull
 ```
 
+### Copying development data to production
+
+Start by copying your development database to your production:
+
+```shell
+heroku db:push
+```
+
+To copy all Image and Resources files from local development to S3 you can run the following:
+
+```shell
+bundle exec rake refinery_s3assets:push
+```
+
+### Alternatative methods of specifying S3 credentials
+
 If you do not have a Heroku application but you do know the S3 credentials then you
 can provide these manually as ENV variables:
 
 ```shell
-S3_KEY=key S3_SECRET=secret S3_BUCKET=bucket bundle exec rake refinery:download_s3_assets
+S3_KEY=key S3_SECRET=secret S3_BUCKET=bucket bundle exec rake refinery_s3assets:pull
 ```
 
+## Warning
+
+There is currently no prompting if you are overwriting existing files so please be careful.
+
 ## License
 
 Please see MIT-LICENSE for more details.
 
 ## Copyright
 
-Copyright (c) 2011 Rounders Consulting Inc.
+Copyright (c) 2012 Rounders Consulting Inc.

data/lib/refinerycms-s3assets/version.rb

@@ -1,5 +1,5 @@
 module Refinery
   module S3assets
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/refinerycms-s3assets.rb

@@ -1,4 +1,4 @@
-require 'aws/s3'
+require 'aws-sdk'
 require 'heroku/command/base'
 require 'progress_bar'
 
@@ -13,50 +13,64 @@ module Refinery
     class Util
 
       def self.pull
-        raise(StandardError, "no S3_KEY config var or environment variable found") if s3_config[:key].nil?
-        raise(StandardError, "no S3_SECRET config var or environment variable found") if s3_config[:secret].nil?
-        raise(StandardError, "no S3_BUCKET config var or environment variable found") if s3_config[:bucket].nil?
-        copy_s3_bucket(s3_config[:key], s3_config[:secret], s3_config[:bucket], 'public/system/refinery')
+        verify_s3_configuration
+        base_path = "public/system/refinery"
+        copy_from_s3_bucket(Image, :image_uid, s3_config[:bucket], File.join(base_path, "images"))
+        copy_from_s3_bucket(Resource, :file_uid, s3_config[:bucket], File.join(base_path, "resources"))
       end
 
-    private
+      def self.push
+        verify_s3_configuration
+        base_path = "public/system/refinery"
+        copy_to_s3_bucket(Image, :image_uid, s3_config[:bucket], File.join(base_path, "images"))
+        copy_to_s3_bucket(Resource, :file_uid, s3_config[:bucket], File.join(base_path, "resources"))
+      end
 
-      def self.copy_s3_bucket(s3_key, s3_secret, s3_bucket, output_path)
-        AWS::S3::Base.establish_connection!(:access_key_id => s3_key, :secret_access_key => s3_secret)
-        bucket = AWS::S3::Bucket.find(s3_bucket)
+      private
 
-        puts "There are #{Image.count} images in the #{s3_bucket} bucket"
-        Image.all.each do |image|
-          s3_object = AWS::S3::S3Object.find image.image_uid,s3_bucket
-          dest = File.join(output_path,"images",s3_object.key)
-          copy_s3_object(s3_object,dest)
+      def self.verify_s3_configuration
+        { :key => 'S3_KEY', :secret => 'S3_SECRET', :bucket => 'S3_BUCKET' }.each do |key, val|
+          raise(StandardError, "no #{val} config var or environment variable found") if s3_config[key].nil?
         end
+      end
 
-        puts "\n\nThere are #{Resource.count} resources in the #{s3_bucket} bucket"
-        Resource.all.each do |resource|
-          s3_object = AWS::S3::S3Object.find resource.file_uid,s3_bucket
-          dest = File.join(output_path,"resources",s3_object.key)
-          copy_s3_object(s3_object,dest)
+      def self.copy_to_s3_bucket(klass, uid, bucket, source_path)
+        puts "Uploading #{klass.count} #{klass.to_s.pluralize} to #{bucket} bucket"
+        bar = ProgressBar.new(klass.count, :bar, :counter, :percentage)
+        klass.all.each do |object|
+          s3_object = s3.buckets[bucket].objects[object.send(uid)]
+          path = File.join(source_path, object.send(uid))
+          s3_object.write(:file => path, :acl => :public_read)
+          bar.increment!
         end
+      end
 
+      def self.copy_from_s3_bucket(klass, uid, bucket, output_path)
+        puts "Downloading #{klass.count} #{klass.to_s.pluralize} from #{bucket} bucket"
+        bar = ProgressBar.new(klass.count, :bar, :counter, :percentage)
+        skipped_files = []
+        klass.all.each do |object|
+          begin
+            s3_object = s3.buckets[bucket].objects[object.send(uid)]
+            dest = File.join(output_path, s3_object.key)
+            copy_s3_object(s3_object, dest)
+            bar.increment!
+          rescue AWS::S3::Errors::NoSuchKey
+            skipped_files << object.send(uid)
+          end
+        end
+        skipped_files.each {|f| puts "could not find #{f}"}
       end
 
       def self.copy_s3_object(s3_object, to)
         FileUtils::mkdir_p File.dirname(to), :verbose => false
-
-        filesize = s3_object.about['content-length'].to_f
-        puts "Saving #{s3_object.key} (#{filesize} bytes):"
-
-        bar = ProgressBar.new(filesize, :percentage, :counter)
-
         open(to, 'wb') do |f|
-          s3_object.value do |chunk|
-            bar.increment! chunk.size
-            f.write chunk
-          end
+          f.write s3_object.read
         end
+      end
 
-        puts "\n=======================================\n"
+      def self.s3
+        @s3 ||= AWS::S3.new(:access_key_id => s3_config[:key], :secret_access_key => s3_config[:secret])
       end
 
       def self.s3_config

data/lib/tasks/s3assets.rake

@@ -1,8 +1,19 @@
 
 
-namespace :refinery do
+namespace :refinery_s3assets do
   desc "download image and resource assets from s3"
-  task :download_s3_assets => :environment do
+  task :pull => :environment do
     Refinery::S3assets::Util.pull
   end
-end
+
+  desc "upload local image and resource assets to s3"
+  task :push => :environment do
+    Refinery::S3assets::Util.push
+  end
+end
+
+# preserve old tasks
+namespace :refinery do
+  task :download_s3_assets => 'refinery_s3assets:pull'
+  task :upload_s3_assets => 'refinery_s3assets:push' 
+end

data/refinerycms-s3assets.gemspec

@@ -8,13 +8,13 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Francois Harbec"]
   s.email       = ["fharbec@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/rounders/refinerycms-s3assets"
   s.summary     = %q{copies s3 assets from production refinerycms app hosted on Heroku to local}
   s.description = %q{copies s3 assets from production refinerycms app hosted on Heroku to local}
 
-  s.add_dependency("aws-s3", "~> 0.6.2")
-  s.add_dependency("heroku", "~> 2.19.1")
-  s.add_dependency("progress_bar", "~> 0.3.4")
+  s.add_dependency("aws-sdk", "~> 1.3.7")
+  s.add_dependency("heroku", "~> 2.21.2")
+  s.add_dependency("progress_bar", "~> 0.4.0")
 
   s.rubyforge_project = "refinerycms-s3assets"
 

metadata

@@ -1,57 +1,80 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: refinerycms-s3assets
-version: !ruby/object:Gem::Version
-  version: 0.1.0
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Francois Harbec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-07 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: aws-s3
-  requirement: &70332380816420 !ruby/object:Gem::Requirement
+
+date: 2012-03-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aws-sdk
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.2
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 3
+        - 7
+        version: 1.3.7
   type: :runtime
-  prerelease: false
-  version_requirements: *70332380816420
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: heroku
-  requirement: &70332380815800 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.19.1
+      - !ruby/object:Gem::Version 
+        hash: 95
+        segments: 
+        - 2
+        - 21
+        - 2
+        version: 2.21.2
   type: :runtime
-  prerelease: false
-  version_requirements: *70332380815800
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: progress_bar
-  requirement: &70332380815240 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.4
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
   type: :runtime
-  prerelease: false
-  version_requirements: *70332380815240
-description: copies s3 assets from production refinerycms app hosted on Heroku to
-  local
-email:
+  version_requirements: *id003
+description: copies s3 assets from production refinerycms app hosted on Heroku to local
+email: 
 - fharbec@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -61,28 +84,38 @@ files:
 - lib/refinerycms-s3assets/version.rb
 - lib/tasks/s3assets.rake
 - refinerycms-s3assets.gemspec
-homepage: ''
+homepage: https://github.com/rounders/refinerycms-s3assets
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: refinerycms-s3assets
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: copies s3 assets from production refinerycms app hosted on Heroku to local
 test_files: []
+