qbwc_requests 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7c569a7bf82b699c1caa556ed79041ada8a3260
+  data.tar.gz: 2a8447dbd33e0a7272467bd50a5971a7baa0a6fb
+SHA512:
+  metadata.gz: 2eadbeda559a1f7b9c65a91d20a9841e1e9047ddc0494604c3869ef828dd01316870b50be8b3926fb89bd792c114033b759bb45fcd9b99cf028732e37778b66d
+  data.tar.gz: eadd9a14ea6b7b1e14278eda5f990c67b3ac2537d3fb6d1be53ac034ef58677ff0d49c7348fc25bcfa6e6b198d67a215f5b76d968491a0ff05163538182c27e9

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qbwc_requests.gemspec
+gem 'rspec'
+gem 'activemodel'
+gem 'qbxml'
+gem 'pry'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Alexandre Mondaini Calvão
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexandre Mondaini Calvão
+
+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,29 @@
+# QbwcRequests
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qbwc_requests'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qbwc_requests
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/qbwc_requests/qbwc/ordered_fields.rb

@@ -0,0 +1,35 @@
+module Qbwc
+  module OrderedFields
+
+    module ClassMethods
+      def field attribute_name
+        @attr_order ||= []
+        @attr_order << attribute_name
+        attr_accessor attribute_name
+      end
+      def attr_order
+        @attr_order
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def ordered_fields
+      new_hash = {}
+      for attribute in self.class.attr_order
+        value = send(attribute)
+        if value.present?
+          if value.respond_to?(:ordered_fields)
+            new_hash[attribute] = value.ordered_fields
+          else
+            new_hash[attribute] = value
+          end
+        end
+      end
+      new_hash
+    end
+
+  end
+end

data/lib/qbwc_requests/qbwc/qbwc.rb

@@ -0,0 +1,2 @@
+module Qbwc
+end

data/lib/qbwc_requests/qbwc/request/base.rb

@@ -0,0 +1,61 @@
+module Qbwc 
+  module Request
+    class Base
+
+      include Qbwc::OrderedFields
+      extend ActiveModel::Naming
+      include ActiveModel::Validations
+      include ActiveModel::Conversion
+
+      def self.query_all amount = 2000
+        XmlActions.query("#{underscore self.name.demodulize}_query_rq", amount)
+      end
+      
+      def add
+        self.valid? ? add_xml : self
+      end
+
+      def initialize(attributes = {})
+        @attributes = compact(attributes)
+        @attributes.each do |name, value|
+          self.instance_variable_set("@#{name}", value)
+        end
+      end
+
+      def class_name
+        self.class.underscore self.class.name.demodulize
+      end
+
+      def persisted?
+        false
+      end
+
+      private
+
+        def self.underscore string
+          string.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+        end
+
+        def compact opts={}
+          # I pass two times to avoid {v: '1',k: {}}, gotta find a better algorithm (recursive)
+          proc = Proc.new { |k, v| v.kind_of?(Hash) ? (v.delete_if(&proc); nil) : v.empty? };
+          hash = opts.delete_if(&proc)
+          hash.delete_if { |k, v| v.empty? }
+        end
+
+        def add_xml
+          req = XmlActions.header
+          req['qbxml']['qbxml_msgs_rq']["#{class_name}_add_rq"] = {"xml_attributes"=>
+              {"requestID"=>"2"},
+                "#{class_name}_add"=> self.ordered_fields
+              }
+          XmlActions.to_xml(req)
+        end
+
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/account.rb

@@ -0,0 +1,13 @@
+module Qbwc 
+  module Request
+    module V07
+      class Account < Base
+
+        field :name
+
+        validates :name, presence: true
+        
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/customer.rb

@@ -0,0 +1,29 @@
+module Qbwc 
+  module Request
+    module V07
+      class Customer < Base
+
+        field :name
+        field :is_active
+        field :company_name
+        field :salutation
+        field :first_name
+        field :middle_name
+        field :last_name
+        field :suffix
+        field :job_title
+        field :phone
+        field :mobile
+        field :pager
+        field :alt_phone
+        field :fax
+        field :email
+        field :cc
+        field :contact
+        field :parent_ref
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/estimate.rb

@@ -0,0 +1,14 @@
+module Qbwc 
+  module Request
+    module V07
+      class Estimate < Base
+
+        field :customer_ref
+        field :estimate_line_add
+
+        validates :customer_ref, presence: true
+        validates :estimate_line_add, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/invoice.rb

@@ -0,0 +1,15 @@
+module Qbwc 
+  module Request
+    module V07
+      class Invoice < Base
+
+        field :customer_ref
+        field :invoice_line_add
+
+        validates :customer_ref, presence: true
+        validates :invoice_line_add, presence: true
+        
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item.rb

@@ -0,0 +1,11 @@
+module Qbwc 
+  module Request
+    module V07
+      class Item
+        def self.query_all
+          XmlActions.query "item_query_rq", 2000
+        end
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item_discount.rb

@@ -0,0 +1,15 @@
+module Qbwc 
+  module Request
+    module V07
+      class ItemDiscount < Base
+
+        field :name
+        field :is_active
+        field :account_ref
+        field :discount_rate
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item_group.rb

@@ -0,0 +1,14 @@
+module Qbwc 
+  module Request
+    module V07
+      class ItemGroup < Base
+
+        field :name
+        field :is_active
+        field :item_desc
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item_non_inventory.rb

@@ -0,0 +1,15 @@
+module Qbwc 
+  module Request
+    module V07
+      class ItemNonInventory < Base
+
+        field :name
+        field :is_active
+        field :pricetype
+        field :parent_ref
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item_other_charge.rb

@@ -0,0 +1,16 @@
+module Qbwc 
+  module Request
+    module V07
+      class ItemOtherCharge < Base
+
+        field :name
+        field :is_active
+        field :pricetype
+        field :sales_or_purchase
+
+        validates :sales_or_purchase, presence: true
+        validates :name, presence: true, length: { maximum: 41 }
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item_payment.rb

@@ -0,0 +1,14 @@
+module Qbwc 
+  module Request
+    module V07
+      class ItemPayment < Base
+
+        field :name
+        field :is_active
+        field :item_desc
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item_service.rb

@@ -0,0 +1,15 @@
+module Qbwc 
+  module Request
+    module V07
+      class ItemService < Base
+
+        field :name
+        field :is_active
+        field :price
+        field :sales_or_purchase
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/item_subtotal.rb

@@ -0,0 +1,15 @@
+module Qbwc 
+  module Request
+    module V07
+      class ItemSubtotal < Base
+              
+        field :name
+        field :is_active
+        field :item_desc
+        field :bar_code
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/purchase_order.rb

@@ -0,0 +1,12 @@
+module Qbwc 
+  module Request
+    module V07
+      class PurchaseOrder < Base
+
+        field :vendor_ref
+        field :purchase_order_line_add
+        
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/request/v07/vendor.rb

@@ -0,0 +1,25 @@
+module Qbwc 
+  module Request
+    module V07
+      class Vendor < Base
+
+        field :name
+        field :is_active
+        field :company_name
+        field :salutation
+        field :first_name
+        field :middle_name
+        field :last_name
+        field :phone
+        field :email
+        field :contact
+        field :name_on_check
+        field :is_vendor_eligible_for_1099
+        field :open_balance
+
+        validates :name, presence: true
+        
+      end
+    end
+  end
+end

data/lib/qbwc_requests/qbwc/xml_actions.rb

@@ -0,0 +1,31 @@
+module Qbwc
+  module XmlActions
+
+    def self.query req, max_returned
+      hash = {"qbxml"=>
+              {"xml_attributes"=>{},
+               "qbxml_msgs_rq"=>
+                {"xml_attributes"=>{"onError"=>"stopOnError"},
+                 "#{req}"=>
+                  {"xml_attributes"=>{},
+                    "max_returned"=> max_returned}
+                }
+              }
+            }
+      to_xml(hash)
+    end
+
+    def self.header
+      {"qbxml"=>
+        {"xml_attributes"=>{}, "qbxml_msgs_rq"=>
+          {"xml_attributes"=>{"onError"=>"stopOnError"}}
+        }
+      }
+    end
+
+    def self.to_xml hash
+      "<?xml version='1.0' encoding='utf-8'?>#{Qbxml.new.to_qbxml(hash)}"
+    end
+
+  end
+end

data/lib/qbwc_requests/version.rb

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

data/lib/qbwc_requests.rb

@@ -0,0 +1,7 @@
+require "qbwc_requests/version"
+require "active_model"
+Dir["#{File.dirname(__FILE__)}/qbwc_requests/qbwc/**/*.rb"].each {|f| require f}
+
+module QbwcRequests
+  # Your code goes here...
+end

data/qbwc_requests.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qbwc_requests/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qbwc_requests"
+  spec.version       = QbwcRequests::VERSION
+  spec.authors       = ["Alexandre Mondaini Calvão"]
+  spec.email         = ["apotema@gmail.com"]
+  spec.description   = %q{A qbxml request generator}
+  spec.summary       = %q{This gem helps you generate Qbxml requests}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/quickbook/xml/qbxml/examples/xmlfiles/AccountQueryRq.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" ?>
+<!-- ========================================================================== -->
+<!-- AccountQueryRq.xml                                                         -->
+<!--                                                                            -->
+<!-- INTUIT CONFIDENTIAL.                                                       -->
+<!-- Copyright (c) 2001-2013 Intuit Inc. All rights reserved.                   -->
+<!-- Use is subject to the terms specified at:                                  -->
+<!--          http://developer.intuit.com/legal/devsite_tos.html                -->
+<!--                                                                            -->
+<!--                                                                            -->
+<!-- ========================================================================== -->
+<!-- Summary: Sample illustrating the account query request.                    -->
+<!-- This XML file contains a single request to query accounts.                 -->
+<!--                                                                            -->
+<!-- Description:                                                               -->
+<!-- This XML file contains a single request to query all accounts. It does not -->
+<!-- filter the output so lots of accounts could cause this to be a bit slow.   -->
+<!-- ========================================================================== -->
+<!-- Language: xml                                                            -->
+<!-- Structure: QBXML                                                            -->
+<!-- QuickBooks: any                                                            -->
+<!-- Deployment: any                                                            -->
+<!-- ========================================================================== -->
+<?qbxml version="8.0"?>
+<QBXML>
+   <QBXMLMsgsRq onError="stopOnError">
+      <AccountQueryRq requestID="1">
+      </AccountQueryRq>
+   </QBXMLMsgsRq>
+</QBXML>
+

data/quickbook/xml/qbxml/examples/xmlfiles/BillQueryRq.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" ?>
+<!-- ========================================================================== -->
+<!-- BillQueryRq.xml                                                            -->
+<!--                                                                            -->
+<!-- INTUIT CONFIDENTIAL.                                                       -->
+<!-- Copyright (c) 2001-2013 Intuit Inc. All rights reserved.                   -->
+<!-- Use is subject to the terms specified at:                                  -->
+<!--          http://developer.intuit.com/legal/devsite_tos.html                -->
+<!--                                                                            -->
+<!--                                                                            -->
+<!-- ========================================================================== -->
+<!-- Summary: Sample illustrating the bill query request.                       -->
+<!--                                                                            -->
+<!-- Description:                                                               -->
+<!-- This XML file contains a single request to query bills.                    -->
+<!-- ========================================================================== -->
+<!-- Language: xml                                                            -->
+<!-- Structure: QBXML                                                            -->
+<!-- QuickBooks: any                                                            -->
+<!-- Deployment: any                                                            -->
+<!-- ========================================================================== -->
+<?qbxml version="8.0"?>
+<QBXML>
+   <QBXMLMsgsRq onError="stopOnError">
+      <BillQueryRq requestID="1" />
+   </QBXMLMsgsRq>
+</QBXML>
+

data/quickbook/xml/qbxml/examples/xmlfiles/CheckQueryRq.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" ?>
+<!-- ========================================================================== -->
+<!-- CheckQueryRq.xml                                                           -->
+<!--                                                                            -->
+<!-- INTUIT CONFIDENTIAL.                                                       -->
+<!-- Copyright (c) 2001-2013 Intuit Inc. All rights reserved.                   -->
+<!-- Use is subject to the terms specified at:                                  -->
+<!--          http://developer.intuit.com/legal/devsite_tos.html                -->
+<!--                                                                            -->
+<!--                                                                            -->
+<!-- ========================================================================== -->
+<!-- Summary: Sample illustrating the check query request.                      -->
+<!--                                                                            -->
+<!-- Description:                                                               -->
+<!-- This XML file contains a single request to query all checks.               -->
+<!-- ========================================================================== -->
+<!-- Language: xml                                                            -->
+<!-- Structure: QBXML                                                            -->
+<!-- QuickBooks: any                                                            -->
+<!-- Deployment: any                                                            -->
+<!-- ========================================================================== -->
+<?qbxml version="8.0"?>
+<QBXML>
+   <QBXMLMsgsRq onError="stopOnError">
+      <CheckQueryRq requestID="1" />
+   </QBXMLMsgsRq>
+</QBXML>
+

data/quickbook/xml/qbxml/examples/xmlfiles/CompanyQueryRq.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" ?>
+<!-- ========================================================================== -->
+<!-- CompanyQueryRq.xml                                                         -->
+<!--                                                                            -->
+<!-- INTUIT CONFIDENTIAL.                                                       -->
+<!-- Copyright (c) 2001-2013 Intuit Inc. All rights reserved.                   -->
+<!-- Use is subject to the terms specified at:                                  -->
+<!--          http://developer.intuit.com/legal/devsite_tos.html                -->
+<!--                                                                            -->
+<!--                                                                            -->
+<!-- ========================================================================== -->
+<!-- Summary: Sample illustrating the company query request.                    -->
+<!--                                                                            -->
+<!-- Description:                                                               -->
+<!-- This XML file contains a single request to query all companies.            -->
+<!-- ========================================================================== -->
+<!-- Language: xml                                                            -->
+<!-- Structure: QBXML                                                            -->
+<!-- QuickBooks: any                                                            -->
+<!-- Deployment: any                                                            -->
+<!-- ========================================================================== -->
+<?qbxml version="8.0"?>
+<QBXML>
+   <QBXMLMsgsRq onError="stopOnError">
+      <CompanyQueryRq requestID="1" />
+   </QBXMLMsgsRq>
+</QBXML>
+