Merge pull request #1 from jsonapi-suite/new_compliable

New compliable

Author: richmolj

Gemfile

@@ -3,11 +3,13 @@ source 'https://rubygems.org'
 gem 'rails', '~> 5.0.0', '>= 5.0.0.1'
 gem 'sqlite3'
 gem 'puma', '~> 3.0'
-gem 'jsonapi_suite', '~> 0.1'
+gem 'jsonapi_suite', '~> 0.5'
+gem 'jsonapi-rails', '~> 0.1'
 gem 'kaminari', '~> 0.17'
-gem 'active_model_serializers',
-  git: 'https://github.com/richmolj/active_model_serializers.git',
-  branch: 'include_data_if_sideloaded'
+
+gem 'jsonapi-serializable',
+  git: 'https://github.com/jsonapi-rb/jsonapi-serializable.git',
+  branch: 'optim-1'
 
 group :development, :test do
   gem 'pry'

Gemfile.lock

@@ -1,12 +1,10 @@
 GIT
-  remote: https://github.com/richmolj/active_model_serializers.git
-  revision: 8700ac6124b8685b979b4a03570f71d498a18d36
-  branch: include_data_if_sideloaded
+  remote: https://github.com/jsonapi-rb/jsonapi-serializable.git
+  revision: c852bed5232c8853d62c188d4c796f2fc22b5b6c
+  branch: optim-1
   specs:
-    active_model_serializers (0.10.2)
-      actionpack (>= 4.1, < 6)
-      activemodel (>= 4.1, < 6)
-      jsonapi (~> 0.1.1.beta2)
+    jsonapi-serializable (0.1.1)
+      jsonapi-renderer (= 0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -34,6 +32,10 @@ GEM
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    active_model_serializers (0.10.3)
+      actionpack (>= 4.1, < 6)
+      activemodel (>= 4.1, < 6)
+      jsonapi (= 0.1.1.beta2)
     activejob (5.0.0.1)
       activesupport (= 5.0.0.1)
       globalid (>= 0.3.6)
@@ -60,31 +62,34 @@ GEM
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
-    json (1.8.3)
+    json (1.8.6)
     jsonapi (0.1.1.beta2)
       json (~> 1.8)
-    jsonapi_ams_extensions (0.1.1)
-      active_model_serializers (~> 0.10.x)
-    jsonapi_compliable (0.3.5)
-      active_model_serializers (~> 0.10)
-      jsonapi (~> 0.1.1.beta2)
-      jsonapi_ams_extensions (~> 0.1)
-      rails (>= 4.1, < 6)
+    jsonapi-deserializable (0.1.1)
+      jsonapi-parser (= 0.1.1)
+    jsonapi-parser (0.1.1)
+    jsonapi-rails (0.1.1)
+      jsonapi-rb (= 0.1.1)
+    jsonapi-rb (0.1.1)
+      jsonapi-deserializable (= 0.1.1)
+      jsonapi-serializable (= 0.1.1)
+    jsonapi-renderer (0.1.1)
+    jsonapi_compliable (0.5.2)
+      jsonapi-serializable (~> 0.1)
     jsonapi_errorable (0.1.1)
       active_model_serializers (~> 0.10)
       rails (>= 4.1, < 6)
-    jsonapi_spec_helpers (0.2.1)
-    jsonapi_suite (0.1.2)
-      active_model_serializers (~> 0.10.x)
-      jsonapi_ams_extensions (~> 0.1)
-      jsonapi_compliable (~> 0.3)
+    jsonapi_spec_helpers (0.2.3)
+    jsonapi_suite (0.5.1)
+      jsonapi (= 0.1.1.beta2)
+      jsonapi_compliable (~> 0.5)
       jsonapi_errorable (~> 0.1)
       jsonapi_spec_helpers (~> 0.2)
       jsonapi_swagger_helpers (~> 0.1)
       nested_attribute_reassignable (~> 0.6)
       rails (>= 4.1, < 6)
       strong_resources (~> 0.1)
-    jsonapi_swagger_helpers (0.1.2)
+    jsonapi_swagger_helpers (0.1.5)
       swagger-blocks (~> 1.3)
     kaminari (0.17.0)
       actionpack (>= 3.0.0)
@@ -177,12 +182,12 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.3.11)
-    strong_resources (0.1.1)
+    strong_resources (0.1.6)
       rails (>= 4.1, < 6.0)
       stronger_parameters (~> 2.6)
     stronger_parameters (2.6.0)
       actionpack (>= 3.2, < 5.1)
-    swagger-blocks (1.3.4)
+    swagger-blocks (1.4.0)
     thor (0.19.1)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
@@ -195,9 +200,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  active_model_serializers!
   database_cleaner (~> 1.5)
-  jsonapi_suite (~> 0.1)
+  jsonapi-rails (~> 0.1)
+  jsonapi-serializable!
+  jsonapi_suite (~> 0.5)
   kaminari (~> 0.17)
   listen (~> 3.0.5)
   pry
@@ -211,4 +217,4 @@ DEPENDENCIES
   tzinfo-data
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

app/controllers/departments_controller.rb

@@ -1,8 +1,13 @@
 class DepartmentsController < ApplicationController
-  jsonapi { }
+  jsonapi resource: DepartmentResource
 
   def index
     departments = Department.all
-    render_ams(departments)
+    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/employees_controller.rb

@@ -1,17 +1,5 @@
 class EmployeesController < ApplicationController
-  jsonapi do
-    allow_filter :name
-    allow_filter :age
-
-    allow_filter :name_prefix do |scope, value|
-      scope.where(["name LIKE ?", "#{value}%"])
-    end
-
-    includes whitelist: {
-      index: :department,
-      show: { department: :goals }
-    }
-  end
+  jsonapi resource: EmployeeResource
 
   before_action :deserialize_jsonapi!, only: [:create, :update]
 
@@ -21,19 +9,19 @@ class EmployeesController < ApplicationController
 
   def index
     employees = Employee.all
-    render_ams(employees)
+    render_jsonapi(employees)
   end
 
   def show
-    employee = jsonapi_scope(Employee.all).find(params[:id])
-    render_ams(employee)
+    employee = jsonapi_scope(Employee.where(id: params[:id]))
+    render_jsonapi(employee.resolve.first, scope: false)
   end
 
   def create
     employee = Employee.new(strong_resource)
 
     if employee.save
-      render_ams(employee)
+      render_jsonapi(employee, scope: false)
     else
       render_errors_for(employee)
     end
@@ -43,7 +31,7 @@ def update
     employee = Employee.find(params[:id])
 
     if employee.update_attributes(strong_resource)
-      render_ams(employee, scope: false)
+      render_jsonapi(employee, scope: false)
     else
       render_errors_for(employee)
     end
@@ -52,6 +40,6 @@ def update
   def destroy
     employee = Employee.find(params[:id])
     employee.destroy
-    render_ams(employee)
+    render_jsonapi(employee, 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/application_resource.rb

@@ -0,0 +1,3 @@
+class ApplicationResource < JsonapiCompliable::Resource
+  use_adapter JsonapiCompliable::Adapters::ActiveRecord
+end

app/resources/department_resource.rb

@@ -0,0 +1,15 @@
+class DepartmentResource < ApplicationResource
+  type :departments
+
+  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

@@ -0,0 +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
+
+  belongs_to :department,
+    scope: -> { Department.all },
+    foreign_key: :department_id,
+    resource: DepartmentResource
+end

app/resources/goal_resource.rb

@@ -0,0 +1,10 @@
+class GoalResource < ApplicationResource
+  type :goals
+
+  allow_filter :department_id
+
+  belongs_to :department,
+    scope: -> { Department.all },
+    foreign_key: :department_id,
+    resource: DepartmentResource
+end

app/serializers/application_serializer.rb

@@ -0,0 +1,17 @@
+class SerializableDepartment < JSONAPI::Serializable::Resource
+  type 'departments'
+
+  attribute :name
+
+  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/department_serializer.rb

@@ -0,0 +1,11 @@
+class SerializableEmployee < JSONAPI::Serializable::Resource
+  type 'employees'
+
+  attributes :name, :age, :created_at, :updated_at
+
+  belongs_to :department do
+    link :related do
+      @url_helpers.department_url(@object.department_id)
+    end
+  end
+end

app/serializers/employee_serializer.rb

@@ -0,0 +1,11 @@
+class SerializableGoal < JSONAPI::Serializable::Resource
+  type 'goals'
+
+  attribute :description
+
+  belongs_to :department do
+    link :related do
+      @url_helpers.department_url(@object.department_id)
+    end
+  end
+end

app/serializers/goal_serializer.rb

@@ -44,4 +44,8 @@
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
   config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  routes.default_url_options = {
+    host: 'localhost:3000'
+  }
 end

app/serializers/serializable_department.rb

@@ -0,0 +1 @@
+require 'jsonapi_compliable/adapters/active_record'

app/serializers/serializable_employee.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

app/serializers/serializable_goal.rb

@@ -8,6 +8,7 @@
       delete "/api/employees/#{employee.id}"
     }.to change { Employee.count }.from(1).to(0)
     expect(response.status).to eq(200)
+
     assert_payload(:employee, employee, json_item)
   end
 end