intacct_ruby_team 1.7.1

data/lib/intacct_ruby/exceptions/function_failure_exception.rb

@@ -0,0 +1,5 @@
+module IntacctRuby
+  module Exceptions
+    class FunctionFailureException < StandardError; end
+  end
+end

data/lib/intacct_ruby/exceptions/insufficient_credentials_exception.rb

@@ -0,0 +1,5 @@
+module IntacctRuby
+  module Exceptions
+    class InsufficientCredentialsException < StandardError; end
+  end
+end

data/lib/intacct_ruby/exceptions/unknown_function_type.rb

@@ -0,0 +1,5 @@
+module IntacctRuby
+  module Exceptions
+    class UnknownFunctionType < StandardError; end
+  end
+end

data/lib/intacct_ruby/function.rb

@@ -0,0 +1,92 @@
+require 'builder'
+require 'intacct_ruby/exceptions/unknown_function_type'
+
+module IntacctRuby
+  # a function to be sent to Intacct. Defined by a function type (e.g. :create),
+  # an object type, (e.g. :customer), and arguments.
+  class Function
+    ALLOWED_TYPES = %w(
+      readByQuery
+      read
+      readByName
+      create
+      update
+      delete
+    ).freeze
+
+    def initialize(function_type, object_type, arguments = {})
+      @function_type = function_type.to_s
+      @object_type = object_type.to_s
+      @arguments = arguments
+
+      validate_type!
+    end
+
+    def to_xml
+      xml = Builder::XmlMarkup.new
+
+      xml.function controlid: controlid do
+        xml.tag!(@function_type) do
+          xml.tag!(@object_type.upcase) do
+            xml << argument_xml(@arguments)
+          end
+        end
+      end
+
+      xml.target!
+    end
+
+    private
+
+    def timestamp
+      @timestamp ||= Time.now.utc.to_s
+    end
+
+    def controlid
+      "#{@function_type}-#{@object_type}-#{timestamp}"
+    end
+
+    def argument_xml(arguments_to_convert)
+      xml = Builder::XmlMarkup.new
+
+      arguments_to_convert.each do |key, value|
+        argument_key = key.to_s.upcase
+
+        xml.tag!(argument_key) do
+          xml << argument_value_as_xml(value)
+        end
+      end
+
+      xml.target!
+    end
+
+    def argument_value_as_xml(value)
+      case value
+      when Hash
+        argument_xml(value) # recursive case
+      when Array
+        argument_value_list_xml(value) # recursive case
+      else
+        value.to_s # end case
+      end
+    end
+
+    def argument_value_list_xml(array_of_hashes)
+      xml = Builder::XmlMarkup.new
+
+      array_of_hashes.each do |argument_hash|
+        xml << argument_xml(argument_hash)
+      end
+
+      xml.target!
+    end
+
+    def validate_type!
+      unless ALLOWED_TYPES.include?(@function_type)
+        raise Exceptions::UnknownFunctionType,
+              "Type #{@object_type} not recognized. Function Type must be " \
+              "one of #{ALLOWED_TYPES}."
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/base_function.rb

@@ -0,0 +1,48 @@
+require 'builder'
+
+module IntacctRuby
+  module Functions
+    # Creates the basic structure for all functions.
+    # Meant to be an interface: this should not be implemented on its own.
+    class BaseFunction
+      def initialize(controlid, attrs = {})
+        @controlid = controlid
+        @attrs = attrs
+
+        @xml = Builder::XmlMarkup.new
+      end
+
+      def to_xml
+        @to_xml ||= begin
+          @xml.function controlid: @controlid do
+            yield(@xml)
+          end
+
+          # converts xml to string
+          @xml.target!
+        end
+      end
+
+      private
+
+      def timestamp
+        @timestamp ||= Time.now.utc.to_s
+      end
+
+      def custom_field_params(custom_fields)
+        xml = Builder::XmlMarkup.new
+
+        xml.customfields do
+          custom_fields.each do |name, value|
+            xml.customfield do
+              xml.customfieldname   name.to_s
+              xml.customfieldvalue  value.to_s
+            end
+          end
+        end
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_aradjustment.rb

@@ -0,0 +1,48 @@
+require 'intacct_ruby/functions/base_function'
+require 'intacct_ruby/helpers/date_helper'
+
+module IntacctRuby
+  module Functions
+    # creates ar adjustment instance in Intacct
+    class CreateARAdjustment < BaseFunction
+      include DateHelper
+
+      def initialize(attrs = {})
+        super "create_aradjustment (Customer \##{attrs[:customerid]}, " \
+              "(#{timestamp})", attrs
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_aradjustment do
+            xml.customerid @attrs[:customerid]
+
+            xml << date_params(:datecreated, @attrs[:datecreated])
+
+            xml.description @attrs[:description]
+
+            xml.aradjustmentitems do
+              xml << line_item_params(@attrs[:aradjustmentitems])
+            end
+          end
+        end
+      end
+
+      private
+
+      def line_item_params(adjustment_item_attrs)
+        xml = Builder::XmlMarkup.new
+
+        adjustment_item_attrs.each do |item_params|
+          xml.lineitem do
+            [:glaccountno, :amount, :memo, :locationid].each do |param_key|
+              xml.tag!(param_key) { xml << item_params[param_key].to_s }
+            end
+          end
+        end
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_customer.rb

@@ -0,0 +1,23 @@
+require 'intacct_ruby/helpers/contacts_helper'
+require 'intacct_ruby/functions/customer_base_function'
+
+module IntacctRuby
+  module Functions
+    # function that creates customer instance
+    class CreateCustomer < CustomerBaseFunction
+      def initialize(attrs = {})
+        super "create_customer_#{attrs[:customerid]}", attrs
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_customer do
+            xml.customerid @attrs[:customerid]
+
+            xml << customer_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_employee.rb

@@ -0,0 +1,21 @@
+require 'intacct_ruby/functions/employee_base_function'
+
+module IntacctRuby
+  module Functions
+    # Function that creates an employee instance in Intacct
+    class CreateEmployee < EmployeeBaseFunction
+      def initialize(attrs = {})
+        super("create_employee_#{attrs[:employeeid]}", attrs)
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_employee do
+            xml.employeeid @attrs[:employeeid]
+            xml << employee_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_gltransaction.rb

@@ -0,0 +1,28 @@
+require 'intacct_ruby/functions/gltransaction_base_function'
+require 'intacct_ruby/helpers/date_helper'
+
+module IntacctRuby
+  module Functions
+    # creates gltransaction instance in Intacct
+    class CreateGLTransaction < GLTransactionBaseFunction
+      include DateHelper
+
+      def initialize(attrs = {})
+        super "create_gltransaction (#{attrs[:description]} #{timestamp})",
+              attrs
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_gltransaction do
+            xml << gltransaction_header_params(@attrs)
+
+            xml.gltransactionentries do
+              xml << gltransactionentry_params(@attrs[:gltransactionentries])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_item.rb

@@ -0,0 +1,21 @@
+require 'intacct_ruby/functions/item_base_function'
+
+module IntacctRuby
+  module Functions
+    # creates an item instance in Intacct
+    class CreateItem < ItemBaseFunction
+      def initialize(attrs = {})
+        super "create_item_#{attrs[:itemid]}", attrs
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_item do
+            xml.itemid @attrs[:itemid]
+            xml << item_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_location.rb

@@ -0,0 +1,21 @@
+require 'intacct_ruby/functions/location_base_function'
+
+module IntacctRuby
+  module Functions
+    # Function that creates a location instance in Intacct
+    class CreateLocation < LocationBaseFunction
+      def initialize(attrs = {})
+        super("create_location_#{attrs[:locationid]}", attrs)
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_location do
+            xml.locationid @attrs[:locationid]
+            xml << location_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_project.rb

@@ -0,0 +1,20 @@
+require 'intacct_ruby/functions/project_base_function'
+
+module IntacctRuby
+  module Functions
+    # creates a project instance in Intacct
+    class CreateProject < ProjectBaseFunction
+      def initialize(attrs = {})
+        super("create_project_#{attrs[:projectid]}", attrs)
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_project do
+            xml << project_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/create_statgltransaction.rb

@@ -0,0 +1,28 @@
+require 'intacct_ruby/functions/gltransaction_base_function'
+require 'intacct_ruby/helpers/date_helper'
+
+module IntacctRuby
+  module Functions
+    # creates gltransaction instance in Intacct
+    class CreateStatGLTransaction < GLTransactionBaseFunction
+      include DateHelper
+
+      def initialize(attrs = {})
+        super "create_statgltransaction (#{attrs[:description]} #{timestamp})",
+              attrs
+      end
+
+      def to_xml
+        super do |xml|
+          xml.create_statgltransaction do
+            xml << gltransaction_header_params(@attrs)
+
+            xml.statgltransactionentries do
+              xml << gltransactionentry_params(@attrs[:statgltransactionentries])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/customer_base_function.rb

@@ -0,0 +1,27 @@
+require 'intacct_ruby/functions/base_function'
+require 'intacct_ruby/helpers/contacts_helper'
+
+module IntacctRuby
+  module Functions
+    # the parent for all customer-related functions. Includes methods that
+    # cut down on duplicate code
+    class CustomerBaseFunction < BaseFunction
+      include ContactsHelper
+
+      private
+
+      def customer_params
+        xml = Builder::XmlMarkup.new
+
+        xml.name full_name(@attrs)
+        xml.custrepid @attrs[:custrepid]
+        xml.status @attrs[:status]
+        xml.contactinfo do
+          xml << contact_params(@attrs, @attrs[:customerid], 'Customer')
+        end
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/employee_base_function.rb

@@ -0,0 +1,36 @@
+require 'intacct_ruby/helpers/contacts_helper'
+require 'intacct_ruby/helpers/date_helper'
+require 'intacct_ruby/functions/base_function'
+
+module IntacctRuby
+  module Functions
+    # contains code shared by all employee functions
+    class EmployeeBaseFunction < BaseFunction
+      include IntacctRuby::ContactsHelper
+      include IntacctRuby::DateHelper
+
+      private
+
+      def employee_params
+        xml = Builder::XmlMarkup.new
+
+        xml.locationid   @attrs[:locationid]
+        xml.supervisorid @attrs[:supervisorid]
+
+        xml << start_date_params
+
+        xml.status @attrs[:status]
+
+        xml.personalinfo do
+          xml << employee_contact_params
+        end
+
+        xml.target!
+      end
+
+      def employee_contact_params
+        contact_params(@attrs, @attrs[:employeeid], 'Employee')
+      end
+    end
+  end
+end