spree_google_merchant_feed 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6fedad81fac72b814ef49704e3238d7757f18278c14266fc5c6b82c7d632ed0
+  data.tar.gz: cd6fcb8295803a8a9be6bdf6dc1df4931598b1dd5c3d70bf4360ebd2c3098dec
+SHA512:
+  metadata.gz: 8bfd24f144298c5026dd5aabc9cebdcca60e817815aa2ecd2d333304a833e8095d64099a15ce0f41ce574fdda1cbf4c2516ada2a080b73648c3f9ed06169c3a0
+  data.tar.gz: 1ab4bf7f1d16cf8e8f8316c9ae97488f06266f7d2f4c95043e133f4597a8a20f1d31a83cdf75aaab3be0f89695e460aff840addf9e76f6d4a9253cf886bc5cef

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 @@
+# SpreeGoogleMerchantFeed
+
+This is a Google Merchant 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 Google Merchant Center for Spree Commerce.
+
+[![Gem Version](https://badge.fury.io/rb/spree_google_merchant_feed.svg)](https://badge.fury.io/rb/spree_google_merchant_feed)
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_google_merchant_feed
+    ```
+
+2. Install the migrations:
+
+    ```sh
+    bundle exec rake railties:install:migrations FROM=spree_google_merchant_feed
+    ```
+
+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_google_merchant_feed/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
+
+## Google Merchant Center Integration
+
+To use your Google Merchant endpoint as a data source in Google Merchant 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/google_merchant/products.xml`
+
+2. **Copy your endpoint URL**  
+  This is the URL that Google Merchant Center will fetch data from.
+
+3. **Add as a data feed in Google Merchant Center**
+   - Go to [Google Merchant Center](https://merchants.google.com/).
+   - 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/google_merchant/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_google_merchant_feed'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/controllers/spree/google_merchant_controller.rb

@@ -0,0 +1,16 @@
+module Spree
+  class GoogleMerchantController < 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/google_merchant/products', formats: [:xml]))
+          send_data(gz_xml, filename: 'sitemap.xml.gz', type: 'application/x-gzip', disposition: 'inline')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
+xml.rss version: "2.0", "xmlns:g" => "http://base.google.com/ns/1.0" do
+  xml.channel do
+    cache current_store do
+      xml.title current_store.name
+      xml.link root_url
+      xml.description current_store.meta_description
+    end
+
+    cache [storefront_products_scope, current_currency] do
+      storefront_products_scope.find_each do |product|
+        xml.item do
+          # Basic product data
+          xml.tag! "g:id", product.id
+          xml.tag! "g:title", product.name.truncate(150)
+          xml.tag! "g:description", product.storefront_description&.truncate(5000)
+          xml.tag! "g:link", spree_storefront_resource_url(product)
+          if product.default_image.present?
+            xml.tag! "g:image_link", spree_image_url(product.featured_image, width: 500, height: 500)
+          end
+
+          # Price and availability
+          xml.tag! "g:availability", product.in_stock? ? "in_stock" : "out_of_stock"
+          xml.tag! "g:availability_date", product.available_on.strftime("%Y-%m-%dT%H:%M%z") if product.available_on?
+          xml.tag! "g:expiration_date", product.discontinue_on.strftime("%Y-%m-%dT%H:%M%z") if product.discontinue_on?
+          xml.tag! "g:price", format('%.2f', product.display_amount.to_d) + " " + current_currency
+        
+          # Product category
+          xml.tag! "g:product_type", product_breadcrumb_taxons(product).map(&:name).join(' > ')
+
+          # Product identifiers
+          xml.tag! "g:brand", product.brand.name if product.brand.present?
+          xml.tag! "g:gtin", product.sku
+
+          # Detailed product description
+          xml.tag! "g:product_weight", "#{product.weight}#{product.weight_unit}" if product.weight.present?
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

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

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

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

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

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

data/lib/spree_google_merchant_feed/version.rb

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

data/lib/spree_google_merchant_feed.rb

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

metadata

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