spree_skroutz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8399789b8170126986e56193fca96b76eb74ac84fa6f933613dc9eee312256f8
+  data.tar.gz: f7913d009f8cb44b9fea3196a8e75dd1d3a9e8b57723597ee125d8b2cc80edf1
+SHA512:
+  metadata.gz: 2a4a67024fc640b44afa7a003d16b531b06d7010c9311dd9c7fa9db51b3aa37c2452e8fe22c3e3f0cedf9e8550bb34ee7be23a6254644fa99b2a5b87f0f3dfac
+  data.tar.gz: fc2e3cae6270e353901903848e6387c5a1902eb711560e396fcf3080b0a8fb1eae09cce8baa229ae69ce254917db6b0bed6d6d713e162d762e03983048304ccb

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,93 @@
+# SpreeSkroutz
+
+This is a Skroutz extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails. Adds the ability to provide products listings to Skroutz Marketplace for Spree Commerce.
+
+[![Gem Version](https://badge.fury.io/rb/spree_skroutz.svg)](https://badge.fury.io/rb/spree_skroutz)
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_skroutz
+    ```
+
+2. Install the migrations:
+
+    ```sh
+    bundle exec rake railties:install:migrations FROM=spree_skroutz
+    ```
+
+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_skroutz/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
+
+## Skroutz Center Integration
+
+To use your Skroutz endpoint as a data source in Skroutz Center:
+
+1. **Deploy your endpoint**
+  Ensure your authentication and data endpoints are publicly accessible and return the required data format (e.g., XML, CSV, or JSON).
+  For this extension, your endpoint will typically be:
+  `https://yoursite.com/skroutz/products.xml`
+
+2. **Copy your endpoint URL**
+  This is the URL that Skroutz Center will fetch data from.
+
+3. **Add as a data feed in Skroutz Center**
+   - Go to [Skroutz Merchants](https://merchants.skroutz.gr/).
+   - In the header, click **Settings & tools**.
+   - Select **Data sources**.
+   - Click **Add product source**.
+   - Choose **Add products from a file**.
+   - Enter your endpoint URL (e.g., `https://yoursite.com/skroutz/products.xml`) as the feed source.
+   - Set fetch frequency and credentials if authentication is required.
+
+4. **Test and verify**
+  After saving, Google will attempt to fetch your data. Check for errors and ensure your feed is processed correctly.

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

data/app/controllers/spree/skroutz_controller.rb

@@ -0,0 +1,16 @@
+module Spree
+  class SkroutzController < StoreController
+    include BaseHelper
+    include StorefrontHelper
+
+    def products
+      respond_to do |format|
+        format.xml
+        format.gzip do
+          gz_xml = ActiveSupport::Gzip.compress(render_to_string(template: 'spree/skroutz/products', formats: [:xml]))
+          send_data(gz_xml, filename: 'products.xml.gz', type: 'application/x-gzip', disposition: 'inline')
+        end
+      end
+    end
+  end
+end

data/app/views/spree/skroutz/products.xml.builder

@@ -0,0 +1,91 @@
+xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
+
+xml.mywebstore do
+  cache [storefront_products_scope, current_currency] do
+    xml.created_at Time.current.strftime("%Y-%m-%d %H:%M")
+
+    xml.products do
+      storefront_products_scope.find_each do |product|
+        xml.product do
+          xml.tag! "id", product.id
+          xml.tag! "name" do
+            xml.cdata! product.name
+          end
+
+          if product.storefront_description.present?
+            xml.tag! "description", product.storefront_description&.truncate(10000)
+          end
+
+          xml.tag! "link" do
+            xml.cdata! spree_storefront_resource_url(product)
+          end
+
+          if product.default_image.present?
+            xml.tag! "image" do
+              xml.cdata! spree_image_url(product.default_image, width: 500, height: 500)
+            end
+          end
+          if product.secondary_image.present?
+            xml.tag! "additionalimage" do
+              xml.cdata! spree_image_url(product.secondary_image, width: 500, height: 500)
+            end
+          end
+
+          xml.tag! "category" do
+            xml.cdata! product_breadcrumb_taxons(product).map(&:name).join(' > ')
+          end
+          xml.tag! "price_with_vat", format('%.2f', product.display_amount.to_d)
+
+          if product.tax_category.present?
+            tax_rate = product.tax_category.tax_rates.first
+            xml.tag! "vat", format('%.2f', tax_rate&.amount_percentage || 0)
+          else
+            xml.tag! "vat", 0
+          end
+
+          if product.brand.present?
+            xml.tag! "manufacturer" do
+              xml.cdata! product.brand.name
+            end
+          end
+
+          xml.tag! "ean", product.barcode if product.barcode.present?
+          xml.tag! "availability", product.in_stock? ? "In stock" : "Out of stock"
+          xml.tag! "weight", "#{product.weight} #{product.weight_unit}" if product.weight.present?
+
+          colors = product.option_values.select{|ov| ov.option_type.name.downcase == 'color' }
+            .map(&:presentation)
+            .uniq
+          xml.tag! "color", colors.join(',') if colors.any?
+
+          size = product.option_values.select{|ov| ov.option_type.name.downcase == 'size' }
+            .map(&:presentation)
+            .uniq
+          xml.tag! "size", size.join(',') if size.any?
+
+          xml.tag! "quantity", product.total_on_hand
+
+          if product.has_variants?
+            xml.variations do
+              product.variants.each do |variant|
+                xml.variation do
+                  xml.tag! "variationid", variant.id
+                  xml.tag! "availability", variant.in_stock? ? "In stock" : "Out of stock"
+                  xml.tag! "ean", variant.barcode if variant.barcode.present?
+                  xml.tag! "price_with_vat", format('%.2f', variant.display_amount.to_d)
+
+                  size = variant.option_values.select{|ov| ov.option_type.name.downcase == 'size' }
+                    .map(&:presentation)
+                    .uniq
+                  xml.tag! "size", size.join(',') if size.any?
+
+                  xml.tag! "quantity", variant.total_on_hand
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

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

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

@@ -0,0 +1,20 @@
+module SpreeSkroutz
+  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_skroutz'
+      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_skroutz/configuration.rb

@@ -0,0 +1,13 @@
+module SpreeSkroutz
+  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_skroutz/engine.rb

@@ -0,0 +1,24 @@
+module SpreeSkroutz
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_skroutz'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_skroutz.environment', before: :load_config_initializers do |_app|
+      SpreeSkroutz::Config = SpreeSkroutz::Configuration.new
+    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_skroutz/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_skroutz/factories'
+end

data/lib/spree_skroutz/version.rb

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

data/lib/spree_skroutz.rb

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: spree_skroutz
+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 the ability to provide products feed to Skroutz Marketplace for
+  Spree Commerce.
+email: info@olympusone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/controllers/spree/skroutz_controller.rb
+- app/views/spree/skroutz/products.xml.builder
+- config/routes.rb
+- lib/generators/spree_skroutz/install/install_generator.rb
+- lib/spree_skroutz.rb
+- lib/spree_skroutz/configuration.rb
+- lib/spree_skroutz/engine.rb
+- lib/spree_skroutz/factories.rb
+- lib/spree_skroutz/version.rb
+homepage: https://github.com/olympusone/spree_skroutz
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/olympusone/spree_skroutz/issues
+  changelog_uri: https://github.com/olympusone/spree_skroutz/releases/tag/v1.0.0
+  documentation_uri: https://github.com/olympusone/spree_skroutz
+  homepage_uri: https://github.com/olympusone/spree_skroutz
+  source_code_uri: https://github.com/olympusone/spree_skroutz/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 Skroutz Extension
+test_files: []