solidus_bank_transfer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98a3409b6d8f9946b8f0846beca795983c1a17e53f784ba19cd9633addae14cd
+  data.tar.gz: 604674a6e8d0ae2c34d1685d3cb3c36376047d64ee23c226453f90b474305ec6
+SHA512:
+  metadata.gz: b60e11fc406c7facf683e4a59d50094069a5964afd7000782fa02217965996a2f136507778b3b3a795f742f73e044096b90e80998316fd8dc223dd29c691a540
+  data.tar.gz: 60e9559962b678c95004f4fa60659f61cdf5b432ac1baf6a8e019cc86d1a4d14b937cb1e27c2a3649b5bb38db1d8f616d17ce880f5c209ebfc9427d17945c905

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2019 weLaika
+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,63 @@
+SolidusBankTransfer
+===================
+
+[![Build Status](https://travis-ci.org/welaika/solidus_bank_transfer.svg?branch=master)](https://travis-ci.org/welaika/solidus_bank_transfer)
+
+This extensions add a Bank Transfer payment method.
+
+You can define bank name, IBAN number and holder name in the backend. This data will be shown to the user in the checkout process.
+
+Installation
+------------
+
+Add solidus_bank_transfer to your Gemfile:
+
+```ruby
+gem 'solidus_bank_transfer'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_bank_transfer:install
+```
+
+Testing
+-------
+
+I usually test with PostgreSQL locally. For this to work, you need a role named `postgres`. If you don't have it, you can create a superuser role with
+
+```shell
+createuser -s postgres
+```
+
+Bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+DB=postgres bundle exec rake
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_bank_transfer/factories'
+```
+
+Releasing
+---------
+
+Your new extension version can be released using `gem-release` like this:
+
+```shell
+bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+```
+
+Author
+------
+
+made with ❤️and ☕️by weLaika
+
+Copyright (c) 2019 weLaika, released under the New BSD License

data/Rakefile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'spree/testing_support/extension_rake'
+  require 'rubocop/rake_task'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  RuboCop::RakeTask.new
+
+  task default: %i[first_run rubocop spec]
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_bank_transfer'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/solidus_bank_transfer.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/solidus_bank_transfer.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/solidus_bank_transfer.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/solidus_bank_transfer.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Spree
+  class PaymentMethod::BankTransfer < PaymentMethod
+    preference :iban, :string
+    preference :bank_name, :string
+    preference :holder, :string
+
+    def actions
+      %w[capture void credit]
+    end
+
+    # Indicates whether its possible to capture the payment
+    def can_capture?(payment)
+      %w[checkout pending].include?(payment.state)
+    end
+
+    # Indicates whether its possible to void the payment.
+    def can_void?(payment)
+      payment.state != 'void'
+    end
+
+    def capture(*)
+      simulated_successful_billing_response
+    end
+
+    def void(*)
+      simulated_successful_billing_response
+    end
+    alias try_void void
+
+    def credit(*)
+      simulated_successful_billing_response
+    end
+
+    def source_required?
+      false
+    end
+
+    private
+
+    def simulated_successful_billing_response
+      ActiveMerchant::Billing::Response.new(true, '', {}, {})
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+<div>
+  <h4><%= t('spree.bank_transfer.pay_with_this_method') %></h4>
+  <p>
+    <strong><%= t('spree.bank_transfer.reason_for_payment') %>: </strong>
+    <span><%= t('spree.bank_transfer.reason_for_payment_instructions') %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.holder') %>: </strong>
+    <span><%= payment_method.preferred_holder %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.iban') %>: </strong>
+    <span><%= payment_method.preferred_iban %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.bank_name') %>: </strong>
+    <span><%= payment_method.preferred_bank_name %></span>
+  </p>
+</div>

data/app/views/spree/order_mailer/_bank_transfer_details.html.erb

@@ -0,0 +1,23 @@
+<%
+  payment_method =
+    @order.payments.map(&:payment_method).select do |pm|
+      pm.is_a?(Spree::PaymentMethod::BankTransfer)
+    end.first
+%>
+
+<% if payment_method.present? %>
+  <h4><%= t('spree.bank_transfer.pay_with_this_method') %></h4>
+  <p>
+    <strong><%= t('spree.bank_transfer.reason_for_payment') %>: </strong>
+    <span><%= t('spree.bank_transfer.reason_for_payment_value', order_number: @order.number) %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.holder') %>: </strong>
+    <span><%= payment_method.preferred_holder %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.iban') %>: </strong>
+    <span><%= payment_method.preferred_iban %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.bank_name') %>: </strong>
+    <span><%= payment_method.preferred_bank_name %></span>
+  </p>
+<% end %>

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

@@ -0,0 +1,22 @@
+<%
+  payment_method =
+    @order.payments.map(&:payment_method).select do |pm|
+      pm.is_a?(Spree::PaymentMethod::BankTransfer)
+    end.first
+%>
+
+<% if payment_method.present? %>
+  <p>
+    <strong><%= t('spree.bank_transfer.reason_for_payment') %>: </strong>
+    <span><%= t('spree.bank_transfer.reason_for_payment_value', order_number: @order.number) %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.holder') %>: </strong>
+    <span><%= payment_method.preferred_holder %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.iban') %>: </strong>
+    <span><%= payment_method.preferred_iban %></span>
+    <br>
+    <strong><%= t('spree.bank_transfer.bank_name') %>: </strong>
+    <span><%= payment_method.preferred_bank_name %></span>
+  </p>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,14 @@
+en:
+  spree:
+    holder: Holder
+    iban: IBAN
+    bank_name: Bank name
+
+    bank_transfer:
+      pay_with_this_method: Pay with bank transfer
+      holder: Holder
+      iban: IBAN
+      bank_name: Bank name
+      reason_for_payment: Reason for payment
+      reason_for_payment_instructions: enter the order number (it will be sent by email after completing the order).
+      reason_for_payment_value: "Order %{order_number}"

data/config/locales/it.yml

@@ -0,0 +1,14 @@
+it:
+  spree:
+    holder: Intestatario
+    iban: IBAN
+    bank_name: Nome banca
+
+    bank_transfer:
+      pay_with_this_method: Paga con bonifico bancario
+      holder: Intestatario
+      iban: IBAN
+      bank_name: Nome banca
+      reason_for_payment: Causale
+      reason_for_payment_instructions: inserisci il numero d'ordine (verrà spedito via email una volta completato l'ordine).
+      reason_for_payment_value: "Ordine %{order_number}"

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusBankTransfer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_bank_transfer\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_bank_transfer\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_bank_transfer\n", before: %r{\*/}, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_bank_transfer\n", before: %r{\*/}, verbose: true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_bank_transfer'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/solidus_bank_transfer.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_bank_transfer/engine'

data/lib/solidus_bank_transfer/engine.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SolidusBankTransfer
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_bank_transfer'
+
+    # 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
+    end
+
+    initializer 'spree.register.payment_methods' do |app|
+      app.config.spree.payment_methods << Spree::PaymentMethod::BankTransfer
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_bank_transfer/factories.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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 'solidus_bank_transfer/factories'
+
+  factory :bank_transfer_payment_method, class: Spree::PaymentMethod::BankTransfer do
+    name { 'Bank Transfer' }
+    preferred_bank_name { 'Uncle Scrooge Bank & Partners' }
+    preferred_iban { 'IT00 S000 0000 0000 0000 0123 456' }
+    preferred_holder { 'Donald Duck' }
+    description { 'Bank transfer' }
+    active { true }
+  end
+end

data/lib/solidus_bank_transfer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusBankTransfer
+  VERSION = '0.0.1'
+end

data/spec/dummy/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);