intacct_ruby 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d91a712067c46b1878f02cd252f0ebb2ebf576e
-  data.tar.gz: 476d463ee509d8ff743e6ac1eea8ef409c77e68b
+  metadata.gz: 6fdeda969319113c490136cf46946c4249f63232
+  data.tar.gz: a6c3031723fcd6e7a9fdf61521e7255912ba8b6f
 SHA512:
-  metadata.gz: 5c7e51583d104820ec989ee2899b98e9aba8302021055ac58ed9a64bac640fee97ea653e532d2367ac59582b67283bed0eabff223598eccac006344552af51ed
-  data.tar.gz: 677b8a609811c4bb2b1a8ea722c6a8a3e1cb016a2f357394114b9910f8e3dc657d4e42368acaf4fbbad852c5198ff5ea88893bcd0a6620efd0f71f8406d7ac26
+  metadata.gz: 2b753266030c50e51e94b81a190b108222b0ae2d7d0a16f6bef8244a60f0316ea4c09d02efb165d03ff7762bbc26dfd6ef06a2afe84c5028389ec65db07a73e8
+  data.tar.gz: 10b084c606c9cb83505a5290443c3c328502585aaf912bcd6180350e4ffef13ec8b6d864d1f214d50349d42153c1009b3cab41e2d608cd2645e3e4a113fb3d51

data/README.md

@@ -8,33 +8,34 @@ A wrapper for [Intacct's API](https://developer.intacct.com/wiki/functions-objec
 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.
+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?
-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!
+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(
+# REQUEST_OPTS contains authentication information. See 'Authentication' section
+# 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'
-)
+}
 
-create_project = IntacctRuby::Functions::CreateProject.new(
+request.create :project, {
   projectid: '1',
   name: 'Get Chewie a Haircut',
   projectcategory: 'Improve Wookie Hygene',
   customerid: '1',
-  customfields: {
-    shampoo: 'true',
-    blowdry: 'false'
-  }
-)
+  shampoo: 'true', # a custom field
+  blowdry: 'false' # a custom field
+}
 
-request = IntacctRuby::Request.new(create_customer, create_project, authentication_params)
 request.send
 ```
 
@@ -43,47 +44,33 @@ This will fire off a request that looks something like this:
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <request>
-   <control>
-      ** omitted **
-   </control>
+   <control><!-- Authentication Params --></control>
    <operation transaction="true">
-      <authentication>
-         ** omitted **
-      </authentication>
+      <authentication><!-- Authentication Params --></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 controlid="create-customer-2017-08-03 17:02:40 UTC">
+            <create>
+               <CUSTOMER>
+                  <CUSTOMERID>1</CUSTOMERID>
+                  <FIRST_NAME>Han</FIRST_NAME>
+                  <LAST_NAME>Solo</LAST_NAME>
+                  <TYPE>Person</TYPE>
+                  <EMAIL1>han@solo.com</EMAIL1>
+                  <STATUS>active</STATUS>
+               </CUSTOMER>
+            </create>
          </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 controlid="create-project-2017-08-03 17:02:40 UTC">
+            <create>
+               <PROJECT>
+                  <PROJECTID>1</PROJECTID>
+                  <NAME>Get Chewie a Haircut</NAME>
+                  <PROJECTCATEGORY>Improve Wookie Hygene</PROJECTCATEGORY>
+                  <CUSTOMERID>1</CUSTOMERID>
+                  <SHAMPOO>true</SHAMPOO>
+                  <BLOWDRY>false</BLOWDRY>
+               </PROJECT>
+            </create>
          </function>
       </content>
    </operation>
@@ -92,7 +79,7 @@ This will fire off a request that looks something like this:
 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/wiki/constructing-web-services-request#The%20Intacct%20DTDs).
+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:
 
@@ -102,7 +89,7 @@ In IntacctRuby - as with the Intacct API that the gem wraps - your system creden
 - `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're unable to have multiple hash entries with the same key._
+\* _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._
 
 ### Authentication Example:
 
@@ -117,7 +104,6 @@ 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 = {
@@ -126,14 +112,14 @@ REQUEST_OPTS = {
   userid: 'some_userid_value',
   companyid: 'some_companyid_value',
   user_password: 'some_user_password_value'
-}
+}.freeze
 
-IntacctRuby::Request.new(some_function, another_function, REQUEST_OPTS)
+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.
+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.
@@ -162,7 +148,7 @@ REQUEST_OPTS.merge!(
   dtdversion: 'some_dtd_override'
 )
 
-IntacctRuby::Request.new(some_function, another_function, REQUEST_OPTS)
+IntacctRuby::Request.new(REQUEST_OPTS)
 ```
 ## Installation
 
@@ -181,23 +167,12 @@ Or install it yourself as:
 
     $ gem install intacct_ruby
 
-## 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/lib/intacct_ruby/api.rb

@@ -5,7 +5,7 @@ module IntacctRuby
       @http_gateway = http_gateway
     end
 
-    def send(request_object, post_request = nil)
+    def send_request(request_object, post_request = nil)
       post_request ||= Net::HTTP::Post.new(uri.request_uri)
 
       post_request['Content-Type'] = 'x-intacct-xml-request'

data/lib/intacct_ruby/request.rb

@@ -49,13 +49,18 @@ module IntacctRuby
       end
     end
 
-    def send(api = nil)
-      api ||= Api.new
+    def send(opts = {})
+      if opts.is_a? Hash
+        api = opts[:api] || Api.new
 
-      validate_keys!
-      validate_functions!
+        validate_keys!
+        validate_functions!
 
-      Response.new api.send(self)
+        Response.new api.send_request(self)
+      else
+        # so that Request#send can play nice alongside Object#send
+        super
+      end
     end
 
     private

data/lib/intacct_ruby/version.rb

@@ -1,3 +1,3 @@
 module IntacctRuby
-  VERSION = '1.6.2'.freeze
+  VERSION = '1.6.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intacct_ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Jeremy Zornow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler