asset_sync_download 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3334ffeade3da3f403e52a77ce20da4c3f183059
+  data.tar.gz: 4ffafc0740a19877373c6386582288f83a048294
+SHA512:
+  metadata.gz: 4ec425830d65c12ee0908b698829926e6c75d11883c96d74d142e982236f805e62cb6f162b2bb3adb7a754a5bc0c0244e6189ce9e712be7f39ef9adee3e9784b
+  data.tar.gz: 22312a68da1c00d29ed9f035f65773d181a67dac256543946797fea33da698e83322a406323587f00288ebbdc76944ed0d3035cdc7646e3cd1d531aed896b00c

data/.envrc.sample

@@ -0,0 +1,5 @@
+export FOG_PROVIDER=AzureRM
+export FOG_DIRECTORY=xxx
+export FOG_REGION=japanwest
+export AZURE_STORAGE_ACCOUNT_NAME="yyy"
+export AZURE_STORAGE_ACCESS_KEY="zzzzzzzzzzzzzzzzzzzzzz"

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/
+/spec/dummy_app*/public/*
+/spec/dummy_app*/log/*
+/spec/dummy_app*/tmp/*
+.envrc
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Appraisals

@@ -0,0 +1,16 @@
+
+appraise "rails_4_1" do
+  gem "rails", "~> 4.1.0"
+end
+
+appraise "rails_4_2" do
+  gem "rails", "~> 4.2.0"
+end
+
+appraise "rails_5_0" do
+  gem "rails", "~> 5.0.0"
+end
+
+appraise "rails_5_1" do
+  gem "rails", "~> 5.1.0"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asset_sync_download.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daisuke TASAKI
+
+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.md

@@ -0,0 +1,99 @@
+# AssetSyncDownload
+
+Downloads asset files to Rails applications from a cloud storage, such as AWS S3 and AzureBlob, synchronized with AssetSync gem.
+
+It enables you to distribute a manifest file and asset files to load-balanced redundant servers without commiting these files to your repository.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asset_sync'
+gem 'asset_sync_download'
+```
+
+AssetSyncDownload depends on AssetSync gem deeply.
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asset_sync_download
+
+## Usage
+
+AssetSyncDownload supposes deployment operations as belows:
+
+1. Run `assets:precompile` rake task on your local PC. You should configure AssetSync to upload a manifest file not only asset files.
+2. Deploy rails application to servers. Do not start or restart them.
+3. Run `assets:sync:download` rake task on the servers. It will download the manifest file and asset files.
+4. Restart the rails applications.
+
+### Rake Tasks
+
+* `rake assets:sync:download:manifest` downloads manifest file.
+* `rake assets:sync:download:asset_files` downloads all asset files on a cloud storage.
+    * If you configure AssetSync as `config.manifest = true`, you get only asset files mentioned in the manifest file.
+
+## Configuration
+
+### AssetSyncDownload
+
+AssetSync has no configurations, but it requires well-configured AssetSync such as `config.fog_provider`, `config.aws_access_key_id` and `config.aws_secret_access_key`.
+
+### AssetSync
+
+Configure **config/environments/production.rb** to use AWS S3 as below. (please refer to documents of AssetSync gem for more information.)
+
+```ruby
+if defined?(AssetSync)
+  AssetSync.configure do |config|
+    config.fog_provider = 'AWS'
+    config.aws_access_key_id     = ENV['AWS_ACCESS_KEY_ID']
+    config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+
+    config.manifest = true
+  end
+end
+```
+
+`config.manifest` is an option which enables to use the manifest file to get the list of local files to upload. **AssetSyncDownload** also refers to the option to get the list of remote files to download.
+
+To enable uploading a manifest file to a cloud storage, you should configure **AssetSync** with **config/initializers/asset_sync.rb** as below:
+
+```ruby
+if defined?(AssetSync)
+  AssetSync.configure do |config|
+    ...
+    config.add_local_file_paths do
+      if ActionView::Base.respond_to?(:assets_manifest)
+        manifest = Sprockets::Manifest.new(ActionView::Base.assets_manifest.environment, ActionView::Base.assets_manifest.dir)
+        manifest_path = manifest.filename
+      else
+        manifest_path = self.config.manifest_path
+      end
+      [manifest_path.sub(/^#{config.public_path}\//, "")] # full path to relative path
+    end
+  end
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/devchick/asset_sync_download.
+
+
+## Credits
+
+Inspired by:
+
+ - [AssetSync gem](https://github.com/AssetSync/asset_sync)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/asset_sync_download.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asset_sync_download/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asset_sync_download"
+  spec.version       = AssetSyncDownload::VERSION
+  spec.authors       = ["Daisuke TASAKI"]
+  spec.email         = ["tasaki@i3-systems.com"]
+
+  spec.summary       = %q{Downloads asset files to Rails applications from a cloud storage, such as AWS S3 and AzureBlob, synchronised with AssetSync gem}
+  spec.description   = %q{It enables you to distribute a manifest file and asset files to load-balanced redundant servers without commiting these files to your repository.}
+  spec.homepage      = "https://github.com/devchick/asset_sync_download"
+  spec.license       = "MIT"
+
+  spec.rubyforge_project = "asset_sync_download"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'asset_sync', '~> 2.3'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "actionpack"
+  spec.add_development_dependency "actionview"
+  spec.add_development_dependency "sprockets"
+  spec.add_development_dependency "uglifier"
+  spec.add_development_dependency "fog-aws"
+  spec.add_development_dependency "fog-azure-rm"
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "systemu"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "asset_sync_download"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+
+gemspec path: "../"

data/lib/asset_sync_download.rb

@@ -0,0 +1,7 @@
+require "asset_sync"
+require "asset_sync_download/asset_sync_download"
+require "asset_sync_download/storage"
+require "asset_sync_download/version"
+
+require "asset_sync_download/railtie" if defined?(Rails)
+require "asset_sync_download/engine"  if defined?(Rails)

data/lib/asset_sync_download/asset_sync_download.rb

@@ -0,0 +1,15 @@
+module AssetSyncDownload
+  class << self
+
+    def storage
+      @storage ||= Storage.new
+    end
+
+    def download(target = :asset_files)
+      AssetSync.with_config do
+        self.storage.download(target)
+      end
+    end
+
+  end
+end

data/lib/asset_sync_download/engine.rb

@@ -0,0 +1,10 @@
+module AssetSyncDownload
+  class Engine < Rails::Engine
+
+    engine_name "asset_sync_download"
+
+    initializer "asset_sync_download config", :group => :all do |app|
+    end
+
+  end
+end

data/lib/asset_sync_download/railtie.rb

@@ -0,0 +1,5 @@
+class Rails::Railtie::Configuration
+  def asset_sync_download
+    AssetSyncDownload.config
+  end
+end

data/lib/asset_sync_download/storage.rb

@@ -0,0 +1,95 @@
+module AssetSyncDownload
+  class Storage
+    extend Forwardable
+
+    def_delegator :storage, :bucket
+    def_delegator :storage, :config
+    def_delegator :storage, :get_remote_files
+    def_delegator :storage, :log
+    def_delegator :storage, :path
+
+    def storage
+      @storage ||= AssetSync.storage
+    end
+
+    def get_asset_files_from_manifest
+      if storage.respond_to?(:get_asset_files_from_manifest)
+        return storage.get_asset_files_from_manifest
+      end
+
+      if self.config.manifest
+        if ActionView::Base.respond_to?(:assets_manifest)
+          log "Using: Rails 4.0 manifest access"
+          manifest = Sprockets::Manifest.new(ActionView::Base.assets_manifest.environment, ActionView::Base.assets_manifest.dir)
+          return manifest.assets.values.map { |f| File.join(self.config.assets_prefix, f) }
+        elsif File.exist?(self.config.manifest_path)
+          log "Using: Manifest #{self.config.manifest_path}"
+          yml = YAML.load(IO.read(self.config.manifest_path))
+
+          return yml.map do |original, compiled|
+            # Upload font originals and compiled
+            if original =~ /^.+(eot|svg|ttf|woff)$/
+              [original, compiled]
+            else
+              compiled
+            end
+          end.flatten.map { |f| File.join(self.config.assets_prefix, f) }.uniq!
+        else
+          log "Warning: Manifest could not be found"
+        end
+      end
+    end
+
+    def download_manifest
+      return unless defined?(Sprockets::ManifestUtils)
+
+      files = get_remote_files
+      manifest_key   = files.find { |f| File.basename(f) =~ Sprockets::ManifestUtils::MANIFEST_RE }
+      manifest_key ||= files.find { |f| File.basename(f) =~ Sprockets::ManifestUtils::LEGACY_MANIFEST_RE }
+      raise "Could not find any manifests. aborted." if manifest_key.nil?
+
+      manifest = bucket.files.get(manifest_key)
+      log "Downloaded: #{manifest_key} (#{manifest.content_length} Bytes)"
+
+      manifest_path = File.join(path, manifest_key)
+      local_dir = File.dirname(manifest_path)
+      FileUtils.mkdir_p(local_dir) unless File.directory?(local_dir)
+      File.open(manifest_path, "wb") { |f| f.write(manifest.body) }
+    end
+
+    def download_asset_files
+      asset_paths = get_asset_files_from_manifest
+      if asset_paths.nil?
+        log "Using: Remote Directory Search"
+        asset_paths = get_remote_files
+      end
+
+      asset_paths.each do |asset_path|
+        local_path = File.join(path, asset_path)
+        if File.exists?(local_path)
+          log "Skipped: #{asset_path}"
+          next
+        end
+
+        file = bucket.files.get(asset_path)
+        log "Downloaded: #{asset_path} (#{file.content_length} Bytes)"
+        local_dir = File.dirname(local_path)
+        FileUtils.mkdir_p(local_dir) unless File.directory?(local_dir)
+        File.open(local_path, "wb") { |f| f.write(file.body) }
+      end
+    end
+
+    def download(target = :asset_files)
+      log "AssetSync: Downloading #{target}."
+      case target
+      when :manifest
+        download_manifest
+      when :asset_files
+        download_asset_files
+      else
+        raise "Unknown target specified: #{target}. It must be :manifest or :asset_files."
+      end
+      log "AssetSync: Done."
+    end
+  end
+end

data/lib/asset_sync_download/version.rb

@@ -0,0 +1,3 @@
+module AssetSyncDownload
+  VERSION = "0.1.2"
+end

data/lib/tasks/asset_sync_download.rake

@@ -0,0 +1,25 @@
+namespace :assets do
+  namespace :sync do
+
+    desc "Download a manifest and asset files"
+    task :download => :environment do
+      Rake::Task["assets:sync:download:manifest"].invoke
+      Rake::Task["assets:sync:download:asset_files"].invoke
+    end
+
+    namespace :download do
+
+      desc "Download a manifest"
+      task :manifest => :environment do
+        AssetSyncDownload.download(:manifest)
+      end
+
+      desc "Download asset files"
+      task :asset_files => :environment do
+        AssetSyncDownload.download(:asset_files)
+      end
+
+    end
+  end
+
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: asset_sync_download
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Daisuke TASAKI
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asset_sync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog-aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog-azure-rm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: systemu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It enables you to distribute a manifest file and asset files to load-balanced
+  redundant servers without commiting these files to your repository.
+email:
+- tasaki@i3-systems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc.sample"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asset_sync_download.gemspec
+- bin/console
+- bin/setup
+- gemfiles/rails_4_1.gemfile
+- gemfiles/rails_4_2.gemfile
+- gemfiles/rails_5_0.gemfile
+- gemfiles/rails_5_1.gemfile
+- lib/asset_sync_download.rb
+- lib/asset_sync_download/asset_sync_download.rb
+- lib/asset_sync_download/engine.rb
+- lib/asset_sync_download/railtie.rb
+- lib/asset_sync_download/storage.rb
+- lib/asset_sync_download/version.rb
+- lib/tasks/asset_sync_download.rake
+homepage: https://github.com/devchick/asset_sync_download
+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: asset_sync_download
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Downloads asset files to Rails applications from a cloud storage, such as
+  AWS S3 and AzureBlob, synchronised with AssetSync gem
+test_files: []