metro_2 1.1.9 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee3f1bb08891e146f840b4f3130faf3805955f37
-  data.tar.gz: bd5a7faf570a7339197fff276a2f41213eb4db11
+  metadata.gz: b830f8ea9769cd85e6f39fd7d66abe9cf4ac2e2a
+  data.tar.gz: 8fd323371e39e8c440c5010d8e4f572d0437fe90
 SHA512:
-  metadata.gz: c6abd4fb0f9c2b91706719c17154ce4ca6daeb580e58078c7601cea8676a080be0d3a262694d99f889700c87712c9a8c8d09747b8a77e711d052e7b8ed808623
-  data.tar.gz: bbc229d9ea1f97da199e5490be38908da9c6bcebe46e964989c6a3067e56413e5cfda1c52cb3193f1e3ce7972f04d65e2919cd9307d1c683d21a76a610a23717
+  metadata.gz: f5234f2a94acf7dc6813e565520524003b07193e374121161b8bbc96603343f9ce84ac7406b11348c22276707bd40af95a7b32192fd4effd2d3e51357b685224
+  data.tar.gz: 3113a1b0fa68d26241158748fe3ccbe5a40dbe7f30e2e0d976b8d514f093c235f437a9fd48e78315f13de9b1fbe2ee10cda0b6c2c82ca885b9ca084422b3c398

data/lib/metro_2.rb

@@ -24,7 +24,7 @@ module Metro2
 
   SPECIAL_COMMENT_CODE = {
     partial_payment_agreement: 'AC',
-    purchased_by_other_company: 'AH',
+    purchased_by_another_company: 'AH',
     paid_in_full_less_than_full_balance: 'AU',
     affected_by_natural_or_declared_disaster: 'AW',
     loan_modified: 'CO',
@@ -162,6 +162,13 @@ module Metro2
     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/
@@ -193,7 +200,12 @@ module Metro2
     end
   end
 
-  def self.numeric_to_metro2(val, required_length, is_monetary)
+  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
 

data/lib/metro_2/fields.rb

@@ -1,6 +1,5 @@
 module Metro2
   module Fields
-
     def alphanumeric_field(name, required_length, permitted_chars = Metro2::ALPHANUMERIC)
       fields << name
 
@@ -21,7 +20,7 @@ module Metro2
       end
     end
 
-    def numeric_field(name, required_length, is_monetary = false)
+    def numeric_field(name, required_length, is_monetary: false, possible_values: nil)
       fields << name
 
       # getter
@@ -37,7 +36,8 @@ module Metro2
       # to_metro2
       define_method "#{name}_to_metro2" do
         val = instance_variable_get("@#{name}")
-        Metro2.numeric_to_metro2(val, required_length, is_monetary)
+        Metro2.numeric_to_metro2(val, required_length, is_monetary: is_monetary,
+                                 name: name, possible_values: possible_values)
       end
     end
 
@@ -66,12 +66,12 @@ module Metro2
 
       # to_metro2
       define_method "#{name}_to_metro2" do
-        Metro2.numeric_to_metro2(val, required_length, is_monetary)
+        Metro2.numeric_to_metro2(val, required_length, is_monetary: is_monetary)
       end
     end
 
     def monetary_field(name)
-      numeric_field(name, 9, true)
+      numeric_field(name, 9, is_monetary: true)
     end
 
     def date_field(name)
@@ -93,7 +93,7 @@ module Metro2
         val = instance_variable_get("@#{name}")
         val = val&.strftime('%m%d%Y')
 
-        Metro2.numeric_to_metro2(val, 8, false)
+        Metro2.numeric_to_metro2(val, 8)
       end
     end
 
@@ -115,7 +115,7 @@ module Metro2
         # 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, false)
+        Metro2.numeric_to_metro2(val, 14)
       end
     end
   end

data/lib/metro_2/metro2_file.rb

@@ -29,6 +29,7 @@ module Metro2
       num_dob = 0
       num_telephone = 0
       num_ecoa_code_z = 0
+      total_k2_segments = 0
 
       @base_segments.each do |base|
         status_code_count[base.account_status.upcase] += 1
@@ -36,6 +37,7 @@ module Metro2
         num_dob += 1 if base.date_of_birth
         num_telephone += 1 if base.telephone_number
         num_ecoa_code_z += 1 if base.ecoa_code == 'Z'
+        total_k2_segments += 1 if base.k2_segment
       end
 
       trailer = Records::TrailerSegment.new
@@ -69,6 +71,7 @@ module Metro2
       trailer.total_date_of_births = num_dob
       trailer.total_date_of_births_in_base = num_dob
       trailer.total_telephome_numbers = num_telephone
+      trailer.total_k2_segments = total_k2_segments
       trailer
     end
 

data/lib/metro_2/records/base_segment.rb

@@ -1,8 +1,10 @@
 module Metro2::Records
   class BaseSegment < Record
+    LENGTH = Metro2::FIXED_LENGTH
+
     @fields = []
 
-    numeric_const_field :record_descriptor_word, 4, Metro2::FIXED_LENGTH
+    numeric_field :record_descriptor_word, 4
     alphanumeric_const_field :processing_indicator, 1, 1 # always 1
     timestamp_field :time_stamp
     numeric_field :correction_indicator, 1
@@ -50,5 +52,28 @@ module Metro2::Records
     alphanumeric_field :postal_code, 9
     alphanumeric_field :address_indicator, 1
     alphanumeric_field :residence_code, 1
+
+    def initialize
+      @appendages = []
+    end
+
+    def k2_segment
+      @k2_segment
+    end
+
+    def k2_segment=(segment)
+      @k2_segment = segment
+      @appendages << @k2_segment
+    end
+
+    def to_metro2
+      @appendages.compact!
+      set_record_descriptor_word
+      super + @appendages.map(&:to_metro2).join
+    end
+
+    def set_record_descriptor_word
+      self.record_descriptor_word = LENGTH + @appendages.sum { |appendage| appendage.class::LENGTH }
+    end
   end
 end

data/lib/metro_2/records/k2_segment.rb

@@ -0,0 +1,21 @@
+module Metro2::Records
+  class K2Segment < Record
+    LENGTH = 34
+
+    @fields = []
+
+    alphanumeric_const_field :segment_identifier, 2, "K2"
+    numeric_field :purchased_from_sold_to_indicator, 1,
+                  possible_values: Metro2::PURCHASED_FROM_SOLD_TO_INDICATOR.values
+    alphanumeric_field :purchased_from_sold_to_name, 30, Metro2::ALPHANUMERIC_PLUS_DOT_DASH_SLASH
+    alphanumeric_const_field :reserved, 1, nil # reserved - blank fill
+
+    def validate_fields
+      if !purchased_from_sold_to_name.nil? &&
+          purchased_from_sold_to_indicator == Metro2::PURCHASED_FROM_SOLD_TO_INDICATOR[:remove_previous]
+        str = "purchased_from_sold_to_name must be blank if purchased_from_sold_to_indicator is 9"
+        raise ArgumentError.new(str)
+      end
+    end
+  end
+end

data/lib/metro_2/records/record.rb

@@ -12,8 +12,13 @@ module Metro2
       extend(Fields)
 
       def to_metro2
+        validate_fields
         self.class.fields.collect { |f| send("#{f}_to_metro2") }.join
       end
+
+      def validate_fields
+        # this should be implemented by each child
+      end
     end
   end
 end

data/lib/metro_2/version.rb

@@ -1,5 +1,5 @@
 module Metro2
-  VERSION = "1.1.9"
+  VERSION = "1.2.1"
 
   def self.version_string
     str = VERSION.split('.')

data/spec/records/base_segment_spec.rb

@@ -35,11 +35,14 @@ describe Metro2::Records::BaseSegment do
     @base.postal_code = '54321'
     @base.address_indicator = 'N'
     @base.residence_code = 'O'
+    @base.k2_segment = k2_segment
   end
 
+  let(:k2_segment) { nil }
+
   context '#to_metro2' do
-    it 'should generate base segment string' do
-      exp = [
+    let(:expected) do
+      [
         '0426',
         '1',
         '09152014170745',
@@ -90,10 +93,28 @@ describe Metro2::Records::BaseSegment do
         'O',
         ''
       ]
+    end
+
+    it 'should generate base segment string' do
       base_str = @base.to_metro2
-      expect(base_str).to eql(exp.join(''))
+      expect(base_str).to eql(expected.join(''))
       expect(base_str.size).to eql(Metro2::FIXED_LENGTH)
     end
+
+    context 'with a K2 segment' do
+      let(:k2_segment) do
+        k2 = Metro2::Records::K2Segment.new
+        k2.purchased_from_sold_to_indicator = 9
+        k2
+      end
+
+      it 'should output the k2 segment in its string and update set_record_descriptor_word' do
+        base_str = @base.to_metro2
+        expected_length = Metro2::Records::BaseSegment::LENGTH + Metro2::Records::K2Segment::LENGTH
+        expect(base_str.size).to eql(expected_length)
+        expect(base_str[0..3].to_i).to eql(expected_length)
+      end
+    end
   end
 
   context 'alphanumerics' do

data/spec/records/header_segment_spec.rb

@@ -32,7 +32,7 @@ describe Metro2::Records::HeaderSegment do
         '123 Report Dr Address CA 91111'.ljust(96, ' '),
         '5555555555',
         'Upstart Engineer metro 2 gem'.ljust(40, ' '),
-        '01109',
+        '01201',
         ' ' * 156
       ]
       header_str = @header.to_metro2

data/spec/records/k2_segment_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Metro2::Records::BaseSegment do
+  before do
+    @k2_segment = Metro2::Records::K2Segment.new
+    @k2_segment.purchased_from_sold_to_indicator = indicator
+    @k2_segment.purchased_from_sold_to_name = company_name
+  end
+
+  context "#to_metro2" do
+    let(:expected) { ["K2", indicator.to_s, company_name.to_s.ljust(30, " "), " "] }
+
+    context "with valid attributes set" do
+      let(:indicator) { 1 }
+      let(:company_name) { "Loan Buying Company" }
+
+      it "should create output string that matches expected" do
+        k2_segment_str = @k2_segment.to_metro2
+        expect(k2_segment_str).to eql(expected.join)
+        expect(k2_segment_str.size).to eql(Metro2::Records::K2Segment::LENGTH)
+      end
+    end
+
+    context "with a 9 indicator" do
+      let(:indicator) { 9 }
+
+      context "with a blank purchased_from_sold_to_name" do
+        let(:company_name) { nil }
+
+        it "should create output string that matches expected" do
+          k2_segment_str = @k2_segment.to_metro2
+          expect(k2_segment_str).to eql(expected.join)
+          expect(k2_segment_str.size).to eql(Metro2::Records::K2Segment::LENGTH)
+        end
+      end
+
+      context "with purchased_from_sold_to_name that is not blank" do
+        let(:company_name) { "Loan Buying Company" }
+
+        it "should raise an error that the field should be blank" do
+          expect { @k2_segment.to_metro2 }.
+              to raise_error(/purchased_from_sold_to_name must be blank/)
+        end
+      end
+    end
+
+    context "with a non-supported indicator" do
+      let(:indicator) { 7 }
+      let(:company_name) { "Loan Buying Company" }
+
+      it "should raise an error that the value is unsupported" do
+        expect { @k2_segment.to_metro2 }.
+            to raise_error(/field purchased_from_sold_to_indicator has unsupported value/)
+      end
+    end
+  end
+end

data/spec/records/trailer_segment_spec.rb

@@ -10,6 +10,7 @@ describe Metro2::Records::TrailerSegment do
     @trailer.total_date_of_births = 1
     @trailer.total_date_of_births_in_base = 1
     @trailer.total_telephome_numbers = 1
+    @trailer.total_k2_segments = 1
   end
 
   describe '#to_metro2' do
@@ -48,7 +49,7 @@ describe Metro2::Records::TrailerSegment do
         '0' * 9,
         '0' * 9,
         '0' * 9,
-        '0' * 9,
+        '000000001',
         '0' * 9,
         '0' * 9,
         '0' * 9,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metro_2
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.2.1
 platform: ruby
 authors:
 - Brian Mascarenhas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2018-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,21 +70,14 @@ files:
 - lib/metro_2/metro2_file.rb
 - lib/metro_2/records/base_segment.rb
 - lib/metro_2/records/header_segment.rb
+- lib/metro_2/records/k2_segment.rb
 - lib/metro_2/records/record.rb
 - lib/metro_2/records/trailer_segment.rb
 - lib/metro_2/version.rb
-- metro_2-1.1.0.gem
-- metro_2-1.1.1.gem
-- metro_2-1.1.2.gem
-- metro_2-1.1.3.gem
-- metro_2-1.1.4.gem
-- metro_2-1.1.5.gem
-- metro_2-1.1.6.gem
-- metro_2-1.1.7.gem
-- metro_2-1.1.8.gem
 - metro_2.gemspec
 - spec/records/base_segment_spec.rb
 - spec/records/header_segment_spec.rb
+- spec/records/k2_segment_spec.rb
 - spec/records/trailer_segment_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -114,5 +107,6 @@ summary: Create Metro 2 format files for credit reporting
 test_files:
 - spec/records/base_segment_spec.rb
 - spec/records/header_segment_spec.rb
+- spec/records/k2_segment_spec.rb
 - spec/records/trailer_segment_spec.rb
 - spec/spec_helper.rb