Merge pull request #20 from vigetlabs/nd/10-sounds-controller

dixonnataliej · web-flow · commit 9c2dede02638 · 2025-07-24T10:49:50.000-06:00
[#10] Add sound controller and active storage
diff --git a/README.md b/README.md
@@ -22,7 +22,12 @@ cd extension && pnpm install
 
 ### Database
 
-TODO
+```bash
+cd api
+bundle exec rails db:create db:migrate
+```
+
+TODO: seed database with default sounds
 
 ### Run servers
 
diff --git a/api/.gitignore b/api/.gitignore
@@ -12,6 +12,8 @@ tmp/
 !/tmp/.keep
 /log/*
 !/log/.keep
+/storage/*
+!/storage/.keep
 
 # Used by dotenv library to load environment variables.
 .env
diff --git a/api/app/controllers/sounds_controller.rb b/api/app/controllers/sounds_controller.rb
@@ -0,0 +1,44 @@
+class SoundsController < ApplicationController
+  def index
+    sounds = Sound.all
+    render json: SoundSerializer.new(sounds).serializable_hash.to_json
+  end
+
+  def show
+    render json: SoundSerializer.new(sound).serializable_hash.to_json
+  end
+
+  def create
+    sound = Sound.new(sound_params)
+    sound.audio_file.attach(sound_params[:audio_file])
+    sound.tag_ids = sound_params[:tag_ids] if sound_params[:tag_ids]
+    if sound.save
+      render json: SoundSerializer.new(sound).serializable_hash.to_json, status: :created
+    else
+      render json: { errors: sound.errors }, status: :unprocessable_entity
+    end
+  end
+
+  def update
+    if sound.update(sound_params)
+      render json: SoundSerializer.new(sound).serializable_hash.to_json
+    else
+      render json: { errors: sound.errors }, status: :unprocessable_entity
+    end
+  end
+
+  def destroy
+    sound.destroy
+    head :no_content
+  end
+
+  private
+
+  def sound
+    @sound ||= Sound.find(params[:id])
+  end
+
+  def sound_params
+    params.require(:sound).permit(:name, :audio_file, tag_ids: [])
+  end
+end
diff --git a/api/app/models/sound.rb b/api/app/models/sound.rb
@@ -1,5 +1,11 @@
 class Sound < ApplicationRecord
   has_and_belongs_to_many :tags
+  has_one_attached :audio_file
 
-  validates :name, :file_url, presence: true
+  validates :name, presence: true
+  validate :audio_file_presence
+
+  def audio_file_presence
+    errors.add(:audio_file, "must be attached") unless audio_file.attached?
+  end
 end
diff --git a/api/app/serializers/sound_serializer.rb b/api/app/serializers/sound_serializer.rb
@@ -0,0 +1,10 @@
+class SoundSerializer
+  include JSONAPI::Serializer
+  attributes :id, :name, :tag_ids
+
+   attribute :audio_file_url do |object|
+    if object.audio_file.attached?
+      Rails.application.routes.url_helpers.rails_blob_url(object.audio_file, only_path: true)
+    end
+  end
+end
diff --git a/api/config/routes.rb b/api/config/routes.rb
@@ -8,6 +8,7 @@
     sessions: "users/sessions",
     registrations: "users/registrations"
   }
+  resources :sounds
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
 
   # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
diff --git a/api/db/migrate/20250722172833_create_active_storage_tables.active_storage.rb b/api/db/migrate/20250722172833_create_active_storage_tables.active_storage.rb
@@ -0,0 +1,57 @@
+# This migration comes from active_storage (originally 20170806125915)
+class CreateActiveStorageTables < ActiveRecord::Migration[7.0]
+  def change
+    # Use Active Record's configured type for primary and foreign keys
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+
+    create_table :active_storage_blobs, id: primary_key_type do |t|
+      t.string   :key,          null: false
+      t.string   :filename,     null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.string   :service_name, null: false
+      t.bigint   :byte_size,    null: false
+      t.string   :checksum
+
+      if connection.supports_datetime_with_precision?
+        t.datetime :created_at, precision: 6, null: false
+      else
+        t.datetime :created_at, null: false
+      end
+
+      t.index [ :key ], unique: true
+    end
+
+    create_table :active_storage_attachments, id: primary_key_type do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false, type: foreign_key_type
+      t.references :blob,     null: false, type: foreign_key_type
+
+      if connection.supports_datetime_with_precision?
+        t.datetime :created_at, precision: 6, null: false
+      else
+        t.datetime :created_at, null: false
+      end
+
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: :index_active_storage_attachments_uniqueness, unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+
+    create_table :active_storage_variant_records, id: primary_key_type do |t|
+      t.belongs_to :blob, null: false, index: false, type: foreign_key_type
+      t.string :variation_digest, null: false
+
+      t.index [ :blob_id, :variation_digest ], name: :index_active_storage_variant_records_uniqueness, unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+  end
+
+  private
+    def primary_and_foreign_key_types
+      config = Rails.configuration.generators
+      setting = config.options[config.orm][:primary_key_type]
+      primary_key_type = setting || :primary_key
+      foreign_key_type = setting || :bigint
+      [ primary_key_type, foreign_key_type ]
+    end
+end
diff --git a/api/db/migrate/20250722223841_remove_file_url_from_sounds.rb b/api/db/migrate/20250722223841_remove_file_url_from_sounds.rb
@@ -0,0 +1,5 @@
+class RemoveFileUrlFromSounds < ActiveRecord::Migration[8.0]
+  def change
+    remove_column :sounds, :file_url, :string
+  end
+end
diff --git a/api/db/schema.rb b/api/db/schema.rb
@@ -10,41 +10,40 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[8.0].define(version: 2025_07_22_172833) do
+ActiveRecord::Schema[8.0].define(version: 2025_07_22_223841) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
 
-  # create_table "active_storage_attachments", force: :cascade do |t|
-  #   t.string "name", null: false
-  #   t.string "record_type", null: false
-  #   t.bigint "record_id", null: false
-  #   t.bigint "blob_id", null: false
-  #   t.datetime "created_at", null: false
-  #   t.index ["blob_id"], name: "index_active_storage_attachments_on_blob_id"
-  #   t.index ["record_type", "record_id", "name", "blob_id"], name: "index_active_storage_attachments_uniqueness", unique: true
-  # end
+  create_table "active_storage_attachments", force: :cascade do |t|
+    t.string "name", null: false
+    t.string "record_type", null: false
+    t.bigint "record_id", null: false
+    t.bigint "blob_id", null: false
+    t.datetime "created_at", null: false
+    t.index ["blob_id"], name: "index_active_storage_attachments_on_blob_id"
+    t.index ["record_type", "record_id", "name", "blob_id"], name: "index_active_storage_attachments_uniqueness", unique: true
+  end
 
-  # create_table "active_storage_blobs", force: :cascade do |t|
-  #   t.string "key", null: false
-  #   t.string "filename", null: false
-  #   t.string "content_type"
-  #   t.text "metadata"
-  #   t.string "service_name", null: false
-  #   t.bigint "byte_size", null: false
-  #   t.string "checksum"
-  #   t.datetime "created_at", null: false
-  #   t.index ["key"], name: "index_active_storage_blobs_on_key", unique: true
-  # end
+  create_table "active_storage_blobs", force: :cascade do |t|
+    t.string "key", null: false
+    t.string "filename", null: false
+    t.string "content_type"
+    t.text "metadata"
+    t.string "service_name", null: false
+    t.bigint "byte_size", null: false
+    t.string "checksum"
+    t.datetime "created_at", null: false
+    t.index ["key"], name: "index_active_storage_blobs_on_key", unique: true
+  end
 
-  # create_table "active_storage_variant_records", force: :cascade do |t|
-  #   t.bigint "blob_id", null: false
-  #   t.string "variation_digest", null: false
-  #   t.index ["blob_id", "variation_digest"], name: "index_active_storage_variant_records_uniqueness", unique: true
-  # end
+  create_table "active_storage_variant_records", force: :cascade do |t|
+    t.bigint "blob_id", null: false
+    t.string "variation_digest", null: false
+    t.index ["blob_id", "variation_digest"], name: "index_active_storage_variant_records_uniqueness", unique: true
+  end
 
   create_table "sounds", force: :cascade do |t|
     t.string "name", null: false
-    t.string "file_url", null: false
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
   end
@@ -77,6 +76,6 @@
     t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true
   end
 
-  # add_foreign_key "active_storage_attachments", "active_storage_blobs", column: "blob_id"
-  # add_foreign_key "active_storage_variant_records", "active_storage_blobs", column: "blob_id"
+  add_foreign_key "active_storage_attachments", "active_storage_blobs", column: "blob_id"
+  add_foreign_key "active_storage_variant_records", "active_storage_blobs", column: "blob_id"
 end
diff --git a/api/spec/fixtures/files/seinfeld_test_audio.mp3 b/api/spec/fixtures/files/seinfeld_test_audio.mp3
diff --git a/api/spec/requests/sounds_spec.rb b/api/spec/requests/sounds_spec.rb
@@ -0,0 +1,64 @@
+require 'rails_helper'
+
+RSpec.describe "Sounds API", type: :request do
+  let(:audio) { fixture_file_upload(Rails.root.join("spec/fixtures/files/seinfeld_test_audio.mp3"), "audio/mpeg") }
+  let(:valid_attributes) do
+    {
+      name: "Test Sound",
+      audio_file: audio
+    }
+  end
+
+  describe "GET /sounds" do
+    it "returns all sounds" do
+      Sound.create!(name: "Test Sound", audio_file: audio)
+      get "/sounds"
+      expect(response).to have_http_status(:ok)
+      expect(JSON.parse(response.body)["data"]).to be_an(Array)
+    end
+  end
+
+  describe "GET /sounds/:id" do
+    it "returns a sound" do
+      sound = Sound.create!(name: "Test Sound", audio_file: audio)
+      get "/sounds/#{sound.id}"
+      expect(response).to have_http_status(:ok)
+      expect(JSON.parse(response.body)["data"]["id"]).to eq(sound.id.to_s)
+    end
+  end
+
+  describe "POST /sounds" do
+    it "creates a sound with an audio file" do
+      post "/sounds", params: { sound: valid_attributes }
+      expect(response).to have_http_status(:created)
+      data = JSON.parse(response.body)["data"]["attributes"]
+      expect(data["name"]).to eq("Test Sound")
+      expect(data["audio_file_url"]).to be_present
+    end
+
+    it "returns errors for missing audio file" do
+      post "/sounds", params: { sound: { name: "No Audio" } }
+      expect(response).to have_http_status(:unprocessable_entity)
+      expect(JSON.parse(response.body)["errors"]).to be_present
+      expect(JSON.parse(response.body)["errors"]["audio_file"]).to include("must be attached")
+    end
+  end
+
+  describe "PATCH /sounds/:id" do
+    it "updates a sound name" do
+      sound = Sound.create!(name: "Old Name", audio_file: audio)
+      patch "/sounds/#{sound.id}", params: { sound: { name: "New Name" } }
+      expect(response).to have_http_status(:ok)
+      expect(JSON.parse(response.body)["data"]["attributes"]["name"]).to eq("New Name")
+    end
+  end
+
+  describe "DELETE /sounds/:id" do
+    it "deletes a sound" do
+      sound = Sound.create!(name: "Delete Me", audio_file: audio)
+      delete "/sounds/#{sound.id}"
+      expect(response).to have_http_status(:no_content)
+      expect(Sound.find_by(id: sound.id)).to be_nil
+    end
+  end
+end
diff --git a/api/spec/requests/user_spec.rb b/api/spec/requests/user_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`sessions: "users/sessions",`
`9`	`9`	`registrations: "users/registrations"`
`10`	`10`	`}`
	`11`	`+ resources :sounds`
`11`	`12`	`# Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html`
`12`	`13`
`13`	`14`	`# Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.`