How to Integrate Ruby on Rails, Paperclip, Amazon AWS S3, and Heroku

How to Integrate Ruby on Rails, Paperclip, Amazon AWS S3, and Heroku

Are you a data scientist or software engineer working with Ruby on Rails and looking to streamline your application’s file management process? Then, this blog post is for you. We’ll explore how to integrate Ruby on Rails, Paperclip, Amazon AWS S3, and Heroku to create a robust and scalable file handling system.

Ruby on Rails is a web application development framework written in Ruby language. It enables developers to write less code while accomplishing more than many other languages and frameworks. Paperclip is a Rails gem used for file uploading, and Amazon AWS S3 is a storage service where we can store our files. Heroku is a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud.

What is Paperclip?

Paperclip is a powerful and flexible gem to handle file uploads in Rails applications. It provides a plethora of options to process and store files, be it images, documents, or audio files.

How Does Paperclip Work with AWS S3?

AWS S3 (Simple Storage Service) is an object storage service from Amazon Web Services. It provides scalability, data availability, security, and performance. This can be integrated with Paperclip to store the uploaded files.

Setting up Paperclip with AWS S3

To start, add the following gems to your Gemfile:

gem 'paperclip'
gem 'aws-sdk', '~> 3'

Then run bundle install to install the gems.

Create an AWS S3 bucket where you will store your files. You will need to take note of your bucket name, AWS Access Key ID, AWS Secret Access Key, and the region of your bucket.

Configure Paperclip to use S3 by adding the following to your config/environments/production.rb:

config.paperclip_defaults = {
  storage: :s3,
  s3_region: 'us-west-2',
  s3_credentials: {
    bucket: 'your_bucket_name',
    access_key_id: 'your_access_key_id',
    secret_access_key: 'your_secret_access_key'
  }
}

In your model, you will need to add Paperclip’s required methods:

class User < ApplicationRecord
  has_attached_file :avatar
  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\z/
end

Deploying on Heroku

Heroku is a cloud-based platform that helps developers deploy, manage, and scale applications. Here’s how to deploy your Ruby on Rails application with Paperclip and AWS S3 on Heroku.

First, create a new application on Heroku. Install the Heroku CLI and login to your account. Then create a new app using the heroku create command.

You will need to set your AWS credentials as Heroku environment variables. You can set these using the heroku config:set command:

heroku config:set S3_BUCKET_NAME=your_bucket_name
heroku config:set AWS_ACCESS_KEY_ID=your_access_key_id
heroku config:set AWS_SECRET_ACCESS_KEY=your_secret_access_key
heroku config:set AWS_REGION=your_bucket_region

Next, update your Paperclip settings in config/environments/production.rb to use these variables:

config.paperclip_defaults = {
  storage: :s3,
  s3_region: ENV['AWS_REGION'],
  s3_credentials: {
    bucket: ENV['S3_BUCKET_NAME'],
    access_key_id: ENV['AWS_ACCESS_KEY_ID'],
    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
  }
}

Finally, deploy your application to Heroku using git push heroku master.

Conclusion

Integrating Ruby on Rails with Paperclip, AWS S3, and Heroku offers a scalable, robust solution for managing file uploads in your web applications. This comprehensive setup allows for efficient file handling and storage, making it ideal for applications with heavy file upload demands.

About Saturn Cloud

Saturn Cloud is your all-in-one solution for data science & ML development, deployment, and data pipelines in the cloud. Spin up a notebook with 4TB of RAM, add a GPU, connect to a distributed cluster of workers, and more. Join today and get 150 hours of free compute per month.