quickbooks 0.0.5 → 0.0.7

data/lib/quickbooks/adapters/qbxml_debug_adapter.rb

@@ -0,0 +1,10 @@
+# This is a fake adapter simply for testing Qbxml Requests.
+module Quickbooks
+  module QbxmlDebugAdapter
+    class Connection
+      def send_xml(xml)
+        puts "Sending XML: #{xml.to_s}"
+      end
+    end
+  end
+end

data/lib/quickbooks/base.rb

@@ -67,10 +67,8 @@
 # - VehicleMileage
 # - VendorCredit
 
-require 'activesupport'
-require 'quickbooks/connection'
 require 'quickbooks/model'
-require 'quickbooks/qbxml'
+require 'qbxml'
 
 module Quickbooks
   # Base is just base for ListItem and Transaction. It inherits from Model, just as Ref does.
@@ -78,7 +76,7 @@ module Quickbooks
 
     self.filter_aliases = {:limit => :max_returned}
 
-    # Stores a log of Quickbooks::Qbxml::Response objects that were a result of methods performed on this object.
+    # Stores a log of Qbxml::Response objects that were a result of methods performed on this object.
     attr_accessor :response_log
     def response_log #:nodoc:
       @response_log || (@response_log = [])
@@ -93,13 +91,16 @@ module Quickbooks
     end
     class << self
 
-      # def inherited(klass)
-      #   super
-      # end
+      def use_adapter(adapter)
+        # Should complain if the adapter doesn't exist.
+        require "#{File.dirname(__FILE__)}/adapters/#{adapter.to_s}_adapter"
+        @@connection_adapter = Object.module_eval("::Quickbooks::#{adapter.to_s.camelize}Adapter::Connection", __FILE__, __LINE__)
+      end
 
       # Establishes a connection to the Quickbooks RDS Server for all Model Classes
-      def establish_connection(application_name='RubyApplication', file='', user='', password='', connection_type='localQBD', connection_mode='DoNotCare')
-        @@connection = Connection.new(application_name, file, user, password, connection_type, connection_mode)
+      def establish_connection(*args)
+        @@connection_adapter ||= use_adapter(:ole)
+        @@connection = @@connection_adapter.new(*args)
       end
 
       # Returns the current Connection
@@ -113,25 +114,32 @@ module Quickbooks
       # you can use this method to explicitly set the connection in a class that inherits from Quickbooks::Base.
       #   Quickbooks::Models::Base.connection = Quickbooks::Connection.new('My Test App', 'C:\\Some File.QBW', 'user', 'pass')
       def connection=(conn)
-        raise ArgumentError, "Cannot set connection to anything but a Quickbooks::Connection object" unless conn.is_a?(Quickbooks::Connection)
+        raise ArgumentError, "Cannot set connection to anything but a (*)Adapter::Connection object" unless conn.class.name =~ /Adapter::Connection$/
         @connection = conn
       end
 
-      # Generates a request by sending *args to Quickbooks::Qbxml::Request.new, sends the request over the current connection,
-      # and interprets the response using Quickbooks::Qbxml::ResponseSet.
+      # Generates a request by sending *args to Qbxml::Request.new, sends the request over the current connection,
+      # and interprets the response using Qbxml::ResponseSet.
       # The response is then instantiated into an object or an array of objects.
       # 
       # This method is used mostly internally, but it is the yoke of this library - use it to perform custom requests.
-      def request_and_instantiate(obj_or_args,*args)
+      def query(obj_or_args,*args)
         # If an object is sent, we need to reinstantiate the response into that object
-        reinstantiate = obj_or_args.is_a?(Quickbooks::Base) ? obj_or_args : nil
+        reinstantiate = if obj_or_args.is_a?(Quickbooks::Base)
+          obj_or_args
+        elsif obj_or_args.is_a?(Class)
+          nil
+        else
+          args.unshift(obj_or_args)
+          nil
+        end
         objects = [] # This will hold and return the instantiated objects from the quickbooks response
 # The following is subject to bugginess, IF the response contains more than one object: it will instantiate only the last one.
-        self.request(obj_or_args, *args).each { |response| objects << response.instantiate(reinstantiate) } # Does not instantiate if it's an error, but simply records response into response_log
+        self.request(reinstantiate || self, *args).each { |response| objects << response.instantiate(reinstantiate) } # Does not instantiate if it's an error, but simply records response into response_log
         objects.length == 1 ? objects[0] : objects
       end
 
-      # Generates a request using Quickbooks::Qbxml::Request, sends it, and returns a Quickbooks::Qbxml::ResponseSet object containing the response(s).
+      # Generates a request using Qbxml::Request, sends it, and returns a Qbxml::ResponseSet object containing the response(s).
       def request(*args)
         Qbxml::ResponseSet.new(
           self.connection.send_xml(
@@ -154,19 +162,19 @@ module Quickbooks
             obj.original_values[key.to_s.underscore] = obj.instance_variable_get('@' + key.to_s.underscore).dup
           end
         end if attrs
-        obj # Will be either a nice object, or a Quickbooks::Qbxml::Error object.
+        obj # Will be either a nice object, or a Qbxml::Error object.
       end
 
       # Queries Quickbooks for all of the objects of the current class's type. For example, Quickbooks::Customer.all will return an array of Quickbooks::Customer objects representing all customers.
       def all(filters={})
         filters.reverse_merge!(:active_status => 'All')
-        [request_and_instantiate(self, :query, filters)].flatten
+        [query(self, :query, filters)].flatten
       end
 
       # Queries Quickbooks for the first object of the current class's type. For example, Quickbooks::Customer.first will return a Quickbooks::Customer object representing the first customer.
       def first(filters={})
         (filters.merge!(:max_returned => 1) unless filters.keys.include?(:list_id) || filters.keys.include?(:txn_id) || filters.keys.include?(:full_name)) if filters.is_a?(Hash)
-        request_and_instantiate(self, :query, filters)
+        query(self, :query, filters)
       end
 
       # Creates a new object of the current class's type. For example, Quickbooks::Customer.create(:name => 'Tommy') will create a customer object with a Name of Tommy.
@@ -194,7 +202,7 @@ module Quickbooks
       return false unless dirty?
       self.errors.clear # Clear out any errors: start with a clean slate!
       if new_record?
-        self.class.request_and_instantiate(self, :add)
+        self.class.query(self, :add)
         ret = !dirty?
         @new_record = false if ret
       else
@@ -204,7 +212,7 @@ module Quickbooks
         # 3) Replace self's original_attributes with those just retrieved, and update the automatic attributes, like EditSequence and TimeModified
         # 4) Return false, return the object dirty but ready to save
         old_originals = original_values.dup # Save the old_originals so we can detect any attributes that changed since we last loaded the object
-        ret = self.class.request_and_instantiate(self, :mod).error? ? false : true # Saves if possible, if EditSequence is out of date, it will read the up-to-date object into original_values
+        ret = self.class.query(self, :mod).error? ? false : true # Saves if possible, if EditSequence is out of date, it will read the up-to-date object into original_values
         # If save failed (dirty?) because of old record (status 3200), but none of the fields conflict (attributes I've modified and are still different aren't the same attributes as any of the attributes someone else updated), then re-save!
         if dirty? && self.response_log.last.status == 3200 && (dirty_attributes.only(dirty_attributes(old_originals).keys).keys - self.class.read_only.stringify_values).length == (dirty_attributes(old_originals).keys - old_originals.diff(original_values).keys - self.class.read_only.stringify_values).length
           # 'Revert' fields I didn't modify to equal the values of the more up-to-date record just loaded.
@@ -223,12 +231,13 @@ module Quickbooks
 
     # Reloads the record from Quickbooks, discarding any changes that have been made to it.
     def reload
-      self.class.request_and_instantiate(self, :query)
+      self.class.query(self, :query)
     end
 
-    # Destroys a record in Quickbooks. Note that even though Quickbooks will destroy the record, the record's ListID and DeletedTime can be accessed by doing a query for deleted objects of the appropriate type.
+    # Destroys a record in Quickbooks. Note that even though Quickbooks will destroy the record,
+    # the record's ListID and DeletedTime can be accessed by doing a query for deleted objects of the appropriate type.
     def destroy
-      self.class.request_and_instantiate(self, :delete).success?
+      self.class.query(self, :delete).success?
     end
 
     # Usual comparison (super), but add in false if either is a new record.

data/lib/quickbooks/model.rb

@@ -1,4 +1,5 @@
 require 'quickbooks/ruby_magic'
+require 'quickbooks/structure'
 module Quickbooks
   CAMELIZE_EXCEPTIONS = {'list_id' => 'ListID', 'txn_id' => 'TxnID', 'owner_id' => 'OwnerID'}
   # These were all created from the info in qbxmlops70.xml, found in the docs in the QBSDK package.
@@ -7,28 +8,34 @@ module Quickbooks
 
       def inherited(klass)
         def klass.valid_filters
-          superclass.valid_filters + (@valid_filters ||= [])
+          (superclass.valid_filters + (@valid_filters ||= [])).flatten_slashes
         end
         def klass.filter_aliases
-          superclass.filter_aliases.merge(@filter_aliases ||= {})
+          seed = [superclass.filter_aliases].flatten_slashes.expand_slashes.flatten_slashes
+          (seed.empty? ? {} : seed).merge(@filter_aliases ||= {})
         end
         klass.instance_variable_set('@object_properties', {})
       end
       
       def valid_filters=(v)
-        @valid_filters = v.stringify_values!
+        @valid_filters = v.stringify_values!.flatten_slashes
       end
       def valid_filters
-        @valid_filters ||= []
+        (@valid_filters ||= []).flatten_slashes
       end
       def filter_aliases=(v)
-        @filter_aliases = v.stringify_keys!.stringify_values!
+        al = [v].flatten_slashes.expand_slashes.flatten_slashes
+        @filter_aliases = al.empty? ? {} : al
       end
       def filter_aliases
         @filter_aliases ||= {}
       end
       def camelized_valid_filters
-        valid_filters.camelize_values(Quickbooks::CAMELIZE_EXCEPTIONS)
+        cvf = []
+        valid_filters.each do |v|
+          cvf << (Quickbooks::CAMELIZE_EXCEPTIONS.has_key?(v) ? Quickbooks::CAMELIZE_EXCEPTIONS[v] : (v.is_a?(Symbol) ? v.to_s.camelize.to_sym : v.split('/').map {|e| e.camelize}.join('/')))
+        end
+        cvf
       end
       
       # Register multiple read/writable properties at once. For example:
@@ -36,7 +43,7 @@ module Quickbooks
       # For reference attributes (like parent_ref), use ParentRef - a class constant for that object.
       # _read_write_ will set the property setter and accessor accordingly.
       def read_write(*args)
-        if args.blank?
+        if args.empty?
           @read_write || (@read_write = [])
         else
           args.each do |prop|
@@ -55,7 +62,7 @@ module Quickbooks
 
       # Read-only attributes: These are attributes, but not modifiable in Quickbooks
       def read_only(*args)
-        if args.blank?
+        if args.empty?
           @read_only || (@read_only = [])
         else
           args.each do |prop|
@@ -118,7 +125,7 @@ module Quickbooks
     # Returns a hash of the attributes and their (new) values that have been changed since the object was last loaded or updated from Quickbooks.
     # If you send in some attributes, it will compare to those given instead of original_attributes.
     def dirty_attributes(compare={})
-      compare = original_values if compare.blank?
+      compare = original_values if compare.empty?
       pairs = {}
       self.class.read_write.each do |column|
         value = instance_variable_get('@' + column.to_s)
@@ -134,12 +141,12 @@ module Quickbooks
       self.dirty_attributes.each do |key,value|
         if value.is_a?(Quickbooks::Model)
           h = value.to_dirty_hash
-          hsh[key] = h unless h.blank?
+          hsh[key] = h unless h.empty?
         else
           hsh[key] = value
         end
       end
-      hsh.order!(self.class.read_write.stringify_values)
+      hsh.ordered!(self.class.read_write.stringify_values)
       hsh
     end
 
@@ -148,12 +155,12 @@ module Quickbooks
       self.attributes(include_read_only).each do |key,value|
         if value.is_a?(Quickbooks::Model)
           h = value.to_hash(include_read_only)
-          hsh[key] = h unless h.blank?
+          hsh[key] = h unless h.empty?
         else
           hsh[key] = value
         end
       end
-      hsh.order!((include_read_only ? self.class.read_only + self.class.read_write : self.class.read_write).stringify_values)
+      hsh.ordered!((include_read_only ? self.class.read_only + self.class.read_write : self.class.read_write).stringify_values)
       hsh
     end
 

data/lib/quickbooks/models/customer.rb

@@ -4,7 +4,7 @@ require 'quickbooks/models/customer/credit_card_info'
 
 module Quickbooks
   class Customer < ListItem
-    self.valid_filters = [:active_status, :from_modified_date, :to_modified_date, :name_filter, :name_range_filter, :total_balance_filter]
+    self.valid_filters = ['active_status', 'from_modified_date', 'to_modified_date', 'name_filter', 'name_range_filter', 'total_balance_filter']
 
     # Properties are in the order required by QBXML
     read_write  :name,

data/lib/quickbooks/models/deleted.rb

@@ -0,0 +1,22 @@
+module Quickbooks
+  class Deleted < Base
+    self.filter_aliases = {'deleted_after' => 'deleted_date_range_filter/from_deleted_date', 'deleted_before' => 'deleted_date_range_filter/to_deleted_date'}
+  end
+
+  class ListDeleted < Deleted
+    self.valid_filters = ['list_del_type', 'deleted_date_range_filter/from_deleted_date', 'deleted_date_range_filter/to_deleted_date']
+    class << self
+      def ListOrTxn
+        'List'
+      end
+    end
+  end
+  class TxnDeleted < Deleted
+    self.valid_filters = ['txn_del_type' 'deleted_date_range_filter/from_deleted_date', 'deleted_date_range_filter/to_deleted_date']
+    class << self
+      def ListOrTxn
+        'Txn'
+      end
+    end
+  end
+end

data/lib/quickbooks/models/list_item.rb

@@ -1,33 +1,35 @@
-class Quickbooks::ListItem < Quickbooks::Base
+module Quickbooks
+  class ListItem < Base
 
-  self.valid_filters = [:list_id, :full_name]
-  self.filter_aliases = {:modified_after => :from_modified_date, :modified_before => :to_modified_date}
+    self.valid_filters = ['list_id', 'full_name']
+    self.filter_aliases = {'updated_after' => 'from_modified_date', 'updated_before' => 'to_modified_date'}
 
-  def self.inherited(klass)
-    super
-    klass.read_only :list_id, :full_name, :edit_sequence, :time_created, :time_modified
-  end
-
-  class << self
-    def ListOrTxn
-      'List'
+    def self.inherited(klass)
+      super
+      klass.read_only :list_id, :full_name, :edit_sequence, :time_created, :time_modified, :time_deleted # :time_deleted only comes from ListDeleted, but ListDeleted attributes can be instantiated into ListItems
     end
 
-    # def child_types
-    #   [ "Account", "Account List", "BillingRate",
-    #     "Class", "Currency", "Customer",
-    #     "CustomerMessage", "CustomerType",
-    #     "DateDrivenTerms", "Employee", "ItemDiscount",
-    #     "ItemFixedAsset", "ItemGroup", "ItemInventory",
-    #     "ItemInventoryAssembly", "ItemNonInventory",
-    #     "ItemOtherCharge", "ItemPayment", "ItemSalesTax",
-    #     "ItemSalesTaxGroup", "ItemService", "ItemSubtotal",
-    #     "JobType", "OtherName", "PaymentMethod",
-    #     "PayrollItemNonWage", "PayrollItemWage", "PriceLevel",
-    #     "SalesRep", "SalesTaxCode", "ShipMethod",
-    #     "StandardTerms", "TaxCode", "Template", "ToDo",
-    #     "Vehicle", "Vendor", "VendorType"
-    #   ]
-    # end
+    class << self
+      def ListOrTxn
+        'List'
+      end
+
+      # def child_types
+      #   [ "Account", "Account List", "BillingRate",
+      #     "Class", "Currency", "Customer",
+      #     "CustomerMessage", "CustomerType",
+      #     "DateDrivenTerms", "Employee", "ItemDiscount",
+      #     "ItemFixedAsset", "ItemGroup", "ItemInventory",
+      #     "ItemInventoryAssembly", "ItemNonInventory",
+      #     "ItemOtherCharge", "ItemPayment", "ItemSalesTax",
+      #     "ItemSalesTaxGroup", "ItemService", "ItemSubtotal",
+      #     "JobType", "OtherName", "PaymentMethod",
+      #     "PayrollItemNonWage", "PayrollItemWage", "PriceLevel",
+      #     "SalesRep", "SalesTaxCode", "ShipMethod",
+      #     "StandardTerms", "TaxCode", "Template", "ToDo",
+      #     "Vehicle", "Vendor", "VendorType"
+      #   ]
+      # end
+    end
   end
 end

data/lib/quickbooks/ruby_magic.rb

@@ -1,5 +1,7 @@
 # This file contains several little tidbits of magic that I've made to make certain things easier.
 # See Object, Class, and Hash.
+require 'time'
+require 'date'
 
 class Object
   # This allows one to effectively 'proxy' specific methods to be called on the return value of one of its methods.
@@ -39,17 +41,17 @@ class Object
     @errors ||= []
   end
   def error?
-    !@errors.blank?
+    !@errors.empty?
   end
 end
 
 class Class
   # Returns the class name without the module names that precede it. I'm sure there's a builtin way to do this, but I couldn't find it and this works just as reliably!
   # Examples:
-  # - Quickbooks::Qbxml::Request.class_leaf_name # => 'Request'
+  # - Qbxml::Request.class_leaf_name # => 'Request'
   # - Quickbooks::Customer.class_leaf_name # => 'Customer'
   def class_leaf_name
-    self.name[self.parent.name.length+2,self.name.length-self.parent.name.length-2]
+    name.split('::')[-1]
   end
 end
 
@@ -65,6 +67,16 @@ class Hash
     self
   end
 
+  def stringify_keys(specials={})
+    self.dup.stringify_keys!(specials)
+  end
+  def stringify_keys!(specials={})
+    self.each_key do |k|
+      self[specials.has_key?(k) ? specials[k] : k.to_s] = self.delete(k)
+    end
+    self
+  end
+
   def underscore_keys(specials={})
     self.dup.underscore_keys!(specials)
   end
@@ -116,29 +128,11 @@ class Hash
     self
   end
 
-  # Sets a static order for any group operations on the hash, specifically: keys, values, each, each_key, and each_value
-  def order!(*keys_in_order)
-    self.instance_variable_set('@keys_in_order', keys_in_order.flatten & self.keys) # (only the keys_in_order that are currently existing keys)
-    class << self
-      def keys
-        @keys_in_order
-      end
-      def values
-        self.keys.collect {|k| self[k]}
-      end
-      def each(&block)
-        self.keys.each do |k|
-          block.call(k, self[k])
-        end
-      end
-      def each_key(&block)
-        self.keys.each &block
-      end
-      def each_value(&block)
-        self.values.each &block
-      end
-    end
-    self
+  def reverse_merge(hsh)
+    hsh.dup.merge(self)
+  end
+  def reverse_merge!(hsh)
+    self.replace(hsh.merge(self))
   end
 
   def transform_keys(trans_hash)
@@ -169,7 +163,7 @@ class Array
     values.flatten!
     i = 0
     while i <= length-1 do
-      self[i].is_one_of?(values) ? i += 1 : self.slice!(i)
+      (self[i].is_one_of?(values) || collect[i].is_one_of?(values)) ? i += 1 : self.slice!(i)
     end
     self
   end
@@ -179,7 +173,7 @@ class Array
   end
   def camelize_values!(specials={})
     self.each_with_index do |v,i|
-      self[i] = specials.has_key?(v) ? specials[v] : (v.is_a?(Symbol) ? v.to_s.camelcase.to_sym : v.camelcase)
+      self[i] = specials.has_key?(v) ? specials[v] : (v.is_a?(Symbol) ? v.to_s.camelize.to_sym : v.camelize)
     end
     self
   end
@@ -191,3 +185,12 @@ class Array
     self.replace(ordered.flatten!.only!(self))
   end
 end
+
+class String
+  def underscore
+    gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
+  end
+  def camelize
+    gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+  end
+end