quickbooks 0.0.1

data/lib/quickbooks.rb

@@ -0,0 +1,40 @@
+#-- 
+# Copyright (c) 2006 Chris Bruce
+#
+# 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.
+#++
+# QuickBooks::Session is used to communicate with QuickBooks RDS Server.  You need to configure
+# your QuickBooks software to allow RDS connection from application.
+# 
+#   require 'quickbooks'
+#   
+#   session = QuickBooks::Session.new('admin', 'pass', 'My Test App')
+#   session.open
+#   xml = <<END
+#   <?xml version="1.0"?>
+#   <?qbxml version="3.0"?>
+#   <QBXML>
+#   <QBXMLMsgsRq onError="continueOnError">
+#    <InvoiceQueryRq requestID="1">
+#      <RefNumber>81</RefNumber>
+#      <IncludeLineItems>true</IncludeLineItems>
+#    </InvoiceQueryRq>
+#   </QBXMLMsgsRq>
+#   </QBXML>
+#   <<END
+#   session.send(xml)
+#   session.close 
+require 'quickbooks/session'

data/lib/quickbooks/models/base.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2006 Chris Bruce
+#
+# 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.
+
+module QuickBooks
+  module Models
+    class Base
+      def add_xml
+        xml 
+      end
+      
+      def mod_xml
+      end
+           
+    end
+    
+    class Transaction
+      attr_accessor :id, :ref_number
+      
+      def self.delete
+      end
+      
+      def delete
+      end
+      
+      def self.void
+      end
+      
+      def void
+      end
+      
+    end
+    
+    class ListItem < Base
+      attr_accessor :id, :full_name
+      
+      def self.delete(id)
+      end
+      
+      def delete
+      end  
+    end
+    
+    class DataExt < Base
+      attr_accessor :owner_id, :data_ext_name, :data_ext_type, :data_ext_value   
+    end
+    
+    class CreditCardInfo
+      attr_accessor :credit_card_number, :expiration_month, :expiration_year, :name_on_card, :credit_card_address, :credit_card_postal_code
+    end
+    
+    class Address
+      attr_accessor :addr1, :addr2, :addr3, :addr4, :city, :state, :postal_code, :country    
+    end
+    
+    
+  end
+end

data/lib/quickbooks/models/customer.rb

@@ -0,0 +1,56 @@
+# Copyright (c) 2006 Chris Bruce
+#
+# 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.
+
+require 'base'
+module QuickBooks
+  module Models
+    class Customer < ListItem
+      attr_accessor(:time_created, :time_modified, :edit_sequence, :name, :is_active, :parent_ref, :sublevel,
+                    :company_name, :salutation, :first_name, :middle_name, :last_name, :suffix, :bill_address, :ship_address,
+                    :print_as, :phone, :mobile, :pager, :alt_phone, :fax, :email, :contact, :alt_contact, :customer_type_ref,
+                    :terms_ref, :sales_rep_ref, :open_balance, :open_balance_date, :balance, :total_balance, :sales_tax_code_ref,
+                    :item_sales_tax_ref, :resale_nmber, :account_number, :credit_limit, :preferred_payment_method_ref,
+                    :credit_card_info, :job_status, :job_start_date, :job_projected_end_date, :job_end_date, :job_desc,
+                    :job_type_ref, :notes, :is_statement_with_parent, :delivery_method, :price_level_ref, :data_ext_ref)
+      
+      def initialize(attributes={})
+        @new_record = true
+        
+        @parent_ref = new ListItem
+        @bill_address = new Address        
+        @terms_ref = new ListItem
+        @sales_rep_ref = new ListItem
+        @sales_tax_code_ref = new ListItem
+        @item_sales_tax_ref = new ListItem
+        @preferred_payment_method_ref = new ListItem
+        @job_type_ref = new ListItem
+        @price_live_ref = new ListItem
+        @data_ext_ref = new ListItem
+        
+        @ship_address = new Address
+        @customer_type_ref = new ListItem
+        
+        @credit_card_info = new CreditCardInfo
+      end                    
+      
+      def new_record?
+      end
+      
+      
+    end
+  end
+end

data/lib/quickbooks/session.rb

@@ -0,0 +1,90 @@
+#--
+# Copyright (c) 2006 Chris Bruce
+#
+# 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.
+#++
+
+module QuickBooks
+  # Session used to communicate with QuickBooks RDS Server.  You need to configure
+  # your QuickBooks software to allow RDS connection from application.
+  # <code>
+  #   require 'quickbooks'
+  #   
+  #   session = QuickBooks::Session.new('admin', 'pass', 'My Test App')
+  #   session.open
+  #   xml = <<END
+  #   <?xml version="1.0"?>
+  #   <?qbxml version="3.0"?>
+  #   <QBXML>
+  #   <QBXMLMsgsRq onError="continueOnError">
+  #    <InvoiceQueryRq requestID="1">
+  #      <RefNumber>81</RefNumber>
+  #      <IncludeLineItems>true</IncludeLineItems>
+  #    </InvoiceQueryRq>
+  #   </QBXMLMsgsRq>
+  #   </QBXML>
+  #   <<END
+  #   session.send(xml)
+  #   session.close
+  class Session
+    require 'cgi'
+    require 'soap/wsdlDriver'
+    
+    attr_accessor :user, :password, :application_name, :host, :port
+    
+    # Initializes an instance of QuickBooks::Session
+    def initialize(user, password, application_name, host="localhost", port=3790, mode='multiUser')
+      @user = user
+      @password = password
+      @application_name = application_name
+      @host = host
+      @port = port
+      @mode = mode
+      @ticket = nil
+      @soap_client = nil      
+    end
+    
+    # Determines if the Session is connected to a QuickBooks RDS Server
+    def connected?
+      if @ticket && @soap_client
+        return true
+      end
+      return false
+    end
+    
+    # Opens a connection to a QuickBooks RDS Server
+    def open
+      @soap_client = SOAP::WSDLDriverFactory.new("https://#{@host}:#{@port}/QBXMLRemote?wsdl").create_rpc_driver
+      @ticket = @soap_client.OpenConnectionAndBeginSession(@user, @password, '', @application_name, '', @mode)
+      return @ticket
+    end
+    
+    # Send a QBXML message to QuickBooks RDS Server
+    def send(xml)
+      @soap_client.ProcessRequest(@ticket, xml)      
+    end
+    
+    # Close the session to QuickBooks RDS Server
+    def close
+      if connected? && @soap_client
+        @soap_client.CloseConnection(@ticket)
+        @soap_client = nil
+        @ticket = nil
+      end        
+    end
+    
+  end
+end

data/test/quickbooks/quickbooks_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class QuickBooksTest < Test::Unit::TestCase
+	def setup		
+	end
+	
+	def test_connection        
+      session = QuickBooks::Session.new('admin', 'pass123', 'My Test App')
+      session.open
+      xml = <<EOL
+<?xml version="1.0"?>
+<?qbxml version="3.0"?>
+<QBXML>
+  <QBXMLMsgsRq onError="continueOnError">
+    <InvoiceQueryRq requestID="1">
+      <RefNumber>81</RefNumber>
+      <IncludeLineItems>true</IncludeLineItems>
+    </InvoiceQueryRq>
+  </QBXMLMsgsRq>
+</QBXML>
+EOL
+      res = session.send(xml)
+      assert_not_nil(res)
+      session.close 
+	end	
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'quickbooks'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: quickbooks
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-09-13 00:00:00 -07:00
+summary: A module to connect to QuickBooks through the QuickBooks SDK.
+require_paths: 
+- lib
+email: chrisabruce@yahoo.com
+homepage: http://quickbooks.rubyforge.org
+rubyforge_project: 
+description: A module to connect to QuickBooks and QuickBooks Merchant Services through the QuickBooks SDK.
+autorequire: quickbooks
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Chris Bruce
+files: 
+- lib/quickbooks
+- lib/quickbooks.rb
+- lib/quickbooks/models
+- lib/quickbooks/session.rb
+- lib/quickbooks/models/base.rb
+- lib/quickbooks/models/customer.rb
+- test/quickbooks
+- test/test_helper.rb
+- test/quickbooks/quickbooks_test.rb
+- LICENSE
+- Rakefile
+- README
+- doc/classes
+- doc/created.rid
+- doc/files
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/rdoc-style.css
+- doc/classes/QuickBooks
+- doc/classes/QuickBooks.html
+- doc/classes/QuickBooks/Models
+- doc/classes/QuickBooks/Models.html
+- doc/classes/QuickBooks/Session.html
+- doc/classes/QuickBooks/Session.src
+- doc/classes/QuickBooks/Models/Address.html
+- doc/classes/QuickBooks/Models/Base.html
+- doc/classes/QuickBooks/Models/Base.src
+- doc/classes/QuickBooks/Models/CreditCardInfo.html
+- doc/classes/QuickBooks/Models/Customer.html
+- doc/classes/QuickBooks/Models/Customer.src
+- doc/classes/QuickBooks/Models/DataExt.html
+- doc/classes/QuickBooks/Models/ListItem.html
+- doc/classes/QuickBooks/Models/ListItem.src
+- doc/classes/QuickBooks/Models/Transaction.html
+- doc/classes/QuickBooks/Models/Transaction.src
+- doc/classes/QuickBooks/Models/Base.src/M000009.html
+- doc/classes/QuickBooks/Models/Base.src/M000010.html
+- doc/classes/QuickBooks/Models/Customer.src/M000001.html
+- doc/classes/QuickBooks/Models/Customer.src/M000002.html
+- doc/classes/QuickBooks/Models/ListItem.src/M000007.html
+- doc/classes/QuickBooks/Models/ListItem.src/M000008.html
+- doc/classes/QuickBooks/Models/Transaction.src/M000003.html
+- doc/classes/QuickBooks/Models/Transaction.src/M000004.html
+- doc/classes/QuickBooks/Models/Transaction.src/M000005.html
+- doc/classes/QuickBooks/Models/Transaction.src/M000006.html
+- doc/classes/QuickBooks/Session.src/M000011.html
+- doc/classes/QuickBooks/Session.src/M000012.html
+- doc/classes/QuickBooks/Session.src/M000013.html
+- doc/classes/QuickBooks/Session.src/M000014.html
+- doc/classes/QuickBooks/Session.src/M000015.html
+- doc/files/lib
+- doc/files/LICENSE.html
+- doc/files/README.html
+- doc/files/lib/quickbooks
+- doc/files/lib/quickbooks_rb.html
+- doc/files/lib/quickbooks/models
+- doc/files/lib/quickbooks/session_rb.html
+- doc/files/lib/quickbooks/models/base_rb.html
+- doc/files/lib/quickbooks/models/customer_rb.html
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+