wire_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d23672dd2a990aa5ca2d19ce40540fbbe2f950cab218fc900542b33ef3e3ed8b
+  data.tar.gz: 875b4cd7eec9f842c4f9839ad6d9e454006b4e73c4a5050fed7647a9cb9ac8b0
+SHA512:
+  metadata.gz: 9232a3b8bfb6ce923ceb8a089d2103aee42232ba88c9fe84f88f5b7e8dc13ffafcf15e36f2eb80672707aa380542e5ffbef78e373ef5a712cd3946a24aff1954
+  data.tar.gz: 8347c0487adc4c0697e60432bd936d70c56fc6559a5e790fe429be0605cf42c1ba44af12420305dd77ffa3ac9ecbffc7a752568ecd18c211337eccaa9c0767b6

data/.codeclimate.yml

@@ -0,0 +1,35 @@
+prepare:
+  fetch:
+    - url: "https://raw.githubusercontent.com/ForwardFinancing/code_styles/master/rubocop.yml"
+      path: ".rubocop.yml"
+
+    - url: "https://raw.githubusercontent.com/ForwardFinancing/code_styles/master/stylelintrc"
+      path: ".stylelintrc"
+engines:
+  bundler-audit:
+    enabled: false # somehow it is failing in CodeClimate's builds
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+    file: ".rubocop.yml"
+    channel: rubocop-0-48
+    checks:
+      Rubocop/Style/RegexpLiteral:
+        enabled: false
+  stylelint:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 20
+ratings:
+  paths:
+    - "Gemfile.lock"
+    - "**.rb"
+exclude_paths:
+- "bin"
+- "schemas"
+- "test"

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+
+[*.xsd]
+indent_size = 4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.0

data/.tool-versions-e

@@ -0,0 +1 @@
+ruby 2.5.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wire_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018-present Forward Financing LLC
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,46 @@
+[![Codeship Status for ForwardFinancing/wire_client](https://app.codeship.com/projects/80539010-e9b6-0135-7649-4a1e2141a6e6/status?branch=master)](https://app.codeship.com/projects/269959)
+[![Code Climate](https://api.codeclimate.com/v1/badges/055840fb4eaf9e44ec80/maintainability)](https://codeclimate.com/repos/5a6a6058396682027c0028f6/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/055840fb4eaf9e44ec80/test_coverage)](https://codeclimate.com/repos/5a6a6058396682027c0028f6/test_coverage)
+
+# WireClient
+
+> Implementation of ISO 20022 payment initiation (pain) messages and bank providers for wire transfers
+
+## Overview
+
+The WireClient gem provides a common interface for working with a variety of Wire Transfer providers
+and building ISO 20022 payment initiation (pain) messages — currently, only `pain.001.001.03`
+and `pain.008.001.02` messages are supported.
+
+This is a fork of the [`sepa_king`](https://github.com/salesking/sepa_king) Ruby gem. Our main purpose
+is to create a flexible solution appliable to the American financial system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wire_client'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself:
+
+```sh
+$ gem install wire_client
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bundle exec rake test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ForwardFinancing/wire_client.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wire_client/version'
+
+GEM = 'wire_client'
+VERSION = WireClient::VERSION
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Build the sequel-seed gem'
+task :build do |p|
+  sh %{#{FileUtils::RUBY} -S gem build #{GEM}.gemspec}
+end
+
+desc 'Release the sequel-seed gem to rubygems.org'
+task release: :build do
+  sh %{#{FileUtils::RUBY} -S gem push ./#{GEM}-#{VERSION}.gem}
+end
+
+task default: :test

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wire_client/account/account.rb

@@ -0,0 +1,59 @@
+require_relative '../base/converters'
+require_relative '../base/validators'
+
+module WireClient
+  class Account
+    include ActiveModel::Validations
+    extend Converter
+
+    attr_accessor :name,
+                  :iban,
+                  :bic,
+                  :account_number,
+                  :wire_routing_number,
+                  :clear_system_code,
+                  :schema_code,
+                  :identifier,
+                  :country,
+                  :country_subdivision,
+                  :charge_bearer,
+                  :currency
+
+    convert :name, to: :text
+    validates_length_of :name, within: 1..70
+    validates_with CurrencyValidator,
+                   CountryValidator,
+                   CountrySubdivisionValidator,
+                   CreditorIdentifierValidator,
+                   BICValidator,
+                   IBANValidator,
+                   message: "%{value} is invalid"
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        public_send("#{name}=", value)
+      end
+
+      @currency ||= 'USD'
+      @country ||= 'US'
+      @country_subdivision ||= 'MA' if self.country == 'US'
+      @schema_code ||= 'CUST'
+      @clear_system_code ||= 'USABA'
+      custom_defaults if self.respond_to? :custom_defaults
+    end
+
+    def country_subdivision_abbr
+      if @country == 'US' && !@country_subdivision.match(/\A[A-Z]{2,2}\z/)
+        return US_STATES[@country_subdivision]
+      end
+      @country_subdivision
+    end
+
+    def country_subdivision_name
+      if @country == 'US' && @country_subdivision.match(/\A[A-Z]{2,2}\z/)
+        return US_STATES.key(@country_subdivision)
+      end
+      @country_subdivision
+    end
+  end
+end

data/lib/wire_client/account/creditor_account.rb

@@ -0,0 +1,7 @@
+module WireClient
+  class CreditorAccount < Account
+    def custom_defaults
+      @charge_bearer ||= 'CRED'
+    end
+  end
+end

data/lib/wire_client/account/debitor_account.rb

@@ -0,0 +1,7 @@
+module WireClient
+  class DebtorAccount < Account
+    def custom_defaults
+      @charge_bearer ||= 'DEBT'
+    end
+  end
+end

data/lib/wire_client/base/constants.rb

@@ -0,0 +1,61 @@
+module WireClient
+  PAIN_008_001_02 = 'pain.008.001.02'
+  PAIN_001_001_03 = 'pain.001.001.03'
+  US_STATES = {
+    "Alabama" => "AL",
+    "Alaska" => "AK",
+    "Arizona" => "AZ",
+    "Arkansas" => "AR",
+    "California" => "CA",
+    "Colorado" => "CO",
+    "Connecticut" => "CT",
+    "Delaware" => "DE",
+    "District of Columbia" => "DC",
+    "Florida" => "FL",
+    "Georgia" => "GA",
+    "Hawaii" => "HI",
+    "Idaho" => "ID",
+    "Illinois" => "IL",
+    "Indiana" => "IN",
+    "Iowa" => "IA",
+    "Kansas" => "KS",
+    "Kentucky" => "KY",
+    "Louisiana" => "LA",
+    "Maine" => "ME",
+    "Maryland" => "MD",
+    "Massachusetts" => "MA",
+    "Michigan" => "MI",
+    "Minnesota" => "MN",
+    "Mississippi" => "MS",
+    "Missouri" => "MO",
+    "Montana" => "MT",
+    "Nebraska" => "NE",
+    "Nevada" => "NV",
+    "New Hampshire" => "NH",
+    "New Jersey" => "NJ",
+    "New Mexico" => "NM",
+    "New York" => "NY",
+    "North Carolina" => "NC",
+    "North Dakota" => "ND",
+    "Ohio" => "OH",
+    "Oklahoma" => "OK",
+    "Oregon" => "OR",
+    "Pennsylvania" => "PA",
+    "Rhode Island" => "RI",
+    "South Carolina" => "SC",
+    "South Dakota" => "SD",
+    "Tennessee" => "TN",
+    "Texas" => "TX",
+    "Utah" => "UT",
+    "Vermont" => "VT",
+    "Virginia" => "VA",
+    "Washington" => "WA",
+    "West Virginia" => "WV",
+    "Wisconsin" => "WI",
+    "Wyoming" => "WY"
+  }
+  SEQUENCE_TYPES = %w(FRST OOFF RCUR FNAL)
+  LOCAL_INSTRUMENTS = %w(CORE COR1 B2B)
+  SERVICE_PRIORITY_TYPES = %w(HIGH NORM)
+  SERVICE_LEVEL_TYPES = %w(BKTR URGP URNS NURG SEPA)
+end

data/lib/wire_client/base/converters.rb

@@ -0,0 +1,46 @@
+module WireClient
+  module Converter
+    def convert(*attributes, options)
+      include InstanceMethods
+
+      method_name = "convert_#{options[:to]}"
+      unless InstanceMethods.method_defined?(method_name)
+        raise ArgumentError, "Converter '#{options[:to]}' does not exist!"
+      end
+
+      attributes.each do |attribute|
+        define_method "#{attribute}=" do |value|
+          instance_variable_set("@#{attribute}", send(method_name, value))
+        end
+      end
+    end
+
+    module InstanceMethods
+      def convert_text(value)
+        return unless value.present?
+        value.to_s.
+          # Replace some special characters described as "Best practices"
+          # in Chapter 6.2 of this document:
+          # http://www.europeanpaymentscouncil.eu/index.cfm/knowledge-bank/epc-documents/sepa-requirements-for-an-extended-character-set-unicode-subset-best-practices/
+          tr('€', 'E').
+          gsub('@', '(at)').
+          tr('_', '-').
+
+          # Replace linebreaks by spaces
+          gsub(/\n+/, ' ').
+
+          # Remove all invalid characters
+          gsub(/[^a-zA-Z0-9ÄÖÜäöüß&*$%\ \'\:\?\,\-\(\+\.\)\/]/, '').
+
+          # Remove leading and trailing spaces
+          strip
+      end
+
+      def convert_decimal(value)
+        return unless value.present?
+        value = BigDecimal(value.to_f&.to_s)
+        value.round(2) if value&.finite? && value.positive?
+      end
+    end
+  end
+end

data/lib/wire_client/base/invalid_wire_transaction_error.rb

@@ -0,0 +1,4 @@
+# To be raised when an Wire transfer transaction cannot be
+# sent because it is invalid
+class InvalidWireTransactionError < RuntimeError
+end

data/lib/wire_client/base/invalid_wire_transaction_type_error.rb

@@ -0,0 +1,3 @@
+# To be raised when an Wire transfer transaction type is invalid
+class InvalidWireTransactionTypeError < RuntimeError
+end

data/lib/wire_client/base/validators.rb

@@ -0,0 +1,95 @@
+module WireClient
+  class BaseValidator < ActiveModel::Validator
+    class_attribute :default_field_name
+
+    def extract_field_name_value(record)
+      field_name = options[:field_name] || self.class.default_field_name
+      value = record.send(field_name).to_s
+
+      [field_name, value]
+    end
+  end
+
+  class RegexBasedValidators < BaseValidator
+    def validate(record)
+      field_name, value = extract_field_name_value(record)
+
+      unless value.match(self.class::REGEX)
+        record.errors.add(field_name, :invalid, message: options[:message])
+      end
+    end
+  end
+
+  class CurrencyValidator < RegexBasedValidators
+    REGEX = /\A[A-Z]{3,3}\z/
+
+    self.default_field_name = :currency
+  end
+
+  class CountryValidator < RegexBasedValidators
+    REGEX = /\A[A-Z]{2,2}\z/
+
+    self.default_field_name = :country
+  end
+
+  class CreditorIdentifierValidator < RegexBasedValidators
+    REGEX = /\A[a-zA-Z0-9]{1,35}\z/
+
+    self.default_field_name = :identifier
+  end
+
+  class MandateIdentifierValidator < RegexBasedValidators
+    REGEX = /\A([A-Za-z0-9]|[\+|\?|\/|\-|\:|\(|\)|\.|\,|\']){1,35}\z/
+
+    self.default_field_name = :mandate_id
+  end
+
+  class CountrySubdivisionValidator < BaseValidator
+    self.default_field_name = :country_subdivision
+
+    def validate(record)
+      field_name, value = extract_field_name_value(record)
+      country = record.send(options[:country] || :country).to_s
+
+      if country == 'US'
+        unless US_STATES.key?(value) || US_STATES.value?(value)
+          record.errors.add(field_name, :invalid, message: options[:message])
+        end
+      end
+    end
+  end
+
+  class IBANValidator < BaseValidator
+    # IBAN2007Identifier (taken from schema)
+    REGEX = /\A[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}\z/
+
+    self.default_field_name = :iban
+
+    def validate(record)
+      field_name, value = extract_field_name_value(record)
+
+      if value.present?
+        unless IBANTools::IBAN.valid?(value) && value.match(REGEX)
+          record.errors.add(field_name, :invalid, message: options[:message])
+        end
+      end
+    end
+  end
+
+  class BICValidator < BaseValidator
+    # AnyBICIdentifier (taken from schema)
+    REGEX = /\A[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}\z/
+
+    self.default_field_name = :bic
+
+    def validate(record)
+      field_name, value = extract_field_name_value(record)
+
+      if value.present?
+        unless value.match(REGEX)
+          record.errors.add(field_name, :invalid, message: options[:message])
+        end
+      end
+    end
+  end
+end

data/lib/wire_client/messages/credit_transfer.rb

@@ -0,0 +1,112 @@
+require_relative './message'
+require_relative '../transaction/credit_transfer_transaction'
+
+module WireClient
+  class CreditTransfer < Message
+    self.account_class = DebtorAccount
+    self.transaction_class = CreditTransferTransaction
+    self.xml_main_tag = 'CstmrCdtTrfInitn'
+    self.known_schemas = [WireClient::PAIN_001_001_03]
+
+    private
+
+    # Find groups of transactions which share the same values for
+    # selected attributes
+    def transaction_group(transaction)
+      {
+        requested_date:   transaction.requested_date,
+        batch_booking:    transaction.batch_booking,
+        service_priority: transaction.service_priority,
+        service_level:    transaction.service_level
+      }
+    end
+
+    def build_payment_information(builder)
+      # Build a PmtInf block for every group of transactions
+      grouped_transactions.each do |group, transactions|
+        # All transactions with the same requested_date are placed into the
+        # same PmtInf block
+        builder.PmtInf do
+          builder.PmtInfId(payment_information_identification(group))
+          builder.PmtMtd('TRF')
+          builder.NbOfTxs(transactions.length)
+          builder.PmtTpInf do
+            builder.InstrPrty(group[:service_priority])
+            builder.SvcLvl do
+              builder.Cd(group[:service_level])
+            end
+          end
+          builder.ReqdExctnDt(group[:requested_date].iso8601)
+          builder.BtchBookg(group[:batch_booking])
+          builder.CtrlSum('%.2f' % amount_total(transactions))
+          builder.Dbtr do
+            builder.Nm(account.name)
+            builder.PstlAdr do
+              builder.CtrySubDvsn(account.country_subdivision_abbr)
+              builder.Ctry(account.country)
+            end
+          end
+          builder.DbtrAcct do
+            account_id(builder, account)
+          end
+          builder.DbtrAgt do
+            builder.FinInstnId do
+              account_agent_id(builder, account)
+              builder.PstlAdr do
+                builder.Ctry(account.country)
+              end
+            end
+          end
+
+          if account.charge_bearer
+            builder.ChrgBr(account.charge_bearer)
+          end
+
+          transactions.each do |transaction|
+            build_transaction(builder, transaction)
+          end
+        end
+      end
+    end
+
+    def build_transaction(builder, transaction)
+      builder.CdtTrfTxInf do
+        builder.PmtId do
+          if transaction.instruction.present?
+            builder.InstrId(transaction.instruction)
+          end
+          builder.EndToEndId(transaction.reference)
+        end
+        builder.Amt do
+          builder.InstdAmt(
+            '%.2f' % transaction.amount,
+            Ccy: transaction.currency
+          )
+        end
+        builder.CdtrAgt do
+          builder.FinInstnId do
+            transaction_agent_id(builder, transaction)
+            builder.Nm(transaction.agent_name)
+            builder.PstlAdr do
+              builder.Ctry(transaction.country)
+            end
+          end
+        end
+        builder.Cdtr do
+          builder.Nm(transaction.name)
+          builder.PstlAdr do
+            builder.Ctry(transaction.country)
+          end
+        end
+        builder.CdtrAcct do
+          transaction_account_id(builder, transaction)
+        end
+        if transaction.remittance_information
+          builder.RmtInf do
+            builder.Ustrd(transaction.remittance_information)
+          end
+        end
+      end
+    end
+  end
+end