simple_iif 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 The Pragmatic Bookshelf
+
+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,20 @@
+# SimpleIif
+
+A trivial library to assist in handling QuickBooks iif files.
+
+I know: iif is a deprecated format. But it's all I have to play with on QuickBooks for Mac.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_iif'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_iif
+

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/lib/simple_iif/row_sequence.rb

@@ -0,0 +1,24 @@
+module SimpleIif
+  class RowSequence
+
+    def initialize
+      @rows = []
+    end
+
+    def add(row_type, *row_params, &block)
+      new_row = Rows.for(row_type, *row_params)
+      @rows << new_row
+    end
+
+    def to_iif
+      result = []
+      @rows.each do |row|
+        result << row.headers.join("\t")
+      end
+      @rows.each do |row|
+        result << row.values.join("\t")
+      end
+      result
+    end
+  end
+end

data/lib/simple_iif/rows/endtrans.rb

@@ -0,0 +1,6 @@
+module SimpleIif
+  class Rows::Endtrans < Rows
+    register("ENDTRNS")
+    @all_fields = []
+  end
+end

data/lib/simple_iif/rows/spl.rb

@@ -0,0 +1,39 @@
+module SimpleIif
+  class Rows::Spl < Rows
+
+    register("SPL")
+
+    @all_fields = [
+      ' SPLID',      #(Required) A unique number that identifies the distribution line in the transaction.
+      ' TRNSTYPE',   #A keyword that indicates the type of transaction. The keyword in this field must match the keyword in the TRNSTYPE field for the transaction. The keyword will be one of the following:
+                     #    BILL: Bills from vendors
+                     #    CHECK: Checks
+                     #    DEPOSIT: Bank or money market deposits
+                     #    INVOICE: Invoices
+                     #    PAYMENT: Customer payments
+      ' DATE',       #The date of the transaction. The date in this field must match the date in the DATE field for the transaction.
+      '*ACCNT',      #(Required) The income or expense account to which you assigned the amount on the distribution line.
+      ' NAME',       #The name of the customer, vendor, payee, or employee.
+      ' CLASS',      #The name of the class that applies to the distribution amount. If the class is a subclass, the class name includes the names of the parent classes, beginning with the highest level class. A colon (:) separates each class name.
+      '*AMOUNT',     #(Required) The distribution amount. Credit amounts are negative.
+      ' DOCNUM',     #The number of the transaction. For checks, the number is the check number; for invoices, the number is the invoice number, etc.
+      ' MEMO',       #The memo text associated with the distribution line.
+      ' CLEAR',      #Indicates whether the distribution amount has cleared. These keywords can appear in the CLEAR field: Y or N
+      ' PRICE',      #The unit cost of the item.
+      ' QNTY',       #The number of items sold. This value is part of a line item on an invoice, credit memo, or sales receipt.
+      ' INVITEM',    #The type of items sold. This value is part of a line item on an invoice, credit memo, or sales receipt.
+      ' PAYMETH',    #On a sales receipt, indicates the method of payment (check, credit card, etc.) that the customer used.
+      ' TAXABLE',    #Indicates that a line item on an invoice, credit memo, or sales receipt is taxable.
+      ' REIMBEXP',   #Indicates the status of the distribution amount as a reimbursable expense. These codes can appear under REIMBEXP:
+                    #    NONEED: Indicates that the distribution amount does not qualify as a reimbursable expense.
+                    #    NOTHING: Indicates that the distribution amount can be billed to a customer as a reimbursable expense.
+                    #    THISWAS: Indicates that the distribution amount is a reimbursable expense that appears on an invoice or sales receipt.
+                    #    HASBEEN: Identifies a distribution amount on a check that has been billed to a customer as a reimbursable expense.
+                    #    EXTRA: Adds additional information about the distribution line. These keywords can appear in the EXTRA field:
+ 
+      ' ENDGRP',     #(Invoices, credit memos, and sales receipts only) Indicates that the distribution line is the last item of an invoice item group.
+      ' AUTOSTAX',   #Identifies a sales tax item as the automatic tax rate you set up for your QuickBooks company.
+      ' VALDAJ',     #(Inventory) Indicates whether the amount in a detail line is an inventory value adjustment. Y or N
+    ]
+  end
+end

data/lib/simple_iif/rows/trans.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+module SimpleIif
+  class Rows::Trans < Rows
+    register("TRNS")
+
+    @all_fields = [
+      ' TRNSID',       #A unique number that identifies the transaction.
+      ' TIMESTAMP',    #A second unique number that works with TRNSID to identify the transaction.
+      ' TRNSTYPE',     #(Required) A keyword that identifies the type of transaction. These keywords can appear in the TRNSTYPE field:
+                       #    BEGINBALCHECK: Transactions that create a beginning balance in a balance sheet account
+                       #    BILL: Bills from vendors
+                       #    BILL REFUND: Refunds from a vendor
+                       #    CASH REFUND: Cash refunds you give to customers
+                       #    CASH SALE: Sales receipts
+                       #    CCARD REFUND: Refunds you receive on credit card charges
+                       #    CHECK: Checks
+                       #    CREDIT CARD: Charges you make on a credit card
+                       #    CREDIT MEMO: Credit you give to customers for merchandise they return
+                       #    DEPOSIT: Bank or money market deposits
+                       #    ESTIMATES: Estimates or bids
+                       #    GENERAL JOURNAL: General journal transactions
+                       #    INVOICE: Invoices
+                       #    PAYMENT: Customer payments
+                       #    PURCHORD: Purchase orders
+                       #    TRANSFER: Transfers of funds from one balance sheet account to another
+      '*DATE',   #The date of the transaction. The date is always in MM/DD/YY format. For example, 1/30/94.
+      '*ACCNT',    #(Required) The name of the account assigned to the transaction.
+      ' NAME',   #The name of the customer, vendor, payee, or employee.
+      ' CLASS',    #The name of the class that applies to the transaction. If the class is a subclass, the class name includes the names of the parent classes, beginning with the highest level class. A colon (:) separates each class name.
+      '*AMOUNT',   #(Required) The amount of the transaction. Debit amounts are always positive, credit amounts are always negative.
+      ' DOCNUM',   #The number of the transaction. For checks, the number is the check number; for invoices, the number is the invoice number; etc.
+      ' MEMO',   #The memo text associated with the transaction.
+      ' CLEAR',    #Indicates whether the transaction has cleared. These keywords can appear in the CLEAR field: Y or N
+      ' TOPRINT',    #Indicates whether a check, invoice, credit memo, or sales receipt has been marked as "To be printed." These keywords can appear in the TOPRINT field: Y or N
+      ' ADDR1',    #The first line of the customer's, vendor's, payee's, or employee's address.
+      ' ADDR2',    #The second line of the customer's, vendor's, payee's, or employee's address.
+      ' ADDR3',    #The third line of the customer's, vendor's, payee's, or employee's address.
+      ' ADDR4',    #The fourth line of the customer's, vendor's, payee's, or employee's address.
+      ' ADDR5',    #The fifth line of the customer's, vendor's, payee's, or employee's address.
+      ' DUEDATE',    #(Bills and invoices only) The due date of the bill payment or invoice payment. The date is always in MM/DD/YY format. For example, 1/30/98.
+      ' TERMS',    #(Invoices only) The terms of the invoice.
+      ' PAID',   #(Invoices only) Indicates whether an invoice has been paid in full. These keywords can appear in the PAID field: Y or N
+      ' PAYMETH',    #(Sales receipts only) The method your customer used to pay for the merchandise.
+      ' SHIPVIA',    #(Invoices and sales receipts only) The method you used to ship the merchandise.
+      ' SHIPDATE',   #(Invoices and sales receipts only) The shipping date. If you are creating an import file, enter the date in MM/DD/YY format. For example, 1/30/94.
+      ' REP',    #(Invoices and sales receipts only) The initials of the sales representative or employee who made the sale.
+      ' FOB',    #(Invoices, credit memos, and cash sales only) The location where you delivered the merchandise—free of charge—to a carrier for shipment.
+      ' PONUM',    #(Invoices and credit memos only) The customer's purchase order number.
+      ' INVTITLE',   #(Invoices, credit memos, and sales receipts only) The title that appears on the invoice, credit memo, or sales receipt.
+      ' INVMEMO',    #(Invoices, credit memos, and sales receipts only) Your message to the customer—as it appears on the invoice, credit memo, or sales receipt.
+      ' SADDR1',   #(Invoices and sales receipts only) The first line of the customer's shipping address.
+      ' SADDR2',   #(Invoices and sales receipts only) The second line of the customer's shipping address.
+      ' SADDR3',   #(Invoices and sales receipts only) The third line of the customer's shipping address.
+      ' SADDR4',   #(Invoices and sales receipts only) The fourth line of the customer's shipping address.
+      ' SADDR5',   #(Invoices and sales receipts only) The fifth line of the customer's shipping address.
+      ' NAMEISTAXABLE',    #(Invoices and sales receipts only) Indicates whether the customer whose name appears in the transaction is taxable. Y or N
+    ]
+
+    def closing_row_name
+      'ENDTRNS'
+    end
+
+  end
+end

data/lib/simple_iif/rows/vend.rb

@@ -0,0 +1,41 @@
+module SimpleIif
+  class Rows::Vend < Rows
+    register("VEND")
+
+    @all_fields = [
+      '*NAME',       #(Required) The name of the vendor.
+      ' TIMESTAMP',  #(Export files only) A unique number that identifies the company file from which you exported the Vendor list.
+      ' REFNUM',     #(Export files only) A unique number that identifies an entry in the list.
+      '*PRINTAS',    #The name you would like checks to be made out to. This field allows you to make checks out to a different name than the name that appears on your Vendor list.
+      '*ADDR1',      #The first line of the vendor's address.
+      '*ADDR2',      #The second line of the vendor's address.
+      ' ADDR3',      #The third line of the vendor's address.
+      ' ADDR4',      #The fourth line of the vendor's address.
+      ' ADDR5',      #The fifth line of the vendor's address.
+      '*VTYPE',      #Your classification for the vendor (QuickBooks calls this a "vendor type"). If you import a vendor type that is not on your Vendor Type list, QuickBooks adds the new vendor type to the list.
+      ' CONT1',      #The name of your primary contact with the vendor.
+      ' PHONE1',     #The vendor's phone number.
+      ' PHONE2',     #The vendor's alternate phone number.
+      ' FAXNUM',     #The vendor's FAX number.
+      ' TAXID',      #The vendor's tax identification number.
+      ' LIMIT',      #Your credit limit with the vendor. If you are creating an import file, enter the dollar amount.
+      ' TERMS',      #Your payment terms with the vendor.
+      ' NOTEPAD',    #Your notes about the vendor. If you are creating an import file, the notes appear in the Notepad window for the vendor.
+      ' SALUTATION', #The vendor's salutation, or title (Mr., Ms., Doctor, etc.).
+      ' COMPANYNAME',#The name of the vendor's company.
+      '*FIRSTNAME',  #The vendor's first name.
+      ' MIDINIT',    #The vendor's middle initial.
+      '*LASTNAME',   #The vendor's last name.
+      ' CUSTFLD1',   #CUSTFLD2
+      ' CUSTFLD2',   #CUSTFLD2
+      ' CUSTFLD3',   #CUSTFLD2
+      ' CUSTFLD4',   #CUSTFLD2
+      ' CUSTFLD5',   #CUSTFLD2
+      ' CUSTFLD6',   #CUSTFLD2
+      ' CUSTFLD7',   #The custom field entries for the vendor (you can have up to 7 custom field entries). Custom fields let you track special information about the vendor, such as the vendor's birthday or e-mail address. What you use custom fields for is entirely up to you.
+      '*1099',       #Indicates whether you file a 1099-MISC form for this vendor. If you are creating an import file, enter one of these keywords in the 1099 field:
+      ' NOTE',       #The name or number of the account you want to associate with this vendor. QuickBooks requires an account number if you want to set up this vendor as an online payee. The payee uses this number to identify you.
+    ]
+
+  end
+end

data/lib/simple_iif/rows.rb

@@ -0,0 +1,95 @@
+require_relative 'row_sequence'
+
+module SimpleIif
+  class Rows
+
+    # Load in the subclasses defining each row type
+    ROWS = {}
+
+    def self.register(row_type)
+      ROWS[row_type] = self
+      self.instance_eval %{
+        def row_type
+          "#{row_type}"
+        end
+      }
+    end
+
+    class << self
+      def required_fields
+        @required_fields ||= @all_fields.grep(/^\*/).map {|f| f[1..-1] }
+      end
+
+      def optional_fields
+        @optional_fields ||= @all_fields.grep(/^ /).map {|f| f[1..-1] }
+      end
+
+    end
+
+    row_definitions = Dir.chdir(File.join(File.dirname(__FILE__))) { Dir.glob("rows/*.rb")}
+    row_definitions.each do |row|
+      require_relative row
+    end
+
+    # An an object that represents a set of transaction rows
+    def self.sequence
+      RowSequence.new
+    end
+
+    # Factory that returns a new row for a given type
+    def self.for(row, *args)
+      if cls = ROWS[row.to_s.upcase]
+        cls.new(*args)
+      else
+        fail "Don't know about row #{row.inspect}"
+      end
+    end
+
+
+    # Now the instance stuff
+
+    attr_reader :data
+
+    def initialize(values = {})
+      @data = {}
+      values.each do |key, value|
+        key = key.to_s.upcase
+        if valid_field?(key)
+          @data[key] = value
+        else
+          puts self.class.required_fields.sort
+          puts "----"
+          puts self.class.optional_fields.sort
+          fail "Row type #{self.class.row_type} does not have a field #{key}"
+        end
+      end
+      check_all_required_fields_present
+    end
+
+    def valid_field?(field_name)
+      self.class.required_fields.include?(field_name) ||
+      self.class.optional_fields.include?(field_name)
+    end
+
+    def headers
+      ["!#{self.class.row_type}"] + @data.keys.sort
+    end
+
+    def values
+      ["#{self.class.row_type}"] + @data.keys.sort.map {|k| @data[k]}
+    end
+
+    def to_iif
+      [ headers.join("\t"), values.join("\t") ]
+    end
+
+    private
+
+    def check_all_required_fields_present
+      missing = self.class.required_fields.select {|f| !@data.has_key?(f) }
+      unless missing.empty?
+        fail "Missing required fields: #{missing.join(', ')}"
+      end
+    end
+  end
+end

data/lib/simple_iif/version.rb

@@ -0,0 +1,3 @@
+module SimpleIif
+  VERSION = "0.0.1"
+end

data/lib/simple_iif.rb

@@ -0,0 +1,6 @@
+require_relative "simple_iif/version"
+require_relative "simple_iif/rows"
+
+module SimpleIif
+
+end

data/simple_iif.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simple_iif/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dave Thomas"]
+  gem.email         = ["dave@pragprog.com"]
+  gem.description   = %q{A simple library to assist in the handling of Quickbooks IIF files}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "simple_iif"
+  gem.require_paths = ["lib"]
+  gem.version       = SimpleIif::VERSION
+end

data/test/test_row_sequence.rb

@@ -0,0 +1,81 @@
+require 'test/unit'
+require 'shoulda'
+require 'simple_iif/rows'
+
+include SimpleIif
+
+class TestRowSequence < Test::Unit::TestCase
+
+  def setup
+    @rs = RowSequence.new
+  end
+
+  context "An empty row sequence" do
+    should "have no headers or values" do
+      assert_equal [], @rs.to_iif
+    end
+  end
+
+  context "A row sequence containing a vendor" do
+    setup do
+      @params = {
+        name: "Dave Thomas",
+        printas: "Mr Smith",
+        addr1: "123 Main St",
+        addr2: "Anytown",
+        vtype: "Author",
+        firstname: "David",
+        lastname:  "Thomas",
+        :'1099' =>  "YES"
+      }
+
+      @rs.add(:vend, @params)
+      @iif = @rs.to_iif
+    end
+
+    should "contain two lines of iff data" do
+      assert_equal 2, @iif.size
+    end
+
+    should "contain a valid header" do
+      hdr = @iif.first
+      assert_not_nil hdr
+      fields = hdr.split("\t")
+      assert_equal "!VEND", fields.shift
+      expected = @params.keys.map(&:to_s).map(&:upcase).sort
+      assert_equal expected, fields
+    end
+
+    should "contain the values" do
+      hdrs = @iif.first.split("\t")[1..-1].map(&:downcase).map(&:to_sym)
+      data = @iif.last
+      fields = data.split("\t")
+      assert_equal "VEND", fields.shift
+      assert_equal hdrs.size, fields.size
+      hdrs.zip(fields).each do |hdr, field|
+        assert_equal @params[hdr], field
+        @params.delete(hdr)
+      end
+      assert @params.empty?, "All headers should have been used"
+    end
+  end
+
+  context "a row sequence containing 2 rows" do
+    setup do
+      @rs.add(:trns, date: '1/2/3', accnt: 'bank', amount: '12.34')
+      @rs.add(:endtrns)
+      @iif = @rs.to_iif
+    end
+
+    should "contain 4 rows of iif data" do
+      assert_equal 4, @iif.size
+    end
+
+    should "contain two headers and two data rows" do
+      %w{ !TRNS !ENDTRNS TRNS ENDTRNS }.each do |row_type|
+        row = @iif.shift
+        assert row.start_with?(row_type), "#{row} should start #{row_type}"
+      end
+    end
+  end
+end

data/test/test_rows.rb

@@ -0,0 +1,83 @@
+require 'test/unit'
+require 'shoulda'
+require 'simple_iif/rows'
+
+include SimpleIif
+
+class TestRows < Test::Unit::TestCase
+
+  REQUIRED_VENDOR_ATTRS = {
+    name:      "A-00001-9",
+    printas:   "Thomas Consulting", 
+    addr1:     "123 Main St", 
+    addr2:     "Lewisville", 
+    vtype:     "Author", 
+    firstname: "Dave",
+    lastname:  "Thomas",
+    :"1099" => "Y"
+  }
+
+  context "Creating an unknown row type" do
+    should "raise an exception" do
+      assert_raises(RuntimeError) do
+        Rows.for("WIBBLE")
+      end
+    end
+  end
+
+  context "Creating an empty vendor row" do
+    should "raise an exception because some fields are missing" do
+      assert_raises(RuntimeError) do
+        Rows.for("VEND")
+      end
+    end
+  end
+
+  context "Creating a vendor with all required fields" do
+    setup do
+      @vendor = Rows.for(:vend, REQUIRED_VENDOR_ATTRS)
+    end
+
+    should "succeed" do
+      assert true
+    end
+
+    should "set all the fields" do
+      REQUIRED_VENDOR_ATTRS.each do |k, v|
+        assert_equal v, @vendor.data[k.to_s.upcase]
+      end
+    end
+
+    should "only have the given fields" do
+      assert_equal REQUIRED_VENDOR_ATTRS.size, @vendor.data.size
+    end
+
+    should "have the correct headers" do
+      assert_equal %w{ !VEND 1099 ADDR1 ADDR2 FIRSTNAME LASTNAME NAME PRINTAS VTYPE}, @vendor.headers
+    end
+
+    should "have the correct values" do
+      assert_equal %w{ VEND Y 123\ Main\ St Lewisville Dave Thomas A-00001-9 Thomas\ Consulting Author}, @vendor.values
+    end
+  end
+
+  context "creaiting a vendor with required fields but also with an invalid field" do
+    should "raise an exception" do
+      assert_raises(RuntimeError) do
+        Rows.for(:vend, REQUIRED_VENDOR_ATTRS.merge(invalid: 123))
+      end
+    end
+  end
+
+  context "creaiting a vendor with required fields and with a valid field" do
+    setup do
+      @vendor = Rows.for(:vend, REQUIRED_VENDOR_ATTRS.merge(taxid: 123))
+    end
+
+    should "pass the valid field through" do
+      assert @vendor.headers.include?("TAXID")
+      assert @vendor.values.include?(123)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: simple_iif
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dave Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-12 00:00:00.000000000 Z
+dependencies: []
+description: A simple library to assist in the handling of Quickbooks IIF files
+email:
+- dave@pragprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simple_iif.rb
+- lib/simple_iif/.DS_Store
+- lib/simple_iif/row_sequence.rb
+- lib/simple_iif/rows.rb
+- lib/simple_iif/rows/endtrans.rb
+- lib/simple_iif/rows/spl.rb
+- lib/simple_iif/rows/trans.rb
+- lib/simple_iif/rows/vend.rb
+- lib/simple_iif/version.rb
+- simple_iif.gemspec
+- test/test_row_sequence.rb
+- test/test_rows.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple library to assist in the handling of Quickbooks IIF files
+test_files:
+- test/test_row_sequence.rb
+- test/test_rows.rb