s3_assets_uploader 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 11e410f5838a7cabe8b6667af204ec5cc8046d8a
-  data.tar.gz: 72dc8d9467ad12d6d9bc8fdc7f9e629ad22e2bd8
+SHA256:
+  metadata.gz: 4ef7284ec8a4e6f67ef449bd755accb7f66409512f856eb6c99056320167f528
+  data.tar.gz: 36ba9f6e43677cea5b177fc1584ce0bdaf171c6a3347508bfcd6b0f350aef2d3
 SHA512:
-  metadata.gz: 41ce122ce3f3ca8e8741918c284d9348d97994b87927b6b3800dbef255aeaf7a1c605da07e574558c2c8c4047477b976a966b5946d2c6eee97c04fa60baa28bb
-  data.tar.gz: 77ea586239f6b7c3168a50982200af7ef013133dbc38020eb8f945339d7b46c16a0d298bff70a6082fda073dba5117f032006c4442b78bd22ed3a6a6cd573b18
+  metadata.gz: 7288f6c0a161604163656568303961e425d38a66e8a686019db4cbadf24c1f96197084db96a8c68b6901ab420a0eb8ad8fb141a754f7ce563497c3a190ab58fc
+  data.tar.gz: 0f5a3f7226a34edb70e95f0fca1e283496d82aedf76801136f3d6da0d786c6b656414ad07033201b8399b0f37f812c7e887d80b39df7b66bd965567c5c9a4454

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1
   - 2.2
+  - 2.3
+  - 2.4
   - ruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,2 +1,19 @@
+# 0.5.0
+- Add `config.content_type` option
+
+# 0.4.0
+- Use aws-sdk v3
+
+# 0.3.0
+- Add `config.cache_control` option
+    - The default value is `max-age=2592000, public` .
+
+# 0.2.0
+- Now Content-Type is automatically specified from asset's filename.
+    - https://github.com/eagletmt/s3_assets_uploader/pull/2
+
+# 0.1.1
+- Add `config.additional_paths`
+
 # 0.1.0
 - Initial release

data/README.md

@@ -1,4 +1,6 @@
 # S3AssetsUploader
+[![Gem Version](https://badge.fury.io/rb/s3_assets_uploader.svg)](http://badge.fury.io/rb/s3_assets_uploader)
+[![Build Status](https://travis-ci.org/eagletmt/s3_assets_uploader.svg?branch=master)](https://travis-ci.org/eagletmt/s3_assets_uploader)
 
 Upload Rails assets to S3.
 
@@ -32,6 +34,31 @@ namespace :assets do
 end
 ```
 
+### Configurations
+- `config.s3_client`
+    - Aws::S3::Client instance to upload files
+    - Default: `Aws::S3::Client.new`
+- `config.bucket`
+    - S3 bucket name
+    - **Required**
+- `config.assets_path`
+    - Local path to assets directory
+    - Default: `"public/assets"`
+- `config.assets_prefix`
+    - Remote assets path prefix
+    - If set, public/assets/foo.png will be uploaded to `"#{assets_prefix}/assets/foo.png"`
+    - Default: `nil`
+- `config.additional_paths`
+    - Additional directories to upload
+    - Default: `[]`
+- `config.cache_control`
+    - cache_control option for S3
+    - Default: `"max-age=2592000, public"`
+- `config.content_type`
+    - Set custom handler to determine content-type of the object
+    - When the handler returns nil, the content-type is guessed from its extension
+    - Default: `nil`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/s3_assets_uploader/config.rb

@@ -1,14 +1,18 @@
-require 'aws-sdk'
+require 'aws-sdk-s3'
 
 module S3AssetsUploader
-  class Config < Struct.new(:s3_client, :bucket, :assets_path, :assets_prefix)
+  class Config < Struct.new(:s3_client, :bucket, :assets_path, :assets_prefix, :additional_paths, :cache_control, :content_type)
     class ValidationError < StandardError
     end
 
     DEFAULT_ASSETS_PATH = 'public/assets'.freeze
+    DEFAULT_CACHE_CONTROL = 'max-age=2592000, public'
 
     def initialize
       self.assets_path = DEFAULT_ASSETS_PATH
+      self.cache_control = DEFAULT_CACHE_CONTROL
+      self.additional_paths = []
+      self.content_type = nil
     end
 
     def assets_path
@@ -23,14 +27,34 @@ module S3AssetsUploader
       if bucket.nil?
         raise ValidationError.new('config.bucket must be set')
       end
+      additional_paths.each do |path|
+        assert_under_public_path!(path)
+      end
       self.s3_client ||= create_default_client
       true
     end
 
+    def content_type(&block)
+      self[:content_type] = block
+    end
+
+    def guess_content_type(path)
+      return unless self[:content_type]
+
+      self[:content_type].call(path)
+    end
+
     private
 
     def create_default_client
       Aws::S3::Client.new
     end
+
+    def assert_under_public_path!(path)
+      if Pathname.new(path).relative_path_from(public_path).to_s.start_with?('../')
+        raise ValidationError.new("#{path} must be under #{public_path}")
+      end
+      true
+    end
   end
 end

data/lib/s3_assets_uploader/uploader.rb

@@ -1,4 +1,5 @@
 require 's3_assets_uploader/config'
+require 'mime/types'
 
 module S3AssetsUploader
   class Uploader
@@ -10,6 +11,9 @@ module S3AssetsUploader
 
     def upload
       upload_path(@config.assets_path)
+      @config.additional_paths.each do |path|
+        upload_path(Pathname.new(path))
+      end
     end
 
     private
@@ -25,6 +29,8 @@ module S3AssetsUploader
             body: f,
             bucket: @config.bucket,
             key: compute_asset_key(path),
+            content_type: guess_content_type(path),
+            cache_control: @config.cache_control,
           )
         end
       end
@@ -38,6 +44,18 @@ module S3AssetsUploader
       end
     end
 
+    def guess_content_type(path)
+      content_type = @config.guess_content_type(path)
+      return content_type if content_type
+
+      mime_type = MIME::Types.type_for(path.basename.to_s).first
+      if mime_type
+        mime_type.content_type
+      else
+        'application/octet-stream'
+      end
+    end
+
     def relative_path(path)
       path.relative_path_from(@config.public_path)
     end

data/lib/s3_assets_uploader/version.rb

@@ -1,3 +1,3 @@
 module S3AssetsUploader
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

data/s3_assets_uploader.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "aws-sdk", ">= 2.0"
+  spec.add_dependency "aws-sdk-s3", ">= 1.0"
+  spec.add_dependency "mime-types"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 3.0"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: s3_assets_uploader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kohei Suzuki
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +107,7 @@ homepage: https://github.com/eagletmt/s3_assets_uploader
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.13
+signing_key:
 specification_version: 4
 summary: Upload Rails assets to S3.
 test_files: []