ach_client 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e40c40c7ee42a6264c64f512772b254fac48b70cb7bb323ba238594c3d2d50c
-  data.tar.gz: a6d925e6f0a9682e085de0f1d12240c827cf769d521ee66fabe7001ade43fd64
+  metadata.gz: d140b0751adee4c2f924f737d9533bf084656ff330e6ebd2f764cede1cac4bf7
+  data.tar.gz: 91340a5b05226ad8e2f1eeeeac110415187a7bb7341c45d155720e143e93b165
 SHA512:
-  metadata.gz: 86303a731c6e1c4de5f4a82fa8a12f2f9f955e3ef70601c423d907282b50e2e5992a762f4736223bab87672b28a86b566fa112c55c0e9a0f7fd2c9c819dbc6c3
-  data.tar.gz: 71299fac7355cd6b0a48e0245e8aa19e01f809f4acdcc00f97afda028c0f18dc0bb8792fabd5b242c6e590317f83385cef7e434fac395d3ad3ac8371897a1cc4
+  metadata.gz: 4affcfdf1085e60c06bf45916cea073f02b83e70bcae42e6e0f4ba9b774aa7695c82676344a2de91a4e0b294663aad91af3cbd055a34b9012f009e2775fcaecf
+  data.tar.gz: 2d9dc7b4c4f4ec66665e8cb74b646d8f21606adab21058c44a74b5451926f1e98cf4a8bf40f905167bfa8f9e388ce7aec2e18d163ee8cffd26e00c3227e3c259

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @ForwardFinancing/funding-app-smes

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.6.8

data/.tool-versions

@@ -1 +1 @@
-ruby 2.5.0
+ruby 2.6.8

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, ForwardFinancing
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -11,7 +11,7 @@
 ## Overview
 
 The AchClient gem provides a common interface for working with a variety of
-ACH providers.
+ACH providers.  This is an **OPEN SOURCE PROJECT, PUBLICLY ACCESSIBLE**, and licensed under the BSD 3-Clause license
 
 Supported features include:
 
@@ -337,6 +337,7 @@ these new classes using the same interface described above for the API providers
 | `outgoing_path` | Path on the remote server where bank has asked you to dump your NACHAs |
 | `incoming_path` | Path on the remote server where the bank leaves confirmation/return files |
 | `file_naming_strategy` | Function to define filenames for the NACHA files |
+| `transmission_datetime_calculator` | (optional) Function to define File Creation Date header value - defaults to `-> { Time.now }` - note that you may wish to override this to use a non-UTC zone |
 
 #### File Naming Strategy
 

data/ach_client.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ach', '~> 0'
 
   # Handy ruby behavior from rails
-  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activesupport', '< 6' # Need to rename .parent to .module_parent before upgrade
 
   # SFTP client (for Bank providers)
   spec.add_dependency 'net-sftp'

data/lib/ach_client/providers/sftp/ach_batch.rb

@@ -62,7 +62,8 @@ module AchClient
           :immediate_destination,
           :immediate_destination_name,
           :immediate_origin,
-          :immediate_origin_name
+          :immediate_origin_name,
+          :transmission_datetime
         ].each do |attribute|
           file_header.send("#{attribute}=", self.class.parent.send(attribute))
         end

data/lib/ach_client/providers/sftp/nacha_provider.rb

@@ -25,6 +25,13 @@ module AchClient
       # @return [String] originating_dfi_identification refers to your bank?
       # originating_dfi => "Originating Depository Financial Institution"
       class_attribute :originating_dfi_identification
+
+      # @return [Proc<Time>] method to calculate the File Creation Date for NACHA header
+      class_attribute :transmission_datetime_calculator, default: -> { Time.now }
+
+      def self.transmission_datetime
+        transmission_datetime_calculator.call
+      end
     end
   end
 end

data/lib/ach_client/providers/soap/i_check_gateway/ach_status_checker.rb

@@ -14,6 +14,8 @@ module AchClient
         "ACCESS DENIED"
       ]
 
+      EMPTY_RETURNS_RESPONSE = 'NO RETURNS REPORTED'.freeze
+
       ##
       # ICheckGateway does not support this
       def self.most_recent
@@ -34,31 +36,74 @@ module AchClient
         end
       end
 
-      # Wrapper for the range response endpoint
-      # @return [Hash{String => [AchClient::AchResponse]}] Hash with
+      # @return Hash{String => [AchClient::AchResponse]} Hash with
       # confirmation number as the key, lists of AchResponse objects as values
       def self.in_range(start_date:, end_date:)
         Helpers::Utils.hashlist_merge(
+          check_for_late_returns(start_date: start_date, end_date: end_date) +
+            pull_transaction_report(start_date: start_date, end_date: end_date)
+        )
+      end
+
+      # @return [Hash{String => [AchClient::AchResponse]}] List of hashes with
+      # confirmation number as the key, lists of AchResponse objects as values
+      private_class_method def self.pull_transaction_report(start_date:, end_date:)
+        AchClient::ICheckGateway.wrap_request(
+          method: :pull_transaction_report,
+          message: AchClient::ICheckGateway::CompanyInfo.build.to_hash.merge({
+            startDate: start_date,
+            endDate: end_date
+          })
+        ).split("\n").select do |record|
+          check_for_errors(record)
+          # Only the records that start with ICHECK are ACH transactions.
+          # Everything else is other types of transactions such as credit card swipes which are outside
+          # the scope of this library
+          record.start_with?('ICHECK')
+        end.map do |record|
+          # The 4th column is the external_ach_id which becomes the hash key
+          {
+            record.split('|')[3] =>
+              [
+                AchClient::ICheckGateway::ResponseRecordProcessor
+                  .process_response_record(record)
+              ]
+          }
+        end
+      end
+
+      # The pull_transaction_report method returns ACHs by effective entry date, which won't necessarily include
+      #   any late returns that were returned outside the window of pending ACHs.
+      # This uses a separate endpoint which gives back returned ACHs by the return date, which will include late
+      #  returns
+      # @return [Hash{String => [AchClient::AchResponse]}] List of hashes with
+      # confirmation number as the key, lists of AchResponse objects as values
+      private_class_method def self.check_for_late_returns(start_date:, end_date:)
+        (start_date..end_date).map do |date|
           AchClient::ICheckGateway.wrap_request(
-            method: :pull_transaction_report,
+            method: :pull_returned_checks,
             message: AchClient::ICheckGateway::CompanyInfo.build.to_hash.merge({
-              startDate: start_date,
-              endDate: end_date
+              ReturnedDate: date
             })
-          ).split("\n").select do |record|
-            check_for_errors(record)
-            # Ignore credit card swipes if there are any
-            record.start_with?('ICHECK')
-          end.map do |record|
-            {
-              record.split('|')[3] =>
-                [
-                  AchClient::ICheckGateway::ResponseRecordProcessor
-                    .process_response_record(record)
-                ]
-            }
+          ).split("\n").map do |record|
+            if record.include?("|")
+              # Each record returned by the API is a pipe separated list with 2 columns:
+              # Example: external_ach_id|R01\r\n
+              external_ach_id, return_code = record.split('|')
+              {external_ach_id => [AchClient::ReturnedAchResponse.new(
+                amount: nil, # response does not include amount
+                date: date,
+                return_code: AchClient::ReturnCodes.find_by(code: return_code)
+              )]}
+            elsif record.include?(EMPTY_RETURNS_RESPONSE)
+              # Server returns an error message instead of an empty list, so we catch the error message and return our
+              #  own empty response
+              {}
+            else
+              raise "Couldnt process ICheckGateway Late Returns Response: #{record}"
+            end
           end
-        )
+        end.reduce(&:+)
       end
     end
   end

data/lib/ach_client/providers/soap/i_check_gateway/response_record_processor.rb

@@ -10,11 +10,13 @@ module AchClient
       AMOUNT_COLUMN = 15
       # The column index with the record submission date
       DATE_COLUMN = 17
-      # THe string index range within the record status with the return code
+      # The string index range within the record status with the return code
       RETURN_CODE_INDEX = 3..5
 
       ## Transforms ICheckGateway transaction report response records into
-      # AchClient::Response objects
+      # AchClient::Response object
+      # Here is an example record:
+      # ICHECK|N||external_ach_id|abc||||||||BC|012345678|********1234|250.00|D|9/12/2016|05:03:04|C1234-1234||AutoCheck|||abcde|CCD|||\r\ns
       # @param record [String] the | separated record string from ICheckGateway
       # @return [AchClient::AchResponse] our representation of the response
       def self.process_response_record(record)

data/lib/ach_client/version.rb

@@ -1,4 +1,4 @@
 module AchClient
   # Increment this when changes are published
-  VERSION = '2.1.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ach_client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Zach Cotter
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ach
@@ -28,16 +28,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +248,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - zach@zachcotter.com
 executables: []
@@ -256,14 +256,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/CODEOWNERS"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".tool-versions"
 - ".tool-versions-e"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - ach_client.gemspec
@@ -332,7 +333,7 @@ homepage: https://github.com/ForwardFinancing/ach_client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -348,9 +349,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Adapter to interact with various ACH service providers
 test_files: []

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-before_install:
-  - export TZ=US/Eastern
-  - export CODECLIMATE_REPO_TOKEN=1fc324a28beed303e632765cca14487904a23023d85b9127a288f04cc007d28d
-  - export CC_TEST_REPORTER_ID=1fc324a28beed303e632765cca14487904a23023d85b9127a288f04cc007d28d
-  - date
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rake test
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-notifications:
-  email: false