spree_cod_payment 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e108c2072c150d4010dae6a8ec22b019b298b35c3257d27220c580e653b91e7
+  data.tar.gz: ab31c2451b46759b045e70e706faf7771037958be6229bc6ed9d7fb43bc9a256
+SHA512:
+  metadata.gz: 74ea27e29d5686ee85cdfd7346322d7895a9c09bc374517a319e20f3ad18c228fc531f58205fc288db47214dbd6fc03cb8e46a420e8703d56ef5e268d05de901
+  data.tar.gz: 59f1cfa09909a6e9bf12e6d4446872987d773c8db7b1561e2c9a1d4b9b0975712d9b0f958875553715f80c6266472bcaf7477bbbbac792d438f8762d42e39883

data/.gitignore

@@ -0,0 +1,23 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+.vscode
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+*.gem
+*/*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Appraisals'
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'lib/generators/**/*'
+
+Rails:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 150
+
+# DISABLED
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,37 @@
+os: linux
+dist: bionic
+
+addons:
+  apt:
+    sources:
+      - google-chrome
+    packages:
+      - google-chrome-stable
+
+services:
+  - mysql
+  - postgresql
+
+language: ruby
+
+rvm:
+  - 2.7
+  - 3.0
+
+env:
+  - DB=mysql
+  - DB=postgres
+
+before_install:
+  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
+
+before_script:
+  - CHROME_MAIN_VERSION=`google-chrome-stable --version | sed -E 's/(^Google Chrome |\.[0-9]+ )//g'`
+  - CHROMEDRIVER_VERSION=`curl -s "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_$CHROME_MAIN_VERSION"`
+  - curl "https://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip" -O
+  - unzip chromedriver_linux64.zip -d ~/bin
+  - nvm install 14
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+spree_opts = '~> 4.3.2'
+gem 'spree', spree_opts
+gem 'spree_backend', spree_opts
+gem 'rails-controller-testing'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 OlympusOne
+
+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,56 @@
+# SpreeCodPayment
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/2d267f05a2c5bc404d1f/maintainability)](https://codeclimate.com/github/olympusone/spree_cod_payment/maintainability)
+
+Spree Cash On Delivery Payment extension allows web store administrator to ship order before payment is done.
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    gem 'spree_cod_payment'
+    ```
+
+2. Install the gem using Bundler
+
+    ```ruby
+    bundle install
+    ```
+
+3. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+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_cod_payment/factories'
+```
+
+## Releasing
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release REAMDE](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) 2022 OlympusOne, released under the New BSD License

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_cod_payment'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,15 @@
+module Spree::OrderDecorator
+    def self.prepended(base)
+        base.has_many :payment_adjustments, through: :payments, source: :adjustments
+    end
+
+    def cod_payment?
+        return false unless ship_address.country_iso == 'GR'
+        
+        payments.where.not(state: ['failed', 'void'])
+                .map { |m| m.payment_method.type }
+                .include?("Spree::PaymentMethod::CodPayment")
+    end
+end
+
+::Spree::Order.prepend(Spree::OrderDecorator)

data/app/models/spree/payment_decorator.rb

@@ -0,0 +1,46 @@
+module Spree::PaymentDecorator
+    def self.prepended(base)
+        base.has_one :adjustment, as: :source, dependent: :destroy
+
+        base.after_create :set_adjustment
+        base.before_update :update_adjustment
+    end
+
+    private
+
+    def set_adjustment
+        if payment_method.type == "Spree::PaymentMethod::CodPayment" && payment_method.charge && order.ship_address.country_iso == 'GR'
+            label = I18n.t('cod_payment.charge_label')
+
+            build_adjustment(
+                amount: payment_method.charge,
+                label: label,
+                order: order,
+                included: false,
+                state: 'closed',
+                adjustable: order         
+            )
+
+            adjustment.save
+            
+            order.update_totals
+            order.persist_totals
+
+            update_columns(
+                amount: order.total,
+                updated_at: Time.current
+            )
+        end
+    end
+
+    def update_adjustment
+        if payment_method.type == "Spree::PaymentMethod::CodPayment" && (void? || invalid?) && adjustment && order.ship_address.country_iso == 'GR'
+            adjustment.update(eligible: false) 
+            
+            order.update_totals
+            order.persist_totals
+        end
+    end
+end
+
+::Spree::Payment.prepend(Spree::PaymentDecorator)

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

@@ -0,0 +1,50 @@
+module Spree
+    class PaymentMethod::CodPayment < ::Spree::PaymentMethod
+      def payment_profiles_supported?
+        false # we do not want to show the confirm step
+      end
+      
+      def actions
+        %w{capture void}
+      end
+  
+      # Indicates whether its possible to capture the payment
+      def can_capture?(payment)
+        return false if payment.completed?
+        
+        payment.order.shipments.all?{|shipment|shipment.state == 'shipped'} \
+          && ['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)
+        ActiveMerchant::Billing::Response.new(true, "", {}, {})
+      end
+  
+      def cancel(response); end
+  
+      def void(*args)
+        ActiveMerchant::Billing::Response.new(true, "", {}, {})
+      end
+  
+      def source_required?
+        false
+      end
+
+      def payment_source_class
+        nil
+      end
+  
+      def method_type
+        'cod_payment'
+      end
+
+      def cod_payment?
+        true
+      end
+    end
+end

data/app/models/spree/payment_method_decorator.rb

@@ -0,0 +1,11 @@
+module Spree::PaymentMethodDecorator
+    def self.prepended(base)
+        base.preference :charge, :string
+    end
+
+    def charge
+        preferences[:charge].to_f
+    end
+end
+  
+::Spree::PaymentMethod.prepend(Spree::PaymentMethodDecorator)

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,23 @@
+module Spree::ShipmentDecorator
+    def determine_state(order)
+        return 'ready' if cod_payment? && !shipped?
+        
+        return 'canceled' if order.canceled?
+        return 'pending' unless order.can_ship?
+        return 'pending' if inventory_units.any? &:backordered?
+        return 'shipped' if shipped?
+
+        return order.paid? || Spree::Config[:auto_capture_on_dispatch] ? 'ready' : 'pending'
+    end
+
+    private
+    def cod_payment?
+        return false unless order.ship_address.country_iso == 'GR'
+        
+        order.payments.any? do |payment|
+            payment.payment_method.type == "Spree::PaymentMethod::CodPayment" && !payment.void?
+        end
+    end
+end
+
+::Spree::Shipment.prepend(Spree::ShipmentDecorator)

data/app/models/spree_cod_payment/configuration.rb

@@ -0,0 +1,8 @@
+module SpreeCodPayment
+  class Configuration < Spree::Preferences::Configuration
+   # Some example preferences are shown below, for more information visit:
+   # https://guides.spreecommerce.org/developer/core/preferences.html
+
+    # preference :cod_payment_charge, :decimal
+  end
+end

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" from the root of your extension
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_cod_payment/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/el.yml

@@ -0,0 +1,5 @@
+el:
+  spree:
+    charge: Χρέωση
+  cod_payment:
+    charge_label: Έξοδα αντικαταβολής

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  cod_payment:
+    charge_label: Cash on delivery charge

data/config/routes.rb

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

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

@@ -0,0 +1,20 @@
+module SpreeCodPayment
+  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_cod_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 'bundle exec rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_cod_payment/engine.rb

@@ -0,0 +1,28 @@
+module SpreeCodPayment
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_cod_payment'    
+    
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree.register.payment_methods', after: :after_initialize do |_app|
+      _app.config.spree.payment_methods << Spree::PaymentMethod::CodPayment
+    end
+
+    initializer 'spree_cod_payment.environment', before: :load_config_initializers do |_app|
+      SpreeCodPayment::Config = SpreeCodPayment::Configuration.new
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/spree/*_decorator*.rb')) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+    end
+    
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_cod_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_cod_payment/factories'
+end

data/lib/spree_cod_payment/version.rb

@@ -0,0 +1,11 @@
+module SpreeCodPayment
+  VERSION = '1.0.0'.freeze
+
+  module_function
+
+  # Returns the version of the currently loaded SpreeCodPayment as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION
+  end
+end

data/lib/spree_cod_payment.rb

@@ -0,0 +1,6 @@
+require 'spree_core'
+require 'spree_api'
+require 'spree_backend'
+require 'spree_extension'
+require 'spree_cod_payment/engine'
+require 'spree_cod_payment/version'

data/spree_cod_payment.gemspec

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_cod_payment/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_cod_payment'
+  s.version     = SpreeCodPayment.version
+  s.summary     = 'Spree Cash On Delivery Payment'
+  s.description = ''
+  s.required_ruby_version = '>= 2.5'
+
+  s.author       = 'OlympusOne'
+  s.email        = 'info@olympusone.com'
+  s.homepage     = 'https://github.com/olympusone/spree_cod_payment'
+  s.license      = 'MIT'
+
+  s.files       = `git ls-files`.split("\n").reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  spree_version = '>= 4.3.2'
+  s.add_dependency 'spree', spree_version
+  s.add_dependency 'spree_backend', spree_version
+  s.add_dependency 'spree_extension'
+
+  s.add_development_dependency 'spree_dev_tools'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: spree_cod_payment
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- OlympusOne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+- !ruby/object:Gem::Dependency
+  name: spree_backend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+- !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: ''
+email: info@olympusone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/.gitkeep
+- app/controllers/.gitkeep
+- app/helpers/.gitkeep
+- app/models/spree/order_decorator.rb
+- app/models/spree/payment_decorator.rb
+- app/models/spree/payment_method/cod_payment.rb
+- app/models/spree/payment_method_decorator.rb
+- app/models/spree/shipment_decorator.rb
+- app/models/spree_cod_payment/configuration.rb
+- app/serializers/.gitkeep
+- app/services/.gitkeep
+- app/views/spree/admin/payments/source_views/_cod_payment.html.erb
+- bin/rails
+- config/locales/el.yml
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/spree_cod_payment/install/install_generator.rb
+- lib/spree_cod_payment.rb
+- lib/spree_cod_payment/engine.rb
+- lib/spree_cod_payment/factories.rb
+- lib/spree_cod_payment/version.rb
+- spree_cod_payment.gemspec
+homepage: https://github.com/olympusone/spree_cod_payment
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Spree Cash On Delivery Payment
+test_files: []