azeroth 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4969648cf9b578079bc4d7baca012aa82768fd37edc9279ed2be606ef11b78b4
-  data.tar.gz: e426759bcab101a0ef02b0b9cc68d56d2cabc43fdea9a30027974dbaebf7a4e5
+  metadata.gz: d5495356a8fc2f5a5010cc8639e993a7c53ddf4bce282e7483c9c65368f7e913
+  data.tar.gz: dc31a2fb80a880d7d8228434d8364672bbca638c80ea5a1def52018d09f59e9c
 SHA512:
-  metadata.gz: 8848cd9189e14cb2ac4ce22b401b2d5c4d5a39af868a38c1746a9e05136018bbf42b5e071f4feff680b823ab70fc9f3320c60fb0b4c982dfee23a2621781bc0a
-  data.tar.gz: ed36e6cf227e30e6f37dbe8ca109ccfecda6f2747349a1c73e97cf7319af929785aeaa0ccb8ab08265d0524d58a39fbe6a3101f5e95cb1b39998879866f783d2
+  metadata.gz: 26105d0876fd07335e6eaed85c5b56318959bff5ecf8290fe1dcb1b6faca9971487cd7bf02295f2f093e0ae9cb91429cafd7af8d14cdc4a20b6ac2088b8a644a
+  data.tar.gz: 1e95b957ef01408897acba372e60532346ec0e51bcc9883c540b08f2b5276f9d8443e39c9cf699728634e3d626c8d735f6504c4a7afda2c416a9bc9066f2231f

data/README.md

@@ -11,4 +11,4 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.2.0](https://www.rubydoc.info/gems/azeroth/0.2.0)
+[https://www.rubydoc.info/gems/azeroth/0.3.0](https://www.rubydoc.info/gems/azeroth/0.3.0)

data/azeroth.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.name          = 'azeroth'
   gem.version       = Azeroth::VERSION
   gem.authors       = ['Darthjee']
-  gem.email         = ['dev@gmail.com']
+  gem.email         = ['darthjee@gmail.com']
   gem.summary       = 'Azeroth'
   gem.description   = gem.description
   gem.homepage      = 'https://github.com/darthjee/azeroth'

data/lib/azeroth/request_handler.rb

@@ -34,10 +34,11 @@ module Azeroth
     def process
       return unless json?
 
-      json = model.decorate(resource)
+      json            = model.decorate(resource)
+      response_status = status
 
       controller.instance_eval do
-        render(json: json)
+        render(json: json, status: response_status)
       end
     end
 
@@ -89,5 +90,19 @@ module Azeroth
     def resource
       raise 'must be implemented in subclass'
     end
+
+    # @private
+    #
+    # Response status
+    #
+    # For most requests, status is 200 (+:ok+)
+    #
+    # Must be implemented in subclasses that will handle
+    # status differently
+    #
+    # @return [Symbol]
+    def status
+      :ok
+    end
   end
 end

data/lib/azeroth/request_handler/create.rb

@@ -17,10 +17,26 @@ module Azeroth
       #
       # @return [Object]
       def resource
+        @resource ||= build_resource
+      end
+
+      def build_resource
         attributes = controller.send("#{model.name}_params")
         collection = controller.send(model.plural)
         collection.create(attributes)
       end
+
+      # @private
+      #
+      # Response status
+      #
+      # For success, returns +:created+, for
+      # validation errors, it returns +:unprocessable_entity+
+      #
+      # @return [Symbol]
+      def status
+        resource.valid? ? :created : :unprocessable_entity
+      end
     end
   end
 end

data/lib/azeroth/request_handler/update.rb

@@ -17,10 +17,27 @@ module Azeroth
       #
       # @return [Object]
       def resource
+        @resource ||= update_resource
+      end
+
+      def update_resource
         attributes = controller.send("#{model.name}_params")
-        resource = controller.send(model.name)
-        resource.update(attributes)
-        resource
+
+        controller.send(model.name).tap do |entry|
+          entry.update(attributes)
+        end
+      end
+
+      # @private
+      #
+      # Response status
+      #
+      # For success, returns +:ok+, for
+      # validation errors, it returns +:unprocessable_entity+
+      #
+      # @return [Symbol]
+      def status
+        resource.valid? ? :ok : :unprocessable_entity
       end
     end
   end

data/lib/azeroth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Azeroth
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/controllers/documents_controller_spec.rb

@@ -10,9 +10,7 @@ describe DocumentsController do
   describe 'GET index' do
     let(:documents_count) { 0 }
     let!(:documents) do
-      documents_count.times.map do
-        Document.create
-      end
+      documents_count.times.map { create(:document) }
     end
 
     let(:expected_json) do
@@ -53,7 +51,7 @@ describe DocumentsController do
   end
 
   describe 'GET show' do
-    let(:document)    { Document.create }
+    let(:document)    { create(:document) }
     let(:document_id) { document.id }
 
     let(:expected_json) do
@@ -99,12 +97,15 @@ describe DocumentsController do
   end
 
   describe 'POST create' do
+    let(:payload) do
+      {
+        name: 'My document'
+      }
+    end
     let(:parameters) do
       {
         format: format,
-        document: {
-          name: 'My document'
-        }
+        document: payload
       }
     end
 
@@ -130,23 +131,51 @@ describe DocumentsController do
           .to change(Document, :count).by(1)
       end
     end
+
+    context 'when there is validation error' do
+      let(:format)  { :json }
+      let(:payload) { { reference: 'x01' } }
+
+      let(:expected_json) do
+        Document::Decorator.new(Document.new(payload)).as_json
+      end
+
+      it do
+        post :create, params: parameters
+        expect(response).not_to be_successful
+      end
+
+      it 'returns created document json' do
+        post :create, params: parameters
+        expect(parsed_response).to eq(expected_json)
+      end
+
+      it do
+        expect { post :create, params: parameters }
+          .not_to change(Document, :count)
+      end
+    end
   end
 
   describe 'PATCH update' do
-    let(:document)    { Document.create }
+    let(:document)    { create(:document) }
     let(:document_id) { document.id }
 
     let(:expected_json) do
       Document::Decorator.new(Document.last).as_json
     end
 
+    let(:payload) do
+      {
+        name: 'My document'
+      }
+    end
+
     let(:parameters) do
       {
         id: document_id,
         format: :json,
-        document: {
-          name: 'My document'
-        }
+        document: payload
       }
     end
 
@@ -163,7 +192,7 @@ describe DocumentsController do
     it do
       expect { patch :update, params: parameters }
         .to change { document.reload.name }
-        .from(nil).to('My document')
+        .to('My document')
     end
 
     context 'when calling on an inexistent id' do
@@ -180,6 +209,30 @@ describe DocumentsController do
         expect(response.body).to eq('')
       end
     end
+
+    context 'when there is validation error' do
+      let(:format)  { :json }
+      let(:payload) { { name: nil } }
+
+      let(:expected_json) do
+        { 'name' => '' }
+      end
+
+      it do
+        post :create, params: parameters
+        expect(response).not_to be_successful
+      end
+
+      it 'returns created document json' do
+        post :create, params: parameters
+        expect(parsed_response).to eq(expected_json)
+      end
+
+      it 'does not update entry' do
+        expect { post :create, params: parameters }
+          .not_to(change { document.reload.name })
+      end
+    end
   end
 
   describe 'GET new' do
@@ -209,7 +262,7 @@ describe DocumentsController do
   end
 
   describe 'GET edit' do
-    let(:document)    { Document.create }
+    let(:document)    { create(:document) }
     let(:document_id) { document.id }
 
     context 'when calling on format json' do
@@ -255,7 +308,7 @@ describe DocumentsController do
   end
 
   describe 'DELETE destroy' do
-    let!(:document)   { Document.create }
+    let!(:document)   { create(:document) }
     let(:document_id) { document.id }
 
     let(:expected_json) do

data/spec/dummy/app/models/document.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 class Document < ActiveRecord::Base
+  validates :name, presence: true
 end

data/spec/dummy/app/models/document/decorator_with_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Document
+  class DecoratorWithError < Azeroth::Decorator
+    expose :name
+    expose :errors, if: :invalid?
+
+    def errors
+      object.errors.messages
+    end
+  end
+end

data/spec/lib/azeroth/decorator_spec.rb

@@ -112,6 +112,43 @@ describe Azeroth::Decorator do
         expect(decorator.as_json).to eq(expected_json)
       end
     end
+
+    context 'with decotator for model with validation' do
+      subject(:decorator) do
+        Document::DecoratorWithError.new(object)
+      end
+
+      context 'with valid model' do
+        let(:object) { build(:document) }
+
+        let(:expected_json) do
+          {
+            name: object.name
+          }.stringify_keys
+        end
+
+        it 'returns meta data defined json' do
+          expect(decorator.as_json).to eq(expected_json)
+        end
+      end
+
+      context 'with invalid model' do
+        let(:object) { build(:document, name: nil) }
+
+        let(:expected_json) do
+          {
+            name: nil,
+            errors: {
+              name: ["can't be blank"]
+            }
+          }.stringify_keys
+        end
+
+        it 'returns meta data defined json' do
+          expect(decorator.as_json).to eq(expected_json)
+        end
+      end
+    end
   end
 
   describe '#method_missing' do

data/spec/lib/azeroth/request_handler/create_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe Azeroth::RequestHandler::Create do
   describe '#process' do
-    it_behaves_like 'a request handler' do
+    it_behaves_like 'a request handler', status: :created do
       let(:extra_params) do
         {
           document: {
@@ -24,4 +24,26 @@ describe Azeroth::RequestHandler::Create do
       end
     end
   end
+
+  context 'when payload is invalid' do
+    it_behaves_like 'a request handler',
+                    status: :unprocessable_entity do
+      let(:extra_params) do
+        {
+          document: {
+            reference: 'my_reference'
+          }
+        }
+      end
+
+      let(:expected_json) do
+        { 'name' => nil }
+      end
+
+      it 'does not create entry' do
+        expect { handler.process }
+          .not_to change(Document, :count)
+      end
+    end
+  end
 end

data/spec/lib/azeroth/request_handler/update_spec.rb

@@ -4,9 +4,10 @@ require 'spec_helper'
 
 describe Azeroth::RequestHandler::Update do
   describe '#process' do
+    let!(:document) { create(:document) }
+
     it_behaves_like 'a request handler' do
       let(:expected_resource) { document }
-      let!(:document)         { create(:document) }
 
       let(:extra_params) do
         {
@@ -28,5 +29,29 @@ describe Azeroth::RequestHandler::Update do
           .to('New Name')
       end
     end
+
+    context 'when payload is invalid' do
+      it_behaves_like 'a request handler',
+                      status: :unprocessable_entity do
+        let(:expected_resource) { document }
+        let(:extra_params) do
+          {
+            id: document.id,
+            document: {
+              name: nil
+            }
+          }
+        end
+
+        let(:expected_json) do
+          { 'name' => nil }
+        end
+
+        it 'does not update entry' do
+          expect { handler.process }
+            .not_to(change { document.reload.name })
+        end
+      end
+    end
   end
 end

data/spec/lib/azeroth/request_handler_spec.rb

@@ -37,7 +37,7 @@ describe Azeroth::RequestHandler do
         .and_return(params)
 
       allow(controller).to receive(:render)
-        .with(json: expected_json)
+        .with(json: expected_json, status: :ok)
         .and_return(expected_json)
     end
 

data/spec/lib/azeroth/resource_builder_spec.rb

@@ -11,7 +11,7 @@ describe Azeroth::ResourceBuilder do
 
   before do
     resource_builder.append
-    10.times { Document.create }
+    create_list(:document, 10)
   end
 
   describe '#append' do
@@ -29,7 +29,7 @@ describe Azeroth::ResourceBuilder do
 
     describe 'after the build' do
       let(:controller) { klass.new(document_id: document.id) }
-      let(:document)   { Document.create }
+      let(:document)   { create(:document) }
 
       before { builder.build }
 

data/spec/lib/azeroth/routes_builder_spec.rb

@@ -31,13 +31,13 @@ describe Azeroth::RoutesBuilder do
   end
 
   before do
-    10.times { Document.create }
+    create_list(:document, 10)
 
     allow(controller).to receive(:params)
       .and_return(params)
 
     allow(controller).to receive(:render)
-      .with(json: expected_json)
+      .with(json: expected_json, status: :ok)
       .and_return(expected_json)
   end
 
@@ -61,7 +61,7 @@ describe Azeroth::RoutesBuilder do
         controller.index
 
         expect(controller).to have_received(:render)
-          .with(json: expected_json)
+          .with(json: expected_json, status: :ok)
       end
     end
   end

data/spec/support/shared_examples/request_handler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'a request handler' do
+shared_examples 'a request handler' do |status: :ok|
   subject(:handler) { described_class.new(controller, model) }
 
   let(:controller)      { controller_class.new }
@@ -27,7 +27,7 @@ shared_examples 'a request handler' do
       .and_return(params)
 
     allow(controller).to receive(:render)
-      .with(json: expected_json)
+      .with(json: expected_json, status: status)
       .and_return(expected_json)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -376,7 +376,7 @@ dependencies:
         version: 0.9.9
 description: ''
 email:
-- dev@gmail.com
+- darthjee@gmail.com
 executables:
 - test
 extensions: []
@@ -439,6 +439,7 @@ files:
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/document.rb
 - spec/dummy/app/models/document/decorator.rb
+- spec/dummy/app/models/document/decorator_with_error.rb
 - spec/dummy/app/models/dummy_model.rb
 - spec/dummy/app/models/dummy_model/decorator.rb
 - spec/dummy/app/models/user.rb
@@ -562,6 +563,7 @@ test_files:
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/document.rb
 - spec/dummy/app/models/document/decorator.rb
+- spec/dummy/app/models/document/decorator_with_error.rb
 - spec/dummy/app/models/dummy_model.rb
 - spec/dummy/app/models/dummy_model/decorator.rb
 - spec/dummy/app/models/user.rb