creditario-client 0.0.1.alpha

data/lib/creditario/repositories/expenses.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Expenses
+  #
+  # Repositorio de Egresos, permite realizar las siguientes operaciones
+  # sobre Egresos para Solicitudes de Crédito de creditar.io
+  #
+  # - Obtener un Egreso en especifico:
+  #
+  #     Creditario::Expenses.retrieve("eeedba2e-fc96-4f96-bd2e-bd046b256f96")
+  #     => Creditario::Expense
+  #
+  # - Crear un Egreso:
+  #
+  #     result = Creditario::Expenses.create(classification: "Renta", amount_cents: 25000, credit_application_id: "636264b1-77a2-45ef-b643-e44cfbc84d40")
+  #     => Creditario::Expense
+  #
+  # - Eliminar un Egreso:
+  #
+  #     result = Creditario::Expenses.delete("eeedba2e-fc96-4f96-bd2e-bd046b256f96")
+  #     => true
+  module Expenses
+    extend Creditario::API::Retrieve
+    extend Creditario::API::Create
+    extend Creditario::API::Delete
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Egresos.
+    def self.resource_path
+      "/expenses"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::Expense
+    end
+  end
+end

data/lib/creditario/repositories/incomes.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Incomes
+  #
+  # Repositorio de Ingresos, permite realizar las siguientes operaciones
+  # sobre Ingresos para Solicitudes de Crédito de creditar.io
+  #
+  # - Obtener un Ingreso en especifico:
+  #
+  #     Creditario::Incomes.retrieve("0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a")
+  #     => Creditario::Income
+  #
+  # - Crear un Ingreso:
+  #
+  #     result = Creditario::Incomes.create(classification: "Trabajo", amount_cents: 45000, credit_application_id: "636264b1-77a2-45ef-b643-e44cfbc84d40")
+  #     => Creditario::Income
+  #
+  # - Eliminar un Ingreso:
+  #
+  #     result = Creditario::Incomes.delete("0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a")
+  #     => true
+  module Incomes
+    extend Creditario::API::Retrieve
+    extend Creditario::API::Create
+    extend Creditario::API::Delete
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Ingresos.
+    def self.resource_path
+      "/incomes"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::Income
+    end
+  end
+end

data/lib/creditario/repositories/payments.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Payments
+  #
+  # Repositorio de Pagos, permite obtener la lista de Pagos a partir de un Crédito.
+  #
+  # - Listar Pagos por Crédito:
+  #
+  #     Creditario::Payments.list(credit_id: "2e9d05b8-2180-4779-bab6-bdfd41d1569f")
+  #     => Creditario::ResourcesCollection
+  #
+  # - Crear un Pago:
+  #
+  #     Creditario::Payments.create(installment_id: "9270cc36-5f90-448a-8fd8-cff7c7bd1f75", amount_cents: 100000, payment_type: "annuity", prepaid_type: "not_reduce", payment_method: "SPEI", forgive_penalty_interest: "false")
+  #     => Creditario::Payment
+  module Payments
+    extend Creditario::API::List
+    extend Creditario::API::Create
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Pagos.
+    def self.resource_path
+      "/payments"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API
+    def self.resource_class
+      Creditario::Payment
+    end
+  end
+end

data/lib/creditario/repositories/products.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Products
+  #
+  # Repositorio de Productos, permite realizar las siguientes operaciones
+  # sobre Productos de creditar.io:
+  #
+  # - Obtener todos los Productos Activos:
+  #
+  #     result = Creditario::Products.list
+  #     => Creditario::PaginatedCollection
+  #
+  #     result.items
+  #     => [Creditario::Product, Creditario::Product, ...]
+  #
+  # - Obtener un Producto en especifico:
+  #
+  #     Creditario::Products.retrieve("c005b7f7-a44a-4ec0-bf7f-73d15d806fd9")
+  #     => Creditario::Product
+  module Products
+    extend Creditario::API::List
+    extend Creditario::API::Retrieve
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Productos.
+    def self.resource_path
+      "/products"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::Product
+    end
+  end
+end

data/lib/creditario/repositories/references.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::References
+  #
+  # Repositorio de Referencias, permite realizar las siguientes operaciones
+  # sobre Referencias para Solicitudes de Crédito de creditar.io
+  #
+  # - Obtener una Referencia en especifico:
+  #
+  #     Creditario::References.retrieve("0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a")
+  #     => Creditario::Referencia
+  #
+  # - Crear una Referencia:
+  #
+  #     result = Creditario::References.create(classification: "Amistad", name: "Diane Nguyen", phone: "3129743789", credit_application_id: "636264b1-77a2-45ef-b643-e44cfbc84d40")
+  #     => Creditario::Referencia
+  #
+  # - Eliminar una Referencia:
+  #
+  #     result = Creditario::References.delete("0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a")
+  #     => true
+  module References
+    extend Creditario::API::Retrieve
+    extend Creditario::API::Create
+    extend Creditario::API::Delete
+
+    ###
+    # Path de la API donde se ejecutan las peticiones para Referencias.
+    def self.resource_path
+      "/references"
+    end
+
+    ###
+    # Clase a utilizar para transformar las respuestas de la API.
+    def self.resource_class
+      Creditario::Reference
+    end
+  end
+end

data/lib/creditario/resources/application.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Application
+  #
+  # Representa una Aplicación de Credito del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => credit_application = Creditario::Application.new({"id": "636264b1-77a2-45ef-b643-e44cfbc84d40", "application_number": "UENDSND-1", "flow": "inicio"})
+  #   => credit_application.id
+  #   => "636264b1-77a2-45ef-b643-e44cfbc84d40"
+  #   => credit_application.flow = "referencias"
+  #   => "referencias"
+  #   => credit_application[:application_number]
+  #   => "UENDSND-1"
+  class Application
+    include Resource
+
+    has_one :product, class: Creditario::Product
+    has_one :contract, class: Creditario::Contract
+    has_many :incomes, class: Creditario::Income
+    has_many :expenses, class: Creditario::Expense
+    has_many :references, class: Creditario::Reference
+  end
+end

data/lib/creditario/resources/attachment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc
+  ###
+  # == Creditario::Attachment
+  #
+  # Representa un Archivo del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => attachment = Creditario::Attachment.new({"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e", "attachment_type": "INE", "url": "http://creditar.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBGUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4f40e5eabc39d2215d0ce08a1ad735df3bcf74b4/image.jpg"})
+  #   => attachment.id
+  #   => "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
+  #   => attachment[:url]
+  #   => "http://creditario.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBGUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4f40e5eabc39d2215d0ce08a1ad735df3bcf74b4/image.jpg"
+  class Attachment
+    include Resource
+  end
+end

data/lib/creditario/resources/catalog.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Catalog
+  #
+  # Representa un Catálogo del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => catalog = Creditario::Catalog.new({resource: "customer", field: "source"})
+  #   => catalog.resource
+  #   => "customer"
+  #   => catalog[:field]
+  #   => "source"
+  class Catalog
+    include Resource
+  end
+
+  ###
+  # == Creditario::CatalogValue
+  #
+  # Representa un Valor de Catálogo del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => catalog = Creditario::CatalogValue.new({name: "Revista", value: "revista"})
+  #   => catalog.name
+  #   => "Revista"
+  #   => catalog[:value]
+  #   => "revista"
+  class CatalogValue
+    include Resource
+  end
+end

data/lib/creditario/resources/contract.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Contract
+  #
+  # Representa un Contrato del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => contract = Creditario::Contract.new({"id": "c005b7f7-a44a-4ec0-bf7f-73d15d806fd9", body: "Contrato del Crédito..."})
+  #   => contract.id
+  #   => "c005b7f7-a44a-4ec0-bf7f-73d15d806fd9"
+  #   => contract.body
+  #   => "Contrato del Crédito..."
+  #   => contract[:body]
+  #   => "Contrato del Crédito..."
+  class Contract
+    include Resource
+  end
+end

data/lib/creditario/resources/credit.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Credit
+  #
+  # Representa un Crédito del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => credit = Creditario::Credit.new({"id": "636264b1-dc0d-453e-8804-4ac451e1dbd5", "credit_application_id": "636264b1-77a2-45ef-b643-e44cfbc84d40", "customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c", "contract_id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a", "installment_plan": [] })
+  #   => credit.id
+  #   => "636264b1-dc0d-453e-8804-4ac451e1dbd5"
+  #   => credit[:customer_id]
+  #   => "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
+  class Credit
+    include Resource
+  end
+end

data/lib/creditario/resources/credit_estimate.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::CreditEstimate
+  #
+  # Representa una Estimación de Crédito del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => credit_estimate = Creditario::CreditEstimate.new({ "total_interest_amount_cents": 100000, "total_credit_amount_cents": 1100000 })
+  #   => credit_estimate.total_interest_amount_cents
+  #   => 100000
+  #   => credit_estimate[:total_credit_amount_cents]
+  #   => 1100000
+  class CreditEstimate
+    include Resource
+  end
+end

data/lib/creditario/resources/customer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Customer
+  #
+  # Representa un Cliente del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => customer = Creditario::Customer.new({first_name: "Juan", last_name: "Carlos", credit_applications: [{"id": "636264b1-77a2-45ef-b643-e44cfbc84d40"}]})
+  #   => customer.first_name
+  #   => "Juan"
+  #   => customer.first_name = "Pepé"
+  #   => "Pepé"
+  #   => customer[:first_name]
+  #   => "Pepé"
+  #   => customer[:first_name] = "Juan"
+  #   => "Juan"
+  class Customer
+    include Resource
+
+    has_many :credit_applications, class: Creditario::Application
+  end
+end

data/lib/creditario/resources/expense.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Creditario
+  ###
+  # == Creditario::Expense
+  #
+  # Representa un Egreso del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => expense = Creditario::Expense.new({"id": "aff581fc-ba6e-49f2-9be7-73ef20043d1c", "classification": "Renta", "amount_cents": 30000})
+  #   => expense.id
+  #   => aff581fc-ba6e-49f2-9be7-73ef20043d1c
+  #   => expense[:amount_cents]
+  #   => 30000
+  class Expense
+    include Resource
+  end
+end

data/lib/creditario/resources/income.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Income
+  #
+  # Representa un Ingreso del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => income = Creditario::Income.new({"id": "2ff8779b-ba6e-49f2-9be7-73ef20043d1c", "classification": "Trabajo", "amount_cents": 500000})
+  #   => income.id
+  #   => 2ff8779b-ba6e-49f2-9be7-73ef20043d1c
+  #   => income[:amount_cents]
+  #   => 500000
+  class Income
+    include Resource
+  end
+end

data/lib/creditario/resources/payment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Payment
+  #
+  # Representa un Pago del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => payment = Creditario::Payment.new({"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c", "payment_type": "annuity", "amount_cents": 100000})
+  #   => payment.id
+  #   => "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
+  #   => payment.payment_type = "annuity"
+  #   => "annuity"
+  #   => payment[:amount_cents]
+  #   => 100000
+  class Payment
+    include Resource
+  end
+end