commons_yellowme 0.11.0

data/lib/commons/repositories/catalogs/base_catalog.rb

@@ -0,0 +1,68 @@
+module Commons
+  module Repositories
+    module Catalogs
+      class BaseCatalog
+        include Singleton
+        include Commons::Repositories::Catalogs::Concerns::ModelCachingExtention
+
+        #
+        # 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)
+          clear_cache
+          @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)
+          clear_cache
+          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)
+          clear_cache
+
+          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
+end

data/lib/commons/repositories/catalogs/concerns/model_caching_extention.rb

@@ -0,0 +1,27 @@
+module Commons
+  module Repositories
+    module Catalogs
+      module Concerns
+        module ModelCachingExtention
+          extend ActiveSupport::Concern
+
+          included do
+            # The first time you call Model.all_cached it will cache the collection,
+            # each consequent call will not fire the DB query
+            def all_cached
+              Rails.cache.fetch("cached_#{self.class.name.underscore.to_s.gsub("/", "_")}") { @db_client.all.load }
+            end
+
+            private
+
+            # Making sure, that data is in consistent state by removing the cache
+            # everytime, the table is touched (eg some record is edited/created/destroyed etc).
+            def clear_cache
+              Rails.cache.delete("cached_#{self.class.name.underscore.to_s.gsub("/", "_")}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/commons/services/concerns/callable.rb

@@ -0,0 +1,15 @@
+module Commons
+  module Services
+    module Concerns
+      module Callable
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def call(*args)
+            new(*args).call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/commons/version.rb

@@ -0,0 +1,3 @@
+module Commons
+  VERSION = '0.11.0'
+end

data/lib/tasks/commons_tasks.rake

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

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification
+name: commons_yellowme
+version: !ruby/object:Gem::Version
+  version: 0.11.0
+platform: ruby
+authors:
+- Yellowme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.10
+- !ruby/object:Gem::Dependency
+  name: strip_attributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: phonelib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.29
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.29
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Commons is Yellowme's Rails APIs utilities gem
+email: hola@yellowme.mx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/commons.rb
+- lib/commons/authentication/authenticate_by_jwt.rb
+- lib/commons/authentication/json_web_token.rb
+- lib/commons/concerns/attributes/sex.rb
+- lib/commons/concerns/extensions/deleted.rb
+- lib/commons/concerns/guard/capitalizable.rb
+- lib/commons/concerns/validations/undestroyable.rb
+- lib/commons/config.rb
+- lib/commons/config/locales/en.yml
+- lib/commons/config/locales/es.yml
+- lib/commons/controllers/schema_validable.rb
+- lib/commons/errors/bad_request.rb
+- lib/commons/errors/conflict.rb
+- lib/commons/errors/default_handling.rb
+- lib/commons/errors/error_base.rb
+- lib/commons/errors/error_serializer.rb
+- lib/commons/errors/forbidden.rb
+- lib/commons/errors/internal_server_error.rb
+- lib/commons/errors/invalid_resource.rb
+- lib/commons/errors/maintenance_mode.rb
+- lib/commons/errors/missing_parameter.rb
+- lib/commons/errors/not_unique.rb
+- lib/commons/errors/payment_required.rb
+- lib/commons/errors/precondition_failed.rb
+- lib/commons/errors/resource_not_found.rb
+- lib/commons/errors/route_not_found.rb
+- lib/commons/errors/unauthorized.rb
+- lib/commons/errors/unprocessable_entity.rb
+- lib/commons/formatter/e164_phone.rb
+- lib/commons/formatter/null_attributes_remover.rb
+- lib/commons/formatter/regex_constants.rb
+- lib/commons/formatter/string_utils.rb
+- lib/commons/middleware/catch_json_parse_errors.rb
+- lib/commons/railtie.rb
+- lib/commons/repositories/base_repository.rb
+- lib/commons/repositories/catalogs/base_catalog.rb
+- lib/commons/repositories/catalogs/concerns/model_caching_extention.rb
+- lib/commons/services/concerns/callable.rb
+- lib/commons/version.rb
+- lib/tasks/commons_tasks.rake
+homepage: https://github.com/yellowme/commons-rails
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Commons is Yellowme's Rails APIs utilities gem
+test_files: []