ba_spree_bank_transfer 1.0.0

data/app/views/spree/admin/banks/toggle_activation.js.erb

@@ -0,0 +1,10 @@
+<% if @success %>
+  $('#active-status-<%= @bank.id %>').text('<%= bank_status(@bank) %>')
+  <% 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 %>
+  $('#toggle-status-<%= @bank.id %>').html('<%= 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}) %>')
+<% else %>
+  alert('<%= @bank.errors.full_messages.to_sentence %>')
+<% end %>

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

@@ -0,0 +1,16 @@
+<% if (banks = Spree::Bank.active).present? %>
+  <table class="table index">
+    <tr>
+      <th><%= Spree.t(:bank_name) %></th>
+      <th><%= Spree.t(:account_no) %></th>
+      <th><%= Spree.t(:additional_details) %></th>
+    </tr>
+    <% banks.each do |bank| %>
+      <tr>
+        <td><%= bank.name %></td>
+        <td><%= bank.account_no %></td>
+        <td><%= bank.additional_details %></td>
+      </tr>
+    <% end %>
+  </table>
+<% end %>

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

@@ -0,0 +1,38 @@
+<div class="container mt-4 pb-3">
+  <h1 class="text-center h2">วิธีการชำระเงินโดยวิธี "โอนเงินผ่านธนาคาร"</h3>
+  <h4><strong>ขั้นตอนการแจ้งชำระเงิน:</strong></h4>
+  <ol>
+    <li>ชำระเงินเต็มจำนวนตามคำสั่งซื้อ ตามบัญชีธนาคารข้างล่าง
+      <% if (banks = Spree::Bank.active).any? %>
+        <div class="w-75">
+          <table class="table table-bordered">
+            <tr class="table-active">
+              <th><%= Spree.t(:bank_name) %></th>
+              <th><%= Spree.t(:account_no) %></th>
+              <th><%= Spree.t(:additional_details) %></th>
+            </tr>
+            <% banks.each do |bank| %>
+              <tr>
+                <td><%= bank.name %></td>
+                <td><%= bank.account_no %></td>
+                <td><%= bank.additional_details %></td>
+              </tr>
+            <% end %>
+          </table>
+        </div>
+      <% end %>
+    </li>
+    <li>แนบหลักฐานการโอนเงินผ่านระบบ
+      <ol>
+        <li>ไปยัง "บัญชีของฉัน" page.</li>
+        <li>เลือก คำสั่งซื้อ</li>
+        <li>คลิก "แนบหลักฐานการชำระเงิน"</li>
+        <li>กรอกข้อมูล และกด ยืนยัน</li>
+      </ol>
+    </li>
+  </ol>
+
+  <div class="w-100">
+    <%= image_tag 'payment_details.png', class: "w-75 img-thumbnail" %>
+  </div>
+</div>

data/app/views/spree/orders/_bank_transfer_form.html.erb

@@ -0,0 +1,40 @@
+<% bank_transfer_payment = @order.payments.from_bank_transfer.first %>
+<% if bank_transfer_payment.present? %>
+  <% unless bank_transfer_payment.details_submitted? %>
+    <br>
+    <%= link_to Spree.t(:add_details), "javascript:void(0);", class: 'button add_bt_details' %>
+    <%= form_for bank_transfer_payment, html: { class: "bt_payment_form", style: "#{bank_transfer_payment.details_submitted? ? '' : 'display:none;'}" } do |f| %>
+      <div class="row mx-0 my-3">
+        <div class="form-group col-12 px-0">
+          <%= f.label Spree.t(:deposited_on), class: 'mb-0' %>
+          <%= f.text_field :deposited_on, disabled: bank_transfer_payment.details_submitted?, class: 'required_field form-control form-control-sm' %>
+        </div>
+        <br>
+        <div class="form-group col-12 px-0">
+          <%= f.label Spree.t(:bank_name), class: 'mb-0' %>
+          <%= f.select :bank_name, options_for_select(Spree::Bank.pluck(:name)), {}, {disabled: bank_transfer_payment.details_submitted?, class: 'required_field form-control form-control-sm'} %>
+        </div>
+        <br>
+        <div class="form-group col-12 px-0">
+          <%= f.label Spree.t(:receipt), class: 'mb-0' %>
+          <%= f.file_field :receipt, disabled: bank_transfer_payment.details_submitted?, class: 'required_field form-control-file' %>
+        </div>
+        <br>
+        <div class="col-12 px-0">
+          <% unless bank_transfer_payment.details_submitted? %>
+            <%= f.submit "Submit", confirm: Spree.t(:confirm_details_submit), class: "btn btn-success btn-block btn-sm" %>
+          <% end %>
+        </div>
+      </div>
+    <% end %>
+  <% else %>
+    <div class="my-3">
+      <p class="text-success font-weight-bold mb-0">
+        <i class="fas fa-check-circle"></i> <%= Spree.t(:bank_transfer_completed) %>
+      </p>
+      <p class="mb-0"><%= Spree.t(:deposited_on) %>: <%= bank_transfer_payment.deposited_on.strftime("%d/%m/%Y") %></p>
+      <p class="mb-0"><%= Spree.t(:bank_name) %>: <%= bank_transfer_payment.bank_name %></p>
+      <a href="<%= main_app.url_for(bank_transfer_payment.receipt) %>" target="_blank"><%= Spree.t(:view_receipt) %></a>
+    </div>
+  <% end %>
+<% end %>

data/ba_spree_bank_transfer.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spree_bank_transfer/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'ba_spree_bank_transfer'
+  s.version     = SpreeBankTransfer::VERSION
+  s.summary     = 'Spree extension to create bank transfer payment method. (be agile fork)'
+  s.description = 'This Spree extension provides bank transfer payment method functionality. Compatible with Ruby 3.1, Rails 7.1 and Spree 4.10.'
+  s.required_ruby_version = '>= 3.1.4'
+
+  s.author      = 'be agile Co., Ltd.'
+  s.email       = 'develop@be-agile.jp'
+  s.homepage    = 'https://github.com/be-agile/ba_spree_bank_transfer'
+  s.licenses    = ['AGPL-3.0-or-later', 'BSD-3-Clause']
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core', '>= 4.10.0'
+  s.add_dependency 'spree_backend', '>= 4.8.0'
+  s.add_dependency 'spree_frontend', '>= 4.8.0'
+  s.add_dependency 'spree_extension', '>= 0.1.0'
+  s.add_dependency 'deface', '~> 1.0'
+  s.add_dependency 'jquery-rails', ' ~> 4.6.0'
+  s.add_dependency 'jquery-ui-rails', ' ~> 6.0.1'
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pg'
+end

data/bin/rails

@@ -0,0 +1,6 @@
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_bank_transfer/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,25 @@
+en:
+  spree:
+    account_no: Account No
+    add_details: Add details
+    additional_details: Additional Details
+    back_to_banks_list: Back to Banks list
+    banks: Banks
+    bank_name: Bank Name
+    confirm_details_submit: Are you sure you want to Submit these details? You will not be able to Edit these details once Submitted. Press 'OK' to confirm.
+    deactivate: Deactivate
+    deposited_on: Deposited on
+    how_bank_transfer_works: How Bank Transfer works?
+    listing_banks: Listing Banks
+    new_bank: New Bank
+    only_show_orders_with_bank_transfer_payment_reference_number: Only show orders with bank transfer payment reference number
+    payment_not_found: Payment not found
+    payment_successfully_updated: Payment successfully updated
+    payment_reference_details: Bank Transfer Payment Reference Details
+    transaction_reference_no: Transaction Reference No
+    receipt: "Receipt"
+  activerecord:
+    models:
+      spree/bank:
+        one: Bank
+        other: Banks

data/config/locales/it.yml

@@ -0,0 +1,24 @@
+it:
+  spree:
+    account_no: Numero Conto
+    add_details: Aggiungi dettagli
+    additional_details: Dettagli aggiuntivi
+    back_to_banks_list: Torna alla lista Banche
+    banks: Banche
+    bank_name: Nome Banca
+    confirm_details_submit: Sei sicuro di voler inserire i dettagli? Non sarà possibile modificarli successivamente. Premi 'OK' per confermare.
+    deactivate: Disattiva
+    deposited_on: Vresato il
+    how_bank_transfer_works: Come funziona il Bonifico Bancario?
+    listing_banks: Lista Banche
+    new_bank: Nuova Banca
+    only_show_orders_with_bank_transfer_payment_reference_number: Visualiza solo ordini con numero transazione bonifico
+    payment_not_found: Pagamento non trovato
+    payment_successfully_updated: Pagamento aggiornato con successo
+    payment_reference_details: Dettagli pagamento
+    transaction_reference_no: Numero transazione
+  activerecord:
+    models:
+      spree/bank:
+        one: Banca
+        other: Banche

data/config/locales/ja.yml

@@ -0,0 +1,25 @@
+ja:
+  spree:
+    account_no: 口座番号
+    add_details: 詳細を追加
+    additional_details: 追加詳細
+    back_to_banks_list: 銀行一覧に戻る
+    banks: 銀行
+    bank_name: 銀行名
+    confirm_details_submit: これらの詳細を送信してもよろしいですか？送信後は編集できなくなります。「OK」を押して確認してください。
+    deactivate: 無効化
+    deposited_on: 入金日
+    how_bank_transfer_works: 銀行振込について
+    listing_banks: 銀行一覧
+    new_bank: 新規銀行
+    only_show_orders_with_bank_transfer_payment_reference_number: 銀行振込の支払い参照番号がある注文のみ表示
+    payment_not_found: 支払いが見つかりません
+    payment_successfully_updated: 支払いが正常に更新されました
+    payment_reference_details: 銀行振込支払い参照詳細
+    transaction_reference_no: 取引参照番号
+    receipt: "領収書"
+  activerecord:
+    models:
+      spree/bank:
+        one: 銀行
+        other: 銀行

data/config/locales/pl.yml

@@ -0,0 +1,24 @@
+pl:
+  spree:
+    account_no: Numer konta
+    add_details: Szczegóły
+    additional_details: Dodatkowe informacje
+    back_to_banks_list: Wróć do listy banków
+    banks: Banki
+    bank_name: Nazwa banku
+    confirm_details_submit: Czy jestes pewien że chcesz dodać te informacje ? Jeśli potwierdzisz te informacje, nie będziesz upoważniony by je zmienić w czasie późniejszym. Raz dodane nie będą mogły być zmienione. Wciśnij "OK" aby potwierdzić.
+    deactivate: Deaktywacja
+    deposited_on: Depozyt
+    how_bank_transfer_works: Jak działa przelew bankowy ?
+    listing_banks: Lista banków
+    new_bank: Nowy bank
+    only_show_orders_with_bank_transfer_payment_reference_number: Pokaż tylko zlecenia z numerem referencyjnym przelewu
+    payment_not_found: Płatnośc nie została odnotowana
+    payment_successfully_updated: Płatność potwierdzona
+    payment_reference_details: Szczegoły przelewu bankowego
+    transaction_reference_no: Numer referencyjny transakcji
+  activerecord:
+    models:
+      spree/bank:
+        one: Bank
+        other: Banki

data/config/locales/pt.yml

@@ -0,0 +1,24 @@
+pt:
+  spree:
+    account_no: N.º Conta
+    add_details: Adicionar detalhes
+    additional_details: Detalhes Adicionais
+    back_to_banks_list: Voltar à lista de Bancos
+    banks: Bancos
+    bank_name: Nome do Banco
+    confirm_details_submit: Tem a certeza que pretende submeter estes detalhes? Não será possível editar estes detalhes após envio. Confirme escolhendo "OK".
+    deactivate: Desactivar
+    deposited_on: Depositado em
+    how_bank_transfer_works: Como funciona a Transferência Bancária?
+    listing_banks: A listar Bancos
+    new_bank: Novo Banco
+    only_show_orders_with_bank_transfer_payment_reference_number: Mostrar apenas encomendas pagas por Transferência Bancária
+    payment_not_found: Pagamento não encontrado
+    payment_successfully_updated: Pagamento actualizado com sucesso
+    payment_reference_details: Detalhes de Pagamento por Transferência Bancária
+    transaction_reference_no: N.º da Transacção Bancária
+  activerecord:
+    models:
+      spree/bank:
+        one: Banco
+        other: Bancos

data/config/locales/th.yml

@@ -0,0 +1,27 @@
+en:
+  spree:
+    account_no: เลขบัญชี
+    add_details: แนบสลิป
+    additional_details: รายละเอียดเพิ่มเติม
+    back_to_banks_list: กลับไปยังรายการธนาคาร
+    banks: กลับไปยังรายการธนาคาร
+    bank_name: ชื่อธนาคาร
+    confirm_details_submit: Are you sure you want to Submit these details? You will not be able to Edit these details once Submitted. Press 'OK' to confirm.
+    deactivate: ปิดการใช้งาน
+    deposited_on: วันที่โอนเงิน
+    how_bank_transfer_works: วิธีการชำระเงินโดยวิธี "โอนเงินผ่านธนาคาร"
+    listing_banks: รายการธนาคาร
+    new_bank: เพิ่มธนาคาร
+    only_show_orders_with_bank_transfer_payment_reference_number: Only show orders with bank transfer payment reference number
+    payment_not_found: ไม่พบการชำระเงิน
+    payment_successfully_updated: แนบหลักฐานการชำระเงินสำเร็จ
+    payment_reference_details: Bank Transfer Payment Reference Details
+    transaction_reference_no: Transaction Reference No
+    receipt: "ใบเสร็จ"
+    view_receipt: "ดูใบเสร็จ"
+    bank_transfer_completed: แจ้งชำระเงินเรียบร้อยแล้ว
+  activerecord:
+    models:
+      spree/bank:
+        one: ธนาคาร
+        other: ธนาคาร

data/config/routes.rb

@@ -0,0 +1,10 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+  namespace :admin do
+    resources :banks, except: [:show, :destroy] 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/20130717071443_create_table_bank.rb

@@ -0,0 +1,11 @@
+class CreateTableBank < SpreeExtension::Migration[4.2]
+  def change
+    create_table :spree_banks do |t|
+      t.string :name
+      t.string :account_no
+      t.boolean :active, default: true
+      t.timestamps
+    end
+    add_index :spree_banks, [:name, :account_no], unique: true
+  end
+end

data/db/migrate/20130717125312_add_index_on_active_on_spree_bank.rb

@@ -0,0 +1,5 @@
+class AddIndexOnActiveOnSpreeBank < SpreeExtension::Migration[4.2]
+  def change
+    add_index :spree_banks, :active
+  end
+end

data/db/migrate/20140519125402_add_bank_name_account_number_and_transaction_reference_number_to_payments.rb

@@ -0,0 +1,7 @@
+class AddBankNameAccountNumberAndTransactionReferenceNumberToPayments < SpreeExtension::Migration[4.2]
+  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/db/migrate/20140530055151_add_column_deposited_on_to_spree_payments.rb

@@ -0,0 +1,5 @@
+class AddColumnDepositedOnToSpreePayments < SpreeExtension::Migration[4.2]
+  def change
+    add_column :spree_payments, :deposited_on, :date
+  end
+end

data/db/migrate/20140612131656_add_col_additional_details_to_banks.rb

@@ -0,0 +1,5 @@
+class AddColAdditionalDetailsToBanks < SpreeExtension::Migration[4.2]
+  def change
+    add_column :spree_banks, :additional_details, :text
+  end
+end

data/lib/ba_spree_bank_transfer.rb

@@ -0,0 +1,6 @@
+require 'spree_core'
+require 'rails/generators'
+require 'spree_bank_transfer/engine'
+require 'spree_bank_transfer/version'
+require 'spree_extension'
+require 'deface'

data/lib/generators/spree_bank_transfer/install/install_generator.rb

@@ -0,0 +1,30 @@
+module SpreeBankTransfer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, type: :boolean, default: true
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "\n//= require spree/frontend/spree_bank_transfer\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "\n//= require spree/backend/spree_bank_transfer\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_bank_transfer\n", before: /\*\//, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_bank_transfer\n", before: /\*\//, verbose: true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_bank_transfer'
+      end
+
+      def run_migrations
+        if options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+          run 'bundle exec rake db:migrate'
+        else
+          puts "Skiping rake db:migrate, don't forget to run it!"
+        end
+      end
+    end
+  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/lib/spree_bank_transfer/engine.rb

@@ -0,0 +1,40 @@
+module SpreeBankTransfer
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace SpreeBankTransfer
+    engine_name 'spree_bank_transfer'
+
+    config.autoload_paths += %W[#{config.root}/lib]
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+      Spree.user_class.class_eval do
+        has_many :payments, through: :orders
+      end
+    end
+
+    initializer 'spree_bank_transfer.autoloader' do |app|
+      if Rails.autoloaders.zeitwerk_enabled?
+        Rails.autoloaders.main.ignore("#{root}/app/overrides")
+      end
+    end
+
+    config.after_initialize do
+      Rails.application.config.spree.payment_methods << Spree::PaymentMethod::BankTransfer
+      settings = Rails.application.config.spree_backend.main_menu.items.find { |item| item.key == "settings" }
+      settings.items << Spree::Admin::MainMenu::ItemBuilder.new('banks', Spree::Core::Engine.routes.url_helpers.admin_banks_path).
+        with_match_path('/banks').
+        with_manage_ability_check(Spree::Bank).
+        build
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_bank_transfer/version.rb

@@ -0,0 +1,3 @@
+module SpreeBankTransfer
+  VERSION = "1.0.0"
+end

data/spec/controllers/spree/admin/banks_controller_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Spree::Admin::BanksController, type: :controller do
+
+  let(:role) { Spree::Role.create!(name: 'user') }
+  let(:roles) { [role] }
+
+  before(:each) do
+    @user = mock_model(Spree::User, :generate_spree_api_key! => false)
+    allow(@user).to receive_message_chain(:roles, :includes).and_return([])
+    allow(@user).to receive(:has_spree_role?).with('admin').and_return(true)
+    allow(controller).to receive(:spree_user_signed_in?).and_return(true)
+    allow(controller).to receive(:spree_current_user).and_return(@user)
+    allow(@user).to receive(:roles).and_return(roles)
+    allow(roles).to receive(:includes).with(:permissions).and_return(roles)
+    allow(controller).to receive(:authorize_admin).and_return(true)
+    allow(controller).to receive(:authorize!).and_return(true)
+  end
+
+  describe "GET index" do
+    before(:each) do
+      @bank1 = mock_model(Spree::Bank)
+      allow(Spree::Bank).to receive(:page).and_return([@bank1])
+    end
+
+    def send_request
+      get :index
+
+
+
+    end
+
+    it "assigns @banks" do
+      send_request
+      expect(assigns(:banks)).to eq([@bank1])
+    end
+
+    it "paginates banks" do
+      expect(Spree::Bank).to receive(:page)
+      send_request
+    end
+
+    it "renders index template" do
+      send_request
+      expect(response).to render_template(:index)
+    end
+  end
+
+  describe "PUT toggle_activation" do
+    before(:each) do
+      @bank = mock_model(Spree::Bank, :toggle! => true)
+      allow(Spree::Bank).to receive(:find).with("1").and_return(@bank)
+    end
+
+    def send_request
+      put :toggle_activation, id: "1", format: :js
+    end
+
+    it "toggles activation status of bank" do
+      expect(@bank).to receive(:toggle!).with(:active)
+      send_request
+    end
+
+    context "when activation status toggled successfully" do
+      it "sets @success to true" do
+        send_request
+        expect(assigns(:success)).to be true
+      end
+    end
+
+    context "when activation status not toggled successfully" do
+      before(:each) do
+        allow(@bank).to receive(:toggle!).and_return(false)
+      end
+
+      it "sets @success to false" do
+        send_request
+        expect(assigns(:success)).to be false
+      end
+    end
+  end
+end

data/spec/controllers/spree/content_controller_spec.rb

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