abo_parser 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0a6cd56f4d4829e57aa28c7e3a3713209f7fa5f64ff1ac1c8e1f7bdd337ff335
4
- data.tar.gz: 603a28e200c51f2b5c2f53f59ef56acba7eb1ccbf4b55e839733a6990e1a62b3
3
+ metadata.gz: f8f46079c751a5d4a32a396751819b087ce11d24fec8c9337594a6a33173b287
4
+ data.tar.gz: 27a21310b20dc46e4ef762faac2728ba89f71176999abeeab2a37e612ea723f0
5
5
  SHA512:
6
- metadata.gz: 8cba650ef983ea244ad0668318ea2952f2c414a06931e04a28db69412df375d969f6d86286535388665a5416f33f2a3ca5dbd1db9a691b0848c569b63668aaf0
7
- data.tar.gz: fa2606a6be8f707ed94e1b0bd10125c2b5351661ef9c6dab1727be73a1ef1c6575f28fe7b9ab014361b38ab369528f0b4fa50619e3d9979f84ca4c4cd79894a1
6
+ metadata.gz: a19cb59f3bdfb55bbd8e6f9813cf17198139e16cf4025796556b9fdae56c549f7c53e4a57db092e6c5bcc8b5e59ec7daceddbb99e970632c4ac7587ef0d887f1
7
+ data.tar.gz: 9e15fab471749e0af8ac21b327445edccd7c2d2e77b895ba373727bd0fef4a357f2c3a4d2765825e326b546ca9f9042dcfef6b231076522143d7e1ecba9345eb
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  ## [Released]
2
2
 
3
+ ## [1.0.1] - 2023-06-03
4
+
5
+ - Added documentation to README.md
6
+
3
7
  ## [1.0.0] - 2023-06-03
4
8
 
5
9
  - Initial release
data/README.md CHANGED
@@ -0,0 +1,128 @@
1
+ # Usage
2
+ ## To parse file
3
+ Only .gpc and .p11 file extententions are supported
4
+ ```ruby
5
+ Abo.new
6
+ ```
7
+ Returns:
8
+ ```ruby
9
+ Abo
10
+ parse_file(path_to_file)
11
+ export_to_gpc(output_file, abo_hash_data)
12
+ export_to_p11(output_file, abo_hash_data)
13
+ ```
14
+
15
+ # parse_file
16
+ ## GPC file
17
+ Usage:
18
+ ```ruby
19
+ bank_statement = Abo.new.parse_file(path_to_file)
20
+ ```
21
+ Arguments:
22
+ ```
23
+ path_to_file | String with path to GPC file
24
+ ```
25
+ Returns:
26
+ ```ruby
27
+ AboStatement
28
+ to_hash()
29
+ client_account_number
30
+ client_account_prefix_number
31
+ abbreviated_client_name
32
+ old_balance_date
33
+ old_balance
34
+ new_balance
35
+ transactions_debit
36
+ transactions_credit
37
+ statement_sequence_number
38
+ posting_date
39
+
40
+ transactions
41
+ Array
42
+ AboTransaction
43
+ to_hash()
44
+ client_account_number
45
+ client_account_prefix_number
46
+ counter_account_number
47
+ counter_account_prefix_number
48
+ document_number
49
+ amount
50
+ posting_code
51
+ variable_symbol
52
+ constant_symbol
53
+ specific_symbol
54
+ value
55
+ additional_information
56
+ change_of_item_code
57
+ type_of_data
58
+ due_date
59
+ debit
60
+ credit
61
+ counter_account_bank_code
62
+ ```
63
+
64
+ ## P11 file
65
+ Usage:
66
+ ```ruby
67
+ payment_orders = Abo.new.parse_file(path_to_file)
68
+ ```
69
+ Arguments:
70
+ ```
71
+ path_to_file | String with path to GPC file
72
+ ```
73
+ Returns:
74
+ ```ruby
75
+ Array
76
+ AboPaymentOrder
77
+ to_hash()
78
+ order_number_of_statement
79
+ file_creation_date
80
+ own_bank_code
81
+ counter_account_bank_code
82
+ amount
83
+ due_date
84
+ constant_symbol
85
+ variable_symbol_credit
86
+ specific_symbol_credit
87
+ own_account_prefix
88
+ own_account_number
89
+ counter_account_prefix
90
+ counter_account_number
91
+ credit_information
92
+ own_account_name
93
+ counter_account_name
94
+ variable_symbol_debit
95
+ specific_symbol_debit
96
+ debit_information
97
+ bank_information
98
+ ```
99
+
100
+ # export_to_gpc
101
+ Usage:
102
+ ```ruby
103
+ Abo.new.export_to_gpc(output_file, abo_hash_data)
104
+ ```
105
+ Arguments:
106
+ ```
107
+ output_file | String of where to save the file
108
+ abo_hash_data | Hash of ABO data (AboStatement with AboTransactions)
109
+ ```
110
+ Returns:
111
+ ```
112
+ Nothing
113
+ ```
114
+
115
+ # export_to_p11
116
+ Usage:
117
+ ```ruby
118
+ Abo.new.export_to_p11(output_file, abo_hash_data)
119
+ ```
120
+ Arguments:
121
+ ```
122
+ output_file | String of where to save the file
123
+ abo_hash_data | Array of AboPaymentOrders (as hash)
124
+ ```
125
+ Returns:
126
+ ```
127
+ Nothing
128
+ ```
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module AboParser
4
- VERSION = "1.0.0"
4
+ VERSION = "1.0.1"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: abo_parser
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Rhemery