extras_de_cont 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c645d6d5fc89fb998902c22056fb81e1a47fadfd1337492119ca9146f809d3
-  data.tar.gz: 3717d8ac49c1779fc31db92f8405c79e9bdb44fa5cd07d38173c35d14c4ef49f
+  metadata.gz: 69bb4ccabcbeca26046ace09db26a3b6e207e5ccb269f0572373472ae6ce8cd4
+  data.tar.gz: c249a2485737903eb4cc42c26ddcd41f17d4aa653d23546e0ede16e93c6ed8ee
 SHA512:
-  metadata.gz: c37d86a1c6e8a7e885226c0d0a9710129e119d4bc5b93fcd2b1b6863de7d455f557ef6ee827b53689cf01ff134ba37f1a7c15537681ca0010cca73767611754d
-  data.tar.gz: 32b6256f9e0c00689a781ff168afb74c16688672ae0bc7f307c94c0559a19bb5198e143530926ba7eff458457ddddc4c2da065edfd4436084e0d02e1822c042f
+  metadata.gz: b347db52d2b09495de4f60edd64897440b548f8a010b3c6d732e17cfa2de684e2dbdd33c882766dbc1d6ce60419dbd7b99bc7e0213e8e913b7dec922c3b2cbfd
+  data.tar.gz: 7945a8150853d19eab987edbbe1e5d99b6682ec35068faabb6083bc43fcfd62643c0b21a5bb970641cdc21011be3a2aace847acf4e022765aca899dd63ff4908

data/extras_de_cont.gemspec

@@ -2,17 +2,57 @@
 
 Gem::Specification.new do |s|
   s.name = "extras_de_cont"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
   s.licenses = ["GPLv3"]
   s.summary = "A simple library which helps you extract transactions from a PDF bank statement."
   s.description = <<~TEXT
-    "A simple library which helps you extract transactions from a PDF bank statement.
-    Fine tuned for Romanian bank statements."
+    A simple library which helps you extract transactions from a PDF bank statement.
+    Fine tuned for Romanian bank statements.
+
+    # ExtrasDeCont
+
+    A ruby gem for extracting bank statements from PDFs.
+
+    ## Simple usage
+
+    Create a PDF parser and print the extracted text:
+
+    ```ruby
+    require "bundler/setup"
+    require "extras_de_cont"
+
+    parser = ExtrasDeCont::Parser.new("/home/dnutiu/Documents/tranzactii_revolut.pdf")
+    puts parser.text
+    ```
+
+    Or, extract all the transactions from a Revolut Bank statement PDF:
+
+    ```ruby
+    transactions = ExtrasDeCont.parse(file, bank: :revolut)
+
+    transactions.each do |t|
+      puts "\#{t.date}, \#{t.description}, \#{t.amount}, \#{t.currency}"
+    end
+    ```
+
+    Or use the included entrypoint:
+
+    ```bash
+    bundle exec ruby -Ilib bin/main /home/dnutiu/Documents/tranzactii_revolut.pdf
+    ```
+
+    Run the Revolut parser test with:
+
+    ```bash
+    ruby -Ilib:test test/revolut_rule_test.rb
+    ```
+
   TEXT
   s.authors = ["Denis Nutiu"]
   s.email = "dnutiu@nuculabs.dev"
   s.homepage = "https://nuculabs.dev"
-  s.metadata = {"source_code_uri" => "https://gitlab.nuculabs.dev/dnutiu/extras-de-cont"}
+  s.metadata = { "source_code_uri" => "https://gitlab.nuculabs.dev/dnutiu/extras-de-cont",
+                 "rubygems_mfa_required" => "true" }
   s.required_ruby_version = ">= 3.0.0"
 
   # Files to include in the gem

data/lib/extras_de_cont/rules/base.rb

@@ -2,6 +2,7 @@
 
 module ExtrasDeCont
   module Rules
+    # The base class for implementing bank specific transaction parsing rules.
     class Base
       def parse(_text)
         raise NotImplementedError, "#{self.class} must implement #parse"

data/lib/extras_de_cont/rules/revolut.rb

@@ -5,6 +5,7 @@ require "extras_de_cont/transaction"
 
 module ExtrasDeCont
   module Rules
+    # Rules for parsing Revolut bank statements.
     class Revolut < Rules::Base
       SECTION_HEADERS = [
         "Pending from ",
@@ -147,12 +148,10 @@ module ExtrasDeCont
         return if amount_matches.empty?
 
         transaction_match = if table.fetch(:has_balance)
-          if amount_matches.length > 1
-            amount_matches[-2]
-          end
-        else
-          amount_matches[-1]
-        end
+                              amount_matches[-2] if amount_matches.length > 1
+                            else
+                              amount_matches[-1]
+                            end
         return if transaction_match.nil?
 
         description = row[date_match.end(0)...transaction_match.begin(0)].to_s.strip

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extras_de_cont
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Denis Nutiu
@@ -23,9 +23,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
-description: |
-  "A simple library which helps you extract transactions from a PDF bank statement.
-  Fine tuned for Romanian bank statements."
+description: |+
+  A simple library which helps you extract transactions from a PDF bank statement.
+  Fine tuned for Romanian bank statements.
+
+  # ExtrasDeCont
+
+  A ruby gem for extracting bank statements from PDFs.
+
+  ## Simple usage
+
+  Create a PDF parser and print the extracted text:
+
+  ```ruby
+  require "bundler/setup"
+  require "extras_de_cont"
+
+  parser = ExtrasDeCont::Parser.new("/home/dnutiu/Documents/tranzactii_revolut.pdf")
+  puts parser.text
+  ```
+
+  Or, extract all the transactions from a Revolut Bank statement PDF:
+
+  ```ruby
+  transactions = ExtrasDeCont.parse(file, bank: :revolut)
+
+  transactions.each do |t|
+    puts "#{t.date}, #{t.description}, #{t.amount}, #{t.currency}"
+  end
+  ```
+
+  Or use the included entrypoint:
+
+  ```bash
+  bundle exec ruby -Ilib bin/main /home/dnutiu/Documents/tranzactii_revolut.pdf
+  ```
+
+  Run the Revolut parser test with:
+
+  ```bash
+  ruby -Ilib:test test/revolut_rule_test.rb
+  ```
+
 email: dnutiu@nuculabs.dev
 executables: []
 extensions: []
@@ -45,6 +84,7 @@ licenses:
 - GPLv3
 metadata:
   source_code_uri: https://gitlab.nuculabs.dev/dnutiu/extras-de-cont
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -63,3 +103,4 @@ rubygems_version: 4.0.10
 specification_version: 4
 summary: A simple library which helps you extract transactions from a PDF bank statement.
 test_files: []
+...