spree_unified_payment 1.0.0

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,67 @@
+Spree::Order.class_eval do
+  has_many :unified_transactions, :class_name => 'UnifiedPayment::Transaction'
+  def pending_card_transaction
+    unified_transactions.pending.first
+  end
+
+  def release_inventory
+    shipments.each do |shipment|
+      shipment.cancel if shipment.inventory_units.any? { |iu| iu.pending == false }
+    end
+  end
+
+  #over writing this method to release inventory units before being deleted in case reserved
+  def create_proposed_shipments
+    release_inventory
+    shipments.destroy_all
+
+    packages = Spree::Stock::Coordinator.new(self).packages
+    packages.each do |package|
+      shipments << package.to_shipment
+    end
+
+    shipments
+  end
+
+  def reason_if_cant_pay_by_card
+    if total.zero? then 'Order Total is invalid'
+    elsif completed? then 'Order already completed'
+    elsif insufficient_stock_lines.present? then 'An item in your cart has become unavailable.'
+    end
+  end
+
+  #overwriting this method under class Spree::Order to avoid reserve_stock twice in case order is from confirm state
+  def finalize!
+    touch :completed_at
+
+    # lock all adjustments (coupon promotions, etc.)
+    adjustments.each { |adjustment| adjustment.update_column('state', "closed") }
+
+    # update payment states, and save
+    updater.update_payment_state
+    reserve_stock unless previous_states.last == :confirm
+
+    updater.update_shipment_state
+    save
+    updater.run_hooks
+
+    deliver_order_confirmation_email
+
+    self.state_changes.create({
+      previous_state: previous_states.last.to_s,
+      next_state:     'complete',
+      name:           'order' ,
+      user_id:        self.user_id
+    }, without_protection: true)
+  end
+
+  def reserve_stock
+    shipments.each do |shipment|
+      #to reserve stock only if it has not been reserved already.
+      if shipment.inventory_units.any? { |inventory_unit| inventory_unit.pending == true }
+        shipment.update!(self)
+        shipment.finalize!
+      end
+    end
+  end
+end

data/app/models/spree/payment_method/unified_payment_method.rb

@@ -0,0 +1,34 @@
+module Spree
+  class PaymentMethod::UnifiedPaymentMethod < PaymentMethod
+    
+    def actions
+      %w{capture void}
+    end
+
+    # Indicates whether its possible to capture the payment
+    def can_capture?(payment)
+      ['checkout', 'pending'].include?(payment.state)
+    end
+
+    # Indicates whether its possible to void the payment.
+    def can_void?(payment)
+      payment.state != 'void'
+    end
+
+    def capture(*args)
+      ActiveMerchant::Billing::Response.new(true, "", {}, {})
+    end
+
+    def void(*args)
+      ActiveMerchant::Billing::Response.new(true, "", {}, {})
+    end
+
+    def source_required?
+      false
+    end
+
+    def payment_profiles_supported?
+      true
+    end
+  end
+end

data/app/models/spree/store_credit_decorator.rb

@@ -0,0 +1,4 @@
+Spree::StoreCredit.class_eval do
+  attr_accessible :balance, :user, :transactioner, :type
+  belongs_to :unified_transaction, :class_name => 'UnifiedPayment::Transaction', :foreign_key => 'unified_transaction_id'
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,7 @@
+Spree::User.class_eval do
+  has_many :unified_payments, :class_name => 'UnifiedPayment::Transaction'
+
+  def self.create_unified_transaction_user(email)
+    create(:email => email, :password => SecureRandom.hex(5))
+  end
+end

data/app/models/unified_payment/transaction_decorator.rb

@@ -0,0 +1,102 @@
+UnifiedPayment::Transaction.class_eval do    
+  attr_accessible :status
+
+  belongs_to :order, :class_name => "Spree::Order"
+  belongs_to :user, :class_name => "Spree::User"
+  has_one :store_credit, :class_name => "Spree::StoreCredit"
+  scope :pending, lambda { where :status => 'pending' }
+  after_create :enqueue_expiration_task, :if => [:payment_transaction_id?]
+
+  after_save :notify_user_on_transaction_status, :if => [:status_changed?, "status_was == 'pending'"]
+  before_save :assign_attributes_using_xml, :if => [:status_changed?, "!pending?"]
+  after_save :complete_order, :if => [:status_changed?, :payment_valid_for_order?, :successful? ,"!order_inventory_released?"]
+  after_save :wallet_transaction, :if => [:status_changed? ,"(!payment_valid_for_order? || order_inventory_released?)", :successful?]
+  after_save :cancel_order, :if => [:status_changed?, :unsuccessful?]
+  after_save :release_order_inventory, :if => [:expired_at?, "expired_at_was == nil"]
+
+  def payment_valid_for_order?
+    !order.completed? && order.total == amount
+  end
+
+  def order_inventory_released?
+    expired_at?
+  end
+
+  def abort!
+    update_attribute(:expired_at, Time.current)
+  end
+
+  def successful?
+    status == 'successful'
+  end
+
+  def unsuccessful?
+    status == 'unsuccessful'
+  end
+
+  def wallet_transaction(transactioner = nil)
+    associate_user if user.nil?
+    store_credit_balance = user.store_credits_total + amount.to_f
+    store_credit = build_store_credit(:balance => store_credit_balance, :user => user, :transactioner => (transactioner || user), :amount => amount.to_f, :reason => "transferred from transaction:#{payment_transaction_id}", :payment_mode => Spree::Credit::PAYMENT_MODE['Payment Refund'], :type => "Spree::Credit")
+    store_credit.save!
+  end
+
+  def pending?
+    status == 'pending'
+  end
+  
+  def update_transaction_on_query(gateway_order_status)
+    update_hash = gateway_order_status == "APPROVED" ? {:status => 'successful'} : {}
+    assign_attributes({:gateway_order_status => gateway_order_status}.merge(update_hash))
+    save(:validate => false)
+  end
+
+  private
+
+  def associate_user
+    associate_with_user = Spree::User.where(:email => order.email).first
+    unless associate_with_user
+      associate_with_user = Spree::User.create_unified_transaction_user(order.email)
+    end
+    self.user = associate_with_user
+    save!
+  end
+
+  def assign_attributes_using_xml
+    if xml_response.include?('<Message')
+      info_hash = Hash.from_xml(xml_response)['Message']
+
+      UNIFIED_XML_CONTENT_MAPPING
+      {:pan= => 'PAN', :response_description= => 'ResponseDescription', :gateway_order_status= => 'OrderStatus', :order_description= => 'OrderDescription', :response_status= => 'Status', :merchant_id= => 'MerchantTranID', :approval_code= => 'ApprovalCode'}.each_pair do |attribute, xml_mapping|
+        self.send(attribute, info_hash[xml_mapping])
+      end
+    end
+  end
+
+  def notify_user_on_transaction_status
+    Spree::TransactionNotificationMailer.delay.send_mail(self)
+  end
+
+  def release_order_inventory
+    #unless needed to not release inventory when transaction expires after order completed via some other payment method before expire or abort
+    order.release_inventory unless order.completed?
+  end
+
+  def complete_order
+    if order.total == amount
+      order.next!
+      order.pending_payments.first.complete
+    end
+  end
+
+  def cancel_order
+    unless order.completed?
+      order.pending_payments.first.update_attribute(:state, 'failed')
+      order.release_inventory unless order_inventory_released?
+    end
+  end
+
+  def enqueue_expiration_task
+    Delayed::Job.enqueue(TransactionExpiration.new(id), { :run_at => TRANSACTION_LIFETIME.minutes.from_now })
+  end
+end

data/app/overrides/add_unified_tabs_to_admin_menu.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(:virtual_path => "spree/layouts/admin",
+                     :name => "Add Unified tab to menu",
+                     :insert_bottom => "[data-hook='admin_tabs'], #admin_tabs[data-hook]",
+                     :text => " <%= tab( :Unified , :url => admin_unified_payments_path) %>",
+                     :sequence => {:after => "promo_admin_tabs"},
+                     :disabled => false)

data/app/views/spree/admin/unified_payments/index.html.erb

@@ -0,0 +1,98 @@
+<h1>Card Transactions</h1>
+
+<% content_for :table_filter do %>
+  <div data-hook="admin_orders_index_search">
+    <%= form_for [:admin, @search], :url => unified_payments_path, :method => :get do |f| %>
+      <div class="field-block alpha four columns">
+        <div class="date-range-filter field">
+          <%= label_tag nil, Spree.t(:date_range) %>
+          <div class="date-range-fields">
+            <%= f.text_field :created_at_gt, :class => 'datepicker datepicker-from', :value => params[:q][:created_at_gt], :placeholder => 'From' %>
+
+            <span class="range-divider">
+              <i class="icon-arrow-right"></i>
+            </span>
+
+            <%= f.text_field :created_at_lt, :class => 'datepicker datepicker-to', :value => params[:q][:created_at_lt], :placeholder => 'Till' %>
+          </div>
+        </div>
+
+        <div class="field">
+          <%= label_tag nil, Spree.t(:status) %>
+          <%= f.select :status_eq, ['pending', 'successful', 'unsuccessful'].each {|s| [s, s]}, {:include_blank => true}, :class => 'select2' %>
+        </div>
+      </div>
+
+      <div class="four columns">
+        <div class="field">
+          <%= label_tag nil, 'TransactionId' %>
+          <%= f.text_field :payment_transaction_id_eq %>
+        </div>
+      </div>
+
+      <div class="clearfix"></div>
+
+      <div class="actions filter-actions">
+        <div data-hook="admin_orders_index_search_buttons">
+          <%= button Spree.t(:filter_results), 'icon-search' %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+<% end %>
+
+<% if @card_transactions.present? %>
+  <table class="order-summary" cellspacing="0" cellpadding="0" border="0">
+    <thead>
+    <tr>
+      <th>Name</th>
+      <th>Transaction Id</th>
+      <th>Order Status</td>
+      <th><%= Spree.t(:amount) %></th>
+      <th>PAN</th>
+      <th>Gateway Order Status</th>
+      <th>Response</th>
+      <th>transaction Status</th>
+      <th>Date</th>
+      <th>XmlResponse/<br>Receipt/<br>Query/Update<br>Wallet</th>
+    </tr>
+    </thead>
+    <tbody>
+    <% @card_transactions.each do |card_transaction| %>
+      <tr class="<%= cycle('even', 'odd') %>" id = "<%= card_transaction.payment_transaction_id %>" >
+        <% #using || for checkout guest users as there is no user for it%>
+        <td><%= card_transaction.user.try(:email) || card_transaction.order.email %></td>
+        <td><%= card_transaction.payment_transaction_id %></td>
+        <td><%= card_transaction.order.try(:state) %></td>
+        <td><%= number_to_currency(card_transaction.amount) %></td>
+        <td><%= card_transaction.pan %></td>
+        <td class="gateway_order_status"><%= card_transaction.gateway_order_status %></td>
+        <td>
+          <span class="card_transaction_label">ResponseCode: &darr;</span>
+          <%= card_transaction.response_status %>
+          <span class="card_transaction_label">Description: &darr;</span>
+          <%= card_transaction.response_description%>
+          <span class="card_transaction_label">AprrovalCode: &darr;</span>
+          <%= card_transaction.approval_code %>
+        </td>
+        <td><%= card_transaction.status %></td>
+        <td><%= card_transaction.created_at.strftime("%d %b %Y, %I:%M%p") %></td>
+        <td class="action">
+          <% unless card_transaction.status == 'pending' %>
+            <a href="javascript:void(0)" id="reveal_xml" data-ct-id=<%= card_transaction.id%>>View XML</a>
+            <div class="hidden xml_response" id="xml_response_<%= card_transaction.id %>"><%= card_transaction.xml_response %></div>
+            <% unless card_transaction.store_credit.present? %>
+              |<%= link_to "Receipt", unified_payments_receipt_path(:transaction_id => card_transaction.payment_transaction_id) %>
+            <% end %>
+          <% else %>
+            <%= link_to("QueryAndWallet", admin_unified_payments_query_gateway_path(:transaction_id => card_transaction.payment_transaction_id), :remote => true, confirm: "#{card_transaction.amount} will be walleted to #{card_transaction.user.try(:email) }. Are You Sure?", :method => 'post', :class => 'wallet_link') unless card_transaction.store_credit.present? %>
+          <% end %>
+          </td>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+  <%= paginate @card_transactions %>
+<% else %>
+  No Transactions
+<% end %>

data/app/views/spree/admin/unified_payments/query_gateway.js.erb

@@ -0,0 +1,10 @@
+// Are we crediting user in wallet all the time?
+//[MK] It wont happen all the time. refer to model/callback
+<% if @card_transaction.successful? %>
+  alert('Successfully walleted');
+  $('#<%= @card_transaction.payment_transaction_id %> .action .wallet_link').hide();
+  $('#<%= @card_transaction.payment_transaction_id %> .gateway_order_status').text('<%= @card_transaction.gateway_order_status %>')
+<% else %>
+  alert('Could not wallet the money. Got order status <%= @card_transaction.gateway_order_status %>');
+  $('#<%= @card_transaction.payment_transaction_id %> .gateway_order_status').text('<%= @@card_transaction.gateway_order_status %>')
+<% end %>

data/app/views/spree/admin/unified_payments/receipt.html.erb

@@ -0,0 +1,20 @@
+<div class="logo-container">
+    <%= image_tag(Spree::Config[:admin_interface_logo], :id => 'logo') %>
+</div>  
+<h1>Receipt:</h1>
+<table border="0" cellpadding="5" cellspacing="0">
+  <% mail_content_hash_for_unified(@message, @card_transaction).each_pair do |key, value| %>
+  <tr>
+    <td><%= key.to_s.split('_').inject([]) { |r,s| r += [s.capitalize] }.join(' ') %></td>
+    <td><%= value.to_s %></td>
+  </tr>
+  <% end %>
+  <tr>
+    <td>Order Description</td>
+    <% if @order.line_items.count == 1 %>
+      <td>Payment for <%= @order.line_items.first.product.name + " at #{Spree::Config[:site_name]}"%></td>
+    <% else %>
+      <td>Payment for <%= @order.line_items.count.to_s + " products at #{Spree::Config[:site_name]}"%></td>
+    <% end %>
+  </tr>
+</table>

data/app/views/spree/checkout/payment/_unifiedpaymentmethod.html.erb

@@ -0,0 +1,24 @@
+
+
+<div class="unified-visa-footnote">
+  <%= Spree::Config[:site_name] %> never stores or collects your card details. We securely transfer you to Unified Payments Ltd to complete your purchase. <%= Spree::Config[:site_name] %> is certified by Unified Payments Ltd for security and safety so feel comfortable purchasing on our site.
+  Refer <%= Spree::Config[:site_name] %>'s Delivery, Return, Refund and Cancellation Policy
+</div>
+<div class="visa_learn_more"><span class="visa_content">Service Provided by <br>Unified Payments Services Limited</span></div>
+
+<div name="unified-visa-instructions" >
+  <div class="instructions_list">
+    <h6 class="subtaxon-title">About Verified by Visa</h6>
+    <p class="rows">Enrolling your card for Verified by Visa.  <%= Spree::Config[:site_name] %> is protected with VbV and requires that the card is enrolled to participate in the VbV program. To enrol Visa cards issued by Nigerian Banks, you would need to follow the steps outlined below:</p>
+    Locate a nearest VISA/VPAY enabled ATM<br/>
+      Insert your card and punch in your  PIN <br/>
+      Select the PIN change option <br/>
+      Select the Internet PIN (i-PIN) change option <br/>
+      Insert any four - six digits of your choice as your iPIN<br/>
+      Re-enter the digits entered in Step 5 above<br/>
+      If you have performed the above steps correctly, a message is displayed informing you you’re your PIN was changed successfully. This means that your card is now enrolled in the VbV (Verified by Visa) program and may be used for any internet related transactions. <br/>
+      Note that the word ‘iPIN’ , ‘Password’ and VbV code are the same<br/>
+      You can now pay/buy on <%= Spree::Config[:site_name] %>.com, VbV enabled site to shop securely <br/>
+    </ol>
+  </div>
+</div>

data/app/views/spree/transaction_notification_mailer/send_mail.html.erb

@@ -0,0 +1,20 @@
+
+<table border="0" cellpadding="5" cellspacing="0">
+  <tr>
+    <th colspan="2" align="left">Your Unified Payment Transaction was <%= @card_transaction.status %>. Below mentioned are the details</th>
+  </tr>
+  <% mail_content_hash_for_unified(@message, @card_transaction).each_pair do |key, value| %>
+  <tr>
+    <td><%= key.to_s.split('_').inject([]) { |r,s| r += [s.capitalize] }.join(' ') %></td>
+    <td>: <%= value.to_s %></td>
+  </tr>
+  <% end %>
+  <tr>
+    <td>Order Description</td>
+    <% if @card_transaction.order.line_items.count == 1 %>
+      <td>: Payment for <%= @card_transaction.order.line_items.first.product.name + " at #{Spree::Config[:site_name]}"%></td>
+    <% else %>
+      <td>: Payment for <%= @card_transaction.order.line_items.count.to_s + " products at #{Spree::Config[:site_name]}"%></td>
+    <% end %>
+  </tr>
+</table>

data/app/views/spree/unified_payments/approved.html.erb

@@ -0,0 +1,25 @@
+<% unless flash[:error] %>
+<div id="approved_notice"> Transaction was completed successfully and your order has been processed. <br>
+  <%= @notice %> </div>
+<table id="unified_payments_approved_info">
+  <tr>
+    <td class='info_attr' width="280" valign="top">Response :</td>
+    <td class='info_val' align="left" valign="top"><%= @card_transaction.response_description %></td>
+  </tr>
+  <tr>
+    <td class='info_attr' valign="top">Order Description:</td>
+    <td class='info_val' align="left" valign="top"<%= @card_transaction.order_description %></td>
+  </tr>
+  <tr>
+    <td class='info_attr' valign="top">Amount:</td>
+    <td class='info_val' align="left" valign="top"><%= number_to_currency(@card_transaction.amount) %></td>
+  </tr>
+  <tr>
+    <td class='info_attr' valign="top">Merchant Reference Number:</td>
+    <td class='info_val' align="left" valign="top"><%= @card_transaction.payment_transaction_id %></td>
+  </tr>
+</table>
+<div id="unified_payment_detail_link_container">View <a href="/orders/<%= @card_transaction.order.number %>" target="_parent">Order Details</a></div>
+<% else %>
+<div id="approved_fail_notice"> Order was not processed. Please contact support team for any queries.</div>
+<% end %>

data/app/views/spree/unified_payments/canceled.html.erb

@@ -0,0 +1 @@
+<%= link_to 'Back To Cart', cart_path, :target => "_parent", :class => 'button' %>

data/app/views/spree/unified_payments/create.html.erb

@@ -0,0 +1,8 @@
+<% unless @payment_url %>
+<div id="card_error">
+  <%= flash[:error] %>
+</div>
+<% else %>
+<p>This transaction will expire in <%= TRANSACTION_LIFETIME %> minutes. Please finish payment within <%= TRANSACTION_LIFETIME %> minutes.</p>
+<a href=<%= @payment_url %> target='_parent' class="button">Proceed to Payment</a>
+<% end %>