(api) OpenAPI plans categories index endpoint

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - OpenAPI spaces endpoints (index/show)
 - OpenAPI plans endpoints (index/show)
+- OpenAPI plans categories index endpoint
 - Improved automated test on statistics generation
 - Refactored statistics generation
 - Refactored test helpers

app/controllers/open_api/v1/plan_categories_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# authorized 3rd party softwares can fetch data about plan categories through the OpenAPI
+class OpenAPI::V1::PlanCategoriesController < OpenAPI::V1::BaseController
+  extend OpenAPI::ApiDoc
+  expose_doc
+
+  def index
+    @plans_categories = PlanCategory.order(:created_at)
+  end
+end

app/doc/open_api/v1/plan_categories_doc.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# openAPI documentation for plan categories endpoint
+class OpenAPI::V1::PlanCategoriesDoc < OpenAPI::V1::BaseDoc
+  resource_description do
+    short 'Plans categories'
+    desc 'Categories of subscription plans'
+    formats FORMATS
+    api_version API_VERSION
+  end
+
+  doc_for :index do
+    api :GET, "/#{API_VERSION}/plan_categories", 'Plans categories index'
+    description 'Plans categories index. Order by *created_at* ascendant.'
+    example <<-PLAN_CATEGORIES
+      # /open_api/v1/plan_categories
+      {
+        "plan_categories": [
+          {
+            "id": 1,
+            "name": "CRAZY LAB",
+            "weight": 0,
+            "description": "Lorem ipsum dolor sit amet",
+            "updated_at": "2021-12-01 15:15:19.860064000 Z",
+            "created_at": "2021-12-01 15:19:28.367161000 Z"
+          },
+          {
+            "id": 2,
+            "name": "PREMIUM",
+            "weight": 1,
+            "description": "<p>Lorem ipsum <b>dolor</b> sit amet</p>",
+            "updated_at": "2021-12-01 15:15:19.860064000 Z",
+            "created_at": "2021-12-01 15:19:28.367161000 Z"
+          }
+        ]
+      }
+    PLAN_CATEGORIES
+  end
+end

app/doc/open_api/v1/plans_doc.rb

@@ -60,7 +60,7 @@ class OpenAPI::V1::PlansDoc < OpenAPI::V1::BaseDoc
             "monthly_payment": true,
             "updated_at": "2020-12-14 14:10:11.056241000 Z",
             "created_at": "2020-12-14 14:10:11.056241000 Z"
-          },
+          }
         ]
       }
     PLANS

app/views/open_api/v1/plan_categories/index.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+json.plan_categories @plans_categories do |category|
+  json.extract! category, :id, :name, :weight, :description, :updated_at, :created_at
+end

config/routes.rb

@@ -241,6 +241,7 @@ Rails.application.routes.draw do
     namespace :v1 do
       scope only: :index do
         resources :plans, only: %i[index show]
+        resources :plan_categories
         resources :users
         resources :trainings
         resources :user_trainings

test/integration/open_api/plan_categories_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module OpenApi; end
+
+class OpenApi::PlanCategoriesTest < ActionDispatch::IntegrationTest
+  def setup
+    @token = OpenAPI::Client.find_by(name: 'minitest').token
+  end
+
+  test 'list all plan categories' do
+    get '/open_api/v1/plan_categories', headers: open_api_headers(@token)
+    assert_response :success
+  end
+end