Ruby で Supabase バケットにファイルをエクスポート
Ruby から Supabase にファイルをエクスポートするには、Storage REST API にバイト列を送信し、選択したオブジェクトをダウンロードして入力と比較します。この例では一般ユーザーとしてサインインし、既存のオブジェクトパスへのアップロードを拒否して、検証済みのアップロードをバケットに残します。削除は別のコマンドで実行します。
前提条件
- Ruby 4.0.7、Bundler、および JSON gem のインストールに必要なコンパイラーと
make。Ruby のダウンロードページに、現在のリリースとインストール方法が掲載されています。Linux でのセットアップは Bundler 4.0.20 で検証済みで、Ruby 3.3.12 と Bundler 2.5.22 の組み合わせでも検証しています。 - 以下のシェルコマンドを実行するための Bash。書き込み可能なディレクトリから開始してください。そのディレクトリには
supabase-storage-demo子ディレクトリが存在せず、BUNDLE_*、GEM_HOME、GEM_PATHの上書き設定がエクスポートされていないことが必要です。 - Supabase プロジェクト、メールアドレスとパスワードを使う確認済みの Auth ユーザー、および
ruby-exportsという名前の専用の非公開 Storage バケット。公式のバケット作成ガイドに従って作成し、コンテンツタイプapplication/octet-streamと最大 1 MiB のファイルを許可してください。 - 環境変数として渡すプロジェクト URL、プロジェクトキー、およびユーザーのメールアドレスとパスワード。
ホスト型プロジェクトでは、公開可能なプロジェクトキーを使用してください。このキーは apikey ヘッダーに、サインインしたユーザーの JWT は Authorization: Bearer に指定します。Supabase は、従来の anon キーと service_role キーを 2026 年末までに非推奨にする予定を発表しています。既存のプロジェクトでは、移行中に両方のキー方式を使用できます。この例のネイティブ環境での検証には、公開可能なキーを使うホスト型プロジェクトではなく、従来の anon キーを使うローカルのセルフホスト型プロジェクトを使用しています。ホスト型環境でのキー発行と TLS は、ここでは検証していません。
プロジェクト管理者として、専用バケットに対して次の SQL を実行してください。これらの Storage ポリシーは、ユーザーの UUID 配下へのアップロードと、そのユーザーによる自身のオブジェクトの読み取りと削除を許可します。アップロードには INSERT、読み戻しには SELECT が必要です。削除には、Storage の remove リファレンスに記載されているとおり、SELECT と DELETE も必要です。まず、より広いアクセスを許可する既存のポリシーがないか確認してください。許可ポリシーは組み合わせて適用されるため、これらのルールで別のポリシーがすでに許可したアクセスを制限することはできません。
create policy ruby_exports_insert on storage.objects
for insert to authenticated with check (
bucket_id = 'ruby-exports'
and (storage.foldername(name))[1] = (select auth.uid())::text
);
create policy ruby_exports_select on storage.objects
for select to authenticated using (
bucket_id = 'ruby-exports'
and (storage.foldername(name))[1] = (select auth.uid())::text
and owner_id = (select auth.uid())::text
);
create policy ruby_exports_delete on storage.objects
for delete to authenticated using (
bucket_id = 'ruby-exports'
and (storage.foldername(name))[1] = (select auth.uid())::text
and owner_id = (select auth.uid())::text
);
SUPABASE_URL、SUPABASE_PROJECT_KEY、SUPABASE_EMAIL、SUPABASE_PASSWORD は、シークレットマネージャーまたは保護されたプロセス環境から渡してください。https://PROJECT_REF.supabase.co のような、プロジェクトのルート URL を使用します。パスワード、ユーザートークン、管理用キーをソースコードやシェル履歴に残さないでください。プログラムは実行のたびに Auth のパスワードグラントで新しいユーザーセッションを取得します。シークレットキーや service_role キーは不要です。
環境のセットアップ
次のブロックを Bash に貼り付けてください。サブシェルを使うため、セットアップに失敗した場合も、現在のディレクトリとシェルオプションは変更されません。既存のプロジェクトディレクトリも保持されます。
(
command -v ruby >/dev/null &&
command -v bundle >/dev/null &&
mkdir supabase-storage-demo &&
cd supabase-storage-demo &&
bundle init &&
bundle config set --local path vendor/bundle
)
新しく作成された supabase-storage-demo/Gemfile を、次の内容に置き換えてください。
source 'https://rubygems.org'
gem 'json', '3.0.2'
gem 'net-http', '0.10.0'
バージョン固定には、2026年10月12日に確認した最新の JSON と
Net::HTTP のリリースを使用しています。システム全体に gem をインストールせず、このプロジェクトの vendor/bundle にインストールしてください。
(cd supabase-storage-demo && bundle install)
インストールに失敗した場合は、報告されたネットワークの問題やコンパイラーの前提条件を修正し、同じプロジェクトでインストール用ブロックを再実行してください。Gemfile とローカルの Bundler 設定は保持します。再試行のためにディレクトリ作成用ブロックを繰り返したり、既存のプロジェクトを削除したりしないでください。
Ruby での REST API クライアントの設定
次のプログラム全体を supabase-storage-demo/storage.rb として保存してください。空のファイルやバイナリファイルも含め、一度にひとつのファイルを処理し、アプリケーション側の上限は 1 MiB です。ローカルファイル名は、制御文字を含まない有効な UTF-8 バイト列である必要があります。この検証はシェルのロケールには依存しません。オブジェクトキーには ASCII の英字、数字、スペース、_、-、.、/ を使用し、空のフォルダーセグメントや .、.. のフォルダーセグメントは含めません。検証した Storage バージョンでは、キー内の Unicode とパーセント記号が拒否されるため、ローカルファイル名とは独立に、対応するキーを選んでください。プログラムは、対応するキーの各セグメントを URL 用にエンコードします。
require 'digest'
require 'json'
require 'net/http'
require 'uri'
class StorageError < StandardError
end
class SupabaseStorage
MAX_BYTES = 1024 * 1024
attr_reader :user_id
def initialize
@url = ENV.fetch('SUPABASE_URL').chomp('/')
origin = URI(@url)
secure = origin.is_a?(URI::HTTPS)
local = origin.is_a?(URI::HTTP) && %w[localhost 127.0.0.1 [::1]].include?(origin.host)
unless (secure || local) && origin.userinfo.nil? && origin.query.nil? &&
origin.fragment.nil? && origin.path.empty?
raise StorageError, 'Use an HTTPS project root URL, or HTTP on localhost for local testing'
end
@project_key = ENV.fetch('SUPABASE_PROJECT_KEY')
login = Net::HTTP::Post.new('/auth/v1/token?grant_type=password')
login['Content-Type'] = 'application/json'
login.body = JSON.generate(email: ENV.fetch('SUPABASE_EMAIL'),
password: ENV.fetch('SUPABASE_PASSWORD'))
session = JSON.parse(request(login).body)
@token = session.fetch('access_token')
user = JSON.parse(request(Net::HTTP::Get.new('/auth/v1/user')).body)
@user_id = user.fetch('id')
end
def upload(bucket, key, path)
bytes = input_bytes(path)
upload = Net::HTTP::Post.new(object_path(bucket, key))
upload['Content-Type'] = 'application/octet-stream'
upload['x-upsert'] = 'false'
upload.body = bytes
request(upload)
verify_bytes(bucket, key, bytes)
end
def verify(bucket, key, path)
verify_bytes(bucket, key, input_bytes(path))
end
def delete(bucket, key)
key = text(key)
object_path(bucket, key)
deletion = Net::HTTP::Delete.new("/storage/v1/object/#{segment(bucket)}")
deletion['Content-Type'] = 'application/json'
deletion.body = JSON.generate(prefixes: [key])
deleted = JSON.parse(request(deletion).body)
unless deleted.is_a?(Array) && deleted.any? { |object| object['name'] == key }
raise StorageError, 'Deletion was not confirmed; the object may be missing or inaccessible'
end
puts 'Deletion confirmed'
end
private
def request(message)
message['apikey'] = @project_key
message['Authorization'] = "Bearer #{@token}" if @token
uri = URI(@url)
Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https',
open_timeout: 10, read_timeout: 30, write_timeout: 30) do |http|
http.max_retries = 0
response = http.request(message)
unless response.is_a?(Net::HTTPSuccess)
raise StorageError, "Request failed (HTTP #{response.code})"
end
response
end
end
def text(value)
value = value.dup.force_encoding(Encoding::UTF_8)
unless value.valid_encoding? && !value.match?(/[\x00-\x1f\x7f]/)
raise StorageError, 'Paths must be valid UTF-8 without control characters'
end
value
end
def segment(value)
URI.encode_www_form_component(text(value)).gsub('+', '%20')
end
def object_path(bucket, key)
raise StorageError, 'Invalid bucket name' unless bucket.match?(/\A[a-z0-9][a-z0-9-]*\z/)
key = text(key)
unless key.match?(/\A[A-Za-z0-9_.\/ -]+\z/)
raise StorageError, 'Use an ASCII object key with letters, digits, spaces, _, -, ., and /'
end
parts = key.split('/', -1)
if parts.any? { |part| ['', '.', '..'].include?(part) } || key.include?('\\')
raise StorageError, 'Use a nonempty object key with ordinary folder segments'
end
"/storage/v1/object/#{segment(bucket)}/#{parts.map { |part| segment(part) }.join('/')}"
end
def input_bytes(path)
path = text(path)
raise StorageError, 'Input must be a regular file' unless File.file?(path)
bytes = File.binread(path, MAX_BYTES + 1) || ''.b
raise StorageError, 'Input exceeds the 1 MiB application limit' if bytes.bytesize > MAX_BYTES
bytes
end
def verify_bytes(bucket, key, expected)
download = Net::HTTP::Get.new(object_path(bucket, key))
download['Accept-Encoding'] = 'identity'
actual = request(download).body || ''.b
unless actual.b == expected.b
raise StorageError, 'Stored bytes differ from the input; inspect the object before retrying'
end
puts "Verified #{expected.bytesize} bytes; SHA-256 #{Digest::SHA256.hexdigest(actual)}"
end
end
begin
command, bucket, key, path = ARGV
valid = (command == 'whoami' && ARGV.length == 1) ||
(%w[upload verify].include?(command) && ARGV.length == 4) ||
(command == 'delete' && ARGV.length == 3)
unless valid
raise StorageError, 'Usage: storage.rb whoami | upload/verify BUCKET KEY FILE | delete BUCKET KEY'
end
storage = SupabaseStorage.new
case command
when 'whoami' then puts storage.user_id
when 'upload' then storage.upload(bucket, key, path)
when 'verify' then storage.verify(bucket, key, path)
when 'delete' then storage.delete(bucket, key)
end
rescue StandardError => error
# Only our deliberate messages are safe to print; library errors can contain private data.
safe = error.instance_of?(StorageError) ? error.message : 'Check configuration, input, and connectivity'
warn "Storage command failed: #{safe}"
exit 1
end
アップロードでは、JSON やマルチパートフィールドではなく、生のバイト列を送信します。読み戻しには、同じユーザーの権限で認証付きオブジェクトエンドポイントを使用します。各ネットワーク操作には 10秒の接続タイムアウトと、読み取りと書き込みそれぞれに 30秒の無通信タイムアウトがあります。転送全体の制限時間ではありません。自動再試行は無効です。レスポンスが失われると、コマンドが失敗を報告してもオブジェクトが残る場合があります。
使用例
渡した認証情報を確認し、ユーザー UUID を取得します。
(cd supabase-storage-demo && bundle exec ruby storage.rb whoami)
report.bin という名前のファイルをプロジェクト内に配置してください。以下の USER_UUID を、表示された UUID に置き換えます。上記のポリシーに従うには、この UUID がオブジェクトキーの最初のフォルダーである必要があります。
(cd supabase-storage-demo &&
bundle exec ruby storage.rb upload ruby-exports 'USER_UUID/exports/report.bin' ./report.bin)
コマンドが成功すると、ダウンロードしたオブジェクトのバイト数と SHA-256 を表示し、終了コード 0 で終了します。オブジェクトは選択したキーに残ります。アップロードや置き換えをせずに再確認するには、次を実行します。
(cd supabase-storage-demo &&
bundle exec ruby storage.rb verify ruby-exports 'USER_UUID/exports/report.bin' ./report.bin)
比較中はソースファイルを変更しないでください。スペースを含むパス引数は引用符で囲み、ハイフンで始まるローカルファイル名には ./ を使用してください。この例では、フォルダーの一覧取得や公開ダウンロードリンクの作成は行いません。
エラー処理とファイル検証
アップロードが拒否された場合、読み戻しに失敗した場合、削除を確認できなかった場合は、いずれもゼロ以外の終了コードで終了します。標準アップロードでは既存のキーが拒否されます。プログラムは upsert を要求せず、以前のバイト列を置き換えません。コマンドは順番に実行してください。
HTTP の失敗だけでは原因を特定できません。プロジェクト URL、ユーザー認証情報、バケットの制限、キーの UUID プレフィックス、適用されるポリシーを確認してください。オブジェクトが存在しない場合とアクセスできない場合で、同じレスポンスになることがあります。プログラムの診断メッセージには、生のサーバーレスポンス本文、認証情報、ライブラリーのエラーを含めません。
上限の 1 MiB ちょうどまで許可され、0 バイトも許可されます。これはこの例での上限です。プロジェクトやバケットで追加の制限が課される場合があります。MIME ヘッダーは汎用のバイナリコンテンツを宣言するもので、ファイル形式の識別やコンテンツの安全性の確認は行いません。アップロードが成功しても検証に失敗した場合は、再試行する前に verify コマンドでそのキーを調べてください。アップロードはロールバックされず、通知なく削除されることもありません。
ベストプラクティス
定期的なレポートのエクスポートでは、レポートごとに新しいキーを選んでください。たとえば USER_UUID/exports/2026/10/report-12.bin のようにします。日付フォルダーでエクスポートを整理し、さらにジョブ識別子を付けると同じ日の複数のレポートを区別できます。後で検証や削除を行う際に同じオブジェクトを対象にできるよう、ジョブの記録とともにキーを保持してください。
大きなファイルの処理
この小さなファイル向けの例では、入力と読み戻しの両方をバッファーに保持し、中断したアップロードを再開することはできません。より大きな転送には、対応する tus クライアントで Supabase の再開可能なアップロードプロトコルを使用してください。標準のオブジェクトエンドポイントに個別のチャンクを送信しても、このプロトコルの実装にはなりません。再開可能な転送は、この例で検証した範囲には含まれません。
エクスポートの明示的な削除
エクスポートしたファイルが不要になったら、選択したキーだけを削除してください。
(cd supabase-storage-demo &&
bundle exec ruby storage.rb delete ruby-exports 'USER_UUID/exports/report.bin')
成功と判定するには、削除レスポンスがそのオブジェクトを識別している必要があります。空の配列は、オブジェクトが存在しないか、ポリシーによって非表示になっていることを意味する場合があるため、その場合、コマンドは失敗を報告します。ひとつのエクスポートを削除しても、そのバケット、他のオブジェクト、ユーザー、ポリシーは削除されません。
ご自身での運用は避けたいですか?
Transloadit は、単一の API 呼び出し内の処理の一環として、S3、Azure、Google Cloud などにファイルをエクスポートします。
