Enhance API coverage

Author: Lee Richmond

app/controllers/departments_controller.rb

@@ -5,4 +5,9 @@ def index
     departments = Department.all
     render_jsonapi(departments)
   end
+
+  def show
+    scope = jsonapi_scope(Department.where(id: params[:id]))
+    render_jsonapi(scope.resolve.first, scope: false)
+  end
 end

app/controllers/goals_controller.rb

@@ -0,0 +1,13 @@
+class GoalsController < ApplicationController
+  jsonapi resource: GoalResource
+
+  def index
+    departments = Goal.all
+    render_jsonapi(departments)
+  end
+
+  def show
+    scope = jsonapi_scope(Goal.where(id: params[:id]))
+    render_jsonapi(scope.resolve.first, scope: false)
+  end
+end

app/resources/department_resource.rb

@@ -1,8 +1,15 @@
 class DepartmentResource < ApplicationResource
   type :departments
 
-  belongs_to :employee,
-    foreign_key: :employee_id,
+  allow_filter :id
+  allow_filter :name
+
+  has_many :employees,
+    foreign_key: :department_id,
     scope: -> { Employee.all },
     resource: EmployeeResource
+  has_many :goals,
+    foreign_key: :department_id,
+    scope: -> { Goal.all },
+    resource: GoalResource
 end

app/resources/employee_resource.rb

@@ -1,15 +1,17 @@
 class EmployeeResource < ApplicationResource
   type :employees
 
+  allow_filter :id
+  allow_filter :department_id
   allow_filter :name
   allow_filter :age
 
   allow_filter :name_prefix do |scope, value|
     scope.where(["name LIKE ?", "#{value}%"])
   end
 
-  has_many :departments,
+  belongs_to :department,
     scope: -> { Department.all },
-    foreign_key: :employee_id,
+    foreign_key: :department_id,
     resource: DepartmentResource
 end

app/resources/goal_resource.rb

@@ -1,6 +1,8 @@
 class GoalResource < ApplicationResource
   type :goals
 
+  allow_filter :department_id
+
   belongs_to :department,
     scope: -> { Department.all },
     foreign_key: :department_id,

app/serializers/serializable_department.rb

@@ -3,6 +3,15 @@ class SerializableDepartment < JSONAPI::Serializable::Resource
 
   attribute :name
 
-  has_many :employees
-  has_many :goals
+  has_many :employees do
+    link :related do
+      @url_helpers.employees_url(filter: { department_id: @object.id })
+    end
+  end
+
+  has_many :goals do
+    link :related do
+      @url_helpers.goals_url(filter: { department_id: @object.id })
+    end
+  end
 end

app/serializers/serializable_employee.rb

@@ -3,5 +3,9 @@ class SerializableEmployee < JSONAPI::Serializable::Resource
 
   attributes :name, :age, :created_at, :updated_at
 
-  belongs_to :department
+  belongs_to :department do
+    link :related do
+      @url_helpers.department_url(@object.department_id)
+    end
+  end
 end

app/serializers/serializable_goal.rb

@@ -3,5 +3,9 @@ class SerializableGoal < JSONAPI::Serializable::Resource
 
   attribute :description
 
-  belongs_to :department
+  belongs_to :department do
+    link :related do
+      @url_helpers.department_url(@object.department_id)
+    end
+  end
 end

config/routes.rb

@@ -1,6 +1,7 @@
 Rails.application.routes.draw do
   scope path: '/api' do
     resources :employees
-    resources :departments, only: [:index]
+    resources :departments, only: [:index, :show]
+    resources :goals, only: [:index, :show]
   end
 end