abo_parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a6cd56f4d4829e57aa28c7e3a3713209f7fa5f64ff1ac1c8e1f7bdd337ff335
-  data.tar.gz: 603a28e200c51f2b5c2f53f59ef56acba7eb1ccbf4b55e839733a6990e1a62b3
+  metadata.gz: f8f46079c751a5d4a32a396751819b087ce11d24fec8c9337594a6a33173b287
+  data.tar.gz: 27a21310b20dc46e4ef762faac2728ba89f71176999abeeab2a37e612ea723f0
 SHA512:
-  metadata.gz: 8cba650ef983ea244ad0668318ea2952f2c414a06931e04a28db69412df375d969f6d86286535388665a5416f33f2a3ca5dbd1db9a691b0848c569b63668aaf0
-  data.tar.gz: fa2606a6be8f707ed94e1b0bd10125c2b5351661ef9c6dab1727be73a1ef1c6575f28fe7b9ab014361b38ab369528f0b4fa50619e3d9979f84ca4c4cd79894a1
+  metadata.gz: a19cb59f3bdfb55bbd8e6f9813cf17198139e16cf4025796556b9fdae56c549f7c53e4a57db092e6c5bcc8b5e59ec7daceddbb99e970632c4ac7587ef0d887f1
+  data.tar.gz: 9e15fab471749e0af8ac21b327445edccd7c2d2e77b895ba373727bd0fef4a357f2c3a4d2765825e326b546ca9f9042dcfef6b231076522143d7e1ecba9345eb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Released]
 
+## [1.0.1] - 2023-06-03
+
+- Added documentation to README.md
+
 ## [1.0.0] - 2023-06-03
 
 - Initial release

data/README.md

@@ -0,0 +1,128 @@
+# Usage
+## To parse file
+Only .gpc and .p11 file extententions are supported
+```ruby
+Abo.new
+```
+Returns:
+```ruby
+Abo
+  parse_file(path_to_file)
+  export_to_gpc(output_file, abo_hash_data)
+  export_to_p11(output_file, abo_hash_data)
+```
+
+# parse_file
+## GPC file
+Usage:
+```ruby
+bank_statement = Abo.new.parse_file(path_to_file)
+```
+Arguments:
+```
+path_to_file | String with path to GPC file
+```
+Returns:
+```ruby
+AboStatement
+  to_hash()
+  client_account_number
+  client_account_prefix_number
+  abbreviated_client_name
+  old_balance_date
+  old_balance
+  new_balance
+  transactions_debit
+  transactions_credit
+  statement_sequence_number
+  posting_date
+
+  transactions
+    Array
+      AboTransaction
+        to_hash()
+        client_account_number
+        client_account_prefix_number
+        counter_account_number
+        counter_account_prefix_number
+        document_number
+        amount
+        posting_code
+        variable_symbol
+        constant_symbol
+        specific_symbol
+        value
+        additional_information
+        change_of_item_code
+        type_of_data
+        due_date
+        debit
+        credit
+        counter_account_bank_code
+```
+
+## P11 file
+Usage:
+```ruby
+payment_orders = Abo.new.parse_file(path_to_file)
+```
+Arguments:
+```
+path_to_file | String with path to GPC file
+```
+Returns:
+```ruby
+Array
+  AboPaymentOrder
+    to_hash()
+    order_number_of_statement
+    file_creation_date
+    own_bank_code
+    counter_account_bank_code
+    amount
+    due_date
+    constant_symbol
+    variable_symbol_credit
+    specific_symbol_credit
+    own_account_prefix
+    own_account_number
+    counter_account_prefix
+    counter_account_number
+    credit_information
+    own_account_name
+    counter_account_name
+    variable_symbol_debit
+    specific_symbol_debit
+    debit_information
+    bank_information
+```
+
+# export_to_gpc
+Usage:
+```ruby
+Abo.new.export_to_gpc(output_file, abo_hash_data)
+```
+Arguments:
+```
+output_file   | String of where to save the file
+abo_hash_data | Hash of ABO data (AboStatement with AboTransactions)
+```
+Returns:
+```
+Nothing
+```
+
+# export_to_p11
+Usage:
+```ruby
+Abo.new.export_to_p11(output_file, abo_hash_data)
+```
+Arguments:
+```
+output_file   | String of where to save the file
+abo_hash_data | Array of AboPaymentOrders (as hash)
+```
+Returns:
+```
+Nothing
+```

data/lib/abo_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AboParser
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abo_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rhemery