kashflow_api 0.0.3 → 0.1.0

data/lib/kashflow_api/models/invoice.rb

@@ -1,47 +1,49 @@
 module KashflowApi
     class Invoice < KashflowApi::SoapObject
-        def self.find(search)
-            result = KashflowApi.api.get_invoice(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_invoice_response][:get_invoice_result])
-        end
-        
-        def customer
-            KashflowApi::Customer.find_by_customer_id(self.customerid)
-        end
+      Keys = [
+        "InvoiceNumber", "InvoiceDate", "DueDate", "CustomerID", "CustomerReference", ["InvoiceDBID", "0"]
+      ]
         
-        def save
-            if @hash["InvoiceDBID"] == "0"
-                insert_invoice
-            else
-                update_invoice
-            end
+      Finds = [ "InvoiceNumber" ]
+    
+      KFObject = { singular: "invoice", plural: "invoices" }
+      
+      XMLKey = "InvoiceDBID"
+    
+      define_methods
+      
+      def self.build_arguments(action, object, field, argument)
+        if action == "get"
+          expects argument, String
+          return "<InvoiceNumber>#{argument}</InvoiceNumber>" if object == "invoice"
+        elsif action == "update" || action == "insert"
+          expects argument, KashflowApi::Invoice
+          return "<InvoiceID>#{argument.invoiceid}</InvoiceID><InvLine>#{argument.to_xml}</InvLine>" if field == "Line"
+          return "<InvoiceNumber>#{argument.invoicenumber}</InvoiceNumber><InvLine>#{argument.to_xml}</InvLine>" if field == "Number"
+          return "<Inv>#{argument.to_xml}</Inv>" if object == "invoice"
         end
+      end
+      
+      def customer
+        KashflowApi::Customer.find_by_customer_id(self.customerid)
+      end
         
-        def to_xml
-            xml = []
-            id_line = ""
-            @hash.keys.each do |key|
-                if key == "InvoiceDBID"
-                    id_line = "<#{key}>#{@hash[key]}</#{key}>" unless @hash[key] == "0"
-                else
-                    xml.push("<#{key}>#{@hash[key]}</#{key}>")
-                end
-            end
-            [id_line, xml.join].join
+      def save
+        if @hash["InvoiceDBID"] == "0"
+          insert_invoice
+        else
+          update_invoice
         end
+      end
         
-        private
+      private
         
-        def blank_object_hash
-            { "InvoiceNumber" => "", "InvoiceDate" => "", "DueDate" => "", "CustomerID" => "", "CustomerReference" => "", "InvoiceDBID" => "0" }
-        end
-        
-        def update_invoice
-            KashflowApi.api.update_invoice(self)
-        end
+      def update_invoice
+        KashflowApi.api.update_invoice(self)
+      end
 
-        def insert_invoice
-            KashflowApi.api.insert_invoice(self)
-        end
+      def insert_invoice
+        KashflowApi.api.insert_invoice(self)
+      end
     end
 end

data/lib/kashflow_api/models/line.rb

@@ -1,50 +1,56 @@
 module KashflowApi
     class Line < KashflowApi::SoapObject
-        def save
-            if @hash["ReceiptID"] != ""
-                insert_receipt_line
-            elsif @hash["InvoiceID"] != ""
-                insert_invoice_line
-            elsif @hash["InvoiceNumber"] != ""
-                insert_invoice_number_line
-            elsif @hash["ReceiptNumber"] != ""
-                insert_receipt_number_line    
-            end
+      Keys = [
+        "Quantity", "Description", "ChargeType", "VatAmount", "VatRate", "Rate", "ReceiptID", "InvoiceID", "InvoiceNumber", "ReceiptNumber"
+      ]
+      
+      Finds = []
+      
+      KFObject = {singular: "line", plural: "lines"}
+      
+      XMLKey = "LineID"
+      
+      def save
+        if @hash["ReceiptID"] != ""
+          insert_receipt_line
+        elsif @hash["InvoiceID"] != ""
+          insert_invoice_line
+        elsif @hash["InvoiceNumber"] != ""
+          insert_invoice_number_line
+        elsif @hash["ReceiptNumber"] != ""
+          insert_receipt_number_line    
         end
-        
-        def to_xml
-            xml = []
-            id_line = ""
-            @hash.keys.each do |key|
-                if key == "LineID"
-                    id_line = "<#{key}>#{@hash[key]}</#{key}>" unless @hash[key] == "0"
-                elsif key != "ReceiptID" && key != "InvoiceID" && @hash[key] != ""
-                    xml.push("<#{key}>#{@hash[key]}</#{key}>")
-                end
-            end
-            [id_line, xml.join].join
-        end
-        
-        private
-        
-        def blank_object_hash
-            {"Quantity" => "", "Description" => "", "ChargeType" => "", "VatAmount" => "", "VatRate" => "", "Rate" => "", "ReceiptID" => "", "InvoiceID" => "", "InvoiceNumber" => "", "ReceiptNumber" => "" }
+      end
+      
+      def to_xml
+        xml = []
+        id_line = ""
+        @hash.keys.each do |key|
+          if key == "LineID"
+            id_line = "<#{key}>#{@hash[key]}</#{key}>" unless @hash[key] == "0"
+          elsif key != "ReceiptID" && key != "InvoiceID" && @hash[key] != ""
+            xml.push("<#{key}>#{@hash[key]}</#{key}>")
+          end
         end
+        [id_line, xml.join].join
+      end
         
-        def insert_receipt_line
-            KashflowApi.api.insert_receipt_line(self)
-        end
+      private
+      
+      def insert_receipt_line
+        KashflowApi.api.insert_receipt_line(self)
+      end
         
-        def insert_invoice_line
-            KashflowApi.api.insert_invoice_line(self)
-        end
+      def insert_invoice_line
+        KashflowApi.api.insert_invoice_line(self)
+      end
         
-        def insert_invoice_number_line
-          KashflowApi.api.insert_invoice_line_with_invoice_number(self)
-        end
+      def insert_invoice_number_line
+        KashflowApi.api.insert_invoice_line_with_invoice_number(self)
+      end
         
-        def insert_receipt_number_line
-          KashflowApi.api.insert_receipt_line_from_number(self)
-        end
+      def insert_receipt_number_line
+        KashflowApi.api.insert_receipt_line_from_number(self)
+      end
     end
 end

data/lib/kashflow_api/models/nominal_code.rb

@@ -1,12 +1,13 @@
 module KashflowApi
     class NominalCode < KashflowApi::SoapObject  
-        def self.all
-            result = KashflowApi.api.get_nominal_codes
-            codes = []
-            result.hash[:envelope][:body][:get_nominal_codes_response][:get_nominal_codes_result][:nominal_code].each do |code|
-                codes.push(self.build_from_soap(code))
-            end
-            codes
-        end
+      Keys = [
+        "Code", "Name", "Debit", "Credit", "Balance"
+      ]
+      
+      Finds = []
+      
+      KFObject = { singular: "nominal_code", plural: "nominal_codes" }
+      
+      XMLKey = "NominalCodeID"
     end
 end

data/lib/kashflow_api/models/quote.rb

@@ -1,14 +1,18 @@
 module KashflowApi
-    class Quote < KashflowApi::Invoice
-        def self.find_by_id(search)
-            result = KashflowApi.api.get_quote_by_id(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_quote_by_id_response][:get_quote_by_id_result])
-        end
-        
-        private
-        
-        def blank_object_hash
-            {}.merge(KashflowApi::Quote.find_by_id("0").hash)
-        end
+  class Quote < KashflowApi::Invoice
+    
+    KFObject = {singular: "quote", plural: "quotes"}
+    
+    def self.build_arguments(action, object, field, argument)
+      if action == "get"
+        expects argument, String
+        return "<Quote#{field}>#{argument}</Quote#{field}>" if object == "quote"
+      elsif action == "update" || action == "insert"
+        expects argument, KashflowApi::Quote
+        return "<InvoiceID>#{argument.invoiceid}</InvoiceID><InvLine>#{argument.to_xml}</InvLine>" if field == "Line"
+        return "<InvoiceNumber>#{argument.invoicenumber}</InvoiceNumber><InvLine>#{argument.to_xml}</InvLine>" if field == "Number"
+        return "<Inv>#{argument.to_xml}</Inv>" if object == "quote"
+      end
     end
+  end
 end

data/lib/kashflow_api/models/receipt.rb

@@ -1,43 +1,41 @@
 module KashflowApi
-    class Receipt < KashflowApi::SoapObject
-            def self.find(search)
-                result = KashflowApi.api.get_receipt(search)
-                self.build_from_soap(result.hash[:envelope][:body][:get_receipt_response][:get_receipt_result])
-            end
-
-            def save
-                if @hash["InvoiceDBID"] == "0"
-                    insert_receipt
-                else
-                    update_receipt
-                end
-            end
-
-            def to_xml
-                xml = []
-                id_line = ""
-                @hash.keys.each do |key|
-                    if key == "InvoiceDBID"
-                        id_line = "<#{key}>#{@hash[key]}</#{key}>" unless @hash[key] == "0"
-                    else
-                        xml.push("<#{key}>#{@hash[key]}</#{key}>")
-                    end
-                end
-                [id_line, xml.join].join
-            end
-
-            private
+  class Receipt < KashflowApi::SoapObject
+    Keys = KashflowApi::Invoice::Keys
+    
+    Finds = KashflowApi::Invoice::Finds
+    
+    KFObject = { singular: "receipt", plural: "receipts" }
+    
+    XMLKey = "InvoiceDBID"
+    
+    def self.build_arguments(action, object, field, argument)
+      if action == "get"
+        expects argument, String
+        return "<ReceiptNumber>#{argument}</ReceiptNumber>" if object == "receipt"
+      elsif action == "update" || action == "insert"
+        expects argument, KashflowApi::Receipt
+        return "<ReceiptID>#{argument.receiptid}</ReceiptID><InvLine>#{argument.to_xml}</InvLine>" if field == "Line"
+        return "<ReceiptNumber>#{argument.invoicenumber}</ReceiptNumber><InvLine>#{argument.to_xml}</InvLine>" if field == "Number"
+        return "<Inv>#{argument.to_xml}</Inv>" if object == "receipt"
+      end
+    end
+    
+    def save
+      if @hash["InvoiceDBID"] == "0"
+        insert_receipt
+      else
+        update_receipt
+      end
+    end
 
-            def blank_object_hash
-                { "InvoiceNumber" => "", "InvoiceDate" => "", "DueDate" => "", "CustomerID" => "", "CustomerReference" => "", "InvoiceDBID" => "0" }
-            end
+    private
             
-            def update_receipt
-                KashflowApi.api.update_receipt(self)
-            end
+    def update_receipt
+      KashflowApi.api.update_receipt(self)
+    end
 
-            def insert_receipt
-                KashflowApi.api.insert_receipt(self)
-            end
+    def insert_receipt
+      KashflowApi.api.insert_receipt(self)
     end
+  end
 end

data/lib/kashflow_api/models/supplier.rb

@@ -1,62 +1,45 @@
 module KashflowApi
-    class Supplier < KashflowApi::SoapObject
-        def self.find(search)
-            self.find_by_supplier_code(search)
-        end
-        
-        def self.find_by_supplier_code(search)
-            result = KashflowApi.api.get_supplier(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_supplier_response][:get_supplier_result])
-        end
-        
-        def self.find_by_supplier_id(search)
-            result = KashflowApi.api.get_supplier_by_id(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_supplier_by_id_response][:get_supplier_by_id_result])
-        end
-        
-        def self.all
-            result = KashflowApi.api.get_suppliers
-            suppliers = []
-            result.hash[:envelope][:body][:get_suppliers_response][:get_suppliers_result][:supplier].each do |supplier|
-                suppliers.push self.build_from_soap supplier
-            end
-            suppliers.sort { |x, y| x.name <=> y.name }
-        end
-        
-        def save
-           if @hash["SupplierID"] == "0"
-               insert_supplier
-           else
-               update_supplier
-           end 
-        end
-        
-        def to_xml
-            xml = []
-            id_line = ""
-            @hash.keys.each do |key|
-                if key == "SupplierID"
-                    id_line = "<#{key}>#{@hash[key]}</#{key}>" unless @hash[key] == "0"
-                else
-                    xml.push("<#{key}>#{@hash[key]}</#{key}>")
-                end
-            end
-            [id_line, xml.join].join
-        end
-        
-        private
-        
-        def blank_object_hash
-            {"Code" => "", "Name" => "", "Contact" => "", "Telephone" => "", "Mobile" => "", "Fax" => "", "Email" => "", "Address1" => "", "Address2" => "",
-                "Address3" => "", "Address4" => "", "Postcode" => "", "Website" => "", "VATNumber" => "", "Notes" => ""}.merge(KashflowApi::Supplier.find("").hash)
-        end
-        
-        def update_supplier
-            KashflowApi.api.update_supplier(self)
-        end
+  class Supplier < KashflowApi::SoapObject
+    Keys = [
+      "Code", "Name", "Contact", "Telephone", "Mobile", "Fax", "Email", "Address1", "Address2", "Address3", "Address4", "Postcode", "Website", "VATNumber", "Notes"
+    ]
+    
+    Finds = [ "code", "id" ]
+    
+    KFObject = { singular: "supplier", plural: "suppliers" }
+    
+    XMLKey = "SupplierID"
+    
+    def self.build_arguments(action, object, field, argument)
+      if action == "get"
+        expects argument, String
+        return "<Supplier#{field}>#{argument}</Supplier#{field}>" if object == "supplier"
+        return "<#{field}>#{argument}</#{field}>" if object == "suppliers"
+      elsif action == "update"
+        expects argument, KashflowApi::Supplier
+        return "<sup>#{argument.to_xml}</sup>" if object == "supplier"
+      elsif action == "insert"
+        expects argument, KashflowApi::Supplier
+        return "<supl>#{argument.to_xml}</supl>" if object == "supplier"
+      end
+    end
+    
+    def save
+      if @hash["SupplierID"] == "0"
+        insert_supplier
+      else
+        update_supplier
+      end 
+    end
+      
+    private
+   
+    def update_supplier
+      KashflowApi.api.update_supplier(self)
+    end
         
-        def insert_supplier
-            KashflowApi.api.insert_supplier(self)
-        end
+    def insert_supplier
+      KashflowApi.api.insert_supplier(self)
     end
+  end
 end

data/lib/kashflow_api/soap_object.rb

@@ -1,40 +1,82 @@
 module KashflowApi
-    class SoapObject
-        attr_accessor :hash
-        
-        def initialize(hash = nil)
-            if hash
-                @hash = hash
-                build_field_hash
-            else
-                @hash = blank_object_hash
-                build_field_hash
-            end
-        end
+  class SoapObject
+    include Expects
+    
+    attr_reader :hash
+    
+    def initialize(hash = nil)
+      expects(hash, Hash) if hash
+      @hash = (hash || new_object_hash)
+      init_class
+    end
+    
+    def self.inherited(klass)
+      KashflowApi.add_soap_object(klass)
+    end
+    
+    def self.all
+      result = KashflowApi.api.send("get_#{self::KFObject[:plural]}".to_sym)
+      results = []
+      result.hash[:envelope][:body]["get_#{self::KFObject[:plural]}_response".to_sym]["get_#{self::KFObject[:plural]}_result".to_sym][self::KFObject[:singular].to_sym].each do |result|
+        results.push self.new result
+      end
+      return results
+    end
+    
+    def self.find(search)
+      self.send(find_method, search)
+    end
+    
+    def self.find_method
+      "find_by_#{self::Finds.first}".to_sym
+    end
+    
+    def self.define_methods
+      self::Finds.each do |find|
+        method_name = "find_by_#{find}".to_sym
+        result_name = find == self::Finds.first ? "get_#{self::KFObject[:singular]}" : "get_#{self::KFObject[:singular]}_by_#{find}"
         
-        def method_missing(method, set = nil)
-            if @fields.keys.include? method
-                @hash[@fields[method]]
-            elsif method.to_s.scan(/.$/).join == "="
-                if @fields.keys.include? method.to_s.gsub(/\=/,'').to_sym
-                    @hash[@fields[method.to_s.gsub(/\=/,'').to_sym]] = set
-                end
+        self.define_singleton_method(method_name, Proc.new { |search|
+          result = KashflowApi.api.send(result_name.to_sym, search)
+          hash = result.hash[:envelope][:body]["#{result_name}_response".to_sym]["#{result_name}_result".to_sym]
+          return self.new(hash)
+        })
+      end
+    end
+    
+    def to_xml
+        xml = []
+        id_line = ""
+        @hash.keys.each do |key|
+            if key == self.class::XMLKey
+                id_line = "<#{key}>#{@hash[key]}</#{key}>" unless @hash[key] == "0"
             else
-                super
+                xml.push("<#{key}>#{@hash[key]}</#{key}>")
             end
         end
+        [id_line, xml.join].join
+    end
         
-        def self.build_from_soap(hash)
-            self.new(hash)
+    private
+    
+    def new_object_hash
+      hash = {}
+      self.class::Keys.each do |key|
+        key = [*key]
+        hash[key.first] = (key.last == key.first ? "" : key.last )
+      end
+      return hash
+    end
+    
+    def init_class
+      @hash.keys.each do |key|
+        self.class.send(:define_method, key.downcase.to_sym) do
+          @hash[key]
         end
-        
-        private
-        
-        def build_field_hash
-            @fields = {}
-            @hash.keys.each do |key|
-                @fields[key.downcase.to_sym] = key
-            end
+        self.class.send(:define_method, "#{key.downcase}=".to_sym) do |set|
+          @hash[key] = set
         end
+      end
     end
+  end
 end