Merge pull request #33 from renuo/feature/24939-rails-active-storage-example

Rails Active Storage example app

Author: thirdeyenick

README.md

@@ -25,6 +25,56 @@ nctl create application rails \
   --env=SECRET_KEY_BASE=$(rails secret)
 ```
 
+### Ruby On Rails with ActiveStorage
+
+Next to the basic Rails example, we also provide a Rails application that has ActiveStorage configured with 
+Deploio Object Storage. 
+
+Once deployed, you can head to the root page of the app and test the upload functionality. The example app supports 
+direct uploads from the browser (CORS configuration is required as below) and custom bucket hostnames 
+(DNS change required, see below).
+
+```bash
+# setup postgres database
+nctl create postgresdatabase rails-active-storage-db --location=nine-es34 --wait
+DATABASE_URL="$(nctl get postgresdatabase rails-active-storage-db --print-connection-string)"
+
+# setup application
+nctl create application rails-active-storage \
+  --git-url=https://github.com/ninech/deploio-examples \
+  --git-sub-path=ruby/rails-active-storage \
+  --env=SECRET_KEY_BASE=$(rails secret)\;DATABASE_URL=${DATABASE_URL}
+  
+# create bucket
+nctl create bucket --location=nine-es34 rails-active-storage-bucket
+
+# create bucket user
+nctl create bucketuser --location=nine-es34 rails-active-storage-bucketuser
+
+# grant bucket user read & write access to bucket
+nctl update bucket rails-active-storage-bucket --permissions reader=rails-active-storage-bucketuser \
+  --permissions writer=rails-active-storage-bucketuser
+  
+# update application with object storage credentials
+ACCESS_KEY="$(nctl get bucketuser rails-active-storage-bucketuser --print-credentials -o json | jq -r .s3_access_key)"
+SECRET_KEY="$(nctl get bucketuser rails-active-storage-bucketuser --print-credentials -o json | jq -r .s3_secret_key)"
+nctl update app rails-active-storage --env="S3_ACCESS_KEY=${ACCESS_KEY};S3_SECRET_KEY=${SECRET_KEY};S3_ENDPOINT=https://es34.objects.nineapis.ch;S3_BUCKET=rails-active-storage-bucket"
+  
+# optional: custom bucket hostnames
+nctl update bucket rails-active-storage-bucket --custom-hostnames={S3_BUCKET_HOST}
+nctl update app rails-active-storage --env="S3_BUCKET_HOST={S3_BUCKET_HOST}"
+nctl get bucket rails-active-storage-bucket --output="yaml" # setup DNS
+
+# CORS configuration for direct uploads from browser
+# see https://guides.rubyonrails.org/active_storage_overview.html#cross-origin-resource-sharing-cors-configuration
+APP_HOST=$(nctl get app rails-active-storage -o json | jq -r ".status.atProvider.defaultURLs | first")
+nctl update bucket rails-active-storage-bucket \
+  --cors origins=${APP_HOST} \
+  --cors allowed-headers=Content-Type,Content-MD5,Content-Disposition \
+  --cors response-headers=Content-Type,Content-MD5,Content-Disposition,ETag \
+  --cors max-age=3600
+```
+
 ## Ruby - Sinatra on Falcon
 
 ```bash

ruby/rails-active-storage/.deploio.yaml

@@ -0,0 +1,5 @@
+deployJob:
+  name: db-migrations
+  command: bundle exec rails db:migrate
+  retries: 0
+  timeout: 5m

ruby/rails-active-storage/.env.example

@@ -0,0 +1,5 @@
+S3_ACCESS_KEY=
+S3_SECRET_KEY=
+S3_ENDPOINT=
+S3_BUCKET=
+S3_BUCKET_HOST=

ruby/rails-active-storage/.gitattributes

@@ -0,0 +1,9 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored
+config/credentials/*.yml.enc diff=rails_credentials
+config/credentials.yml.enc diff=rails_credentials

ruby/rails-active-storage/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# Temporary files generated by your text editor or operating system
+# belong in git's global ignore instead:
+# `$XDG_CONFIG_HOME/git/ignore` or `~/.config/git/ignore`
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files.
+/.env*
+!.env.example
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore key files for decrypting credentials and more.
+/config/*.key
+

ruby/rails-active-storage/.rspec

@@ -0,0 +1 @@
+--require spec_helper

ruby/rails-active-storage/.rubocop.yml

@@ -0,0 +1,3 @@
+# Omakase Ruby styling for Rails
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

ruby/rails-active-storage/.ruby-version

@@ -0,0 +1 @@
+4.0.1

ruby/rails-active-storage/Gemfile

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 8.1.2"
+# The modern asset pipeline for Rails [https://github.com/rails/propshaft]
+gem "propshaft"
+# Use postgresql as the database for Active Record
+gem "pg", "~> 1.1"
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", ">= 5.0"
+
+gem "aws-sdk-s3"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ windows jruby ]
+
+group :development, :test do
+  gem "rspec-rails"
+  gem "dotenv"
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri windows ], require: "debug/prelude"
+end