s3_assets_deployer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fafda75c54f7eef90f941621ff314b1c5f0c97d
+  data.tar.gz: b0cccf43185b224e75abac884401b5b51958500a
+SHA512:
+  metadata.gz: f9afc73012333151eb5d3946ecc8ece9fa443dd018d388c9b8d848873db8e766aba3ffb531be164f24fb34153f8b3f9137bf30119620ce5d7cfe47144864f58a
+  data.tar.gz: 6eccc3c128d58294936cc8de53c3126e8c4da76f8689d320fc12bbb87671eef593dc9791c2d26bb6d642ccd90d0b9b60aa892453f671c2b0ffa91fa1676846d5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Shota Iguchi
+
+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,47 @@
+# S3AssetsDeployer
+Asset files deployer for rails application.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_assets_deployer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install s3_assets_deployer
+```
+
+## Usage
+
+### Rails
+Add initializer at `config/iniitializers/s3_assets_deployer.rb`
+```rb
+AssetsDeployer.configure do |config|
+  config.assets.root_path   = Rails.root.join('public')
+  config.assets.prefix_paths = ['assets', 'packs']
+  config.assets.ignore_paths = ['packs/manifest.json']
+  # your storage service configurations
+  config.s3.region     = 'ap-northeast-1'
+  config.s3.bucket     = 'bucket_name'
+  config.s3.prefix_key = 'project_name'
+  # credentials
+  # Also, you can use environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY) or instance profile credentials
+  config.s3.credentials[:access_key_id]     = 'aws_access_key_id'
+  config.s3.credentials[:secret_access_key] = 'aws_secret_access_key'
+end
+```
+
+then you can use this rails command
+```console
+$ bundle exec rails assets:precompile assets:deploy
+```
+
+## 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,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'

data/lib/s3_assets_deployer/asset_file.rb

@@ -0,0 +1,24 @@
+require 'mime/types'
+
+module S3AssetsDeployer
+  class AssetFile
+    attr_reader :prefix
+
+    def initialize(prefix, path)
+      @prefix = prefix
+      @path = path
+    end
+
+    def key
+      [prefix, File.basename(@path)].join('/')
+    end
+
+    def body
+      File.new(@path)
+    end
+
+    def content_type
+      MIME::Types.type_for(@path).first.to_s
+    end
+  end
+end

data/lib/s3_assets_deployer/aws_s3.rb

@@ -0,0 +1,56 @@
+require 'aws-sdk'
+
+module S3AssetsDeployer
+  class AwsS3
+    def initialize(credentials:, region: nil, bucket: nil, prefix_key: nil)
+      @credentials = credentials
+      @bucket = bucket
+      @prefix_key = prefix_key
+      @region = region
+    end
+
+    def upload(files)
+      files.each do |file|
+        client.put_object(
+          bucket: @bucket,
+          key: [@prefix_key, file.key].compact.join('/'),
+          body: file.body,
+          content_type: file.content_type
+        )
+      end
+    end
+
+    private
+
+    def client
+      @client ||= Aws::S3::Client.new(client_options)
+    end
+
+    def client_options
+      hash = {}
+      hash[:credentials] = credentials
+      hash[:region] = region if !region.nil? && !region.empty?
+      hash
+    end
+
+    def credentials
+      if access_key_id && secret_access_key
+        Aws::Credentials.new(access_key_id, secret_access_key)
+      else
+        Aws::InstanceProfileCredentials.new
+      end
+    end
+
+    def access_key_id
+      @credentials[:access_key_id] || ENV['AWS_ACCESS_KEY_ID']
+    end
+
+    def secret_access_key
+      @credentials[:secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
+    end
+
+    def region
+      @region || ENV['AWS_REGION']
+    end
+  end
+end

data/lib/s3_assets_deployer/configuration.rb

@@ -0,0 +1,27 @@
+module S3AssetsDeployer
+  class Configuration
+    attr_accessor :assets,
+                  :s3
+
+    class AssetsConfiguration < Struct.new(:root_path, :prefix_paths, :ignore_paths)
+      def initialize
+        self.prefix_paths = ['assets']
+        self.ignore_paths = []
+      end
+    end
+
+    class S3Configuration < Struct.new(:credentials, :bucket, :prefix_key, :region)
+      def initialize
+        self.credentials = {}
+      end
+    end
+
+    def assets
+      @assets ||= AssetsConfiguration.new
+    end
+
+    def s3
+      @s3 ||= S3Configuration.new
+    end
+  end
+end

data/lib/s3_assets_deployer/deployer.rb

@@ -0,0 +1,26 @@
+require 's3_assets_deployer/asset_file'
+
+module S3AssetsDeployer
+  class Deployer
+    def initialize(storage:, root_path:, prefix_paths:, ignore_paths:)
+      @storage = storage
+      @root_path = root_path
+      @prefix_paths = prefix_paths
+      @ignore_paths = ignore_paths.map { |path| File.join(root_path, path) }
+    end
+
+    def run
+      @storage.upload(files)
+    end
+
+    private
+
+    def files
+      @files ||= @prefix_paths.flat_map do |prefix|
+        Dir.glob(@root_path.join(prefix).join('**', '**')).map do |path|
+          AssetFile.new(prefix, path) if Pathname.new(path).file? && !@ignore_paths.include?(path)
+        end
+      end.compact
+    end
+  end
+end

data/lib/s3_assets_deployer/engine.rb

@@ -0,0 +1,5 @@
+module S3AssetsDeployer
+  class Engine < Rails::Engine
+    engine_name 's3_assets_deployer'
+  end
+end

data/lib/s3_assets_deployer/version.rb

@@ -0,0 +1,3 @@
+module S3AssetsDeployer
+  VERSION = '0.1.0'
+end

data/lib/s3_assets_deployer.rb

@@ -0,0 +1,35 @@
+require 's3_assets_deployer/deployer'
+require 's3_assets_deployer/configuration'
+require 's3_assets_deployer/aws_s3'
+
+module S3AssetsDeployer
+  def self.run
+    deployer = Deployer.new(
+      storage: s3,
+      root_path: config.assets.root_path,
+      prefix_paths: config.assets.prefix_paths,
+      ignore_paths: config.assets.ignore_paths
+    )
+
+    deployer.run
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.s3
+    @s3 ||= AwsS3.new(
+      credentials: config.s3.credentials,
+      bucket: config.s3.bucket,
+      prefix_key: config.s3.prefix_key,
+      region: config.s3.region
+    )
+  end
+end
+
+require 's3_assets_deployer/engine' if defined?(Rails)

data/lib/tasks/assets.rake

@@ -0,0 +1,5 @@
+namespace :assets do
+  task deploy: :environment do
+    S3AssetsDeployer.run
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: s3_assets_deployer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shota Iguchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: aws-sdk
+  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: 
+email:
+- shota-iguchi@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/s3_assets_deployer.rb
+- lib/s3_assets_deployer/asset_file.rb
+- lib/s3_assets_deployer/aws_s3.rb
+- lib/s3_assets_deployer/configuration.rb
+- lib/s3_assets_deployer/deployer.rb
+- lib/s3_assets_deployer/engine.rb
+- lib/s3_assets_deployer/version.rb
+- lib/tasks/assets.rake
+homepage: 
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Rails assets deployer
+test_files: []