s3_asset_sync 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8791d286affb173eb4d5e3940e2d31104a134fd
+  data.tar.gz: 047cc71a9f62d00bdfdffc978b2369a1d35a7331
+SHA512:
+  metadata.gz: fad6979d7fd385cc2114471ece7719e935e95a69b1cdc7e9010bfb72fcc11dfbd26523c0dccaa1fa7bade61d3eee086964223d48929e274f44db23e45cf00628
+  data.tar.gz: 0b71d72e6c543ae1d37c3b426d3259bc5b3b86797a65e78cfb34dffca3b36229b82fd083ce9de3193768296b1a9e2ccb6ba7f6908aca0156e37b2a41078987d7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Neil Turner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,35 @@
+= S3 Asset Sync
+
+This gem provides a simple way of syncronizing your Rails 4 assets with an AWS S3 Bucket.
+
+== Installation
+
+  gem 's3_asset_sync'
+
+== Configuration
+
+Run the following command to generate a configuration file in your Rails /config/initializers folder.
+
+  rake s3_asset_sync:setup
+
+Edit that file and replace the default values with your own AWS details.
+
+== Usage
+
+By default, assets will be syncronized automatically after precompilation:
+
+  rake assets:precompile
+
+If this is not the desired behaviour then simply edit the configuration value as below:
+
+ Rails.application.config.s3_asset_sync.run_after_precompile = false
+
+To manually syncronize assets run:
+
+  rake assets:sync_to_s3
+
+== Deleting Assets
+
+Expired assets won't be automatically removed from S3 as some nodes within a load balanced setup may temporarily require older assets. To delete expired assets from S3 run:
+
+  rake assets:purge_s3

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'S3AssetSync'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/s3_asset_sync.rb

@@ -0,0 +1,104 @@
+require 'colorize'
+require 'aws-sdk-core'
+require 's3_asset_sync/railtie' if defined?(Rails)
+
+module S3AssetSync
+
+  ##
+  # Loops through /public/assets directory and sync's each
+  # file with the specified S3 Bucket.
+  #
+  def self.sync
+    puts "Syncing assets to S3...".yellow
+
+    Aws.config.update({
+      credentials: Aws::Credentials.new(
+        Rails.application.config.s3_asset_sync.s3_access_key,
+        Rails.application.config.s3_asset_sync.s3_secret_access_key
+      ),
+      region: Rails.application.config.s3_asset_sync.s3_region
+    })
+
+    s3 = Aws::S3::Client.new
+
+    Dir.foreach(Rails.root.join('public','assets')) do |file|
+      next if file == '.' || file == '..'
+      puts "SYNC: #{file}"
+      self.s3_upload_object(s3, file) unless self.s3_object_exists?(s3, file)
+    end
+
+    puts "Asset sync successfully completed...".green
+  end
+
+  ##
+  # Loops through specified S3 Bucket and checks to see if the object
+  # exists in our /public/assets folder. Deletes it from the
+  # bucket if it doesn't exist.
+  #
+  def self.purge
+    puts "Cleaning assets in S3...".yellow
+
+    Aws.config.update({
+      credentials: Aws::Credentials.new(
+        Rails.application.config.s3_asset_sync.s3_access_key,
+        Rails.application.config.s3_asset_sync.s3_secret_access_key
+      ),
+      region: Rails.application.config.s3_asset_sync.s3_region
+    })
+
+    s3 = Aws::S3::Client.new
+
+    keys = []
+
+    s3.list_objects(bucket:Rails.application.config.s3_asset_sync.s3_bucket).each do |response|
+      keys += response.contents.map(&:key)
+    end
+
+    keys.each do |key|
+      if !File.exists?(Rails.root.join('public', 'assets', key))
+        self.s3_delete_object(s3, key) 
+        puts "DELETED: #{key}"
+      end
+    end
+
+    puts "Asset clean successfully completed...".green
+  end
+
+  ##
+  # Check if a key exists in the specified S3 Bucket.
+  #
+  def self.s3_object_exists?(client, key)
+    begin
+      client.head_object(
+        bucket: Rails.application.config.s3_asset_sync.s3_bucket,
+        key: key
+      )
+      return true
+    rescue
+      return false
+    end
+  end
+
+  ##
+  # Uploads an object to the specified S3 Bucket.
+  #
+  def self.s3_upload_object(client, key)
+    resp = client.put_object(
+      acl: "public-read",
+      bucket: Rails.application.config.s3_asset_sync.s3_bucket,
+      body: File.open(Rails.root.join('public','assets', key)),
+      key: key
+    )
+  end
+
+  ##
+  # Deletes an object from the specified S3 Bucket.
+  #
+  def self.s3_delete_object(client, key)
+    resp = client.delete_object(
+      bucket: Rails.application.config.s3_asset_sync.s3_bucket,
+      key: key
+    )
+  end
+
+end

data/lib/s3_asset_sync/railtie.rb

@@ -0,0 +1,25 @@
+module S3AssetSync
+  class Railtie < Rails::Railtie
+    config.s3_asset_sync = ActiveSupport::OrderedOptions.new
+    
+    config.s3_asset_sync.run_after_precompile = true
+    config.s3_asset_sync.s3_bucket = "YOUR_BUCKET_NAME"
+    config.s3_asset_sync.endpoint = "YOUR_END_POINT"
+    config.s3_asset_sync.s3_access_key = "YOUR_ACCESS_KEY"
+    config.s3_asset_sync.s3_secret_access_key = "YOUR_SECRET_ACCESS_KEY"
+
+    rake_tasks do
+      load "tasks/s3_asset_sync.rake"
+      namespace :s3_asset_sync do
+        desc "Initialize S3AssetSync configuration."
+        task :setup do
+          abort("Already found config file. Have you already run this task?.") if File.exist?("config/initializers/s3_asset_sync.rb")
+
+          cp(
+            File.expand_path("../../../templates/s3_asset_sync.rb", __FILE__), "config/initializers/s3_asset_sync.rb"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/s3_asset_sync/version.rb

@@ -0,0 +1,3 @@
+module S3AssetSync
+  VERSION = "0.1.1"
+end

data/lib/tasks/s3_asset_sync.rake

@@ -0,0 +1,19 @@
+namespace :assets do
+
+  desc 'Synchronize all compiled assets to Amazon S3'
+  task :sync_to_s3 => :environment do
+    S3AssetSync.sync
+  end
+
+  desc 'Remove any expired assets stored on Amazon S3'
+  task :purge_s3 => :environment do
+    S3AssetSync.purge
+  end
+
+end
+
+if Rake::Task.task_defined?("assets:precompile")
+  Rake::Task["assets:precompile"].enhance do
+    Rake::Task["assets:sync_to_s3"].invoke if defined?(Rails) && Rails.application.config.s3_asset_sync.run_after_precompile
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: s3_asset_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Neil Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Simple way to syncronise your Rails 4 assets with an AWS S3 Bucket.
+email:
+- neil@neilturner.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/s3_asset_sync.rb
+- lib/s3_asset_sync/railtie.rb
+- lib/s3_asset_sync/version.rb
+- lib/tasks/s3_asset_sync.rake
+homepage: https://github.com/neilturner77/s3_asset_sync
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple way to syncronise your Rails 4 assets with an AWS S3 Bucket.
+test_files: []