creditario-client 0.0.1.alpha

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "sdoc"
+require "rdoc/task"
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "doc/"
+  rdoc.options << "--format=sdoc"
+  rdoc.options << "--exclude=test"
+  rdoc.template = "rails"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "creditario/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/creditario-client.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "creditario/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "creditario-client"
+  spec.version       = Creditario::Client::VERSION
+  spec.authors       = ["michelada.io"]
+  spec.email         = ["info@michelada.io"]
+
+  spec.summary       = "Ruby Client for the creditar.io API"
+  spec.homepage      = "https://www.creditar.io"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oj", "~> 3.0.0"
+  spec.add_dependency "multipart-post", "2.0.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "sdoc", "~> 1.0"
+  spec.add_development_dependency "rubocop", "~> 0.57.2"
+  spec.add_development_dependency "webmock", "~> 3.4.2"
+end

data/lib/creditario/api/create.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  module API
+    ###
+    # == Creditario::API::Create
+    #
+    # Modulo encargado de generar recursos nuevos en la API de creditar.io
+    module Create
+      ###
+      # Realiza una llamada POST al path del Repositorio que esta haciendo
+      # uso de este modulo.
+      #
+      # Si todo sale bien devuelve una instancia del Recurso específico que el
+      # Repositorio maneja.
+      # De lo contrario, regresa un Hash con los errores arrojados por el servidor de creditar.io
+      def create(**params)
+        response = API.request(:post, self.resource_path, params)
+
+        attributes = response.dig("data").first
+        links = response.dig("links")
+
+        self.resource_class.new(attributes, links)
+      rescue Creditario::Exceptions::UnprocessableEntityError => exception
+        exception.server_response
+      end
+    end
+  end
+end

data/lib/creditario/api/delete.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  module API
+    ###
+    # == Creditario::API::Delete
+    #
+    # Modulo encargado de eliminar recursos existentes en la API de creditar.io
+    module Delete
+      ###
+      # Realiza una llamada DELETE al path del Repositorio que este haciendo uso
+      # de este modulo.
+      #
+      # Si todo sale bien, la respuesta no tendrá contenido alguno y el código de estado HTTP será 204.
+      # De lo contrario, el código de estado HTTP será diferente a 204 y la respuesta tendrá los detalles
+      # del error.
+      def delete(id)
+        path = "#{self.resource_path}/#{id}"
+        API.request(:delete, path).code == "204"
+      rescue Creditario::Exceptions::ResourceNotFoundError => exception
+        exception.server_response
+      end
+    end
+  end
+end

data/lib/creditario/api/list.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  module API
+    ###
+    # == Creditario::API::List
+    #
+    # Modulo encargado de obtener recursos paginados de la API de creditar.io
+    module List
+      ###
+      # Realiza una llamada GET al path del Repositorio que esta haciendo uso
+      # de este modulo.
+      #
+      # Devuelve una colección paginada o normal de los recursos que el
+      # Repositorio maneja.
+      def list(query_params = {})
+        response = API.request(:get, self.resource_path, query_params)
+
+        if response.has_key? "pagination"
+          PaginatedCollection.new(response, self.resource_class)
+        else
+          ResourcesCollection.new(response, self.resource_class)
+        end
+      end
+    end
+  end
+end

data/lib/creditario/api/multipart.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  module API
+    ###
+    # == Creditario::API:Multipart
+    #
+    # Modulo encargado de generar recursos nuevos de tipo +multipart/form-data+ en la API de creditario.io
+    module Multipart
+      ###
+      # Realiza una llamada POST de tipo +multipart/form-data+ al path del Repositorio que esta haciendo
+      # uso de este modulo.
+      #
+      # Si todo sale bien devuelve una instancia del Recurso específico que el
+      # Repositorio maneja.
+      # De lo contrario, regresa un Hash con los errores arrojados por el servidor de creditar.io
+      def create(**params)
+        response = API.request(:multipart, self.resource_path, params)
+
+        attributes = response.dig("data").first
+        links = response.dig("links")
+
+        self.resource_class.new(attributes, links)
+      rescue Creditario::Exceptions::UnprocessableEntityError => exception
+        exception.server_response
+      end
+    end
+  end
+end

data/lib/creditario/api/request.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "net/http/post/multipart"
+
+module Creditario # :nodoc:
+  module API # :nodoc:
+    ###
+    # Alias para el método Creditario::API::Request.request
+    def self.request(*params)
+      Request.request(*params)
+    end
+
+    ###
+    # == Creditario::API::Request
+    #
+    # Modulo encargado de ejecutar los requests HTTP de cualquier tipo
+    # a la API de creditar.io
+    module Request
+      class << self
+        ###
+        # Ejecuta un request HTTP a la API de creditar.io
+        #
+        # Los símbolos aceptados en el parámetro +method+ son:
+        #
+        # - :get
+        # - :post
+        # - :delete
+        # - :patch
+        # - :multipart
+        def request(method, path, params = {})
+          uri = URI(Creditario::Client.api_base + path)
+          request = request_from_method(method, uri, params)
+
+          response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
+            http.request(request)
+          end
+
+          handle_errored_responses(response)
+
+          return response if response.body.nil?
+          Oj.load(response.body)
+        rescue Oj::ParseError => ex
+          raise Exceptions::InvalidResponseBodyError, ex.message
+        rescue Net::OpenTimeout => ex
+          raise Exceptions::APIBusyError, ex.message
+        rescue Errno::ECONNREFUSED => ex
+          raise Exceptions::APINotReachableError, ex.message
+        end
+
+        private
+
+          def request_from_method(method, uri, params)
+            case method
+            when :get
+              uri.query = URI.encode_www_form(params)
+              set_request_headers(Net::HTTP::Get.new(uri))
+            when :post
+              set_request_body(set_request_headers(Net::HTTP::Post.new(uri)), params)
+            when :multipart
+              set_authorization_headers(Net::HTTP::Post::Multipart.new(uri, params))
+            when :delete
+              set_request_headers(Net::HTTP::Delete.new(uri))
+            when :patch
+              set_request_body(set_request_headers(Net::HTTP::Patch.new(uri)), params)
+            end
+          end
+
+          def set_request_headers(request)
+            request = set_authorization_headers(request)
+
+            request["Accept"] = "application/vnd.creditar.v#{Creditario::Client.api_version}+json"
+            request["Content-Type"] = "application/json"
+
+            request
+          end
+
+          def set_authorization_headers(request)
+            raise Creditario::Exceptions::MissingAPIKeyError.new if Creditario::Client.api_key.nil?
+
+            request["Authorization"] = "Token token=#{Creditario::Client.api_key}"
+            request
+          end
+
+          def set_request_body(request, params)
+            request.body = params.to_json
+            request
+          end
+
+          def handle_errored_responses(response)
+            return if response.code.to_i < 400
+
+            raise Exceptions::InvalidAPIKeyError if response.code == "401"
+            raise Exceptions::ForbiddenError.new(response) if response.code == "403"
+            raise Exceptions::ResourceNotFoundError.new(response) if response.code == "404"
+            raise Exceptions::UnprocessableEntityError.new(response) if response.code == "422"
+          end
+      end
+    end
+  end
+end

data/lib/creditario/api/retrieve.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  module API
+    ###
+    # == Creditario::API::Retrieve
+    #
+    # Modulo encargado de obtener un solo recurso de la API de creditar.io
+    module Retrieve
+      ###
+      # Realiza una llamada GET al path del Repositorio que este haciendo uso
+      # de este modulo.
+      #
+      # Si todo sale bien devuelve una instancia del Recurso específico que el Repositorio maneja.
+      # De lo contrario, regresa un Hash con los errores arrojados por el servidor de creditar.io
+      def retrieve(id, query_params = {})
+        parts = [self.resource_path, id]
+        path = parts.compact.join("/")
+        response = API.request(:get, path, query_params)
+
+        attributes = response.dig("data").first
+        links = response.dig("links")
+
+        self.resource_class.new(attributes, links)
+      rescue Creditario::Exceptions::ResourceNotFoundError => exception
+        exception.server_response
+      rescue Creditario::Exceptions::UnprocessableEntityError => exception
+        exception.server_response
+      end
+    end
+  end
+end

data/lib/creditario/api/update.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  module API
+    ###
+    # == Creditario::API::Update
+    #
+    # Modulo encargado de actualizar recursos existentes en la API de creditar.io
+    module Update
+      ###
+      # Realizar una llamada PATCH al path del Repositorio que esta haciendo uso
+      # de este modulo.
+      #
+      # Si todo sale bien devuelve una instancia del Recurso específico que el Repositorio maneja.
+      # De lo contrario, regresa un Hash con los errores arrojados por el servidor de creditar.io
+      def update(id, params = {}, include_param = nil)
+        path = "#{self.resource_path}/#{id}"
+        path = include_param.nil? ? path : path + "?include=#{include_param}"
+        response = API.request(:patch, path, params)
+
+        attributes = response.dig("data").first
+        links = response.dig("links")
+
+        self.resource_class.new(attributes, links)
+      rescue Creditario::Exceptions::UnprocessableEntityError,
+             Creditario::Exceptions::ResourceNotFoundError,
+             Creditario::Exceptions::ForbiddenError => exception
+        exception.server_response
+      end
+    end
+  end
+end

data/lib/creditario/client.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require "oj"
+
+require "creditario/client/version"
+require "creditario/client/railtie" if defined?(Rails)
+
+require "creditario/exceptions"
+
+require "creditario/api/request"
+require "creditario/api/create"
+require "creditario/api/multipart"
+require "creditario/api/delete"
+require "creditario/api/list"
+require "creditario/api/retrieve"
+require "creditario/api/update"
+
+require "creditario/utils/paginated_collection"
+require "creditario/utils/resources_collection"
+
+require "creditario/resources/resource"
+require "creditario/resources/product"
+require "creditario/resources/credit_estimate"
+require "creditario/resources/contract"
+require "creditario/resources/expense"
+require "creditario/resources/income"
+require "creditario/resources/reference"
+require "creditario/resources/application"
+require "creditario/resources/customer"
+require "creditario/resources/catalog"
+require "creditario/resources/attachment"
+require "creditario/resources/credit"
+require "creditario/resources/payment"
+
+require "creditario/repositories/applications"
+require "creditario/repositories/customers"
+require "creditario/repositories/products"
+require "creditario/repositories/credit_estimates"
+require "creditario/repositories/contracts"
+require "creditario/repositories/catalogs"
+require "creditario/repositories/incomes"
+require "creditario/repositories/expenses"
+require "creditario/repositories/references"
+require "creditario/repositories/attachments"
+require "creditario/repositories/credits"
+require "creditario/repositories/payments"
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Client
+  # Modulo que será utilizado para consumir la API de creditar.io
+  module Client
+    ###
+    # URL al ambiente de *production* de la API de creditar.io
+    @api_base = "https://www.creditar.io"
+
+    ###
+    # Version a utilizar de la API de creditar.io
+    @api_version = 1
+
+    class << self
+      ###
+      # La API Key es necesaria para cualquier interacción con la API de creditar.io
+      #
+      # Después de requerir la gema, lo más recomendado es definir la API Key a
+      # utilizar en todas las llamadas a la API.
+      #
+      # ==== Ejemplo
+      #   Creditario::Client.api_key = "BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFe"
+      attr_accessor :api_key
+
+      ###
+      # URL en la cual se ejecutarán las interacciones con la API de creditar.io
+      #
+      # Util cuando se desea utilizar el ambiente de *staging* por ejemplo.
+      #
+      # ==== Ejemplo
+      #
+      #  Creditario::Client.api_base = "https://staging.creditar.io"
+      attr_accessor :api_base
+
+      ###
+      # Versión a utilizar de la API de creditar.io
+      # Por default es 1
+      attr_accessor :api_version
+
+      ###
+      # Método de acceso al repositorio de Productos.
+      #
+      # Para más información, puedes consultar la documentación de Creditario::Products
+      def products
+        Creditario::Products
+      end
+
+      ###
+      # Método de acceso al repositorio de Clientes.
+      #
+      # Para más información, puedes consultar la documentación de Creditario::Customers
+      def customers
+        Creditario::Customers
+      end
+
+      ###
+      # Método de acceso al repositorio de Solicitudes.
+      #
+      # Para más información, puedes consultar la documentación de Creditario::Applications
+      def applications
+        Creditario::Applications
+      end
+
+      ###
+      # Método de acesso al repositorio de Contratos.
+      #
+      # Para más información, puedes consultrar la documentación de Creditario::Contracts
+      def contracts
+        Creditario::Contracts
+      end
+
+      ###
+      # Método de acceso al repositorio de Catálogos.
+      #
+      # Para más información, puedes consultar la documentación de Creditario::Catalogs
+      def catalogs
+        Creditario::Catalogs
+      end
+
+      # Método de acceso al repositorio de Ingresos.
+      #
+      # Para más información, puedes consultar la documentación de Creditario::Incomes
+      def incomes
+        Creditario::Incomes
+      end
+
+      ###
+      # Método de acceso al repositorio de Egresos.
+      #
+      # Para más información, puedes consultar la documentación de Creditario::Expenses
+      def expenses
+        Creditario::Expenses
+      end
+
+      ###
+      # Método de acceso al repositorio de Referencias.
+      #
+      # Para más información, puedes consultar la documentación de Creditario::References
+      def references
+        Creditario::References
+      end
+
+      ###
+      # Método de acceso al repositorio de Archivos.
+      #
+      # Para más información, puede consultar la documentación de Creditario::Attachments
+      def attachments
+        Creditario::Attachments
+      end
+
+      ###
+      # Método de acceso al repositorio de Estimaciones de Crédito
+      #
+      # Para más información, puede consultar la documentación de Creditario::CreditEstimates
+      def credit_estimates
+        Creditario::CreditEstimates
+      end
+
+      ###
+      # Método de acceso al repositorio de Créditos
+      #
+      # Para más información, puede consultar la documentación de Creditario::Credits
+      def credits
+        Creditario::Credits
+      end
+
+      ###
+      # Método de acceso al repositorio de Pagos
+      #
+      # Para más información, puede consultar la documentación de Creditario::Payments
+      def payments
+        Creditario::Payments
+      end
+    end
+  end
+end