resting_pug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7d99d102f6977a7fce1ac74ae7b1489d95273d7
+  data.tar.gz: ba714667deb6cfc2bc48a39085bf1f18a2954845
+SHA512:
+  metadata.gz: 062416d0fe7ee490e6ddd9cfb7b7b3fe8cd94d738a5579e0d8801794dd940012a9c3ccf456b223e42a2d41cc4c5f82d0d61857c7d62663378748fff484e9f487
+  data.tar.gz: ebb18d667055f77993629cb8320920e410fed4b221dde060ab0709a267ceb11d46701ad1e168bf70708ac88e2c478a69e06b127ef6dab818d71520dc9007356b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Slava Korolev
+
+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,54 @@
+
+<h1 align="center">
+  <br>
+  <a href="https://korolvs.github.com/resting_pug"><img src="https://korolvs.github.com/resting_pug/resting_pug.png" alt="Markdownify" width="80%"></a>
+  <br>
+</h1>
+
+# Basic Overview
+Resting Pug allows you to create a JSON API with just adding one line to your controller and fully customize it with overriding small and simple helper methods.
+
+## Usage
+Include ```RestingPug::Base``` into controller to add CRUD actions to it:
+
+```ruby
+class BooksController < ApplicationController
+  include RestingPug::Base
+end
+```
+
+You can add CRUD actions to all controllers by including this module into ```ApplicationController```:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include RestingPug::Base
+end
+```
+
+Don't forget to add a route to ```config/routes.rb``` 
+
+```ruby
+Rails.application.routes.draw do
+  resources :books
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resting_pug'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Logo is [Designed by Freepik](https://www.freepik.com/free-vector/happy-pug-resting-on-the-sofa_1357299.htm)

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RestingPug'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/resting_pug.rb

@@ -0,0 +1,4 @@
+require "resting_pug/base"
+
+module RestingPug
+end

data/lib/resting_pug/actions.rb

@@ -0,0 +1,168 @@
+module RestingPug
+  # Describes basic CRUD actions
+  # @see https://en.wikipedia.org/wiki/Create,_read,_update_and_delete
+  # @used_in {Base.included}
+  module Actions
+    # Creates a subject with attributes from params and returns it.
+    # @example
+    #   Request:
+    #   POST http://your.awesome/api/books
+    #   {
+    #     "name": "11/22/63",
+    #     "author": "Stephen King"
+    #   }
+    #
+    #   Response:
+    #   200 OK
+    #   {
+    #     "book": {
+    #       "id": 1,
+    #       "name": "11/22/63",
+    #       "author": "Stephen King"
+    #     }
+    #   }
+    # @note You can sustomize creating action:
+    #   - override {Subject#subject_model} to set what model will be created
+    #   - override {Chains#create_chain} to add or remove methods which will be called while creating a subject
+    #   - override {Params#permitted_fields_for_create} to set which params can be set in a new subject
+    #   - override {Params#permitted_fields_for_show} to set which params will be shown in response
+    #   - override {Render#decide_what_to_render} to set how it will be decided what to render in response
+    #   - override {Render#render_subject} to set how subject will be rendered
+    #   - override {Render#render_errors} to set how errors will be rendered
+    # @use {#run_chain}
+    # @use {Chains#create_chain}
+    def create
+      run_chain(create_chain)
+    end
+
+    # Updates a subject by id with attributes from params and returns it.
+    # @example
+    #   Request:
+    #   PATCH http://your.awesome/api/books/1
+    #   {
+    #     "name": "The Green Mile",
+    #   }
+    #
+    #   Response:
+    #   200 OK
+    #   {
+    #     "book": {
+    #       "id": 1,
+    #       "name": "The Green Mile",
+    #       "author": "Stephen King"
+    #     }
+    #   }
+    # @note You can sustomize creating action:
+    #   - override {Subject#subject_model} to set what model will be updated
+    #   - override {Chains#update_chain} to add or remove methods which will be called while updating a subject
+    #   - override {Params#permitted_fields_for_update} to set which params can be updated
+    #   - override {Params#permitted_fields_for_show} to set which params will be shown in response
+    #   - override {Render#decide_what_to_render} to set how it will be decided what to render in response
+    #   - override {Render#render_subject} to set how subject will be rendered
+    #   - override {Render#render_errors} to set how errors will be rendered
+    #   - override {Render#render_not_found} to set what to render when subject with ID from params is not found
+    # @use {#run_chain}
+    # @use {Chains#update_chain}
+    def update
+      run_chain(update_chain)
+    end
+
+    # Destroys a subject by id
+    # @example
+    #   Request:
+    #   DELETE http://your.awesome/api/books/1
+    #
+    #   Response:
+    #   204 No Content
+    # @note You can sustomize creating action:
+    #   - override {Subject#subject_model} to set what model will be deleted
+    #   - override {Chains#destroy_chain} to add or remove methods which will be called while deleting a subject
+    #   - override {Subject#destroy_subject} to set how it will be destroyed
+    #   - override {Render#render_nothing} to set what to render when subject is destroyed
+    #   - override {Render#render_errors} to set how errors will be rendered
+    #   - override {Render#render_not_found} to set what to render when subject with ID from params is not found
+    # @use {#run_chain}
+    # @use {Chains#destroy_chain}
+    def destroy
+      run_chain(destroy_chain)
+    end
+
+    # Shows a subject by id
+    # @example
+    #   Request:
+    #   GET http://your.awesome/api/books/1
+    #
+    #   Response:
+    #   200 OK
+    #   {
+    #     "book": {
+    #       "id": 1,
+    #       "name": "The Green Mile",
+    #       "author": "Stephen King"
+    #     }
+    #   }
+    # @note You can sustomize creating action:
+    #   - override {Subject#subject_model} to set what model will be shown
+    #   - override {Chains#show_chain} to add or remove methods which will be called while updating a subject
+    #   - override {Params#permitted_fields_for_show} to set which params will be shown in response
+    #   - override {Render#render_subject} to set how subject will be rendered
+    #   - override {Render#render_not_found} to set what to render when subject with ID from params is not found
+    # @use {#run_chain}
+    # @use {Chains#show_chain}
+    def show
+      run_chain(show_chain)
+    end
+
+    # Shows a list of subjects.
+    # You can filter subjects by attributes using *filter* param.
+    # You can sort subjects using *sort* param. It is a string of comma-separated attributes with minus before attributes you wants to sort descending.
+    # You can paginate subjcts with *page* and *per_page* params.
+    # @example
+    #   Request:
+    #   GET http://your.awesome/api/books
+    #   GET http://your.awesome/api/books?filter[author]="King"
+    #   GET http://your.awesome/api/books?filter[author][]="King"&filter[author][]="Kesey"
+    #   GET http://your.awesome/api/books?sort=-id,name,-author
+    #   GET http://your.awesome/api/books?page=3&per_page=10
+    #   GET http://your.awesome/api/books?filter[author]="King"&sort=-id?page=3&per_page=10
+    #
+    #   Response:
+    #   200 OK
+    #   {
+    #     "books": [{
+    #       "id": 2,
+    #       "name": "The Green Mile",
+    #       "author": "Stephen King"
+    #     }, {
+    #       "id": 1,
+    #       "name": "11/22/63",
+    #       "author": "Stephen King"
+    #     }]
+    #   }
+    # @note You can sustomize creating action:
+    #   - override {Subject#subject_model} to set what model will be shown
+    #   - override {Chains#index_chain} to add or remove methods which will be called while updating a subject
+    #   - override {Params#permitted_fields_for_show} to set which params will be shown in response
+    #   - override {Params#permitted_fields_for_filter} to set which params can be used for filtering
+    #   - override {Params#permitted_fields_for_sort} to set which params can be used for sorting
+    #   - override {Params#default_sort_params} to set default sort params
+    #   - override {Params#per_page_default} to set default per_page param
+    #   - override {Params#per_page_range} to set minimum and maximum possible per_page value
+    #   - override {Render#render_subjects} to set how subjects will be rendered
+    # @use {#run_chain}
+    # @use {Chains#index_chain}
+    def index
+      run_chain(index_chain)
+    end
+
+    protected
+
+    # Executes each method in a chain one by one
+    # @param chain [Array] array of methods to execute
+    def run_chain(chain)
+      chain.each do |action|
+        self.send(action)
+      end
+    end
+  end
+end

data/lib/resting_pug/base.rb

@@ -0,0 +1,28 @@
+require_relative './actions'
+require_relative './chains'
+require_relative './render'
+require_relative './subject'
+require_relative './params'
+require_relative './modificators'
+require 'will_paginate/active_record'
+
+module RestingPug
+  # Main module
+  module Base
+    # Includes all methods in controller
+    # @param base [ActionController::Base]
+    def self.included(base)
+      base.class_eval do
+        include RestingPug::Actions
+        include RestingPug::Chains
+        include RestingPug::Render
+        include RestingPug::Subject
+        include RestingPug::Params
+        include RestingPug::Modificators
+
+        rescue_from ActionController::ParameterMissing, with: :render_param_missing
+        rescue_from ActiveRecord::RecordNotFound, with: :render_not_found
+      end
+    end
+  end
+end

data/lib/resting_pug/chains.rb

@@ -0,0 +1,56 @@
+module RestingPug
+  # Describes chains of methods for actions. Each chain is an array of methods running one by one.
+  # @used_in {Base.included}
+  module Chains
+    protected
+
+    # Creates a chain of methods for creating a subject
+    # @note Override this method to add or remove methods executed while creating a subject
+    # @used_in {Actions#create}
+    # @use {Subject#create_subject}
+    # @use {Render#decide_what_to_render}
+    def create_chain
+      [:create_subject, :decide_what_to_render]
+    end
+
+    # Creates a chain of methods for updating a subject
+    # @note Override this method to add or remove methods executed while updating a subject
+    # @used_in {Actions#update}
+    # @use {Subject#fetch_subject}
+    # @use {Subject#update_subject}
+    # @use {Render#decide_what_to_render}
+    def update_chain
+      [:fetch_subject, :update_subject, :decide_what_to_render]
+    end
+
+    # Creates a chain of methods for deleting a subject
+    # @note Override this method to add or remove methods executed while deleting a subject
+    # @used_in {Actions#destroy}
+    # @use {Subject#fetch_subject}
+    # @use {Subject#destroy_subject}
+    def destroy_chain
+      [:fetch_subject, :destroy_subject]
+    end
+
+    # Creates a chain of methods for showing a subject
+    # @note Override this method to add or remove methods executed while showing a subject
+    # @used_in {Actions#show}
+    # @use {Subject#fetch_subject}
+    # @use {Render#render_subject}
+    def show_chain
+      [:fetch_subject, :render_subject]
+    end
+
+    # Creates a chain of methods for showing a list of subjects
+    # @note Override this method to add or remove methods executed while showing a list of subjects
+    # @used_in {Actions#index}
+    # @use {Subject#fetch_subjects}
+    # @use {Modificators#filter_subjects}
+    # @use {Modificators#sort_subjects}
+    # @use {Modificators#paginate_subjects}
+    # @use {Render#render_subjects}
+    def index_chain
+      [:fetch_subjects, :filter_subjects, :sort_subjects, :paginate_subjects, :render_subjects]
+    end
+  end
+end

data/lib/resting_pug/modificators.rb

@@ -0,0 +1,31 @@
+module RestingPug
+  # Describes methods which modificate subject/subjects
+  # @used_in {Base.included}
+  module Modificators
+    protected
+
+    # Selects certain page from all subjects using pagination params
+    # @note Override this method to change pagination of subjects
+    # @used_in {Chains#index_chain}
+    # @use {Params#pagination_params}
+    def paginate_subjects
+      @subjects = @subjects.paginate(page: pagination_params[:page], per_page: pagination_params[:per_page])
+    end
+
+    # Sorts subjects using sorting params
+    # @note Override this method to change sorting of subjects
+    # @used_in {Chains#index_chain}
+    # @use {Params#sort_params}
+    def sort_subjects
+      @subjects = @subjects.order(sort_params)
+    end
+
+    # Filters subjects using filter params
+    # @note Override this method to change how subjects are filtered
+    # @used_in {Chains#index_chain}
+    # @use {Params#pagination_params}
+    def filter_subjects
+      @subjects = @subjects.where(filter_params)
+    end
+  end
+end

data/lib/resting_pug/params.rb

@@ -0,0 +1,189 @@
+module RestingPug
+  # Describes transformations with params
+  # @used_in {Base.included}
+  module Params
+    protected
+
+    ### PERMITTED FIELDS
+
+    # Returns an array with all fields that API can use
+    # @note Override this method to add or remove fields that you don't want API to use.
+    # @return [Array] of symbols representing attributes
+    # @used_in {#permitted_fields_for_show}
+    # @used_in {#permitted_fields_for_create}
+    # @used_in {#permitted_fields_for_update}
+    # @used_in {#permitted_fields_for_sort}
+    # @used_in {#permitted_fields_for_filter}
+    # @use {Subject#subject_model}
+    def permitted_fields
+      subject_model.column_names.map(&:to_sym)
+    end
+
+    # Returns an array with all fields that API will show
+    # @note Override this method to add or remove fields that you don't want API to show.
+    # @return [Array] of symbols representing attributes
+    # @used_in {Render#render_subject}
+    # @used_in {Render#render_subjects}
+    # @use {#permitted_fields}
+    def permitted_fields_for_show
+      permitted_fields
+    end
+
+    # Returns an array with all fields that API will allow to use while creating a subject
+    # @note Override this method to add or remove fields that you don't want API to use for creating.
+    # @return [Array] of symbols representing attributes
+    # @used_in {#params_for_create}
+    # @use {#permitted_fields}
+    def permitted_fields_for_create
+      permitted_fields - [:id, :created_at, :updated_at]
+    end
+
+    # Returns an array with all fields that API will allow to use while updating a subject
+    # @note Override this method to add or remove fields that you don't want API to use for updating.
+    # @return [Array] of symbols representing attributes
+    # @used_in {#params_for_update}
+    # @use {#permitted_fields}
+    def permitted_fields_for_update
+      permitted_fields - [:id, :created_at, :updated_at]
+    end
+
+    # Returns an array with all fields that API will allow to use while sorting subjects
+    # @note Override this method to add or remove fields that you don't want API to use for sorting.
+    # @return [Array] of symbols representing attributes
+    # @used_in {#sort_params}
+    # @use {#permitted_fields}
+    def permitted_fields_for_sort
+      permitted_fields
+    end
+
+    # Returns an array with all fields that API will allow to use while filtering subjects by single value
+    # @note Override this method to add or remove fields that you don't want API to use for filtering by single value.
+    #   If you want to change attributes that can be filtered by arrays of values check {#permitted_fields_for_filter_arrays}
+    # @return [Array] of symbols representing attributes
+    # @used_in {#permitted_fields_for_filter_arrays}
+    # @used_in {#permitted_fields_for_filter_with_arrays}
+    # @use {#permitted_fields}
+    def permitted_fields_for_filter
+      permitted_fields - [:created_at, :updated_at]
+    end
+
+    # Returns an array with all fields that API will allow to use while filtering subjects by array of values
+    # @note Override this method to add or remove fields that you don't want API to use for filtering by array of values.
+    #   If you want to change attributes that can be filtered by single value check {#permitted_fields_for_filter}
+    # @return [Array] of symbols representing attributes
+    # @used_in {#permitted_fields_for_filter_with_arrays}
+    # @use {#permitted_fields_for_filter}
+    def permitted_fields_for_filter_arrays
+      permitted_fields_for_filter.map { |field| { field => [] } }
+    end
+
+    # Returns an array with all fields that API will allow to use while filtering subjects both by single values and by array of values
+    # @note To set fields that can be used check {#permitted_fields_for_filter} and {#permitted_fields_for_filter_arrays}
+    # @return [Array] of symbols representing attributes
+    # @used_in {#filter_params}
+    # @use {#permitted_fields_for_filter}
+    # @use {#permitted_fields_for_filter_arrays}
+    def permitted_fields_for_filter_with_arrays
+      permitted_fields_for_filter + permitted_fields_for_filter_arrays
+    end
+
+    # PARAMS
+
+    # Returns strong parameters which are used in creating action
+    # @note Override {#permitted_fields_for_create} to set allowed fields.
+    #   Override {Subject#subject_model_sym} to change the root attrubute of params.
+    # @see http://guides.rubyonrails.org/action_controller_overview.html#strong-parameters
+    # @used_in {Subject#create_subject}
+    # @use {Subject#subject_model_sym}
+    # @use {#permitted_fields_for_create}
+    def params_for_create
+      params.require(subject_model_sym).permit(permitted_fields_for_create)
+    end
+
+    # Returns strong parameters which are used in updating action
+    # @note Override {#permitted_fields_for_update} to set allowed fields.
+    #   Override {Subject#subject_model_sym} to change the root attrubute of params.
+    # @see http://guides.rubyonrails.org/action_controller_overview.html#strong-parameters
+    # @used_in {Subject#update_subject}
+    # @use {Subject#subject_model_sym}
+    # @use {#permitted_fields_for_update}
+    def params_for_update
+      params.require(subject_model_sym).permit(permitted_fields_for_update)
+    end
+
+    # FILTERING
+
+    # Returns strong parameters which are used for filtering subjects
+    # @note Override {#permitted_fields_for_filter} and {permitted_fields_for_filter_arrays} to set allowed fields.
+    # @see http://guides.rubyonrails.org/action_controller_overview.html#strong-parameters
+    # @used_in {Modificators#filter_subjects}
+    # @use {#permitted_fields_for_filter_with_arrays}
+    def filter_params
+      params[:filter] ? params.require(:filter).permit(permitted_fields_for_filter_with_arrays) : nil
+    end
+
+    # SORT
+
+    # Transforms a string like "-id,name" to a hash { id: :desc, name: :asc }
+    # @note Override {#permitted_fields_for_sort} to set allowed fields to sort.
+    #   Override {#default_sort_params} to set default sort params.
+    # @used_in {Modificators#sort_subjects}
+    # @use {#permitted_fields_for_sort}
+    # @use {#default_sort_params}
+    def sort_params
+      sort_hash = nil
+      if params[:sort]
+        sort_array = params[:sort].split(',')
+        sort_array = sort_array.map do |field|
+          is_desc = field.split('-').count > 1
+          name = field.split('-').last
+          { name: name.to_sym, is_desc: is_desc }
+        end
+        sort_array.select! do |field|
+          permitted_fields_for_sort.include? field[:name]
+        end
+        sort_array.each do |field|
+          sort_hash ||= {}
+          sort_hash[field[:name]] = field[:is_desc] ? :desc : :asc
+        end
+      end
+      sort_hash || default_sort_params
+    end
+
+    # Returns a hash with default sorting params
+    # @note Override {#permitted_fields_for_sort} to set allowed fields to sort.
+    # @see http://guides.rubyonrails.org/active_record_querying.html#ordering
+    # @used_in {#sort_params}
+    def default_sort_params
+      {id: :desc}
+    end
+
+    # PAGINATION
+
+    # Handles pagination params and return a hash like { page: 1, per_page: 10 }
+    # @note Override {#per_page_range} to set minimum and maximum per_page param.
+    #   Override {#per_page_default} to set default per_page param.
+    # @used_in {Modificators#paginate_subjects}
+    # @use {#per_page_range}
+    # @use {#per_page_default}
+    def pagination_params
+      page = params[:page].try(:to_i) || 1
+      per_page = [per_page_range[:min], params[:per_page].try(:to_i) || per_page_default, per_page_range[:max]].sort[1]
+      return { page: page, per_page: per_page }
+    end
+
+    # Returns a hash minimum and maximum per_page param like { page: 1, per_page: 10 }
+    # @note Override {#per_page_default} to set default per_page param.
+    # @used_in {#pagination_params}
+    def per_page_range
+      { min: 5, max: 100 }
+    end
+
+    # Returns a default per_page param
+    # @note Override {#per_page_range} to set minimum and maximum per_page param
+    # @used_in {#pagination_params}
+    def per_page_default
+      10
+    end
+  end
+end

data/lib/resting_pug/render.rb

@@ -0,0 +1,72 @@
+module RestingPug
+  # Contains methods responsible for rendering response
+  # @used_in {Base.included}
+  module Render
+    protected
+
+    # Calls {#render_subject} if subject is valid and {#render_errors} otherwise
+    # @note Override {#render_subject} and {#render_errors} to change rendering behaviour
+    # @used_in {Chains#create_chain}
+    # @used_in {Chains#update_chain}
+    # @use {#render_subject}
+    # @use {#render_errors}
+    def decide_what_to_render
+      if @subject.valid?
+        render_subject
+      else
+        render_errors
+      end
+    end
+
+    # Renders json with a subject
+    # @note Override this method to add more complicated logic of rendering.
+    #   Override {Subject#subject_model_sym} to change root attribute.
+    #   Override {Params#permitted_fields_for_show} to change shown attributes.
+    # @used_in {#decide_what_to_render}
+    # @used_in {Chains#show_chain}
+    # @use {Subject#subject_model_sym}
+    # @use {Params#permitted_fields_for_show}
+    def render_subject
+      render json: { subject_model_sym => @subject.as_json(only: permitted_fields_for_show) }
+    end
+
+    # Renders json with subjects
+    # @note Override this method to add more complicated logic of rendering.
+    #   Override {Subject#subject_model_sym_plural} to change root attribute.
+    #   Override {Params#permitted_fields_for_show} to change shown attributes.
+    # @used_in {Chains#index_chain}
+    # @use {Subject#subject_model_sym_plural}
+    # @use {Params#permitted_fields_for_show}
+    def render_subjects
+      render json: { subject_model_sym_plural => @subjects.as_json(only: permitted_fields_for_show) }
+    end
+
+    # Renders empty response
+    # @note Override this method to add more complicated logic of rendering.
+    # @used_in {Subject#destroy_subject}
+    def render_nothing
+      render json: {}, status: 204
+    end
+
+    # Renders errors
+    # @note Override this method to add more complicated logic of rendering.
+    # @used_in {#decide_what_to_render}
+    def render_errors
+      render json: { errors: @subject.errors }, status: 422
+    end
+
+    # Renders error when required params are missing
+    # @note Override this method to add more complicated logic of rendering.
+    # @used_in {Base.included}
+    def render_param_missing
+      render json: { errors: { subject_model_sym => ['param is missing'] } }, status: 400
+    end
+
+    # Renders error when required params are missing
+    # @note Override this method to add more complicated logic of rendering.
+    # @used_in {Base.included}
+    def render_not_found
+      render json: {}, status: 404
+    end
+  end
+end

data/lib/resting_pug/subject.rb

@@ -0,0 +1,87 @@
+module RestingPug
+  # Defines everything related to subject basic operations(creation, updating etc)
+  # @used_in {Base.included}
+  module Subject
+    protected
+
+    # Gets a subject model from a controller class name
+    # @note Override this method if you want to use another model.
+    # @used_in {#subject_model_sym}
+    # @used_in {#subject_model_sym_plural}
+    # @used_in {#create_subject}
+    # @used_in {#fetch_subject}
+    # @used_in {#fetch_subjects}
+    # @used_in {Params#permitted_fields}
+    def subject_model
+      controller_name.classify.constantize
+    end
+
+    # Returns a symbol out of the subject model name
+    # @note Override this method to get another root for params and JSON responses.
+    # @use {#subject_model}
+    # @used_in {Params#params_for_create}
+    # @used_in {Params#params_for_update}
+    # @used_in {Render#render_subject}
+    # @used_in {Render#render_param_missing}
+    def subject_model_sym
+      subject_model.to_s.underscore.to_sym
+    end
+
+    # Returns a symbol out of the subject model name(plural)
+    # @note Override this method to get another root JSON response.
+    # @use {#subject_model}
+    # @used_in {Render#render_subjects}
+    def subject_model_sym_plural
+      subject_model.to_s.pluralize.underscore.to_sym
+    end
+
+    # Creates a subject
+    # @note Override this method to add some custom logic to creating process.
+    # @used_in {Chains#create_chain}
+    # @use {#subject_model}
+    # @use {Params#params_for_create}
+    def create_subject
+      @subject = subject_model.create(params_for_create)
+    end
+
+    # Updates a subject
+    # @note Override this method to add some custom logic to updating process.
+    # @used_in {Chains#update_chain}
+    # @use {Params#params_for_update}
+    def update_subject
+      @subject.update(params_for_update)
+    end
+
+    # Destroys a subject and render nothing or errors
+    # @note Override this method to add some custom logic to destroying process.
+    # @used_in {Chains#destroy_chain}
+    # @use {Render#render_nothing}
+    # @use {Render#render_errors}
+    def destroy_subject
+      if @subject.destroy
+        render_nothing
+      else
+        render_errors
+      end
+    end
+
+    # Finds a subject by id
+    # @note Override this method to add some custom logic to fetching process.
+    # @used_in {Chains#create_chain}
+    # @used_in {Chains#update_chain}
+    # @used_in {Chains#destroy_chain}
+    # @used_in {Chains#show_chain}
+    # @use {#subject_model}
+    def fetch_subject
+      @subject = subject_model.find(params[:id])
+    end
+
+    # Returns all subjects accessable for API
+    # @note Override this method to add some custom logic to fetching process.
+    # @used_in {Chains#index_chain}
+    # @use {#subject_model}
+    def fetch_subjects
+      @subjects = subject_model.all
+    end
+  end
+end

data/lib/resting_pug/version.rb

@@ -0,0 +1,3 @@
+module RestingPug
+  VERSION = '0.1.0'
+end

data/lib/tasks/resting_pug_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :resting_pug do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: resting_pug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Slava Korolev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Resting Pug allows you to create a JSON API with just adding one line
+  to your controller and fully customize it with overriding small and simple helper
+  methods.
+email:
+- korolvs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/resting_pug.rb
+- lib/resting_pug/actions.rb
+- lib/resting_pug/base.rb
+- lib/resting_pug/chains.rb
+- lib/resting_pug/modificators.rb
+- lib/resting_pug/params.rb
+- lib/resting_pug/render.rb
+- lib/resting_pug/subject.rb
+- lib/resting_pug/version.rb
+- lib/tasks/resting_pug_tasks.rake
+homepage: https://korolvs.github.io/resting_pug/
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A simple and fully customizable way to create an API in your Rails application.
+test_files: []