commons_yellowme 0.11.0

data/lib/commons/errors/error_base.rb

@@ -0,0 +1,64 @@
+# Author: carlos@yellowme.mx
+#
+# Description:
+# The APIError class aids us in defining a standard
+# interface for how we handle the errors in our API.
+#
+# It has two main functions:
+#   1. Hold details of the error thrown so it can
+#   be translated to one of the standard HTTP codes.
+#   2. Provide a consistent way to "serialize" errors.
+#
+# Attributes:
+# - message: string, Holds a human friendly way to
+# describe the error.
+# - status: integer, Denotes the HTTP status code.
+# - error: string, Similar to message, but this
+# field is intended to show the error message from
+# a raised error.
+# - detail: Hash, Contains a more details about the
+# error.
+
+module Commons
+  module Errors
+    class ErrorBase < StandardError
+      include ActiveModel::Serialization
+
+      attr_reader :message, :backtrace, :title, :detail, :code, :meta
+
+      def initialize(message = nil,
+                     backtrace = nil,
+                     status: :internal_server_error,
+                     code: I18n.t('status_code.IER5000_internal_server_error.code'),
+                     title: I18n.t('status_code.IER5000_internal_server_error.title'),
+                     detail: I18n.t('status_code.IER5000_internal_server_error.detail'),
+                     meta: {})
+
+        @message = message
+        @backtrace = backtrace
+        @title = title
+        @detail = detail
+        @code = code
+        @status = status
+        @meta = meta
+        @meta.merge!(message: message) unless @meta.nil? || @message.nil?
+        @meta = nil if @meta.blank?
+      end
+
+      # returns the error as its hash representation
+      def to_hash
+        {
+          code: code,
+          title: title,
+          status: status,
+          detail: detail,
+          meta: meta
+        }
+      end
+
+      def status
+        Rack::Utils::SYMBOL_TO_STATUS_CODE[@status]
+      end
+    end
+  end
+end

data/lib/commons/errors/error_serializer.rb

@@ -0,0 +1,10 @@
+module Commons
+  module Errors
+    class ErrorSerializer < ActiveModel::Serializer
+      include Commons::Formatter::NullAttributesRemover
+      type 'errors'
+
+      attributes :status, :code, :title, :detail, :meta
+    end
+  end
+end

data/lib/commons/errors/forbidden.rb

@@ -0,0 +1,15 @@
+module Commons
+  module Errors
+    class Forbidden < ErrorBase
+      def initialize(message = nil, backtrace = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              backtrace,
+              status: :forbidden,
+              title: title || I18n.t('status_code.IER4005_forbidden.title'),
+              code: code || I18n.t('status_code.IER4005_forbidden.code'),
+              detail: detail || I18n.t('status_code.IER4005_forbidden.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/internal_server_error.rb

@@ -0,0 +1,15 @@
+module Commons
+  module Errors
+    class InternalServerError < ErrorBase
+      def initialize(message = nil, backtrace = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              backtrace,
+              status: :internal_server_error,
+              title: title || I18n.t('status_code.IER5000_internal_server_error.title'),
+              code: code || I18n.t('status_code.IER5000_internal_server_error.code'),
+              detail: detail || I18n.t('status_code.IER5000_internal_server_error.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/invalid_resource.rb

@@ -0,0 +1,21 @@
+module Commons
+  module Errors
+    class InvalidResource < UnprocessableEntity
+      def initialize(message = nil,
+                     backtrace = nil,
+                     title: nil,
+                     code: nil,
+                     detail: nil,
+                     validation_errors: nil)
+        meta = {}
+        meta.merge!(validation_errors: validation_errors) unless validation_errors.blank?
+        super message,
+              backtrace,
+              title: title || I18n.t('status_code.IER4006_invalid_resource.title'),
+              code: code || I18n.t('status_code.IER4006_invalid_resource.code'),
+              detail: detail || I18n.t('status_code.IER4006_invalid_resource.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/maintenance_mode.rb

@@ -0,0 +1,14 @@
+module Commons
+  module Errors
+    class MaintenanceMode < ErrorBase
+      def initialize(message = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              status: :service_unavailable,
+              title: title || I18n.t('status_code.IER5030_maintenance_mode.title'),
+              code: code || I18n.t('status_code.IER5030_maintenance_mode.code'),
+              detail: detail || I18n.t('status_code.IER5030_maintenance_mode.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/missing_parameter.rb

@@ -0,0 +1,13 @@
+module Commons
+  module Errors
+    class MissingParameter < UnprocessableEntity
+      def initialize(message = nil, param: nil)
+        meta = {}
+        meta.merge!(param: param.to_s.camelize(:lower)) unless param.blank?
+        super message,
+              detail: I18n.t('status_code.IER4007_missing_parameter.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/not_unique.rb

@@ -0,0 +1,14 @@
+module Commons
+  module Errors
+    class NotUnique < Conflict
+      def initialize(message = nil, backtrace = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              backtrace,
+              title: title || I18n.t('status_code.IER4008_not_unique.title'),
+              code: code || I18n.t('status_code.IER4008_not_unique.code'),
+              detail: detail || I18n.t('status_code.IER4008_not_unique.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/payment_required.rb

@@ -0,0 +1,15 @@
+module Commons
+  module Errors
+    class PaymentRequired < ErrorBase
+      def initialize(message = nil, backtrace = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              backtrace,
+              status: :payment_required,
+              title: title || I18n.t('status_code.IER4009_payment_required.title'),
+              code: code || I18n.t('status_code.IER4009_payment_required.code'),
+              detail: detail || I18n.t('status_code.IER4009_payment_required.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/precondition_failed.rb

@@ -0,0 +1,15 @@
+module Commons
+  module Errors
+    class PreconditionFailed < ErrorBase
+      def initialize(message = nil, backtrace = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              backtrace,
+              status: :precondition_failed,
+              title: title || I18n.t('status_code.IER4010_precondition_failed.title'),
+              code: code || I18n.t('status_code.IER4010_precondition_failed.code'),
+              detail: detail || I18n.t('status_code.IER4010_precondition_failed.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/resource_not_found.rb

@@ -0,0 +1,14 @@
+module Commons
+  module Errors
+    class RouteNotFound < ErrorBase
+      def initialize(message = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              status: :not_found,
+              title: title || I18n.t('status_code.IER4001_route_not_found.title'),
+              code: code || I18n.t('status_code.IER4001_route_not_found.code'),
+              detail: detail || I18n.t('status_code.IER4001_route_not_found.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/route_not_found.rb

@@ -0,0 +1,14 @@
+module Commons
+  module Errors
+    class ResourceNotFound < ErrorBase
+      def initialize(message = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              status: :not_found,
+              title: title || I18n.t('status_code.IER4011_resource_not_found.title'),
+              code: code || I18n.t('status_code.IER4011_resource_not_found.code'),
+              detail: detail || I18n.t('status_code.IER4011_resource_not_found.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/unauthorized.rb

@@ -0,0 +1,15 @@
+module Commons
+  module Errors
+    class Unauthorized < ErrorBase
+      def initialize(message = nil, backtrace = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              backtrace,
+              status: :unauthorized,
+              code: code || I18n.t('status_code.IER4002_unauthorized.code'),
+              title: title || I18n.t('status_code.IER4002_unauthorized.title'),
+              detail: detail || I18n.t('status_code.IER4002_unauthorized.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/errors/unprocessable_entity.rb

@@ -0,0 +1,15 @@
+module Commons
+  module Errors
+    class UnprocessableEntity < ErrorBase
+      def initialize(message = nil, backtrace = nil, title: nil, code: nil, detail: nil, meta: {})
+        super message,
+              backtrace,
+              status: :unprocessable_entity,
+              title: title || I18n.t('status_code.IER4222_unprocessable_entity.title'),
+              code: code || I18n.t('status_code.IER4222_unprocessable_entity.code'),
+              detail: detail || I18n.t('status_code.IER4222_unprocessable_entity.detail'),
+              meta: meta
+      end
+    end
+  end
+end

data/lib/commons/formatter/e164_phone.rb

@@ -0,0 +1,47 @@
+module Commons
+  module Formatter
+    class E164Phone
+      attr_accessor :valid
+
+      # @type [String]
+      # Mexico ISO Country Code
+      MEXICO_ISO_CODE = 'MX'.freeze
+      # @type [String]
+      # Mexico Phone Country Code
+      MEXICO_CC = '52'.freeze
+      # @type [String]
+      # Mexico National Destination Code
+      MEXICO_NDC = ''.freeze
+      MEXICO_REGEX = /^(521?\d{10}|\d{10})$/
+      NOT_DIGITS_REGEX = /[^0-9]/
+
+      def initialize(phone_number)
+        @phone = Phonelib.parse(phone_number)
+        @valid = @phone.valid?
+      end
+
+      def format
+        @valid ? @phone.e164 : nil
+      end
+
+      def format_national
+        @valid ? @phone.raw_national : nil
+      end
+
+      def country_code
+        @valid ? @phone.country_code : nil
+      end
+
+      def validate
+        @valid && @phone.country_code == MEXICO_CC
+      end
+
+      def self.canonical_phone(phone_number)
+        phone_digits = phone_number.gsub(NOT_DIGITS_REGEX, '')
+        return nil unless MEXICO_REGEX.match(phone_digits)
+
+        phone_digits.split(//).last(10).join
+      end
+    end
+  end
+end

data/lib/commons/formatter/null_attributes_remover.rb

@@ -0,0 +1,9 @@
+module Commons
+  module Formatter
+    module NullAttributesRemover
+      def attributes(*args)
+        super.compact
+      end
+    end
+  end
+end

data/lib/commons/formatter/regex_constants.rb

@@ -0,0 +1,9 @@
+module Commons
+  module Formatter
+    module RegexConstants
+      PROPER_NOUN = /\A\p{L}[\p{L}'\.\-]*( [\p{L}'\.\-]+)*\z/u
+      CURP = /\A([A-Z][AEIOUX][A-Z]{2}\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\d|3[01])[HM](?:AS|B[CS]|C[CLMSH]|D[FG]|G[TR]|HG|JC|M[CNS]|N[ETL]|OC|PL|Q[TR]|S[PLR]|T[CSL]|VZ|YN|ZS)[B-DF-HJ-NP-TV-Z]{3}[A-Z\d])(\d)\z/
+      RFC = /\A([A-ZÑ\x26]{3,4}(\d{2})(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[0-1])([A-Z0-9]){2}([A0-9]))?\z/i
+    end
+  end
+end

data/lib/commons/formatter/string_utils.rb

@@ -0,0 +1,9 @@
+module Commons
+  module Formatter
+    module StringUtils
+      def self.capitalize(text)
+        text.downcase.gsub(/(?!(las?|del?|los?|y)\b)\b\p{L}/, &:upcase)
+      end
+    end
+  end
+end

data/lib/commons/middleware/catch_json_parse_errors.rb

@@ -0,0 +1,30 @@
+module Commons
+  module Middleware
+    class CatchJsonParseErrors
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue ActionDispatch::Http::Parameters::ParseError => e
+        if env['HTTP_ACCEPT'] =~ %r{application/json} ||
+           env['CONTENT_TYPE'] =~ %r{application/json}
+          str = Commons::Errors::ErrorSerializer.new(Commons::Errors::BadRequest.new(e)).to_json
+          str.tr!("'", '\'')
+          return [
+            '400',
+            { 'Content-Type' => 'application/json' },
+            [
+              '{ "error":'\
+              "#{str}"\
+              '}'\
+            ]
+          ]
+        else
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/commons/railtie.rb

@@ -0,0 +1,4 @@
+module Commons
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/commons/repositories/base_repository.rb

@@ -0,0 +1,227 @@
+module Commons
+  module Repositories
+    class BaseRepository
+      include Singleton
+
+      #
+      # Método que devuelve todos los objetos
+      #
+      # @return [Object,nil]
+      #
+      def all
+        @db_client.all
+      end
+
+      #
+      # Método que devuelve todos los objetos que no han sido eliminados
+      #
+      # @return [Object,nil]
+      #
+      def kept
+        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+
+        @db_client.where(deleted_at: nil)
+      end
+
+      #
+      # Método que devuelve todos los objetos que han sido eliminados
+      #
+      # @return [Object,nil]
+      #
+      def deleted
+        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+
+        @db_client.where.not(deleted_at: nil)
+      end
+
+      #
+      # Método que devuelve el objeto según su ID
+      #
+      # @return [Object,nil]
+      #
+      def find(id)
+        @db_client.find(id)
+      end
+
+      #
+      # Método que devuelve el objeto según su ID
+      #
+      # @return [Object,nil]
+      #
+      def find_kept(id)
+        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+
+        @db_client.find_by!(id: id, deleted_at: nil)
+      end
+
+      #
+      # Método que devuelve el objeto según parámetros
+      #
+      # @return [Object,nil]
+      #
+      def find_by(params)
+        @db_client.find_by(params)
+      end
+
+      #
+      # Método que devuelve el objeto según parámetros
+      #
+      # @return [Object,nil]
+      #
+      def find_kept_by(params)
+        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+
+        @db_client.find_by(
+          deleted_at: nil,
+          **params
+        )
+      end
+
+      #
+      # Método que devuelve el objeto según parámetros
+      #
+      # @return [Object]
+      #
+      # @raise [ActiveRecord::RecordNotFound]
+      #
+      def find_by!(params)
+        @db_client.find_by!(params)
+      end
+
+      #
+      # Método que devuelve el objeto según parámetros
+      #
+      # @return [Object]
+      #
+      # @raise [ActiveRecord::RecordNotFound]
+      #
+      def find_kept_by!(params)
+        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+
+        @db_client.find_by!(
+          deleted_at: nil,
+          **params
+        )
+      end
+
+      #
+      # Método que realiza un guardado de un objeto
+      #
+      # @param [Object]
+      #
+      # @return [Boolean]
+      #
+      # @raise [ActiveRecord::RecordInvalid]
+      # @raise [ActiveRecord::RecordNotSaved]
+      #
+      def create!(object)
+        raise ArgumentError unless object.is_a? @db_client
+
+        object.save!
+      end
+
+      #
+      # Método que realiza un guardado de un objeto
+      #
+      # @param [Array<Hash>] params Listado de parámetros del objeto
+      #
+      # @return [Object] Objeto creado
+      #
+      # @raises [ActiveRecord::RecordInvalid]
+      #
+      def create_from_params!(**params)
+        @db_client.create!(**params)
+      end
+
+      #
+      # Método que realiza una busqueda o guardado de un objeto
+      #
+      # @param [Array<Hash>] params Listado de parámetros del objeto
+      # @param [block] block
+      #
+      # @return [Object] Objeto creado
+      #
+      # @raises [ActiveRecord::RecordInvalid]
+      #
+      def find_or_create_by!(params, &block)
+        object = @db_client.find_by(params) || @db_client.create!(params, &block)
+        object
+      end
+
+      #
+      # Método que realiza una busqueda de la primer entrada,
+      # en caso de no encontrarlo crea un objeto con el bloque
+      #
+      # @param [Array<Hash>] params Listado de parámetros del objeto
+      # @param [block] block
+      #
+      # @return [Object] Objeto creado
+      #
+      # @raises [ActiveRecord::RecordInvalid]
+      #
+      def where_first_or_create!(params, attributes = nil, &block)
+        @db_client.where(params).first_or_create!(attributes, &block)
+      end
+
+      #
+      # Método que guarda los cambios realizados a una instancia del objeto
+      #
+      # @param [Object]
+      #
+      # @return [Boolean]
+      #
+      # @raise [ActiveRecord::RecordInvalid]
+      # @raise [ActiveRecord::RecordNotSaved]
+      #
+      def update!(object)
+        create!(object)
+      end
+
+      #
+      # Método que realiza un guardado de un objeto
+      #
+      # @param [Array<Hash>] params Listado de parámetros del objeto
+      #
+      # @return [Object] Objeto creado
+      #
+      # @raises [ActiveRecord::RecordInvalid]
+      #
+      def update_from_params!(id:, **params)
+        object = @db_client.find_by!(id: id)
+        object.update!(params)
+
+        object
+      end
+
+      #
+      # Método que realiza un borrado lógico de un objeto
+      #
+      # @param [UUID] id Identificador del objeto
+      #
+      # @return [Object] Objeto eliminado
+      #
+      # @raises [ActiveRecord::RecordInvalid]
+      # @raises [ActiveModel::MissingAttributeError]
+      #
+      def soft_delete!(id)
+        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+
+        object = @db_client.find_by!(id: id, deleted_at: nil)
+        object.update!(deleted_at: Time.current)
+
+        object
+      end
+
+      private
+
+      def initialize
+        @db_client ||= class_object
+      end
+
+      def class_object
+        model_name = self.class.to_s.gsub("Repository", "")
+        Object.const_get model_name
+      end
+    end
+  end
+end