intacct_ruby 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ca274310bbba02e3f4b67129889e3f4637f8e3b
-  data.tar.gz: 7ded8a9810638848329bb04915d737f6f651a5bc
+  metadata.gz: 94288978f189f8f67b07129def8ad0d71f711b98
+  data.tar.gz: 22898d8bb78457506c557cd53834fb1c70186e1b
 SHA512:
-  metadata.gz: 78356517fa12e7491017be5e2edc1fbadf997e412c3c10db258309ce4c607ad03b2cd70bb3e6795a300b88fc8b1ecc97f493b683ed21cee0d087d5c0921520a7
-  data.tar.gz: 287d025755f77bdff9e7e624158cecec13598dfe24acac78e6b7da66dadd286bfd9ad55aa561069cd5cb0f9cd185f33dc14f6bf8e224ce47a2fee860456fe6f1
+  metadata.gz: c245c5bac43937e578dbe42d8638e54eb5befd9813abed0be88b1b65c02668ac6d89d33386c4b35b3006cb4483fceb244a2b9c433848d39b36b1b280a1b52bca
+  data.tar.gz: fd5b9fafbf8bb15f34d027682ad3b15c1788950f41c9250cf2f20348ed411fcfac440cbb84fab68b3cedaad33c65a8bec4bd1b3145eb29a14976b5fe12761748

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Expected Behavior
+
+[Please give a detailed explanation of what you expected to happen. Include relevant links to the supporting Intacct documentation and code snippets as appropriate.]
+
+### Actual Behavior
+
+[Please give a detailed explanation of what actually happens. Include code snippets as appropriate.]
+
+### Steps to reproduce
+
+[Please give a walkthrough of the steps that got you to the problem. Include a link to a public gist/repo, an inline code sample, or a failing test!]

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+### Contributor Self-Check:
+
+* [ ] My commits and messages [are solid](https://chris.beams.io/posts/git-commit/)
+* [ ] I have included tests that check success and failure
+* [ ] I have updated the README as appropriate
+
+### Which GitHub Issues does this PR address?
+
+[Copy/paste or search for your issue number by typing #]
+
+### What does this PR do?
+
+[Describe the problem and/or circumstances that lead to this PR. If this information is already laid out in the issue that you've linked, just copy/paste any necessary background info.]
+
+### How do I manually test this?
+
+[Detail is key! It might even be nice to set up some sample data for your tester.]
+
+### Additional Comments
+
+[This section is optional. Use it to give the maintainers a "heads ups!" about the code you've written.]
+
+### GIF for how this PR makes me feel
+
+![](GIF_URL)

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.2.9
+- 2.3.6
+- 2.4.3
+- 2.5.0
+script:
+- bundle exec rspec
+
+notifications:
+    slack: privateprep:xsf8aYrl93oAPZbWnfEJ7b7u

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 1.8.0 (March 8, 2018)
+
+* Allow for varying cases in calls for calls other than :create and :update ([@bezoar17](https://github.com/bezoar17) in [#9](https://github.com/privateprep/intacct-ruby/pull/9) and [#13](https://github.com/privateprep/intacct-ruby/pull/13))
+* Adds templates for Issues and PRs ([@danielpowell4](https://github.com/danielpowell4) in [#10](https://github.com/privateprep/intacct-ruby/pull/10))
+* Bumps ruby version to 2 ([@danielpowell4](https://github.com/danielpowell4) in [#12](https://github.com/privateprep/intacct-ruby/pull/12))
+* Connects dev pipeline to Travis CI ([@danielpowell4](https://github.com/danielpowell4) in [#12](https://github.com/privateprep/intacct-ruby/pull/12))
+
+# Pre 1.8.0
+
+This log was not maintained as the gem was private.
+Huge thanks to [@jzornow](https://github.com/jzornow). Without him, this project would never have gotten off the ground!

data/README.md

@@ -1,16 +1,19 @@
-[ ![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)
+[![Build Status](https://travis-ci.org/privateprep/intacct-ruby.svg?branch=master)](https://travis-ci.org/privateprep/intacct-ruby)
 
 # 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` translates that philosophy into Ruby.
 
-### How Do It Do?
+### Putting Gem to Use
+
 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
@@ -18,27 +21,29 @@ Let's say you want to create a project and a customer associated with that proje
 # for more information.
 request = IntacctRuby::Request.new(REQUEST_OPTS)
 
-request.create :customer, {
-  customerid: '1',
-  first_name: 'Han',
-  last_name: 'Solo',
-  type: 'Person',
-  email1: 'han@solo.com',
-  status: 'active'
+request.create :CUSTOMER, {
+  CUSTOMERID: '1',
+  FIRST_NAME: 'Han',
+  LAST_NAME: 'Solo',
+  TYPE: 'Person',
+  EMAIL1: 'han@solo.com',
+  STATUS: 'active'
 }
 
-request.create :project, {
-  projectid: '1',
-  name: 'Get Chewie a Haircut',
-  projectcategory: 'Improve Wookie Hygene',
-  customerid: '1',
-  shampoo: 'true', # a custom field
-  blowdry: 'false' # a custom field
+request.create :PROJECT, {
+  PROJECTID: '1',
+  NAME: 'Get Chewie a Haircut',
+  PROJECTCATEGORY: 'Improve Wookie Hygene',
+  CUSTOMERID: '1',
+  SHAMPOO: 'true', # a custom field
+  BLOWDRY: 'false' # a custom field
 }
 
 request.send
 ```
 
+**Note:** Here `:CUSTOMER` and `:PROJECT` are object-types which are tagged just after the function tag `create` and are case-sensitive along with the extra-parameters(CUSTOMERID, FIRST_NAME ..)
+
 This will fire off a request that looks something like this:
 
 ```xml
@@ -76,18 +81,94 @@ This will fire off a request that looks something like this:
    </operation>
 </request>
 ```
+
+### Read Requests
+
+The read requests follow a slightly different pattern. The object-type is mentioned inside the object tag as seen here [Intacct List Vendors](https://developer.intacct.com/api/accounts-payable/vendors/#list-vendors). The following code will read all vendor objects.
+
+```ruby
+request = IntacctRuby::Request.new(REQUEST_OPTS)
+
+# Object-Type VENDOR is sent through extra-parameters and not as the first argument.
+request.readByQuery nil, {
+  object: 'VENDOR',
+  query: '',
+  fields: '*',
+  pagesize: 100
+}
+
+request.send
+```
+
+**Note:** Clean up the query argument before using it in readByQuery function as mentioned here [Intacct Illegal characters in XML](https://developer.intacct.com/web-services/queries/#illegal-characters-in-xml).
+So, something like `query: "BATCH_DATE > '02/14/2018'"` should be `query: "BATCH_DATE &gt; '02/14/2018'"`
+
+This will fire off a request that looks something like this:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<request>
+   <control><!-- Authentication Params --></control>
+   <operation transaction="true">
+      <authentication><!-- Authentication Params --></authentication>
+      <content>
+         <function controlid="readByQuery-2017-08-03 17:02:40 UTC">
+            <readByQuery>
+                <object>VENDOR</object>
+                <fields>*</fields>
+                <query></query>
+                <pagesize>100</pagesize>
+            </readByQuery>
+         </function>
+      </content>
+   </operation>
+</request>
+```
+
+Similarly, for pagination use the `readMore` function as mentioned here [Intacct Paginate Results](https://developer.intacct.com/web-services/queries/#paginate-results)
+
+```ruby
+request = IntacctRuby::Request.new(REQUEST_OPTS)
+
+request.readMore nil, {
+  resultId: '7765623332WU1hh8CoA4QAAHxI9i8AAAAA5'
+}
+
+request.send
+```
+
+This will fire off a request that looks something like this:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<request>
+   <control><!-- Authentication Params --></control>
+   <operation transaction="true">
+      <authentication><!-- Authentication Params --></authentication>
+      <content>
+         <function controlid="readMore-2017-08-03 17:02:40 UTC">
+            <readMore>
+              <resultId>7765623332WU1hh8CoA4QAAHxI9i8AAAAA5</resultId>
+            </readMore>
+         </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.
 
 ## Authentication
+
 Before we go any further, make sure you've read the [Intacct API Quickstart Guide](https://developer.intacct.com/web-services/) and [their article on constructing XML Requests](https://developer.intacct.com/web-services/requests/)
 
 In IntacctRuby - as with the Intacct API that the gem wraps - your system credentials are pass along with each separate `Request` instance. The functions that define a request are followed by a hash that spells out each piece of information required by Intacct for authentication. These fields are:
 
-- `senderid`
-- `sender_password`\*
-- `userid`
-- `companyid`
-- `user_password`\*
+* `senderid`
+* `sender_password`\*
+* `userid`
+* `companyid`
+* `user_password`\*
 
 \* _In [Intacct's documentation](https://developer.intacct.com/wiki/constructing-web-services-request), these are referred to only as `password`. This won't work in Rubyland, though, because we can't have multiple hash entries with the same key._
 
@@ -104,7 +185,9 @@ IntacctRuby::Request.new(
   user_password: 'some_user_password_value'
 )
 ```
+
 Though, it probably makes more sense to keep all of these in some handy constant for easy reuse:
+
 ```ruby
 REQUEST_OPTS = {
   senderid: 'some_senderid_value',
@@ -118,19 +201,23 @@ IntacctRuby::Request.new(REQUEST_OPTS)
 ```
 
 ### Important Notes on Authentication
+
 #### These Are Required!
+
 Obviously, Intacct won't do anything if you don't tell it who you are. To save you the bandwidth, **this gem will throw errors if any of these auth params are not provided.**
 
 #### BE SAFE!
+
 Though the examples above show hard-coded username/password pairs, this is a really bad idea to do in production code. Instead, we recommend storing these variables in ENVs, using a tool like [Figaro](https://github.com/laserlemon/figaro) to bring it all together.
 
 ## Customizing Calls
 
 This gem creates calls using the following defaults:
-- **uniqueid:** false,
-- **dtdversion:** 3.0,
-- **includewhitespace:** false,
-- **transaction:** true
+
+* **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 by adding additional fields to the options hash passed into `Request#new`:
 
@@ -150,9 +237,11 @@ REQUEST_OPTS.merge!(
 
 IntacctRuby::Request.new(REQUEST_OPTS)
 ```
+
 ## Installation
 
 ### The Gem Itself
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -176,4 +265,3 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/intacct_ruby.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version               = IntacctRuby::VERSION
   spec.authors               = ['Jeremy Zornow']
   spec.email                 = ['jeremy@zornow.com']
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.2.0'
   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 ' \
@@ -26,11 +26,12 @@ Gem::Specification.new do |spec|
   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_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'travis', '~> 1.8', '>= 1.8.8'
 
   spec.add_runtime_dependency 'builder', '~> 3.0', '>= 3.0.4'
 end

data/lib/intacct_ruby/function.rb

@@ -9,6 +9,7 @@ module IntacctRuby
       readByQuery
       read
       readByName
+      readMore
       create
       update
       delete
@@ -27,7 +28,7 @@ module IntacctRuby
 
       xml.function controlid: controlid do
         xml.tag!(@function_type) do
-          xml.tag!(@object_type.upcase) do
+          xml.tag!(@object_type) do
             xml << argument_xml(@arguments)
           end
         end
@@ -50,7 +51,7 @@ module IntacctRuby
       xml = Builder::XmlMarkup.new
 
       arguments_to_convert.each do |key, value|
-        argument_key = key.to_s.upcase
+        argument_key = key.to_s
 
         xml.tag!(argument_key) do
           xml << argument_value_as_xml(value)

data/lib/intacct_ruby/version.rb

@@ -1,3 +1,3 @@
 module IntacctRuby
-  VERSION = '1.7.0'.freeze
+  VERSION = '1.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intacct_ruby
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Jeremy Zornow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,87 +25,107 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        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: '10.0'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.13.3
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 3.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        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: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 1.8.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 1.8.8
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -134,9 +154,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -189,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -197,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Intacct API

data/.ruby-version

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