spree_bank_transfer_payment 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ffc24fd7ef86c955818874c4f67749867b46de8fa7681ec8eb705bdab512252
+  data.tar.gz: 45a64b39fd76f4e19a5deff89c3bbecbf2ae69e49a66a4c1938888701efd6bc7
+SHA512:
+  metadata.gz: 5f1b9caddf429021d8f4bb1d85f6dcab4aab9614040b821f2bd722e62479beb3327b757182cfaa13675af87f5b6e11ddfff5a10f2e73368feac87ba02fd8e8f1
+  data.tar.gz: 56406587023a79394f97c5d4665629f625d97f7381944392018305476ea552bbf0a0ef6784032752afcac3505f9d249ca75d45b3244ff7f95db395d6784198af

data/LICENSE.md

@@ -0,0 +1,8 @@
+# MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# SpreeBankTransferPayment
+
+This is a Bank Transfer Payment extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails. Adds Bank Transfer payment method to Spree stores.
+
+[![Gem Version](https://badge.fury.io/rb/spree_bank_transfer_payment.svg)](https://badge.fury.io/rb/spree_cod_payment)
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_bank_transfer_payment
+    ```
+
+2. Install the migrations:
+
+    ```sh
+    bundle exec rake railties:install:migrations FROM=spree_bank_transfer_payment
+    ```
+
+3. Run the migrations:
+
+    ```sh
+    bundle exec rails db:migrate
+    ```
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Developing
+
+1. Create a dummy app
+
+    ```bash
+    bundle update
+    bundle exec rake test_app
+    ```
+
+2. Add your new code
+3. Run tests
+
+    ```bash
+    bundle exec rspec
+    ```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_bank_transfer_payment/factories'
+```
+
+## Releasing a new version
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release README](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.
+
+Copyright (c) 2025 OlympusOne, released under the MIT

data/Rakefile

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

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

@@ -0,0 +1,55 @@
+module Spree
+  class PaymentMethod::BankTransfer < Spree::PaymentMethod
+    def method_type
+      type.demodulize.underscore
+    end
+
+    def default_name
+      Spree.t(:bank_transfer_method)
+    end
+
+    def custom_form_fields_partial_name
+      :bank_transfer_instructions
+    end
+
+    def source_required?
+      false
+    end
+
+    def auto_capture?
+      false
+    end
+
+    def actions
+      %w[capture void]
+    end
+
+    # Indicates whether its possible to capture the payment
+    def can_capture?(payment)
+      payment.pending?
+    end
+
+    # Indicates whether its possible to void the payment.
+    def can_void?(payment)
+      !payment.void?
+    end
+
+    def capture(*)
+      simulated_successful_billing_response
+    end
+
+    def cancel(*)
+      simulated_successful_billing_response
+    end
+
+    def credit(*)
+      simulated_successful_billing_response
+    end
+
+    private
+
+    def simulated_successful_billing_response
+      ActiveMerchant::Billing::Response.new(true, '', {}, {})
+    end
+  end
+end

data/app/views/spree/admin/payment_methods/custom_form_fields/_bank_transfer_instructions.html.erb

@@ -0,0 +1,3 @@
+<div class="trix-container">
+    <%= f.rich_text_area :instructions, class: 'overflow-auto', style: 'height: 300px' %>
+</div>

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

@@ -0,0 +1,3 @@
+<% if payment_method.instructions.present? %>
+    <%= payment_method.instructions.html_safe %>
+<% end %>

data/config/locales/el.yml

@@ -0,0 +1,9 @@
+---
+el:
+  activerecord:
+    attributes:
+      spree/payment_method:
+        instructions: Οδηγίες
+  spree:
+    bank_transfer: Τραπεζική Κατάθεση
+    bank_transfer_method: Τραπεζική Κατάθεση

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+---
+en:
+  activerecord:
+    attributes:
+      spree/payment_method:
+        instructions: Instructions
+  spree:
+    bank_transfer: Bank Transfer
+    bank_transfer_method: Bank Transfer

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.add_routes do
+  # Add your extension routes here
+end

data/db/migrate/20250601215018_add_instructions_to_payment_methods.rb

@@ -0,0 +1,5 @@
+class AddInstructionsToPaymentMethods < ActiveRecord::Migration[8.0]
+  def change
+    add_column :spree_payment_methods, :instructions, :text
+  end
+end

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

@@ -0,0 +1,20 @@
+module SpreeBankTransferPayment
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_bank_transfer_payment'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_bank_transfer_payment/engine.rb

@@ -0,0 +1,26 @@
+module SpreeBankTransferPayment
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_bank_transfer_payment'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.after_initialize do |app|
+      app.config.spree.payment_methods << Spree::PaymentMethod::BankTransfer
+
+      Spree::PermittedAttributes.payment_method_attributes << :instructions
+    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
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_bank_transfer_payment/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_bank_transfer_payment/factories'
+end

data/lib/spree_bank_transfer_payment/version.rb

@@ -0,0 +1,7 @@
+module SpreeBankTransferPayment
+  VERSION = '2.0.0'.freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end

data/lib/spree_bank_transfer_payment.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_bank_transfer_payment/engine'
+require 'spree_bank_transfer_payment/version'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: spree_bank_transfer_payment
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- OlympusOne
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+- !ruby/object:Gem::Dependency
+  name: spree_storefront
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+- !ruby/object:Gem::Dependency
+  name: spree_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+- !ruby/object:Gem::Dependency
+  name: spree_extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds Bank Transfer payment method to Spree stores.
+email: info@olympusone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/models/spree/payment_method/bank_transfer.rb
+- app/views/spree/admin/payment_methods/_bank_transfer.html.erb
+- app/views/spree/admin/payment_methods/custom_form_fields/_bank_transfer_instructions.html.erb
+- app/views/spree/admin/payment_methods/descriptions/_bank_transfer.html.erb
+- app/views/spree/admin/payments/source_views/_bank_transfer.html.erb
+- app/views/spree/admin/spree/checkout/payment/_bank_transfer.html.erb
+- app/views/spree/checkout/payment/_bank_transfer.html.erb
+- config/locales/el.yml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20250601215018_add_instructions_to_payment_methods.rb
+- lib/generators/spree_bank_transfer_payment/install/install_generator.rb
+- lib/spree_bank_transfer_payment.rb
+- lib/spree_bank_transfer_payment/engine.rb
+- lib/spree_bank_transfer_payment/factories.rb
+- lib/spree_bank_transfer_payment/version.rb
+homepage: https://github.com/olympusone/spree_bank_transfer_payment
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/olympusone/spree_bank_transfer_payment/issues
+  changelog_uri: https://github.com/olympusone/spree_bank_transfer_payment/releases/tag/v2.0.0
+  documentation_uri: https://github.com/olympusone/spree_bank_transfer_payment
+  homepage_uri: https://github.com/olympusone/spree_bank_transfer_payment
+  source_code_uri: https://github.com/olympusone/spree_bank_transfer_payment/tree/v2.0.0
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Spree Commerce Bank Transfer Payment Extension
+test_files: []