intacct_ruby 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d42a536100b60ef09ae692e1ca89d06cf8842684
-  data.tar.gz: 451891434ad91b2f70873d30c64a790170c733a6
+  metadata.gz: baaffa6dd9353222e537633286a01ebdbbc0e196
+  data.tar.gz: 4f174bbff844a691902f8e6cf9059d0f4c11b86c
 SHA512:
-  metadata.gz: 9dbd0f7d721c24e1eca287937f417f22ad9b204d6d77a6e17286188982d808a531805a77ccd3cb8ec29c974197423d27959947b68f390b9bcd9110c711d3de69
-  data.tar.gz: b75ce4f70c468cce6fd67bf715a4daa75bfd004389fc5752f84d792ca1707c7257c6bf4bcfbbfb2b821dad078381233b73d42cdf3fd4bbab97d386681d480625
+  metadata.gz: 33f2fc22db5cbc9dc1b4f0bbc65b37cbd674411e8c0972309c7d77b6d46e431b33a677429383b7ad17ce84dcd7b084ecc386361dc4754fd0564eb8f813ad8510
+  data.tar.gz: c03c9f4b18d77285b6c333fbeb0d8097ce256004a44d9814a150194485d8a3251740f9424d24d903827f6853f7ccd0d8304a4ca2d83f1fdbfb859fd88f756166

data/README.md

@@ -34,7 +34,7 @@ create_project = IntacctRuby::Functions::CreateProject.new(
   }
 )
 
-request = IntacctRuby::Request.new(create_customer, create_project)
+request = IntacctRuby::Request.new(create_customer, create_project, authentication_params)
 request.send
 ```
 
@@ -91,25 +91,78 @@ 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.
 
-## Customizing Calls
-
+## 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).
 
+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`\*
+
+\* _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._
+
+### Authentication Example:
+
+```ruby
+IntacctRuby::Request.new(
+  some_function,
+  another_function,
+  senderid: 'some_senderid_value',
+  sender_password: 'some_sender_password_value',
+  userid: 'some_userid_value',
+  companyid: 'some_companyid_value',
+  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',
+  sender_password: 'some_sender_password_value',
+  userid: 'some_userid_value',
+  companyid: 'some_companyid_value',
+  user_password: 'some_user_password_value'
+}
+
+IntacctRuby::Request.new(some_function, another_function, 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
 
-If you'd like to override any of these, you can do so when you create a new request:
+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`:
 
 ```ruby
-IntacctRuby::Request.new(
-  function_1,
-  function_2,
+REQUEST_OPTS = {
+  senderid: 'some_senderid_value',
+  sender_password: 'some_sender_password_value',
+  userid: 'some_userid_value',
+  companyid: 'some_companyid_value',
+  user_password: 'some_user_password_value'
+}
+
+REQUEST_OPTS.merge!(
   uniqueid: 'some_uniqueid_override',
   dtdversion: 'some_dtd_override'
 )
+
+IntacctRuby::Request.new(some_function, another_function, REQUEST_OPTS)
 ```
 ## Installation
 
@@ -128,28 +181,6 @@ 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.
 

data/intacct_ruby.gemspec

@@ -33,5 +33,4 @@ Gem::Specification.new do |spec|
   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/exceptions/empty_request_exception.rb

@@ -0,0 +1,5 @@
+module IntacctRuby
+  module Exceptions
+    class EmptyRequestException < StandardError; end
+  end
+end

data/lib/intacct_ruby/exceptions/insufficient_credentials_exception.rb

@@ -0,0 +1,5 @@
+module IntacctRuby
+  module Exceptions
+    class InsufficientCredentialsException < StandardError; end
+  end
+end

data/lib/intacct_ruby/request.rb

@@ -1,8 +1,9 @@
 require 'builder'
-require 'figaro'
 
 require 'intacct_ruby/api'
 require 'intacct_ruby/response'
+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.
@@ -15,15 +16,21 @@ module IntacctRuby
       transaction: true
     }.freeze
 
-    def initialize(*args)
-      @opts = DEFAULTS.dup
+    REQUIRED_AUTHENTICATION_KEYS = [
+      :senderid,
+      :sender_password,
+      :userid,
+      :companyid,
+      :user_password
+    ].freeze
 
-      # `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
+    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 = args
+      @functions = functions
     end
 
     def to_xml
@@ -39,6 +46,9 @@ module IntacctRuby
     def send(api = nil)
       api ||= Api.new
 
+      validate_keys!
+      validate_functions!
+
       Response.new api.send(self)
     end
 
@@ -46,14 +56,34 @@ module IntacctRuby
 
     attr_reader :request, :functions
 
+    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 Figaro.env.intacct_senderid
-        request.password Figaro.env.intacct_sender_password
+        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.
@@ -67,9 +97,9 @@ module IntacctRuby
     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
+          request.userid    @opts[:userid]
+          request.companyid @opts[:companyid]
+          request.password  @opts[:user_password]
         end
       end
     end

data/lib/intacct_ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intacct_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeremy Zornow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,26 +126,6 @@ dependencies:
     - - ">="
       - !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:
@@ -167,7 +147,9 @@ files:
 - intacct_ruby.gemspec
 - lib/intacct_ruby.rb
 - lib/intacct_ruby/api.rb
+- lib/intacct_ruby/exceptions/empty_request_exception.rb
 - lib/intacct_ruby/exceptions/function_failure_exception.rb
+- lib/intacct_ruby/exceptions/insufficient_credentials_exception.rb
 - lib/intacct_ruby/functions/base_function.rb
 - lib/intacct_ruby/functions/create_aradjustment.rb
 - lib/intacct_ruby/functions/create_customer.rb