intacct_ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d42a536100b60ef09ae692e1ca89d06cf8842684
+  data.tar.gz: 451891434ad91b2f70873d30c64a790170c733a6
+SHA512:
+  metadata.gz: 9dbd0f7d721c24e1eca287937f417f22ad9b204d6d77a6e17286188982d808a531805a77ccd3cb8ec29c974197423d27959947b68f390b9bcd9110c711d3de69
+  data.tar.gz: b75ce4f70c468cce6fd67bf715a4daa75bfd004389fc5752f84d792ca1707c7257c6bf4bcfbbfb2b821dad078381233b73d42cdf3fd4bbab97d386681d480625

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeremy@zornow.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in intacct_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeremy Zornow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,173 @@
+[ ![Codeship Status for jzornow/intacct-ruby](https://app.codeship.com/projects/161bbcb0-037f-0135-febb-660dbc75d940/status?branch=master)](https://app.codeship.com/projects/213338)
+
+# IntacctRuby
+
+A wrapper for [Intacct's API](https://developer.intacct.com/wiki/functions-object), which tries to stay as close as it can to the syntax and philosophy of the API itself.
+
+## The Power of Multi-Function Api Calls
+Unlike the other Gems out in the Rubyverse, this library supports one of the Intacct API's most powerful features: multi-function API calls.
+
+### Why Does This Matter?
+In an ERP system like Intacct, you'll probably want to perform multiple actions at once, like debiting one account and crediting another, or creating several associated records simulatenously. The more calls you make, the longer it will take to see a response. That's just a fact. But if you can bundle all of those actions together into a single call, you lower the load on both your system and Intacct's servers and guarantee yourself a quicker response. Intacct's entire API is built around this idea, and `IntacctRuby` tries to translate that philosophy into Ruby code as best as it can.
+
+### How Do It Do?
+Let's say you want to create a project and a customer associated with that project simultaneously. The Intacct API would tell you to create a call with a `<create_customer>` function followed by a `<create_project>` function. So let's do it!
+
+```ruby
+create_customer = IntacctRuby::Functions::CreateCustomer.new(
+  customerid: '1',
+  first_name: 'Han',
+  last_name: 'Solo',
+  type: 'Person',
+  email1: 'han@solo.com',
+  status: 'active'
+)
+
+create_project = IntacctRuby::Functions::CreateProject.new(
+  projectid: '1',
+  name: 'Get Chewie a Haircut',
+  projectcategory: 'Improve Wookie Hygene',
+  customerid: '1',
+  customfields: {
+    shampoo: 'true',
+    blowdry: 'false'
+  }
+)
+
+request = IntacctRuby::Request.new(create_customer, create_project)
+request.send
+```
+
+This will fire off a request that looks something like this:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<request>
+   <control>
+      ** omitted **
+   </control>
+   <operation transaction="true">
+      <authentication>
+         ** omitted **
+      </authentication>
+      <content>
+         <function controlid="create_customer_1">
+            <create_customer>
+               <customerid>1</customerid>
+               <name>Han Solo</name>
+               <status>active</status>
+               <contactinfo>
+                  <contact>
+                     <contactname>Han Solo (Customer #1)</contactname>
+                     <printas>Han Solo</printas>
+                     <firstname>Han</firstname>
+                     <lastname>Solo</lastname>
+                     <email1>han@solo.com</email1>
+                  </contact>
+               </contactinfo>
+            </create_customer>
+         </function>
+         <function controlid="create_project_1">
+            <create_project>
+               <projectid>1</projectid>
+               <name>Get Chewie a Haircut</name>
+               <projectcategory>Improve Wookie Hygene</projectcategory>
+               <customerid>1</customerid>
+               <customfields>
+                  <customfield>
+                     <customfieldname>shampoo</customfieldname>
+                     <customfieldvalue>true</customfieldvalue>
+                  </customfield>
+                  <customfield>
+                     <customfieldname>blowdry</customfieldname>
+                     <customfieldvalue>false</customfieldvalue>
+                  </customfield>
+               </customfields>
+            </create_project>
+         </function>
+      </content>
+   </operation>
+</request>
+```
+If there are function errors (e.g. you omitted a required field) you'll see an error on response. Same if you see an internal server error, or any error outside of the 2xx range.
+
+## Customizing Calls
+
+Before we go any further, make sure you've read the [Intacct API Quickstart Guide](https://developer.intacct.com/wiki/constructing-web-services-request#The%20Intacct%20DTDs).
+
+This gem creates calls using the following defaults:
+- **uniqueid:** false,
+- **dtdversion:** 3.0,
+- **includewhitespace:** false,
+- **transaction:** true
+
+If you'd like to override any of these, you can do so when you create a new request:
+
+```ruby
+IntacctRuby::Request.new(
+  function_1,
+  function_2,
+  uniqueid: 'some_uniqueid_override',
+  dtdversion: 'some_dtd_override'
+)
+```
+## Installation
+
+### The Gem Itself
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'intacct_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install intacct_ruby
+
+### The Configuration (Don't Skip This Part!)
+Once the gem's in place, you'll have it teach it your company secrets.
+
+Intacct requires that the following credentials be passed along in the `<control>` block of each request:
+- `senderid`
+- (sender) `password`
+
+and that the following be sent in the `<authentication>` block, too:
+- `userid`
+- `companyid`
+- `password`
+
+IntacctRuby handles all this for you, but you'll need to tell it which is which. The gem pulls these values from Environmental variables, and it uses [Figaro](https://github.com/laserlemon/figaro) to manage the whole process. In order to get this to work, you'll need to have an `application.yml` file in your project directory with the following definitions:
+```yaml
+intacct_senderid:         'some senderid'
+intacct_sender_password:  'some password'
+intacct_userid:           'some userid'
+intacct_user_password:    'some password'
+intacct_companyid:        'some companyid'
+```
+Once those are in place, IntacctRuby will suck 'em up and deposit them in the requests that you generate. Eeeasy squeezey.
+
+## Adding New Functions
+This gem was designed, as so many are, for a specific use case. The Intacct API has hundreds of API calls, though I only built out a dozen or so. Within that dozen, I only built out the fields that I needed in each call.
+
+I know what you're thinking:
+**You dweeb! Why didn't make the stuff that I need, too?**
+
+I didn't, because I have full confidence in your ability to do it yourself. These calls are easy to construct, and they almost perfectly mirror the structure of the XML shown in Intacct's API documentation. You can figure it out! You're a developer, for shirt's sake.
+
+If you're interested, feel free to reach out to me for information on how to build or improve the functions that are already present in this gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jzornow/intacct-ruby/.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'intacct_ruby'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/intacct_ruby.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'intacct_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'intacct_ruby'
+  spec.version               = IntacctRuby::VERSION
+  spec.authors               = ['Jeremy Zornow']
+  spec.email                 = ['jeremy@zornow.com']
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.summary               = 'A Ruby wrapper for the Intacct API'
+  spec.description           = 'Allows for multi-function API calls, the ' \
+                               'addition of custom fields, and more. All in ' \
+                               'an easy-to-use package!'
+  spec.homepage              = 'https://github.com/jzornow/intacct-ruby'
+  spec.license               = 'MIT'
+
+  spec.files                 = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
+  spec.add_development_dependency 'mocha', '~> 0.13.3'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4', '>= 3.4.2'
+
+  spec.add_runtime_dependency 'builder', '~> 3.0', '>= 3.0.4'
+  spec.add_runtime_dependency 'figaro', '~> 1.1', '>= 1.1.1'
+end

data/lib/intacct_ruby.rb

@@ -0,0 +1,24 @@
+require 'intacct_ruby/api'
+require 'intacct_ruby/version'
+
+require 'intacct_ruby/request'
+require 'intacct_ruby/response'
+
+require 'intacct_ruby/functions/base_function'
+
+require 'intacct_ruby/functions/create_customer'
+require 'intacct_ruby/functions/update_customer'
+
+require 'intacct_ruby/functions/create_project'
+require 'intacct_ruby/functions/update_project'
+
+require 'intacct_ruby/functions/create_employee'
+require 'intacct_ruby/functions/update_employee'
+
+require 'intacct_ruby/functions/create_location'
+require 'intacct_ruby/functions/update_location'
+
+require 'intacct_ruby/functions/create_item'
+require 'intacct_ruby/functions/update_item'
+
+require 'intacct_ruby/functions/create_aradjustment'

data/lib/intacct_ruby/api.rb

@@ -0,0 +1,31 @@
+module IntacctRuby
+  # the gateway by which IntacctRuby::Request instances are sent off to Intacct
+  class Api
+    def initialize(http_gateway = nil)
+      @http_gateway = http_gateway
+    end
+
+    def send(request_object, post_request = nil)
+      post_request ||= Net::HTTP::Post.new(uri.request_uri)
+
+      post_request['Content-Type'] = 'x-intacct-xml-request'
+      post_request.body = request_object.to_xml
+
+      https_request(post_request, uri)
+    end
+
+    private
+
+    URI_STRING = 'https://api.intacct.com/ia/xml/xmlgw.phtml'.freeze
+
+    def uri
+      @uri ||= URI.parse URI_STRING
+    end
+
+    def https_request(request, uri)
+      @http_gateway ||= Net::HTTP.new uri.host, uri.port
+      @http_gateway.use_ssl = true
+      @http_gateway.request request
+    end
+  end
+end

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/functions/base_function.rb

@@ -0,0 +1,46 @@
+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
+        @xml.function controlid: @controlid do
+          yield(@xml)
+        end
+
+        # converts xml to string
+        @xml.target!
+      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