paxmex 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 328b6d41aeeeccde646c599fbc62a8e08b5250aa
-  data.tar.gz: f21beec92244d5731a3643b7dd07b0cc4e7b0c94
+  metadata.gz: a0a3cb72e76f7427fc11156441726d55d55182c6
+  data.tar.gz: 6c3f61b3a649318e2edc031c8ce16d183a9759b8
 SHA512:
-  metadata.gz: 6204b8480df620b96e07967dfe18b8c64c2d6f9b3822391ab64651f7f873af2e5f8dbc4c760b7b6d80c12b4f97e778a4eec6e7adfe3152930909d0c9cdaa2362
-  data.tar.gz: b5a7ba48f0ca141a4ee034a5ec1f97f3d62116f9f021f9468af15e7519d953f438ae6e608414d7ef025e5763aaa9d54e48b67a489a8335e2251b8aaa73f91bc1
+  metadata.gz: 4564018ecb0cb35450d0c17febaf730abf7eddce536aed508cb2e97e7b6c521e910a17b8c58cea4ab86229bcf831de73f9bc152ab52f9e699a7e75fe13fc529c
+  data.tar.gz: 15f6d8493280e49c7cba57d36da4eab84c862a9060561323240c2a106e54f550f1981b3d6364580392c3c05c64c6a864a1a035bee1668ea0f8ad3268355bebc2

data/README.md

@@ -12,14 +12,23 @@ This gem parses your Amex data files into human readable data.
 % gem install paxmex
 ```
 
-## Available Methods
+## Available Formats
 
-* parse_eptrn(file_path)
-* parse_epraw(file_path)
-* parse_cbnot(file_path)
-* parse_epa(file_path)
+* eptrn
+* epraw
+* cbnot
+* epa
 
-The first three methods return a readable hash in the following format:
+## Usage
+
+Each report format has a corresponding method on the `Paxmex` module. Call `parse` or `load_file` on the return value to either parse data in memory or from a file:
+
+```ruby
+Paxmex.eptrn.parse("...")
+Paxmex.eptrn.load_file('/path/to/file.cbnot')
+```
+
+The first three report formats (i.e. eptrn, epraw, and cbnot) return a hash in the following format:
 
 ```ruby
 {
@@ -43,7 +52,7 @@ The first three methods return a readable hash in the following format:
 }
 ```
 
-The last method (parse_epa) returns nearly the same, but it contains nested records (according to the schema definition):
+The last format (epa) returns nearly the same thing, but contains nested records as indicated by the epa schema definition:
 
 ```ruby
 {
@@ -89,15 +98,16 @@ Values are parsed from their representation into a corresponding native Ruby typ
 If you'd like the raw values to be returned instead, you can set the ```raw_values``` option to true, e.g.:
 
 ```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)
+Paxmex.eptrn.parse(path_to_file, raw_values: true)
+Paxmex.epraw.parse(path_to_file, raw_values: true)
+Paxmex.cbnot.parse(path_to_file, raw_values: true)
+Paxmex.epa.parse(path_to_file, raw_values: true)
 ```
 
 ## User-defined schema
 
 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,10 +119,10 @@ result = parser.parse
 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')
+Paxmex.eptrn.parse('/path/to/amex/eptrn/raw/file')
+Paxmex.epraw.parse('/path/to/amex/epraw/raw/file')
+Paxmex.cbnot.parse('/path/to/amex/cbnot/raw/file')
+Paxmex.epa.parse('/path/to/amex/epa/raw/file')
 
 # Use your own schema definition
 parser = Parser.new('/path/to/raw/file', '/path/to/your/schema.yml')
@@ -120,6 +130,7 @@ 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, 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.rb

@@ -1,27 +1,37 @@
 require 'paxmex/parser'
 
 module Paxmex
-  class << self
-    def parse_cbnot(*args)
-      parse('cbnot', *args)
+  class SchemaProxy
+    attr_reader :schema_name
+
+    def initialize(schema_name)
+      @schema_name = schema_name
     end
 
-    def parse_epa(*args)
-      parse('epa', *args)
+    def parse(data, opts = {})
+      Parser.new(data, schema_name).parse(opts)
     end
 
-    def parse_epraw(*args)
-      parse('epraw', *args)
+    def load_file(file, opts = {})
+      parse(File.read(file), opts)
     end
+  end
 
-    def parse_eptrn(*args)
-      parse('eptrn', *args)
+  class << self
+    def cbnot
+      @cbnot ||= SchemaProxy.new('cbnot')
     end
 
-    private
+    def epa
+      @epa ||= SchemaProxy.new('epa')
+    end
+
+    def epraw
+      @epraw ||= SchemaProxy.new('epraw')
+    end
 
-    def parse(schema, *args)
-      Parser.new(args.shift, schema).parse(*args)
+    def eptrn
+      @eptrn ||= SchemaProxy.new('eptrn')
     end
   end
 end

data/lib/paxmex/parser.rb

@@ -10,8 +10,8 @@ class Paxmex::Parser
 
   attr_reader :schema, :path
 
-  def initialize(path, schema)
-    @path = path
+  def initialize(data, schema)
+    @data = data.chomp
     @parent_chain = []
 
     if File.file?(schema)
@@ -22,13 +22,13 @@ class Paxmex::Parser
   end
 
   def raw
-    @raw ||= File.read(@path).chomp
+    @data
   end
 
   def parse(opts = {})
     return @parsed if @parsed
 
-    content = raw.split("\n")
+    content = @data.split("\n")
 
     # Parse the trailing section first so that we don't need
     # to consider it when parsing recurring sections

data/lib/paxmex/schema/field.rb

@@ -1,3 +1,5 @@
+require 'date'
+require 'time'
 require 'bigdecimal'
 require 'paxmex/schema'
 

data/lib/paxmex/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paxmex
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Daryl Yeo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: This gem parses your Amex data files into human readable data.