spree-bank-transfer 2.2.2 → 2.2.4

data/README.md

@@ -1,7 +1,7 @@
 Spree Bank Transfer [![Code Climate](https://codeclimate.com/github/vinsol/spree_bank_transfer.png)](https://codeclimate.com/github/vinsol/spree_bank_transfer) [![Build Status](https://travis-ci.org/vinsol/spree_bank_transfer.png?branch=master)](https://travis-ci.org/vinsol/spree_bank_transfer)
 =================
 
-This Spree extension allows admin to provide bank transfer payment method to its users for.
+Spree Bank Transfer extension creates a new payment method in Spree. This payment method allows customers to pay by transferring money directly into merchant’s  bank account.  It also allows admin to provide their Bank account's (Merchant Bank Account) details which will be displayed to customers while checkout, and they can use this information to make payment for their orders. This extension also facilitate admin to Activate/Deactivate Bank accounts.
 
 
 Installation
@@ -30,13 +30,54 @@ bundle
 bundle exec rails g spree_bank_transfer:install
 ```
 
-Use
+How it works: 
 ---
-Login as Admin and create a new payment method with Spree::PaymentMethod::BankTransfer as provider class.
 
-Create bank details under configuration/banks.
+* To add Bank Transfer feature, Admin needs to add “Bank Transfer” payment method:
 
-Checkout and select bank transfer payment method. Here, user can see the list of bank details.
+   Configuration -> Payment Methods -> New payment Method
+   
+   You need to select “Spree::PaymentMethod::BankTransfer” as the Provider
+
+* Add bank account information from “Banks” link on “Configuration” page.
+  
+  - Provide Name of the bank
+  - Provide Account number
+  - Select “Status” check box 
+
+    ![Listing Banks](http://vinsol.com/gems_screenshots/spree-bank-transfer/list%20banks.png)
+    
+    **Bank Account will be visible on Checkout Page only if it is Active.**
+* After adding the payment method and bank details (as stated above), this payment method will be visible on Checkout page while making payment against an order.
+
+*  Active merchant **accounts number** will also be visible on Checkout page under this method.
+
+    ![Checkout](http://vinsol.com/gems_screenshots/spree-bank-transfer/checkout%20page.png)
+
+* Customer will be able to order by completing the order with this method and can transfer money equal to total order value directly into any one of the merchant’s bank account.
+
+* After receiving amount into his account, admin can update order by following the steps: 
+
+    - On ‘Orders’ tab, click on order number to go to the order’s details page..
+    - Select “Payments” link.
+    - Mark the payment “Capture”
+    ![Order Page](http://vinsol.com/gems_screenshots/spree-bank-transfer/order%20page.png)
+
+* The order will not be marked Completed  until admin captures the payment as mentioned in step above.
+
+
+
+
+Contributing
+------------
+
+1. Fork the repo.
+2. Clone your repo.
+3. Run `bundle install`.
+4. Run `bundle exec rake test_app` to create the test application in `spec/test_app`.
+5. Make your changes.
+6. Ensure specs pass by running `bundle exec rspec spec`.
+7. Submit your pull request.
 
 Testing
 -------
@@ -56,17 +97,6 @@ Simply add this require statement to your spec_helper:
 require 'spree_bank_transfer/factories'
 ```
 
-Contributing
-------------
-
-1. Fork the repo.
-2. Clone your repo.
-3. Run `bundle install`.
-4. Run `bundle exec rake test_app` to create the test application in `spec/test_app`.
-5. Make your changes.
-6. Ensure specs pass by running `bundle exec rspec spec`.
-7. Submit your pull request.
-
 
 Credits
 -------

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

@@ -0,0 +1,9 @@
+$(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;
+  });
+});

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

@@ -0,0 +1 @@
+.bt_payment_form { margin-left: 10px;}

data/app/controllers/spree/content_controller_decorator.rb

@@ -0,0 +1,5 @@
+Spree::ContentController.class_eval do
+  def bank_transfer
+    render :layout => false
+  end
+end

data/app/controllers/spree/payments_controller.rb

@@ -0,0 +1,29 @@
+module Spree
+  class PaymentsController < Spree::StoreController
+    before_filter :authenticate_spree_user!
+    before_filter :find_payment
+
+    def update
+      @payment.validate_bank_details = true
+      if @payment.update_attributes(payment_params)
+        flash[:notice] = Spree.t(:payment_successfully_updated)
+      else
+        flash[:error] = @payment.errors.full_messages.to_sentence
+      end
+      redirect_to :back
+    end
+
+    def find_payment
+      @payment = spree_current_user.payments.where(:id => params[:id]).first
+      unless @payment
+        flash[:error] = Spree.t(:payment_not_found)
+        redirect_to :back
+      end
+    end
+    
+    private
+      def payment_params
+        params.require(:payment).permit(:bank_name, :account_no, :transaction_reference_no)
+      end
+  end
+end

data/app/models/spree/bank.rb

@@ -3,6 +3,6 @@ module Spree
     validates :name, :account_no , :presence => true
     validates_uniqueness_of :account_no , :scope => :name
 
-    scope :active, where(:active => true)
+    scope :active, -> { where(:active => true) }
   end
 end

data/app/models/spree/payment_decorator.rb

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

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,3 @@
+Spree::User.class_eval do
+  has_many :payments, :through => :orders
+end

data/app/overrides/add_bank_details_form_to_order_show.rb

@@ -0,0 +1,24 @@
+Deface::Override.new(
+  :virtual_path => 'spree/orders/show',
+  :name => 'add_bank_details_form_to_order_show',
+  :insert_before => "[data-hook='links']",
+  :text => %q{
+    <% if bank_transfer_payment = @order.payments.from_bank_transfer.first %>
+      <%= form_for bank_transfer_payment, :html => { :class => "bt_payment_form" } do |f| %>
+        <table>
+          <tr>
+            <td><%= Spree.t(:bank_name) %></td><td><%= f.text_field :bank_name %></td>
+          </tr>
+          <tr>
+            <td><%= Spree.t(:account_no) %></td><td><%= f.text_field :account_no %></td>
+          </tr>
+          <tr>
+            <td><%= Spree.t(:transaction_reference_no) %></td><td><%= f.text_field :transaction_reference_no %></td>
+          </tr>
+        </table>
+        <br>
+        <%= f.submit "Submit" %>
+      <% end %>  
+    <% end %>  
+  }
+)

data/app/overrides/add_payment_reference_details.rb

@@ -0,0 +1,33 @@
+Deface::Override.new(
+  :virtual_path => 'spree/admin/payments/_list',
+  :name => 'add_payment_reference_details',
+  :insert_after => "table.index",
+  :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>
+        <table class="index">
+          <thead>
+            <tr data-hook="payments_header">
+              <th><%= Spree.t(:bank_name) %></th>
+              <th><%= Spree.t(:account_no) %></th>
+              <th><%= Spree.t(:transaction_reference_no) %></th>
+              <th class="actions"></th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <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>
+            </tr>
+          </tbody>
+        </table>
+      </fieldset>
+    <% end %>
+  }
+)
+
+
+
+

data/app/overrides/filter_results_by_transaction_reference_no.rb

@@ -0,0 +1,29 @@
+Deface::Override.new(
+  :virtual_path => 'spree/admin/orders/index',
+  :name => 'filter_results_by_transaction_reference_no',
+  :insert_after => "div.omega.four.columns",
+  :text => %q{
+    <div class="clearfix"></div>
+    <div class="field-block alpha four columns">
+      <div class="field checkbox">
+        <label>
+          <%= f.check_box :payments_transaction_reference_no_not_null %>
+          <%= Spree.t(:only_show_orders_with_payment_reference_number) %>
+        </label>
+      </div>
+
+      <div class="field">
+        <%= label_tag nil, Spree.t(:payment_state) %>
+        <%= f.select :payments_state_eq, Spree::Payment.state_machines[:state].states.collect {|s| [s.name, s.value]}, {:include_blank => true}, :class => 'select2' %>
+      </div>
+    </div>
+  }
+)       
+
+
+
+
+
+
+
+

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

@@ -1,3 +1,5 @@
+<%= 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

@@ -0,0 +1,23 @@
+<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>
+    <% end %>
+  </table>
+<% end %>

data/config/locales/en.yml

@@ -3,3 +3,10 @@
 
 en:
   hello: "Hello world"
+  spree:
+    payment_not_found: "Payment not found"
+    payment_successfully_updated: "Payment successfully updated"
+    payment_reference_details: "Payment Reference Details"
+    bank_name: "Bank Name"
+    account_no: 'Account No'
+    transaction_reference_no: 'Transaction Reference No'

data/config/routes.rb

@@ -5,4 +5,6 @@ Spree::Core::Engine.routes.draw do
       put :toggle_activation, :on => :member
     end
   end
+  resources :payments, :only => :update
+  get '/content/bank_transfer', :to => 'content#bank_transfer', :as => :bank_transfer_instructions
 end

data/db/migrate/20140519125402_add_bank_name_account_number_and_transaction_reference_number_to_payments.rb

@@ -0,0 +1,7 @@
+class AddBankNameAccountNumberAndTransactionReferenceNumberToPayments < ActiveRecord::Migration
+  def change
+    add_column :spree_payments, :bank_name, :string
+    add_column :spree_payments, :account_no, :string
+    add_column :spree_payments, :transaction_reference_no, :string
+  end
+end

data/spec/controllers/spree/content_controller_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper' 
+
+describe Spree::ContentController do
+  before do
+    controller.stub(:authenticate_spree_user!).and_return(true)
+    @user = mock_model(Spree::User, :generate_spree_api_key! => false, :last_incomplete_spree_order => nil)
+    controller.stub(:spree_current_user).and_return(@user)
+  end
+
+  describe "GET bank_transfer" do
+    it "renders bank_transfer" do
+      get :bank_transfer, :use_route => 'spree'
+      response.should render_template("bank_transfer")
+    end
+  end
+end

data/spec/controllers/spree/payments_controller_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Spree::PaymentsController do
+  before do
+    controller.stub(:authenticate_spree_user!).and_return(true)
+    @user = mock_model(Spree::User, :generate_spree_api_key! => false, :last_incomplete_spree_order => nil)
+    controller.stub(:spree_current_user).and_return(@user)
+    
+    @payment = mock_model(Spree::Payment)
+    @current_user_payments = double("current_user_payments", :where => [@payment])
+    @user.stub(:payments).and_return(@current_user_payments)
+    request.env["HTTP_REFERER"] = "http://localhost"
+  end
+
+  shared_examples_for "request which finds payment" do
+
+    it "finds payment" do
+      @current_user_payments.should_receive(:where).with(:id => 'payment_id')
+      send_request
+    end
+
+    it "assigns @payment" do
+      send_request
+      assigns(:payment).should eq(@payment)
+    end
+
+    context 'when payment not found' do
+      before do
+        @current_user_payments.stub(:where).and_return([])
+      end
+
+      it "sets flash message" do
+        send_request
+        flash[:error].should eq("Payment not found")
+      end
+
+      it "redirects to back" do
+        send_request
+        response.should redirect_to(:back)
+      end
+    end
+  end
+
+  describe "PATCH update" do
+    before do
+      @payment.stub(:validate_bank_details=)
+      @payment.stub(:update_attributes)
+    end
+
+    def send_request
+      patch :update, :id => 'payment_id', :payment => { :bank_name => 'bank_name', :account_no => "account_no", :transaction_reference_no => "transaction_reference_no" }, :use_route => 'spree'
+    end
+
+    it_behaves_like "request which finds payment"
+
+    it "sets validate_bank_details to true" do
+      @payment.should_receive(:validate_bank_details=).with(true)
+      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")
+      send_request
+    end
+
+    context 'when payment updated' do
+      before do
+        @payment.stub(:update_attributes).and_return(true)
+      end
+
+      it "sets flash message" do
+        send_request
+        flash[:notice].should eq("Payment successfully updated")
+      end
+    end
+
+    context 'when payment not updated' do
+      before do
+        @payment.stub(:update_attributes).and_return(false)
+        @payment.stub_chain(:errors, :full_messages).and_return(["some error occurred"])
+      end
+
+      it "sets flash error" do
+        send_request
+        flash[:error].should eq("some error occurred")
+      end
+    end
+    
+    it "redirects to back" do
+      send_request
+      response.should redirect_to(:back)
+    end
+  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" })
+    end
+  end
+end

data/spec/models/spree/payment_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Spree::Payment do
+  context 'when validate_bank_details' do
+    before do
+      subject.validate_bank_details = true
+    end
+
+    it { should validate_presence_of(:bank_name) }
+    it { should validate_presence_of(:account_no) }
+    it { should validate_presence_of(:transaction_reference_no) }
+  end
+
+  context 'when validate_bank_details not true' do
+    it { should_not validate_presence_of(:bank_name) }
+    it { should_not validate_presence_of(:account_no) }
+    it { should_not validate_presence_of(:transaction_reference_no) }
+  end
+
+  describe ".from_bank_transfer" do
+    before do
+      check_payment_method = Spree::PaymentMethod::Check.new
+      check_payment_method.name = "Check Payment Method"
+      check_payment_method.save!
+
+      bank_transfer_payment_method = Spree::PaymentMethod::BankTransfer.new
+      bank_transfer_payment_method.name = "Bank Transfer"
+      bank_transfer_payment_method.save!
+
+      @order = Spree::Order.new
+      @order.save!
+      
+      @payment1 = Spree::Payment.new
+      @payment1.order_id = @order.id
+      @payment1.payment_method_id = check_payment_method.id
+      @payment1.save!
+
+      @payment2 = Spree::Payment.new
+      @payment2.order_id = @order.id
+      @payment2.payment_method_id = check_payment_method.id
+      @payment2.save!
+
+      @bank_transfer_payment1 = Spree::Payment.new
+      @bank_transfer_payment1.order_id = @order.id
+      @bank_transfer_payment1.payment_method_id = bank_transfer_payment_method.id
+      @bank_transfer_payment1.save!
+
+      @bank_transfer_payment2 = Spree::Payment.new
+      @bank_transfer_payment2.order_id = @order.id
+      @bank_transfer_payment2.payment_method_id = bank_transfer_payment_method.id
+      @bank_transfer_payment2.save!
+    end
+
+    it "returns payments with payment method as bank_transfer" do
+      Spree::Payment.from_bank_transfer.should =~ [@bank_transfer_payment1, @bank_transfer_payment2]
+    end
+  end
+end

data/spec/models/spree/user_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Spree::User do
+  it { should have_many(:payments).through(:orders) }
+end

data/spree_bank_transfer.gemspec

@@ -2,12 +2,12 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree-bank-transfer'
-  s.version     = '2.2.2'
+  s.version     = '2.2.4'
   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'
 
-  s.authors   = ['Mohit Bansal', 'Vishal Zambre']
+  s.author    = 'Mohit Bansal'
   s.email     = 'info@vinsol.com'
   s.homepage  = 'http://vinsol.com'
   s.license   = "MIT"

metadata

@@ -1,22 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: spree-bank-transfer
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 15
   prerelease: 
   segments: 
   - 2
   - 2
-  - 2
-  version: 2.2.2
+  - 4
+  version: 2.2.4
 platform: ruby
 authors: 
 - Mohit Bansal
-- Vishal Zambre
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2014-05-12 00:00:00 Z
+date: 2014-05-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: spree_core
@@ -56,14 +55,21 @@ files:
 - app/assets/stylesheets/admin/spree_bank_transfer.css
 - app/assets/stylesheets/store/spree_bank_transfer.css
 - app/controllers/spree/admin/banks_controller.rb
+- app/controllers/spree/content_controller_decorator.rb
+- app/controllers/spree/payments_controller.rb
 - app/helpers/.DS_Store
 - app/helpers/spree/.DS_Store
 - app/helpers/spree/admin/banks_helper.rb
 - app/models/.DS_Store
 - app/models/spree/.DS_Store
 - app/models/spree/bank.rb
+- app/models/spree/payment_decorator.rb
 - 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_banks_to_admin_configuration_sidebar.rb
+- app/overrides/add_payment_reference_details.rb
+- app/overrides/filter_results_by_transaction_reference_no.rb
 - app/views/.DS_Store
 - app/views/spree/admin/banks/_form.html.erb
 - app/views/spree/admin/banks/edit.html.erb
@@ -74,10 +80,12 @@ files:
 - app/views/spree/admin/payments/source_views/_banktransfer.html.erb
 - app/views/spree/checkout/.DS_Store
 - app/views/spree/checkout/payment/_banktransfer.html.erb
+- app/views/spree/content/bank_transfer.html.erb
 - config/locales/en.yml
 - config/routes.rb
 - 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
 - lib/generators/spree_bank_transfer/.DS_Store
 - lib/generators/spree_bank_transfer/install/install_generator.rb
 - lib/spree_bank_transfer.rb
@@ -85,8 +93,12 @@ files:
 - lib/spree_bank_transfer/factories.rb
 - script/rails
 - spec/controllers/spree/admin/banks_controller_spec.rb
+- spec/controllers/spree/content_controller_spec.rb
+- spec/controllers/spree/payments_controller_spec.rb
 - spec/models/spree/bank_spec.rb
 - spec/models/spree/payment_method/bank_transfer_spec.rb
+- spec/models/spree/payment_spec.rb
+- spec/models/spree/user_spec.rb
 - spec/spec_helper.rb
 - spree_bank_transfer.gemspec
 homepage: http://vinsol.com