creditario-client 0.0.1.alpha

data/lib/creditario/client/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "creditario/client"
+require "rails"
+
+module Creditario # :nodoc:
+  class Railtie < Rails::Railtie # :nodoc:
+    railtie_name :creditario
+
+    generators do
+      require_relative "../../generators/creditario/install_generator"
+    end
+  end
+end

data/lib/creditario/client/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Creditario
+  module Client
+    ###
+    # Versión actual de la gema *creditario-client*
+    VERSION = "0.0.1.alpha"
+  end
+end

data/lib/creditario/exceptions.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Creditario
+  ###
+  # === Creditario::Exceptions
+  #
+  # Modulo para definir todas las excepciones reconocidas para esta gema.
+  module Exceptions
+    ###
+    # Excepción arrojada cuando se intenta hacer un request sin haber
+    # especificado un api_key.
+    #
+    # Para arreglar este error es necesario definir el api_key de la siguiente manera:
+    #
+    #   Creditario::Client.api_key = "tu-api-key"
+    class MissingAPIKeyError < StandardError
+      def initialize(msg = "No API Key Provided") # :nodoc:
+        super
+      end
+    end
+
+    ###
+    # Excepción arrojada cuando se intenta acceder a algún recurso
+    # que no existe en creditar.io
+    #
+    # Si se rescata esta excepción, se puede acceder a su atributo *server_response*
+    # para obtener la respuesta de creditar.io
+    class ResourceNotFoundError < StandardError
+      ###
+      # Contiene los detalles de la respuesta de creditar.io
+      attr_reader :server_response
+
+      def initialize(response) # :nodoc:
+        @server_response = Oj.load(response.body)
+        super(msg = "The resource does not exist")
+      end
+    end
+
+    ###
+    # Excepción arrojada cuando durante la creación o actualización
+    # de algún recurso, se envían datos inválidos a creditar.io
+    #
+    # Si se rescata esta excepción, se puede acceder a su atributo *server_response*
+    # para obtener la respuesta de creditar.io
+    class UnprocessableEntityError < StandardError
+      ###
+      # Contiene los detalles de la respuesta de creditar.io
+      attr_reader :server_response
+
+      def initialize(response) # :nodoc:
+        @server_response = Oj.load(response.body)
+        super(msg = "There are some validation issues")
+      end
+    end
+
+    ###
+    # Excepción arrojada cuando existen restricciones para crear o modificar un
+    # recurso en creditar.io
+    #
+    # Si se rescata esta excepción, se puede acceder a su atributo *server_response*
+    # para obtener la respuesta de creditar.io
+    class ForbiddenError < StandardError
+      ###
+      # Contiene los detalles de la respuesta de creditar.io
+      attr_reader :server_response
+
+      def initialize(response) # :nodoc:
+        @server_response = Oj.load(response.body)
+        super(msg = "There are restrictions on the resource")
+      end
+    end
+
+    ###
+    # Excepción arrojada cuando se intenta hacer un request con una API Key inválida.
+    # Para arreglar este error es necesario definir la API Key correcta.
+    #
+    #   Creditario::Client.api_key = "tu-api-key"
+    class InvalidAPIKeyError < StandardError
+      def initialize(msg = "The API Key provided is invalid or it has expired.") # :nodoc:
+        super
+      end
+    end
+
+    ###
+    # Excepción arrojada cuando no se puede establecer comunicación con el servidor
+    # de la API de creditar.io
+    class APINotReachableError < StandardError
+      TECHNICAL_MESSAGE = "Technical message -> " # :nodoc:
+      HUMAN_MESSAGE = "Looks like the API for creditar.io is down.\n" # :nodoc:
+
+      def initialize(message) # :nodoc:
+        super(msg = "#{HUMAN_MESSAGE}#{TECHNICAL_MESSAGE}#{message}")
+      end
+    end
+
+    ###
+    # Excepción arrojada cuando el servidor de creditar.io regresa una respuesta que no es JSON
+    # Probablemente estás mandando un header incorrecto.
+    class InvalidResponseBodyError < StandardError
+      TECHNICAL_MESSAGE = "Technical message -> " # :nodoc:
+      HUMAN_MESSAGE = "The API responded with something that is not JSON, is your request ok?\n" # :nodoc:
+
+      def initialize(message) # :nodoc:
+        super(msg = "#{HUMAN_MESSAGE}#{TECHNICAL_MESSAGE}#{message}")
+      end
+    end
+
+    ###
+    # Excepción arrojada cuando el servidor de creditar.io se tarda mucho en responder.
+    # O cuando se pierde la conexión de internet a medio request.
+    # Probablemente reintentando la petición se solucione el problema.
+    class APIBusyError < StandardError
+      TECHNICAL_MESSAGE = "Technical message -> " # :nodoc:
+      HUMAN_MESSAGE = "The communication with the API has timed out.\n" # :nodoc:
+
+      def initialize(message) # :nodoc:
+        super(msg = "#{HUMAN_MESSAGE}#{TECHNICAL_MESSAGE}#{message}")
+      end
+    end
+  end
+end

data/lib/creditario/repositories/applications.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Applications
+  #
+  # Repositorio de Solicitudes de Crédito, permite realizar las siguientes operaciones
+  # sobre Solicitudes de Crédito de creditar.io
+  #
+  # - Obtener todas las Solicitudes:
+  #
+  #     result = Creditario::Applications.list
+  #     => Creditario::PaginatedCollection
+  #
+  #     result.items
+  #     => [Creditario::Application, Creditario::Application, ...]
+  #
+  # - Obtener una Solicitud en especifico:
+  #
+  #     Creditario::Applications.retrieve("0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a")
+  #     => Creditario::Application
+  #
+  # - Crear una Solicitud:
+  #
+  #     result = Creditario::Applications.create(customer_id: "2e9d05b8-2180-4779-bab6-bdfd41d1569f", product_id: "c005b7f7-a44a-4ec0-bf7f-73d15d806fd9")
+  #     => Creditario::Application
+  #
+  # - Actualizar una Solicitud:
+  #
+  #     result = Creditario::Applications.update("c0324939-0802-41b2-b81e-04e8982270ec", { street: "Avenida Siempre Viva", exterior_number: "742" })
+  #     => Creditario::Application
+  module Applications
+    extend Creditario::API::List
+    extend Creditario::API::Retrieve
+    extend Creditario::API::Create
+    extend Creditario::API::Update
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Solicitudes.
+    def self.resource_path
+      "/applications"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::Application
+    end
+  end
+end

data/lib/creditario/repositories/attachments.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Attachments
+  #
+  # Repositorio de Archivos, permite realizar las siguientes operaciones
+  # sobre Archivos para Solicitudes de Crédito y Clientes de creditario.io
+  #
+  # - Obtener un Archivo en especifico:
+  #
+  #     Creditario::Attachments.retrieve("aabfd43d-6f63-44dd-b7d9-9352a101d11e")
+  #     => Creditario::Attachment
+  #
+  # - Crear un Archivo:
+  #
+  #   Nota: Para el envío del archivo es necesario utilizar la clase +UploadIO.new+.
+  #
+  #     file_upload_io = UploadIO.new(File.new("@/path/to/a/file.jpg"), "image/jpg", "file.jpg")
+  #
+  #     result = Creditario::Attachments.create(
+  #       attachmentable_type: "credit_application",
+  #       attachmentable_id: "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
+  #       attachment_type: "INE",
+  #       file: file_upload_io
+  #     )
+  #     => Creditario::Attachment
+  #
+  # - Eliminar un Archivo:
+  #
+  #     result = Creditario::Attachments.delete("aabfd43d-6f63-44dd-b7d9-9352a101d11e")
+  #     => true
+  class Attachments
+    extend Creditario::API::Multipart
+    extend Creditario::API::Retrieve
+    extend Creditario::API::Delete
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Egresos.
+    def self.resource_path
+      "/attachments"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::Attachment
+    end
+  end
+end

data/lib/creditario/repositories/catalogs.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Catalogs
+  #
+  # Repositorio de Catálogos, permite realizar las siguientes operaciones
+  # sobre Catálogos de creditar.io:
+  #
+  # - Obtener todos los Catálogos disponibles:
+  #
+  #     result = Creditario::Catalogs.list
+  #     => Creditario::ResourcesCollection
+  #
+  #     result.items
+  #     => [Creditario::Catalog, Creditario::Catalog, ...]
+  #
+  # - Obtener los valores de un Catálogo en especifico:
+  #
+  #     Creditario::Catalog.retrieve(resource: "customer", field: "source")
+  #     => Creditario::ResourcesCollection
+  module Catalogs
+    extend Creditario::API::List
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Catálogos
+    def self.resource_path
+      if caller_locations[0].label == "retrieve"
+        "/catalog"
+      else
+        "/catalogs"
+      end
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      if caller_locations[0].label == "retrieve"
+        Creditario::CatalogValue
+      else
+        Creditario::Catalog
+      end
+    end
+
+    ###
+    # Método para obtener los valores de un Catálogo, que generalmente son varios.
+    # Es por ello que no se extendió el modulo Creditario::API::Retrieve ya que ese está pensado
+    # para procesar un solo Recurso a la vez.
+    #
+    # Los *search_params* necesitan ser **resource** y **field** tal y como se especifica
+    # en la descripción del Repositorio Creditario::Catalogs.
+    def self.retrieve(**search_params)
+      response = API.request(:get, resource_path, search_params)
+      ResourcesCollection.new(response, self.resource_class)
+    rescue Creditario::Exceptions::ResourceNotFoundError => exception
+      exception.server_response
+    end
+  end
+end

data/lib/creditario/repositories/contracts.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Contracts
+  #
+  # Repositorio de Contratos, permite realizar las siguientes operaciones
+  # sobre Contratos de creditar.io:
+  #
+  # - Obtener un Contrato en especifico:
+  #
+  #     Creditario::Contracts.retrieve("c005b7f7-a44a-4ec0-bf7f-73d15d806fd9")
+  #     => Creditario::Contract
+  module Contracts
+    extend Creditario::API::Retrieve
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Contratos.
+    def self.resource_path
+      "/contracts"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::Contract
+    end
+  end
+end

data/lib/creditario/repositories/credit_estimates.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::CreditEstimates
+  #
+  # Repositorio de Estimaciones de Crédito, permite obtener una Estimación de Crédito
+  # en base a un Producto de creditar.io:
+  #
+  # - Obtener una Estimación:
+  #
+  #     Creditario::CreditEstimates.retrieve(nil, product_id: "c005b7f7-a44a-4ec0-bf7f-73d15d806fd9", amount_cents: 1000000, installments_number: 12)
+  #     => Creditario::CreditEstimate
+  module CreditEstimates
+    extend Creditario::API::Retrieve
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Estimaciones.
+    def self.resource_path
+      "/credit_estimates"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::CreditEstimate
+    end
+  end
+end

data/lib/creditario/repositories/credits.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Credits
+  #
+  # Repositorio de Créditos, permite obtener la lista de Créditos a partir de un Cliente
+  # así como obtener un Crédito a partir de su ID.
+  #
+  # - Listar Créditos por Cliente:
+  #
+  #     Creditario::Credits.list(customer_id: "2e9d05b8-2180-4779-bab6-bdfd41d1569f")
+  #     => Creditario::ResourcesCollection
+  #
+  # - Obtener un Crédito:
+  #
+  #     Creditario::Credits.retrieve("636264b1-dc0d-453e-8804-4ac451e1dbd5")
+  #     => Creditario::Credit
+  module Credits
+    extend Creditario::API::List
+    extend Creditario::API::Retrieve
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Créditos.
+    def self.resource_path
+      "/credits"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API
+    def self.resource_class
+      Creditario::Credit
+    end
+  end
+end

data/lib/creditario/repositories/customers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Customers
+  #
+  # Repositorio de Clientes, permite realizar las siguientes operaciones
+  # sobre Clientes de creditar.io
+  #
+  # - Obtener todos los Clientes:
+  #
+  #     result = Creditario::Customers.list
+  #     => Creditario::PaginatedCollection
+  #
+  #     result.items
+  #     => [Creditario::Customer, Creditario::Customer, ...]
+  #
+  # - Obtener un Cliente en especifico:
+  #
+  #     Creditario::Customers.retrieve("2e9d05b8-2180-4779-bab6-bdfd41d1569f")
+  #     => Creditario::Customer
+  #
+  # - Crear un Cliente:
+  #
+  #     result = Creditario::Customers.create(email: "karla@quieredinero.com")
+  #     => Creditario::Customer
+  #
+  # - Actualizar un cliente:
+  #
+  #     result = Creditario::Customers.update("2e9d05b8-2180-4779-bab6-bdfd41d1569f", { email: "karina@necesitadinero.com" })
+  #     => Creditario::Customer
+  module Customers
+    extend Creditario::API::List
+    extend Creditario::API::Retrieve
+    extend Creditario::API::Create
+    extend Creditario::API::Update
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Clientes.
+    def self.resource_path
+      "/customers"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API
+    def self.resource_class
+      Creditario::Customer
+    end
+  end
+end