solidus_feeds 0.1.0

data/app/assets/stylesheets/spree/frontend/solidus_feeds.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_feeds"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_feeds/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_feeds"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=false \
+  --payment-method=none \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+unbundled bundle exec rails generate ${extension_name}:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusFeeds
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/solidus_feeds.rb'
+      end
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_feeds\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_feeds\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_feeds\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_feeds\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
+      end
+
+      def add_migrations
+        run 'bin/rails railties:install:migrations FROM=solidus_feeds'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Layout/LineLength
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end

data/lib/generators/solidus_feeds/install/templates/initializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+SolidusFeeds.configure do |config|
+  # The store name appearing on the feeds
+  # config.title = 'My store name'
+  #
+  # The URL appearing on the feeds
+  # config.link = 'https://example.com'
+  #
+  # The description appearing on the feeds
+  # config.description = 'Find out about new products on https://example.com'
+  #
+  # The language of the feeds
+  # config.language = 'en-us'
+end

data/lib/solidus_feeds.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+require 'solidus_feeds/configuration'
+require 'solidus_feeds/version'
+require 'solidus_feeds/engine'
+
+require 'solidus_feeds/publishers/s3'
+require 'solidus_feeds/publishers/static_file'
+
+require 'solidus_feeds/generators/google_merchant'

data/lib/solidus_feeds/configuration.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'solidus_feeds/feed'
+
+module SolidusFeeds
+  class Configuration
+    # Define here the settings for this extensions, e.g.:
+    #
+    # attr_accessor :my_setting
+
+    def register(name, &builder)
+      feeds[name.to_sym] = Feed.new(&builder)
+    end
+
+    def find(name)
+      feeds.fetch(name)
+    end
+
+    private
+
+    def feeds
+      @feeds ||= {}
+    end
+  end
+
+  class << self
+    attr_writer :title, :link, :description, :language
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias config configuration
+
+    def reset_config!
+      @configuration
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def title
+      @title ||= ::Spree::Store.default.name
+    end
+
+    def link
+      @link ||= "https://#{::Spree::Store.default.url}"
+    end
+
+    def description
+      @description ||= "Find out about new products on https://#{::Spree::Store.default.url} first!"
+    end
+
+    def language
+      @language ||= 'en-us'
+    end
+  end
+end

data/lib/solidus_feeds/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+require 'solidus_feeds'
+
+module SolidusFeeds
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_feeds'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/solidus_feeds/factories.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+end

data/lib/solidus_feeds/feed.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SolidusFeeds
+  class Feed
+    attr_accessor :generator, :publisher
+
+    def initialize
+      yield(self) if block_given?
+    end
+
+    def generate(output)
+      generator.call(output)
+    end
+
+    def publish
+      publisher.call do |output|
+        generate(output)
+      end
+    end
+  end
+end

data/lib/solidus_feeds/generators/google_merchant.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'builder'
+
+module SolidusFeeds
+  module Generators
+    # The GoogleMerchant XML feed as described in https://support.google.com/merchants/answer/7052112.
+    class GoogleMerchant
+      attr_accessor :products, :host
+
+      def initialize(products, host:)
+        self.products = products
+        self.host = host
+      end
+
+      def call(io)
+        builder = Builder::XmlMarkup.new(target: io, indent: 0)
+        render_template(builder)
+      end
+
+      def render_template(xml)
+        xml.rss version: "2.0", "xmlns:g" => "http://base.google.com/ns/1.0" do
+          xml.channel do
+            xml.title SolidusFeeds.title
+            xml.link SolidusFeeds.link
+            xml.description SolidusFeeds.description
+            xml.language SolidusFeeds.language
+            products.find_each do |product|
+              xml.item do
+                xml.tag! 'g:id', id(product)
+                xml.tag! 'g:title', title(product)
+                xml.tag! 'g:description', description(product)
+                xml.tag! 'g:link', link(product)
+                xml.tag! 'g:image_link', image_link(product)
+                xml.tag! 'g:condition', condition(product)
+                xml.tag! 'g:price', price(product)
+                xml.tag! 'g:availability', availability(product)
+                xml.tag! 'g:brand', brand(product)
+                xml.tag! 'g:mpn', mpn(product)
+                xml.tag! 'g:google_product_category', google_product_category_id(product)
+              end
+            end
+          end
+        end
+      end
+
+      def id(product)
+        product.id
+      end
+
+      def title(product)
+        product.name
+      end
+
+      def description(product)
+        product.description
+      end
+
+      def link(product)
+        spree_routes.product_url(product, host: host)
+      end
+
+      def image_link(product)
+        return unless product.images.any?
+
+        attachment_url = product.images.first.attachment.url(:large)
+        asset_host = ActionController::Base.asset_host || host
+
+        URI.join(asset_host, attachment_url).to_s
+      end
+
+      # Must be "new", "refurbished", or "used".
+      def condition(product)
+        product.property("condition") || "new"
+      end
+
+      def price(product)
+        ::Spree::Money.new(product.price).money.format(symbol: false, with_currency: true)
+      end
+
+      # Must be "in stock", "preorder" or "out of stock"
+      def availability(product)
+        product.master.in_stock? ? 'in stock' : 'out of stock'
+      end
+
+      def brand(product)
+        product.property("brand") || SolidusFeeds.title
+      end
+
+      def mpn(product)
+        product.master.sku
+      end
+
+      def google_product_category_id(product)
+        # Must be selected from https://support.google.com/merchants/answer/1705911
+        product.property("google_product_category_id")
+      end
+
+      private
+
+      def spree_routes
+        @spree_routes ||= ::Spree::Core::Engine.routes.url_helpers
+      end
+    end
+  end
+end