webpacker_uploader 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbdb29fdfafeddb7feb884a38b52e8805a42551a9d6562a74b011b9673926cd1
-  data.tar.gz: 925e5c75c02b4b227b243a2a016de589e18b9072421ff20f4cc632a72834a74e
+  metadata.gz: 613e7597be0786ab1a3acf5d460eafeb42d1b94816250c64f36e38c13d2f9138
+  data.tar.gz: '01864d7e0ce27b5ca6030bb52383255c9af63789b006c8a8a199c9e78b17b380'
 SHA512:
-  metadata.gz: d5ac3ffbf041da9ec25dbc52e7dd8c6e63ee501a5a3eff6355efbf37124089d29c4ba6720b88310b5e083749aea1ac7c8be1a9c5692fb0eecfa6931a202cc8d5
-  data.tar.gz: 9d16ddae2c7ca1efcbc0f1f4dbb4c5002c0b28281f652ff92e2a0bc28d849c7bb9828ee9e26121c157cdcc9d0221c78983d8c093865da35cacfe2433b9bcc30f
+  metadata.gz: 9d6d102186314e943265aeaad56830c9b0404f52490640ab6e735c2a68b6923bc96b71cf24aeaf00c7d878fc7aebe07ee1f8c997965dfe0176fab12fc0cfd4f2
+  data.tar.gz: 1d22a604f388a94944504a5552f3b3928acf62b23ed21fc0b0570388fee1526c7bb12ac5ebacc0ce12b81ed5ed409ae59d41738b5fe9a99729c3d8061daee25c

data/.github/workflows/ruby.yml

@@ -16,7 +16,8 @@ jobs:
         ruby: [
             2.5,
             2.6,
-            2.7
+            2.7,
+            3.0
         ]
     steps:
       - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,13 +1,10 @@
 require: rubocop-performance
+
 AllCops:
   TargetRubyVersion: 2.5
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true
-  Exclude:
-    - 'lib/install/templates/**'
-    - 'vendor/**/*'
-    - 'node_modules/**/*'
 
 # Prefer &&/|| over and/or.
 Style/AndOr:

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased]
+
+## [[0.2.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.2.0) - 2021-02-09
+
+### Added
+
+- Make file exclusion list configurable. ([#3](https://github.com/tlatsas/webpacker_uploader/pull/3), [@estebanz01](https://github.com/estebanz01))
+- Support prefixing remote S3 paths. ([#2](https://github.com/tlatsas/webpacker_uploader/pull/2), [@estebanz01](https://github.com/estebanz01))
+- AWS provider: Add support for EC2 instance profile credentials. ([#2](https://github.com/tlatsas/webpacker_uploader/pull/2), [@estebanz01](https://github.com/estebanz01))
+
+## [[0.1.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.1.0) - 2020-10-01
+
+### Added
+
+- Initial release. ([@tlatsas](https://github.com/tlatsas))

data/Gemfile.lock

@@ -59,13 +59,15 @@ GEM
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.5.0)
     minitest (5.14.2)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
+    racc (1.5.2)
     rack (2.2.3)
     rack-proxy (0.6.5)
       rack

data/README.md

@@ -1,5 +1,9 @@
 # WebpackerUploader
 
+[![Ruby tests](https://img.shields.io/github/workflow/status/tlatsas/webpacker_uploader/Ruby%20tests?style=flat-square)](https://github.com/tlatsas/webpacker_uploader/actions)
+[![RuboCop](https://img.shields.io/github/workflow/status/tlatsas/webpacker_uploader/RuboCop?label=rubocop&style=flat-square)](https://github.com/tlatsas/webpacker_uploader/actions)
+[![Gem](https://img.shields.io/gem/v/webpacker_uploader?style=flat-square)](https://rubygems.org/gems/webpacker_uploader)
+
 Webpacker uploader provides an easy way to upload your assets to AWS S3.
 It knows which files to upload by reading the `manifest.json` file.
 
@@ -31,19 +35,83 @@ gem "aws-sdk-s3", require: false
 ## Usage
 
 ```ruby
-    require 'webpacker_uploader'
-    require 'webpacker_uploader/providers/aws'
+require "webpacker_uploader"
+require "webpacker_uploader/providers/aws"
+
+provider_options = {
+  credentials: { profile_name: "staging" },
+  region: "eu-central-1",
+  bucket: "application-assets-20200929124523451600000001"
+}
+
+provider = WebpackerUploader::Providers::Aws.new(provider_options)
+WebpackerUploader.upload!(provider)
+```
 
-    provider_options = {
-      credentials: { profile_name: "staging" },
-      region: "eu-central-1",
-      bucket: "application-assets-20200929124523451600000001"
-    }
+Currently, the only provider implemented is the AWS S3 provider.
+
+### AWS S3 provider
+
+The AWS S3 provider credentials can be configured in three ways.
+Passing a named profile name:
+
+```ruby
+provider_options = {
+  credentials: { profile_name: "staging" },
+  region: "eu-central-1",
+  bucket: "application-assets-20200929124523451600000001"
+}
 
-    provider = WebpackerUploader::Providers::Aws.new(provider_options)
-    WebpackerUploader.upload!(provider)
+provider = WebpackerUploader::Providers::Aws.new(provider_options)
 ```
 
+passing the access and the secret keys directly:
+
+```ruby
+provider_options = {
+  credentials: { access_key_id: "AKIAIOSFODNN7EXAMPLE", secret_access_key: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY" },
+  region: "eu-central-1",
+  bucket: "application-assets-20200929124523451600000001"
+}
+
+provider = WebpackerUploader::Providers::Aws.new(provider_options)
+```
+
+or using an EC2 instance profile:
+
+```ruby
+provider_options = {
+  credentials: { instance_profile: true },
+  region: "eu-central-1",
+  bucket: "application-assets-20200929124523451600000001"
+}
+
+provider = WebpackerUploader::Providers::Aws.new(provider_options)
+```
+
+### Ignore files
+
+The uploader can be configured to skip certain files based on the file extension.
+By default `.map` files are excluded. This can be configured through the `ignored_extensions` attribute.
+In order to upload everything pass an empty array.
+
+```ruby
+# skip uploading images
+WebpackerUploader.ignored_extensions = [".png", ".jpg", ".webp"]
+WebpackerUploader.upload!(provider)
+```
+
+### Prefix remote files
+
+Uploaded files can be prefixed by setting the `prefix` parameter during upload:
+
+```ruby
+WebpackerUploader.upload!(provider, prefix: "assets")
+```
+
+This will prefix all remote file paths with `assets` so instead of storing `packs/application-dd6b1cd38bfa093df600.css` it
+will store `assets/packs/application-dd6b1cd38bfa093df600.css`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/webpacker_uploader.rb

@@ -15,9 +15,10 @@ module WebpackerUploader
     @instance ||= WebpackerUploader::Instance.new
   end
 
-  delegate :logger, :logger=, :upload!, to: :instance
+  delegate :logger, :logger=, :upload!, :ignored_extensions, :ignored_extensions=, to: :instance
 end
 
 require "webpacker_uploader/instance"
 require "webpacker_uploader/manifest"
+require "webpacker_uploader/mime"
 require "webpacker_uploader/version"

data/lib/webpacker_uploader/instance.rb

@@ -1,36 +1,38 @@
 # frozen_string_literal: true
 
-require "mime-types"
-
 class WebpackerUploader::Instance
-  # TODO make this configurable
-  IGNORE_EXTENSION = %w[.map].freeze
-  public_constant :IGNORE_EXTENSION
-
   cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
+  cattr_accessor(:ignored_extensions) { %w[.map] }
 
   def manifest
     @manifest ||= WebpackerUploader::Manifest.new
   end
 
-  def upload!(provider)
-    manifest.assets.each do |name, path|
-      path = path[1..-1]
+  def upload!(provider, prefix: nil)
+    if ignored_extensions.nil?
+      raise ArgumentError, "Ignored extensions should be specified as an array"
+    end
+
+    manifest.assets.each do |name, js_path|
+      path = js_path[1..-1]
+
+      remote_path =
+        if prefix.nil?
+          path
+        else
+          "#{prefix}/#{path}"
+        end
+
       file_path = Rails.root.join("public", path)
 
-      if name.end_with?(*IGNORE_EXTENSION)
-        logger.info("Skipping: #{file_path}")
+      if name.end_with?(*ignored_extensions)
+        logger.info("Skipping #{file_path}")
       else
-        logger.info("Processing: #{file_path}")
-        provider.upload!(path, file_path, content_type_for(path)) unless name.end_with?(*IGNORE_EXTENSION)
+        content_type = WebpackerUploader::Mime.mime_type(path)
+        logger.info("Processing #{file_path} as #{content_type}")
+
+        provider.upload!(remote_path, file_path, content_type)
       end
     end
   end
-
-  private
-
-    def content_type_for(file)
-      fallback = MIME::Types.type_for(file).first.content_type
-      Rack::Mime.mime_type(File.extname(file), fallback)
-    end
 end

data/lib/webpacker_uploader/mime.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "mime-types"
+
+module WebpackerUploader::Mime
+  def mime_type(file_path)
+    fallback = MIME::Types.type_for(file_path).first&.content_type || "application/octet-stream"
+    Rack::Mime.mime_type(File.extname(file_path), fallback)
+  end
+  module_function :mime_type
+end

data/lib/webpacker_uploader/providers/aws.rb

@@ -25,6 +25,8 @@ module WebpackerUploader
         def credentials(options)
           if options[:profile_name].present?
             ::Aws::SharedCredentials.new(profile_name: options[:profile_name])
+          elsif options.key?(:instance_profile) && options[:instance_profile]
+            ::Aws::InstanceProfileCredentials.new
           else
             ::Aws::Credentials.new(options[:access_key_id], options[:secret_access_key])
           end

data/lib/webpacker_uploader/version.rb

@@ -1,3 +1,3 @@
 module WebpackerUploader
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpacker_uploader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tasos Latsas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webpacker
@@ -91,6 +91,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
@@ -102,6 +103,7 @@ files:
 - lib/webpacker_uploader.rb
 - lib/webpacker_uploader/instance.rb
 - lib/webpacker_uploader/manifest.rb
+- lib/webpacker_uploader/mime.rb
 - lib/webpacker_uploader/providers/aws.rb
 - lib/webpacker_uploader/version.rb
 - webpacker_uploader.gemspec
@@ -110,7 +112,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/tlatsas/webpacker_uploader
-  source_code_uri: https://github.com/tlatsas/webpacker_uploader/tree/v0.1.0
+  source_code_uri: https://github.com/tlatsas/webpacker_uploader/tree/v0.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -126,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Uploads manifest.json file contents to the cloud