tb_checkout 1.0.3

data/app/models/tb_checkout/transaction.rb

@@ -0,0 +1,253 @@
+module TbCheckout
+  class Transaction < ActiveRecord::Base
+    self.table_name = 'tb_checkout_transactions'
+    belongs_to :cart, :inverse_of => :transactions
+
+    attr_accessor :card_number
+    attr_accessor :card_ccv
+    attr_reader :card_expiration
+    self.columns_hash['card_expiration'] = OpenStruct.new(type: :date, klass: Date)
+
+    attr_reader :response
+
+    validates_presence_of :cart, :billing_first_name, :billing_last_name, :billing_address_1,  
+                          :billing_city, :billing_state, :billing_postal, :card_type
+    validates_numericality_of :amount_charged, :greater_than => 0
+    validate :credit_card_is_valid, :on => :create
+    before_validation :set_amount_charged
+    before_create :set_invoice_num, :set_spud_user_and_session_id
+
+    include TbCheckout::BelongsToUserSession
+
+    # Transaction status
+    #
+    # Status describes the current state of a transaction
+    #
+    # * Pending: The transaction is newly created
+    # * Authorized: The transaction has been submitted to the payment gateway and successfully authorized
+    # * Captured: The transaction has been submitted to the payment gateway and the purchase is finalized
+    # * Fail: A failure code was received from the payment gateway
+    # * Voided: The transaction is voided in the gateway
+    # * Refunded: The transaction is refunded in the gateway
+    module Status
+      PENDING = 'pending'
+      AUTHORIZED = 'authorized'
+      CAPTURED = 'captured'
+      FAIL = 'fail'
+      VOIDED = 'voided'
+      REFUNDED = 'refunded'
+    end
+
+    # Scopes
+    default_scope { order('created_at desc') }
+    scope :pending, ->{ where(:status => Status::PENDING) }
+    scope :authorized, ->{ where(:status => Status::AUTHORIZED) }
+    scope :captured, ->{ where(:status => Status::CAPTURED) }
+    scope :failed, ->{ where(:status => Status::FAIL) }
+
+    # Authorize the transaction against the payment gateway
+    #
+    # * The transaction must be in PENDING state in order ot take this action
+    def authorize!
+      self.with_lock(true) do
+        if self.status != Status::PENDING
+          raise StandardError, 'Payment must be in Pending state before authorization'
+        end
+        @response = TbCheckout.gateway.authorize(amount_in_cents, build_credit_card(), build_purchase_options())
+        if @response.success?
+          self.update_columns(:status => Status::AUTHORIZED, :gateway_transaction_id => @response.params['transaction_id'], :response_text => @response.to_json)
+          return true
+        else
+          self.update_columns(:status => Status::FAIL, :response_text => @response.to_json)
+          logger.fatal @response.inspect
+          return false
+        end
+      end
+    end
+
+    # Capture the funds from an authorized transaction through the payment gateway
+    #
+    # * The transaction must be in AUTHORIZED state in order ot take this action
+    def capture!
+      self.with_lock(true) do
+        if self.status != Status::AUTHORIZED
+          raise StandardError, 'Payment must be in Authorized state before capture'
+        end
+        @response = TbCheckout.gateway.capture(amount_in_cents, self.gateway_transaction_id)
+        if @response.success? || @response.params['action'] == 'PRIOR_AUTH_CAPTURE'
+          self.update_columns(:status => Status::CAPTURED, :response_text => @response.to_json)
+        else
+          self.update_columns(:status => Status::FAIL, :response_text => @response.to_json)
+          logger.fatal @response.inspect
+        end
+      end
+      if self.status == Status::CAPTURED
+        self.cart.update_attributes(:is_completed => true)
+        self.cart.cart_items.each do |cart_item|
+          cart_item.item.run_callbacks(:capture)
+        end
+        return true
+      else
+        return false
+      end
+    end
+
+    # Voids or Refunds the transaction
+    #
+    # * An unsettled trasanction cannot be refunded, and a settled transaction cannot be voided
+    # * Transactions are settled nightly
+    # * If the transaction is less than 24 hours old, attempt to void it and if that fails attempt a refund
+    def void_or_refund!
+      if (1.days.ago < self.created_at && void!) || refund!
+        return true
+      else
+        return false
+      end
+    end
+
+    def amount_in_cents
+      return amount_charged * 100
+    end
+
+    def billing_full_name
+      return "#{billing_first_name} #{billing_last_name}"
+    end
+
+    def billing_full_address
+      street = [billing_address_1, billing_address_2].reject(&:blank?).join(', ')
+      return "#{street}, #{billing_city} #{billing_state}, #{billing_postal}"
+    end
+
+    # Check for card_expiration value in String format and convert to Date format
+    #
+    def card_expiration=(date)
+      if date.is_a? String
+        begin
+          @card_expiration = Date.parse(date)
+        rescue ArgumentError => e
+          @card_expiration = nil
+        end
+      else
+        @card_expiration = date
+      end
+    end
+
+private
+
+    def void!
+      self.with_lock(true) do
+        if self.status != Status::CAPTURED
+          raise StandardError, 'Payment must be in captured state before it can be voided'
+        end
+        @response = TbCheckout.gateway.void(gateway_transaction_id)
+        if @response.success?
+          self.update_columns(:status => Status::VOIDED, :response_text => @response.to_json)
+          return true
+        else
+          self.update_columns(:response_text => @response.to_json)
+          logger.fatal @response.inspect
+          return false
+        end
+      end
+    end
+
+    def refund!
+       self.with_lock(true) do
+        if self.status != Status::CAPTURED
+          raise StandardError, 'Payment must be in captured state before it can be voided'
+        end
+        cc_last_four_digits = self.card_display.chars.last(4).join()
+        @response = TbCheckout.gateway.refund(amount_in_cents, self.gateway_transaction_id, {
+          :order_id => invoice_num,
+          :description => "REFUND: #{self.cart.description}",
+          :card_number => cc_last_four_digits,
+          :first_name => billing_first_name,
+          :last_name => billing_last_name,
+          :zip => billing_postal
+        })
+        if @response.success? || @response.params['response_reason_code'] == '55' # already refunded
+          self.update_columns(:status => Status::REFUNDED, :response_text => @response.to_json, :refund_gateway_transaction_id => @response.params['gateway_transaction_id'])
+          return true
+        else
+          self.update_columns(:response_text => @response.to_json)
+          logger.fatal @response.inspect
+          return false
+        end
+      end
+    end
+
+    def credit_card_is_valid
+      if self.card_number.blank?
+        errors.add(:card_number, 'cannot be blank')
+      end
+      if self.card_ccv.blank?
+        errors.add(:card_ccv, 'cannot be blank')
+      end
+      if errors.size == 0
+        credit_card = build_credit_card()
+        if credit_card.valid?()
+          self.card_display = credit_card.display_number()
+        else
+          credit_card.errors.full_messages.each do |msg|
+            errors.add(:base, msg)  
+          end
+        end
+      end
+    end
+
+    def build_credit_card
+      return ActiveMerchant::Billing::CreditCard.new({
+        :brand => card_type,
+        :number => card_number,
+        :verification_value => card_ccv,
+        :month => card_expiration.month,
+        :year => card_expiration.year,
+        :first_name => billing_first_name,
+        :last_name => billing_last_name
+      })
+    end
+
+    def build_purchase_options
+      return {
+        :email => self.cart.spud_user.try(:email) || nil,
+        :order_id => self.invoice_num,
+        :description => self.cart.description,
+        :billing_address => {
+          :name => billing_full_name,
+          :address1 => billing_address_1,
+          :address2 => billing_address_2,
+          :city => billing_city,
+          :state => billing_state,
+          :country => country_for_billing_state(),
+          :zip => billing_postal,
+          :phone => self.cart.spud_user.try(:phone) || nil
+        }
+      }
+    end
+
+    def set_amount_charged
+      if self.cart
+        self.amount_charged = self.cart.total_price
+      end
+    end
+
+    def set_invoice_num
+      user_id = self.cart.spud_user_id || 0
+      self.invoice_num = [user_id, Time.now.to_i].join('-')
+    end
+
+    def set_spud_user_and_session_id
+      self.spud_user_id = self.cart.spud_user_id || 0
+      self.session_id = self.cart.session_id || 0
+    end
+
+    def country_for_billing_state
+      if ['AB', 'BC', 'MB', 'NB', 'NL', 'NS', 'NT', 'NU', 'ON', 'PE', 'QC', 'SK', 'YT'].include?(billing_state)
+        return 'Canada'
+      else
+        return 'USA'
+      end
+    end
+
+  end
+end

data/app/views/tb_checkout/admin/carts/index.html.erb

@@ -0,0 +1,54 @@
+<% content_for :data_controls do %>
+  <%= form_tag tb_checkout_admin_carts_path, :method => :get, :class => 'tb-checkout-cart-filter-form' do %>
+  <%= select_tag :status, options_for_select([
+    ['All', 'all'],
+    ['Complete', 'completed'],
+    ['In Progress', 'in-progress'],
+    ['Abandoned', 'abandoned']
+  ], params[:status]) %>
+  <% end %>
+<% end %>
+
+<% content_for :detail do %>
+  <table class="table table-striped">
+    <thead>
+      <th>User</th>
+      <th>Description</th>
+      <th>Total Price</th>
+      <th>Status</th>
+      <th>Last Modified</th>
+      <th></th>
+    </thead>
+    <tbody>
+      <% @carts.each do |cart| %>
+        <tr>
+          <td class="no-wrap"><%= cart.user_full_name %></td>
+          <td><%= cart.description %></td>
+          <td>
+            <% if cart.is_empty? %>
+              Empty
+            <% else %>
+              <%= number_to_currency cart.total_price %>
+            <% end %>
+          </td>
+          <td>
+            <%= tb_checkout_status_label_for_cart(cart) %>
+          </td>
+          <td class="no-wrap"><%= cart.updated_at.strftime('%I:%M %p, %D') %></td>
+          <td>
+            <%= link_to 'Detail', tb_checkout_admin_cart_path(cart, :status => params[:status]), :class => 'btn btn-mini' %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+  <%= will_paginate @carts %>
+
+  <script>
+    $(document).ready(function(){
+      $('.tb-checkout-cart-filter-form').on('change', 'select', function(e){
+        $(this).parents('form').submit();
+      });
+    });
+  </script>
+<% end %>

data/app/views/tb_checkout/admin/carts/show.html.erb

@@ -0,0 +1,45 @@
+<h3>General Info</h3>
+
+<ul>
+  <li><strong>User</strong> <%= @cart.user_full_name %></li>
+  <li><strong>Created At</strong> <%= @cart.created_at.strftime('%I:%M %p, %D') %></li>
+  <li><strong>Last Modified</strong> <%= @cart.updated_at.strftime('%I:%M %p, %D') %></li>
+  <li><strong>Status</strong> <%= tb_checkout_status_label_for_cart(@cart) %></li>
+</ul>
+
+<h3>Products</h3>
+
+<% if @cart.is_empty? %>
+  <p>This cart does not contain any items.</p>
+<% else %>
+  <table class="table table-striped">
+    <thead>
+      <th>Product</th>
+      <th>Quantity</th>
+      <th>Price</th>
+    </thead>
+    <tbody>
+      <% @cart.cart_items.each do |cart_item| %>
+        <tr>
+          <td><%= cart_item.item_description %></td>
+          <td><%= cart_item.quantity %></td>
+          <td><%= number_to_currency cart_item.total_price %></td>
+        </tr>
+      <% end %>
+    </tbody>
+    <tfoot>
+      <tr>
+        <td colspan="2">Total</td>
+        <td><%= number_to_currency @cart.total_price %></td>
+      </tr>
+    </tfoot>
+  </table>
+<% end %>
+
+<h3>Transactions</h3>
+
+<% if @cart.transactions.blank? %>
+  <p>There are no transactions associated with this shopping cart.</p>
+<% else %>
+  <%= render :partial => '/tb_checkout/admin/transactions/table', :locals => {:transactions => @cart.transactions} %>
+<% end %>

data/app/views/tb_checkout/admin/transactions/_table.html.erb

@@ -0,0 +1,24 @@
+<table class="table table-striped">
+  <thead>
+    <th>Invoice Number</th>
+    <th>Transaction ID</th>
+    <th>Billing Name</th>
+    <th>Card</th>
+    <th>Amount Charged</th>
+    <th>Status</th>
+    <th></th>
+  </thead>
+  <tbody>
+    <% transactions.each do |transaction| %>
+      <tr>
+        <td><%= transaction.invoice_num %></td>
+        <td><%= transaction.gateway_transaction_id %></td>
+        <td class="no-wrap"><%= transaction.billing_full_name %></td>
+        <td class="no-wrap"><%= transaction.card_display %> (<%= transaction.card_type %>)</td>
+        <td><%= number_to_currency transaction.amount_charged %></td>
+        <td><%= tb_checkout_status_label_for_transaction(transaction.status) %></td>
+        <td><%= link_to 'Detail', tb_checkout_admin_transaction_path(transaction), :class => 'btn btn-mini' %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/tb_checkout/admin/transactions/index.html.erb

@@ -0,0 +1,7 @@
+<% content_for :data_controls do %>
+
+<% end %>
+
+<% content_for :detail do %>
+  <%= render :partial => 'table', :locals => {:transactions => @transactions} %>
+<% end %>

data/app/views/tb_checkout/admin/transactions/show.html.erb

@@ -0,0 +1,70 @@
+<h3>Summary</h3>
+<table class="table table-bordered">
+  <thead>
+    <tr>
+      <th>User</th>
+      <th>Invoice Number</th>
+      <th>Transaction ID</th>
+      <th>Card</th>
+      <th>Amount Charged</th>
+      <th>Status</th>
+    </tr>
+  </thead>
+  <tbody>
+    <td><%= @transaction.cart.user_full_name %></td>
+    <td><%= @transaction.invoice_num %></td>
+    <td><%= @transaction.gateway_transaction_id %></td>
+    <td><%= @transaction.card_display %> (<%= @transaction.card_type %>)</td>
+    <td><%= number_to_currency @transaction.amount_charged %></td>
+    <td><%= tb_checkout_status_label_for_transaction(@transaction.status) %></td>
+  </tbody>
+</table>
+
+<h3>Billing Address</h3>
+<table class="table table-bordered">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Address</th>
+      <th>Address 2</th>
+      <th>City</th>
+      <th>State</th>
+      <th>Postal</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><%= @transaction.billing_full_name %></td>
+      <td><%= @transaction.billing_address_1 %></td>
+      <td><%= @transaction.billing_address_2 || "--" %></td>
+      <td><%= @transaction.billing_city %></td>
+      <td><%= @transaction.billing_state %></td>
+      <td><%= @transaction.billing_postal %></td>
+    </tr>
+</table>
+
+<h3>Line Items</h3>
+<table class="table table-bordered">
+  <thead>
+    <tr>
+      <th>Product</th>
+      <th>Quantity</th>
+      <th>Price</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @transaction.cart.cart_items.each do |cart_item| %>
+      <tr>
+        <td><%= cart_item.item_description %></td>
+        <td><%= cart_item.quantity %></td>
+        <td><%= number_to_currency cart_item.total_price %></td>
+      </tr>
+    <% end %>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td colspan="2">Total</td>
+      <td><%= number_to_currency @transaction.cart.total_price %></td>
+    </tr>
+  </tfoot>
+</table>