creditario-client 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3f134863c3b8a41b1aa6a04ab85ecdea2f8351a
+  data.tar.gz: 3ad89b47f7616b79e9a9749b9e14fbffdd95f234
+SHA512:
+  metadata.gz: 36fcf9b0ff2df07227c8e2f36990be0bc4ac065395694cb3b288fca90434826c016a9ad7c9419f63cb7913600c8e5b44a29484ccdb793ae6f36fe9e3b8146430
+  data.tar.gz: 478866bd223b0f8b66f780574a11d152bfc166c0f207c2effa0ac30312aed4ad7a0db309d743ef352f88a6d31a150bcc956fe9266ac76ec35dfc46e7385d93c9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+/public
+/vendor
+
+*.gem

data/.gitlab-ci.yml

@@ -0,0 +1,23 @@
+image: registry.michelada.io/financial/creditario-client/ci
+
+cache:
+  key: ${CI_COMMIT_REF_SLUG}
+  paths:
+    - vendor/ruby
+
+before_script:
+  - gem install bundler
+  - bundle install -j $(nproc) --path vendor
+
+# the 'pages' job will deploy and build your site to the 'public' path
+pages:
+  stage: deploy
+  script:
+    - bundle exec sdoc . -T rails --exclude="vendor/|test/"
+    - mv doc public
+  artifacts:
+    paths:
+      - public
+  only:
+    - master # this job will affect only the 'master' branch
+

data/.rubocop.yml

@@ -0,0 +1,155 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/StringConversionInInterpolation:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eduardofigarola@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,3 @@
+FROM ruby:2.5.3-alpine3.9
+RUN apk update && apk upgrade && \
+    apk add --no-cache git build-base

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in creditario-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 michelada.io
+
+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,241 @@
+# Creditario::Client
+
+## Instalación
+
+Solo añade a tu Gemfile:
+
+    gem "creditario-client", git: "git@git.michelada.io:financial/creditario-client.git"
+
+## Uso
+
+### Ruby on Rails
+
+#### 5.2+
+
+Si utilizas Ruby on Rails en su versión 5.2, hay 2 cosas que debes hacer, la primera es:
+
+    $ bundle exec rails g creditario:install
+
+Y la segunda es editar tu archivo de credenciales, para añadir el *api_key* de tu Organización:
+
+    $ EDITOR=vim bundle exec rails credentials:edit
+
+Dentro de tu archivo de credenciales, debes agregar lo siguiente:
+
+    creditario:
+      development:
+        api_key: BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFe
+      production:
+        api_key: v48mbFLupTLWGvYnLVjDqaeEUJEYHmAM # Your production api_key
+
+¡Listo! Ya tienes el cliente para la API de creditar.io totalmente configurado.
+
+#### \< 5.2
+
+En caso de que tu aplicación de Rails no utilice el archivo de credenciales, tal vez prefieras
+utilizar **variables de entorno** para configurar el `api_key` y el `api_base` del cliente para
+la API de creditar.io
+
+Todo lo que tienes que hacer es ejecutar:
+
+    $ bundle exec rails g creditario:install
+
+Y actualizar el archivo `config/creditario.yml` que fue generado previamente:
+
+    default: &default
+      api_base: <%= ENV["CREDITARIO_API_URL"] || "http://localhost:3000" %>
+      api_key: <%= ENV["CREDITARIO_API_KEY"] %>
+
+Listo, ahora solamente deberás inicializar las variables de entorno para que el cliente sea configurado correctamente.
+
+### Fuera de Rails
+
+Si deseas usar la gema fuera de una aplicación de Rails. Justo después de requerirla en tu código debes configurar la `api_key` y la `api_base` a utilizar.
+
+Esto lo puedes lograr con lo siguiente:
+
+    Creditario::Client.api_key = "BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFe"
+    Creditario::Client.api_base = "http://localhost:3000"
+
+## Desarrollo
+
+Recuerda que si necesitas hacer pruebas, deberás tener la API de creditar.io corriendo en tu máquina local o conectarte a la URL de staging.
+
+Si estás haciendo pruebas locales, puedes especificar la URL y el puerto, gracias a la variable de entorno llamada: `CREDITARIO_API_URL`, usala antes de iniciar tus pruebas/desarrollo, ejemplo:
+
+    $ CREDITARIO_API_URL=http://localhost:9000 bundle exec rails server
+
+Por defecto, siempre intentará conectarse a `http://localhost:3000` si no se pasa la variable de entorno.
+
+## Ejemplos
+
+### Productos
+
+Las operaciones que puedes realizar sobre Productos son: listar y obtener.
+
+#### Listar todos los Productos activos
+
+    result = Creditario::Products.list
+    => Creditario::PaginatedCollection
+
+    result.items
+    => [Creditario::Product, Creditario::Product, ...]
+
+#### Obtener un Producto
+
+    Creditario::Products.retrieve("c005b7f7-a44a-4ec0-bf7f-73d15d806fd9")
+    => Creditario::Product
+
+### Clientes
+
+Las operaciones que puedes realizar sobre Clientes son: listar, obtener, crear y actualizar.
+
+#### Listar todos los Clientes
+
+    result = Creditario::Customers.list
+    => Creditario::PaginatedCollection
+
+    result.items
+    => [Creditario::Customer, Creditario::Customer, ...]
+
+#### Obtener un Cliente
+
+    Creditario::Customers.retrieve("2e9d05b8-2180-4779-bab6-bdfd41d1569f")
+    => Creditario::Customer
+
+#### Crear un Cliente
+
+    result = Creditario::Customers.create(email: "karla@quieredinero.com", product_id: "c005b7f7-a44a-4ec0-bf7f-73d15d806fd9")
+    => Creditario::Customer
+
+#### Actualizar un Cliente
+
+    result = Creditario::Customers.update("2e9d05b8-2180-4779-bab6-bdfd41d1569f", { email: "karina@necesitadinero.com" })
+    => Creditario::Customer
+
+### Solicitudes
+
+Las operaciones que puedes realizar sobre Solicitudes son: listar, obtener, crear y actualizar.
+
+#### Listar todas las Solicitudes
+
+    result = Creditario::Applications.list
+    => Creditario::PaginatedCollection
+
+    result.items
+    => [Creditario::Application, Creditario::Application, ...]
+
+#### Obtener una Solicitud
+
+    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
+
+### Ingresos
+
+Las operaciones que puedes realizar sobre Ingresos son: obtener, crear y eliminar.
+
+#### Obtener un Ingreso
+
+    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
+
+### Egresos
+
+Las operaciones que puedes realizar sobre Egresos son: obtener, crear y eliminar.
+
+#### Obtener un Egreso
+
+    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
+
+### Referencias
+
+Las operaciones que puedes realizar sobre Referencias son: obtener, crear y eliminar.
+
+#### Obtener una Referencia
+
+    Creditario::References.retrieve("0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a")
+    => Creditario::Reference
+
+#### Crear una Referencia
+
+    result = Creditario::References.create(classification: "Amistad", name: "Diane Nguyen", phone: "3129743789", credit_application_id: "636264b1-77a2-45ef-b643-e44cfbc84d40")
+    => Creditario::Reference
+
+#### Eliminar una Referencia
+
+    result = Creditario::References.delete("0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a")
+    => true
+
+### Catálogos
+
+Las operaciones que puedes realizar sobre Catálogos son: listar y obtener.
+
+#### Listar Catálogos disponibles
+
+    result = Creditario::Catalogs.list
+    => Creditario::ResourcesCollection
+
+    result.items
+    => [Creditario::Catalog, Creditario::Catalog, ...]
+
+#### Obtener valores de un Catálogo
+
+    Creditario::Catalog.retrieve(resource: "customer", field: "source")
+    => Creditario::ResourcesCollection
+
+### Estimaciones de Crédito
+
+La operación que puedes realizar sobre Estimaciones de Crédito es: obtener.
+
+#### Obtener una Estimación de Crédito
+
+    result = Creditario::CreditEstimates.retrieve(nil, product_id: "c005b7f7-a44a-4ec0-bf7f-73d15d806fd9", amount_cents: "5000000", installments_number: "12")
+    => Creditario::CreditEstimate
+
+### Créditos
+
+Las operaciones que puedes realizar sobre Créditos son: listar y obtener.
+
+#### Listar Créditos de un Cliente
+
+    result = Creditario::Credits.list(customer_id: "f916636d-e045-43e4-898d-14e6dddf13f9")
+    => Creditario::ResourcesCollection
+
+    result.items
+    => [Creditario::Credit, Creditario::Credit, ...]
+
+#### Obtener un Crédito
+
+    result = Creditario::Credits.retrieve("33ca13b7-9910-430c-b5d7-7ba12a9b18a5")
+    => Creditario::Credit