api-response_builder 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f94d9f6432b2633b6770e26ab87ebd19fdb919761b7dcea2ed9885cf80973012
+  data.tar.gz: 6322f9a05cf5e372a249d827b444c4d44a07c82f9b10099c48f56ed57754167c
+SHA512:
+  metadata.gz: df5a399358707342ed4105b981bff36f13aee7575601719a06cfc2546169cdbde9cbaebdb3affd3c18d3f50c3ad8785129d13541d764d08248ddca1aad1196f3
+  data.tar.gz: 9afb01c0539ed5e7127c65cfabf046c32ff8c756b7a4624904e41b0753cf1a7e85ebf6c58bfbcffb88642f33d7412048acd00536b9ed2cfa78e0e1777ed57e69

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in api-response_builder.gemspec
+gemspec
+
+gem 'i18n', '~> 0.9.1'
+
+gem 'activerecord', '~> 5.0', '>= 5.0.0.1'
+
+gem 'active_model_serializers', '~> 0.10.7'
+
+# gem 'mysql2'

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    api-response_builder (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    active_model_serializers (0.10.7)
+      actionpack (>= 4.1, < 6)
+      activemodel (>= 4.1, < 6)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    case_transform (0.2)
+      activesupport
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    jsonapi-renderer (0.2.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    mysql2 (0.4.6)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_model_serializers (~> 0.10.7)
+  activerecord (~> 5.0, >= 5.0.0.1)
+  api-response_builder!
+  bundler (~> 1.16)
+  i18n (~> 0.9.1)
+  mysql2
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dass Mk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,350 @@
+# Api::ResponseBuilder
+
+Module to build response object for Rails 5 API Applications.
+Depends on `active_model_serializers` gem.
+
+Pass a valid / invalid ActiveRecord object or an instance of ActiveRecord::Relation and get response object in following structure.
+
+Properties | Description
+------------ | -------------
+status | 'failure' (or) 'success'
+body | Serialized Object
+messages | Error Description (if any)
+status_code | HTTP Status Code
+
+
+## Example
+
+```ruby
+#app/controllers/api/v1/application_controller.rb
+module Api
+  module V1
+    class ApplicationController < ActionController::API
+
+      def serializer_responder(resource, config = {})
+        response = ::Api::ResponseBuilder::Main.new(resource, config, params).response
+        render json: response, status: response[:status_code]
+      end
+
+    end
+  end
+end
+
+# app/serializers/v1/user_serializer.rb
+module V1
+  # Serializer for User model
+  class UserSerializer < ::ActiveModel::Serializer
+    attributes :id,
+      :firstname,
+      :lastname,
+      :phone_number,
+      :email
+  end
+end
+
+
+# app/controllers/api/v1/users_controller.rb
+module Api
+  module V1
+    # Defines endpoints for CRUD operations on user model
+    class UsersController < ::Api::V1::ApplicationController
+
+      def index
+        users = User.all
+        serializer_responder(users, serializer: ::V1::UserSerializer)
+      end
+
+    end
+  end
+end
+
+```
+
+Response Object for API endpoint `/api/v1/users` will be
+
+```json
+{
+  "status": "success", 
+  "body" :  
+    [
+      {
+        "id": 1,
+        "firstname": "Kalidas",
+        "lastname": "M",
+        "phone_number": "+919876543210",
+        "email": "kalidasm610@gmail.com"
+      },
+      {
+        "id": 2,
+        "firstname": "Dass",
+        "lastname": "Mk",
+        "phone_number": "+919876543211",
+        "email": ""
+      }
+    ],
+  "status_code": "ok"
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api-response_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-response_builder
+
+## Usage
+
+#### ApplicationController - Setup
+By taking advantage of Ruby's inheritance and Rails's app structure, few instance methods in application controller can be used to handle all scenarios for rendering json response across entire application.
+
+```ruby
+  module Api
+    module V1
+      class ApplicationController < ActionController::API
+        # action callbacks
+
+        # Global Exception Handler for Api Exceptions and StandardError
+        rescue_from ::Api::Exception, StandardError do |e|
+          handle_api_exception(e)
+        end
+
+        # Global exception handlers for ActiveRecord Exceptions
+        rescue_from ::ActiveRecord::RecordNotFound, with: :render_record_not_found
+        rescue_from ::ActiveRecord::RecordInvalid, with: :render_record_invalid
+        rescue_from ::ActiveRecord::RecordNotDestroyed, with: :render_forbidden
+
+        # Public methods
+        def handle_api_exception(e)
+          response = ::Api::ResponseBuilder::Main.new(e, {}, params).response
+          render json: response, status: response[:status_code]
+        end
+
+        def render_record_not_found
+          handle_api_exception ::Api::Exception.new(
+            ::Api::Exception.record_not_found
+          )
+        end
+
+        def render_internal_server_error
+          handle_api_exception ::Api::Exception.new(
+            ::Api::Exception.internal_server_error
+          )
+        end
+
+        def render_record_invalid(e)
+          # If exception message is not included in arguments, locale message
+          # (if present) for record invalid exception will be returned in resp
+          exception_message = e.record.errors.full_messages
+          exception = ::Api::Exception.new(
+            ::Api::Exception.record_invalid, exception_message
+          )
+          handle_api_exception(exception)
+        end
+
+        def render_forbidden
+          handle_api_exception ::Api::Exception.new(
+            ::Api::Exception.forbidden_resource
+          )
+        end
+
+        def serializer_responder(resource, config = {})
+          response = ::Api::ResponseBuilder::Main.new(resource, config, params).response
+          # response object also contains corresponding http status code under the key :status_code
+          # Including `Http Status Code` as part of API response is generally considered as good practice
+          # If all your api responses should have `200 OK` as status code, omit status key in render method
+          # Rails, by default, set status code as `200 OK`
+          render json: response, status: response[:status_code]
+        end
+      end
+    end
+  end
+
+```
+
+
+#### Passing Additional Information to Response
+
+In some cases, meta information may be passed along with response. For example, passing total count of resources for pagination.
+
+In order to pass meta info, include `:meta` key-value pair in config object passed to `::Api::ResponseBuilder::Main`.
+It will be reflected in response object under `meta` key
+
+Note: 
+  * config[:serializer] should be `ActiveModel::Serializer` class (if serializer is not passed, it will serialize entire object)
+  * `config[:meta]` will accept only hash
+
+
+```ruby
+  # app/controllers/api/v1/users_controller.rb
+  def index
+    users = User.all
+
+    config = {}
+    config[:serializer] = UserSerializer
+    config[:meta] = { total_count: users.count }
+    serializer_responder(users, config)
+  end
+
+  # simple way
+  serializer_responder(users, { serializer: UserSerializer, meta: { total_count: users.count } })
+```
+
+##### Response
+
+```json
+  {
+  "status": "success", 
+  "body" :  
+    [
+      {
+        "id": 1,
+        "firstname": "Kalidas",
+        "lastname": "M",
+        "phone_number": "+919876543210",
+        "email": "kalidasm610@gmail.com"
+      },
+      {
+        "id": 2,
+        "firstname": "Dass",
+        "lastname": "Mk",
+        "phone_number": "+919876543211",
+        "email": ""
+      }
+    ],
+  "status_code": "ok",
+  "meta": {
+    "total_count": 2
+  }
+}
+```
+
+
+#### API Exceptions
+
+Following exceptions are handled by this gem as there are the most commonly used.
+
+EXCEPTION | HTTP Status Code
+------------ | -------------
+INTERNAL_SERVER_ERROR | :internal_server_error (500)
+RECORD_NOT_FOUND | :not_found (404)
+RECORD_INVALID | ::unprocessable_entity (422)
+RECORD_NOT_DESTROYED | :forbidden (403)
+FORBIDDEN_RESOURCE | :forbidden (403)
+UNAUTHORIZED_ACCESS | :unauthorized (401)
+
+For futher information, take a look at the [Code](https://github.com/kalidasm/rails-api-response-builder/blob/master/lib/api/exception.rb)
+
+
+##### Error Messages for API Exceptions
+
+All the error messages for these exceptions are rendered from I18n locales (`en.api_response.messages.#{key}`)
+
+Key represents lower-cased version of exception names listed above
+
+Example :
+
+```yml
+  en:
+    api_response:
+      messages:
+        internal_server_error: "Internal server error."
+        record_not_found: "The resource you are looking for does not exist."
+        record_invalid: "Validation Failed"
+        record_not_destroyed: "Failed to delete the resource"
+        forbidden_resource: "You don't have sufficient privileges to perform this operation"
+        unauthorized_access: "You are not authorized to perform this operation"
+```
+
+##### Raising API Exception inside controllers
+
+```ruby
+  def update_credit_score
+    # code to authorization info for current user
+    unless user_authorized?
+      raise ::Api::Exception.new(
+        ::Api::Exception.unauthorized_access
+      )
+    end
+    # Code to Update the credit score
+  end
+```
+
+Response would be
+
+```json
+  {
+    "status": "failure",
+    "messages": {
+      "errors": ["You are not authorized to perform this operation"]
+    },
+    "status_code": "unprocessable_entity",
+    "meta": {}
+  }
+```
+
+If you want to override the default error message in a specific scenario,
+
+```ruby
+  def update_credit_score
+    # code to authorization info for current user
+    unless user_authorized?
+      custom_error_message = 'You are not allowed to update credit score'
+
+      raise ::Api::Exception.new(
+        ::Api::Exception.unauthorized_access, custom_error_message
+      )
+    end
+    # Code to Update the credit score
+  end
+```
+```json
+  {
+    "status": "failure",
+    "messages": {
+      "errors": ["You are not allowed to update credit score"]
+    },
+    "status_code": "unprocessable_entity",
+    "meta": {}
+  }
+```
+
+#### Response Status - Failure / Success
+
+Response Object contains a key named `status`. It will have only any one of
+  * failure
+  * success
+
+Status will be `failure` when
+  * Resource has any errors
+  * Resource is an instance of `::Api::Exception`
+  * StandardError is raised
+
+Status will be `success` when
+  * Resource do not have any errors
+  * Resource is *not* an instance of `::Api::Exception`
+  * No Exception been raised
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kalidasm/api-response_builder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api-response_builder.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "api/response_builder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "api-response_builder"
+  spec.version       = Api::ResponseBuilder::VERSION
+  spec.authors       = ["Dass Mk"]
+  spec.email         = ["kalidasm610@gmail.com"]
+
+  spec.summary       = %q{API Response Builder to keep controllers super-slim}
+  spec.description   = %q{API Response Builder to keep controllers super-slim}
+  spec.homepage      = "https://github.com/kalidasm/rails-api-response-builder"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "i18n", "~> 0.7.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api/response_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api/exception.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+# Base API exception class to create custom exceptions dynamically
+# with a code and message passed
+require 'i18n'
+
+module Api
+  class Exception < ::StandardError
+    attr_accessor :messages
+
+    def initialize(error_constant, messages = nil)
+      @error_constant = error_constant
+      @messages = {
+        @error_constant[:key].to_s => [messages || @error_constant[:message]]
+      }
+    end
+
+    def full_messages
+      @messages.values.flatten
+    end
+
+    def status_code
+      @error_constant[:status_code]
+    end
+
+    class << self
+      def error_constants
+        {
+          INTERNAL_SERVER_ERROR: {
+            message: t(:internal_server_error),
+            key: :internal_server_error,
+            status_code: :internal_server_error
+          },
+          RECORD_NOT_FOUND: {
+            message: t(:record_not_found),
+            key: :record_not_found,
+            status_code: :not_found
+          },
+          RECORD_INVALID: {
+            message: t(:record_invalid),
+            key: :record_invalid,
+            status_code: :unprocessable_entity
+          },
+          RECORD_NOT_DESTROYED: {
+            message: t(:record_not_destroyed),
+            key: :record_not_destroyed,
+            status_code: :forbidden
+          },
+          FORBIDDEN_RESOURCE: {
+            message: t(:forbidden_resource),
+            key: :forbidden_resource,
+            status_code: :forbidden
+          },
+          UNAUTHORIZED_ACCESS: {
+            message: t(:unauthorized_access),
+            key: :unauthorized_access,
+            status_code: :unauthorized
+          }
+        }
+      end
+
+      private
+
+      def t(key)
+        ::I18n.config.available_locales = :en
+        ::I18n.t("api_response.messages.#{key}")
+      end
+    end
+
+    error_constants.each do |key, value|
+      define_singleton_method(key.downcase) { value }
+    end
+  end
+end

data/lib/api/response_builder.rb

@@ -0,0 +1,15 @@
+require "api/response_builder/version"
+require "api/response_builder/base"
+require "api/response_builder/data"
+require "api/response_builder/main"
+require "api/response_builder/messages"
+require "api/response_builder/status"
+require "api/response_builder/status_code"
+require "api/exception"
+require "active_record"
+require "active_model_serializers"
+
+module Api
+  module ResponseBuilder
+  end
+end

data/lib/api/response_builder/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Api
+  module ResponseBuilder
+    # Base Class for building api response
+    class Base
+      attr_accessor :resource,
+        :config
+
+      def initialize(resource, config = {})
+        @resource = resource
+        @config = config
+      end
+
+      protected
+
+      def active_model_object?
+        @resource.is_a?(::ActiveRecord::Base)
+      end
+
+      def hash_object?
+        @resource.is_a?(Hash)
+      end
+
+      def resource_has_errors?
+        active_model_object? && @resource.errors.any?
+      end
+
+      def collection?
+        @resource.is_a?(::ActiveRecord::Relation) || @resource.is_a?(Array)
+      end
+
+      def exception?
+        @resource.is_a?(Exception)
+      end
+
+      def other_exception?
+        !api_exception? && @resource.is_a?(StandardError)
+      end
+
+      def api_exception?
+        @resource.is_a?(::Api::Exception)
+      end
+
+      def invalid_resource?
+        return @resource.errors.any? if active_model_object?
+        false
+      end
+    end
+  end
+end

data/lib/api/response_builder/data.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Api
+  module ResponseBuilder
+    # Class which helps in building api response body
+    class Data < ::Api::ResponseBuilder::Base
+      attr_accessor :data
+
+      def initialize(resource, config = {})
+        super(resource, config)
+        @data = nil
+        set_data
+      end
+
+      private
+
+      def set_data
+        return if exception?
+        set_object_data
+        set_collection_data
+      end
+
+      def set_collection_data
+        return unless collection?
+        @data = ::ActiveModel::Serializer::CollectionSerializer.
+          new(resource, config)
+      end
+
+      def set_object_data
+        return if invalid_resource?
+        serializer = config[:serializer]
+        @data = serializer ? serializer.new(resource, config) : resource
+      end
+    end
+  end
+end

data/lib/api/response_builder/main.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Api
+  module ResponseBuilder
+    # Class which helps in building whole api response
+    class Main
+      attr_accessor :resource,
+        :config,
+        :response,
+        :params
+
+      def initialize(resource, config = {}, params = {})
+        @resource = resource
+        @config = config
+        @response = {}
+        @params = params
+        set_response
+      end
+
+      def set_response
+        prepare_response
+        response_data = ::Api::ResponseBuilder::Data.new(resource, config).data
+        messages = ::Api::ResponseBuilder::Messages.new(resource, config).messages
+        status_code = ::Api::ResponseBuilder::StatusCode.new(resource, config).status_code
+
+        @response[:body] = response_data if response_data.present?
+        @response[:messages] = messages if messages.present?
+        @response[:status_code] = status_code
+        @response[:meta] = (config[:meta].to_h)
+      end
+
+      def prepare_response
+        status_msg = ::Api::ResponseBuilder::Status.new(resource, config).status_message
+        @response = status_msg.present? ? status_msg : {}
+      end
+    end
+  end
+end

data/lib/api/response_builder/messages.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Api
+  module ResponseBuilder
+    # Class which helps in building messges for api response
+    class Messages < ::Api::ResponseBuilder::Base
+      attr_accessor :messages
+
+      def initialize(resource, config = {})
+        super(resource, config)
+        @messages = {}
+        set_messages
+      end
+
+      private
+
+      def set_messages
+        add_errors_if_any
+        return unless other_exception?
+        exception = ::Api::Exception.internal_server_error
+        @messages[:errors] = ::Api::Exception.new(exception, resource.message).
+          full_messages
+      end
+
+      def add_errors_if_any
+        @messages[:errors] = resource.full_messages if api_exception?
+        return unless resource_has_errors?
+        @messages[:errors] = resource.errors.full_messages
+      end
+    end
+  end
+end

data/lib/api/response_builder/status.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Api
+  module ResponseBuilder
+    # Class which helps in building status of api response
+    class Status < ::Api::ResponseBuilder::Base
+      attr_accessor :status_message
+
+      def initialize(resource, config = {})
+        super(resource, config)
+        @status_message = { status: "success" }
+        set_status_message
+      end
+
+      private
+
+      def set_status_message
+        return unless resource_has_errors? || api_exception? || other_exception?
+        @status_message[:status] = "failure"
+      end
+    end
+  end
+end

data/lib/api/response_builder/status_code.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Api
+  module ResponseBuilder
+    # Class which helps in building status code of api response
+    class StatusCode < ::Api::ResponseBuilder::Base
+      attr_accessor :status_code,
+        :resource
+
+      def initialize(resource, config = {})
+        super(resource, config)
+        @resource = resource
+        @status_code = :ok
+        set_status_code
+      end
+
+      private
+
+      def set_status_code
+        return unless resource_has_errors? || api_exception? || other_exception?
+        if resource_has_errors?
+          @status_code = :unprocessable_entity
+        elsif api_exception?
+          # resource is an instance of ApiException class
+          @status_code = @resource.status_code
+        else
+          # other exception which is probably internal server error
+          @status_code = :internal_server_error
+        end
+      end
+    end
+  end
+end

data/lib/api/response_builder/version.rb

@@ -0,0 +1,5 @@
+module Api
+  module ResponseBuilder
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: api-response_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dass Mk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: API Response Builder to keep controllers super-slim
+email:
+- kalidasm610@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-response_builder.gemspec
+- bin/console
+- bin/setup
+- lib/api/exception.rb
+- lib/api/response_builder.rb
+- lib/api/response_builder/base.rb
+- lib/api/response_builder/data.rb
+- lib/api/response_builder/main.rb
+- lib/api/response_builder/messages.rb
+- lib/api/response_builder/status.rb
+- lib/api/response_builder/status_code.rb
+- lib/api/response_builder/version.rb
+homepage: https://github.com/kalidasm/rails-api-response-builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: API Response Builder to keep controllers super-slim
+test_files: []