metro2_format 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86d8af24ca1737814501fd020751719885ec7d49c93a54e9774feebecc142250
+  data.tar.gz: b3756ce2a4ebc029957419bb7cdb168d2ceb4813688354ee927362720d0329c4
+SHA512:
+  metadata.gz: 293d93ccdf56965eb7cf5619e17477418e9e1b7f0df2334cd59aed173a0ca0352c5bceeddded93d70774f0debc6362fddef31fa873294cb9a00e936d59d31e17
+  data.tar.gz: 523566fc302e17ad6b74ca3b169b14f35b3810e29410d3c7dc8d77185bba3a39e5f5181dbbc83ac50fc11368df389f77e7a07c86469d773f25427fa52006c0c0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Mascarenhas
+
+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,49 @@
+# Metro2
+
+Creates files in Metro 2 format for reporting to credit agencies
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metro_2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metro_2
+
+## Usage
+
+```ruby
+metro_2_content = Metro2::Metro2File.new
+metro_2_content.header.cycle_number = 15
+metro_2_content.header.equifax_program_identifier = 'EFAXID'
+metro_2_content.header.transunion_program_identifier = 'TRANSUNION'
+# ... other header segment attributes
+
+base_segment = Metro2::Records::BaseSegment.new
+base_segment.time_stamp = Time.new(2014, 9, 15, 17, 7, 45)
+base_segment.identification_number = 'REPORTERXYZ'
+base_segment.cycle_number = 1
+base_segment.consumer_account_number = 'ABC123'
+base_segment.portfolio_type = 'I'
+# ... other base segment attributes
+metro_2_content.base_segments << base_segment
+# add more base segments as needed
+
+metro_2_content.to_s # contents to write to file
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/metro_2/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require
+require 'metro_2/version'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec
+
+task :build do
+  system 'gem build metro_2.gemspec'
+end
+

data/lib/metro_2.rb

@@ -0,0 +1,241 @@
+require 'metro_2/version'
+
+module Metro2
+
+  PORTFOLIO_TYPE = {
+    line_of_credit: 'C',
+    installment: 'I',
+    mortgage: 'M',
+    open_account: 'O',
+    revolving: 'R'
+  }.freeze
+
+  ACCOUNT_TYPE = {
+    unsecured: '01',
+    education: '12'
+    # TODO: add other account types
+  }.freeze
+
+  ECOA_CODE = {
+    individual: '1',
+    deceased: 'X',
+    delete: 'Z'
+    # TODO: add other ECOA codes
+  }.freeze
+
+  SPECIAL_COMMENT_CODE = {
+    partial_payment_agreement: 'AC',
+    purchased_by_another_company: 'AH',
+    paid_in_full_less_than_full_balance: 'AU',
+    affected_by_natural_or_declared_disaster: 'AW',
+    loan_modified: 'CO',
+    forbearance: 'CP',
+    # TODO: add other special comment codes
+  }.freeze
+
+  COMPLIANCE_CONDITION_CODE = {
+    in_dispute: 'XB',
+    previously_in_dispute_now_resolved: 'XH',
+    # TODO: add other compliance condition codes
+  }.freeze
+
+  INTEREST_TYPE_INDICATOR = {
+    fixed: 'F',
+    variable: 'V'
+  }.freeze
+
+  CORRECTION_INDICATOR = '1'
+
+  TERMS_FREQUENCY = {
+    deferred: 'D',
+    single_payment: 'P',
+    weekly: 'W',
+    biweekly: 'B',
+    semimonthly: 'S',
+    monthly: 'M',
+    bimonthly: 'L',
+    quarterly: 'Q',
+    triannually: 'T',
+    semiannually: 'S',
+    annually: 'Y'
+  }.freeze
+
+  ACCOUNT_STATUS = {
+    account_transferred: '05',
+    current: '11',
+    closed: '13',
+    paid_in_full_voluntary_surrender: '61',
+    paid_in_full_collection_account: '62',
+    paid_in_full_repossession: '63',
+    paid_in_full_charge_off: '64',
+    paid_in_full_foreclosure: '65',
+    past_due_30_59: '71',
+    past_due_60_89: '78',
+    past_due_90_119: '80',
+    past_due_120_149: '82',
+    past_due_150_179: '83',
+    past_due_180_plus: '84',
+    govt_insurance_claim_filed: '88',
+    deed_received: '89',
+    collections: '93',
+    foreclosure_completed: '94',
+    voluntary_surrender: '95',
+    merch_repossessed: '96',
+    charge_off: '97',
+    delete_account: 'DA',
+    delete_account_fraud: 'DF'
+  }.freeze
+
+  PAYMENT_HISTORY_PROFILE = {
+    current: '0',
+    past_due_30_59: '1',
+    past_due_60_89: '2',
+    past_due_90_119: '3',
+    past_due_120_149: '4',
+    past_due_150_179: '5',
+    past_due_180_plus: '6',
+    no_history_prior: 'B',
+    no_history_available: 'D',
+    zero_balance: 'E',
+    collection: 'G',
+    foreclosure_completed: 'H',
+    voluntary_surrender: 'J',
+    repossession: 'K',
+    charge_off: 'L'
+  }.freeze
+
+  CONSUMER_TRANSACTION_TYPE = {
+    new_account_or_new_borrower: '1',
+    name_change: '2',
+    address_change: '3',
+    ssn_change: '5',
+    name_and_address_change: '6',
+    name_and_ssn_change: '8',
+    address_and_ssn_change: '9',
+    name_address_and_ssn_change: 'A'
+  }.freeze
+
+  ADDRESS_INDICATOR = {
+    confirmed: 'C',
+    known: 'Y',
+    not_confirmed: 'N',
+    military: 'M',
+    secondary: 'S',
+    business: 'B',
+    non_deliverable: 'U',
+    data_reporters_default: 'D',
+    bill_payer_service: 'P'
+  }.freeze
+
+  RESIDENCE_CODE = {
+    owns: 'O',
+    rents: 'R'
+  }.freeze
+
+  GENERATION_CODE = {
+    junior: 'J',
+    senior: 'S',
+    ii: '2',
+    iii: '3',
+    iv: '4',
+    v: '5',
+    vi: '6',
+    vii: '7',
+    viii: '8',
+    ix: '9'
+  }.freeze
+
+  CONSUMER_INFORMATION_INDICATOR = {
+    petition_ch7: 'A',
+    petition_ch11: 'B',
+    petition_ch12: 'C',
+    petition_ch13: 'D',
+    discharged_ch7: 'E',
+    discharged_ch11: 'F',
+    discharged_ch12: 'G',
+    discharged_ch13: 'H',
+    dismissed_ch7: 'I',
+    dismissed_ch11: 'J',
+    dismissed_ch12: 'K',
+    dismissed_ch13: 'L',
+    withdrawn_ch7: 'M',
+    withdrawn_ch11: 'N',
+    withdrawn_ch12: 'O',
+    withdrawn_ch13: 'P',
+  }
+
+  # K2 Segment constants
+  PURCHASED_FROM_SOLD_TO_INDICATOR = {
+    purchased_from: 1,
+    sold_to: 2,
+    remove_previous: 9
+  }.freeze
+
+  ALPHANUMERIC = /\A([[:alnum:]]|\s)+\z/
+  ALPHANUMERIC_PLUS_DASH = /\A([[:alnum:]]|\s|\-)+\z/
+  ALPHANUMERIC_PLUS_DOT_DASH_SLASH = /\A([[:alnum:]]|\s|\-|\.|\\|\/)+\z/
+  NUMERIC = /\A\d+\.?\d*\z/
+
+  FIXED_LENGTH = 426
+
+  def self.account_status_needs_payment_rating?(account_status)
+    account_status.in?([ACCOUNT_STATUS[:account_transferred], ACCOUNT_STATUS[:closed],
+                        ACCOUNT_STATUS[:paid_in_full_foreclosure], ACCOUNT_STATUS[:govt_insurance_claim_filed],
+                        ACCOUNT_STATUS[:deed_received], ACCOUNT_STATUS[:foreclosure_completed],
+                        ACCOUNT_STATUS[:voluntary_surrender]])
+  end
+
+  def self.alphanumeric_to_metro2(val, required_length, permitted_chars, name)
+    # Left justified and blank-filled
+    val = val.to_s
+
+    return ' ' * required_length  if val.empty?
+
+    unless !!(val =~ permitted_chars)
+      raise ArgumentError.new("Content (#{val}) contains invalid characters in field '#{name}'")
+    end
+
+    if val.size > required_length
+      val[0..(required_length-1)]
+    else
+      val + (' ' * (required_length - val.size))
+    end
+  end
+
+  def self.numeric_to_metro2(val, required_length,
+                             is_monetary: false, name: nil, possible_values: nil)
+    unless possible_values.nil? || possible_values.include?(val)
+      raise ArgumentError.new("field #{name} has unsupported value: #{val}")
+    end
+
+    # Right justified and zero-filled
+    val = val.to_s
+
+    return '0' * required_length if val.empty?
+
+    unless !!(val =~ Metro2::NUMERIC)
+      raise ArgumentError.new("field (#{val}) must be numeric")
+    end
+
+    decimal_index = val.index('.')
+    val = val[0..(decimal_index - 1)] if decimal_index
+
+    # any value above 1 billion gets set to 999,999,999
+    return '9' * required_length if is_monetary && val.to_f >= 1000000000
+    if val.size > required_length
+      raise ArgumentError.new("numeric field (#{val}) is too long (max #{required_length})")
+    end
+
+    ('0' * (required_length - val.size)) + val
+  end
+end
+
+require 'metro_2/fields'
+require 'metro_2/metro2_file'
+
+# Require records files
+require 'metro_2/records/record'
+
+Dir.new(File.dirname(__FILE__) + '/metro_2/records').each do |file|
+  require('metro_2/records/' + File.basename(file)) if File.extname(file) == ".rb"
+end

data/lib/metro_2/fields.rb

@@ -0,0 +1,123 @@
+module Metro2
+  module Fields
+    def alphanumeric_field(name, required_length, permitted_chars = Metro2::ALPHANUMERIC)
+      fields << name
+
+      # getter
+      define_method name do
+        instance_variable_get("@#{name}")
+      end
+
+      # setter (includes validations)
+      define_method "#{name}=" do | val |
+        instance_variable_set("@#{name}", val)
+      end
+
+      # to_metro2
+      define_method "#{name}_to_metro2" do
+        val = instance_variable_get("@#{name}")
+        Metro2.alphanumeric_to_metro2(val, required_length, permitted_chars, name)
+      end
+    end
+
+    def numeric_field(name, required_length, is_monetary: false, possible_values: nil)
+      fields << name
+
+      # getter
+      define_method name do
+        instance_variable_get("@#{name}")
+      end
+
+      # setter (includes validations)
+      define_method "#{name}=" do | val |
+        instance_variable_set("@#{name}", val)
+      end
+
+      # to_metro2
+      define_method "#{name}_to_metro2" do
+        val = instance_variable_get("@#{name}")
+        Metro2.numeric_to_metro2(val, required_length, is_monetary: is_monetary,
+                                 name: name, possible_values: possible_values)
+      end
+    end
+
+    def alphanumeric_const_field(name, required_length, val, permitted_chars = Metro2::ALPHANUMERIC)
+      fields << name
+
+      # getter
+      define_method name do
+        val
+      end
+
+      # to_metro2
+
+      define_method "#{name}_to_metro2" do
+        Metro2.alphanumeric_to_metro2(val, required_length, permitted_chars, name)
+      end
+    end
+
+    def numeric_const_field(name, required_length, val, is_monetary = false)
+      fields << name
+
+      # getter
+      define_method name do
+        val
+      end
+
+      # to_metro2
+      define_method "#{name}_to_metro2" do
+        Metro2.numeric_to_metro2(val, required_length, is_monetary: is_monetary)
+      end
+    end
+
+    def monetary_field(name)
+      numeric_field(name, 9, is_monetary: true)
+    end
+
+    def date_field(name)
+      fields << name
+
+      # getter
+      define_method name do
+        instance_variable_get("@#{name}")
+      end
+
+      # setter (includes validations)
+      define_method "#{name}=" do | val |
+        instance_variable_set("@#{name}", val)
+      end
+
+      # to_metro2
+      define_method "#{name}_to_metro2" do
+        # Right justified and zero-filled
+        val = instance_variable_get("@#{name}")
+        val = val&.strftime('%m%d%Y')
+
+        Metro2.numeric_to_metro2(val, 8)
+      end
+    end
+
+    def timestamp_field(name)
+      fields << name
+
+      # getter
+      define_method name do
+        instance_variable_get("@#{name}")
+      end
+
+      # setter (includes validations)
+      define_method "#{name}=" do | val |
+        instance_variable_set("@#{name}", val)
+      end
+
+      # to_metro2
+      define_method "#{name}_to_metro2" do
+        # Right justified and zero-filled
+        val = instance_variable_get("@#{name}")
+        val = val&.strftime('%m%d%Y%H%M%S')
+        Metro2.numeric_to_metro2(val, 14)
+      end
+    end
+  end
+
+end