Release v19.12.2023

Release v19.12.2023

Author: tuanle03

Gemfile

@@ -46,6 +46,16 @@ gem "devise"
 
 gem 'devise-jwt'
 
+gem 'grape'
+
+gem 'appsignal'
+
+gem 'grape-swagger'
+
+gem 'grape_logging'
+
+gem 'faker'
+
 # Use Sass to process CSS
 # gem "sassc-rails"
 
@@ -55,6 +65,7 @@ gem 'devise-jwt'
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
   gem "debug", platforms: %i[ mri mingw x64_mingw ]
+  gem 'byebug'
   gem 'rspec-rails'
   gem 'factory_bot_rails'
 end

Gemfile.lock

@@ -68,11 +68,14 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
+    appsignal (3.5.0)
+      rack
     bcrypt (3.1.20)
     bindex (0.8.1)
     bootsnap (1.17.0)
       msgpack (~> 1.2)
     builder (3.2.4)
+    byebug (11.1.3)
     capybara (3.39.0)
       addressable
       matrix
@@ -107,14 +110,40 @@ GEM
     dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
     erubi (1.12.0)
     factory_bot (6.4.2)
       activesupport (>= 5.0.0)
     factory_bot_rails (6.4.2)
       factory_bot (~> 6.4)
       railties (>= 5.0.0)
+    faker (3.2.2)
+      i18n (>= 1.8.11, < 2)
     globalid (1.2.1)
       activesupport (>= 6.1)
+    grape (2.0.0)
+      activesupport (>= 5)
+      builder
+      dry-types (>= 1.1)
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+    grape-swagger (2.0.0)
+      grape (>= 1.7, < 3.0)
+      rack-test (~> 2)
+    grape_logging (1.8.4)
+      grape
+      rack
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     importmap-rails (1.1.5)
@@ -143,6 +172,10 @@ GEM
     mini_portile2 (2.8.5)
     minitest (5.20.0)
     msgpack (1.7.2)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.2)
+      mustermann (>= 1.0.0)
     net-imap (0.4.7)
       date
       net-protocol
@@ -164,6 +197,8 @@ GEM
       nio4r (~> 2.0)
     racc (1.7.3)
     rack (2.2.8)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
     rack-test (2.1.0)
       rack (>= 1.3)
     rails (7.0.4.3)
@@ -220,6 +255,7 @@ GEM
       rspec-mocks (~> 3.12)
       rspec-support (~> 3.12)
     rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
     selenium-webdriver (4.10.0)
       rexml (~> 3.2, >= 3.2.5)
@@ -273,12 +309,18 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  appsignal
   bootsnap
+  byebug
   capybara
   debug
   devise
   devise-jwt
   factory_bot_rails
+  faker
+  grape
+  grape-swagger
+  grape_logging
   importmap-rails
   jbuilder
   puma (~> 5.0)

README.md

@@ -1,6 +1,6 @@
-# Awesome Blog API
+# CodeLearn API
 
-Welcome to the Awesome Blog API repository! This project is built using Ruby on Rails, Grape API, JWT (JSON Web Tokens), and Swagger. It provides a robust backend for a web blog application, allowing you to create, retrieve, update, and delete blog posts, comments, and more through a RESTful API.
+Welcome to the CodeLearn API repository! This project is built using Ruby on Rails, Grape API, JWT (JSON Web Tokens), and Swagger. It provides a robust backend for a web blog application, allowing you to create, retrieve, update, and delete blog posts, comments, and more through a RESTful API.
 
 ## Table of Contents
 
@@ -57,7 +57,7 @@ This project uses JSON Web Tokens (JWT) for user authentication. Make sure to in
    ```
 
 ## Swagger Documentation
-Explore the API endpoints and test them using the Swagger documentation at `http://localhost:3000/doc`.
+Explore the API endpoints and test them using the Swagger documentation at `http://localhost:2106/api/web/doc`.
 
 ## Contributing
 We welcome contributions! If you find a bug or have an enhancement in mind, please open an issue or submit a pull request.

app/api/application_api.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'appsignal/integrations/grape'
+require 'grape-swagger'
+require 'grape_logging'
+
+class ApplicationAPI < Grape::API
+  format :json
+
+  helpers ::Helpers::AuthenticationHelper
+  helpers do
+    def unauthorized_error!
+      error!('Unauthorized', 401)
+    end
+  end
+
+  rescue_from Grape::Exceptions::ValidationErrors do |e|
+    error!(e, 400)
+  end
+
+  rescue_from ActiveRecord::RecordNotFound do |e|
+    error!(e, 404)
+  end
+
+  rescue_from NotImplementedError, TypeError, StandardError do |e|
+    status_code = e.respond_to?(:status_code) ? e.status_code : 500
+    Appsignal.set_error(e) if status_code == 500
+    error!(e, status_code)
+  end
+
+  mount WebAPI
+end

app/api/helpers/authentication_helper.rb

@@ -0,0 +1,18 @@
+module Helpers::AuthenticationHelper
+  extend Grape::API::Helpers
+
+  def authenticate_user!
+    error!('Unauthorized. Invalid or expired token.', 401) unless current_user
+  end
+
+  def current_user
+    @current_user ||=
+      begin
+        token = request.headers['Authorization'].split(' ').last
+        User.find_by(id: JWT.decode(token, Rails.application.credentials.devise_jwt_secret_key)[0]['user_id']) if token
+      rescue JWT::DecodeError
+        nil
+      end
+  end
+
+end

app/api/json_error_formatter.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# typed: true
+
+# Custom error formatter for Grape API
+class JsonErrorFormatter
+  class << self
+
+    ERRORS_MAPPER = {
+      StandardError: 'E999',
+      'Errors::APIFailures::AccessDeniedError': 'E401',
+      'Grape::Exceptions::ValidationErrors': 'E400',
+      'Errors::AccessDeniedError': 'E1001',
+      'ActiveRecord::RecordNotFound': 'E1002',
+      'AASM::InvalidTransition': 'E1003',
+      'ActiveModel::Errors': 'E1004',
+      ArgumentError: 'E1005',
+      'Tpl::Services::Base::InvalidKeyError': 'E1006',
+      'NonUpdatable::NonUpdatableError': 'E1007',
+      'Errors::StockChecks::AlreadyStartedError': 'E1008',
+      'Errors::StockChecks::HasNotStartedError': 'E1009',
+      'Errors::StockChecks::AlreadyEndedError': 'E1010',
+      'Errors::StockChecks::NotAllLocationsChecked': 'E1011',
+      'Errors::OverstockCarts::CheckingProductIsNotUnderstockError': 'E1013',
+      'Errors::OverstockCarts::SupplyOverflowError': 'E1014',
+      'Errors::OverstockCarts::DiffStockNotMatchedExceedingStockError': 'E1015',
+      'Errors::OverstockCarts::NotEnoughStockOnCart': 'E1016',
+      'Errors::SharedAccessKeys::InvalidKeyError': 'E1017',
+      'Errors::APIFailures::ServiceFailure': 'E1018',
+      'Errors::ProductUnits::AlreadyGtinCodeError': 'E1019',
+    }.freeze
+
+    private_constant :ERRORS_MAPPER
+
+    # Return the error response in JSON format
+    def call(messages, _backtrace, _options, _env, _original_exception)
+      error_code = ERRORS_MAPPER[messages.class.to_s.to_sym] || ERRORS_MAPPER[messages.to_s.to_sym]
+      error_code ||= ERRORS_MAPPER[:StandardError]
+
+      {
+        error: error_code,
+        messages: parse_messages(messages).uniq,
+        debug: debug_data(messages),
+      }.to_json
+    end
+
+    # Adding the debug data to the error response
+    def debug_data(messages)
+      return {} if Rails.env.production?
+
+      {
+        inspect: messages.try(:inspect)&.first(100),
+        backtrace: messages.try(:backtrace)&.first(30),
+      }
+    end
+
+    # Return the error messages
+    def parse_messages(exception) # rubocop:disable Metrics/MethodLength
+      case exception
+      when ActiveModel::Errors, Grape::Exceptions::ValidationErrors
+        exception.full_messages
+      when ActiveRecord::RecordNotFound
+        Array(I18n.t('api.errors.not_found', model: exception.model))
+      when Errors::APIFailures::ServiceFailure
+        exception.errors.full_messages
+      when ActiveRecord::RecordInvalid, StandardError
+        Array(exception.message)
+      when Array
+        exception
+      else
+        Array(exception)
+      end
+    end
+  end
+end

app/api/json_formatter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# typed: true
+
+# Custom formatter for Grape API
+class JsonFormatter
+  class << self
+    # Return the response in JSON format
+    def call(obj, env)
+      case obj
+      when ServiceResult
+        success_entity = get_success_entity(env)
+        to_json(success_entity.represent(success_entity.try(:collection?) ? obj.records : obj.record), env)
+      when API::Result
+        success_entity = get_success_entity(env)
+        to_json(success_entity.represent(obj.data), env)
+      else
+        to_json(obj, env)
+      end
+    end
+
+    private
+
+    def to_json(obj, env)
+      Grape::Formatter::Json.call(obj, env)
+    end
+
+    def get_success_entity(env)
+      success_entity = env.dig('grape.routing_args', :route_info).options[:success]
+      success_entity || raise(Errors::APIFailures::InvalidSuccessConfigError)
+    end
+  end
+end

app/api/validators/gte_date_validator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# GteDateValidator for Grape params
+class Validators::GteDateValidator < Grape::Validations::Validators::Base
+  FORM_INPUT_TIME = 10.minutes
+  private_constant :FORM_INPUT_TIME
+
+  # validate_param! method is required
+  def validate_param!(param_name, params)
+    case @option
+    when :now
+      validate_current_date!(param_name, params)
+    when Symbol
+      validate_greater_than!(param_name, params)
+    else
+      error_message = I18n.t('validators.un_supported', option: param_name, class: 'GteDateValidator')
+      raise(error_message)
+    end
+  end
+
+  private
+
+  def validate_greater_than!(param_name, params)
+    return if params[@option]&.value.blank?
+    return if params[param_name].value >= params[@option].value
+
+    raise(Grape::Exceptions::Validation.new(params: [@scope.full_name(param_name)],
+      message: I18n.t('validators.invalid_greater_than_date', date: @option)))
+  end
+
+  def validate_current_date!(param_name, params)
+    return if @option.blank?
+    return if params[param_name].value > FORM_INPUT_TIME.ago
+
+    raise(Grape::Exceptions::Validation.new(params: [@scope.full_name(param_name)],
+      message: I18n.t('validators.invalid_greater_than_date', date: 'current date')))
+  end
+end

app/api/validators/length_validator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# LengthValidator for Grape params
+class Validators::LengthValidator < Grape::Validations::Validators::Base
+  # validate_param! method is required
+  def validate_param!(attr_name, params)
+    return if params[attr_name].blank?
+    return if params[attr_name].length.in?(limited_length)
+
+    raise(Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: error_message(attr_name)))
+  end
+
+  private
+
+  def limited_length
+    case @option
+    when Range
+      @option
+    when Hash
+      @option[:minimun]..@option[:maximum]
+    when Integer
+      @option..@option
+    else
+      raise(Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: 'Length is invalid'))
+    end
+  end
+
+  def error_message(attr_name)
+    case @option
+    when Range
+      "#{attr_name} length must be in #{@option}"
+    when Hash
+      "#{attr_name} length must be in #{Integer(@option[:minimun], 10)}..#{Integer(@option[:maximum], 10)}"
+    when Integer
+      "#{attr_name} length must be #{@option}"
+    end
+  end
+end