to_qbxml 1.0.1 → 1.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWUzZjZkYjBjOWNlYjY3YmZmYzk0ZTk3Y2FiZmI0Mzg5MDM2Mjg5Ng==
-  data.tar.gz: !binary |-
-    NzllM2E0ZGJjYjU3ZTU0NGU4NTY4ODcwMTUxNzkyZjZjYmY0OWI4NQ==
+SHA1:
+  metadata.gz: 7d0fae5d6caaaad3ea2983cbc676bab80fa7b4f2
+  data.tar.gz: 7240d049dbdd4087a97fca788f43cf2c6030af2b
 SHA512:
-  metadata.gz: !binary |-
-    MGM2YzNmNGNlMTI0YTA0MGM1YTlmNDZkOTg0NjA5OWJiZjQwMTM1Mzk4YTc1
-    YWFiZThiODdkN2RlYmM0NDg2YTA0OWY4YzVkNTg0YWQ3Nzc3OTRhZGIxMGJi
-    ZDY4MTBiYmRjMDA2MjI2ODM4YzdkNTkxNmQ0M2E1ZTMzNDgzNWU=
-  data.tar.gz: !binary |-
-    N2NlNmZlOWMwN2Q3NzJkNzc1ZmY4NWZmZDFhNTM4NTdmYzYwZmNjOTQ5ZGQx
-    MmE5NGZiMDFjYTFlYTA2OTFiYTdkYWRkNmQxZWQyZGM0MjU5M2VjYjgyY2Ni
-    YmU3YjM4MTU4MzkyNjdmMWEyMjkyZTEwZDlmNzJlNjhjOWViZjU=
+  metadata.gz: 1ade8547d07b29bd8d134d0b04e6a14ade7131261a6adfdfbbbb8f306a01497bf2ce10e8b327f5725407fa175660e06bfb6193ed6be8f28766ea702a9ec4f8e4
+  data.tar.gz: 1931412d8a4eae44df43828960de1cd89f8eb206163695fc9c3dcf68aec60d76d624cf1f197020afb663da397a6a00be47b1ea1310e363125ea9dab4cf9d0aba

data/README.md

@@ -18,6 +18,15 @@ Or install it yourself as:
 
 ## Usage
 
+### Configuration
+```
+ToQbxml.configure do |config|
+  config.version = '11.0'
+  config.on_error = 'continueOnError'
+end
+
+```
+
 ### Create an add request
 ```ruby
   def line_item(line_number)
@@ -45,7 +54,7 @@ Or install it yourself as:
 ```
 
 ```xml
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="US-ASCII"?>
 <?qbxml version="7.0"?>
 <QBXML>
   <QBXMLMsgsRq onError="stopOnError">
@@ -106,7 +115,7 @@ Use the parent node *repeat* to make repeating nodes such as *InvoiceLineAdd* an
 ```
 
 ```xml
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="US-ASCII"?>
 <?qbxml version="7.0"?>
 <QBXML>
   <QBXMLMsgsRq onError="stopOnError">
@@ -132,8 +141,8 @@ Use the parent node *repeat* to make repeating nodes such as *InvoiceLineAdd* an
 ```
 
 ```xml
-<?xml version="1.0" encoding="utf-8"?>
-<?qbxml version="7.0"?>
+<?xml version="1.0" encoding="US-ASCII"?>
+<?qbxml version="12.0"?>
 <QBXML>
   <QBXMLMsgsRq onError="stopOnError">
     <InvoiceQueryRq requestID="1">
@@ -156,7 +165,7 @@ Use the parent node *repeat* to make repeating nodes such as *InvoiceLineAdd* an
 ```
 
 ```xml
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="US-ASCII"?>
 <?qbxml version="7.0"?>
 <QBXML>
   <QBXMLMsgsRq onError="stopOnError">
@@ -186,6 +195,10 @@ Takes 2 arguments:
 ### Examples:
 See the [specs](https://github.com/minimul/to_qbxml/blob/master/spec/lib/to_qbxml/to_qbxml_spec.rb) for more examples
 
+### What about encoding?
+
+This library is hard coded for US-ASCII because that is what is accepted by the QBSDK. Fool around with UTF-8 at your own peril.
+
 ### What about validation?
 This library provides no validation or schema validation. In my experience, it is best to use the [OCR docs](http://developer-static.intuit.com/qbsdk-current/common/newosr/index.html) and the [QBXML validator and SDKTest utilities](https://developer.intuit.com/docs/0250_qb/0010_get_oriented/0060_sdk_components) that come bundled with the standard QBSDK installation. These tools are only available on Windows but if you are wanting to do any serious integration with QuickBooks Desktop then you better have a Windows machine or VM handy. 
 
@@ -195,7 +208,7 @@ Here are some quick examples:
 
 #### Given
 ```xml
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="US-ASCII"?>
 <?qbxml version="7.0"?>
 <QBXML>
   <QBXMLMsgsRq onError="stopOnError">

data/lib/to_qbxml/to_qbxml.rb

@@ -1,16 +1,35 @@
 class ToQbxml
-  #attr_reader :hash, :options
-
   ACRONYMS = [/Ap\z/, /Ar/, /Cogs/, /Com\z/, /Uom/, /Qbxml/, /Ui/, /Avs/, /Id\z/,
               /Pin/, /Ssn/, /Clsid/, /Fob/, /Ein/, /Uom/, /Po\z/, /Pin/, /Qb/]
   ATTR_ROOT    = 'xml_attributes'.freeze
   IGNORED_KEYS = [ATTR_ROOT]
-  ON_ERROR = 'stopOnError'
   REPEATABLE_KEY = 'Repeat' 
 
   def initialize(hash, options = {})
     @hash = hash
     @options = options
+    @version = ToQbxml.version
+    @on_error = ToQbxml.on_error
+  end
+
+  def self.configure(&block)
+    yield self
+  end
+
+  def self.version
+    @version ||= '7.0' 
+  end
+
+  def self.version=(number)
+    @version = number
+  end
+
+  def self.on_error
+    @on_error ||= 'stopOnError' 
+  end
+
+  def self.on_error=(err_kind)
+    @on_error = err_kind
   end
 
   def make(type, boilerplate_options = {})
@@ -22,11 +41,11 @@ class ToQbxml
     @hash = convert_to_qbxml_hash
     xml = hash_to_xml(@hash, @options)
     handler = xml_handler(xml)
-    @options[:doc] ? handler : handler.to_xml
+    @options[:doc] ? handler : handler.to_xml(encoding: 'US-ASCII')
   end
 
   def xml_handler(xml)
-    doc = Nokogiri.XML(xml, nil, @options[:encoding] || 'utf-8')
+    doc = Nokogiri.XML(xml)
     remove_tags_preserve_content(doc, REPEATABLE_KEY)
   end
 
@@ -55,7 +74,7 @@ class ToQbxml
     opts = opts.dup
     opts[:indent]          ||= 0
     opts[:root]            ||= :QBXML
-    opts[:version]         ||= '7.0'
+    opts[:version]         ||= @version
     opts[:attributes]      ||= (hash.delete(ATTR_ROOT) || {})
     opts[:builder]         ||= Builder::XmlMarkup.new(indent: opts[:indent])
     opts[:skip_types]      = true unless opts.key?(:skip_types) 
@@ -92,7 +111,7 @@ class ToQbxml
     {  :qbxml_msgs_rq =>
        [
          {
-           :xml_attributes =>  { "onError" => opts[:on_error] || ON_ERROR},
+           :xml_attributes =>  { "onError" => opts[:on_error] || @on_error},
            head + '_rq' =>
            [
              {

data/lib/to_qbxml/version.rb

@@ -1,3 +1,3 @@
 class ToQbxml
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/lib/to_qbxml/to_qbxml_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 describe ToQbxml do
@@ -40,15 +41,36 @@ describe ToQbxml do
       expect(xml).to match /version=\"12\.0/
     end
 
-    it "should have the default encoding of utf-8" do
+    it "default version is 7.0" do
       xml = ToQbxml.new({}).generate
-      expect(xml).to match /encoding=\"utf-8/
+      expect(xml).to match /version=\"7\.0/
     end
 
-    it "should be able to change the default encoding" do
-      xml = ToQbxml.new({}, encoding: 'windows-1251').generate
-      expect(xml).to match /encoding=\"windows-1251/
+    it "should change system-wide qbxml version to 10.0" do
+      ToQbxml.configure do |config|
+        config.version = '11.0'
+      end
+      xml = ToQbxml.new({}).generate
+      expect(xml).to match /version=\"11\.0/
+    end
+
+    it "default on_error is stopOnError" do
+      xml = ToQbxml.new({}).make(:customer)
+      expect(xml).to match /onError=\"stopOnError/
+    end
+
+    it "should change system-wide on_error" do
+      ToQbxml.on_error = 'continueOnError'
+      xml = ToQbxml.new({}).make(:invoice)
+      expect(xml).to match /onError=\"continueOnError/
+    end
+
+    it "should properly encode special characters" do
+      hash = { name: 'Lè Car <"Häns">'}
+      xml = ToQbxml.new(hash).make(:customer)
+      expect(xml).to match /Name\>L&#232; Car &lt;\"H&#228;ns\"&gt;/
     end
+
   end
 
   context 'query requests' do

metadata

@@ -1,117 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: to_qbxml
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Christian Pelczarski (minimul)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
 description: Ruby Hash to QuickBooks XML Request
@@ -121,7 +121,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,21 +141,20 @@ 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.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Takes Ruby Hash and turns it into QuickBooks XML Request
 test_files:
 - spec/lib/to_qbxml/to_qbxml_spec.rb
 - spec/spec_helper.rb
-has_rdoc: