ant-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 684d845bdd989ba73fe3b462f2ce7806bdbdb1bd0f972d5c7be23904c97bba02
+  data.tar.gz: ccd3efc7a6dbaeddf2b4f57ad897d769cb1ba42c58089a6fee59d8ccded248c9
+SHA512:
+  metadata.gz: e1603d2802d7aab513178e4fd9769e4380afaa18ed3bbe3e0ec8849ca523629695173d9dd28df939680a032d6f9727c2824122edfd7dd59c70ee5510acf3e7c0
+  data.tar.gz: 26c7583a6da8c1cf0c61834ecafbc1352f982b123eb9d36f482bdfefe7a4e5fefc24146b7ca4de0327a586c5dbd91ccce18d68ec89cf5c9728a3d4a6693cc060

data/lib/ant/core.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Ant
+  module DRY
+    autoload(:Daemon, 'ant/dry/daemon.rb')
+    autoload(:ResourceInjector, 'ant/dry/resource_injector.rb')
+  end
+  autoload(:Exceptions, 'ant/exceptions.rb')
+end

data/lib/ant/dry/daemon.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'ant/logger'
+
+module Ant
+  module DRY
+    # Use this for running tasks that will be looping by only sending a lambda
+    # TODO: Improve this class.
+    # - Add a maechanism for killing the process
+    # - Add a function to test how many threads are alive
+    # - Make it testable
+    # - Add unit tests
+    class Daemon
+      include Ant::Logger
+
+      def initialize(wait_time, attach, retry_on_failure = false)
+        @proc = -> { yield }
+        @wait_time = wait_time
+        @attach = attach
+        @retry_on_failure = retry_on_failure
+        @finish = false
+      end
+
+      def task
+        log_info 'starting daemon'
+        loop do
+          begin
+            @proc.call
+          rescue StandardError => ex
+            raise unless @retry_on_failure
+
+            # :nocov: #
+            log_error('Unexpected error', error: ex)
+            # :nocov: #
+          end
+          sleep(@wait_time)
+        end
+      end
+
+      def run
+        if @attach
+          task
+        else
+          # :nocov: #
+          @thread = Thread.new { task }
+          # :nocov: #
+        end
+      end
+
+      # :nocov: #
+      def await
+        @thread&.join
+      end
+      # :nocov: #
+    end
+  end
+end

data/lib/ant/dry/resource_injector.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Ant
+  module DRY
+    ##
+    # Provides a method for sending external dependencies
+    # to classes, like database connections, configurations,
+    # and other objects that can vary but does not modify
+    # the class functionality.
+    # This class works a decorator to be just extended
+    # by classes
+    #
+    #  class Controller
+    #    extend ResourceInjector
+    #  end
+    module ResourceInjector
+      # Initialices the resources value and returns the object.
+      # This method should not be used from the out context.
+      # Resources are grouped by key
+      def resources(key)
+        @resources ||= {}
+        @resources[key] ||= {}
+        @resources[key]
+      end
+
+      # Provides the interface for sending objects inside the class.
+      # The resources have a group and sub group.
+      # When no group is given, it will be added to the :root group
+      # ==== Examples
+      #   Controller.inject(:magic_number, 42)
+      #   Controller.inject(:databases, :database_conection, Sequel.connect)
+      def register(key, subkey, value = nil)
+        if value.nil?
+          value = subkey
+          subkey = key
+          key = :root
+        end
+        resources(key)[subkey] = value
+      end
+
+      # Provides the inside interface for fetching the objects that were
+      # previously provided from the external world.
+      # Also, when no subgroup is given, the key is fetched from :root
+      # ==== Examples
+      #   class Controller
+      #     def initialize
+      #       @magic_number = self.class.resource(:magic_number)
+      #     end
+      #
+      #     def self.factory(id)
+      #       db = resource(:databases, :database_conection)
+      #     end
+      #   end
+      def resource(key, subkey = nil)
+        if subkey.nil?
+          subkey = key
+          key = :root
+        end
+        res = resources(key)[subkey]
+        raise("Resource `#{key}::#{subkey}` Not Found") if res.nil?
+
+        res
+      end
+    end
+  end
+end

data/lib/ant/exceptions.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Ant
+  module Exceptions
+    autoload(:HTTP, 'ant/http_exceptions.rb')
+    ##
+    # Exception used as standard error on this gem.
+    # @param message.  This param is meant to be read by another developer
+    #                  It would be nice if the message were self descriptive
+    #                  enough so the developer won't need to ask the creator
+    #                  of the app for help.
+    # @param code.     The code is similar to message, but for this case
+    #                  it is meant to be used for the program to handle
+    #                  exceptions and to make easier to identify the exception..
+    #                  The default is the exception class, so it won't change
+    #                  almost never.
+    # @param data.     Contains additional data to detail the error.
+    class AntBaseException < StandardError
+      attr_reader :message, :code, :data
+      def initialize(message, code, data)
+        @message = message
+        @code = code
+        @data = data
+      end
+
+      def to_log_format
+        to_h.merge(class: self.class.name)
+      end
+
+      def to_h
+        {
+          message: message,
+          code: code,
+          data: data,
+          backtrace: backtrace
+        }
+      end
+    end
+
+    ##
+    # Is used to express a success with the client's request.
+    class AntSuccess < AntBaseException
+      def initialize(message, code = nil, data = {})
+        code ||= self.class.name.split('::').last
+        super(message, code, data)
+      end
+    end
+
+    ##
+    # Is used to express a problem with the client's request.
+    class AntFail < AntBaseException
+      def initialize(message, code = nil, data = {})
+        code ||= self.class.name.split('::').last
+        code = 'BadRequest' if code == 'AntFail'
+        super(message, code, data)
+      end
+    end
+
+    ##
+    # Is used to express an error that was found during the execution of the
+    # program but it also means that the invoked endpoint has not the power to
+    # fix it, so it will only complain.
+    class AntError < AntBaseException
+      def initialize(message, code = nil, data = {})
+        code ||= self.class.name.split('::').last
+        code = 'ServerError' if code == 'AntError'
+        super(message, code, data)
+      end
+    end
+  end
+end

data/lib/ant/http_exceptions.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'exceptions'
+
+module Ant
+  module Exceptions
+    # Provides basic execptions for http common errors.
+    module HTTP
+      class << self
+        EXCEPTION_TYPES = {
+          success: Ant::Exceptions::AntSuccess,
+          fail: Ant::Exceptions::AntFail,
+          error: Ant::Exceptions::AntError
+        }.freeze
+
+        def new_http_exception(class_name, http_code, type)
+          parent = exception_type(type)
+          http_exception_class = Class.new(parent) do
+            def initialize(message, object = {})
+              super(message, nil, object)
+            end
+
+            define_method 'http_code' do
+              http_code
+            end
+          end
+
+          const_set(class_name, http_exception_class)
+        end
+
+        private
+
+        def exception_type(type)
+          EXCEPTION_TYPES[type.to_sym]
+        end
+      end
+
+      http_codes = [
+        { code_name: 'Ok', code: 200, type: :success },
+        { code_name: 'Created', code: 201, type: :success },
+        { code_name: 'Accepted', code: 202, type: :success },
+        { code_name: 'NoContent', code: 204, type: :success },
+        { code_name: 'BadRequest', code: 400, type: :fail },
+        { code_name: 'Unauthorized', code: 401, type: :fail },
+        { code_name: 'Forbidden', code: 403, type: :fail },
+        { code_name: 'NotFound', code: 404, type: :fail },
+        { code_name: 'NotValid', code: 422, type: :fail }
+      ]
+
+      http_codes.each do |code|
+        Exceptions::HTTP.new_http_exception(
+          code[:code_name],
+          code[:code],
+          code[:type]
+        )
+      end
+    end
+  end
+end

data/lib/ant/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ant
+  module Core
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: ant-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gilberto Vargas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ant-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rack-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: |2
+      Ant::Core will be used across all the ant gems. Provides the most basic
+      functionality or what might be used along with more than one gem.
+      Currently this only exposes the basic exceptions and the DRY patterns.
+email:
+- tachoguitar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ant/core.rb
+- lib/ant/dry/daemon.rb
+- lib/ant/dry/resource_injector.rb
+- lib/ant/exceptions.rb
+- lib/ant/http_exceptions.rb
+- lib/ant/version.rb
+homepage: https://github.com/tachomex/ant
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ant framework core functionality
+test_files: []