spree_cod_payment 2.1.4 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d0754f87eb4e4ef36d219a5b08173f0aa1415406743a54a8f8733d261121651
-  data.tar.gz: 262475f6e407a57f1b8b2ff5bbbeec1bf14616db66b540864cb4b305e1c02d8f
+  metadata.gz: 072c0fb115ffe57b9ef898a4e4302277c77aa4b312cf4d7478301ff8c002ff39
+  data.tar.gz: ec31dc0fac14b895b973706a80767a95ebd47f949d36c11dc53c116126db362b
 SHA512:
-  metadata.gz: '09969f5c0c2a29eaf1d92fd0f423531720afb9ed6c4455116297c4b7d3ae2a8ad683e869421a591d30d05e29217e5920bdf18d335abbea2c7de19f0705a2ea70'
-  data.tar.gz: 6106b0a6d05e0a9ab5eaf0c5a2cb12f39a7d5455ae7532c0ec81ab7658c607f7b6dacf37fda84a663b96e8c0a5a66c3e542f4fd19dad7b931e19a772326c449d
+  metadata.gz: 930c01febe106423066542d298faa9824c7161a8b3eb51ced8068dd80805a0c064403ab6aebbec021d7e6ca828525dfc96eeff30e037270419f1dbe83342398a
+  data.tar.gz: cfe061924bce0d3cbae8af428974df1c5588ea9150652096278a3a62239535aaed3dbc3f57ee6f03261f10656600431fe1d1219ad68e5a31c2b624d29e66e345

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 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

@@ -1,4 +1,4 @@
-# SpreeCodPayment
+# Spree COD Payment
 
 This is a Cash On Delivery Payment extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails. Adds Cash on Delivery (COD) payment method option during checkout.
 
@@ -6,63 +6,82 @@ This is a Cash On Delivery Payment extension for [Spree Commerce](https://spreec
 
 ## Installation
 
-1. Add this extension to your Gemfile:
+1. Add this extension to your Gemfile with this line:
 
     ```bash
     bundle add spree_cod_payment
     ```
 
-2. Install the migrations:
+2. Run the install generator
 
     ```bash
-    bundle exec rake railties:install:migrations FROM=spree_cod_payment
+    bundle exec rails g spree_cod_payment:install
     ```
 
-3. Run the migrations:
+3. Restart your server
 
-    ```bash
-    bundle exec rails db:migrate
-    ```
+  If your server was running, restart it so that it can find the assets properly.
+
+## Usage
+
+1. Create a Payment Method for Cash on Delivery (e.g. name: "Cash on Delivery") whose `method_type` is `cod_payment`.
+2. This gem supplies helpers:
+   * `payment_method.cod_payment?`
+   * `payment_method.cod_payment_available?(order)` (true when the order’s shipping method supports COD)
+3. To show the COD payment method ONLY when eligible (and optionally hide it for store pickup), add a decorator in the host app:
+
+````ruby
+module Spree
+  module PaymentMethodDecorator
+    def available_for_order?(order)
+      return false unless super
+
+      # Show COD only when shipping method allows it.
+      if cod_payment_available?(order)
+        return cod_payment?
+      end
+
+      # If integrating with store pickup (from spree_store_pickup):
+      if respond_to?(:store_pickup_available?) && store_pickup_available?(order)
+        return false if cod_payment?            # Hide COD during pickup
+        return !cod_payment?                    # Allow other methods
+      end
+
+      # Hide specialized method when its condition is not met.
+      return false if cod_payment?
+
+      true
+    end
+  end
 
-4. Restart your server
+  PaymentMethod.prepend PaymentMethodDecorator
+end
+````
 
 ## Developing
 
-1. Create a dummy app:
+1. Create a dummy app
 
     ```bash
     bundle update
     bundle exec rake test_app
     ```
 
-2. Add code.
+2. Add your new code
 
-3. Run tests:
+3. Run tests
 
     ```bash
     bundle exec rspec
     ```
 
-When testing your application's integration you may use its factories:
+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'
 ```
 
-## Testing
-
-Generate the test app:
-
-```bash
-bundle exec rake test_app
-```
-
-Then run:
-
-```bash
-bundle exec rspec
-```
-
 ## Releasing a new version
 
 ```bash
@@ -78,4 +97,4 @@ 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 AGPL-3.0 or later.
+Copyright (c) 2026 OlympusOne, released under the MIT License.

data/app/models/spree/payment_method_decorator.rb

@@ -8,6 +8,6 @@ module Spree
       order.shipping_method&.cod?
     end
   end
-end
 
-Spree::PaymentMethod.prepend Spree::PaymentMethodDecorator
+  PaymentMethod.prepend PaymentMethodDecorator
+end

data/app/views/spree/admin/shipping_methods/_cod_form.html.erb

@@ -5,10 +5,6 @@
     </h5>
   </div>
   <div class="card-body">
-    <div class="custom-control custom-checkbox">
-      <%= f.check_box :cod, class: 'custom-control-input' %>
-      <%= f.label :cod, class: 'custom-control-label font-weight-semibold' %>
-      <%= f.error_message_on :cod %>
-    </div>
+    <%= f.spree_check_box :cod %>
   </div>
 </div>

data/config/initializers/spree.rb

@@ -1,8 +1,7 @@
 Rails.application.config.after_initialize do
-  Rails.application.config.spree.payment_methods << Spree::PaymentMethod::CodPayment
+  Spree.payment_methods << Spree::PaymentMethod::CodPayment
 
-  # Admin partials
-  Rails.application.config.spree_admin.shipping_method_form_partials << 'spree/admin/shipping_methods/cod_form'
+  Spree.admin.partials.shipping_method_form << 'spree/admin/shipping_methods/cod_form'
 
   Spree::PermittedAttributes.shipping_method_attributes << :cod
 end

data/lib/spree_cod_payment/version.rb

@@ -1,5 +1,5 @@
 module SpreeCodPayment
-  VERSION = '2.1.4'.freeze
+  VERSION = '2.1.6'.freeze
 
   def gem_version
     Gem::Version.new(VERSION)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_cod_payment
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.6
 platform: ruby
 authors:
 - OlympusOne
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_storefront
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.8
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: spree_extension
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.md
+- LICENSE
 - README.md
 - Rakefile
 - app/models/spree/payment_method/cod_payment.rb
@@ -109,13 +109,13 @@ files:
 - lib/spree_cod_payment/version.rb
 homepage: https://github.com/olympusone/spree_cod_payment
 licenses:
-- AGPL-3.0-or-later
+- MIT
 metadata:
   bug_tracker_uri: https://github.com/olympusone/spree_cod_payment/issues
-  changelog_uri: https://github.com/olympusone/spree_cod_payment/releases/tag/v2.1.4
+  changelog_uri: https://github.com/olympusone/spree_cod_payment/releases/tag/v2.1.6
   documentation_uri: https://github.com/olympusone/spree_cod_payment
   homepage_uri: https://github.com/olympusone/spree_cod_payment
-  source_code_uri: https://github.com/olympusone/spree_cod_payment/tree/v2.1.4
+  source_code_uri: https://github.com/olympusone/spree_cod_payment/tree/v2.1.6
 rdoc_options: []
 require_paths:
 - lib

data/LICENSE.md

@@ -1,15 +0,0 @@
-# LICENSE
-
-Copyright (c) 2025 OlympusOne. All rights reserved.
-
-This program is free software: you can redistribute it and/or modify it under the terms of the
-GNU Affero General Public License as published by the Free Software Foundation, either
-version 3 of the License, or any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).