intacct_ruby_team 1.7.1

data/lib/intacct_ruby/functions/gltransaction_base_function.rb

@@ -0,0 +1,64 @@
+require 'intacct_ruby/functions/base_function'
+require 'intacct_ruby/helpers/date_helper'
+
+module IntacctRuby
+  module Functions
+    # creates gltransaction instance in Intacct
+    class GLTransactionBaseFunction < BaseFunction
+      include DateHelper
+
+      private
+
+      def gltransaction_header_params(attributes)
+        xml = Builder::XmlMarkup.new
+
+        xml << extract_from_attrs(attributes, :journalid)
+        xml << date_params(:datecreated, attributes[:datecreated])
+        xml << extract_from_attrs(attributes, :description)
+
+        xml.target!
+      end
+
+      def gltransactionentry_params(transaction_entries)
+        xml = Builder::XmlMarkup.new
+
+        transaction_entries.each do |entry_attrs|
+          xml << glentry_params(entry_attrs)
+        end
+
+        xml.target!
+      end
+
+      def glentry_params(attrs)
+        xml = Builder::XmlMarkup.new
+
+        xml.glentry do
+          xml << extract_from_attrs(attrs, :trtype, :amount, :glaccountno)
+          xml << date_params(:datecreated, attrs[:datecreated])
+          xml << extract_from_attrs(
+            attrs,
+            :memo,
+            :locationid,
+            :customerid,
+            :employeeid,
+            :projectid,
+            :itemid
+          )
+        end
+
+        xml.target!
+      end
+
+      def extract_from_attrs(attributes_hash, *keys)
+        xml = Builder::XmlMarkup.new
+
+        keys.each do |key|
+          value = attributes_hash[key]
+          xml.tag!(key) { xml << value.to_s } if value
+        end
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/item_base_function.rb

@@ -0,0 +1,29 @@
+require 'intacct_ruby/functions/base_function'
+
+module IntacctRuby
+  module Functions
+    # function that all item functions are built off of, to decreate dupe code
+    class ItemBaseFunction < BaseFunction
+      ALL_PARAMS = [
+        :name,
+        :itemtype,
+        :extended_description,
+        :productlineid,
+        :standard_cost,
+        :glgroup,
+        :uomgrp
+      ].freeze
+
+      def item_params
+        xml = Builder::XmlMarkup.new
+
+        ALL_PARAMS.each do |param_name|
+          param_value = @attrs[param_name]
+          xml.tag!(param_name) { xml << param_value } if param_value
+        end
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/location_base_function.rb

@@ -0,0 +1,24 @@
+require 'intacct_ruby/functions/base_function'
+require 'intacct_ruby/helpers/date_helper'
+
+module IntacctRuby
+  module Functions
+    # base for all location-related functions, to cut down on duplicate code
+    class LocationBaseFunction < BaseFunction
+      include IntacctRuby::DateHelper
+
+      private
+
+      def location_params
+        xml = Builder::XmlMarkup.new
+
+        xml.name     @attrs[:name]
+        xml.parentid @attrs[:parentid]
+
+        xml << start_date_params
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/project_base_function.rb

@@ -0,0 +1,22 @@
+require 'intacct_ruby/functions/base_function'
+
+module IntacctRuby
+  module Functions
+    # contains shared code for creating and updating projects
+    class ProjectBaseFunction < BaseFunction
+      private
+
+      def project_params
+        xml = Builder::XmlMarkup.new
+
+        [:projectid, :name, :projectcategory, :customerid].each do |key|
+          xml.tag!(key.to_s) { xml << @attrs[key].to_s }
+        end
+
+        xml << custom_field_params(@attrs[:customfields])
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/update_customer.rb

@@ -0,0 +1,22 @@
+require 'intacct_ruby/functions/customer_base_function'
+
+module IntacctRuby
+  module Functions
+    # update customer instance
+    class UpdateCustomer < CustomerBaseFunction
+      include ContactsHelper
+
+      def initialize(attrs = {})
+        super "update_customer_#{attrs[:customerid]} (#{timestamp})", attrs
+      end
+
+      def to_xml
+        super do |xml|
+          xml.update_customer customerid: @attrs[:customerid] do
+            xml << customer_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/update_employee.rb

@@ -0,0 +1,20 @@
+require 'intacct_ruby/functions/employee_base_function'
+
+module IntacctRuby
+  module Functions
+    # function used to update employee instances
+    class UpdateEmployee < EmployeeBaseFunction
+      def initialize(attrs = {})
+        super("update_employee_#{attrs[:employeeid]} (#{timestamp})", attrs)
+      end
+
+      def to_xml
+        super do |xml|
+          xml.update_employee employeeid: @attrs[:employeeid] do
+            xml << employee_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/update_item.rb

@@ -0,0 +1,20 @@
+require 'intacct_ruby/functions/item_base_function'
+
+module IntacctRuby
+  module Functions
+    # updates item instance in Intacct
+    class UpdateItem < ItemBaseFunction
+      def initialize(attrs = {})
+        super "update_item_#{attrs[:itemid]} (#{timestamp})", attrs
+      end
+
+      def to_xml
+        super do |xml|
+          xml.update_item itemid: @attrs[:itemid] do
+            xml << item_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/update_location.rb

@@ -0,0 +1,20 @@
+require 'intacct_ruby/functions/location_base_function'
+
+module IntacctRuby
+  module Functions
+    # used to update location instances in Intacct
+    class UpdateLocation < LocationBaseFunction
+      def initialize(attrs = {})
+        super("update_location_#{attrs[:locationid]} (#{timestamp})", attrs)
+      end
+
+      def to_xml
+        super do |xml|
+          xml.update_location locationid: @attrs[:locationid] do
+            xml << location_params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/intacct_ruby/functions/update_project.rb

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

data/lib/intacct_ruby/helpers/contacts_helper.rb

@@ -0,0 +1,32 @@
+module IntacctRuby
+  # methods to avoid duplication when creating and updating contact records
+  module ContactsHelper
+    def contact_params(attributes, id, person_type)
+      xml = Builder::XmlMarkup.new
+
+      name = full_name(attributes)
+
+      xml.contact do
+        xml.contactname contactname(name, id, person_type)
+        xml.printas     full_name(attributes)
+        xml.firstname   attributes[:first_name]
+        xml.lastname    attributes[:last_name]
+        xml.email1      attributes[:email1]
+      end
+
+      xml.target!
+    end
+
+    def contactname(name, id, person_type)
+      # a unique identifier for a contact, to be used for Intacct's
+      # contactname field. Person Type required to ensure that there aren't
+      # duplicates (e.g. a customer and employee w/ ID 1 both named
+      # 'John Smith')
+      "#{name} (#{person_type} \##{id})"
+    end
+
+    def full_name(attrs = {})
+      "#{attrs[:first_name]} #{attrs[:last_name]}"
+    end
+  end
+end

data/lib/intacct_ruby/helpers/date_helper.rb

@@ -0,0 +1,22 @@
+require 'builder'
+
+module IntacctRuby
+  # methods to help generate date XML for calls
+  module DateHelper
+    def date_params(block_name, attrs = {})
+      xml = Builder::XmlMarkup.new
+
+      xml.tag!(block_name) do
+        xml.year  attrs[:year]
+        xml.month attrs[:month]
+        xml.day   attrs[:day]
+      end
+    end
+
+    # Note: @attrs[:startdate] MUST be defined in the invoking context for this
+    # bad boy to work
+    def start_date_params
+      date_params :startdate, @attrs[:startdate]
+    end
+  end
+end

data/lib/intacct_ruby/request.rb

@@ -0,0 +1,138 @@
+require 'builder'
+
+require 'intacct_ruby/api'
+require 'intacct_ruby/response'
+require 'intacct_ruby/function'
+
+require 'intacct_ruby/exceptions/insufficient_credentials_exception'
+require 'intacct_ruby/exceptions/empty_request_exception'
+
+module IntacctRuby
+  # An outgoing request to the Intacct API. Can have multiple functions.
+  # Complete with send method that gets (and wraps) response from Intacct.
+  class Request
+    attr_reader :functions
+
+    DEFAULTS = {
+      uniqueid: false,
+      dtdversion: 3.0,
+      includewhitespace: false,
+      transaction: true
+    }.freeze
+
+    REQUIRED_AUTHENTICATION_KEYS = [
+      :senderid,
+      :sender_password,
+      :userid,
+      :companyid,
+      :user_password
+    ].freeze
+
+    def initialize(*functions, request_params)
+      # request_params should contain all req'd authentication information. If
+      # not, an error will be thrown on #send
+      @opts = DEFAULTS.dup.merge request_params
+
+      # If a hash is provided + popped, the remaining attrs are functions
+      @functions = functions
+    end
+
+    def to_xml
+      @to_xml ||= begin
+        @request = Builder::XmlMarkup.new
+
+        @request.instruct!
+        @request.request do
+          control_block
+          operation_block
+        end
+      end
+    end
+
+    def send(opts = {})
+      if opts.is_a? Hash
+        api = opts[:api] || Api.new
+
+        validate_keys!
+        validate_functions!
+
+        Response.new api.send_request(self)
+      else
+        # so that Request#send can play nice alongside Object#send
+        super
+      end
+    end
+
+    private
+
+    def method_missing(method_name, *arguments, &block)
+      super unless Function::ALLOWED_TYPES.include? method_name.to_s
+
+      # object_type must be the first argument in arguments
+      @functions << Function.new(method_name, arguments.shift, *arguments)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      Function::ALLOWED_TYPES.include?(method_name) || super
+    end
+
+    def validate_functions!
+      unless functions.any?
+        raise Exceptions::EmptyRequestException,
+              'a successful request must contain at least one function'
+      end
+    end
+
+    def validate_keys!
+      missing_keys = REQUIRED_AUTHENTICATION_KEYS - @opts.keys
+
+      unless missing_keys.empty?
+        missing_keys.map! { |s| ":#{s}" } # so they appear as symbols in output
+
+        raise Exceptions::InsufficientCredentialsException,
+              "[#{missing_keys.join(', ')}] required for a valid request. "
+              'All authentication-related keys should be provided on ' \
+              'instantiation in IntacctRuby::Request#new'
+      end
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.utc.to_s
+    end
+
+    def control_block
+      @request.control do
+        @request.senderid @opts[:senderid]
+        @request.password @opts[:sender_password]
+
+        # As recommended by Intacct API reference. This ID should be unique
+        # to the call: it's used to associate a response with a request.
+        @request.controlid          timestamp
+        @request.uniqueid           @opts[:uniqueid]
+        @request.dtdversion         @opts[:dtdversion]
+        @request.includewhitespace  @opts[:includewhitespace]
+      end
+    end
+
+    def authentication_block
+      @request.authentication do
+        @request.login do
+          @request.userid    @opts[:userid]
+          @request.companyid @opts[:companyid]
+          @request.password  @opts[:user_password]
+        end
+      end
+    end
+
+    def operation_block
+      @request.operation transaction: @opts[:transaction] do
+        authentication_block
+        @request.content do
+          functions.each do |function|
+            @request << function.to_xml
+          end
+        end
+      end
+    end
+  end
+end