workarea-google_product_feed 3.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd02b4d78fddea69ede52bdb1f96282debd4d8f21c4c82c104c4af08b23325e3
+  data.tar.gz: 407d2275d33690d402795ff6ca127b3761ab63d5c7fc77a3f90c586e163602a2
+SHA512:
+  metadata.gz: fcd0ef976f661a4aa9386878c6117d28df6c279a43db090ebe2ea79e43d0a437c601b112d8c74f6b65daed9dbbb08cebc48950ac51cd86ea5bf596fe03e01bfd
+  data.tar.gz: 01671aef8ac70fe1cf0586e46cc1d46421d31d2936ad7e47949bdc5005e2c7d758e7ad2ed4cb513d740dcef595c31f847d53d000a69ff3607573fbfdfdb9f3fe

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle/
+Gemfile.lock
+.sass-cache/
+.DS_Store
+log/*.log
+pkg/
+tmp/
+test/dummy/public/system/*
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+coverage
+.byebug_history

data/CHANGELOG.md

@@ -0,0 +1,99 @@
+Workarea Google Product Feed 3.1.3 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Google Product Feed 3.1.2 (2019-06-25)
+--------------------------------------------------------------------------------
+
+*   Update image urls in google product feed
+
+    * change image size to be :detail so the images are larger than 250
+    (googles requirement for apparel products)
+    * fix problems with tests failing with multi-site
+
+    GOOGPROD-22
+    Eric Pigeon
+
+
+
+Workarea Google Product Feed 3.1.1 (2018-09-19)
+--------------------------------------------------------------------------------
+
+*   Fix config values not being reset in tests
+
+    Tests can fail because values aren't reset properly.
+
+    GOOGPROD-20
+    Ben Crouse
+
+
+
+Google Product Feed 3.1.0 (2018-03-21)
+--------------------------------------------------------------------------------
+
+*   Add a configuration for static values in google merchant feed
+
+    GOOGPROD-16
+    Eric Pigeon
+
+*   Use a product's default category first
+
+    update the google taxonomy to prefer using it's default category first
+
+    GOOGPROD-18
+    Eric Pigeon
+
+
+Google Product Feed 3.0.2 (2018-01-11)
+--------------------------------------------------------------------------------
+
+*   Product feed does not include inactive products
+
+    GOOGPROD-10
+    Jake Beresford
+
+*   Improve implementation of Google category field
+
+    * check product, then category, then fall back to a configuration
+
+    GOOGPROD-11
+    Jake Beresford
+
+*   Do not export non-displayable skus to google feed
+
+    GOOGPROD-10
+    Jake Beresford
+
+
+Google Product Feed 3.0.0 (2017-05-25)
+--------------------------------------------------------------------------------
+
+*   Fixes final test.
+
+    GOOGPROD-7
+    Beresford, Jake
+
+*   Upgrade plugin for v3 compatibility
+
+    * Rename
+    * Convert rspec to minitest
+    * Use Variant#active? instead of Variant#purchasable?
+
+    GOOGPROD-7
+    Beresford, Jake
+
+
+Google Product Feed 2.0.5 (2016-12-07)
+--------------------------------------------------------------------------------
+
+*   Send the correct price for a variant
+
+    If a product has different pricers per variant we should use the correct
+    sell price for the sku rather than the minimal selling price of the
+    product
+
+    GOOGPROD-6
+    Eric Pigeon

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'workarea', source: 'https://gems.weblinc.com'
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'simplecov-bamboo', require: false
+end

data/README.md

@@ -0,0 +1,61 @@
+Workarea Google Production Feed
+================================================================================
+Google Production Feed for the Workarea Platform
+
+
+Google category
+--------------------------------------------------------------------------------
+The google product feed includes a field for google category. This field must map to one of the pre-defined categories.
+Documentation can be found here [https://support.google.com/merchants/answer/6324436?hl=en](https://support.google.com/merchants/answer/6324436?hl=en)
+
+The workarea platform implements this field by:
+1) Look for google\_category on the product, use this if found.
+2) Look for google\_name on the products default category
+3) Look for google\_name on categories the product is in, use this if found
+4) Use the default google category from Workarea::GoogleProductFeed.default\_category
+
+Getting Started
+--------------------------------------------------------------------------------
+
+You must have access to a WebLinc gems server to use this gem. Add your gems server credentials to Bundler:
+
+```bash
+$ bundle config gems.weblinc.com my_username:my_password
+```
+
+Or set the appropriate environment variable in a shell startup file:
+
+```bash
+$ export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
+```
+
+Then add the gem to your application's Gemfile specifying the source:
+
+```ruby
+# ...
+gem 'workarea-google_product_feed', source: 'https://gems.weblinc.com'
+# ...
+```
+
+Or use a source block:
+
+```ruby
+# ...
+source 'https://gems.weblinc.com' do
+  gem 'workarea-google_product_feed'
+end
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+$ cd path/to/application ; bundle
+```
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+
+Copyright WebLinc 2018. All rights reserved.
+
+For licensing, contact sales@workarea.com.

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tasker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/google_product_feed/version'
+
+desc "Release version #{Workarea::GoogleProductFeed::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::GoogleProductFeed::VERSION} -m 'Tagging #{Workarea::GoogleProductFeed::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-google_product_feed.gemspec'
+  system "gem push workarea-google_product_feed-#{Workarea::GoogleProductFeed::VERSION}.gem"
+  system "gem push workarea-google_product_feed-#{Workarea::GoogleProductFeed::VERSION}.gem --host #{host}"
+  system "rm workarea-google_product_feed-#{Workarea::GoogleProductFeed::VERSION}.gem"
+end

data/app/models/workarea/catalog/category.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Catalog::Category, with: :google_product_feed do
+    decorated do
+      field :google_name, type: String
+    end
+  end
+end

data/app/models/workarea/catalog/product.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Catalog::Product, with: :google_product_feed do
+    decorated do
+      field :google_category, type: String
+    end
+  end
+end

data/app/models/workarea/feed/google.rb

@@ -0,0 +1,16 @@
+module Workarea
+  class Feed::Google
+    class NoFeedError < StandardError; end
+
+    include ApplicationDocument
+    extend Dragonfly::Model
+
+    field :feed_uid, type: String
+
+    dragonfly_accessor :feed, app: :workarea
+
+    def self.find_first_or_initialize
+      first || new
+    end
+  end
+end

data/app/view_models/workarea/storefront/google_product_feed_sku_view_model.rb

@@ -0,0 +1,26 @@
+module Workarea
+  module Storefront
+    class GoogleProductFeedSkuViewModel < ApplicationViewModel
+      def status
+        model.active? ? 'in stock' : 'out of stock'
+      end
+
+      def color
+        Array.wrap(model.fetch_detail('color')).first
+      end
+
+      def condition
+        'new'
+      end
+
+      def size
+        Array.wrap(model.fetch_detail('size')).first
+      end
+
+      def displayable?
+        return false unless options[:inventory_sku].present?
+        options[:inventory_sku].displayable?
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/google_product_feed_view_model.rb

@@ -0,0 +1,125 @@
+module Workarea
+  module Storefront
+    class GoogleProductFeedViewModel < ApplicationViewModel
+      module ProductImageUrl
+        include Workarea::ApplicationHelper
+        include Workarea::I18n::DefaultUrlOptions
+        include ActionView::Helpers::AssetUrlHelper
+        include Core::Engine.routes.url_helpers
+        extend self
+
+        def mounted_core
+          self
+        end
+      end
+      include ActionView::Helpers::SanitizeHelper
+      include ActionView::Helpers::TextHelper
+
+      def self.fields
+        [
+          'item_group_id',
+          'id',
+          'title',
+          'description',
+          'link',
+          'image_link',
+          'availability',
+          'condition',
+          'brand',
+          'color',
+          'size',
+          'google_product_category',
+          'product_type',
+          'price'
+        ] + GoogleProductFeed.static_feed_values.keys
+      end
+
+      delegate :sell_min_price, to: :pricing
+
+      def brand
+        return '' unless model.filters['brand'].present?
+        model.filters['brand'].join(' ')
+      end
+
+      def category_name
+        model.google_category.presence ||
+        category&.google_name.presence ||
+        Workarea::GoogleProductFeed.default_category
+      end
+
+      # TODO this should be changed to return sku images if present
+      def image
+        ProductImageUrl.product_image_url(images.primary, GoogleProductFeed.image_size)
+      end
+
+      def meta_description
+        if model.meta_description.present?
+          sanitize_description(model.meta_description)
+        else
+          sanitize_description(model.description)
+        end
+      end
+
+      def product_type
+        return '' unless model.filters['product_type'].present?
+        model.filters['product_type'].first
+      end
+
+      def variants
+        @variants ||= model.variants.map do |variant|
+          GoogleProductFeedSkuViewModel.wrap(
+            variant,
+            inventory_sku: inventory.for_sku(variant.sku)
+          )
+        end
+      end
+
+      def sku_price(sku)
+        pricing.for_sku(sku).sell
+      end
+
+      private
+
+        def category
+          return categorization.default_model if categorization.default_model&.google_name.present?
+
+          categorization.to_models.detect { |c| c.google_name.present? } ||
+            categorization.to_models.first
+        end
+
+        def categorization
+          @categorization ||= Workarea::Categorization.new(model)
+        end
+
+        def host
+          Workarea.config.host
+        end
+
+        def images
+          @images ||= Storefront::ProductViewModel::ImageCollection.new(model, options)
+        end
+
+        def inventory
+          @inventory ||= Inventory::Collection.new(model.variants.map(&:sku))
+        end
+
+        def pricing
+          @pricing ||= Pricing::Collection.new(model.variants.map(&:sku))
+        end
+
+        def primary_image
+          model.images.asc(:position).first
+        end
+
+        def sanitize_description(description)
+          return if description.nil?
+
+          # strip html and shorten to the google max of 5k chars
+          sanitized = truncate(strip_tags(description), length: 5000)
+
+          # strip tabs and new lines
+          sanitized.tr("\t\r\n", '')
+        end
+    end
+  end
+end

data/app/workers/workarea/exporting/google_feed.rb

@@ -0,0 +1,90 @@
+module Workarea
+  module Exporting
+    class GoogleFeed
+      include Sidekiq::Worker
+      include I18n::DefaultUrlOptions
+      include Storefront::Engine.routes.url_helpers
+
+      cattr_accessor :execution_block_size, :temp_file
+      self.execution_block_size = 100
+      self.temp_file = 'tmp/export/google_feed.txt'
+
+      sidekiq_options queue: 'low'
+
+      def perform(*args)
+        generate_csv
+        save_google_feed
+      end
+
+      def generate_csv
+        ensure_directory
+
+        @feed = CSV.open(GoogleFeed.temp_file, 'w', col_sep: "\t")
+        write_header
+        write_google_feed
+
+      ensure
+        @feed.close if defined?(@feed)
+      end
+
+      private
+
+        def ensure_directory
+          directory = File.dirname(GoogleFeed.temp_file)
+          FileUtils.mkdir_p(directory)
+        end
+
+        def write_header
+          @feed << Storefront::GoogleProductFeedViewModel.fields
+        end
+
+        def write_google_feed
+          Catalog::Product.all.each_by(GoogleFeed.execution_block_size) do |p|
+            product = Storefront::GoogleProductFeedViewModel.wrap(p)
+
+            product.variants.each do |sku|
+              next unless item_valid(product, sku)
+              @feed << values_array(product, sku)
+            end
+          end
+        end
+
+        def save_google_feed
+          google_feed = Feed::Google.find_first_or_initialize
+          google_feed.feed = @feed
+          google_feed.save!
+        end
+
+        def host
+          Workarea.config.host
+        end
+
+        def item_valid(product, sku)
+          sku.active? &&
+            sku.displayable? &&
+            product.active? &&
+            product.sku_price(sku.sku).present? &&
+            product.sku_price(sku.sku) > 0
+        end
+
+        def values_array(product, sku)
+          [
+            product.id,
+            sku.sku,
+            product.name,
+            product.meta_description,
+            product_url(product, host: host, sku: sku.sku),
+            product.image,
+            sku.status,
+            sku.condition,
+            product.brand,
+            sku.color,
+            sku.size,
+            product.category_name,
+            product.product_type,
+            product.sku_price(sku.sku)
+          ] + GoogleProductFeed.static_feed_values.values
+        end
+    end
+  end
+end