rails_s3_uploader

Rails S3 Uploader

Rails S3 Uploader is a gem that facilitates the process of uploading files to cloud storage services, such as AWS S3, by integrating flexibly with Active Storage. This gem was developed to offer advanced and customizable features beyond those natively provided by Active Storage.

Purpose and Key Benefits

The primary purpose of Rails S3 Uploader is to provide developers with greater flexibility and control over file management in the cloud. By integrating this gem into your Rails project, you can:

Customization and Configuration Flexibility

• Easily configure integration with AWS S3 or other cloud storage services through custom storage policies, advanced security, and detailed control over files.

Advanced File Handling

• Implement sophisticated operations on files before or after uploading, such as image processing, thumbnail generation, and content validation, automating complex tasks directly within the gem.

Integration with APIs and External Services

• Easily integrate with external APIs to send notifications, process files in external systems, or integrate with content analysis services to ensure security and compliance.

Custom Retention and Expiration Policies

• Define custom policies to manage file retention and expiration according to your project's specific requirements.

Support for Business-Specific Features

• Meet specific business needs, such as version control of files, secure sharing of download links with expiration, and detailed auditing of upload operations.

---

Installation

Note: This gem is currently in development and your final version has not yet been released on RubyGems.org.

To use the development version, add this line to your Gemfile:

gem 'rails_s3_uploader', git: 'https://github.com/eltonsantos/rails_s3_uploader.git'

And run: bundle install

Usage

Note: Full usage documentation will be provided in future versions.

Rails S3 Uploader was developed to facilitate the file upload process to AWS S3 in Ruby on Rails projects. It can be especially useful in projects that need to store and manage files efficiently in the AWS cloud.

Recommended Project Types

• Web Applications: Easily integrate image, document, and other file uploads in web applications built with Ruby on Rails.

• E-commerce Applications: Manage product images, catalogs, and media files on e-commerce platforms.

• Content Management Systems (CMS): Allow users to upload and manage multimedia content in Rails-based CMS systems.

• Collaboration Projects: Facilitate document sharing among users on collaborative platforms.

Initial Configuration

Environment Variables

Create a .env file at the root of your Rails project and add your AWS credentials:

AWS_ACCESS_KEY_ID=your_access_key_id
AWS_SECRET_ACCESS_KEY=your_secret_access_key
AWS_REGION=your_region
AWS_BUCKET=your_bucket

Initializer

Create an initializer in config/initializers/rails_s3_uploader.rb:

RailsS3Uploader.configure do |config|
  config.access_key_id = ENV['AWS_ACCESS_KEY_ID']
  config.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
  config.region = ENV['AWS_REGION']
  config.bucket = ENV['AWS_BUCKET']
end

Development

To set up the development environment, clone the repository and install the dependencies:

git clone https://github.com/eltonsantos/rails_s3_uploader.git

cd rails_s3_uploader

bin/setup

You can use bin/console for an interactive prompt that allows you to test the code.

To install this gem locally, run:

bundle exec rake install

Contributions are welcome! Bug reports and pull requests are welcome on GitHub at https://github.com/eltonsantos/rails_s3_uploader.

Requirements

• Ruby >= 2.6.0 (recommended 2.7+)

• Rails >= 6.0 (compatible up to Rails 7)

• AWS S3 Account: You need an S3 bucket and access credentials to use the rails_s3_uploader gem.

Contributing to Rails S3 Uploader

Fork, fix, then send a pull request.

Licence

This gem is available as open-source under the terms of The MIT License (MIT).

Copyright (c) 2024 Elton Santos, Raquel Fonseca. See MIT-LICENSE for further details.