solidus_feeds 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58531c73946da9c28461e17502503cf2b5a4705c6a616f08c9c113013c98a5a0
+  data.tar.gz: 57e0b6b0f02d1a6b9da731c6a6c4f248fc4804ab26e810324849a7691a7deab2
+SHA512:
+  metadata.gz: b57c1b93cfb53bd1d188028e101cb92355a3b5920becb8758374c511141f2eb91858a0277d00953537aa0537e3168670ed7989854e44590f46daae333f547645
+  data.tar.gz: aca21bcca2411cd27ae410ca6e13ea9a7848ad428a9d6168b59da33c2dfe94579fe376eca2046a395cdac3ee970c31ab67f513dadb922146dfbdf6e71c29fe8b

data/.circleci/config.yml

@@ -0,0 +1,41 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+  lint-code:
+    executor: solidusio_extensions/sqlite-memory
+    steps:
+      - solidusio_extensions/lint-code
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+      - lint-code
+
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_feeds/version.rb'
+  message: Bump SolidusFeeds to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: false
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It might be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.github_changelog_generator

@@ -0,0 +1,2 @@
+issues=false
+exclude-labels=infrastructure

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require:
+  - solidus_dev_support/rubocop
+
+AllCops:
+  NewCops: disable
+
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2021 Nebulab SRLs
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,246 @@
+# Solidus Feeds
+
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_feeds.svg?style=shield)](https://circleci.com/gh/solidusio-contrib/solidus_feeds)
+[![codecov](https://codecov.io/gh/solidusio-contrib/solidus_feeds/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio-contrib/solidus_feeds)
+
+<!-- Explain what your extension does. -->
+A framework for producing and publishing feeds on Solidus.
+
+## Installation
+
+Add solidus_feeds to your Gemfile:
+
+```ruby
+gem 'solidus_feeds'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bin/rails generate solidus_feeds:install
+```
+
+## Out of the box usage
+
+<!-- Explain how to use your extension once it's been installed. -->
+
+Let's say that you want to generate a XML feed for products belonging to the `Shoes` taxon,
+consumable by Google Merchant compatible marketplaces  and make it publicly available on your
+`my-bucket` S3 bucket at the path `foo/bar.xml`.
+
+To register the feed you'd need to add the following code to an initializer such as
+`config/initializers/solidus.rb` or better yet `config/initializers/solidus_feeds.rb`
+
+```ruby
+SolidusFeeds.config.register :google_merchant_shoes do |feed|
+  taxon = Spree::Taxon.find_by(name: "Shoes")
+  products = Spree::Product.available.in_taxon(taxon)
+
+  feed.generator = SolidusFeeds::Generators::GoogleMerchant.new(products)
+  feed.publisher = SolidusFeeds::Publishers::S3.new(bucket: "my-bucket", object_key: "foo/bar.xml")
+end
+```
+
+Then make your Solidus app generate and publish the feed by calling the following line. It's
+recommended to call it in a background job, especially when generating feeds with large amounts of
+products.
+
+```ruby
+SolidusFeeds.find(:google_merchant_shoes).publish
+```
+
+Having it in a background job makes it easier to:
+
+- Launch it manually from the backend dashboard
+- Make it refresh periodically via cron, sidekiq-scheduler, Heroku scheduler or similar
+- Refresh the feed when receiving data from a [webhook](https://github.com/solidusio-contrib/solidus_webhooks)
+  or after specific Solidus events
+
+## Serving the feed from the products controller (legacy)
+
+We suggest to avoid this behaviour because it could be resource intensive, especially with a large
+number of products.
+
+If you want to support the legacy behaviour of [`solidus_product_feed`](https://github.com/solidusio-contrib/solidus_product_feed)
+and publish a XML feed at `/products.rss`, you can add the following decorator:
+
+```ruby
+# app/decorators/controllers/solidus_feeds/spree/products_controller.rb
+
+module SolidusFeeds
+  module Spree
+    module ProductsControllerDecorator
+      def self.prepended(klass)
+        klass.respond_to :rss, only: :index
+        klass.before_action :verify_requested_format!, only: :index
+      end
+
+      def index
+        render as: :xml, body: load_feed_products if request.format.rss?
+        super
+      end
+
+      private
+
+      def load_feed_products
+        @products = ::Spree::Product.all
+        io = StringIO.new
+        SolidusFeeds::Generators::GoogleMerchant
+          .new(@products, host: 'https://example.com')
+          .call(io)
+        io.rewind
+        io.read
+      end
+
+      ::Spree::ProductsController.prepend self
+    end
+  end
+end
+```
+
+## Publishing backends
+
+### S3
+
+If you don't want to configure a S3 `client` each time, you can load your AWS config in an
+initializer:
+
+```ruby
+# config/initializers/aws.rb
+
+Aws.config[:profile] = 'my-profile'
+```
+
+Then config your S3 publisher specifying the `bucket`, `object_key` and an optional `client` if you
+need custom configuration on a per-publisher basis.
+
+```ruby
+# config/initializers/solidus_feeds.rb
+
+SolidusFeeds.config.register :all_products do |feed|
+  feed.generator = SolidusFeeds::Generators::GoogleMerchant.new(Spree::Product.all)
+  feed.publisher = SolidusFeeds::Publishers::S3.new(
+    bucket: "foo",
+    object_key: "bar/my_feed.xml",
+    client: Aws::S3::Client.new(…), # This is optional - use only if a custom config is needed
+  )
+
+  # visit https://s3.us-east-1.amazonaws.com/foo/bar/my_feed.xml
+end
+```
+
+### Static file
+
+To publish the feed directly from an app directory (e.g. the `public` directory), you can use the
+Static File Publisher as such:
+
+```ruby
+# config/initializers/solidus_feeds.rb
+
+SolidusFeeds.config.register :all_products do |feed|
+  feed.generator = SolidusFeeds::Generators::GoogleMerchant.new(Spree::Product.all)
+  feed.publisher = SolidusFeeds::Publishers::StaticFile.new(
+    path: Rails.root.join('public/products.xml')
+  )
+end
+```
+
+## Builtin Marketplace format generators
+
+- Google Merchant XML: compatible with Google Merchant and Facebook/Instagram feeds
+
+## Creating your own Generators and Publishers
+
+Both the generator and the publisher are expected to respond to `#call`.
+
+The publisher's `#call` method is expected to yield an IO-like object that responds to `#<<`.
+
+### Example
+
+For example a simple feed that will publish recently added products to Rails' public folder in JSON
+format would look like this:
+
+```ruby
+class FilePublisher < Struct.new(:path)
+  def call
+    File.open(path, 'w') do |file|
+      yield file
+    end
+  end
+end
+
+class JsonProductFeed < Struct.new(:products)
+  def call(io)
+    products.find_each do |product|
+      io << product.to_json
+    end
+  end
+end
+
+SolidusFeeds.register :recent_products do |feed|
+  recent_products = Spree::Product.where(created_at: Time.now..2.weeks.ago)
+
+  feed.generator = JsonProductFeed.new(recent_products)
+  feed.publisher = FilePublisher.new(Rails.root.join("public/product.json")
+end
+```
+
+## Development
+
+### Testing the extension
+
+First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
+app if it does not exist, then it will run specs. The dummy app can be regenerated by using
+`bin/rake extension:test_app`.
+
+```shell
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+bundle exec rubocop
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_feeds/factories'
+```
+
+### Running the sandbox
+
+To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
+the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
+`sandbox/bin/rails`.
+
+Here's an example:
+
+```
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+### Updating the changelog
+
+Before and after releases the changelog should be updated to reflect the up-to-date status of
+the project:
+
+```shell
+bin/rake changelog
+git add CHANGELOG.md
+git commit -m "Update the changelog"
+```
+
+### Releasing new versions
+
+Please refer to the dedicated [page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) on Solidus wiki.
+
+## License
+
+Copyright (c) 2021 Nebulab SRLs, released under the New BSD License.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'

data/app/assets/javascripts/spree/backend/solidus_feeds.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/solidus_feeds.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/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/backend/all.css'
+*/