bankline_csv_import_file 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54025cfff6c29e03b95f121166c159066a5c4ffb
-  data.tar.gz: bec14e977478642df29e3c967096cb69b34766ef
+  metadata.gz: 5873525845d592185e8e2588efb4ae4780f891e5
+  data.tar.gz: 23c0e7b3fde8695b4e1bdcf31258ff37b4f64b68
 SHA512:
-  metadata.gz: 8eba6219bfb10225a9d9ac28e6d1e6d75d1897781e78abc82f123ef955a5bd85e6d9bbd8c839405dbab369320631088acb63e9d17c8ee979fb66503c944aac57
-  data.tar.gz: 4b7d8620a44aceb424979484501c301898502d3aa59c494851e2090d988e283875b38eb621dca7f4ec84e3fa8b1725f406e05b3a844e6d4294bf416bfc7667b0
+  metadata.gz: c114810c6d7a56388a2e8c9f6bec660719bb1344c8e5c40711892bd316c0095f2f21f43f93ec02fe41e9f08e6be3286d5b27f365ddc0c6e327584285e7be71e1
+  data.tar.gz: 85cb877a0b3506166048addfaeb236605c6c18e2452a760ddbf73829248f6da365f42894844bb43f349c68a685f284a82c3ef7b2be5e35cac347cdee4023060e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bankline_csv_import_file (0.2.0)
+    bankline_csv_import_file (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -11,37 +11,40 @@ USER BEWARE: At the time of writing, we have not yet verified that the produced
 
 Add any number of payments as described below, then generate the CSV content:
 
-    file = BanklineCsvImportFile.new
+``` ruby
+file = BanklineCsvImportFile.new
 
-    file.add_domestic_payment(…)
-    file.add_domestic_payment(…)
-    file.add_international_payment(…)
-
-    file.generate  # => "foo,bar,…"
+file.add_domestic_payment(…)
+file.add_domestic_payment(…)
+file.add_international_payment(…)
 
+file.generate  # => "foo,bar,…"
+```
 
 ### Domestic payment
 
-All these fields are required unless stated otherwise.
+All these arguments are required unless stated otherwise.
 
-    file = BanklineCsvImportFile.new
+``` ruby
+file = BanklineCsvImportFile.new
 
-    file.add_domestic_payment(
-      payer_sort_code: "151000",
-      payer_account_number: "31806542",
-      amount: "123.45",                        # Strings and BigDecimal are allowed. (Floats are not advisable for money.) Rounded to 2 decimals.
-      beneficiary_sort_code: "151000",
-      beneficiary_account_number: "44298801",
-      beneficiary_name: "John Doe",            # Truncated to a max length of 35.
-      beneficiary_reference: "Invoice 123",    # Truncated to a max length of 18.
-      payment_date: Date.new(2018, 1, 1),      # Optional. Defaults to Date.current if available, otherwise Date.today. See note below.
-    )
+file.add_domestic_payment(
+  payer_sort_code: "151000",
+  payer_account_number: "31806542",
+  amount: "123.45",                        # Strings and BigDecimal are allowed. (Floats are not advisable for money.) Rounded to 2 decimals.
+  beneficiary_sort_code: "151000",
+  beneficiary_account_number: "44298801",
+  beneficiary_name: "John Doe",            # Truncated to a max length of 35.
+  beneficiary_reference: "Invoice 123",    # Truncated to a max length of 18.
+  payment_date: Date.new(2018, 1, 1),      # See note below.
+)
 
-    file.generate  # => "foo,bar,…"
+file.generate  # => "foo,bar,…"
+```
 
 Currency is assumed to be GBP.
 
-Texts are converted to UPPERCASE and characters other than A-Z, 0-9, space and .-/& are automatically removed from free-text fields.
+Texts are converted to UPPERCASE and characters other than A-Z, 0-9, space and .-/& are automatically removed from free-text values.
 
 Sort codes and account numbers are automatically normalised to the expected format.
 
@@ -54,28 +57,32 @@ Bankline says this about the payment date:
 
 ### International payment
 
-All these fields are required unless stated otherwise.
+All these arguments are required unless stated otherwise.
 
-    file = BanklineCsvImportFile.new
-    file.add_international_payment(
-      payer_sort_code: "151000",             # Any non-digits will be stripped automatically.
-      payer_account_number: "31806542",      # Any non-digits will be stripped automatically.
-      amount: "123.45",                      # Strings and BigDecimal are allowed. (Floats are not advisable for money.)
-      payment_date: Date.new(2018, 1, 1),    # Optional. Defaults to Date.current if available, otherwise Date.today. See note below.
-      beneficiary_bic: "SPKHDE2H",
-      beneficiary_iban: "DE53250501800039370089",
-      beneficiary_name: "John Doe",
+``` ruby
+file = BanklineCsvImportFile.new
 
-      # Optional but recommended, see below. Truncated to 35 chars per line and max 3 lines.
-      beneficiary_address: "10 Foo Street\nBartown, Baz County\nABC 123"
+file.add_international_payment(
+  payer_sort_code: "151000",             # Any non-digits will be stripped automatically.
+  payer_account_number: "31806542",      # Any non-digits will be stripped automatically.
+  amount: "123.45",                      # Strings and BigDecimal are allowed. (Floats are not advisable for money.)
+  payment_date: Date.new(2018, 1, 1),    # See note below.
+  beneficiary_bic: "SPKHDE2H",
+  beneficiary_iban: "DE53250501800039370089",
+  beneficiary_name: "John Doe",
 
-      beneficiary_reference: "Invoice 123",  # Optional. Truncated to 35 chars per line and max 4 lines.
-    )
-    file.generate  # => "foo,bar,…"
+  # Optional but recommended, see below. Truncated to 35 chars per line and max 3 lines.
+  beneficiary_address: "10 Foo Street\nBartown, Baz County\nABC 123"
+
+  beneficiary_reference: "Invoice 123",  # Optional. Truncated to 35 chars per line and max 4 lines.
+)
+
+file.generate  # => "foo,bar,…"
+```
 
 Currency is assumed to be GBP.
 
-Characters other than a-z, A-Z, 0-9, space and .-/?:(),+' are automatically removed from free-text fields.
+Characters other than a-z, A-Z, 0-9, space and .-/?:(),+' are automatically removed from free-text values.
 
 Sort codes, account numbers, IBAN and BIC are automatically normalised to the expected format.
 

data/lib/bankline_csv_import_file.rb

@@ -9,11 +9,8 @@ class BanklineCsvImportFile
     @records = []
   end
 
-  def add_domestic_payment(payer_sort_code:, payer_account_number:, amount:, beneficiary_sort_code:, beneficiary_account_number:, beneficiary_name:, beneficiary_reference:, payment_date: nil)
-    # Use Ruby on Rails' `Date.current` when available, since it will be in the app time zone rather than the server time zone.
-    payment_date ||= Date.respond_to?(:current) ? Date.current : Date.today
+  def add_domestic_payment(payer_sort_code:, payer_account_number:, amount:, beneficiary_sort_code:, beneficiary_account_number:, beneficiary_name:, beneficiary_reference:, payment_date:)
     formatted_payment_date = payment_date.strftime("%d%m%Y")
-
     payer_account_with_sort_code = normalize_account("#{payer_sort_code}#{payer_account_number}")
 
     record = Record.new
@@ -32,11 +29,8 @@ class BanklineCsvImportFile
     @records << record
   end
 
-  def add_international_payment(payer_sort_code:, payer_account_number:, amount:, beneficiary_bic:, beneficiary_iban:, beneficiary_name:, beneficiary_address: nil, beneficiary_reference:, payment_date: nil)
-    # Use Ruby on Rails' `Date.current` when available, since it will be in the app time zone rather than the server time zone.
-    payment_date ||= Date.respond_to?(:current) ? Date.current : Date.today
+  def add_international_payment(payer_sort_code:, payer_account_number:, amount:, beneficiary_bic:, beneficiary_iban:, beneficiary_name:, beneficiary_address: nil, beneficiary_reference:, payment_date:)
     formatted_payment_date = payment_date.strftime("%d%m%Y")
-
     payer_account_with_sort_code = normalize_account("#{payer_sort_code}#{payer_account_number}")
 
     normalized_iban = normalize_iban(beneficiary_iban)

data/lib/bankline_csv_import_file/version.rb

@@ -1,3 +1,3 @@
 class BanklineCsvImportFile
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bankline_csv_import_file
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler