commons_yellowme 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72561778339f9301bc276ec516c4bf13d3e98323c93ba4a7bfce41d67dcca9d2
+  data.tar.gz: 9036b246544ec395c0cfb7829bdbea2b85deb1cbf14b465c8aacf3eaaf56c709
+SHA512:
+  metadata.gz: 563e23f1dfecd7805b3e274327365fe77a789db503cb421e00773d4ada57fb990456cfc5dea53fb0a411d1622074e4ef5985e851f54bce516ae6237d5863c785
+  data.tar.gz: 87e562f16d6f70f1c870c6db5ade5f5ae3c48601704e7040f7c327f8ad7c3c42b56a345268a68fa2bc1c04965b5ab672512f9d46bd3dc83144eb31afc18c762d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Juan Ku
+
+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,28 @@
+# Commons
+Commons is Yellowme's Rails APIs utilities gem
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'commons', git: 'https://github.com/yellowme/commons.git'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install commons
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,17 @@
+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    = 'Commons'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/commons.rb

@@ -0,0 +1,67 @@
+require 'commons/railtie'
+
+require 'strip_attributes'
+require 'active_model_serializers'
+require 'jwt'
+require 'phonelib'
+
+require 'commons/config'
+
+# authentication
+require 'commons/authentication/json_web_token'
+require 'commons/authentication/authenticate_by_jwt'
+
+# controllers
+require 'commons/controllers/schema_validable'
+
+# repositories
+require 'commons/repositories/base_repository'
+require 'commons/repositories/catalogs/concerns/model_caching_extention'
+require 'commons/repositories/catalogs/base_catalog'
+
+# services
+require 'commons/services/concerns/callable'
+
+# models
+require 'commons/concerns/attributes/sex'
+require 'commons/concerns/extensions/deleted'
+require 'commons/concerns/guard/capitalizable'
+require 'commons/concerns/validations/undestroyable'
+
+# utils
+require 'commons/formatter/null_attributes_remover'
+require 'commons/formatter/regex_constants'
+require 'commons/formatter/string_utils'
+require 'commons/formatter/e164_phone'
+
+# errors
+require 'commons/errors/error_base'
+require 'commons/errors/error_serializer'
+require 'commons/errors/bad_request'
+require 'commons/errors/conflict'
+require 'commons/errors/default_handling'
+require 'commons/errors/forbidden'
+require 'commons/errors/internal_server_error'
+require 'commons/errors/unprocessable_entity'
+require 'commons/errors/invalid_resource'
+require 'commons/errors/maintenance_mode'
+require 'commons/errors/missing_parameter'
+require 'commons/errors/not_unique'
+require 'commons/errors/payment_required'
+require 'commons/errors/precondition_failed'
+require 'commons/errors/resource_not_found'
+require 'commons/errors/route_not_found'
+require 'commons/errors/unauthorized'
+
+# middleware
+require 'commons/middleware/catch_json_parse_errors'
+
+mydir = __dir__
+
+I18n.load_path += Dir[File.join(mydir, 'commons', 'config', 'locales', '**/*.yml').to_s]
+I18n.reload! if I18n.backend.initialized?
+
+Phonelib.default_country = "MX"
+
+module Commons
+end

data/lib/commons/authentication/authenticate_by_jwt.rb

@@ -0,0 +1,27 @@
+module Commons
+  module Authentication
+    module AuthenticateByJWT
+      def authorize_jwt!
+        raise Commons::Errors::Unauthorized if jwt.blank?
+
+        begin
+          decoded = JSONWebToken.decode(jwt)
+          @current_user = UserRepository.instance.find_by(id: decoded[:user_id])
+        rescue ActiveRecord::RecordNotFound => e
+          raise Commons::Errors::Unauthorized
+        rescue JWT::DecodeError => e
+          raise Commons::Errors::Unauthorized
+        end
+      end
+
+      private
+
+      def jwt
+        jwt ||= request.headers['Authorization']
+        return nil unless jwt.instance_of? String
+
+        jwt = jwt.split(' ').last if jwt
+      end
+    end
+  end
+end

data/lib/commons/authentication/json_web_token.rb

@@ -0,0 +1,17 @@
+module Commons
+  module Authentication
+    class JSONWebToken
+      SECRET_KEY = Commons.secret_key_base.to_s
+
+      def self.encode(payload, exp = 24.hours.from_now)
+        payload[:expires_at] = exp.to_i
+        JWT.encode(payload, SECRET_KEY)
+      end
+
+      def self.decode(token)
+        decoded = JWT.decode(token, SECRET_KEY)[0]
+        HashWithIndifferentAccess.new decoded
+      end
+    end
+  end
+end

data/lib/commons/concerns/attributes/sex.rb

@@ -0,0 +1,19 @@
+module Commons
+  module Concerns
+    module Attributes
+      module Sex
+        extend ActiveSupport::Concern
+
+        FEMALE = 'female'.freeze
+        MALE = 'male'.freeze
+
+        included do
+          enum sex: {
+            female: FEMALE,
+            male: MALE
+          }, _suffix: true
+        end
+      end
+    end
+  end
+end

data/lib/commons/concerns/extensions/deleted.rb

@@ -0,0 +1,25 @@
+module Commons
+  module Concerns
+    module Extensions
+      module Deleted
+        extend ActiveSupport::Concern
+
+        included do
+          before_validation :check_not_deleted, on: [:update]
+
+          def deleted?
+            raise ActiveModel::MissingAttributeError unless self.has_attribute?(:deleted_at)
+            self.deleted_at.present?
+          end
+        end
+
+        private
+
+        def check_not_deleted
+          raise ActiveModel::MissingAttributeError unless self.has_attribute?(:deleted_at)
+          raise ActiveRecord::RecordInvalid if self.deleted_at_in_database.present?
+        end
+      end
+    end
+  end
+end

data/lib/commons/concerns/guard/capitalizable.rb

@@ -0,0 +1,32 @@
+module Commons
+  module Concerns
+    module Guard
+      module Capitalizable
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          attr_reader :only
+
+          private
+
+          def capitalize(only: [])
+            @only = only
+          end
+        end
+
+        included do
+          before_validation :capitalize_attrs
+        end
+
+        private
+
+        def capitalize_attrs
+          self.class.only.each do |attr|
+            value = self.instance_eval(attr.to_s)
+            self.send("#{attr.to_s}=", Commons::Formatter::StringUtils.capitalize(value)) unless value.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/commons/concerns/validations/undestroyable.rb

@@ -0,0 +1,18 @@
+module Commons
+  module Concerns
+    module Validations
+      module Undestroyable
+        extend ActiveSupport::Concern
+        included do
+          before_destroy :prevent_destroy
+        end
+
+        private
+
+        def prevent_destroy
+          raise Commons::Errors::Unauthorized
+        end
+      end
+    end
+  end
+end

data/lib/commons/config.rb

@@ -0,0 +1,11 @@
+module Commons
+  class << self
+    def secret_key_base=(secret_key_base)
+      @secret_key_base = secret_key_base
+    end
+
+    def secret_key_base
+      @secret_key_base || ENV["secret_key_base"]
+    end
+  end
+end

data/lib/commons/config/locales/en.yml

@@ -0,0 +1 @@
+en:

data/lib/commons/config/locales/es.yml

@@ -0,0 +1,58 @@
+es:
+  status_code:
+    IER4001_route_not_found:
+      code: 'IER4001'
+      title: 'Ruta no encontrada'
+      detail: 'IER4001: La ruta solicitada no se encuentra registrada'
+    IER4002_unauthorized:
+      code: 'IER4002'
+      title: 'No tienes permisos validos'
+      detail: 'IER4002: Parece que no tienes los permisos/credenciales correctos'
+    IER4003_bad_request:
+      code: 'IER4003'
+      title: 'El servidor no puede o no procesará la solicitud debido a un error aparente del cliente'
+      detail: 'IER4003: Su solicitud probablemente tenga alguna sintaxis con formato incorrecto, un encabezado incorrecto u otra cosa que no sepamos cómo procesar'
+    IER4004_conflict:
+      code: 'IER4004'
+      title: 'Hay un conflicto'
+      detail: 'IER4004: Su solicitud parece chocar con el estado del servidor'
+    IER4005_forbidden:
+      code: 'IER4005'
+      title: 'Tienes prohibido hacer esto.'
+      detail: 'IER4005: Parece que intentaste hacer algo que no debías hacer'
+    IER4006_invalid_resource:
+      code: 'IER4006'
+      title: 'Errores al procesar las validaciones.'
+      detail: 'IER4006: La información que ha enviado no es válida'
+    IER4007_missing_parameter:
+      code: 'IER4007'
+      title: 'Hacen faltan parámetros.'
+      detail: 'IER4007: Hacen faltan parámetros a la información suministrada'
+    IER4008_not_unique:
+      code: 'IER4008'
+      title: 'Hacen falta parámetros.'
+      detail: 'IER4008: Has violado una restricción de unicidad'
+    IER4009_payment_required:
+      code: 'IER4009'
+      title: 'Necesitas hacer un pago para que esta acción funcione.'
+      detail: 'IER4009: El servidor requiere que se realice un pago antes de continuar.'
+    IER4010_precondition_failed:
+      code: 'IER4010'
+      title: 'No se cumplió una condición previa.'
+      detail: 'IER4010: El servidor no cumple con una de las condiciones previas que el solicitante coloca en la solicitud.'
+    IER4011_resource_not_found:
+      code: 'IER4011'
+      title: 'Recurso no encontrado'
+      detail: 'IER4011: El recurso solicitado no se encuentra registrado'
+    IER4222_unprocessable_entity:
+      code: 'IER4222'
+      title: 'Incapaz de procesar la petición'
+      detail: 'IER4222: No se puede procesar la petición'
+    IER5000_internal_server_error:
+      code: 'IER5000'
+      title: 'Server Error.'
+      detail: 'IER5000: Su solicitud parece haber causado un error de servidor'
+    IER5030_maintenance_mode:
+      code: 'IER5030'
+      title: 'El servidor está en mantenimiento'
+      detail: 'IER5030: Mantenimiento en proceso'

data/lib/commons/controllers/schema_validable.rb

@@ -0,0 +1,27 @@
+module Commons
+  module Controllers
+    module SchemaValidable
+      #
+      # Método que valida datos en base a un Schema
+      #
+      # @param [Hash] request_data datos a validar
+      # @param [Dry::Validation::Contract] schema Schema de validación
+      #
+      # @return [Hash]
+      #
+      # @raise [Commons::Errors::UnprocessableEntity]
+      #
+      def validate_request(request_data, schema)
+        validated_params = schema.call(request_data)
+
+        if validated_params.failure?
+          raise Commons::Errors::UnprocessableEntity.new(nil, nil,
+            meta: { validation_errors: validated_params.errors.to_h }
+          )
+        end
+
+        validated_params.to_h
+      end
+    end
+  end
+end

data/lib/commons/errors/bad_request.rb

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

data/lib/commons/errors/conflict.rb

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

data/lib/commons/errors/default_handling.rb

@@ -0,0 +1,44 @@
+module Commons
+  module Errors
+    module DefaultHandling
+      def self.included(cls)
+        cls.class_eval do
+          # WARNING
+          # Avoid setting rescue_from Exception/StandardError since it will override your
+          # own custom rescue_from handlers https://stackoverflow.com/a/9121054/3287738
+          # WARNING
+          rescue_from ActiveRecord::RecordNotFound do |e|
+            respond ResourceNotFound.new e.message,
+                                         meta: {
+                                           model: e.model,
+                                           id: e.id,
+                                           primary_key: e.primary_key
+                                         }
+          end
+
+          rescue_from ActiveRecord::RecordInvalid do |e|
+            respond InvalidResource.new e.message,
+                                        validation_errors: e&.record&.errors&.to_hash
+          end
+
+          rescue_from ArgumentError do |e|
+            respond InvalidResource.new e.message
+          end
+
+          rescue_from ActiveRecord::RecordNotUnique do |e|
+            respond NotUnique.new e.message
+          end
+
+          rescue_from ActionController::ParameterMissing do |e|
+            respond MissingParameter.new e.message, param: e.param
+          end
+
+          rescue_from ActionController::RoutingError do |e|
+            respond RouteNotFound.new e.message,
+                                      detail: { failures: e.failures }
+          end
+        end
+      end
+    end
+  end
+end