creditario-client 0.0.1.alpha

data/lib/creditario/resources/product.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Product
+  #
+  # Representa un Producto del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => product = Creditario::Product.new({"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c", "short_name": "un-pago", "name": "Crédito a un sólo pago"})
+  #   => product.id
+  #   => "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
+  #   => product.short_name = "dos-pagos"
+  #   => "dos-pagos"
+  #   => product[:name]
+  #   => "Crédito a un sólo pago"
+  class Product
+    include Resource
+  end
+end

data/lib/creditario/resources/reference.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Creditario
+  ###
+  # == Creditario::Reference
+  #
+  # Representa una Referencia del sistema creditar.io
+  #
+  # === Ejemplo
+  #
+  #   => reference = Creditario::Reference.new({"id": "1b38ab7d-4c3e-4f39-99e8-57b099c86d45", "classification": "Familiar", "name": "Diane Nguyen", "phone": "3123100045"})
+  #   => reference.id
+  #   => 1b38ab7d-4c3e-4f39-99e8-57b099c86d45
+  #   => reference[:phone]
+  #   => 312100045
+  class Reference
+    include Resource
+  end
+end

data/lib/creditario/resources/resource.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::Resource
+  #
+  # Modulo que se encarga de establecer el mecanismo de inicialización de las siguientes clases:
+  #
+  # - Creditario::Customer
+  # - Creditario::Application
+  # - Creditario::Product
+  #
+  module Resource
+    def self.included(klass) # :nodoc:
+      klass.extend ClassMethods
+    end
+
+    ###
+    # Hash que representa los attributos de un recurso.
+    attr_reader :attributes
+
+    ###
+    # Colección de links relaccionados al recurso.
+    attr_reader :links
+
+    ###
+    # Recibe parametro +attributes+ de tipo Hash y genera los métodos de escritura y
+    # lectura para cada elemento del Hash.
+    def initialize(attributes, links = [])
+      @attributes = attributes
+      @links = links
+      define_attributes_setters_and_getters
+    end
+
+    ###
+    # Método para acceder con llave al elemento del Hash +attributes+
+    def [](key)
+      attributes[key]
+    end
+
+    ###
+    # Método para acceder con llave y sobreescribir el elemento del Hash +attributes+
+    def []=(key, value)
+      attributes[key] = value
+    end
+
+    private
+
+      def define_attributes_setters_and_getters
+        attributes.each do |attribute, value|
+          if self.class.class_variable_defined?(:@@associations)
+            association = self.class.class_variable_get(:@@associations).find { |association| association[:name] == attribute.to_sym }
+            unless association.nil?
+              attributes[attribute] = build_associations(association[:class], value)
+            end
+          end
+
+          define_attribute_setter_and_getter(attribute, value)
+        end
+      end
+
+      def define_attribute_setter_and_getter(attribute, value)
+        self.class.define_method(attribute) do
+          attributes[attribute]
+        end
+
+        self.class.define_method("#{attribute}=") do |new_value|
+          attributes[attribute] = new_value
+        end
+      end
+
+      def build_associations(klass, collection_or_attributes)
+        return klass.new(collection_or_attributes) if collection_or_attributes.is_a?(Hash)
+
+        collection_or_attributes.map do |attributes|
+          klass.new(attributes)
+        end
+      end
+
+      module ClassMethods # :nodoc:
+        ###
+        # Define una relación de uno a muchos con otro recurso.
+        def has_many(*association)
+          self.class_variable_set(:@@associations, []) unless self.class_variable_defined?(:@@associations)
+          self.class_variable_get(:@@associations) << { name: association.first }.merge(association.last)
+        end
+
+        ###
+        # Define una relacion de uno a uno con otro recurso.
+        def has_one(*association)
+          self.class_variable_set(:@@associations, []) unless self.class_variable_defined?(:@@associations)
+          self.class_variable_get(:@@associations) << { name: association.first }.merge(association.last)
+        end
+      end
+  end
+end

data/lib/creditario/utils/paginated_collection.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::PaginatedCollection
+  #
+  # Representa una colección de recursos paginados, a los cuales se puede acceder mediante
+  # el atributo +items+.
+  #
+  # También contiene información relacionada a los recursos relacionados mediante
+  # el atributo +links+.
+  #
+  # Así como los cursores de la paginación, encontados en el atributo +cursors+
+  class PaginatedCollection
+    ###
+    # Arreglo de todos los recursos obtenidos de la API
+    attr_reader :items
+
+    ###
+    # Links relacionados a la llamada realizada a la API
+    attr_reader :links
+
+    ###
+    # Información sobre el siguiente cursor utilizado en la paginación
+    attr_reader :cursors
+
+    ###
+    # Recibe el JSON parseado de la llamada ejecutada a la API y lo procesa
+    # obteniendo así la colección de items de la clase específica a la que pertenecen,
+    # los links y los cursores de paginación.
+    def initialize(json_response = {}, item_class)
+      @items = build_items(json_response.dig("data"), item_class)
+      @links = json_response.dig("links")
+      @cursors = json_response.dig("pagination", "cursors")
+    end
+
+    private
+
+      def build_items(array, item_class)
+        array.map do |item|
+          item_class.new(item)
+        end
+      end
+  end
+end

data/lib/creditario/utils/resources_collection.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  ###
+  # == Creditario::ResourcesCollection
+  #
+  # Representa una colección de recursos, a los cuales se puede acceder mediante
+  # el atributo +items+.
+  class ResourcesCollection
+    ###
+    # Arreglo de todos los recursos obtenidos de la API
+    attr_reader :items
+
+    ###
+    # Links relacionados a la llamada realizada a la API
+    attr_reader :links
+
+    ###
+    # Recibe el JSON parseado de la llamada ejecutada a la API y lo procesa
+    # obteniendo así la colección de items de la clase específica a la que pertenecen
+    # y sus links.
+    def initialize(json_response = {}, item_class)
+      @items = build_items(json_response.dig("data"), item_class)
+      @links = json_response.dig("links")
+    end
+
+    private
+
+      def build_items(array, item_class)
+        array.map do |item|
+          item_class.new(item)
+        end
+      end
+  end
+end

data/lib/generators/creditario/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Crea el initializer de Creditario::Client y además añade un archivo YAML de configuración
+    para poder tener `api_key` y `api_base` diferentes por entorno.
+
+Example:
+    rails generate creditario:install
+
+    Va a crear lo siguiente:
+      - config/initializers/creditario.rb
+      - config/creditario.yml
+
+    Va a modificar:
+      - config/application.rb

data/lib/generators/creditario/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Creditario # :nodoc:
+  module Generators # :nodoc:
+    class InstallGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Instala Creditario"
+
+      def install
+        copy_file "initializer.rb", "config/initializers/creditario.rb"
+        copy_file "creditario.yml", "config/creditario.yml"
+        insert_into_file "config/application.rb", "    config.creditario = config_for(:creditario)\n", before: "  end\n"
+      end
+    end
+  end
+end

data/lib/generators/creditario/templates/creditario.yml

@@ -0,0 +1,12 @@
+default: &default
+  api_base: <%= ENV["CREDITARIO_API_URL"] || "http://localhost:3000" %>
+  api_key: <%= Rails.application.credentials.dig(:creditario, Rails.env.to_sym, :api_key) %>
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default

data/lib/generators/creditario/templates/initializer.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Creditario::Client.api_base = Rails.configuration.creditario.dig("api_base")
+Creditario::Client.api_key = Rails.configuration.creditario.dig("api_key")

data/rakelib/fixture_api_response.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "fixture_api_response.rb"
+
+namespace :fixture_api_response do
+  desc "Create fixture from a request to server local e.g: http://localhost:[port]"
+  task :generate do
+    FixtureAPIResponse.new
+  end
+end

data/rakelib/fixture_api_response.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class FixtureAPIResponse # :nodoc:
+  attr_reader :method, :port, :path, :params, :api_token, :name
+
+  REQUESTS = %w(get post patch delete multipart)
+
+  def initialize
+    @method, @port, @path, @params, @api_token, @name = ""
+    build_request_and_save_fixture
+  end
+
+  def build_request_and_save_fixture
+    method_gets
+    port_gets
+    path_gets
+    params_gets
+    api_token_gets
+    name_gets
+    execute_request
+  end
+
+  private
+
+    def execute_request
+      puts "Generando..."
+      system(send(method) + path_to_save_fixture)
+      puts "Fixture generado! > #{path_to_save_fixture.split(" ").last}"
+    end
+
+    def method_gets
+      loop do
+        puts "Qué tipo de petición desea hacer? (1) GET (2) POST (3) PATCH/PUT (4) DELETE (5) MULTIPART"
+        @method = STDIN.gets.chomp.to_i
+
+        if method >= 1 && !REQUESTS[method - 1].nil?
+          @method = REQUESTS[method - 1]
+          break
+        else
+          puts "Seleccione una opción correcta!"
+        end
+      end
+    end
+
+    def port_gets
+      puts "Cuál es el puerto?"
+      @port = STDIN.gets.chomp
+    end
+
+    def path_gets
+      puts "Cuál es la ruta?"
+      @path = STDIN.gets.chomp
+    end
+
+    def params_gets
+      return if method == "get" || method == "delete"
+
+      puts "Proporcione los datos a enviar:"
+      @params = STDIN.gets.chomp
+    end
+
+    def api_token_gets
+      puts "Proporcione un token_token válido:"
+      @api_token = STDIN.gets.chomp
+    end
+
+    def name_gets
+      puts "Qué nombre tendra el archivo fixture?"
+      @name = STDIN.gets.chomp
+    end
+
+    def request_url
+      "'localhost:#{port}#{path}'"
+    end
+
+    def headers
+      "-H 'Content-Type: application/json' " \
+      "#{header_api_token}" \
+      "-H 'Accept: application/vnd.creditar.v1+json'"
+    end
+
+    def header_api_token
+      "-H 'Authorization: Token token=#{api_token}' "
+    end
+
+    def path_to_save_fixture
+      filename = name.empty? ? DateTime.now.to_s(:number) : name
+      " > ./test/fixtures/#{filename}.txt"
+    end
+
+    def body
+      "-d '#{params}'"
+    end
+
+    def get
+      "curl -X GET -is #{request_url} #{headers}"
+    end
+
+    def post
+      "curl -X POST -is #{request_url} #{headers} #{body}"
+    end
+
+    def patch
+      "curl -X PATCH -is #{request_url} #{headers} #{body}"
+    end
+
+    def delete
+      "curl -X DELETE -is #{request_url} #{headers}"
+    end
+
+    def multipart
+      "curl #{params} #{header_api_token} -is #{request_url}"
+    end
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: creditario-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- michelada.io
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+description: 
+email:
+- info@michelada.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- creditario-client.gemspec
+- lib/creditario/api/create.rb
+- lib/creditario/api/delete.rb
+- lib/creditario/api/list.rb
+- lib/creditario/api/multipart.rb
+- lib/creditario/api/request.rb
+- lib/creditario/api/retrieve.rb
+- lib/creditario/api/update.rb
+- lib/creditario/client.rb
+- lib/creditario/client/railtie.rb
+- lib/creditario/client/version.rb
+- lib/creditario/exceptions.rb
+- lib/creditario/repositories/applications.rb
+- lib/creditario/repositories/attachments.rb
+- lib/creditario/repositories/catalogs.rb
+- lib/creditario/repositories/contracts.rb
+- lib/creditario/repositories/credit_estimates.rb
+- lib/creditario/repositories/credits.rb
+- lib/creditario/repositories/customers.rb
+- lib/creditario/repositories/expenses.rb
+- lib/creditario/repositories/incomes.rb
+- lib/creditario/repositories/payments.rb
+- lib/creditario/repositories/products.rb
+- lib/creditario/repositories/references.rb
+- lib/creditario/resources/application.rb
+- lib/creditario/resources/attachment.rb
+- lib/creditario/resources/catalog.rb
+- lib/creditario/resources/contract.rb
+- lib/creditario/resources/credit.rb
+- lib/creditario/resources/credit_estimate.rb
+- lib/creditario/resources/customer.rb
+- lib/creditario/resources/expense.rb
+- lib/creditario/resources/income.rb
+- lib/creditario/resources/payment.rb
+- lib/creditario/resources/product.rb
+- lib/creditario/resources/reference.rb
+- lib/creditario/resources/resource.rb
+- lib/creditario/utils/paginated_collection.rb
+- lib/creditario/utils/resources_collection.rb
+- lib/generators/creditario/USAGE
+- lib/generators/creditario/install_generator.rb
+- lib/generators/creditario/templates/creditario.yml
+- lib/generators/creditario/templates/initializer.rb
+- rakelib/fixture_api_response.rake
+- rakelib/fixture_api_response.rb
+homepage: https://www.creditar.io
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: Ruby Client for the creditar.io API
+test_files: []