iif-parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38f0a22c455842fb1858f54b8a8750b99a87d8ac
+  data.tar.gz: c9c58832991120633400117415cd5267dfc7be1e
+SHA512:
+  metadata.gz: e4beff15de0cd29df7f38370ce05a026094011e40eef11f753968e6f68d1c73bd1adea785f7c90371a59776f7aadb448c686218f603267b3761053e4f7f8cd64
+  data.tar.gz: dd8b5a3194ccf1a43c4858ab86d9a779962a6bbb93568cc20f5c80779772ca22aaaf78b524db8e4e3358d5aad4369ace0c2de2a0441acc268d9e3e8149012883

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christian
+
+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,68 @@
+# Iif::Parser
+
+The Iif::Parser gem will take Intuit QuickBooks files that are in IIF format and parse out the transactions (`!TRNS` and `!ENDTRNS` blocks) sections into plain Ruby objects.
+#### For example, take this IIF formatted file ..
+```
+!TRNS	TRNSID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO
+!SPL	SPLID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO
+!ENDTRNS							TEXT		TEXT
+TRNS		GENERAL JOURNAL	10/24/14	Prepaid Exp		Midwest:Kansas:Wichita	1000.75		Bank Drafts - 10/24/14 - Midwest:Kansas:Wichita
+SPL		GENERAL JOURNAL	10/24/14	ABC Bank		Midwest:Kansas:Wichita	-1000.75		Bank Drafts - 10/24/14 - Midwest:Kansas:Wichita
+ENDTRNS							END		TEXT
+```
+#### .. and then pump it into a new instance of Iif::Parser
+```ruby
+i = Iif::Parser.new(iif)
+p i.transactions.size
+# => 1
+p i.transactions.first.entries.size
+# => 2
+```
+#### .. and it will be converted into nice Ruby objects!
+```ruby
+puts i.transactions.first.entries
+#<Iif::Entry type="TRNS", 
+  trnsid="", 
+  trnstype="GENERAL JOURNAL", 
+  date=#<Date: 2014-10-24 ((2456955j,0s,0n),+0s,2299161j)>, 
+  accnt="Prepaid Exp", 
+  name="", 
+  class="Midwest:Kansas:Wichita", 
+  amount=#<BigDecimal:7fccd1043b20,'0.100075E4',18(18)>, 
+  docnum="", 
+  memo="Bank Drafts - 10/24/14 - Midwest:Kansas:Wichita">
+#<Iif::Entry type="SPL", 
+  splid="", 
+  trnstype="GENERAL JOURNAL", 
+  date=#<Date: 2014-10-24 ((2456955j,0s,0n),+0s,2299161j)>, 
+  accnt="ABC Bank", 
+  name="", 
+  class="Midwest:Kansas:Wichita", 
+  amount=#<BigDecimal:7fccd0a09a48,'-0.100075E4',18(18)>, 
+  docnum="", 
+  memo="Bank Drafts - 10/24/14 - Midwest:Kansas:Wichita">
+```
+#### See the [specs](https://github.com/minimul/iif-parser/blob/master/spec/iif/parser_spec.rb) for more examples
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iif-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iif-parser
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/iif-parser/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iif/parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/iif-parser.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iif/parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iif-parser"
+  spec.version       = Iif::Parser::VERSION
+  spec.authors       = ["Christian Pelczarski"]
+  spec.email         = ["christian@minimul.com"]
+
+  spec.summary       = %q{Basic IIF parser written in Ruby}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/minimul/iif-parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/iif/parser/entry.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+
+module Iif
+  class Entry < OpenStruct
+  end
+end

data/lib/iif/parser/transaction.rb

@@ -0,0 +1,10 @@
+
+module Iif
+  class Transaction
+    attr_accessor :entries
+    
+    def initialize
+      self.entries = []
+    end
+  end
+end

data/lib/iif/parser/version.rb

@@ -0,0 +1,5 @@
+module Iif
+  class Parser
+    VERSION = "1.0.0"
+  end
+end

data/lib/iif/parser.rb

@@ -0,0 +1,106 @@
+require 'bigdecimal'
+require 'csv'
+require_relative 'parser/version'
+require_relative 'parser/transaction'
+require_relative 'parser/entry'
+
+module Iif
+  class Parser
+    attr_accessor :definitions
+    attr_accessor :entries
+    attr_accessor :transactions
+
+    def initialize(resource)
+      @definitions = {}
+      @entries = []
+      @transactions = []
+
+      resource = open_resource(resource)
+      resource.rewind
+      parse_file(resource)
+      create_transactions
+    end
+
+    def open_resource(resource)
+      if resource.respond_to?(:read)
+        resource
+      else
+        open(resource)
+      end
+    rescue Exception
+      StringIO.new(resource)
+    end
+
+    def parse_line(line)
+      if (ar = line.strip.split(/\t/)).size == 1
+        ar = CSV.parse_line(line.strip)
+      end
+      ar
+    end
+
+    def parse_file(resource)
+      resource.each_line do |line|
+        fields = parse_line(line)
+        if fields[0][0] == '!'
+          parse_definition(fields)
+        else
+          parse_data(fields)
+        end
+      end
+    end
+    
+    def parse_definition(fields)
+      key = fields[0][1..-1]
+      values = fields[1..-1]
+      @definitions[key] = values.map { |v| v.downcase }
+    end
+
+    def parse_data(fields)
+      definition = @definitions[fields[0]]
+
+      entry = Entry.new
+      entry.type = fields[0]
+      
+      fields[1..-1].each_with_index do |field, idx|
+        entry.send(definition[idx] + "=", field)
+      end
+
+      entry.amount = BigDecimal.new(entry.amount) if entry.amount
+      entry.date = convert_date(entry.date) if entry.date
+
+      @entries.push(entry)
+    end
+
+    def convert_date(date)
+      ar = date.split(/[-\/]/).map(&:to_i)
+      year = ar[2].to_s.size == 4 ? ar[2] : "20#{ar[2]}"
+      Date.new(year.to_i, ar[0], ar[1])
+    end
+
+    def create_transactions
+      transaction = nil
+      in_transaction = false
+
+      @entries.each do |entry|
+        
+        case entry.type
+
+        when "TRNS"
+          if in_transaction
+            @transactions.push(transaction)
+            in_transaction = false
+          end
+          transaction = Transaction.new
+          in_transaction = true
+          
+        when "ENDTRNS"
+          @transactions.push(transaction)
+          in_transaction = false
+
+        end
+
+        transaction.entries.push(entry) if in_transaction
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: iif-parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Pelczarski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- christian@minimul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iif-parser.gemspec
+- lib/iif/parser.rb
+- lib/iif/parser/entry.rb
+- lib/iif/parser/transaction.rb
+- lib/iif/parser/version.rb
+homepage: https://github.com/minimul/iif-parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Basic IIF parser written in Ruby
+test_files: []