[WIP] REST API (#41)

REST API Initial version

Author: tachyons

Gemfile

@@ -42,6 +42,9 @@ gem "searchkick"
 gem "puma"
 gem "sendgrid-actionmailer"
 
+gem "fast_jsonapi"
+gem "sidekiq"
+
 group :production do
   gem "therubyracer", platforms: :ruby
 end

Gemfile.lock

@@ -99,6 +99,7 @@ GEM
       execjs
     coffee-script-source (1.12.2)
     concurrent-ruby (1.0.5)
+    connection_pool (2.2.2)
     crass (1.0.4)
     database_cleaner (1.7.0)
     devise (4.5.0)
@@ -126,6 +127,8 @@ GEM
       railties (>= 3.0.0)
     faraday (0.15.3)
       multipart-post (>= 1.2, < 3)
+    fast_jsonapi (1.4)
+      activesupport (>= 4.2)
     ffi (1.9.25)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
@@ -147,7 +150,7 @@ GEM
       ruby_parser (~> 3.5)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
+    jaro_winkler (1.5.2)
     jbuilder (2.7.0)
       activesupport (>= 4.2.0)
       multi_json (>= 1.2)
@@ -208,8 +211,8 @@ GEM
       mime-types
       mimemagic (~> 0.3.0)
       terrapin (~> 0.6.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     poltergeist (1.18.1)
       capybara (>= 2.1, < 4)
@@ -262,6 +265,7 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
+    redis (4.0.2)
     ref (2.0.0)
     responders (2.4.0)
       actionpack (>= 4.2.0, < 5.3)
@@ -287,7 +291,7 @@ GEM
       rspec-mocks (~> 3.8.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.60.0)
+    rubocop (0.63.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
@@ -335,6 +339,10 @@ GEM
       rails (>= 3.2)
     shoulda-matchers (3.1.2)
       activesupport (>= 4.0.0)
+    sidekiq (5.2.2)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
     simple_form (4.0.1)
       actionpack (>= 5.0)
       activemodel (>= 5.0)
@@ -374,7 +382,7 @@ GEM
       thread_safe (~> 0.1)
     uglifier (4.1.19)
       execjs (>= 0.3.0, < 3)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.4.1)
     warden (1.2.7)
       rack (>= 1.0)
     web-console (3.7.0)
@@ -408,6 +416,7 @@ DEPENDENCIES
   database_cleaner
   devise
   factory_bot_rails
+  fast_jsonapi
   haml
   haml-rails
   jbuilder
@@ -439,6 +448,7 @@ DEPENDENCIES
   sendgrid-actionmailer
   sextant
   shoulda-matchers
+  sidekiq
   simple_form
   spring
   spring-watcher-listen (~> 2.0.0)

app/controllers/api/v1/authors_controller.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Api::V1::AuthorsController < ApiBaseController
+  before_action :set_author, only: :show
+  before_action :parse_json_api_params
+
+  def show
+    render json: AuthorSerializer.new(@author)
+  end
+
+  def index
+    render json: AuthorSerializer.new(
+      Author.paginate(page: @query.page_number, per_page: @query.per_page)
+    )
+  end
+
+  private
+
+  def set_author
+    @author = Author.find_by!(grandham_id: params[:id])
+  end
+end

app/controllers/api/v1/books_controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Api::V1::BooksController < ApiBaseController
+  before_action :set_book, only: :show
+  before_action :parse_json_api_params
+
+  def show
+    render json: BookSerializer.new(@book)
+  end
+
+  def index
+    @books = if @query.search_query.present?
+               Book
+                 .includes(:authors, :libraries)
+                 .search(@query.search_query, page: @query.page_number, per_page: @query.per_page)
+             else
+               Book
+                 .includes(:authors, :libraries)
+                 .paginate(page: @query.page_number, per_page: @query.per_page)
+             end
+    render json: BookSerializer.new(@books, include: %i[authors libraries])
+  end
+
+  private
+
+  def set_book
+    @book = Book.find_by!(grandham_id: params[:id])
+  end
+end

app/controllers/api/v1/libraries_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Api::V1::LibrariesController < ApiBaseController
+  before_action :set_library, only: :show
+  before_action :parse_json_api_params
+
+  def show
+    render json: LibrarySerializer.new(@library)
+  end
+
+  def index
+    @libraries = if @query.search_query.present?
+                   Library.search(@query.search_query, page: @query.page_number, per_page: @query.per_page)
+                 else
+                   Library.paginate(page: @query.page_number, per_page: @query.per_page)
+                 end
+
+    render json: LibrarySerializer.new(@libraries)
+  end
+
+  private
+
+  def set_library
+    @ibrary = Library.find_by!(grandham_id: params[:id])
+  end
+end

app/controllers/api/v1/publishers_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Api::V1::PublishersController < ApiBaseController
+  before_action :set_publisher, only: :show
+  before_action :parse_json_api_params
+
+  def show
+    render json: PublisherSerializer.new(@publisher)
+  end
+
+  def index
+    @publishers = if @query.search_query.present?
+                    Publisher.search(@query.search_query, page: @query.page_number, per_page: @query.per_page)
+                  else
+                    Publisher.paginate(page: @query.page_number, per_page: @query.per_page)
+                  end
+
+    render json: PublisherSerializer.new(@publishers)
+  end
+
+  private
+
+  def set_publisher
+    @publisher = Publisher.find_by!(grandham_id: params[:id])
+  end
+end

app/controllers/api_base_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ApiBaseController < ApplicationController
+  rescue_from ActiveRecord::RecordNotFound do |_exception|
+    head :not_found
+  end
+
+  protected
+
+  def parse_json_api_params
+    @query = JsonApiQueryParser.new(params)
+    @query.call
+  end
+end

app/controllers/searches_controller.rb

@@ -24,6 +24,7 @@ def resource(action)
   end
 
   def get_results
-    @results = Search.new(resource(params[:action]), params[:query], params[:page]).results if params[:query].present?
+    search_query = MalayalamTextNormalizer.new(params[:query]).call
+    @results = Search.new(resource(params[:action]), search_query, params[:page]).results if params[:query].present?
   end
 end

app/serializers/author_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AuthorSerializer
+  include FastJsonapi::ObjectSerializer
+  attributes :name, :language
+  set_id :grandham_id
+end

app/serializers/book_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class BookSerializer
+  include FastJsonapi::ObjectSerializer
+  set_id :grandham_id
+  attributes :grandham_id, :title, :isbn, :pages, :year, :description, :edition, :ddc, :volume,
+             :series, :price, :length, :title_orginal, :illustrator, :note, :preface
+
+  has_many :authors
+  has_many :libraries
+end

app/serializers/library_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class LibrarySerializer
+  include FastJsonapi::ObjectSerializer
+  set_id :grandham_id
+  attributes :name, :place, :language
+end

app/serializers/publisher_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class PublisherSerializer
+  include FastJsonapi::ObjectSerializer
+  set_id :grandham_id
+  attributes :name, :place, :language
+end

app/services/json_api_query_parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class JsonApiQueryParser
+  attr_reader :page_number, :per_page, :search_query
+  def initialize(params, options = nil)
+    @params = params.is_a?(Hash) ? params : params.permit(:query, page: %i[number size]).to_h
+    @options = options
+  end
+
+  def call
+    @page_number = params.dig("page", "number") || 1
+    @per_page = params.dig("page", "size") || 20
+    @search_query = MalayalamTextNormalizer.new(params["query"]).call
+  end
+
+  private
+
+  attr_reader :params, :options
+end

app/services/malayalam_text_normalizer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class MalayalamTextNormalizer
+  ATOMIC_CHILLU_MAP = {
+    "ന്‍" => "ൻ",
+    "ണ്‍" => "ൺ",
+    "ര്‍" => "ർ",
+    "ല്‍" => "ൽ",
+    "ള്‍" => "ൾ",
+    "ക്‍" => "ൿ"
+  }.freeze
+  def initialize(text)
+    @text = text
+  end
+
+  def call
+    return text if text.blank?
+
+    ATOMIC_CHILLU_MAP.each do |non_atomic, atomic|
+      @text = text.gsub(atomic, non_atomic)
+    end
+    text
+  end
+
+  private
+
+  attr_reader :text
+end

config/routes.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Grandham::Application.routes.draw do
+Grandham::Application.routes.draw do # rubocop:disable Metrics/BlockLength
   get "qr_generator/image"
 
   get "error/access_denied"
@@ -71,4 +71,12 @@
       get :books, on: :member
     end
   end
+  namespace :api do
+    namespace :v1 do
+      resources :books, only: %i[show index]
+      resources :authors, only: %i[show index]
+      resources :libraries, only: %i[show index]
+      resources :publishers, only: %i[show index]
+    end
+  end
 end