Merge pull request #35 from rossme/develop

api v1 setup inc schema and specs (#34)

Author: rossme

app/controllers/api/v1/base_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Api::V1
+
+  # This controller is responsible for handling the json response of the API
+  class BaseController < ActionController::API
+    include Api::V1::Concerns::ResponseHandler
+
+    respond_to :json
+  end
+end

app/controllers/api/v1/concerns/response_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Api::V1
+  module Concerns
+
+    module ResponseHandler
+      extend ActiveSupport::Concern
+
+      def respond_with(resource:, status:)
+        render json: response_serializer(resource), status: status
+      end
+
+      def response_serializer(resource)
+        serializer = constantized_serializer.new(resource)
+        action_name == 'show' ? serializer.serialize_object : serializer.serialize_collection
+      end
+
+      def constantized_serializer
+        "Api::V1::#{controller_name.capitalize}Serializer".safe_constantize
+      end
+    end
+  end
+end

app/controllers/api/v1/prompts_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Api
+  module V1
+    class PromptsController < BaseController
+
+      def show
+        prompt = Prompt.find(params[:id])
+        respond_with(resource: prompt, status: :ok)
+      end
+
+      def index
+        prompts = Prompt.all
+        respond_with(resource: prompts, status: :ok)
+      end
+    end
+  end
+end

app/controllers/api/v1/schema_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Api
+  module V1
+    class SchemaController < BaseController
+
+      def index
+        if File.exist?(schema_path)
+          send_file schema_path, type: 'application/x-yaml', disposition: 'inline'
+        else
+          render plain: 'API schema not found', status: :not_found
+        end
+      end
+
+      def schema_path
+        Rails.root.join('config', 'openapi', 'api_v1_schema.yaml')
+      end
+    end
+  end
+end

app/serializers/api/v1/prompts_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Api
+  module V1
+    class PromptsSerializer
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      attr_reader :resource
+
+      def serialize_object
+        resource.serializable_hash
+      end
+
+      def serialize_collection
+        resource(&:serializable_hash)
+      end
+    end
+  end
+end

config/openapi/api_v1_schema.yaml

@@ -0,0 +1,70 @@
+---
+openapi: 3.0.0
+info:
+  title: Prompts API
+  version: 1.0.0
+paths:
+  /api/v1/prompts:
+    get:
+      summary: List all prompts
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Prompt'
+
+  /api/v1/prompts/{id}:
+    get:
+      summary: Get a prompt by ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: ID of the prompt
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Prompt'
+
+components:
+  schemas:
+    Prompt:
+      type: object
+      properties:
+        id:
+          type: integer
+        user_id:
+          type: integer
+          description: The ID of the user who created the prompt.
+        input:
+          type: string
+          description: The input content of the prompt.
+        output:
+          type: string
+          description: The output content of the prompt.
+        created_at:
+          type: string
+        updated_at:
+          type: string
+        actioned:
+          type: boolean
+          description: If the prompt has been actioned.
+        action:
+          type: string
+        actionable_type:
+          type: string
+          description: Polymorphic object type of the actionable.
+        actionable_id:
+          type: integer
+      required:
+        - user_id
+        - input

config/routes.rb

@@ -4,8 +4,17 @@
   devise_for :users
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
 
+  # Web routes
   resources :prompts
 
+  # API V1 routes
+  namespace :api do
+    namespace :v1 do
+      resources :prompts, only: %i[index show]
+      resources :schema,  only: %i[index]
+    end
+  end
+
   # Application root path
   root to: 'prompts#index'
 end

spec/requests/api/v1/concerns/response_handler_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'pry'
+
+RSpec.describe Api::V1::Concerns::ResponseHandler do
+  describe '#respond_with' do
+    it 'responds with a collection' do
+      collection = create_list(:prompt, 3)
+      controller = double('controller', action_name: 'index', controller_name: 'prompts')
+      allow(controller).to receive(:constantized_serializer).and_return(Api::V1::PromptsSerializer)
+      allow(controller).to receive(:render).with(json: Api::V1::PromptsSerializer.new(collection).serialize_collection, status: :ok)
+      controller.extend(Api::V1::Concerns::ResponseHandler)
+      controller.respond_with(resource: collection, status: :ok)
+      expect(controller).to have_received(:render).with(json: Api::V1::PromptsSerializer.new(collection).serialize_collection, status: :ok)
+    end
+  end
+end

spec/requests/api/v1/prompts_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Api::V1::Prompts', type: :request do
+  describe 'GET /index' do
+    it 'returns http success' do
+      get '/api/v1/prompts'
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe 'GET /show' do
+    it 'returns http success' do
+      prompt = create(:prompt)
+      get "/api/v1/prompts/#{prompt.id}"
+      expect(response).to have_http_status(:success)
+    end
+  end
+end