dcas-ruby 0.1.0 → 0.2.0

data/API.rdoc

@@ -7,7 +7,14 @@
 * Parse response files
 
 === First you must set up the login info and a cache location
-  angola = DCAS::Client.new(:username => 'angola', :password => '4ng014', :cache_location => './EFT')
+  angola =  DCAS::Client.new(
+              :username => 'angola',
+              :password => '4ng014',
+              :company_alias => 'angolaHQ',
+              :company_username => 'angolatw',
+              :company_password => 'secret',
+              :cache_location => './PaymentFileStore'
+            )
 
 === Create a Payment Batch
   ach_payments = angola.new_batch(batch_id)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/dcas-ruby.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dcas-ruby}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["BehindLogic"]

data/lib/dcas/payment.rb

@@ -25,6 +25,10 @@ module DCAS
       payments.first.class.name.gsub(/.*::/,'').downcase
     end
 
+    def filename
+      "#{@client.company_user}_#{type}.csv"
+    end
+
     # Generates a payment batch file and returns its contents.
     def to_csv
       FasterCSV.generate do |csv|

data/lib/dcas.rb

@@ -6,6 +6,7 @@ module DCAS
   OUTGOING_BUCKET = 'outgoing'
   INCOMING_BUCKET = 'incoming'
   STAGING_BUCKET  = 'staging'
+  DEFAULT_CACHE_LOCATION = 'EFT'
 
   class << self
     # Parses the responses from a response file and returns an array of DCAS::Response objects.
@@ -16,16 +17,17 @@ module DCAS
   class Client
     # Instantiate a new Client object which can do authenticated actions in a DCAS FTPS bucket.
     def initialize(options={})
-      raise ArgumentError, "must include :username, :password, :company_alias, :company_username, :company_password, and :cache_location" if [:username, :password, :company_alias, :company_username, :company_password, :cache_location].any? {|k| !options.has_key?(k)}
-      @username = options[:username]
-      @password = options[:password]
-      @company_alias = options[:company_alias]
-      @company_username = options[:company_username]
-      @company_password = options[:company_password]
-      @cache_location = options[:cache_location]
+      raise ArgumentError, "must include :username, :password, :company_alias, :company_username, and :company_password" if [:username, :password, :company_alias, :company_username, :company_password].any? {|k| options[k].to_s.length == 0}
+      @username = options[:username].to_s
+      @password = options[:password].to_s
+      @company_alias = options[:company_alias].to_s
+      @company_username = options[:company_username].to_s
+      @company_password = options[:company_password].to_s
+      @cache_location = options[:cache_location].to_s || DEFAULT_CACHE_LOCATION
     end
 
-    attr_reader :username, :password, :company_alias, :company_username, :company_password, :cache_location
+    attr_reader :username, :password, :company_alias, :company_username, :company_password
+    attr_accessor :cache_location
 
     # :nodoc:
     def batches
@@ -39,40 +41,75 @@ module DCAS
     end
 
     # Uploads a single payments file to the DCAS outgoing payments bucket.
-    def submit_payments_file!(filename)
+    # You can optionally supply a 'lock' object, which must respond to:
+    #   #submit_locked?(filename)
+    #   #submit_lock!(filename)
+    #   #submit_finished!(filename)
+    #   #submit_failed!(filename)
+    # If a lock_object is supplied, the method will mark it as failed and return false instead of raising an error, in case of failure.
+    def submit_payments_file!(filename, lock_object=nil)
       shortname = filename.gsub(/.*[\\\/][^\\\/]+$/,'')
-      with_ftp do |ftp|
-        # 1) Create the STAGING folder if it's not already there.
-        ftp.mkdir(DCAS::STAGING_BUCKET) unless ftp.nlst.include?(DCAS::STAGING_BUCKET)
-        ftp.chdir(DCAS::STAGING_BUCKET)
-        # 2) Delete the same filename from the STAGING folder if one exists.
-        ftp.delete(shortname) if ftp.nlst.include?(shortname)
-        # 3) Upload the file into the STAGING folder.
-        ftp.put(filename, shortname)
-        # 4) If we're still connected, check the file size of the file, then move it out of STAGING and mark file as completed.
-        if ftp.nlst.include?(shortname) && ftp.size(shortname) == File.size(filename)
-          ftp.rename(shortname, "../#{DCAS::OUTGOING_BUCKET}/#{shortname}") unless DCAS::TESTING
-        else
-          raise RuntimeError, "FAILED uploading `#{filename}' - incomplete or unsuccessful upload. Please try again."
+      if lock_object && lock_object.submit_locked?(shortname)
+        raise RuntimeError, "Submit for #{shortname} is locked!"
+      else
+        lock_object.submit_lock!(shortname) if lock_object
+        with_ftp do |ftp|
+          # 1) Create the STAGING folder if it's not already there.
+          ftp.mkdir(DCAS::STAGING_BUCKET) unless ftp.nlst.include?(DCAS::STAGING_BUCKET)
+          ftp.chdir(DCAS::STAGING_BUCKET)
+          # 2) Delete the same filename from the STAGING folder if one exists.
+          ftp.delete(shortname) if ftp.nlst.include?(shortname)
+          # 3) Upload the file into the STAGING folder.
+          ftp.put(filename, shortname)
+          # 4) If we're still connected, check the file size of the file, then move it out of STAGING and mark file as completed.
+          if ftp.nlst.include?(shortname) && ftp.size(shortname) == File.size(filename)
+            ftp.rename(shortname, "../#{DCAS::OUTGOING_BUCKET}/#{shortname}") unless DCAS::TESTING
+            lock_object.submit_finished!(shortname) if lock_object
+          else
+            if lock_object
+              lock_object.submit_failed!(shortname)
+              return false
+            else
+              raise RuntimeError, "FAILED uploading `#{filename}' - incomplete or unsuccessful upload. Please try again."
+            end
+          end
         end
       end
       true
     end
 
+    # Writes one batch to file and submits it to the DCAS outgoing payments bucket.
+    # You can optionally supply a 'lock' object, which must respond to:
+    #   #submit_locked?
+    #   #submit_lock!(filename)
+    #   #submit_finished!(filename)
+    #   #submit_failed!(filename)
+    # If a lock_object is supplied, the method will mark it as failed and return false instead of raising an error, in case of failure.
+    def submit_batch!(batch, lock_object=nil)
+      File.makedirs(cache_location)
+      filename = cache_location + "/" + batch.filename
+      # 1) Create the file locally.
+      File.open(filename) {|f| f << batch.to_csv }
+      # 2) Upload it to the DCAS outgoing payments bucket.
+      submit_payments_file!(filename, lock_object)
+    end
+
     # Writes all batches to file and submits them to the DCAS outgoing payments bucket.
-    def submit_batches!
+    # You can optionally supply a 'lock' object, which must respond to:
+    #   #submit_locked?
+    #   #submit_lock!(filename)
+    #   #submit_finished!(filename)
+    #   #submit_failed!(filename)
+    def submit_batches!(lock_object=nil)
       File.makedirs(cache_location)
       batches_submitted = 0
-      with_ftp do
+      with_ftp do # causes all batches to be uploaded in a single session
         # 1) Gather all payments for this client.
         batches.each do |batch| # 2) For each file type (ach, cc) yet to be uploaded:
-          filename = cache_location + "/#{company_user}_#{batch.type}_#{Time.now.strftime("%Y%m%d")}.csv"
-          # 1) Create the file locally.
-          File.open(filename) {|f| f << batch.to_csv }
-          # 2) Upload it to the DCAS outgoing payments bucket.
-          batches_submitted += 1 if submit_payments_file!(filename)
+          batches_submitted += 1 if submit_batch!(batch, lock_object)
         end
       end
+      batches_submitted
     end
 
     # Checks for response files in the DCAS incoming responses bucket.

data/spec/dcas_spec.rb

@@ -14,14 +14,14 @@ describe "Dcas - Comprehensive failure frequency test" do
   end
 
   it "should generate Ach payment files correctly" do
-    ach_batch = @fake_client.new_batch(1)
+    ach_batch = @fake_client.new_batch('1001')
     Fixtures[:TestPayments][:Ach].collect {|p| ach_batch << DCAS::AchPayment.new(*p) }
     ach_payments_file = ach_batch.to_csv
     ach_payments_file.should eql(File.read('spec/fixtures/ach_payments.csv'))
   end
 
   it "should generate CreditCard payment files correctly" do
-    cc_batch = @fake_client.new_batch(1)
+    cc_batch = @fake_client.new_batch('1001')
     Fixtures[:TestPayments][:CreditCard].collect {|p| cc_batch << DCAS::CreditCardPayment.new(*p) }
     cc_payments_file = cc_batch.to_csv
     cc_payments_file.should eql(File.read('spec/fixtures/credit_card_payments.csv'))
@@ -32,10 +32,10 @@ describe "Dcas - Comprehensive failure frequency test" do
       # Depends: Fixture load of a list of DCAS logins to test
       # Depends: Fixed test files
       Fixtures[:Clients].each do |client|
-        cc_batch = client.new_batch(1)
+        cc_batch = client.new_batch('123')
         Fixtures[:TestPayments][:CreditCard].each {|p| cc_batch << DCAS::CreditCardPayment.new(*p) }
 
-        ach_batch = client.new_batch(1)
+        ach_batch = client.new_batch('123')
         Fixtures[:TestPayments][:Ach].each {|p| ach_batch << DCAS::AchPayment.new(*p) }
 
         client.submit_batches!.should eql(Fixtures[:PaymentFiles].length)

data/spec/fixtures/ach_payments.yml

@@ -1,6 +1,6 @@
 ---
 -
-  - '00111428'
+  - '11428'
   - 'Dan Hall'
   - '18.88'
   - 'Checking'
@@ -8,7 +8,7 @@
   - '182045828'
   - '2010010'
 -
-  - '00111200'
+  - '11200'
   - 'Karie Moore'
   - '18.88'
   - 'Checking'
@@ -16,7 +16,7 @@
   - '584218548'
   - '2010010'
 -
-  - '00111829'
+  - '11829'
   - 'Therese Boon'
   - '18.88'
   - 'Checking'
@@ -24,7 +24,7 @@
   - '94217885428'
   - '2010010'
 -
-  - '00111282'
+  - '11282'
   - 'Gretchen Gutierrez'
   - '18.88'
   - 'Savings'
@@ -32,7 +32,7 @@
   - '24254'
   - '2010010'
 -
-  - '00111795'
+  - '11795'
   - 'Audrice Pitto'
   - '18.88'
   - 'Checking'
@@ -40,7 +40,7 @@
   - '280458548254'
   - '2010010'
 -
-  - '00111537'
+  - '11537'
   - 'Rachel Ruppert'
   - '18.88'
   - 'Checking'
@@ -48,7 +48,7 @@
   - '641081508245'
   - '2010010'
 -
-  - '00111892'
+  - '11892'
   - 'Judith Witlock'
   - '18.88'
   - 'Checking'
@@ -56,7 +56,7 @@
   - '52488542858'
   - '2010010'
 -
-  - '00111172'
+  - '11172'
   - 'Kris Martell'
   - '18.88'
   - 'Savings'
@@ -64,7 +64,7 @@
   - '4728458248'
   - '2010010'
 -
-  - '00111284'
+  - '11284'
   - 'Michell Penderson'
   - '18.88'
   - 'Checking'
@@ -72,7 +72,7 @@
   - '38184599459'
   - '2010010'
 -
-  - '00111756'
+  - '11756'
   - 'Polly Clark'
   - '18.88'
   - 'Checking'

data/spec/fixtures/credit_card_payments.yml

@@ -1,69 +1,69 @@
 ---
 -
-  - '00111532'
+  - '11532'
   - 'Kipp Owen'
   - '18.88'
   - 'VISA'
   - '4508288028044788'
   - '12/2010'
 -
-  - '00111382'
+  - '11382'
   - 'Brooke Racquet'
   - '18.88'
   - 'VISA'
   - '4979170284809229'
   - '12/2011'
 -
-  - '00111018'
+  - '11018'
   - 'Pat Sylvester'
   - '18.88'
   - 'MCRD'
   - '5280827180294022'
   - '12/2012'
 -
-  - '00111992'
+  - '11992'
   - 'Vicki Tolliki'
   - '18.88'
   - 'MCRD'
   - '5173179138280429'
   - '12/2011'
 -
-  - '00111247'
+  - '11247'
   - 'Cheryl Barger'
   - '18.88'
   - 'VISA'
   - '4247972792081828'
   - '12/2010'
 -
-  - '00111028'
+  - '11028'
   - 'Melissa Fletcher'
   - '18.88'
   - 'MCRD'
   - '5428208180420824'
   - '12/2011'
 -
-  - '00111384'
+  - '11384'
   - 'Mack Payne'
   - '18.88'
   - 'MCRD'
   - '5425682492949922'
   - '12/2012'
 -
-  - '00111742'
+  - '11742'
   - 'Melissa Latcher'
   - '18.88'
   - 'MCRD'
   - '5208372629781292'
   - '12/2011'
 -
-  - '00111402'
+  - '11402'
   - 'Caroline Sieben'
   - '18.88'
   - 'MCRD'
   - '5181381081538389'
   - '12/2012'
 -
-  - '00111208'
+  - '11208'
   - 'Charlotte Sue Hiran'
   - '18.88'
   - 'MCRD'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dcas-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - BehindLogic