paxmex 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 873f859a60a234be55dfd8e57e8d8ce52806465e
-  data.tar.gz: 14ad88336ee18973abbba8abc6b07a89b06ab349
+  metadata.gz: 328b6d41aeeeccde646c599fbc62a8e08b5250aa
+  data.tar.gz: f21beec92244d5731a3643b7dd07b0cc4e7b0c94
 SHA512:
-  metadata.gz: cc895ad6ce66301ce496350b4f495cc9b20bb2c5c8d02f9dc2c990f4246f3a7412bda3e9ff4ed7bf8ff01300c6717e484c12caf1b1380d358e61ceafec6384c0
-  data.tar.gz: 670b609085c611796b57de80e953426487c52e74746348f1c573e801ba88467aadafc9ae7239e7a9962492b17d603a58db2ae19964a384f1957f6f1e136af81e
+  metadata.gz: 6204b8480df620b96e07967dfe18b8c64c2d6f9b3822391ab64651f7f873af2e5f8dbc4c760b7b6d80c12b4f97e778a4eec6e7adfe3152930909d0c9cdaa2362
+  data.tar.gz: b5a7ba48f0ca141a4ee034a5ec1f97f3d62116f9f021f9468af15e7519d953f438ae6e608414d7ef025e5763aaa9d54e48b67a489a8335e2251b8aaa73f91bc1

data/README.md

@@ -16,9 +16,10 @@ This gem parses your Amex data files into human readable data.
 
 * parse_eptrn(file_path)
 * parse_epraw(file_path)
+* parse_cbnot(file_path)
 * parse_epa(file_path)
 
-The first two methods return a readable hash in the following format:
+The first three methods return a readable hash in the following format:
 
 ```ruby
 {
@@ -90,12 +91,13 @@ If you'd like the raw values to be returned instead, you can set the ```raw_valu
 ```ruby
 Paxmex.parse_eptrn(path_to_file, raw_values: true)
 Paxmex.parse_epraw(path_to_file, raw_values: true)
+Paxmex.parse_cbnot(path_to_file, raw_values: true)
 Paxmex.parse_epa(path_to_file, raw_values: true)
 ```
 
 ## User-defined schema
 
-If you need to parse a different format (i.e. not EPRAW, EPTRN or EPA), write your own schema definition and use it like this:
+If you need to parse a different format (i.e. not EPRAW, EPTRN, CBNOT, or EPA), write your own schema definition and use it like this:
 ```ruby
 parser = Parser.new(path_to_raw_file, path_to_schema_file)
 result = parser.parse
@@ -109,6 +111,7 @@ require 'paxmex'
 # Use default schema definitions
 Paxmex.parse_eptrn('/path/to/amex/eptrn/raw/file')
 Paxmex.parse_epraw('/path/to/amex/epraw/raw/file')
+Paxmex.parse_cbnot('/path/to/amex/cbnot/raw/file')
 Paxmex.parse_epa('/path/to/amex/epa/raw/file')
 
 # Use your own schema definition
@@ -116,7 +119,7 @@ parser = Parser.new('/path/to/raw/file', '/path/to/your/schema.yml')
 result = parser.parse
 ```
 
-The raw input files for either methods are data report files provided by American Express. These files are in either EPRAW, EPTRN or EPA format so use the relevant method to parse them. We have provided dummy EPRAW, EPTRN and EPA files in `spec/support`. Output and key-value pairs vary depending on whether you choose to parse an EPTRN, EPRAW or EPA file.
+The raw input files for either methods are data report files provided by American Express. These files are in either EPRAW, EPTRN, CBNOT, or EPA format so use the relevant method to parse them. We have provided dummy EPRAW, EPTRN, CBNOT, and EPA files in `spec/support`. Output and key-value pairs vary depending on whether you choose to parse an EPTRN, EPRAW, CBNOT, or EPA file.
 If you need to parse a file in another format, you can write your own YAML schema for this purpose. We would be happy if you help us improving this project by sharing your schemas.
 
 ## Contributing

data/lib/paxmex/schema/field.rb

@@ -1,59 +1,69 @@
 require 'bigdecimal'
 require 'paxmex/schema'
 
-class Paxmex::Schema::Field
-  DATE_PATTERN = /^date\((.+)\)$/
-  TIME_PATTERN = /^time\((.+)\)$/
+module Paxmex
+  class Schema
+    class Field
+      DATE_PATTERN = /^date\((.+)\)$/
+      TIME_PATTERN = /^time\((.+)\)$/
 
-  attr_reader :name, :start, :final, :type
+      attr_reader :name, :start, :final, :type
 
-  def initialize(opts = {})
-    @name  = opts[:name]
-    @start = opts[:start]
-    @final = opts[:final]
-    @type  = opts[:type] || 'string'
-  end
+      def initialize(opts = {})
+        @name  = opts[:name]
+        @start = opts[:start]
+        @final = opts[:final]
+        @type  = opts[:type] || 'string'
+      end
 
-  def parse(raw_value)
-    case type
-    when 'string' then raw_value.rstrip
-    when 'julian' then parse_julian_date(raw_value) rescue nil
-    when 'date' then Date.strptime(raw_value, '%m%d%Y') rescue nil
-    when 'numeric' then raw_value.strip.to_i
-    when 'decimal' then parse_decimal(raw_value)
-    when DATE_PATTERN then parse_date_pattern(raw_value) rescue nil
-    when TIME_PATTERN then parse_time_pattern(raw_value) rescue nil
-    else fail "Could not parse field type #{type}. Supported types: string, julian, date, numeric, decimal, date(format), time(format)"
-    end
-  end
+      def parse(raw_value)
+        case type
+        when 'string' then raw_value.rstrip
+        when 'julian' then parse_julian_date(raw_value) rescue nil
+        when 'date' then Date.strptime(raw_value, '%m%d%Y') rescue nil
+        when 'numeric' then parse_numeric(raw_value)
+        when 'decimal' then parse_decimal(raw_value)
+        when DATE_PATTERN then parse_date_pattern(raw_value) rescue nil
+        when TIME_PATTERN then parse_time_pattern(raw_value) rescue nil
+        else fail "Could not parse field type #{type}. Supported types: string, julian, date, numeric, decimal, date(format), time(format)"
+        end
+      end
 
-  private
+      private
 
-  def parse_date_pattern(value)
-    Date.strptime(value, DATE_PATTERN.match(type).captures.first)
-  end
+      def parse_date_pattern(value)
+        Date.strptime(value, DATE_PATTERN.match(type).captures.first)
+      end
 
-  def parse_time_pattern(value)
-    Time.strptime(value, TIME_PATTERN.match(type).captures.first)
-  end
+      def parse_time_pattern(value)
+        Time.strptime(value, TIME_PATTERN.match(type).captures.first)
+      end
 
-  def parse_decimal(value)
-    # fields _may_ end with a letter
-    unless value.match(/^[0-9]*[0-9A-R{}]$/)
-      fail "Unexpected value '#{value}' for field '#{name}'"
-    end
+      def parse_numeric(value)
+        value.strip!
+        return value.to_f if value.include?('.')
+        value.to_i
+      end
 
-    is_credit = !!(value =~ /[JKLMNOPQR}]/)
-    value = value.gsub(/[ABCDEFGHIJKLMNOPQR{}]/,
-      'A'=>1, 'B'=>2, 'C'=>3, 'D'=>4, 'E'=>5, 'F'=>6, 'G'=>7, 'H'=>8, 'I'=>9,
-      'J'=>1, 'K'=>2, 'L'=>3, 'M'=>4, 'N'=>5, 'O'=>6, 'P'=>7, 'Q'=>8, 'R'=>9,
-      '{'=>0, '}'=>0)
+      def parse_decimal(value)
+        # fields _may_ end with a letter
+        unless value.match(/^[0-9]*[0-9A-R{}]$/)
+          fail "Unexpected value '#{value}' for field '#{name}'"
+        end
 
-    parsed_value = value.to_i * (is_credit ? -1 : 1) / 100.0
-    BigDecimal.new(parsed_value.to_s, 7)
-  end
+        is_credit = !!(value =~ /[JKLMNOPQR}]/)
+        value = value.gsub(/[ABCDEFGHIJKLMNOPQR{}]/,
+          'A'=>1, 'B'=>2, 'C'=>3, 'D'=>4, 'E'=>5, 'F'=>6, 'G'=>7, 'H'=>8, 'I'=>9,
+          'J'=>1, 'K'=>2, 'L'=>3, 'M'=>4, 'N'=>5, 'O'=>6, 'P'=>7, 'Q'=>8, 'R'=>9,
+          '{'=>0, '}'=>0)
 
-  def parse_julian_date(date_string)
-    Date.ordinal(date_string[0..3].to_i, date_string[4..6].to_i)
+        parsed_value = value.to_i * (is_credit ? -1 : 1) / 100.0
+        BigDecimal.new(parsed_value.to_s, 7)
+      end
+
+      def parse_julian_date(date_string)
+        Date.ordinal(date_string[0..3].to_i, date_string[4..6].to_i)
+      end
+    end
   end
 end

data/lib/paxmex/schema/section.rb

@@ -1,64 +1,68 @@
 require 'paxmex/schema/field'
 
-class Paxmex::Schema::Section
-  BLOCK_LENGTH = 450
+module Paxmex
+  class Schema
+    class Section
+      BLOCK_LENGTH = 450
 
-  attr_reader :key, :data, :parent_key
+      attr_reader :key, :data, :parent_key
 
-  def initialize(key, data)
-    @parent_key = data.delete('PARENT') { nil }
-    @key = key
-    @data = data
-  end
+      def initialize(key, data)
+        @parent_key = data.delete('PARENT') { nil }
+        @key = key
+        @data = data
+      end
 
-  def recurring?
-    !!data['RECURRING']
-  end
+      def recurring?
+        !!data['RECURRING']
+      end
 
-  def abstract?
-    !!data['ABSTRACT']
-  end
+      def abstract?
+        !!data['ABSTRACT']
+      end
 
-  def trailer?
-    !!data['TRAILER']
-  end
+      def trailer?
+        !!data['TRAILER']
+      end
 
-  def child?
-    !!@parent_key
-  end
+      def child?
+        !!@parent_key
+      end
 
-  def fields
-    @fields ||= data['FIELDS'].map do |field|
-      Paxmex::Schema::Field.new(
-        name: field['NAME'],
-        start: field['RANGE'].first,
-        final: field['RANGE'].last,
-        type: field['TYPE']
-      )
-    end
-  end
+      def fields
+        @fields ||= data['FIELDS'].map do |field|
+          Paxmex::Schema::Field.new(
+            name: field['NAME'],
+            start: field['RANGE'].first,
+            final: field['RANGE'].last,
+            type: field['TYPE']
+          )
+        end
+      end
 
-  def types
-    data['TYPES']
-  end
+      def types
+        data['TYPES']
+      end
 
-  def type_field
-    data['TYPE_FIELD']
-  end
+      def type_field
+        data['TYPE_FIELD']
+      end
 
-  def type_mapping
-    data['TYPE_MAPPING']
-  end
+      def type_mapping
+        data['TYPE_MAPPING']
+      end
 
-  def section_for_type(type)
-    sections_for_types.detect { |t| t.key == type_mapping[type] }
-  end
+      def section_for_type(type)
+        sections_for_types.detect { |t| t.key == type_mapping[type] }
+      end
 
-  def length
-    BLOCK_LENGTH
-  end
+      def length
+        BLOCK_LENGTH
+      end
 
-  def sections_for_types
-    @sections_for_types ||= types.map { |k, v| self.class.new(k, v) }
+      def sections_for_types
+        @sections_for_types ||= types.map { |k, v| self.class.new(k, v) }
+      end
+    end
   end
 end

data/lib/paxmex/schema.rb

@@ -1,46 +1,48 @@
-class Paxmex::Schema
-  require 'paxmex/schema/section'
+require 'paxmex/schema/section'
 
-  def initialize(schema_hash)
-    @schema_hash = schema_hash
-    @parents = []
-  end
+module Paxmex
+  class Schema
+    def initialize(schema_hash)
+      @schema_hash = schema_hash
+      @parents = []
+    end
 
-  def sections
-    @sections ||= @schema_hash.map { |k, v| build_section(k,v) }
-  end
+    def sections
+      @sections ||= @schema_hash.map { |k, v| build_section(k,v) }
+    end
 
-  def to_h
-    @schema_hash
-  end
+    def to_h
+      @schema_hash
+    end
 
-  def parent_section?(key)
-    sections.any? do |s|
-      if s.abstract?
-        s.sections_for_types.any? { |ss| ss.parent_key == key }
-      else
-        s.parent_key == key
+    def parent_section?(key)
+      sections.any? do |s|
+        if s.abstract?
+          s.sections_for_types.any? { |ss| ss.parent_key == key }
+        else
+          s.parent_key == key
+        end
       end
     end
-  end
 
-  private
+    private
 
-  def build_section(key, data)
-    section = Section.new(key, data)
-    mark_abstract if section.abstract?
-    add_parent(section) if section.child?
+    def build_section(key, data)
+      section = Section.new(key, data)
+      mark_abstract if section.abstract?
+      add_parent(section) if section.child?
 
-    section
-  end
+      section
+    end
 
-  def mark_abstract
-    fail 'Cannot have more than one abstract section' if @have_abstract
-    @have_abstract = true
-  end
+    def mark_abstract
+      fail 'Cannot have more than one abstract section' if @have_abstract
+      @have_abstract = true
+    end
 
-  def add_parent(section)
-    fail 'Recursive parent definition' if @parents.include?(section.key)
-    @parents << parent
+    def add_parent(section)
+      fail 'Recursive parent definition' if @parents.include?(section.key)
+      @parents << parent
+    end
   end
 end

data/lib/paxmex/version.rb

@@ -1,3 +1,3 @@
 module Paxmex
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paxmex
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Daryl Yeo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec