solidus_feeds 0.1.0

data/lib/solidus_feeds/publishers/s3.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+module SolidusFeeds
+  module Publishers
+    class S3
+      attr_reader :object_key, :bucket, :resource
+
+      NoContentError = Class.new(StandardError)
+
+      def initialize(object_key:, bucket:, client: Aws::S3::Client.new)
+        @object_key = object_key
+        @bucket = bucket
+        @resource = Aws::S3::Resource.new(client: client)
+      end
+
+      def call
+        Tempfile.create(object_key) do |io|
+          yield io
+          io.rewind
+          raise NoContentError, "no content was generated" if io.eof?
+
+          object = resource.bucket(bucket).object(object_key)
+          object.put(body: io, acl: 'public-read')
+        end
+      end
+    end
+  end
+end

data/lib/solidus_feeds/publishers/static_file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusFeeds
+  module Publishers
+    class StaticFile
+      attr_reader :path
+
+      def initialize(path:)
+        @path = path
+      end
+
+      def call(&block)
+        File.open(path, 'w', &block)
+      end
+    end
+  end
+end

data/lib/solidus_feeds/testing_support/factories.rb

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

data/lib/solidus_feeds/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusFeeds
+  VERSION = '0.1.0'
+end

data/solidus_feeds.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_feeds/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_feeds'
+  spec.version = SolidusFeeds::VERSION
+  spec.authors = ['Elia Schito', 'Nicolò Rebughini']
+  spec.email = 'contact@solidus.io'
+
+  spec.summary = 'A framework for producing and publishing feeds on Solidus.'
+  spec.homepage = 'https://github.com/solidusio-contrib/solidus_feeds#readme'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_feeds'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_feeds/releases'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'aws-sdk-s3', '~> 1.83'
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+
+  spec.add_development_dependency 'solidus_dev_support', '~> 2.3'
+end

data/spec/lib/solidus_feeds/generators/google_merchant_spec.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'stringio'
+
+RSpec.describe SolidusFeeds::Generators::GoogleMerchant do
+  subject(:generator) { described_class.new(products, host: 'https://example.com') }
+
+  let(:products) do
+    Spree::Product.where(id: [
+      create(:product, id: 123, slug: 'pro1', name: 'A product', price: 123.45, description: 'product description', sku: 'PRD1'), # rubocop:disable Layout/LineLength
+      create(:product, id: 456, slug: 'pro2', name: 'Another product', price: 678.90, description: 'another product description', sku: 'PRD2'), # rubocop:disable Layout/LineLength
+    ]).order(:id)
+  end
+  let(:product) { products.first }
+  let(:store) { instance_double(Spree::Store, name: "The Best Store", url: "example.com") }
+
+  before { allow(Spree::Store).to receive(:default).and_return(store) }
+
+  before(:each, with_images: true) do
+    allow(ActionController::Base).to receive(:asset_host).and_return('https://assets.example.com')
+    Spree::Image.create! viewable: products.first.master, attachment_file_name: 'foo.png', id: 234
+  end
+
+  describe '#call', :with_images do
+    describe 'generated XML' do
+      def expect_xml_content(xpath)
+        expect(xml.xpath(xpath, 'g' => "http://base.google.com/ns/1.0").text)
+      end
+
+      let(:xml) do
+        io = StringIO.new
+        generator.call(io)
+        Nokogiri::XML(io.string)
+      end
+
+      it 'includes the tags with the expected values' do
+        aggregate_failures do
+          expect_xml_content('//channel/title').to eq('The Best Store')
+          expect_xml_content('//channel/link').to eq('https://example.com')
+          expect_xml_content('//channel/description').to eq('Find out about new products on https://example.com first!')
+          expect_xml_content('//channel/language').to eq('en-us')
+          expect_xml_content('//channel/item[1]/g:id').to eq('123')
+          expect_xml_content('//channel/item[1]/g:title').to eq('A product')
+          expect_xml_content('//channel/item[1]/g:description').to eq('product description')
+          expect_xml_content('//channel/item[1]/g:link').to eq('https://example.com/products/pro1')
+          expect_xml_content('//channel/item[1]/g:image_link').to eq("https://assets.example.com/spree/products/234/large/foo.png") # rubocop:disable Layout/LineLength
+          expect_xml_content('//channel/item[1]/g:condition').to eq('new')
+          expect_xml_content('//channel/item[1]/g:price').to eq('123.45 USD')
+          expect_xml_content('//channel/item[1]/g:availability').to eq('out of stock')
+          expect_xml_content('//channel/item[1]/g:brand').to eq('The Best Store')
+          expect_xml_content('//channel/item[1]/g:mpn').to eq('PRD1')
+          expect_xml_content('//channel/item[1]/g:google_product_category').to eq('')
+        end
+      end
+    end
+  end
+
+  specify '#id' do
+    product = instance_double(Spree::Product, id: 789)
+
+    expect(generator.id(product)).to eq(789)
+  end
+
+  specify '#title' do
+    product = instance_double(Spree::Product, name: "Foo Bar")
+
+    expect(generator.title(product)).to eq("Foo Bar")
+  end
+
+  specify '#description' do
+    product = instance_double(Spree::Product, description: "Foo Bar")
+
+    expect(generator.description(product)).to eq("Foo Bar")
+  end
+
+  specify '#link' do
+    product = instance_double(Spree::Product, to_param: "123-my-product")
+
+    expect(generator.link(product)).to eq("https://example.com/products/123-my-product")
+  end
+
+  specify '#image_link', :with_images do
+    expect(generator.image_link(products.first)).to eq("https://assets.example.com/spree/products/234/large/foo.png")
+    expect(generator.image_link(products.second)).to eq(nil)
+  end
+
+  specify '#condition' do
+    products.first.set_property("condition", "foo-bar")
+
+    expect(generator.condition(product)).to eq("foo-bar")
+  end
+
+  specify '#price' do
+    product = instance_double(Spree::Product, price: 321.45);
+
+    expect(generator.price(product)).to eq("321.45 USD")
+  end
+
+  describe '#availability' do
+    it 'is "in stock" when available' do
+      allow(product.master).to receive(:in_stock?).and_return(true)
+
+      expect(generator.availability(product)).to eq("in stock")
+    end
+
+    it 'is "out of stock" when unavailable' do
+      allow(product.master).to receive(:in_stock?).and_return(false)
+
+      expect(generator.availability(product)).to eq("out of stock")
+    end
+  end
+
+  specify '#brand' do
+    product.set_property("brand", "foo-bar")
+
+    expect(generator.brand(product)).to eq("foo-bar")
+    expect(generator.brand(products.second)).to eq("The Best Store")
+  end
+
+  specify '#mpn' do
+    allow(product.master).to receive(:sku).and_return("FOOO_123_SKU")
+
+    expect(generator.mpn(product)).to eq("FOOO_123_SKU")
+  end
+
+  specify '#google_product_category_id' do
+    product.set_property("google_product_category_id", "123456")
+
+    expect(generator.google_product_category_id(product)).to eq("123456")
+  end
+end

data/spec/lib/solidus_feeds/publishers/s3_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+RSpec.describe SolidusFeeds::Publishers::S3 do
+  let(:io) { StringIO.new }
+  let(:client) { Aws::S3::Client.new(stub_responses: true) }
+  let(:generator) {
+    ->(io) {
+      csv = CSV.new(io)
+      csv << ["some", "data"]
+      csv << ["another", "line"]
+    }
+  }
+
+  describe '#call' do
+    it 'correctly uploads the generated content to S3' do
+      s3_publisher = described_class.new(object_key: 'my_feed.xml', bucket: 'dummy_bucket', client: client)
+
+      response = s3_publisher.call do |io|
+        generator.call(io)
+      end
+
+      expect(response).to be_instance_of(Aws::S3::Types::PutObjectOutput)
+    end
+
+    it 'raises an error if the generator does not generate anything' do
+      s3_publisher = described_class.new(object_key: 'my_feed.xml', bucket: 'dummy_bucket', client: client)
+
+      expect {
+        s3_publisher.call do |io|
+          io << ""
+        end
+      }.to raise_error SolidusFeeds::Publishers::S3::NoContentError
+    end
+  end
+end

data/spec/lib/solidus_feeds/publishers/static_file_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+RSpec.describe SolidusFeeds::Publishers::StaticFile do
+  let(:filename) { 'my_feed.csv' }
+  let(:io) { StringIO.new }
+  let(:generator) {
+    ->(io) {
+      csv = CSV.new(io)
+      csv << ["some", "data"]
+      csv << ["another", "line"]
+    }
+  }
+
+  describe '#call' do
+    it 'saves the generated content to the specified file' do
+      buffer = StringIO.new
+      allow(File).to receive(:open).with(filename, 'w').and_yield(buffer)
+      static_file_publisher = described_class.new(path: filename)
+
+      static_file_publisher.call do |io|
+        generator.call(io)
+      end
+
+      expect(buffer.string).to eq(
+        "some,data\nanother,line\n"
+      )
+    end
+  end
+end

data/spec/lib/solidus_feeds/solidus_feeds_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+RSpec.describe SolidusFeeds do
+  let(:store) { instance_double(Spree::Store, name: "The Best Store", url: "example.com") }
+
+  before { allow(Spree::Store).to receive(:default).and_return(store) }
+
+  specify '.title' do
+    expect(described_class.title).to eq("The Best Store")
+  end
+
+  specify '.link' do
+    expect(described_class.link).to eq("https://example.com")
+  end
+
+  specify '.description' do
+    expect(described_class.description).to eq("Find out about new products on https://example.com first!")
+  end
+
+  specify '.language' do
+    expect(described_class.language).to eq("en-us")
+  end
+end

data/spec/solidus_feeds_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'stringio'
+require 'csv'
+
+RSpec.describe SolidusFeeds do
+  before { described_class.reset_config! }
+
+  let(:io) { StringIO.new }
+  let(:string_io_publisher) { ->(&block) { block.call(io) } }
+  let(:csv_generator) {
+    ->(io) {
+      csv = CSV.new(io)
+      csv << ["some", "data"]
+      csv << ["another", "line"]
+    }
+  }
+
+  it 'allows to register, generate, and publish feeds' do
+    described_class.configure do |config|
+      config.register :foo do |feed|
+        feed.publisher = string_io_publisher
+        feed.generator = csv_generator
+      end
+    end
+
+    described_class.config.find(:foo).publish
+    expect(io.string).to eq("some,data\nanother,line\n")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+# Create the dummy app if it's still missing.
+dummy_env = "#{__dir__}/dummy/config/environment.rb"
+system 'bin/rake extension:test_app' unless File.exist? dummy_env
+require dummy_env
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/feature_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{__dir__}/support/**/*.rb"].sort.each { |f| require f }
+
+# Requires factories defined in lib/solidus_feeds/testing_support/factories.rb
+SolidusDevSupport::TestingSupport::Factories.load_for(SolidusFeeds::Engine)
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+
+  if Spree.solidus_gem_version < Gem::Version.new('2.11')
+    config.extend Spree::TestingSupport::AuthorizationHelpers::Request, type: :system
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: solidus_feeds
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elia Schito
+- Nicolò Rebughini
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.83'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.83'
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: solidus_dev_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description:
+email: contact@solidus.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gem_release.yml"
+- ".github/stale.yml"
+- ".github_changelog_generator"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/solidus_feeds.js
+- app/assets/javascripts/spree/frontend/solidus_feeds.js
+- app/assets/stylesheets/spree/backend/solidus_feeds.css
+- app/assets/stylesheets/spree/frontend/solidus_feeds.css
+- bin/console
+- bin/rails
+- bin/rails-engine
+- bin/rails-sandbox
+- bin/rake
+- bin/sandbox
+- bin/setup
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/solidus_feeds/install/install_generator.rb
+- lib/generators/solidus_feeds/install/templates/initializer.rb
+- lib/solidus_feeds.rb
+- lib/solidus_feeds/configuration.rb
+- lib/solidus_feeds/engine.rb
+- lib/solidus_feeds/factories.rb
+- lib/solidus_feeds/feed.rb
+- lib/solidus_feeds/generators/google_merchant.rb
+- lib/solidus_feeds/publishers/s3.rb
+- lib/solidus_feeds/publishers/static_file.rb
+- lib/solidus_feeds/testing_support/factories.rb
+- lib/solidus_feeds/version.rb
+- solidus_feeds.gemspec
+- spec/lib/solidus_feeds/generators/google_merchant_spec.rb
+- spec/lib/solidus_feeds/publishers/s3_spec.rb
+- spec/lib/solidus_feeds/publishers/static_file_spec.rb
+- spec/lib/solidus_feeds/solidus_feeds_spec.rb
+- spec/solidus_feeds_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/solidusio-contrib/solidus_feeds#readme
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/solidusio-contrib/solidus_feeds#readme
+  source_code_uri: https://github.com/solidusio-contrib/solidus_feeds
+  changelog_uri: https://github.com/solidusio-contrib/solidus_feeds/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: A framework for producing and publishing feeds on Solidus.
+test_files:
+- spec/lib/solidus_feeds/generators/google_merchant_spec.rb
+- spec/lib/solidus_feeds/publishers/s3_spec.rb
+- spec/lib/solidus_feeds/publishers/static_file_spec.rb
+- spec/lib/solidus_feeds/solidus_feeds_spec.rb
+- spec/solidus_feeds_spec.rb
+- spec/spec_helper.rb