spree_bestprice 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 037e25c6d63748d61af761af2f8eeda5e83583098b88f3858e386e47c5361437
+  data.tar.gz: 4059819ae737953a3cce2c3a8a87b4050855a0db537ef7245dc031b3ce13bb39
+SHA512:
+  metadata.gz: 7529023166756a2904131933d37788e611b146dc026fc58dc46934b8bf050f76bc69f4982326bf6dbb978798cb1486698d1e6718257a6f905dea189e90976b96
+  data.tar.gz: 5017f1436a86bd42f8802640737d676c5d215d2a2b22820a7b511c852460c95fc43255ad7bd52d0dc07af7324f147630641a6f5feaca7c5b08ab170639e3b414

data/README.md

@@ -0,0 +1,73 @@
+# Spree BestPrice
+
+This is a BestPrice extension for [Spree Commerce](https://spreecommerce.org), an open‑source e-commerce platform built with Ruby on Rails. It adds the ability to provide products listings to BestPrice Martketplace.
+
+[![Gem Version](https://badge.fury.io/rb/spree_bestprice.svg)](https://badge.fury.io/rb/spree_bestprice)
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+   ```bash
+   bundle add spree_bestprice
+   ```
+
+2. Restart your server
+
+## Usage
+
+1. **Deploy your endpoint**
+   Once the extension is installed and enabled for your store, the feed is publicly served at:
+   `https://yoursite.com/bestprice/products.xml`
+
+2. **Whitelist BestPrice's bot IPs**
+   BestPrice's crawler needs access to the feed URL. Make sure these IPs aren't blocked by a firewall, WAF, or bot-protection layer:
+
+- `139.91.201.40`
+- `139.91.200.222`
+- `62.103.124.6`
+- `62.103.124.3`
+
+3. **Register the feed with BestPrice**
+   Share your feed URL with BestPrice (via your Partner Platform contact) to have it added as a data source. New products are typically ingested within 3 business days of the first successful fetch; this isn't something you configure — BestPrice controls the fetch schedule on their end. If a fetch fails, they retry and will email you if the problem persists.
+
+## 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_bestprice/factories'
+```
+
+## Releasing a new version
+
+```bash
+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) 2026 OlympusOne, released under the MIT 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_bestprice'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/config/spree_bestprice_manifest.js

@@ -0,0 +1 @@
+//= link_tree ../images

data/app/controllers/spree/bestprice_controller.rb

@@ -0,0 +1,28 @@
+module Spree
+  class BestpriceController < StoreController
+    include BaseHelper
+    include StorefrontHelper
+
+    before_action :ensure_feed_enabled
+
+    def products
+      respond_to do |format|
+        format.xml do
+          render template: 'spree_bestprice/products', formats: [:xml]
+        end
+        format.gzip do
+          gz_xml = ActiveSupport::Gzip.compress(render_to_string(template: 'spree_bestprice/products', formats: [:xml]))
+          send_data(gz_xml, filename: 'products.xml.gz', type: 'application/x-gzip', disposition: 'inline')
+        end
+      end
+    end
+
+    private
+
+    def ensure_feed_enabled
+      unless store_integration('bestprice').present?
+        render plain: 'BestPrice extension is not enabled for this store.', status: :not_found
+      end
+    end
+  end
+end

data/app/models/spree/integrations/bestprice.rb

@@ -0,0 +1,36 @@
+module Spree
+  module Integrations
+    class Bestprice < Spree::Integration
+      IN_STOCK_AVAILABILITY = {
+        pickup: 'Σε απόθεμα',
+        delivery: 'Παράδοση σε 1-3 ημέρες'
+      }.freeze
+
+      OUT_OF_STOCK_AVAILABILITY_OPTIONS = [
+        'Παράδοση σε 4-7 ημέρες',
+        'Παράδοση σε 4-10 ημέρες',
+        'Παράδοση σε 8-14 ημέρες',
+        'Παράδοση σε 15-30 ημέρες',
+        'Κατόπιν παραγγελίας',
+        'Προπαραγγελία',
+        'Εξαντλήθηκε'
+      ].freeze
+
+      AVAILABILITY_OPTIONS = [
+        *IN_STOCK_AVAILABILITY.values,
+        *OUT_OF_STOCK_AVAILABILITY_OPTIONS
+      ].freeze
+
+      preference :physical_pickup, :boolean, default: false
+      preference :default_availability, :string
+
+      def self.integration_group
+        'marketing'
+      end
+
+      def self.icon_path
+        'integration_icons/bestprice-logo.png'
+      end
+    end
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,13 @@
+module Spree
+  module ProductDecorator
+    def bestprice_availability
+      private_metadata['bestprice_availability'].presence
+    end
+
+    def bestprice_availability=(value)
+      self.private_metadata = private_metadata.merge('bestprice_availability' => value.presence)
+    end
+
+    Spree::Product.prepend self
+  end
+end

data/app/views/spree/admin/integrations/forms/_bestprice.html.erb

@@ -0,0 +1,19 @@
+<div class="col-12 col-md-6 p-0">
+  <div class="card mb-4">
+    <div class="card-body">
+      <p>
+        <%= Spree.t('admin.integrations.bestprice.description') %>
+      </p>
+
+      <%= preference_field(@integration, form, 'physical_pickup', i18n_scope: 'admin.integrations.bestprice') %>
+
+      <div class="form-group">
+        <%= form.label :preferred_default_availability, Spree.t('admin.integrations.bestprice.preferred_default_availability') %>
+        <%= form.select :preferred_default_availability,
+              options_for_select(Spree::Integrations::Bestprice::OUT_OF_STOCK_AVAILABILITY_OPTIONS, @integration.preferred_default_availability),
+              { include_blank: Spree.t('admin.integrations.bestprice.preferred_default_availability_none') },
+              { class: 'custom-select', data: { action: 'auto-submit#submit' } } %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/spree/admin/products/_bestprice_availability.html.erb

@@ -0,0 +1,19 @@
+<div class="card mb-4">
+  <div class="card-header">
+    <h6 class="mb-0"><%= Spree.t('admin.integrations.bestprice.title') %></h6>
+  </div>
+  <div class="card-body">
+    <div class="form-group">
+      <%= f.label :bestprice_availability, Spree.t('admin.products.bestprice_availability') %>
+      <%= f.select :bestprice_availability,
+            options_for_select(
+              [[Spree.t('admin.products.bestprice_availability_default'), '']] +
+              Spree::Integrations::Bestprice::OUT_OF_STOCK_AVAILABILITY_OPTIONS,
+              product.bestprice_availability.to_s
+            ),
+            {},
+            { class: 'custom-select' } %>
+      <small class="form-text text-muted"><%= Spree.t('admin.products.bestprice_availability_hint') %></small>
+    </div>
+  </div>
+</div>

data/app/views/spree_bestprice/products.xml.builder

@@ -0,0 +1,123 @@
+xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
+
+bestprice_integration = store_integration('bestprice')
+default_in_stock_availability = if bestprice_integration&.preferred_physical_pickup
+  Spree::Integrations::Bestprice::IN_STOCK_AVAILABILITY[:pickup]
+else
+  Spree::Integrations::Bestprice::IN_STOCK_AVAILABILITY[:delivery]
+end
+default_out_of_stock_availability = bestprice_integration&.preferred_default_availability.presence ||
+  Spree::Integrations::Bestprice::OUT_OF_STOCK_AVAILABILITY_OPTIONS.last
+
+resolve_availability = lambda do |item_in_stock, override|
+  override.presence || (item_in_stock ? default_in_stock_availability : default_out_of_stock_availability)
+end
+
+option_values_by_type_name = lambda do |variants, type_name|
+  variants.flat_map(&:option_values)
+    .select { |ov| ov.option_type.name.downcase == type_name }
+    .map(&:presentation)
+    .uniq
+end
+
+xml.store do
+  cache [storefront_products_scope, current_currency] do
+    xml.date Time.current.strftime("%Y-%m-%d %H:%M")
+
+    xml.products do
+      storefront_products_scope.find_each do |product|
+        color_option_type = product.option_types.find { |ot| ot.name.downcase == 'color' }
+
+        entries = if color_option_type
+          product.variants
+            .group_by { |v| v.option_values.find { |ov| ov.option_type_id == color_option_type.id } }
+            .reject { |color_value, _| color_value.nil? }
+            .map do |color_value, variants|
+              title = if product.name.downcase.include?(color_value.presentation.downcase)
+                product.name
+              else
+                "#{product.name} - #{color_value.presentation}"
+              end
+
+              {
+                id: "#{product.id}-#{color_value.id}",
+                title: title,
+                variants: variants
+              }
+            end
+        else
+          [{ id: product.id.to_s, title: product.name, variants: product.variants.presence || [product.master] }]
+        end
+
+        breadcrumb_taxons = product_breadcrumb_taxons(product)
+
+        entries.each do |entry|
+          variants = entry[:variants]
+          in_stock = variants.any?(&:in_stock?)
+          availability = resolve_availability.call(in_stock, product.bestprice_availability)
+
+          representative_variant = variants.find(&:in_stock?) || variants.first
+
+          xml.product do
+            xml.tag! "productId", entry[:id]
+
+            xml.tag! "title" do
+              xml.cdata! entry[:title]
+            end
+
+            xml.tag! "productURL" do
+              xml.cdata! spree_storefront_resource_url(product)
+            end
+
+            entry_images = variants.flat_map(&:images).uniq
+            entry_images = [product.default_image].compact if entry_images.empty?
+
+            xml.tag! "image" do
+              xml.cdata! spree_image_url(entry_images.first, width: 500, height: 500) if entry_images.first
+            end
+
+            entry_images[1..].each do |image|
+              xml.tag! "additional_image" do
+                xml.cdata! spree_image_url(image, width: 500, height: 500)
+              end
+            end
+
+            xml.tag! "category_id", breadcrumb_taxons.last.id if breadcrumb_taxons.any?
+
+            xml.tag! "category_name" do
+              xml.cdata! breadcrumb_taxons.map(&:name).join('->')
+            end
+
+            xml.tag! "price", format('%.2f', representative_variant.display_price.to_d)
+
+            xml.tag! "availability", availability
+
+            xml.tag! "stock", in_stock ? 'Y' : 'N'
+
+            xml.tag! "manufacturer" do
+              xml.cdata! product.brand_taxon&.name.to_s
+            end
+
+            xml.tag! "ean", representative_variant.barcode.presence || product.barcode
+
+            size = option_values_by_type_name.call(variants, 'size')
+            xml.tag! "size", size.join(',') if size.any?
+
+            xml.tag! "weight", "#{product.weight} #{product.weight_unit}" if product.weight.present?
+
+            color = option_values_by_type_name.call(variants, 'color')
+            xml.tag! "color", color.join(',') if color.any?
+
+            if product.storefront_description.present?
+              xml.tag! "description" do
+                xml.cdata! product.storefront_description&.truncate(10000)
+              end
+            end
+
+            xml.tag! "quantity", variants.sum(&:total_on_hand)
+          end
+        end
+      end
+    end
+  end
+end

data/config/initializers/spree.rb

@@ -0,0 +1,7 @@
+Rails.application.config.after_initialize do
+  Spree.integrations << Spree::Integrations::Bestprice
+
+  Spree::PermittedAttributes.product_attributes.push(:bestprice_availability)
+
+  Rails.application.config.spree_admin.product_form_partials << 'spree/admin/products/bestprice_availability'
+end

data/config/locales/el.yml

@@ -0,0 +1,15 @@
+---
+el:
+  spree:
+    admin:
+      integrations:
+        bestprice:
+          title: BestPrice
+          description: Το BestPrice είναι εργαλείο για καταχωρίσεις προϊόντων στο BestPrice
+          physical_pickup: Το κατάστημα διαθέτει φυσικό σημείο παραλαβής
+          preferred_default_availability: Προεπιλεγμένη διαθεσιμότητα (εκτός αποθέματος)
+          preferred_default_availability_none: "Χωρίς προεπιλογή (τα εκτός αποθέματος εξαιρούνται)"
+      products:
+        bestprice_availability: Διαθεσιμότητα BestPrice (override)
+        bestprice_availability_default: Χρήση προεπιλογής καταστήματος
+        bestprice_availability_hint: Αναφέρετε πάντα αυτή τη διαθεσιμότητα για το προϊόν, ανεξαρτήτως αποθέματος.

data/config/locales/en.yml

@@ -0,0 +1,15 @@
+---
+en:
+  spree:
+    admin:
+      integrations:
+        bestprice:
+          title: BestPrice
+          description: BestPrice is a channel integration for product listings on BestPrice
+          physical_pickup: Store has a physical pickup location
+          preferred_default_availability: Default availability (out of stock)
+          preferred_default_availability_none: "No default (out-of-stock products excluded)"
+      products:
+        bestprice_availability: BestPrice availability override
+        bestprice_availability_default: Use store default
+        bestprice_availability_hint: Always report this availability status for this product, regardless of stock level.

data/config/routes.rb

@@ -0,0 +1,4 @@
+Spree::Core::Engine.add_routes do
+  get '/bestprice/products.xml', to: 'bestprice#products', defaults: { format: :xml }
+  get '/bestprice/products.xml.gz', to: 'bestprice#products'
+end

data/lib/spree_bestprice/configuration.rb

@@ -0,0 +1,13 @@
+module SpreeBestPrice
+  class Configuration < Spree::Preferences::Configuration
+
+   # Some example preferences are shown below, for more information visit:
+   # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
+
+   # preference :enabled, :boolean, default: true
+   # preference :dark_chocolate, :boolean, default: true
+   # preference :color, :string, default: 'Red'
+   # preference :favorite_number, :integer
+   # preference :supported_locales, :array, default: [:en]
+  end
+end

data/lib/spree_bestprice/engine.rb

@@ -0,0 +1,32 @@
+module SpreeBestPrice
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_bestprice'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_bestprice.environment', before: :load_config_initializers do |_app|
+      SpreeBestPrice::Config = SpreeBestPrice::Configuration.new
+    end
+
+    initializer 'spree_bestprice.assets' do |app|
+      app.config.assets.precompile += %w[spree_bestprice_manifest]
+    end
+
+    initializer 'spree_bestprice.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << root.join('config/importmap.rb')
+    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_bestprice/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :bestprice_integration, class: Spree::Integrations::Bestprice do
+    active { true }
+    store { Spree::Store.default }
+  end
+end

data/lib/spree_bestprice/version.rb

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

data/lib/spree_bestprice.rb

@@ -0,0 +1,5 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_bestprice/engine'
+require 'spree_bestprice/version'
+require 'spree_bestprice/configuration'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: spree_bestprice
+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.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: spree_storefront
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: spree_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !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 the ability to provide products listings to BestPrice.
+email: info@olympusone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/spree_bestprice_manifest.js
+- app/assets/images/integration_icons/bestprice-logo.png
+- app/controllers/spree/bestprice_controller.rb
+- app/models/spree/integrations/bestprice.rb
+- app/models/spree/product_decorator.rb
+- app/views/spree/admin/integrations/forms/_bestprice.html.erb
+- app/views/spree/admin/products/_bestprice_availability.html.erb
+- app/views/spree_bestprice/products.xml.builder
+- config/initializers/spree.rb
+- config/locales/el.yml
+- config/locales/en.yml
+- config/routes.rb
+- lib/spree_bestprice.rb
+- lib/spree_bestprice/configuration.rb
+- lib/spree_bestprice/engine.rb
+- lib/spree_bestprice/factories.rb
+- lib/spree_bestprice/version.rb
+homepage: https://github.com/olympusone/spree_bestprice
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/olympusone/spree_bestprice/issues
+  changelog_uri: https://github.com/olympusone/spree_bestprice/releases/tag/v1.0.0
+  documentation_uri: https://github.com/olympusone/spree_bestprice
+  homepage_uri: https://github.com/olympusone/spree_bestprice
+  source_code_uri: https://github.com/olympusone/spree_bestprice/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: 4.0.3
+specification_version: 4
+summary: Spree Commerce BestPrice Extension
+test_files: []