spree-bank-transfer 2.2.4 → 2.2.5

data/app/assets/javascripts/store/spree_bank_transfer.js.erb

@@ -0,0 +1,30 @@
+//= require jquery.ui.datepicker
+$(document).ready(function() {
+  $('#banktransfer_instructions').click(function(event) {
+    newwindow = window.open($(this).attr('href'), 'bank transfer', 'left=20,top=20,width=650,height=750,toolbar=0,resizable=0,scrollbars=1');
+    if (window.focus) {
+      newwindow.focus();
+    }
+    return false;
+  });
+
+  $('[name="payment[deposited_on]"]').datepicker({dateFormat: '<%= Spree.t(:js_format, :scope => "date_picker", :default => "yy/mm/dd") %>'});
+
+  $('.add_bt_details').click(function() {
+    $(this).hide();
+    $('.bt_payment_form').show();
+  });
+
+  $('.bt_payment_form input[type="submit"]').click(function(event) {
+    var empty_fields = $('.required_field').filter(function() { return !$(this).val().trim().length }), empty_fields_names = []
+    if ($(empty_fields).length) {
+      $(empty_fields).each(function() {
+        empty_fields_names.push($(this).attr('field-name'));
+      });
+
+      alert(empty_fields_names.join(', ') + " can't be blank");
+      event.preventDefault();
+      return false;
+    }
+  });
+});

data/app/assets/stylesheets/store/spree_bank_transfer.css

@@ -1 +1,9 @@
-.bt_payment_form { margin-left: 10px;}
+/*
+*= require jquery.ui.datepicker
+*/
+
+.bt_payment_form { margin-left: -10px; }
+.bt_payment_form table { border-collapse: inherit; }
+.bt_payment_form [type="submit"] { margin-left: 10px; }
+.bt_payment_form input[type="text"], .bt_payment_form input[type="date"] { width: 138px; }
+.hidden { display: none; }

data/app/controllers/spree/payments_controller.rb

@@ -4,11 +4,11 @@ module Spree
     before_filter :find_payment
 
     def update
-      @payment.validate_bank_details = true
-      if @payment.update_attributes(payment_params)
+      payment_details = PaymentDetails.new(@payment, payment_params)
+      if payment_details.save
         flash[:notice] = Spree.t(:payment_successfully_updated)
       else
-        flash[:error] = @payment.errors.full_messages.to_sentence
+        flash[:error] = payment_details.errors.to_sentence
       end
       redirect_to :back
     end
@@ -23,7 +23,7 @@ module Spree
     
     private
       def payment_params
-        params.require(:payment).permit(:bank_name, :account_no, :transaction_reference_no)
+        params.require(:payment).permit(:deposited_on, :bank_name, :account_no, :transaction_reference_no)
       end
   end
 end

data/app/models/spree/payment_decorator.rb

@@ -1,6 +1,10 @@
 Spree::Payment.class_eval do
   attr_accessor :validate_bank_details
-  validates :bank_name, :account_no, :transaction_reference_no, :presence => true, :if => :validate_bank_details
+  validates :bank_name, :account_no, :transaction_reference_no, :deposited_on, :presence => true, :if => :validate_bank_details
 
   scope :from_bank_transfer, -> { joins(:payment_method).where(:spree_payment_methods => { :type => 'Spree::PaymentMethod::BankTransfer' }) }
+
+  def details_submitted?
+    transaction_reference_no?
+  end
 end

data/app/overrides/add_bank_details_form_to_order_show.rb

@@ -1,23 +1,32 @@
 Deface::Override.new(
-  :virtual_path => 'spree/orders/show',
+  :virtual_path => 'spree/shared/_order_details',
   :name => 'add_bank_details_form_to_order_show',
-  :insert_before => "[data-hook='links']",
+  :insert_bottom => ".payment-info",
   :text => %q{
     <% if bank_transfer_payment = @order.payments.from_bank_transfer.first %>
-      <%= form_for bank_transfer_payment, :html => { :class => "bt_payment_form" } do |f| %>
+      <% unless bank_transfer_payment.details_submitted? %>
+        <br>
+        <%= link_to Spree.t(:add_details), "javascript:void(0);", :class => 'button add_bt_details' %>
+      <% end %>
+      <%= form_for bank_transfer_payment, :html => { :class => "bt_payment_form #{bank_transfer_payment.details_submitted? ? '' : 'hidden'}" } do |f| %>
         <table>
           <tr>
-            <td><%= Spree.t(:bank_name) %></td><td><%= f.text_field :bank_name %></td>
+            <td><%= Spree.t(:deposited_on) %></td><td><%= f.date_field :deposited_on, :disabled => bank_transfer_payment.details_submitted?, :class => 'required_field', 'field-name' => 'Deposited on' %></td>
+          </tr>
+          <tr>
+            <td><%= Spree.t(:bank_name) %></td><td><%= f.text_field :bank_name, :disabled => bank_transfer_payment.details_submitted?, :class => 'required_field', 'field-name' => 'Bank name' %></td>
           </tr>
           <tr>
-            <td><%= Spree.t(:account_no) %></td><td><%= f.text_field :account_no %></td>
+            <td><%= Spree.t(:account_no) %></td><td><%= f.text_field :account_no, :disabled => bank_transfer_payment.details_submitted?, :class => 'required_field', 'field-name' => 'Account No.' %></td>
           </tr>
           <tr>
-            <td><%= Spree.t(:transaction_reference_no) %></td><td><%= f.text_field :transaction_reference_no %></td>
+            <td><%= Spree.t(:transaction_reference_no) %></td><td><%= f.text_field :transaction_reference_no, :disabled => bank_transfer_payment.details_submitted?, :class => 'required_field', 'field-name' => 'Transaction Reference No.' %></td>
           </tr>
         </table>
         <br>
-        <%= f.submit "Submit" %>
+        <% unless bank_transfer_payment.details_submitted? %>
+          <%= f.submit "Submit", :confirm => "Are you sure you want to Submit these details? You will not be able to Edit these details once Submitted. Press 'OK' to confirm."  %>
+        <% end %>
       <% end %>  
     <% end %>  
   }

data/app/overrides/add_bank_transfer_instructions_link_to_payment.rb

@@ -0,0 +1,9 @@
+Deface::Override.new(
+  :virtual_path => 'spree/checkout/_payment',
+  :name => 'add_bank_transfer_instructions_link_to_payment',
+  :insert_after => "#payment-method-fields",
+  :text => %q{
+    <p><%= link_to "How Bank Transfer works?", bank_transfer_instructions_path, :id => 'banktransfer_instructions', :target => "_blank" %></p>
+  }
+)
+

data/app/overrides/add_payment_reference_details.rb

@@ -5,10 +5,11 @@ Deface::Override.new(
   :text => %q{
     <% if bank_transfer_payment = @order.payments.from_bank_transfer.first %>
       <fieldset class="no-border-bottom" >
-        <legend align="center"><%= Spree.t(:payment_reference_details) %></legend>
+        <legend align="center"><%= Spree.t(:bank_transfer_payment_reference_details) %></legend>
         <table class="index">
           <thead>
             <tr data-hook="payments_header">
+              <th><%= Spree.t(:deposited_on) %></th>
               <th><%= Spree.t(:bank_name) %></th>
               <th><%= Spree.t(:account_no) %></th>
               <th><%= Spree.t(:transaction_reference_no) %></th>
@@ -17,6 +18,7 @@ Deface::Override.new(
           </thead>
           <tbody>
             <tr>
+              <td class='align-center'><%= bank_transfer_payment.deposited_on %></td>
               <td class='align-center'><%= bank_transfer_payment.bank_name %></td>
               <td class='align-center'><%= bank_transfer_payment.account_no %></td>
               <td class='align-center'><%= bank_transfer_payment.transaction_reference_no %></td>

data/app/overrides/filter_results_by_transaction_reference_no.rb

@@ -8,7 +8,7 @@ Deface::Override.new(
       <div class="field checkbox">
         <label>
           <%= f.check_box :payments_transaction_reference_no_not_null %>
-          <%= Spree.t(:only_show_orders_with_payment_reference_number) %>
+          <%= Spree.t(:only_show_orders_with_bank_transfer_payment_reference_number) %>
         </label>
       </div>
 

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

@@ -1,5 +1,3 @@
-<%= link_to "How it works?", bank_transfer_instructions_path, :id => 'banktransfer_instructions', :target => "_blank" %>
-<br><br>
 <% if (banks = Spree::Bank.active).any? %>
   <table>
     <tr>

data/app/views/spree/content/bank_transfer.html.erb

@@ -1,23 +1,32 @@
-<p>Deposit order amount in one of the below mentioned Bank Accounts.</p>
-<p>Note: A payment reference number will be generated by the bank.</p>
-Enter this payment reference number on Order's page by following steps:<br><br>
-a) Select "My Account" from top right corner. <br>
-b) Select "Order" link from drop down. <br>
-c) Click on the Order number. <br>
-d) Provide payment details and Submit.
-<br><br>
-
-<% if (banks = Spree::Bank.active).any? %>
-  <table border="1">
-    <tr>
-      <th>Name</th>
-      <th>Account No</th>
-    </tr>
-    <% banks.each do |bank| %>
-      <tr>
-        <td><%= bank.name %></td>
-        <td><%= bank.account_no %></td>
-      </tr>
+<h4>HOW BANK TRANSFER WORKS</h4>
+<b>Steps:</b>
+<ol>
+  <li>Deposit order total in one of the below mentioned bank accounts. After this payment a payment reference number will be provided by the bank.
+    <% if (banks = Spree::Bank.active).any? %>
+      <div style="padding:20px 0">
+      <table border="1" align='center' width="60%">
+        <tr>
+          <th><center>Name</center></th>
+          <th><center>Account No</center></th>
+        </tr>
+        <% banks.each do |bank| %>
+          <tr>
+            <td><center><%= bank.name %></center></td>
+            <td><center><%= bank.account_no %></center></td>
+          </tr>
+        <% end %>
+      </table>
+      </div>
     <% end %>
-  </table>
-<% end %>
+  </li>
+  <li>Enter this payment reference number on Order Details page by following steps:
+    <ol style="padding:10px 0 0 20px" type='a'>
+      <li>Go to "My Account" page.</li>
+      <li>Select Order for which you want to provide details.</li> 
+      <li>Click on "Add Details" link visible in "Payment Information" column.</li>
+      <li>Provide payment details and Submit.</li>
+      <br><br>
+      <%= image_tag 'payment_details.png' %>
+    </ol>
+  </li>
+</ol>

data/db/migrate/20140530055151_add_column_deposited_on_to_spree_payments.rb

@@ -0,0 +1,5 @@
+class AddColumnDepositedOnToSpreePayments < ActiveRecord::Migration
+  def change
+    add_column :spree_payments, :deposited_on, :date
+  end
+end

data/lib/payment_details.rb

@@ -0,0 +1,21 @@
+class PaymentDetails
+  attr_accessor :payment, :errors, :params
+
+  def initialize(payment, params)
+    self.payment = payment
+    self.params = params
+    self.errors = []
+  end
+
+  def save
+    if payment.details_submitted?
+      errors << "Payment Details can be submitted only once."
+    else
+      payment.validate_bank_details = true
+      unless payment.update_attributes(params)
+        errors << payment.errors.full_messages.to_sentence
+      end
+    end
+    errors.empty?
+  end
+end

data/spec/controllers/spree/payments_controller_spec.rb

@@ -43,8 +43,8 @@ describe Spree::PaymentsController do
 
   describe "PATCH update" do
     before do
-      @payment.stub(:validate_bank_details=)
-      @payment.stub(:update_attributes)
+      @payment_details = double('payment_details', :save => true)
+      PaymentDetails.stub(:new).and_return(@payment_details)
     end
 
     def send_request
@@ -53,34 +53,31 @@ describe Spree::PaymentsController do
 
     it_behaves_like "request which finds payment"
 
-    it "sets validate_bank_details to true" do
-      @payment.should_receive(:validate_bank_details=).with(true)
+
+    it "creates new payment details" do
+      PaymentDetails.should_receive(:new).with(@payment, { 'bank_name' => 'bank_name', 'account_no' => "account_no", 'transaction_reference_no' => "transaction_reference_no" })
       send_request
     end
 
-    it "update_attributes" do
-      @payment.should_receive(:update_attributes).with("bank_name" => 'bank_name', "account_no" => "account_no", "transaction_reference_no" => "transaction_reference_no")
+    it "saves payment_details" do
+      @payment_details.should_receive(:save)
       send_request
     end
 
-    context 'when payment updated' do
-      before do
-        @payment.stub(:update_attributes).and_return(true)
-      end
-
-      it "sets flash message" do
+    context 'when payment details saved successfully' do
+      it 'sets flash message' do
         send_request
         flash[:notice].should eq("Payment successfully updated")
       end
     end
 
-    context 'when payment not updated' do
+    context 'when payment details not saved' do
       before do
-        @payment.stub(:update_attributes).and_return(false)
-        @payment.stub_chain(:errors, :full_messages).and_return(["some error occurred"])
+        @payment_details.stub(:save).and_return(false)
+        @payment_details.stub(:errors).and_return(["some error occurred"])
       end
 
-      it "sets flash error" do
+      it 'sets flash error' do
         send_request
         flash[:error].should eq("some error occurred")
       end
@@ -93,9 +90,9 @@ describe Spree::PaymentsController do
   end
 
   describe "#payment_params" do
-    it "permits only bank_name, account_no, transaction_reference_no" do
-      controller.params = { :payment => { :bank_name => 'Bank Name', :account_no => 'Account number', :transaction_reference_no => "transaction reference number", :order_id => 'order_id' } }
-      controller.send(:payment_params).should eq({ "bank_name" => "Bank Name", "account_no" => "Account number", "transaction_reference_no" => "transaction reference number" })
+    it "permits only bank_name, account_no, transaction_reference_no, deposited_on" do
+      controller.params = { :payment => { :bank_name => 'Bank Name', :account_no => 'Account number', :transaction_reference_no => "transaction reference number", :order_id => 'order_id', :deposited_on => 'deposited_on' } }
+      controller.send(:payment_params).should eq({ "bank_name" => "Bank Name", "account_no" => "Account number", "transaction_reference_no" => "transaction reference number", 'deposited_on' => 'deposited_on' })
     end
   end
 end

data/spec/lib/payment_details_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper' 
+
+describe PaymentDetails do
+  before do
+    @payment = mock_model(Spree::Payment, :update_attributes => true, :validate_bank_details= => nil)
+    @params = { 'bank_name' => 'bank_name', 'account_no' => "account_no", 'transaction_reference_no' => "transaction_reference_no" }
+    @payment_details = PaymentDetails.new(@payment, @params)
+  end
+
+  describe "#initialize" do
+    it "sets payment" do
+      @payment_details.payment.should eq(@payment)
+    end
+
+    it "sets params" do
+      @payment_details.params.should eq(@params)
+    end
+
+    it "initializes errors" do
+      @payment_details.errors.should eq([])
+    end
+  end
+
+  describe "#save" do
+    context 'when payment details submitted' do
+      before do
+        @payment.stub(:details_submitted?).and_return(true)
+      end
+
+      it "sets errors" do
+        @payment_details.save
+        @payment_details.errors.should eq(["Payment Details can be submitted only once."])
+      end
+
+      it "does not update payment" do
+        @payment.should_not_receive(:update_attributes)
+        @payment_details.save
+      end
+
+      it "returns false" do
+        @payment_details.save.should be_false
+      end
+
+    end
+
+    context 'when payment details not submitted' do
+      before do
+        @payment.stub(:details_submitted?).and_return(false)
+      end
+
+      it 'sets validates_bank_details to true' do
+        @payment.should_receive(:validate_bank_details=).with(true)
+        @payment_details.save
+      end
+
+      it "updates payment attributes" do
+        @payment.should_receive(:update_attributes)
+        @payment_details.save
+      end
+
+      context 'when payment attributes not updated successfully' do
+        before do
+          @payment.stub(:update_attributes).and_return(false)
+          @payment.stub_chain(:errors, :full_messages).and_return(["some error occurred"])
+        end
+
+        it 'sets errors' do
+          @payment_details.save
+          @payment_details.errors.should eq(["some error occurred"])
+        end
+
+        it 'returns false' do
+          @payment_details.save.should be_false
+        end
+      end
+
+      context 'when payment attributes updated successfully' do
+        it 'returns true' do
+          @payment_details.save.should be_true
+        end
+      end
+    end
+  end
+end

data/spec/models/spree/payment_spec.rb

@@ -9,6 +9,7 @@ describe Spree::Payment do
     it { should validate_presence_of(:bank_name) }
     it { should validate_presence_of(:account_no) }
     it { should validate_presence_of(:transaction_reference_no) }
+    it { should validate_presence_of(:deposited_on) }
   end
 
   context 'when validate_bank_details not true' do
@@ -55,4 +56,26 @@ describe Spree::Payment do
       Spree::Payment.from_bank_transfer.should =~ [@bank_transfer_payment1, @bank_transfer_payment2]
     end
   end
+
+  describe "#details_submitted?" do
+    before do
+      @payment = Spree::Payment.new
+    end
+
+    context 'when transaction_reference_no present' do
+      before do
+        @payment.transaction_reference_no = 'transaction_reference_no'
+      end
+
+      it 'is true' do
+        @payment.details_submitted?.should be_true
+      end
+    end
+
+    context 'when transaction_reference_no not present' do
+      it 'is false' do
+        @payment.details_submitted?.should be_false
+      end
+    end
+  end
 end

data/spree_bank_transfer.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree-bank-transfer'
-  s.version     = '2.2.4'
+  s.version     = '2.2.5'
   s.summary     = 'Spree extension to create bank transfer payment method.'
   s.description = 'This Spree extension allows admin to provide bank transfer payment method to its users.'
   s.required_ruby_version = '>= 1.9.3'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: spree-bank-transfer
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 2
   - 2
-  - 4
-  version: 2.2.4
+  - 5
+  version: 2.2.5
 platform: ruby
 authors: 
 - Mohit Bansal
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-05-23 00:00:00 Z
+date: 2014-06-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: spree_core
@@ -50,8 +50,9 @@ files:
 - README.md
 - Rakefile
 - Versionfile
+- app/assets/images/payment_details.png
 - app/assets/javascripts/admin/spree_bank_transfer.js
-- app/assets/javascripts/store/spree_bank_transfer.js
+- app/assets/javascripts/store/spree_bank_transfer.js.erb
 - app/assets/stylesheets/admin/spree_bank_transfer.css
 - app/assets/stylesheets/store/spree_bank_transfer.css
 - app/controllers/spree/admin/banks_controller.rb
@@ -67,6 +68,7 @@ files:
 - app/models/spree/payment_method/bank_transfer.rb
 - app/models/spree/user_decorator.rb
 - app/overrides/add_bank_details_form_to_order_show.rb
+- app/overrides/add_bank_transfer_instructions_link_to_payment.rb
 - app/overrides/add_banks_to_admin_configuration_sidebar.rb
 - app/overrides/add_payment_reference_details.rb
 - app/overrides/filter_results_by_transaction_reference_no.rb
@@ -86,8 +88,10 @@ files:
 - db/migrate/20130717071443_create_table_bank.rb
 - db/migrate/20130717125312_add_index_on_active_on_spree_bank.rb
 - db/migrate/20140519125402_add_bank_name_account_number_and_transaction_reference_number_to_payments.rb
+- db/migrate/20140530055151_add_column_deposited_on_to_spree_payments.rb
 - lib/generators/spree_bank_transfer/.DS_Store
 - lib/generators/spree_bank_transfer/install/install_generator.rb
+- lib/payment_details.rb
 - lib/spree_bank_transfer.rb
 - lib/spree_bank_transfer/engine.rb
 - lib/spree_bank_transfer/factories.rb
@@ -95,6 +99,7 @@ files:
 - spec/controllers/spree/admin/banks_controller_spec.rb
 - spec/controllers/spree/content_controller_spec.rb
 - spec/controllers/spree/payments_controller_spec.rb
+- spec/lib/payment_details_spec.rb
 - spec/models/spree/bank_spec.rb
 - spec/models/spree/payment_method/bank_transfer_spec.rb
 - spec/models/spree/payment_spec.rb

data/app/assets/javascripts/store/spree_bank_transfer.js

@@ -1,9 +0,0 @@
-$(document).ready(function() {
-  $('#banktransfer_instructions').click(function(event) {
-    newwindow = window.open($(this).attr('href'), 'bank transfer', 'left=20,top=20,width=500,height=500,toolbar=0,resizable=0,scrollbars=1');
-    if (window.focus) {
-      newwindow.focus();
-    }
-    return false;
-  });
-});