spree_batch_capture 0.1.0

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  # Add your extension routes here
+end

data/db/migrate/20111129223646_add_last_processing_error_to_payments.rb

@@ -0,0 +1,10 @@
+class AddLastProcessingErrorToPayments < ActiveRecord::Migration
+  def self.up
+    add_column :payments, :last_processing_error, :string
+  end
+
+  def self.down
+    remove_column :payments, :last_processing_error
+    
+  end
+end

data/lib/spree_batch_capture/error.rb

@@ -0,0 +1,6 @@
+module SpreeBatchCapture
+  module Error
+    class InvalidWorker < StandardError; end
+    class UnexpectedWorkerError < StandardError; end
+  end
+end

data/lib/spree_batch_capture/worker/base.rb

@@ -0,0 +1,98 @@
+require 'resque'
+#require 'resque/plugins/lock'
+
+module SpreeBatchCapture
+  class Worker::Base
+    #extend Resque::Plugins::Lock
+    
+    # Actual method called by Resque.
+    # This method cleans up any options and allows a consistent interface
+    # for the worker's run method.
+    def self.perform(options={})
+      begin
+        options.symbolize_keys!
+        if before_run(options)
+          result = run(options)
+          return after_run(result, options)
+        else
+          return false
+        end
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    # Override to do any modifications or validation 
+    # before running the job. Job will fail if before_run
+    # returns false.
+    def self.before_run(options)
+      return true
+    end
+
+    # Override to do any post run checking. Receives the
+    # result (true/false) of the run and the options
+    # which may have been altered by the run. Job will fail if 
+    # after_run returns false
+    def self.after_run(result, options)
+      return true
+    end
+
+    # Override to handle any exceptions that come up during the execution of 
+    # the job. Returning false will fail the job, while returning true
+    # will indicate that the job was successful.
+    def self.handle_error(exception)
+      return false
+    end
+
+    # Implemented by subclasses and performs the actual work of the worker.
+    def self.run(options)
+      return true
+    end
+
+    # Use enqueue to add a job to the queue to be captured. 
+    # Returns the result of the enqueue and the queue name as an array.
+    def self.enqueue(options, custom_queue_name=nil)
+      queue_name = custom_queue_name || default_queue_name || worker_klass_name
+      
+      # Resque.enqueue_to is currently supported only in the master branch
+      # of the gem and not included in any gem. When it is, the following line
+      # should work. 
+      #added = ::Resque.enqueue_to(queue_name, worker_class, options)
+      
+      #Until then, we have to do this work-around:
+      @queue = queue_name
+
+      added = ::Resque.enqueue(worker_class, options)
+      [ added, queue_name ]
+    end
+
+    # Override this in the subclass to provide the name of the queue
+    def self.worker_klass_name
+      return "Base"
+    end
+
+    # Provides a default queue name. Returning nil will default to the class name.
+    def self.default_queue_name
+      return nil
+    end
+
+    private 
+
+    def self.worker_class
+      begin 
+        @worker_class = "SpreeBatchCapture::Worker::#{worker_klass_name.camelize}".constantize
+      rescue
+        raise Error::InvalidWorker.new "Worker class name (#{worker_klass_name.camelize}) doesn't match a valid worker."
+      end
+    end
+
+
+    # Override the default lock for resque-lock. The out-of-the-box
+    # lock doesn't work for this case.
+    def self.lock(options)
+      "lock:#{default_queue_name || worker_klass_name}::#{options}"
+    end
+
+    
+  end
+end

data/lib/spree_batch_capture/worker/bogus.rb

@@ -0,0 +1,14 @@
+class SpreeBatchCapture::Worker::Bogus < SpreeBatchCapture::Worker::Base
+  
+  def self.run(options)
+    return true
+  end
+
+  def self.worker_klass_name
+    return "Bogus"
+  end
+
+  def self.default_queue_name
+    return "bogus"
+  end
+end

data/lib/spree_batch_capture/worker/capture.rb

@@ -0,0 +1,53 @@
+module SpreeBatchCapture
+  class Worker::Capture < Worker::Base
+
+    def self.run(options)
+      order = options[:order]
+
+      return true unless order.payment_state == "balance_due"
+
+      if order.payments.nil? || ( order.payments && order.payments.empty? )
+        raise UnexpectedWorkerError.new "Attempted to capture an order without any payments."
+      else 
+
+        order.payments.each do |payment|
+          payment_source = payment.source
+          if payment_source.can_capture? payment
+            begin
+              payment_source.capture(payment)
+            rescue => e
+              payment.fail
+              log_payment_error payment, "Error capturing payment for order #{order.number}. #{e.class} :: #{e.message}"
+            end
+
+          else
+            log_payment_error payment, "Order #{order.number} is not eligible for capture with payment #{payment.source_type} for #{payment.amount}."
+          end
+        end
+      end
+
+      return true
+
+    end
+
+    def self.before_run(options)
+      options[:order] = Order.find(options[:order_id])
+    end
+
+    def self.worker_klass_name
+      return "Capture"
+    end
+
+    def self.default_queue_name
+      return "capture"
+    end
+
+    private 
+
+    def self.log_payment_error(payment, error)
+      payment.last_processing_error = error
+      payment.save!
+    end
+
+  end
+end

data/lib/spree_batch_capture.rb

@@ -0,0 +1,18 @@
+require 'spree_core'
+require 'spree_batch_capture_hooks'
+
+module SpreeBatchCapture
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_batch_capture_hooks.rb

@@ -0,0 +1,3 @@
+class BatchProcessHooks < Spree::ThemeSupport::HookListener
+  # custom hooks go here
+end

data/lib/tasks/install.rake

@@ -0,0 +1,25 @@
+namespace :spree_batch_capture do
+  desc "Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)"
+  task :install do
+    Rake::Task['spree_batch_capture:install:migrations'].invoke
+    Rake::Task['spree_batch_capture:install:assets'].invoke
+  end
+
+  namespace :install do
+    desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+
+    desc "Copies all assets (NOTE: This will be obsolete with Rails 3.1)"
+    task :assets do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'public')
+      destination = File.join(Rails.root, 'public')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+
+end

data/lib/tasks/spree_batch_capture.rake

@@ -0,0 +1 @@
+# add custom rake tasks here

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: spree_batch_capture
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Farmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: &16020680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.60.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *16020680
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &16020220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *16020220
+- !ruby/object:Gem::Dependency
+  name: resque-lock
+  requirement: &16019760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *16019760
+description: Adds batch processing to Spree. Includes batch capture and batch export
+  of orders.
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/routes.rb
+- lib/spree_batch_capture_hooks.rb
+- lib/tasks/install.rake
+- lib/tasks/spree_batch_capture.rake
+- lib/spree_batch_capture/worker/bogus.rb
+- lib/spree_batch_capture/worker/capture.rb
+- lib/spree_batch_capture/worker/base.rb
+- lib/spree_batch_capture/error.rb
+- lib/spree_batch_capture.rb
+- db/migrate/20111129223646_add_last_processing_error_to_payments.rb
+homepage: http://vitrue.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: ''
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Adds batch capture and export to Spree
+test_files: []