qbxml 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19cc9c6c600d5ad6185008a0c4d7c273a928844f
-  data.tar.gz: 5a2ef8033e05136789d019a7c30b38eae2dbefbb
+  metadata.gz: 11572014f70b00b684710498b5f2072e4c716a34
+  data.tar.gz: d8d4be361ed0a330345637c270221fb06f1f03c0
 SHA512:
-  metadata.gz: 51ddbdc7b3f078649fd0ac8373d2f598779d1b403dde03b0cc932876dc3378ca0447802874d8f5b52f4285c0674424d2a91d52c82474181ded3690b7b38f0d0a
-  data.tar.gz: 6a6a08ae03de03de815ca57d995e6e8e1027d7f3ef1baf7e9d8dd561628a202dc094dd1bfc96c6af0e5874d4bb2dcbd0979a743c4a433bd2fd104ebc4c9f69f9
+  metadata.gz: bfac0afceeca6efd56a5459f0c21b1180d76c6705ff070a30d254db62c35255015e66d1be3ecc6fe88272b0f351ca18d06e38c0f32e5e9b810c871d324720436
+  data.tar.gz: eb5a9c9a4346d810b638000608ef37f02d382a5dc9683576bc67f757af49a0b0e66fbcb1bcd691c171bd1ea6d861941fd80510175857ebf83d69bc95d56feb47

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -1,11 +1,3 @@
 source 'https://rubygems.org'
-gemspec
-
-# test
-gem 'pry'
-gem 'pry-nav'
-gem 'rspec'
-gem 'simplecov', require: false, group: :test
 
-# backwards compatibility tests
-gem 'quickbooks_api', path: '../old/quickbooks_api'
+gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Qbxml
 
+[![Build Status](https://travis-ci.org/qbwc/qbxml.svg?branch=master)](https://travis-ci.org/qbwc/qbxml)
+
 Qbxml is a QBXML parser and validation tool.
 
 ## Installation
@@ -20,11 +22,11 @@ Or install it yourself as:
 
 ### Initialization
 
-The parser can be initialized to either Quickbooks (:qb) or Quickbooks Point of
-Sale (:qbpos)
+The QBXML supported depends on whether you use QuickBooks (`:qb`) or
+QuickBooks Point of Sale (`:qbpos`) and on the version of QuickBooks used.
 
 ```ruby
-q = Qbxml.new(:qb)
+q = Qbxml.new(:qb, '7.0')
 ```
 
 ### API Introspection
@@ -73,18 +75,7 @@ q.to_qbxml(hsh, validate: true)
 
 ## Caveats
 
-Correct case conversion depends on the following ActiveSupport inflection
-settings. Correct behaviour cannot be guaranteed if any of the following
-inflections are modified.
-
-```ruby
-ACRONYMS = ['AP', 'AR', 'COGS', 'COM', 'UOM', 'QBXML', 'UI', 'AVS', 'ID',
-            'PIN', 'SSN', 'COM', 'CLSID', 'FOB', 'EIN', 'UOM', 'PO', 'PIN', 'QB']
-
-ActiveSupport::Inflector.inflections do |inflect|
-  ACRONYMS.each { |a| inflect.acronym a }
-end
-```
+QuickBooks only supports [ISO-8859-1](http://en.wikipedia.org/wiki/ISO/IEC_8859-1) characters. Any characters outside of ISO-8859-1 will become question marks in QuickBooks.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+task :default => :test

data/lib/qbxml/hash.rb

@@ -15,7 +15,11 @@ class Qbxml::Hash < ::Hash
   def self.from_hash(hash, opts = {}, &block)
     key_proc = \
       if opts[:camelize]
-        lambda { |k| k.camelize } 
+        lambda { |k|
+          # QB wants things like ListID, not ListId. Adding inflections then using camelize can accomplish
+          # the same thing, but then the inflections will apply to everything the user does everywhere.
+          k.camelize.gsub(Qbxml::Types::ACRONYM_REGEXP) { "#{$1}#{$2.upcase}#{$3}" }
+        }
       elsif opts[:underscore]
         lambda { |k| k.underscore } 
       end
@@ -51,6 +55,7 @@ private
     builder = opts[:builder]
     
     unless opts.delete(:skip_instruct)
+      builder.instruct!(:xml, :encoding => "ISO-8859-1")
       builder.instruct!(opts[:schema], version: opts[:version])
     end
 
@@ -60,7 +65,12 @@ private
         when Hash
           self.hash_to_xml(val, opts.merge({root: key, skip_instruct: true}))
         when Array
-          val.map { |i| self.hash_to_xml(i, opts.merge({root: key, skip_instruct: true})) }
+          val.map { |i|
+            if i.is_a?(String)
+              next builder.tag!(key, i, {})
+            end
+            next self.hash_to_xml(i, opts.merge({root: key, skip_instruct: true}))
+          }
         else
           builder.tag!(key, val, {})
         end
@@ -78,9 +88,12 @@ private
 
     # Insert node hash into parent hash correctly.
     case hash[name]
-    when Array then hash[name] << node_hash
-    when Hash  then hash[name] = [hash[name], node_hash]
-    else hash[name] = node_hash
+      when Array
+        hash[name] << node_hash
+      when Hash, String
+        hash[name] = [hash[name], node_hash]
+      else
+        hash[name] = node_hash
     end
 
     # Handle child elements
@@ -103,12 +116,14 @@ private
       node_hash.delete(CONTENT_ROOT)
     elsif node_hash[CONTENT_ROOT].present?
       node_hash.delete(ATTR_ROOT)
-      hash[name] = \
-        if schema
-          typecast(schema, node.path, node_hash[CONTENT_ROOT], opts[:typecast_cache])
-        else
-          node_hash[CONTENT_ROOT]
-        end
+      v = schema ? typecast(schema, node.path, node_hash[CONTENT_ROOT], opts[:typecast_cache]) : node_hash[CONTENT_ROOT]
+      # We only updated the last element
+      if hash[name].is_a?(Array)
+        hash[name].pop
+        hash[name] << v
+      else
+        hash[name] = v
+      end
     else
       hash[name] = node_hash[CONTENT_ROOT]
     end

data/lib/qbxml/qbxml.rb

@@ -86,6 +86,8 @@ class Qbxml
   end
 
   def select_schema(schema_key, version)
+    # Try to handle it if a user gave us a numeric version. Assume 1 decimal.
+    version = '%.1f' % version if version.is_a?(Numeric)
     raise "invalid schema '#{schema_key}', must be one of #{SCHEMAS.keys.inspect}" if !SCHEMAS.has_key?(schema_key)
     raise "invalid version '#{version}' for schema #{schema_key}, must be one of #{SCHEMAS[schema_key].keys.inspect}" if !SCHEMAS[schema_key].has_key?(version)
     return SCHEMAS[schema_key][version]

data/lib/qbxml/types.rb

@@ -30,11 +30,14 @@ module Qbxml::Types
     "TIMEINTERVALTYPE" => STR_CAST
   }
 
+  # Strings in tag names that should be capitalized in QB's XML
   ACRONYMS = ['AP', 'AR', 'COGS', 'COM', 'UOM', 'QBXML', 'UI', 'AVS', 'ID',
               'PIN', 'SSN', 'COM', 'CLSID', 'FOB', 'EIN', 'UOM', 'PO', 'PIN', 'QB']
 
-  ActiveSupport::Inflector.inflections do |inflect|
-    ACRONYMS.each { |a| inflect.acronym a }
-  end
+  # Based on the regexp in ActiveSupport::Inflector.camelize
+  # Substring 1: Start of string, lower case letter, or slash
+  # Substring 2: One of the acronyms above, In Capitalized Casing
+  # Substring 3: End of string or capital letter
+  ACRONYM_REGEXP = Regexp.new("(?:(^|[a-z]|\\/))(#{ACRONYMS.map{|a| a.capitalize}.join("|")})([A-Z]|$)")
 
 end

data/lib/qbxml/version.rb

@@ -1,3 +1,3 @@
 class Qbxml
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/qbxml.gemspec

@@ -6,8 +6,8 @@ require 'qbxml/version'
 Gem::Specification.new do |gem|
   gem.name          = "qbxml"
   gem.version       = Qbxml::VERSION
-  gem.authors       = ["Alex Skryl"]
-  gem.email         = ["rut216@gmail.com"]
+  gem.authors       = ["Alex Skryl", "Jason Barnabe"]
+  gem.email         = ["rut216@gmail.com", "jason.barnabe@gmail.com"]
   gem.description   = %q{Quickbooks XML Parser}
   gem.summary       = %q{Quickbooks XML Parser and Validation Tool}
   gem.homepage      = ""
@@ -20,4 +20,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency('activesupport', '>= 3.2.9')
   gem.add_dependency('nokogiri', '~> 1.5')
   gem.add_dependency('builder', '~> 3.0')
+
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('pry-nav')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('simplecov')
+  gem.add_development_dependency('rake')
 end

data/test/unit/hash_to_xml_test.rb

@@ -0,0 +1,78 @@
+require 'minitest/autorun'
+require 'qbxml'
+
+class HashToXmlTest < Minitest::Test
+
+  def test_hash_to_xml_customer_query
+    qbxml = Qbxml.new
+    assert_equal "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\n<?qbxml version=\"7.0\"?>\n<QBXML>\n  <QBXMLMsgsRq>\n    <CustomerQueryRq>\n      <ListID>GUID-GOES-HERE</ListID>\n    </CustomerQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>\n", qbxml.to_qbxml({:qbxml => {:qbxml_msgs_rq => {:customer_query_rq => {:list_id => 'GUID-GOES-HERE'}}}})
+  end
+
+  def test_hash_to_xml_invoice_mod
+    qbxml = Qbxml.new
+    xml = <<-EOF
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<?qbxml version="7.0"?>
+<QBXML>
+  <QBXMLMsgsRq>
+    <InvoiceModRq>
+      <InvoiceMod>
+        <TxnID>1929B9-1423150873</TxnID>
+        <EditSequence/>
+        <CustomerRef>
+          <ListID>4A50001-1013529664</ListID>
+        </CustomerRef>
+        <TxnDate>2015-01-28</TxnDate>
+        <RefNumber>12345678</RefNumber>
+        <Memo></Memo>
+        <InvoiceLineMod>
+          <TxnLineID>-1</TxnLineID>
+          <ItemRef>
+            <FullName>Sales</FullName>
+          </ItemRef>
+          <Desc>Contract 123</Desc>
+          <Quantity>23.44165</Quantity>
+          <Rate>515.0</Rate>
+          <SalesTaxCodeRef>
+            <FullName>E</FullName>
+          </SalesTaxCodeRef>
+        </InvoiceLineMod>
+      </InvoiceMod>
+    </InvoiceModRq>
+  </QBXMLMsgsRq>
+</QBXML>
+    EOF
+    assert_equal xml, qbxml.to_qbxml({:invoice_mod_rq=>{:invoice_mod=>{:txn_id=>"1929B9-1423150873", :edit_sequence=>nil, :customer_ref=>{:list_id=>"4A50001-1013529664"}, :txn_date=>"2015-01-28", :ref_number=>"12345678", :memo=>"", :invoice_line_mod=>[{:txn_line_id=>-1, :item_ref=>{:full_name=>"Sales"}, :desc=>"Contract 123", :quantity=>"23.44165", :rate=> 515.0, :sales_tax_code_ref=>{:full_name=>"E"}}]}}})
+  end
+
+  def test_hash_to_xml_customer_add
+    qbxml = Qbxml.new
+    xml = <<-EOF
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<?qbxml version="7.0"?>
+<QBXML>
+  <QBXMLMsgsRq>
+    <CustomerAddRq>
+      <CustomerAdd>
+        <Name>Joe Blow</Name>
+        <CompanyName>Joe Blow Inc.</CompanyName>
+        <BillAddress>
+          <Addr1>123 Fake Street</Addr1>
+          <City>Springfield</City>
+          <State>Texachussets</State>
+          <PostalCode>99999</PostalCode>
+          <Country>USA</Country>
+        </BillAddress>
+      </CustomerAdd>
+    </CustomerAddRq>
+  </QBXMLMsgsRq>
+</QBXML>
+    EOF
+    assert_equal xml, qbxml.to_qbxml({:customer_add_rq=>{:customer_add=>{:name=>"Joe Blow", :company_name=>"Joe Blow Inc.", :bill_address=>{:addr1=>"123 Fake Street", :city=>"Springfield", :state=>"Texachussets", :postal_code=>"99999", :country=>"USA"}}}})
+  end
+
+  def test_array_of_strings
+    assert_equal "<foo>\n  <bar>baz</bar>\n  <bar>guh</bar>\n</foo>\n", Qbxml::Hash.to_xml({:foo => {:bar => ['baz', 'guh']}}, {skip_instruct: true})
+  end
+
+end

data/test/unit/version_test.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require 'qbxml'
+
+class VersionTest < Minitest::Test
+
+  def test_string_version
+    Qbxml.new(:qb, '7.0')
+  end
+
+  def test_bad_version
+    assert_raises RuntimeError do
+      Qbxml.new(:qb, '3.14')
+    end
+  end
+
+  def test_float_version
+    Qbxml.new(:qb, 7.0)
+  end
+
+  def test_int_version
+    Qbxml.new(:qb, 7)
+  end
+
+end

data/test/unit/xml_to_hash_test.rb

@@ -0,0 +1,30 @@
+require 'minitest/autorun'
+require 'qbxml'
+
+class XmlToHashTest < Minitest::Test
+
+  def test_xml_to_hash
+    qbxml = Qbxml.new
+    h = {"qbxml"=>{"xml_attributes"=>{}, "qbxml_msgs_rq"=>{"xml_attributes"=>{}, "customer_query_rq"=>{"xml_attributes"=>{}, "list_id"=>"GUID-GOES-HERE"}}}}
+    assert_equal h, qbxml.from_qbxml("<?qbxml version=\"7.0\"?>\n<QBXML>\n  <QBXMLMsgsRq>\n    <CustomerQueryRq>\n      <ListID>GUID-GOES-HERE</ListID>\n    </CustomerQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>\n")
+  end
+
+  def test_array_of_strings
+    qbxml = Qbxml.new
+    h = {
+      "qbxml" => {
+        "xml_attributes" => {},
+        "qbxml_msgs_rq" => {
+          "xml_attributes" => {},
+          'invoice_query_rq' => {
+            "xml_attributes" => {},
+            'include_ret_element' => ['TxnID', 'RefNumber']
+          }
+        }
+      }
+    }
+    assert_equal h, qbxml.from_qbxml("<?qbxml version=\"7.0\"?>\n<QBXML>\n  <QBXMLMsgsRq>\n    <InvoiceQueryRq>\n      <IncludeRetElement>TxnID</IncludeRetElement>\n    <IncludeRetElement>RefNumber</IncludeRetElement>\n    </InvoiceQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>\n")
+  end
+
+end
+

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: qbxml
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex Skryl
+- Jason Barnabe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,19 +53,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-nav
+  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: 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: simplecov
+  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: rake
+  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'
 description: Quickbooks XML Parser
 email:
 - rut216@gmail.com
+- jason.barnabe@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.md
 - lib/qbxml.rb
 - lib/qbxml/hash.rb
 - lib/qbxml/qbxml.rb
@@ -106,6 +178,9 @@ files:
 - spec/support/responses/purchase_order_query_rs.xml
 - spec/support/responses/receive_payment_query_rs.xml
 - spec/support/responses/sales_receipt_add_rs.xml
+- test/unit/hash_to_xml_test.rb
+- test/unit/version_test.rb
+- test/unit/xml_to_hash_test.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -125,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Quickbooks XML Parser and Validation Tool
@@ -151,3 +226,6 @@ test_files:
 - spec/support/responses/purchase_order_query_rs.xml
 - spec/support/responses/receive_payment_query_rs.xml
 - spec/support/responses/sales_receipt_add_rs.xml
+- test/unit/hash_to_xml_test.rb
+- test/unit/version_test.rb
+- test/unit/xml_to_hash_test.rb

data/TODO.md

@@ -1,3 +0,0 @@
-stupid backwards compatibility
-- rename :xml_attributes to __attributes__
-- remove empty xml_attributes hashes