webpacker_uploader 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b7937b7a57c7be6ea442c7d321feb36005dab87386227ad7f9bdbd262dbe838
-  data.tar.gz: abd3a34e04a85979607905611e354bbddaa6aa1c8059ed945e28bd5ed5bb7b13
+  metadata.gz: b1f1e410b9ed124323d818d4b436581aecd735717f47176bf9754091209e608d
+  data.tar.gz: e8732c0cab079cf51864b1addd8a3e8d94c1487fa371872213f5343f2473de03
 SHA512:
-  metadata.gz: b61d0ab52871ad4700df2ce3a79ad89d7aed913073aaba4370c580878d3dfc556c6f4a52332fde1b63430e7d9aea253e6bb07ac8fff14be2c295d835f560a40e
-  data.tar.gz: d41c5bb9716983ca88c6d3f8be8e93961b8cff4c57ffe635f2a9ef299fc0577856734d5da015e8a5e7232f2eb3ea98922989f535e202be283522ab2ec0494a64
+  metadata.gz: 0c52c1f98939ca6338579e23fbe186fadfa1b22204bf62ceaffdb3ec4e2387c2f0763330a0db7cfcbc898e7a77035719749458b5828a0d5b7ba3b3b78ecde8e0
+  data.tar.gz: 2dde591f7f50548ad64a14f401b325aa3a4e83566c78463602406a458d6d6bc331843ab188fd7142c8be616722671574bf43ec36d0d0dcc9155f9253bdc61c84

data/.gitignore

@@ -9,3 +9,4 @@
 .ruby-version
 *.gem
 /test/test_app/log/
+/integration/dummy/log/

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+## [[0.6.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.6.0) - 2021-07-20
+
+### Added
+
+- Allow passing arbitrary options to the AWS S3 Client through the AWS provider. ([#11](https://github.com/tlatsas/webpacker_uploader/pull/11), [@tlatsas](https://github.com/tlatsas))
+
+### Fixed
+
+- Fix undefined method delegate for WebpackerUploader:Module when using the console script. ([#13](https://github.com/tlatsas/webpacker_uploader/pull/13), [@tlatsas](https://github.com/tlatsas))
+
 ## [[0.5.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.5.0) - 2021-07-12
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webpacker_uploader (0.5.0)
+    webpacker_uploader (0.6.0)
       mime-types
       rack (~> 2.0)
       webpacker (>= 5.1)
@@ -29,21 +29,21 @@ GEM
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    aws-eventstream (1.1.0)
-    aws-partitions (1.376.0)
-    aws-sdk-core (3.108.0)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.477.0)
+    aws-sdk-core (3.117.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.38.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-kms (1.44.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.81.1)
-      aws-sdk-core (~> 3, >= 3.104.3)
+    aws-sdk-s3 (1.96.1)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.2.2)
+    aws-sigv4 (1.2.4)
       aws-eventstream (~> 1, >= 1.0.2)
     builder (3.2.4)
     concurrent-ruby (1.1.9)
@@ -58,9 +58,11 @@ GEM
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    mime-types-data (3.2021.0704)
+    mini_portile2 (2.5.3)
     minitest (5.14.2)
-    nokogiri (1.11.7-x86_64-darwin)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.0.0)

data/README.md

@@ -3,6 +3,7 @@
 [![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)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg?style=flat-square)](https://www.rubydoc.info/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.
@@ -147,6 +148,19 @@ interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+## Integration tests
+
+This gem also provides an integration test suite. It runs using [localstack](https://github.com/localstack/localstack/).
+To run the integration tests, install docker on your system and spin up a localstack container running the s3 service.
+
+```shell
+docker compose -f "integration/docker-compose.yml" up --detach
+```
+
+To run the tests, use `rake test:integration`.
+
+To stop the container once done run: `docker-compose -f "integration/docker-compose.yml" down` 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tlatsas/webpacker_uploader.

data/Rakefile

@@ -12,4 +12,12 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+namespace :test do
+  desc "Run integration tests using localstack"
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << "integration"
+    t.test_files = FileList["integration/**/*_test.rb"]
+  end
+end
+
 task default: :test

data/lib/webpacker_uploader.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/module"
 require "active_support/core_ext/object/blank"
 
 module WebpackerUploader

data/lib/webpacker_uploader/providers/aws.rb

@@ -7,7 +7,8 @@ module WebpackerUploader
   module Providers
     # AWS provider uploads files to AWS S3. It uses the +aws-sdk-s3+ gem.
     class Aws
-      attr_reader :client, :resource, :bucket # @private
+      # AWS provider error class. Raised when the provided AWS client credentials options are wrong.
+      class CredentialsError < StandardError; end
 
       # @param [Hash] options
       #   * :region (String) The S3 region name.
@@ -18,7 +19,12 @@ module WebpackerUploader
       #     * :access_key_id (String) the AWS credentials access id.
       #     * :secret_access_key (String) the AWS credentials secret access key.
       #
-      # @example Initialize the using a named profile:
+      # @note Any unknown options will be passed directly to the +Aws::S3::Client+ class
+      #   during initialization.
+      #
+      # @raise [CredentialsError] if the credential options Hash is not correct.
+      #
+      # @example Initialize using a named profile:
       #
       #   provider_options = {
       #     credentials: { profile_name: "staging" },
@@ -45,9 +51,11 @@ module WebpackerUploader
       #   }
       #   provider = WebpackerUploader::Providers::Aws.new(provider_options)
       def initialize(options)
-        @client = ::Aws::S3::Client.new(client_options(options))
-        @resource = ::Aws::S3::Resource.new(client: @client)
-        @bucket = @resource.bucket(options[:bucket])
+        @region      = options.delete(:region)
+        @bucket_name = options.delete(:bucket)
+        @credentials = credentials(options.delete(:credentials))
+        @aws_options = options
+        @resource    = ::Aws::S3::Resource.new(client: client)
       end
 
       # Uploads a file to AWS S3.
@@ -57,25 +65,43 @@ module WebpackerUploader
       # @param content_type [String] The content type that will be set to the S3 object.
       # @return [void]
       def upload!(object_key, file, content_type = "")
-        object = @bucket.object(object_key)
+        object = @resource.bucket(@bucket_name).object(object_key)
         object.upload_file(file, content_type: content_type)
       end
 
       private
-        def client_options(options)
-          opts = { region: options[:region] }
-          opts[:profile] = options[:profile_name] if options.key? :profile_name
-          opts[:credentials] = credentials(options) if credentials(options)
-          opts
-        end
-
         def credentials(options)
-          if options.key?(:instance_profile) && options[:instance_profile]
+          if options.key?(:profile_name)
+            { profile: options[:profile_name] }
+          elsif options.key?(:instance_profile) && options[:instance_profile]
             ::Aws::InstanceProfileCredentials.new
-          elsif options.key?(:access_key_id)
+          elsif options.key?(:access_key_id) && options.key?(:secret_access_key)
             ::Aws::Credentials.new(options[:access_key_id], options[:secret_access_key])
+          else
+            raise CredentialsError, "Wrong AWS provider credentials options."
           end
         end
+
+        def profile?
+          @credentials.is_a?(Hash) && @credentials.key?(:profile)
+        end
+
+        def credentials_object?
+          !profile?
+        end
+
+        def client
+          ::Aws::S3::Client.new(client_options)
+        end
+
+        def client_options
+          opts = {}
+          opts.merge!(@aws_options)
+          opts[:region] = @region
+          opts.merge!(@credentials) if profile?
+          opts[:credentials] = @credentials if credentials_object?
+          opts
+        end
     end
   end
 end

data/lib/webpacker_uploader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebpackerUploader
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/test/providers/aws_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "webpacker_uploader/providers/aws"
+
+class AwsTest < Minitest::Test
+  def test_credentials_initialization
+    assert_raises(WebpackerUploader::Providers::Aws::CredentialsError) do
+      WebpackerUploader::Providers::Aws.new(credentials: {})
+    end
+
+    assert_raises(WebpackerUploader::Providers::Aws::CredentialsError) do
+      WebpackerUploader::Providers::Aws.new(credentials: { access_key_id: "test" })
+    end
+  end
+end

data/webpacker_uploader.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
     "source_code_uri" => "https://github.com/tlatsas/webpacker_uploader/tree/v#{s.version}"
   }
 
-  s.files         = `git ls-files`.split("\n").reject { |f| f.match(%r{^(bin|test|.github)/}) }
+  s.files         = `git ls-files`.split("\n").reject { |f| f.match(%r{^(bin|test|integration|.github)/}) }
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.require_paths = ["lib"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpacker_uploader
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tasos Latsas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webpacker
@@ -135,6 +135,7 @@ files:
 - test/configuration_test.rb
 - test/manifest_test.rb
 - test/mime_test.rb
+- test/providers/aws_test.rb
 - test/test_app/config/webpacker.yml
 - test/test_app/public/packs/manifest.json
 - test/test_helper.rb
@@ -147,7 +148,7 @@ metadata:
   homepage_uri: https://github.com/tlatsas/webpacker_uploader
   bug_tracker_uri: https://github.com/tlatsas/webpacker_uploader/issues
   changelog_uri: https://github.com/tlatsas/webpacker_uploader/blob/main/CHANGELOG.md
-  source_code_uri: https://github.com/tlatsas/webpacker_uploader/tree/v0.5.0
+  source_code_uri: https://github.com/tlatsas/webpacker_uploader/tree/v0.6.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -171,6 +172,7 @@ test_files:
 - test/configuration_test.rb
 - test/manifest_test.rb
 - test/mime_test.rb
+- test/providers/aws_test.rb
 - test/test_app/config/webpacker.yml
 - test/test_app/public/packs/manifest.json
 - test/test_helper.rb