spree_google_merchant_feed 1.0.3 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9047c7c39bc7dee13aecaa0d8fd61dd9fbb5f81b263116f5c5e0b3985f94b350
-  data.tar.gz: 1da142506a491ca2dc304dfaefe67571bd227cb764753e5313ac929ee446b195
+  metadata.gz: 73bd1e391cd46c9881a481dec0598576a49ffe623ff6ad827b5286d1d0408b1b
+  data.tar.gz: 41e80986993067fa780d64529935f3ec18ad82042a436aa68eabcf2c91d2aa8f
 SHA512:
-  metadata.gz: f11a3df8ba3fc76299758c98bb458e321e9183722e44e5aa51b5b823a5f5b6daf14e5f8c1892ca48ee92d92ad0ca94ad3b0a2d518c44119458d4677d032bbe82
-  data.tar.gz: 6e995c240d91260c393ace2980a96982b49a466eea4ba5fafa28cabb0dbc55853c390c217b810217dc2e40ba6aced25ac86daa5ea2a3955c1373cbc043812b81
+  metadata.gz: 1c27f241cd94a99b23cf84f003ebb2a62953d8a283a6996d6688bf2f90725b9dcea0d6c5dd64f9b4a92c20cdddbd9f4c3b5165b53656b1209904a48c16e9b6c1
+  data.tar.gz: 90be81863d28167c8ff7ac7fd07cbe01c963d39f34359abf82f87fdf14ac21e433d02d96834ee5c691f7c1ee22ec947efc5007256e64d811354d458feabf0326

data/LICENSE.md

@@ -1,21 +1,15 @@
-# MIT License
+# LICENSE
 
-Copyright (c) 2025 OlympusOne
+Copyright (c) 2025 OlympusOne. All rights reserved.
 
-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:
+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.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+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.
 
-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.
+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/).

data/README.md

@@ -1,59 +1,83 @@
 # 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.
+This is a Google Merchant 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 Google Merchant Center.
 
 [![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:
+1. Add this extension to your Gemfile:
 
-    ```ruby
+    ```bash
     bundle add spree_google_merchant_feed
     ```
 
-2. Install the migrations:
+2. Restart your server.
 
-    ```sh
-    bundle exec rake railties:install:migrations FROM=spree_google_merchant_feed
-    ```
+## Usage
 
-3. Run the migrations:
+To use your Google Merchant endpoint as a data source in Google Merchant Center:
 
-    ```sh
-    bundle exec rails db:migrate
-    ```
+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`
 
-4. Restart your server
+2. **Copy your endpoint URL**
+  This is the URL that Google Merchant Center will fetch data from.
 
-  If your server was running, restart it so that it can find the assets properly.
+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.
 
 ## Developing
 
-1. Create a dummy app
+1. Create a dummy app:
 
     ```bash
     bundle update
     bundle exec rake test_app
     ```
 
-2. Add your new code
-3. Run tests
+2. Add 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:
+When testing your application's integration you may use its factories:
 
 ```ruby
 require 'spree_google_merchant_feed/factories'
 ```
 
+## Testing
+
+Generate the test app:
+
+```bash
+bundle exec rake test_app
+```
+
+Then run:
+
+```bash
+bundle exec rspec
+```
+
 ## Releasing a new version
 
-```shell
+```bash
 bundle exec gem bump -p -t
 bundle exec gem release
 ```
@@ -66,28 +90,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 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.
+Copyright (c) 2025 OlympusOne, released under the AGPL-3.0 or later.

data/app/assets/config/spree_google_merchant_feed_manifest.js

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

data/app/controllers/spree/google_merchant_feed_controller.rb

@@ -0,0 +1,28 @@
+module Spree
+  class GoogleMerchantFeedController < StoreController
+    include BaseHelper
+    include StorefrontHelper
+
+    before_action :ensure_feed_enabled
+
+    def products
+      respond_to do |format|
+        format.xml do
+          render template: 'spree_google_merchant_feed/products', formats: [:xml]
+        end
+        format.gzip do
+          gz_xml = ActiveSupport::Gzip.compress(render_to_string(template: 'spree_google_merchant_feed/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('google_merchant_feed').present?
+        render plain: 'Google Merchant Feed is not enabled for this store.', status: :not_found
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Integrations
+    class GoogleMerchantFeed < Spree::Integration
+      def self.integration_group
+        'marketing'
+      end
+
+      def self.icon_path
+        'integration_icons/google-merchant-center-logo.png'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<div class="col-12 col-md-6 p-0">
+  <div class="card mb-4">
+    <div class="card-body">
+      <p>
+        <%= Spree.t('admin.integrations.google_merchant_feed.description') %>
+      </p>
+    </div>
+  </div>
+</div>

data/app/views/{spree/google_merchant → spree_google_merchant_feed}/products.xml.builder

@@ -16,7 +16,7 @@ xml.rss version: "2.0", "xmlns:g" => "http://base.google.com/ns/1.0" do
           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)
+            xml.tag! "g:image_link", spree_image_url(product.default_image, width: 500, height: 500)
           end
 
           # Price and availability

data/config/initializers/spree.rb

@@ -0,0 +1,3 @@
+Rails.application.config.after_initialize do
+  Rails.application.config.spree.integrations << Spree::Integrations::GoogleMerchantFeed
+end

data/config/locales/el.yml

@@ -0,0 +1,8 @@
+---
+el:
+  spree:
+    admin:
+      integrations:
+        google_merchant_feed:
+          title: Google Merchant Feed
+          description: Το Google Merchant Feed είναι εργαλείο για καταχωρίσεις προϊόντων στο Google Merchant Center

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+---
+en:
+  spree:
+    admin:
+      integrations:
+        google_merchant_feed:
+          title: Google Merchant Feed
+          description: Google Merchant Feed is a channel integration for product listings on Google Merchant Center

data/config/routes.rb

@@ -1,4 +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'
+  get '/google_merchant/products', to: 'google_merchant_feed#products', defaults: { format: :xml }
+  get '/google_merchant/products.xml.gz', to: 'google_merchant_feed#products'
 end

data/lib/spree_google_merchant_feed/engine.rb

@@ -13,6 +13,14 @@ module SpreeGoogleMerchantFeed
       SpreeGoogleMerchantFeed::Config = SpreeGoogleMerchantFeed::Configuration.new
     end
 
+    initializer 'spree_google_merchant_feed.assets' do |app|
+      app.config.assets.precompile += %w[spree_google_merchant_feed_manifest]
+    end
+
+    initializer 'spree_google_merchant_feed.importmap', after: 'spree.admin.importmap' do |app|
+      app.config.spree_admin.importmap.draw(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)

data/lib/spree_google_merchant_feed/factories.rb

@@ -1,6 +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'
+  factory :google_merchant_feed_integration, class: Spree::Integrations::GoogleMerchantFeed do
+    active { true }
+    store { Spree::Store.default }
+  end
 end

data/lib/spree_google_merchant_feed/version.rb

@@ -1,5 +1,5 @@
 module SpreeGoogleMerchantFeed
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.1.2'.freeze
 
   def gem_version
     Gem::Version.new(VERSION)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_google_merchant_feed
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.2
 platform: ruby
 authors:
 - OlympusOne
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.1.8
 - !ruby/object:Gem::Dependency
   name: spree_storefront
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.1.8
 - !ruby/object:Gem::Dependency
   name: spree_admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.1.8
 - !ruby/object:Gem::Dependency
   name: spree_extension
   requirement: !ruby/object:Gem::Requirement
@@ -79,8 +79,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Adds the ability to provide products listings to Google Merchant Center
-  for Spree Commerce.
+description: Adds the ability to provide products listings to Google Merchant Center.
 email: info@olympusone.com
 executables: []
 extensions: []
@@ -89,10 +88,16 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- app/controllers/spree/google_merchant_controller.rb
-- app/views/spree/google_merchant/products.xml.builder
+- app/assets/config/spree_google_merchant_feed_manifest.js
+- app/assets/images/integration_icons/google-merchant-center-logo.png
+- app/controllers/spree/google_merchant_feed_controller.rb
+- app/models/spree/integrations/google_merchant_feed.rb
+- app/views/spree/admin/integrations/forms/_google_merchant_feed.html.erb
+- app/views/spree_google_merchant_feed/products.xml.builder
+- config/initializers/spree.rb
+- config/locales/el.yml
+- config/locales/en.yml
 - 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
@@ -100,13 +105,13 @@ files:
 - lib/spree_google_merchant_feed/version.rb
 homepage: https://github.com/olympusone/spree_google_merchant_feed
 licenses:
-- MIT
+- AGPL-3.0-or-later
 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.3
+  changelog_uri: https://github.com/olympusone/spree_google_merchant_feed/releases/tag/v1.1.2
   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.3
+  source_code_uri: https://github.com/olympusone/spree_google_merchant_feed/tree/v1.1.2
 rdoc_options: []
 require_paths:
 - lib

data/app/controllers/spree/google_merchant_controller.rb

@@ -1,16 +0,0 @@
-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/lib/generators/spree_google_merchant/install/install_generator.rb

@@ -1,20 +0,0 @@
-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