spree_store_pickup 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bff3e96a314f62623ba4b7cb4886caa8f1e72a6021676ce7acb56d6d88dc310
+  data.tar.gz: b6b2cd63d857f865380ec10ea1cb0f5faf92b0e9c3791ab1a8831f19c27bcd96
+SHA512:
+  metadata.gz: 3933568d145fdf4e80de7276b084bf072b6b22be60d782341c8011cc8e47d4c2cc42ba467f5958f34ceef616fdcb5bae184949c89db8417533c2de4faad5376c
+  data.tar.gz: ad4ec212cbb7e3ada8553fa04b362ab10811fbd5cce8702b5f297af6d8338ea47421201c4a4ae85cde1184fa76b09f4e9fb62a49c0c747c5cfd780e3e42ebf83

data/LICENSE.md

@@ -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,69 @@
+# SpreeStorePickup
+
+This is a Store Pickup extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails. Adds in-store pickup as selectable shipping and payment option during checkout.
+
+[![Gem Version](https://badge.fury.io/rb/spree_store_pickup.svg)](https://badge.fury.io/rb/spree_store_pickup)
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_store_pickup
+    ```
+
+2. Install the migrations:
+
+    ```sh
+    bundle exec rake railties:install:migrations FROM=spree_store_pickup
+    ```
+
+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_store_pickup/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_store_pickup'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,51 @@
+module Spree
+  class PaymentMethod::StorePickup < Spree::PaymentMethod
+    def method_type
+      type.demodulize.underscore
+    end
+
+    def default_name
+      Spree.t(:store_pickup_method)
+    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/models/spree/payment_method_decorator.rb

@@ -0,0 +1,13 @@
+module Spree
+  module PaymentMethodDecorator
+    def store_pickup?
+      method_type == 'store_pickup'
+    end
+
+    def store_pickup_available?(order)
+      order.shipping_method&.store_pickup?
+    end
+  end
+end
+
+Spree::PaymentMethod.prepend Spree::PaymentMethodDecorator

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

@@ -0,0 +1,14 @@
+<div class="card mb-4">
+  <div class="card-header">
+    <h5 class="card-title">
+      <%= Spree.t(:store_pickup) %>
+    </h5>
+  </div>
+  <div class="card-body">
+    <div class="custom-control custom-checkbox">
+      <%= f.check_box :store_pickup, class: 'custom-control-input' %>
+      <%= f.label :store_pickup, class: 'custom-control-label font-weight-semibold' %>
+      <%= f.error_message_on :store_pickup %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,3 @@
+<p class="text-muted mb-3 text-neutral-600">
+  <%= Spree.t('storefront.checkout.store_pickup_method.description') %>
+</p>

data/config/locales/el.yml

@@ -0,0 +1,14 @@
+---
+el:
+  activerecord:
+    attributes:
+      spree/shipping_method:
+        store_pickup: Παραλαβή από το κατάστημα
+  spree:
+    store_pickup: Παραλαβή από το κατάστημα
+    store_pickup_method: Παραλαβή από το κατάστημα
+    storefront:
+      checkout:
+        store_pickup_method:
+          title: Παραλαβή από το κατάστημα
+          description: Θα πληρώσετε την παραγγελία σας κατά την παραλαβή της από το κατάστημα.

data/config/locales/en.yml

@@ -0,0 +1,14 @@
+---
+en:
+  activerecord:
+    attributes:
+      spree/shipping_method:
+        store_pickup: Store Pickup
+  spree:
+    store_pickup: Store Pickup
+    store_pickup_method: Store Pickup
+    storefront:
+      checkout:
+        store_pickup_method:
+          title: Store Pickup
+          description: You will pay for your order when you pick it up from the store.

data/config/routes.rb

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

data/db/migrate/20250601165042_add_store_pickup_to_shipping_methods.rb

@@ -0,0 +1,5 @@
+class AddStorePickupToShippingMethods < ActiveRecord::Migration[8.0]
+  def change
+    add_column :spree_shipping_methods, :store_pickup, :boolean, default: false, null: false
+  end
+end

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

@@ -0,0 +1,20 @@
+module SpreeStorePickup
+  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_store_pickup'
+      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_store_pickup/engine.rb

@@ -0,0 +1,28 @@
+module SpreeStorePickup
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_store_pickup'
+
+    # 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::StorePickup
+
+      app.config.spree_admin.shipping_method_form_partials << 'spree/admin/shipping_methods/store_pickup_form'
+
+      Spree::PermittedAttributes.shipping_method_attributes << :store_pickup
+    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_store_pickup/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_store_pickup/factories'
+end

data/lib/spree_store_pickup/version.rb

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

data/lib/spree_store_pickup.rb

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

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: spree_store_pickup
+version: !ruby/object:Gem::Version
+  version: 1.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 in-store pickup as selectable shipping and payment option during
+  checkout.
+email: info@olympusone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/models/spree/payment_method/store_pickup.rb
+- app/models/spree/payment_method_decorator.rb
+- app/views/spree/admin/payment_methods/_store_pickup.html.erb
+- app/views/spree/admin/payment_methods/descriptions/_store_pickup.html.erb
+- app/views/spree/admin/payments/source_views/_store_pickup.html.erb
+- app/views/spree/admin/shipping_methods/_store_pickup_form.html.erb
+- app/views/spree/admin/spree/checkout/payment/_store_pickup.html.erb
+- app/views/spree/checkout/payment/_store_pickup.html.erb
+- config/locales/el.yml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20250601165042_add_store_pickup_to_shipping_methods.rb
+- lib/generators/spree_store_pickup/install/install_generator.rb
+- lib/spree_store_pickup.rb
+- lib/spree_store_pickup/engine.rb
+- lib/spree_store_pickup/factories.rb
+- lib/spree_store_pickup/version.rb
+homepage: https://github.com/olympusone/spree_store_pickup
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/olympusone/spree_store_pickup/issues
+  changelog_uri: https://github.com/olympusone/spree_store_pickup/releases/tag/v1.0.0
+  documentation_uri: https://github.com/olympusone/spree_store_pickup
+  homepage_uri: https://github.com/olympusone/spree_store_pickup
+  source_code_uri: https://github.com/olympusone/spree_store_pickup/tree/v1.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 Store Pickup Extension
+test_files: []