Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imgproxy/imgproxy-rails
https://github.com/imgproxy/imgproxy-rails
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/imgproxy/imgproxy-rails
- Owner: imgproxy
- License: mit
- Created: 2023-08-03T19:11:46.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-16T08:29:24.000Z (5 months ago)
- Last Synced: 2024-11-16T07:18:58.067Z (about 1 month ago)
- Language: Ruby
- Size: 83 KB
- Stars: 95
- Watchers: 8
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
---
Seamless integration of [imgproxy](https://imgproxy.net)–a fast and secure standalone server for resizing and converting remote images–to your Rails app with zero changes to your codebase required.
While [imgproxy.rb](https://github.com/imgproxy/imgproxy.rb) being a framework-agnostic Ruby gem includes proper support for Rails' most popular image attachment options: [Active Storage](https://edgeguides.rubyonrails.org/active_storage_overview.html) and [Shrine](https://github.com/shrinerb/shrine), it requires user to use imgproxy specific API:
```ruby
user.avatar.imgproxy_url(width: 250, height: 250)
```
But wouldn't that be awesome to keep using existing variant syntax? For example, to use vips/ImageMagick in dev and imgproxy in production?
And `imgproxy-rails` gem provides just that, thanks to [ActiveStorage::Variant API](https://api.rubyonrails.org/v7.1.3/classes/ActiveStorage/Variant.html) and [Proxy mode](https://guides.rubyonrails.org/active_storage_overview.html#proxy-mode).
## Installation
Add to your project:
```ruby
# Gemfile
gem "imgproxy-rails"
```
### Supported Ruby versions
- Ruby (MRI) >= 2.7.0
- JRuby >= 9.3.0
### Supported Rails versions
- Rails >= 6.0.0
## Usage
Given the following configuration:
```ruby
# development.rb
config.active_storage.resolve_model_to_route = :rails_storage_proxy
# production.rb
config.active_storage.resolve_model_to_route = :imgproxy_active_storage
```
The following HTML snippet will generate different URLs in dev and prod:
```erb
# show.erb.html
<%= image_tag Current.user.avatar.variant(resize: "100x100") %>
```
In dev, it will generate a URL like this:
```html
```
In prod, it will generate a URL like this:
```html
```
You can also specify imgproxy-specific parameters in `imgproxy_options` attribute. Imgproxy-specific params will take precedence over ones from original API:
```ruby
# height=50 and width=50 will be applied
Current.user.avatar.variant(resize: "100x100", imgproxy_options: {height: 50, width: 50})
```
### Generating video and PDF previews
If you are an imgproxy Pro user and you want to use it to generate previews for your videos and PDFs, just add their content types to the `variable_content_types` list:
```ruby
config.active_storage.variable_content_types << "application/pdf"
config.active_storage.variable_content_types << "video/mp4"
config.active_storage.variable_content_types << "video/mov"
# ...etc
```
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/imgproxy/imgproxy-rails](https://github.com/imgproxy/imgproxy-rails).
## Credits
This gem is generated via [new-gem-generator](https://github.com/palkan/new-gem-generator).
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).