ba_spree_bank_transfer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d394fa151a642a15400acd2c8d756a3150d6adb95471c5f852563c1363739fc7
+  data.tar.gz: 3428007a4a548aeb27c36cbe0242bac5a16d6efb8c0072f01fa6e42f4a4a1219
+SHA512:
+  metadata.gz: d40c0c552f0c8cf76854b9f3f3cc9bf28ea9566197103e5a2c3ba62962ad92ffd35b1c1e276b089b53915cebeb4717a9d625e48e206ee409a6aca0e6ea052fe1
+  data.tar.gz: 68563e5f073e51c3c23ebdd9b4dcb34635e2b141c01bc23e5634152fb4ab76c5d4995ad030b0bd61793f0af0f2c3a91e23e29efe260fdb0cff9b85db50a8fa97

data/.gitignore

@@ -0,0 +1,15 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - ruby-2.2.2
+script:
+  - bundle exec rake test_app
+  - bundle exec rspec .

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Provides basic authentication functionality for testing parts of your engine
+spree_version = 'master'
+gem 'spree', github: 'spree/spree', branch: spree_version
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: spree_version
+
+gem 'coffee-rails', '~> 5.0.0'
+gem "sass-rails", '~> 6.0.0'
+
+group :test do
+  gem 'minitest'
+  gem 'rspec-rails', '~> 4.0.0'
+  gem 'shoulda-matchers', '~> 4.3.0'
+  gem 'rspec-activemodel-mocks', '~> 1.1.0'
+  gem 'simplecov', require: false
+  gem 'database_cleaner'
+end
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Vinsol
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,110 @@
+# ba_spree_bank_transfer
+
+This is a fork of [spree_bank_transfer](https://github.com/vinsol-spree-contrib/spree_bank_transfer) with additional features and improvements.
+
+ba_spree_bank_transfer is an extension which allows adding a new payment method "Bank Transfer" to existing spree e-commerce store. With the help of this payment method customer can place an order online and pay by transferring money directly into merchant's Bank account. This extension allow merchants to provide their bank account(s) details which in turn is used by customers to order and pay using this method. This extension also facilitate admin to Activate/Deactivate attached Bank accounts. Admin can also filter orders on the basis of the available payment transaction reference numbers with this extension.
+
+## Features
+
+* Supports Ruby 3.1
+* Supports Rails 7.1
+* Supports Spree 4.10
+* Japanese translations included
+* Actively maintained with contributions back to the original project
+
+## Installation
+
+1. Add ba_spree_bank_transfer to your Gemfile:
+
+```ruby
+gem 'ba_spree_bank_transfer'
+```
+
+2. Install the gem using Bundler:
+
+```shell
+bundle install
+```
+
+3. Copy & run migrations:
+
+```shell
+bundle exec rails g ba_spree_bank_transfer:install
+```
+
+## How it works
+
+* To add Bank Transfer feature, Admin needs to add "Bank Transfer" payment method:
+
+   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
+  - Provide "Additional Details", like "Branch Name", "Bank code" etc.
+
+    **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.
+
+**"How Bank Transfer Works" link will open a pop-up window. It will list all steps to complete order with this method.**
+
+* 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 customer deposits money into merchant's account, a payment transaction reference number is provided by the bank. Customer needs to add this payment reference details with the respective order by going to order detail page.
+
+     My Account -> Order no. -> Add details (Payment information column) -> Submit
+
+* Admin will be able to see the payment reference details, added by customer, on the Order detail page.
+
+       Orders -> Order no. ->  Payments
+
+* The order will not be marked Completed until admin captures the payment as mentioned in step above.
+
+      Note: Admin needs to manually verify the transaction details from their bank account before capturing the payment
+
+* Admin can filter orders which has payment transaction reference number by clicking the check box "only show orders with bank transfer payment reference number" on "Orders" page.
+
+## 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
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'ba_spree_bank_transfer/factories'
+```
+
+## License
+
+This extension is available as open source under the terms of either:
+* [GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)](https://www.gnu.org/licenses/agpl-3.0.en.html)
+* [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
+
+## Credits
+
+Originally created by Vinsol.
+Fork maintained by [be agile Co., Ltd.](https://be-agile.jp/).%

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_bank_transfer'
+  Rake::Task['extension:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,7 @@
+'4.1.x' => { branch: '4-1-stable' }
+'3.0.x' => { branch: '3-0-stable' }
+'2.4.x' => { branch: '2-4-stable' }
+'2.3.x' => { branch: '2-3-stable' }
+'2.2.x' => { branch: '2-2-stable' }
+'2.1.x' => { branch: '2-1-stable' }
+'2.0.x' => { branch: '2-0-stable' }

data/app/assets/javascripts/spree/frontend/spree_bank_transfer.js.erb

@@ -0,0 +1,37 @@
+//= require jquery-ui/widgets/datepicker
+$(document).ready(function() {
+  $('#banktransfer_instructions').on("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;
+  });
+
+  var options = $.extend(
+    {}, // empty object
+    $.datepicker.regional['<%= I18n.default_locale %>'], // I18n locale
+    {dateFormat: '<%= Spree.t(:js_format, scope: "date_picker", default: "yy/mm/dd") %>',
+     firstDay: '<%= Spree.t(:first_day, scope: "date_picker", default: "0") %>'}
+  );
+  $.datepicker.setDefaults(options);
+  $('[name="payment[deposited_on]"]').datepicker();
+
+  $('.add_bt_details').on("click", function() {
+    $(this).hide();
+    $('.bt_payment_form').show();
+  });
+
+  $('.bt_payment_form input[type="submit"]').on("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/spree/frontend/spree_bank_transfer.css

@@ -0,0 +1,9 @@
+/*
+ *= require jquery-ui
+ *= require jquery-ui/datepicker
+*/
+.ui-datepicker {
+  width: 18em; /* fix calendar width */
+  padding: .2em .2em 0;
+}
+.hidden { display: none; }

data/app/controllers/spree/admin/banks_controller.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Admin
+    class BanksController < ResourceController
+      def index
+        @banks = Spree::Bank.page(params[:page])
+      end
+
+      def toggle_activation
+        @success = @bank.toggle!(:active)
+      end
+    end
+  end
+end

data/app/controllers/spree/content_controller_decorator.rb

@@ -0,0 +1,8 @@
+module Spree
+  module ContentControllerDecorator
+    def bank_transfer
+    end
+  end
+end
+
+Spree::ContentController.prepend(Spree::ContentControllerDecorator)

data/app/controllers/spree/payments_controller.rb

@@ -0,0 +1,35 @@
+module Spree
+  class PaymentsController < Spree::StoreController
+    ### Uncomment for not allow continue as Guest ###
+    # before_action :authenticate_spree_user!
+    before_action :find_payment
+
+    def update
+      payment_details = PaymentDetails.new(@payment, payment_params)
+      if payment_details.save
+        flash[:notice] = Spree.t(:payment_successfully_updated)
+      else
+        flash[:error] = payment_details.errors.to_sentence
+      end
+      redirect_back(fallback_location: root_path)
+    end
+
+    def find_payment
+      @payment = if spree_current_user
+        spree_current_user.payments.find_by(number: params[:id])
+      else
+        Payment.joins(:order).find_by(number: params[:id], spree_orders: {user_id: nil})
+      end
+
+      unless @payment
+        flash[:error] = Spree.t(:payment_not_found)
+        redirect_back(fallback_location: root_path)
+      end
+    end
+
+    private
+      def payment_params
+        params.require(:payment).permit(:deposited_on, :bank_name, :account_no, :transaction_reference_no, :receipt)
+      end
+  end
+end

data/app/helpers/spree/admin/banks_helper.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Admin
+    module BanksHelper
+
+      def bank_status(bank)
+        bank.active? ? Spree.t(:active) : Spree.t(:inactive)
+      end
+
+      def action_to_toggle_bank_status(bank)
+        bank.active? ? Spree.t(:deactivate) : Spree.t(:activate)
+      end
+
+      def action_text_to_toggle_bank_status(bank)
+        bank.active? ? 'remove-sign' : 'ok-sign'
+      end
+
+    end
+  end
+end

data/app/models/spree/bank.rb

@@ -0,0 +1,8 @@
+module Spree
+  class Bank < ActiveRecord::Base
+    validates :name, :account_no , presence: true
+    validates_uniqueness_of :account_no , scope: :name
+
+    scope :active, -> { where(active: true) }
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Order.class_eval do
+  self.whitelisted_ransackable_associations += %w(payments)
+end

data/app/models/spree/payment_decorator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Spree
+  module PaymentDecorator
+    def self.prepended(base)
+      base.class_eval do
+        attr_accessor :validate_bank_details
+
+        has_one_attached :receipt
+        belongs_to :order
+        validates :bank_name, :deposited_on, :receipt, presence: true, if: :validate_bank_details
+        after_save :update_order_state, if: :validate_bank_details
+        before_save :update_source_type, if: :validate_bank_details
+
+        scope :from_bank_transfer, lambda {
+                                     joins(:payment_method).where(spree_payment_methods: { type: 'Spree::PaymentMethod::BankTransfer' })
+                                   }
+
+        self.whitelisted_ransackable_attributes = %w[bank_name state]
+      end
+    end
+
+    def details_submitted?
+      bank_name?
+    end
+
+    private
+
+    def update_source_type
+      self.source_type = 'Spree::PaymentMethod::BankTransfer'
+    end
+
+    def update_order_state
+      order.update(payment_state: :paid)
+    end
+  end
+end
+
+# Register the decorator
+Spree::Payment.prepend(Spree::PaymentDecorator)

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

@@ -0,0 +1,48 @@
+module Spree
+  class PaymentMethod::BankTransfer < 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)
+      simulated_successful_billing_response
+    end
+
+    def void(*args)
+      simulated_successful_billing_response
+    end
+
+    def source_required?
+      false
+    end
+
+    def credit(*args)
+      simulated_successful_billing_response
+    end
+
+    def public_preferences
+      super.merge(bank_accounts: Spree::Bank.active)
+    end
+
+    private
+
+    def simulated_successful_billing_response
+      ActiveMerchant::Billing::Response.new(true, "", {}, {})
+    end
+
+    def public_preference_keys
+      super + [:bank_accounts]
+    end
+  end
+end

data/app/overrides/add_bank_details_form_to_order_show.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/orders/show',
+  name: 'add_bank_details_form_to_order_show',
+  insert_bottom: ".payment-info",
+  partial: "spree/orders/bank_transfer_form"
+)

data/app/overrides/add_bank_transfer_instructions_link_to_payment.rb

@@ -0,0 +1,10 @@
+Deface::Override.new(
+  virtual_path: 'spree/checkout/_payment',
+  name: 'add_bank_transfer_instructions_link_to_payment',
+  insert_after: "#payment-method-fields",
+  text: %q{
+    <% if @order.available_payment_methods.any? { |pm| pm.type == 'Spree::PaymentMethod::BankTransfer' } %>
+      <p><%= link_to Spree.t(:how_bank_transfer_works), bank_transfer_instructions_path, id: 'banktransfer_instructions', target: "_blank" %></p>
+    <% end %>
+  }
+)

data/app/overrides/add_payment_reference_details.rb

@@ -0,0 +1,32 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/payments/_list',
+  name: 'add_payment_reference_details',
+  insert_after: "#payments",
+  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 table">
+          <thead>
+            <tr data-hook="payments_header" class="table-active">
+              <th><%= Spree.t(:deposited_on) %></th>
+              <th><%= Spree.t(:bank_name) %></th>
+              <th><%= Spree.t(:receipt) %></th>
+            </tr>
+          </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' width="450px">
+                <% if bank_transfer_payment.receipt.attached? %>
+                  <%= image_tag main_app.url_for(bank_transfer_payment.receipt), class: "w-100" %>
+                <% end %>
+              </td>
+            </tr>
+          </tbody>
+        </table>
+      </fieldset>
+    <% end %>
+  }
+)

data/app/overrides/filter_results_by_transaction_reference_no.rb

@@ -0,0 +1,17 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/orders/index',
+  name: 'filter_results_by_transaction_reference_no',
+  insert_before: ".form-actions",
+  text: %q{
+    <div class="row">
+      <div class="col-md-4">
+        <div class="form-group">
+          <%= 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 form-control'} %>
+        </div>
+      </div>
+    </div>
+  }
+)

data/app/views/spree/admin/banks/_form.html.erb

@@ -0,0 +1,26 @@
+<div data-hook="admin_banks_form_fields">
+  <div class="row">
+    <%= f.field_container :name, class: ['form-group'] do %>
+      <%= f.label :name, Spree.t(:name) %> <span class="required">*</span><br />
+      <%= f.error_message_on :name, class: 'fullwidth title' %>
+      <%= f.text_field :name, class: 'form-control' %>
+    <% end %>
+
+    <%= f.field_container :account_no, class: ['form-group'] do %>
+      <%= f.label :account_no, Spree.t(:account_no) %><span class="required">*</span><br />
+      <%= f.text_field :account_no, class: 'form-control' %>
+    <% end %>
+
+    <%= f.field_container :additional_details, class: ['form-group'] do %>
+      <%= f.label :additional_details, Spree.t(:additional_details) %><br />
+      <%= f.text_area :additional_details, rows: 10, class: 'form-control' %>
+    <% end %>
+
+    <%= f.field_container :active, class: ['checkbox'] do %>
+      <%= f.label :active do %>
+        <%= f.check_box :active %>
+        <%= Spree.t(:active) %>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/spree/admin/banks/edit.html.erb

@@ -0,0 +1,14 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:editing_resource, resource: Spree::Bank.model_name.human) %> / <%= @bank.name %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @bank } %>
+
+<%= form_for @bank, url: admin_bank_path(@bank) do |f| %>
+  <fieldset>
+    <%= render partial: 'form', locals: { f: f } %>
+    <div data-hook="buttons" class="actions">
+      <%= button Spree.t('actions.update'), 'save' %>
+    </div>
+  </fieldset>
+<% end %>

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

@@ -0,0 +1,48 @@
+
+<% content_for :page_title do %>
+  <%= plural_resource_name(Spree::Bank) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:new_bank), new_object_url, class: "btn-success", icon: 'add', id: 'admin_new_bank_link' %>
+<% end %>
+
+<% if @banks.present? %>
+
+  <table class="table" id='listing_banks'>
+    <thead>
+      <tr data-hook="admin_banks_index_headers">
+        <th><%= Spree.t(:bank_name) %></th>
+        <th><%= Spree.t(:account_no) %></th>
+        <th><%= Spree.t(:additional_details) %></th>
+        <th><%= Spree.t(:status) %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @banks.each do |bank|%>
+        <tr id="<%= spree_dom_id bank %>" data-hook="admin_banks_index_rows">
+          <td><%= bank.name %></td>
+          <td><%= bank.account_no %></td>
+          <td><%= bank.additional_details %></td>
+          <td id='active-status-<%= bank.id %>'><%= bank_status(bank) %></td>
+          <td data-hook="admin_banks_index_row_status" id='toggle-status-<%= bank.id %>' class="actions actions-2 text-right">
+            <% action_class = bank.active ? "btn-danger" : "btn-success" %>
+            <% btn_class = 'btn ' + action_class + ' btn-sm' %>
+            <% status = bank.active ? "active" : "inactive" %>
+            <% bank_id = 'bank-' + bank[:id].to_s %>
+            <%= link_to_with_icon(action_text_to_toggle_bank_status(bank), action_to_toggle_bank_status(bank), toggle_activation_admin_bank_path(bank), {class: btn_class, id: bank_id, rel: status, remote: true, method: :put}) %>
+          </td>
+          <td data-hook="admin_banks_index_row_actions" class="actions actions-2 text-right">
+            <%= (link_to_edit bank) if can? :edit, bank %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+<% else %>
+  <div class="alert alert-info no-objects-found">
+    <%= Spree.t(:no_resource_found, resource: plural_resource_name(Spree::Bank)) %>,
+    <%= link_to(Spree.t(:add_one), new_object_url) if can? :create, Spree::Bank %>!
+  </div>
+<% end %>

data/app/views/spree/admin/banks/new.html.erb

@@ -0,0 +1,17 @@
+
+<% content_for :page_title do %>
+  <%= Spree.t(:new_bank) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= link_to_with_icon 'arrow-left', Spree.t(:back_to_banks_list), admin_banks_path, class: 'btn btn-primary' %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @bank } %>
+
+<%= form_for [:admin, @bank] do |f| %>
+  <fieldset>
+    <%= render partial: 'form', locals: { f: f } %>
+    <%= render partial: 'spree/admin/shared/new_resource_links' %>
+  </fieldset>
+<% end %>