ach_client 0.5.1

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

@@ -0,0 +1,59 @@
+module AchClient
+  class ICheckGateway
+    ## Transforms ICheckGateway transaction report response records into
+    # AchClient::Response objects
+    class ResponseRecordProcessor < Abstract::ResponseRecordProcessor
+
+      # The column index with the record status
+      STATUS_COLUMN = 1
+      # The column index with the record amount ($)
+      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
+      RETURN_CODE_INDEX = 3..5
+
+      ## Transforms ICheckGateway transaction report response records into
+      # AchClient::Response objects
+      # @param record [String] the | separated record string from ICheckGateway
+      # @return [AchClient::AchResponse] our representation of the response
+      def self.process_response_record(record)
+        # The response record is a | separated list
+        record = record.split('|')
+        # The first letter in the second column determines the response type
+        case record[STATUS_COLUMN].first
+        when 'N'
+          # N - no, it hasn't settled yet
+          AchClient::ProcessingAchResponse.new(
+            amount: record[AMOUNT_COLUMN],
+            date: record[DATE_COLUMN]
+          )
+        when 'Y'
+          # Y - yes, it has settled
+          AchClient::SettledAchResponse.new(
+            amount: record[AMOUNT_COLUMN],
+            date: record[DATE_COLUMN]
+          )
+        else
+          # If it starts with R, it is probably a return, in which case the
+          # column looks like: R (R01)
+          # As of now, it looks like there are no corrections from
+          # ICheckGateway
+          if record[1].start_with?('R')
+            AchClient::ReturnedAchResponse.new(
+              amount: record[AMOUNT_COLUMN],
+              date: record[DATE_COLUMN],
+              return_code: AchClient::ReturnCodes.find_by(
+                code: record[STATUS_COLUMN][RETURN_CODE_INDEX]
+              )
+            )
+          else
+            # If it doesn't start with an R, something that is undocumented is
+            # happening, so we raise an error since we need to know about it
+            raise "Couldnt process ICheckGateway Response: #{record.join('|')}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module AchClient
+  class ICheckGateway
+    # Right now the ICheckGateway transaction type codes are the same as the
+    #   AchWorks transaction type codes
+    class TransactionTypeTransformer < AchClient::AchWorks::TransactionTypeTransformer
+    end
+  end
+end

data/lib/ach_client/providers/soap/soap_provider.rb

@@ -0,0 +1,47 @@
+module AchClient
+  ## Concern for providers that have SOAP apis, to be included in
+  #    provider class
+  module SoapProvider
+    extend ActiveSupport::Concern
+
+    included do
+      # @return [String] Url of provider's WSDL doc for the environment you want
+      class_attribute :wsdl
+
+      # @return [Savon::Client] The Savon client object to use for making SOAP
+      # requests to the provider
+      class_attribute :_soap_client
+
+      # Makes a SOAP request to the provider, without any error handling, and
+      # returns the savon response after logging it
+      # @param method [Symbol] SOAP operation to call against the provider
+      # @param message [Hash] The request body
+      # @return [Savon::Response] raw response
+      def self.request(method:, message:)
+        logged_response(method, soap_client.call(method, message: message))
+      end
+
+      private_class_method def self.logged_response(method, response)
+        # Provider name can be the name of the class this is included in
+        provider_name = self.to_s.demodulize
+        AchClient::Logging::LogProviderJob.perform_async(
+          body: response.xml,
+          name: "response-#{provider_name}-#{method}-#{DateTime.now}.xml"
+        )
+        response
+      end
+
+      # @return [Savon::Client] The Savon client object to use for making SOAP
+      # requests to the provider
+      private_class_method def self.soap_client
+        self._soap_client ||= Savon.client(wsdl: self.wsdl) do
+          # Lets us use symbols as keys without Savon changing the case
+          # { 'Key' => 'Value' } == { Key: 'Value' }
+          convert_request_keys_to :none
+
+          pretty_print_xml true
+        end
+      end
+    end
+  end
+end

data/lib/ach_client/version.rb

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

data/lib/ach_client.rb

@@ -0,0 +1,38 @@
+require 'ach'
+require 'active_support/all'
+require 'savon'
+require 'sucker_punch'
+
+# Require all of the files in lib
+Dir[Gem::Specification.find_by_name("ach_client").gem_dir + '/lib/**/*.rb'].sort.each do |f|
+  require(f.split('/lib/').last.split('.rb').first)
+end
+
+# Adapter for interacting with various Ach service providers
+module AchClient
+
+  # Enables consumer to interact with new Sftp/NACHA providers without adding
+  # them to the codebase!!
+  # Lets say the consumer wants to integrate with Citibank.
+  # They would invoke AchClient::Citibank, which would be undefined.
+  # This const_missing would be called, and the Citibank module would be
+  # dynamically defined, with all the necessary Sftp/NACHA concerns included and
+  # ready for use.
+  # This is only helpful because many financial institutions use the same setup
+  # with NACHA and an SFTP server.
+  def self.const_missing(name)
+    const_set(
+      name,
+      Class.new do
+        include AchClient::SftpProvider
+        include AchClient::NachaProvider
+
+        # Defines the classes within the provider namespace to use for
+        # sending transactions
+        const_set(:AchTransaction, Class.new(Sftp::AchTransaction))
+        const_set(:AchBatch, Class.new(Sftp::AchBatch))
+        const_set(:AchStatusChecker, Class.new(Sftp::AchStatusChecker))
+      end
+    )
+  end
+end

metadata

@@ -0,0 +1,346 @@
+--- !ruby/object:Gem::Specification
+name: ach_client
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Zach Cotter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ach
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- zach@zachcotter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- ach_client.gemspec
+- bin/console
+- bin/setup
+- config/return_codes.yml
+- lib/ach_client.rb
+- lib/ach_client/abstract/abstract_method_error.rb
+- lib/ach_client/helpers/dollars_to_cents.rb
+- lib/ach_client/logging/log_provider_job.rb
+- lib/ach_client/logging/log_providers/log_provider.rb
+- lib/ach_client/logging/log_providers/null_log_provider.rb
+- lib/ach_client/logging/log_providers/stdout_log_provider.rb
+- lib/ach_client/logging/logging.rb
+- lib/ach_client/logging/savon_observer.rb
+- lib/ach_client/objects/account_types.rb
+- lib/ach_client/objects/responses/ach_response.rb
+- lib/ach_client/objects/responses/corrected_ach_response.rb
+- lib/ach_client/objects/responses/processing_ach_response.rb
+- lib/ach_client/objects/responses/returned_ach_response.rb
+- lib/ach_client/objects/responses/settled_ach_response.rb
+- lib/ach_client/objects/return_code.rb
+- lib/ach_client/objects/return_codes.rb
+- lib/ach_client/objects/transaction_types.rb
+- lib/ach_client/providers/abstract/ach_batch.rb
+- lib/ach_client/providers/abstract/ach_status_checker.rb
+- lib/ach_client/providers/abstract/ach_transaction.rb
+- lib/ach_client/providers/abstract/company_info.rb
+- lib/ach_client/providers/abstract/response_record_processor.rb
+- lib/ach_client/providers/abstract/transformer.rb
+- lib/ach_client/providers/sftp/account_type_transformer.rb
+- lib/ach_client/providers/sftp/ach_batch.rb
+- lib/ach_client/providers/sftp/ach_status_checker.rb
+- lib/ach_client/providers/sftp/ach_transaction.rb
+- lib/ach_client/providers/sftp/nacha_provider.rb
+- lib/ach_client/providers/sftp/sftp_provider.rb
+- lib/ach_client/providers/sftp/transaction_type_transformer.rb
+- lib/ach_client/providers/soap/ach_works/account_type_transformer.rb
+- lib/ach_client/providers/soap/ach_works/ach_batch.rb
+- lib/ach_client/providers/soap/ach_works/ach_status_checker.rb
+- lib/ach_client/providers/soap/ach_works/ach_transaction.rb
+- lib/ach_client/providers/soap/ach_works/ach_works.rb
+- lib/ach_client/providers/soap/ach_works/company_info.rb
+- lib/ach_client/providers/soap/ach_works/correction_details_processor.rb
+- lib/ach_client/providers/soap/ach_works/date_formatter.rb
+- lib/ach_client/providers/soap/ach_works/response_record_processor.rb
+- lib/ach_client/providers/soap/ach_works/transaction_type_transformer.rb
+- lib/ach_client/providers/soap/i_check_gateway/account_type_transformer.rb
+- lib/ach_client/providers/soap/i_check_gateway/ach_batch.rb
+- lib/ach_client/providers/soap/i_check_gateway/ach_status_checker.rb
+- lib/ach_client/providers/soap/i_check_gateway/ach_transaction.rb
+- lib/ach_client/providers/soap/i_check_gateway/company_info.rb
+- lib/ach_client/providers/soap/i_check_gateway/i_check_gateway.rb
+- lib/ach_client/providers/soap/i_check_gateway/response_record_processor.rb
+- lib/ach_client/providers/soap/i_check_gateway/transaction_type_transformer.rb
+- lib/ach_client/providers/soap/soap_provider.rb
+- lib/ach_client/version.rb
+homepage: https://github.com/ForwardFinancing/ach_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- config
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Adapter to interact with various ACH service providers
+test_files: []