baa_chan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dd4992c1495048ce9123656452c1d9e2ed8ce3dffd2c7f070172c958f748cca
+  data.tar.gz: b6a55877a52d39e01aeb3bb6f11d54a6f7f9a86e5622b70ba4e82e13e1302701
+SHA512:
+  metadata.gz: 392c751ceccd693dfb2a85d6140b69c8d1bfea4f08088917f8de8e0965deef3234b839aaba431a35ea996041cf0c4a50932b3353039e184cfda1a3b2fd178869
+  data.tar.gz: 62c4a801ea57f5ff746a3edec50458ae18ad4e3ca8d01330bbdbf259ebe3d4eb3dd7132b4e46e654807558c6fe2aafdf77543c7f1d768c9f3d9c7524c96dc5fb

data/bin/baa_chan

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'baa_chan'
+puts BaaChan::Reader.new(ARGV[0]).call.to_builder

data/lib/baa_chan.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'baa_chan/reader'

data/lib/baa_chan/costs.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BaaChan
+  class Costs
+    attr_accessor :clearing_fee, :registration_fee, :emoluments,
+                  :brokerage, :iss, :irrf, :pis_cofins
+
+    def initialize(brokerage, clearing_fee, registration_fee, emoluments, options)
+      @brokerage = brokerage
+      @clearing_fee = clearing_fee
+      @registration_fee = registration_fee
+      @emoluments = emoluments
+      @iss = options[:iss] || 0.0
+      @irrf = options[:irrf] || 0.0
+      @pis_cofins = options[:pis_cofins] || 0.0
+    end
+  end
+end

data/lib/baa_chan/layout.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Layout
+  LAYOUTS_PATH = 'lib/baa_chan/layouts'
+
+  def initialize(broker)
+    @broker = broker
+  end
+
+  def attributes
+    @attributes ||= YAML.safe_load(File.read(File.join(LAYOUTS_PATH, "#{@broker}.yml")))
+  end
+
+  def line
+    attributes[caller_locations.first.label]['line'].to_i
+  end
+
+  def index(attr_name = nil)
+    attr = attr_name || caller_locations.first.label
+
+    attributes[attr]['index'].to_i
+  end
+
+  def trade_prefix
+    attributes['trades']['prefix']
+  end
+
+  def regexp_for(attr)
+    attributes[attr]['regexp']
+  end
+end

data/lib/baa_chan/layouts/clear.yml

@@ -0,0 +1,30 @@
+broker:
+  line: 4
+trade_confirmation_number:
+  line: 2
+  index: 0
+trade_date:
+  line: 2
+  index: 2
+trades:
+  prefix: 1-BOVESPA
+operation:
+  index: 1
+ticker:
+  index: 3
+quantity:
+  index: 7
+price:
+  index: 8
+clearing_fee:
+  regexp: .*Taxa de liquidação.*
+  index: 7
+registration_fee:
+  regexp: .*Taxa de Registro.*
+  index: 7
+emoluments:
+  regexp: .*Emolumentos.*
+  index: 1
+irrf:
+  regexp: .*I\.R\.R\.F.*
+  index: 5

data/lib/baa_chan/layouts/genial.yml

@@ -0,0 +1,36 @@
+broker:
+  line: 4
+trade_confirmation_number:
+  line: 2
+  index: 0
+trade_date:
+  line: 2
+  index: 2
+trades:
+  prefix: 1-BOVESPA
+operation:
+  index: 1
+ticker:
+  index: 3
+quantity:
+  index: 6
+price:
+  index: 7
+clearing_fee:
+  regexp: .*Taxa de liquidação.*
+  index: 7
+registration_fee:
+  regexp: .*Taxa de Registro.*
+  index: 7
+emoluments:
+  regexp: .*Emolumentos.*
+  index: 1
+brokerage:
+  regexp: ^A coluna Q.*
+  index: 9
+iss:
+  regexp: ^ISS \( SÃO PAULO \).*
+  index: 5
+pis_cofins:
+  regexp: ^ISS/PIS/COFINS.*
+  index: 1

data/lib/baa_chan/layouts/singulare.yml

@@ -0,0 +1,36 @@
+broker:
+  line: 3
+trade_confirmation_number:
+  line: 2
+  index: 0
+trade_date:
+  line: 2
+  index: 2
+trades:
+  prefix: BM&FBOVESPA S/A.
+operation:
+  index: 2
+ticker:
+  index: 6
+quantity:
+  index: 9
+price:
+  index: 10
+clearing_fee:
+  regexp: .*Taxa de Liquidação.*
+  index: 7
+registration_fee:
+  regexp: .*Taxa de Registro.*
+  index: 7
+emoluments:
+  regexp: .*Emolumentos.*
+  index: 5
+brokerage:
+  regexp: ^Corretagem.*
+  index: 1
+iss:
+  regexp: ^ISS \(SAO PAULO\).*
+  index: 3
+irrf:
+  regexp: .*I\.R\.R\.F.*
+  index: 14

data/lib/baa_chan/parser.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'baa_chan/trade_confirmation'
+require 'baa_chan/trade'
+require 'baa_chan/costs'
+require 'date'
+require 'yaml'
+
+module BaaChan
+  class CostsParserError < StandardError; end
+
+  class Parser
+    def initialize(lines, layout)
+      @lines = lines
+      @layout = layout
+    end
+
+    def call
+      TradeConfirmation.new(broker, trade_confirmation_number, trade_date, trades, costs)
+    end
+
+    private
+
+    def broker
+      @broker ||= @lines[@layout.line]
+    end
+
+    def trade_confirmation_number
+      @trade_confirmation_number ||= @lines[@layout.line].split[@layout.index]
+    end
+
+    def trade_date
+      @trade_date ||= Date.parse @lines[@layout.line].split[@layout.index]
+    end
+
+    def trades
+      @trades ||= TradeParser.new(@lines, @layout).parse
+    end
+
+    def costs
+      @costs ||= CostsParser.new(@lines, @layout).parse
+    end
+  end
+
+  class TradeParser
+    def initialize(lines, layout)
+      @lines = lines
+      @layout = layout
+    end
+
+    def parse
+      @lines.each_with_object([]) do |line, trades|
+        next unless line.include? @layout.trade_prefix
+
+        @trade_line = line
+        trades << Trade.new(operation, ticker, quantity, price)
+      end
+    end
+
+    private
+
+    def operation
+      @trade_line.split[@layout.index] == 'V' ? 'Sell' : 'Buy'
+    end
+
+    def ticker
+      @trade_line.split[@layout.index]
+    end
+
+    def quantity
+      @trade_line.split[@layout.index].to_i
+    end
+
+    def price
+      @trade_line.split[@layout.index].gsub(',', '.').to_f
+    end
+  end
+
+  class CostsParser
+    def initialize(lines, layout)
+      @lines = lines
+      @layout = layout
+    end
+
+    def parse
+      Costs.new(brokerage, clearing_fee, registration_fee, emoluments, { iss: iss, irrf: irrf, pis_cofins: pis_cofins })
+    rescue StandardError => e
+      raise CostsParserError, e.message
+    end
+
+    private
+
+    def value_for(attr_name)
+      @lines.find { |line| line.match? @layout.regexp_for(attr_name) }
+            .split[@layout.index(attr_name)]
+            .gsub(',', '.')
+            .to_f
+    end
+
+    def brokerage
+      value_for('brokerage')
+    rescue NoMethodError
+      0.0
+    end
+
+    def clearing_fee
+      value_for('clearing_fee')
+    end
+
+    def registration_fee
+      value_for('registration_fee')
+    end
+
+    def emoluments
+      value_for('emoluments')
+    end
+
+    def iss
+      value_for('iss')
+    rescue NoMethodError
+      0.0
+    end
+
+    def irrf
+      value_for('irrf')
+    rescue NoMethodError
+      0.0
+    end
+
+    def pis_cofins
+      value_for('pis_cofins')
+    rescue NoMethodError
+      0.0
+    end
+  end
+end

data/lib/baa_chan/pdf_to_text.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'English'
+
+module BaaChan
+  class UnreadablePDFError < StandardError; end
+
+  class InvalidExtensionError < StandardError; end
+
+  class PdfToText
+    def self.call(source)
+      raise InvalidExtensionError unless source.match /\.pdf$/
+
+      content = `pdftotext -layout #{source} -`
+
+      raise UnreadablePDFError unless $CHILD_STATUS.success?
+
+      content
+    end
+  end
+end

data/lib/baa_chan/reader.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module BaaChan
+  class MalformedPDFError < StandardError; end
+
+  class UnknownLayoutError < StandardError; end
+
+  class Reader
+    BROKER_LIST = {
+      singulare: 'Singulare - corretora de titulos de valores mobiliarios',
+      genial: 'GENIAL INVESTIMENTOS CORRETORA DE VALORES MOBILIÁRIOS S.A.',
+      clear: 'CLEAR CORRETORA - GRUPO XP'
+    }.freeze
+
+    def initialize(source)
+      @source = source
+    end
+
+    def call
+      parse(PdfToText.call(@source))
+    end
+
+    private
+
+    def parse(text)
+      lines = sanitize(text)
+
+      layout = Layout.new(detect_layout(lines))
+
+      Parser.new(lines, layout).call
+    end
+
+    def sanitize(content)
+      content.split("\n").map(&:strip)
+    end
+
+    def detect_layout(lines)
+      broker = if lines[3] == BROKER_LIST[:singulare]
+                 'singulare'
+               elsif lines[4] == BROKER_LIST[:genial]
+                 'genial'
+               elsif lines[4] == BROKER_LIST[:clear]
+                 'clear'
+               else
+                 raise UnknownLayoutError
+               end
+
+      return broker
+    end
+  end
+end
+
+require 'baa_chan/pdf_to_text'
+require 'baa_chan/parser'
+require 'baa_chan/layout'

data/lib/baa_chan/trade.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BaaChan
+  class Trade
+    attr_accessor :operation, :ticker, :quantity, :price
+
+    def initialize(operation, ticker, quantity, price)
+      @operation = operation
+      @ticker = ticker
+      @quantity = quantity
+      @price = price
+    end
+  end
+end

data/lib/baa_chan/trade_confirmation.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'jbuilder'
+
+module BaaChan
+  class TradeConfirmation
+    attr_accessor :broker, :trade_confirmation_number, :trade_date, :trades, :costs
+
+    def initialize(broker, trade_confirmation_number, trade_date, trades, costs)
+      @broker = broker
+      @trade_confirmation_number = trade_confirmation_number
+      @trade_date = trade_date
+      @trades = trades
+      @costs = costs
+    end
+
+    def total_cost
+      @costs.brokerage +
+        @costs.registration_fee +
+        @costs.emoluments +
+        @costs.pis_cofins +
+        @costs.clearing_fee
+    end
+
+    def to_builder
+      Jbuilder.encode do |json|
+        json.call(
+          self,
+          :broker,
+          :trade_confirmation_number,
+          :trade_date
+        )
+
+        json.trades @trades do |trade|
+          json.operation trade.operation
+          json.ticker trade.ticker
+          json.quantity trade.quantity
+          json.price trade.price
+        end
+
+        json.costs do
+          json.brokerage @costs.brokerage
+          json.clearing_fee @costs.clearing_fee
+          json.registration_fee @costs.registration_fee
+          json.emoluments @costs.emoluments
+          json.iss @costs.iss if @costs.iss
+          json.irrf @costs.irrf if @costs.irrf
+          json.pis_cofins @costs.pis_cofins if @costs.pis_cofins
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: baa_chan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Diogo Noda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.2
+description: |
+  BaaChan will read your trade confirmations and provide you
+  details about your trades helping you out handling your
+  finances
+email: diogotnoda@gmail.com
+executables:
+- baa_chan
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/baa_chan
+- lib/baa_chan.rb
+- lib/baa_chan/costs.rb
+- lib/baa_chan/layout.rb
+- lib/baa_chan/layouts/clear.yml
+- lib/baa_chan/layouts/genial.yml
+- lib/baa_chan/layouts/singulare.yml
+- lib/baa_chan/parser.rb
+- lib/baa_chan/pdf_to_text.rb
+- lib/baa_chan/reader.rb
+- lib/baa_chan/trade.rb
+- lib/baa_chan/trade_confirmation.rb
+homepage: https://rubygems.org/gems/baa_chan
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Trade Confirmation Reader
+test_files: []