Determine based on holidays whether a date is an official SEPA payment date recognised by the European Central Bank (ECB). The gem populates the base holidays for year 2015, 2016, 2017 and 2018 and will grab the later years' dates from ECB's site (feature yet to be completed).
The SEPA Date gem can be configured to check for national holidays as well, which may differ from the official ECB holidays. To set these up, please consult the configuration section.
- Ruby >= 1.8.7
The SEPA Date gem relies on the following gems:
Development depencies:
Add this to your Gemfile and run the bundle command.
gem "sepa_date"Then setup the configuration files with:
$ sepa_date_configureTo test if your expected payment date is in fact a valid ECB day, and not a national holiday as well as it can be processed within a reasonable timeframe from the banks' point of view:
due_date = SepaDate.verify_due_date(expected_due_date: DateTime.new(2015, 3, 18))
# due_date = #<Date: 2015-03-18 ((2457100j,0s,0n),+0s,2299161j)>The library will auto-adjust should your payment date fall on a holiday or a weekend:
due_date = SepaDate.verify_due_date(expected_due_date: DateTime.new(2015, 4, 3))
# due_date = #<Date: 2015-04-07 ((2457100j,0s,0n),+0s,2299161j)>The library will provide you useful information about these adjustments if it applied some adjustion in verbose mode:
due_date = SepaDate.verify_due_date(expected_due_date: DateTime.new(2015, 4, 3), verbose: true)
# due_date = {due_date: #<Date: 2015-04-07 ((2457100j,0s,0n),+0s,2299161j)>, message: "The selected payment date cannot be fulfilled because the required bank submission date falls on a bank holiday. We will automatically adjust this to the next available banking day, 07/04/2015."}You can configure many aspects of how the SEPA Date gem is handing its internals and outputs.
| Configuration | Definition | Default Value |
|---|---|---|
| submission_days | Submission days buffer - business days it takes to process a payment from a bank's point of view once they received a payment file. | 6 |
| date_format | Formatting for dates in all output messages. | "%d/%m/%Y" |
| config_date_format | Date format used to parse configuration options from the YAML files for holidays. | "%Y-%m-%d" |
| business_time_configuration_file | Location of the business time configuration file. | "config/business_time.yml" |
| holidays_configuration_file | Location of the holidays configuration file. This file holds the ECB holidays as well as national ones. | "config/holidays.yml" |
| instruction_days | Definition on how many days in advance should we need a bank file generated. | 3 |
| ecb_code | ECB code that should be used when dealing with European wide bank holidays. | "ecb" |
| country_code | Country code, if any, that should be used when dealing with national holidays. | nil |
Add country specific entries to your holidays.yml file (see configuration options) with the country code as the primary key, followed by the year and an array of dates as the value:
ie:
2015: [ "2015-01-01", "2015-03-17", "2015-04-03", "2015-04-06", "2015-05-04", "2015-05-01", "2015-08-03", "2015-10-26", "2015-12-25", "2015-12-28", "2015-12-29" ]
2016: [ ... ]You can tweak the location of the config file as well as the date format to be parsed using the configuration options
Find the ECB specific entries to your holidays.yml file (see configuration options) with the ecb_code as the primary key, followed by the year and an array of dates as the value:
ecb:
2015: [ "2015-12-25", "2015-12-28", "2015-01-01", "2015-04-03", "2015-04-06", "2015-05-01" ]
2016: [ ... ]You can tweak the location of the config file as well as the date format to be parsed using the configuration options
We gladly accept bugfixes and new features. Please follow the guidelines here to ensure your work is accepted.
When filing a new Issue:
- Please make clear in the subject what gateway the issue is about.
- Include the version of ActiveMerchant, Ruby, ActiveSupport, and Nokogiri you are using.
When submitting a pull request to resolve an issue:
- Fork it and clone your new repo
- Create a branch (
git checkout -b my_awesome_feature) - Commit your changes (
git add my/awesome/file.rb; git commit -m "Added my awesome feature") - Push your changes to your fork (
git push origin my_awesome_feature) - Open a Pull Request
(The MIT License)
Copyright (c) 2014 Máté Marjai, The Product Works
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.