Add jsonapi_destroy (#65)

Author: richmolj

gemfiles/rails_4.gemfile

@@ -3,15 +3,15 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.1"
-gem "jsonapi-rails", "~> 0.3.1", require: "jsonapi/rails"
+gem "jsonapi-rails", "~> 0.3.1", :require => "jsonapi/rails"
 gem "rspec-rails"
 
 group :test do
   gem "pry"
-  gem "pry-byebug", platform: [:mri]
+  gem "pry-byebug", :platform => [:mri]
   gem "appraisal"
   gem "guard"
   gem "guard-rspec"
 end
 
-gemspec path: "../"
+gemspec :path => "../"

gemfiles/rails_5.gemfile

@@ -3,15 +3,15 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.0"
-gem "jsonapi-rails", "~> 0.3.1", require: "jsonapi/rails"
+gem "jsonapi-rails", "~> 0.3.1", :require => "jsonapi/rails"
 gem "rspec-rails"
 
 group :test do
   gem "pry"
-  gem "pry-byebug", platform: [:mri]
+  gem "pry-byebug", :platform => [:mri]
   gem "appraisal"
   gem "guard"
   gem "guard-rspec"
 end
 
-gemspec path: "../"
+gemspec :path => "../"

lib/generators/jsonapi/templates/controller.rb.erb

@@ -79,13 +79,17 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
   <%- end -%>
   <%- if actions?('destroy') -%>
   <%- unless omit_comments? -%>
-  # No need for any special logic here as no_content is jsonapi_compliant.
-  # Customize this if you have a more complex use case.
+  # Renders 200 OK with empty meta
+  # http://jsonapi.org/format/#crud-deleting-responses-200
   <%- end -%>
   def destroy
-    <%= file_name %> = <%= model_klass %>.find(params[:id])
-    <%= file_name %>.destroy
-    return head(:no_content)
+    <%= file_name %>, success = jsonapi_destroy.to_a
+
+    if success
+      render_jsonapi(<%= file_name %>, scope: false)
+    else
+      render_errors_for(<%= file_name %>)
+    end
   end
   <%- end -%>
 end

lib/jsonapi_compliable/base.rb

@@ -226,6 +226,12 @@ def jsonapi_update
       end
     end
 
+    def jsonapi_destroy
+      _persist do
+        jsonapi_resource.destroy(params[:id])
+      end
+    end
+
     # Similar to +render :json+ or +render :jsonapi+
     #
     # By default, this will "build" the scope via +#jsonapi_scope+. To avoid

lib/jsonapi_compliable/deserializer.rb

@@ -207,10 +207,18 @@ def process_relationship_datum(datum)
   end
 
   def raw_attributes
-    data[:attributes] || {}
+    if data
+      data[:attributes] || {}
+    else
+      {}
+    end
   end
 
   def raw_relationships
-    data[:relationships] || {}
+    if data
+      data[:relationships] || {}
+    else
+      {}
+    end
   end
 end

spec/fixtures/employee_directory.rb

@@ -74,15 +74,34 @@ class HomeOffice < ApplicationRecord
 end
 
 class Employee < ApplicationRecord
+  attr_accessor :force_validation_error
+
   belongs_to :workspace, polymorphic: true
   belongs_to :classification
   has_many :positions
   validates :first_name, presence: true
+  validates :delete_confirmation,
+    presence: true,
+    on: :destroy
 
   has_many :employee_teams
   has_many :teams, through: :employee_teams
 
   has_one :salary
+
+  before_destroy do
+    add_validation_error if force_validation_error
+
+    if Rails::VERSION::MAJOR >= 5
+      throw(:abort) if errors.present?
+    else
+      errors.blank?
+    end
+  end
+
+  def add_validation_error
+    errors.add(:base, 'Forced validation error')
+  end
 end
 
 class Position < ApplicationRecord

spec/integration/rails/persistence_spec.rb

@@ -37,9 +37,13 @@ def update
       end
 
       def destroy
-        employee = Employee.find(params[:id])
-        employee.destroy
-        render_jsonapi(employee, scope: false)
+        employee, success = jsonapi_destroy.to_a
+
+        if success
+          render json: { meta: {} }
+        else
+          render json: { error: employee.errors }
+        end
       end
     end
 
@@ -135,17 +139,37 @@ def do_put(id)
     end
 
     describe 'basic destroy' do
-      let(:employee) { Employee.create!(first_name: 'Joe') }
+      let!(:employee) { Employee.create!(first_name: 'Joe') }
+
+      before do
+        allow_any_instance_of(Employee)
+          .to receive(:force_validation_error) { force_validation_error }
+      end
+
+      let(:force_validation_error) { false }
 
       it 'deletes the object' do
-        delete :destroy, params: { id: employee.id }
+        expect {
+          delete :destroy, params: { id: employee.id }
+        }.to change { Employee.count }.by(-1)
         expect { employee.reload }.to raise_error(ActiveRecord::RecordNotFound)
       end
 
-      it 'responds with object' do
+      it 'responds with 200, empty meta' do
         delete :destroy, params: { id: employee.id }
-        expect(json_item['id']).to eq(employee.id.to_s)
-        expect(json_item['first_name']).to eq('Joe')
+        expect(response.status).to eq(200)
+        expect(json).to eq({ 'meta' => {} })
+      end
+
+      context 'when validation errors' do
+        let(:force_validation_error) { true }
+
+        it 'responds with correct error payload' do
+          expect {
+            delete :destroy, params: { id: employee.id }
+          }.to_not change { Employee.count }
+          expect(json['error']).to eq('base' => ['Forced validation error'])
+        end
       end
     end