Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tlatsas/webpacker_uploader
Upload webpack(-er) generated assets to the cloud
https://github.com/tlatsas/webpacker_uploader
assets cloud frontend rails ruby s3-cdn webpacker
Last synced: 12 days ago
JSON representation
Upload webpack(-er) generated assets to the cloud
- Host: GitHub
- URL: https://github.com/tlatsas/webpacker_uploader
- Owner: tlatsas
- License: mit
- Created: 2020-09-21T07:01:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-24T02:50:18.000Z (over 1 year ago)
- Last Synced: 2024-04-26T07:02:50.034Z (9 months ago)
- Topics: assets, cloud, frontend, rails, ruby, s3-cdn, webpacker
- Language: Ruby
- Homepage: https://rubygems.org/gems/webpacker_uploader
- Size: 125 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# WebpackerUploader
[](https://github.com/tlatsas/webpacker_uploader/actions)
[](https://github.com/tlatsas/webpacker_uploader/actions)
[](https://rubygems.org/gems/webpacker_uploader)
[](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.
This is particularly useful if you serve your application's assets through a combination of
S3 + CDN, outside of your Rails application.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "webpacker_uploader", require: false
```
and run:
```sh
bundle install
```
or:
```sh
gem install webpacker_uploader
```
To use the aws provider install the aws-sdk-s3 gem. Add in your Gemfile:
```ruby
gem "aws-sdk-s3", require: false
```
## Usage
Usually, in a Rake task you would add the following to upload the assets to AWS S3:
```ruby
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)
```
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)
```
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)
```
### 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`.
### Add a cache-control directive to remote files
```ruby
WebpackerUploader.upload!(provider, cache_control: "public, max-age=3600")
```
This option is used to specify caching behavior along the request/reply chain.
```text
⚠️ This option is applied to all uploaded files, not on a per-file basis.
```
### Configuration
WebpackerUploader currently supports the following configuration options:
| option | description | default value |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| ignored_extensions | Which files uploader should skip based on the file extension | [] |
| logger | The logger to use for logging | ActiveSupport::Logger.new(STDOUT) |
| log_output | Log output as we upload files | true |
| public_manifest_path | The webpack manifest path | Webpacker.config.public_manifest_path |
| public_path | The webpack public output path | Webpacker.config.public_path |
It can be configured using a block:
```ruby
WebpackerUploader.configure do |config|
config.ignored_extensions = [".png", ".jpg", ".webp"]
config.log_output = false
config.public_manifest_path = "path/to/manifest.json"
config.public_path = "path/to/public/dir"
end
```
or directly:
```ruby
WebpackerUploader.config.log_output = false
```
The uploader used to skip `.map` files by default. This has changed (see [CHANGELOG.md](https://github.com/tlatsas/webpacker_uploader/blob/main/CHANGELOG.md))
and everything is uploaded by default now. To retain the previous functionality use:
```ruby
# skip uploading map files
WebpackerUploader.config.ignored_extensions = [".map"]
```
## Development
After checking out the repo, run `bin/setup` to install dependencies.
Then, run `rake test` to run the tests. You can also run `bin/console` for an
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.
See [CONTRIBUTING](CONTRIBUTING.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).