intacct_ruby 0.2.0

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,88 @@
+require 'builder'
+require 'figaro'
+
+require 'intacct_ruby/api'
+require 'intacct_ruby/response'
+
+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
+    DEFAULTS = {
+      uniqueid: false,
+      dtdversion: 3.0,
+      includewhitespace: false,
+      transaction: true
+    }.freeze
+
+    def initialize(*args)
+      @opts = DEFAULTS.dup
+
+      # `args` should be a list of Intacct::Function objects, with the last
+      # argument optionally providing overrides to request defaults
+      @opts.merge!(args.pop) if args.last.is_a? Hash
+
+      # If a hash is provided + popped, the remaining attrs are functions
+      @functions = args
+    end
+
+    def to_xml
+      @request = Builder::XmlMarkup.new
+
+      request.instruct!
+      request.request do
+        control_block
+        operation_block
+      end
+    end
+
+    def send(api = nil)
+      api ||= Api.new
+
+      Response.new api.send(self)
+    end
+
+    private
+
+    attr_reader :request, :functions
+
+    def timestamp
+      @timestamp ||= Time.now.utc.to_s
+    end
+
+    def control_block
+      request.control do
+        request.senderid Figaro.env.intacct_senderid
+        request.password Figaro.env.intacct_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    Figaro.env.intacct_userid
+          request.companyid Figaro.env.intacct_companyid
+          request.password  Figaro.env.intacct_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

data/lib/intacct_ruby/response.rb

@@ -0,0 +1,43 @@
+require 'nokogiri'
+require 'intacct_ruby/exceptions/function_failure_exception'
+
+module IntacctRuby
+  # Wraps an XML API response, throwing an exception if the call was unsucessful
+  #
+  # This class *can* be instantiated on its own, but only in cases where the
+  # contents of the response (e.g. generated keys, query results) aren't
+  # important.
+  #
+  # If, for example, a key returned needs to be extracted from the response,
+  # extend this class and add methods that access whatever data is required.
+  class Response
+    attr_reader :response_body
+
+    def initialize(xml_response)
+      @response_body = Nokogiri::XML(xml_response.body)
+
+      # raises an error unless the response is in the 2xx range.
+      xml_response.value
+
+      # in case the response is a success, but one of the included functions
+      # failed and the transaction was rolled back
+      raise_function_errors unless transaction_successful?
+    end
+
+    def function_errors
+      @function_errors ||= @response_body.xpath('//error/description2')
+                                         .map(&:text)
+    end
+
+    private
+
+    def transaction_successful?
+      function_errors.none?
+    end
+
+    def raise_function_errors
+      raise Exceptions::FunctionFailureException,
+            function_errors.join("\n")
+    end
+  end
+end

data/lib/intacct_ruby/version.rb

@@ -0,0 +1,3 @@
+module IntacctRuby
+  VERSION = '0.2.0'.freeze
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: intacct_ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jeremy Zornow
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: figaro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: Allows for multi-function API calls, the addition of custom fields, and
+  more. All in an easy-to-use package!
+email:
+- jeremy@zornow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- intacct_ruby.gemspec
+- lib/intacct_ruby.rb
+- lib/intacct_ruby/api.rb
+- lib/intacct_ruby/exceptions/function_failure_exception.rb
+- lib/intacct_ruby/functions/base_function.rb
+- lib/intacct_ruby/functions/create_aradjustment.rb
+- lib/intacct_ruby/functions/create_customer.rb
+- lib/intacct_ruby/functions/create_employee.rb
+- lib/intacct_ruby/functions/create_item.rb
+- lib/intacct_ruby/functions/create_location.rb
+- lib/intacct_ruby/functions/create_project.rb
+- lib/intacct_ruby/functions/customer_base_function.rb
+- lib/intacct_ruby/functions/employee_base_function.rb
+- lib/intacct_ruby/functions/item_base_function.rb
+- lib/intacct_ruby/functions/location_base_function.rb
+- lib/intacct_ruby/functions/project_base_function.rb
+- lib/intacct_ruby/functions/update_customer.rb
+- lib/intacct_ruby/functions/update_employee.rb
+- lib/intacct_ruby/functions/update_item.rb
+- lib/intacct_ruby/functions/update_location.rb
+- lib/intacct_ruby/functions/update_project.rb
+- lib/intacct_ruby/helpers/contacts_helper.rb
+- lib/intacct_ruby/helpers/date_helper.rb
+- lib/intacct_ruby/request.rb
+- lib/intacct_ruby/response.rb
+- lib/intacct_ruby/version.rb
+homepage: https://github.com/jzornow/intacct-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Intacct API
+test_files: []