fintual 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f98a9ffaa3da5c224140665a955488ed5f42710614b9e67fa497e4faf3e8c97d
+  data.tar.gz: 35b157ec4af6f583e80d1998efaa7259d60640b5dce7546448327dde064f81de
+SHA512:
+  metadata.gz: 5dfb711bf11e35352c36ad38b4a9b03f9e90f954e8102d0f614d4185981ee1e2fe2e2a1e58e408c5c29be9ecfca59f79e4427f145fccc0f52d5f4c0e31f6fc95
+  data.tar.gz: bbe463d14fa28fb46e968fe2a2bc02573ed69dfe196b3472d07500f8212651c869451fb7d8ad379c0917b33b697e046b3f946e26c75ac58c98f3c4c512c42970

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+coverage/*
+Gemfile.lock
+*~
+.bundle
+.rvmrc
+log/*
+measurement/*
+pkg/*
+.DS_Store
+.env
+spec/dummy/tmp/*
+spec/dummy/log/*.log
+demo.rb

data/.rubocop.yml

@@ -0,0 +1,6 @@
+require:
+ - rubocop-performance
+ - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fintoc.gemspec
+gemspec
+
+group :test do
+  gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
+end

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'rubocop/rake_task'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+task default: :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/fintual.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'fintual'
+  s.version     = '0.1.0'
+  s.summary     = 'client for fintual.cl'
+  s.description = 'A simple api client for fintual.cl'
+  s.authors     = ['Alfredo Enrione']
+  s.email       = 'aenrione@protonmail.com'
+  s.homepage    =
+    'https://rubygems.org/gems/fintual'
+  s.license = 'MIT'
+  s.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  s.add_dependency 'http'
+  s.add_dependency 'json'
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/fintual/client.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'fintual/errors'
+require 'fintual/constants'
+require 'fintual/version'
+require 'fintual/resources/goal'
+require 'json'
+require 'net/http'
+require 'net/https'
+
+module Fintual
+  # Client component to make the requests and get data
+  class Client
+    def initialize(email, password)
+      @email = email
+      @password = password
+      @user_agent = "fintual-ruby/#{Fintual::VERSION}"
+      @headers = {
+        'Content-Type': 'application/json',
+        'User-Agent': @user_agent
+      }
+      @default_params = {}
+      @default_params = {
+        user_email: @email,
+        user_token: get_token
+      }
+    end
+
+    def get
+      request('get')
+    end
+
+    def delete
+      request('delete')
+    end
+
+    def request(method)
+      proc do |resource, **kwargs|
+        parameters = params(method, **kwargs)
+        response = make_request(method, resource, parameters)
+        content = JSON.parse(response.body, symbolize_names: true)
+        data = content[:data]
+        error = content[:error]
+
+        if content[:status] == "error"
+          raise_custom_error(content)
+        end
+        data
+      end
+    end
+
+    def goals
+      result = get.call('goals')
+      result.map { |data| build_goal(data[:attributes]) }
+    end
+
+    def build_goal(**kwargs)
+      Fintual::Goal.new(**kwargs)
+    end
+
+    def to_s
+      visible_chars = 4
+      hidden_part = '*' * (@api_key.size - visible_chars)
+      visible_key = @api_key.slice(0, visible_chars)
+      "Client(🔑=#{hidden_part + visible_key}"
+    end
+
+    private
+
+    def client
+      @client ||= Net::HTTP
+    end
+
+    def make_request(method, resource, parameters)
+      uri = URI.parse("#{Fintual::Constants::SCHEME}#{Fintual::Constants::BASE_URL}#{resource}")
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      case method.downcase
+      when 'get'
+        req = Net::HTTP::Get.new(uri.path, @headers)
+      when 'post'
+        req = Net::HTTP::Post.new(uri.path, @headers)
+      end
+      req.body = parameters.to_json
+      https.request(req)
+    end
+
+    def params(method, **kwargs)
+      { **@default_params, **kwargs }
+
+    end
+
+    def raise_custom_error(error)
+      raise Fintual::Errors::FintualError.new(error[:message])
+    end
+
+    def get_token
+      payload = {
+        user: {email: @email, password: @password}
+        }
+      request('post').call('access_tokens', payload)[:attributes][:token]
+    end
+  end
+end

data/lib/fintual/constants.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Constant values for the client
+module Fintual
+  module Constants
+    FIELDSUBS = [%w[id id_], %w[type type_]].freeze
+    GENERAL_DOC_URL = 'https://fintual.cl/api-docs/index.html'
+    SCHEME = 'https://'
+    BASE_URL = 'fintual.cl/api/'
+  end
+end

data/lib/fintual/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'fintual/constants'
+
+module Fintual
+  module Errors
+    # Error definitions for handling wrong requests
+    class FintualError < StandardError
+      def initialize(message, doc_url = Fintual::Constants::GENERAL_DOC_URL)
+        super()
+        @message = message
+        @doc_url = doc_url
+      end
+
+      def message
+        "\n#{@message}\n Please check the docs at: #{@doc_url}"
+      end
+
+      def to_s
+        message
+      end
+    end
+
+    class InvalidRequestError < FintualError; end
+    class LinkError < FintualError; end
+    class AuthenticationError < FintualError; end
+    class InstitutionError < FintualError; end
+    class ApiError < FintualError; end
+    class MissingResourceError < FintualError; end
+    class InvalidLinkTokenError < FintualError; end
+    class InvalidUsernameError < FintualError; end
+    class InvalidHolderTypeError < FintualError; end
+    class MissingParameterError < FintualError; end
+    class EmptyStringError < FintualError; end
+    class UnrecognizedRequestError < FintualError; end
+    class InvalidDateError < FintualError; end
+    class InvalidCredentialsError < FintualError; end
+    class LockedCredentialsError < FintualError; end
+    class InvalidApiKeyError < FintualError; end
+    class UnavailableInstitutionError < FintualError; end
+    class InternalServerError < FintualError; end
+  end
+end

data/lib/fintual/resources/goal.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Fintual
+  # for handling the total balance
+  class Goal
+    attr_reader :name, :current, :deposited, :profit, :created_at
+
+    def initialize(name:, nav:, created_at:, deposited:, profit:, **)
+      @name = name
+      @deposited = deposited
+      @current = nav
+      @deposited = deposited
+      @profit = profit
+      @created_at = created_at
+    end
+
+    def to_s
+      "#{name}: #{@current} (#{@deposited})"
+    end
+
+    def inspect
+      "<Goal #{name}: #{@current} (#{@deposited})>"
+    end
+  end
+end

data/lib/fintual/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Fintual
+  VERSION = '0.1.1'
+end

data/lib/fintual.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'fintual/version'
+require 'fintual/client'
+
+# Main Module
+module Fintual
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: fintual
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alfredo Enrione
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple api client for fintual.cl
+email: aenrione@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Rakefile
+- fintual.gemspec
+- lib/fintual.rb
+- lib/fintual/client.rb
+- lib/fintual/constants.rb
+- lib/fintual/errors.rb
+- lib/fintual/resources/goal.rb
+- lib/fintual/version.rb
+homepage: https://rubygems.org/gems/fintual
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: client for fintual.cl
+test_files: []