jekyll-spree-client 0.1.9 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 345d7f0e45d1c821288d7a4452601c163f2d82304d317dc72ec425d6abd5cb47
-  data.tar.gz: b74a132ff5c5592c2989bff62b2403e9a6cb10eacf4af715b5ee287c404f19a6
+  metadata.gz: 231ce6a54824c7e484336d5a80f90eecf82ccff491a0de8f80fcd7e81b8e0d9a
+  data.tar.gz: 5808e4bf0454d60ead7c62f2e2ecf8828f4417c97f4a0a5f907039dffdc73591
 SHA512:
-  metadata.gz: a92e70c17670182523b32ad5e5f6038f3fa0611c23c731a61b30e9f36cb30df6f65dd406921830b35dda8fd303cb60f8738e2e895c73f180390a482762e6725f
-  data.tar.gz: f918174d0812624c71174e3c414160daa90c28539c1ae32859ce4c2046aa94ff9c222b5a551d3174009975c31939c7de75c30172a1a419290763b7249bf2418a
+  metadata.gz: 17d67e2e407cba9595c4218b01dc03512f75a4b959c1917ab0d95488cf045cd6e9296e11568a2aae01ab21ddd9fbf66d4e8c276d64b202fe67cfd8e834dce2ff
+  data.tar.gz: 0ef761a1c5fb123635e4e1fd9f6636e5ff2b3ae7297d8ebfc4b937d1337be7d46ccb7a2bd9729ea27f8f56706b3dad3b1688669633f52afc522bab5a0eee61f5

data/README.md

@@ -82,6 +82,18 @@ depth: 100
 The layout doesn't matter, but we recommend to use a layout for
 products.
 
+### Layouts
+
+You'll need four layouts and at least a corresponding post, one for each
+step of the buying process.
+
+* `cart` the cart, shows the order details
+* `shipment` shipping and billing addresses, shipping rates apply here
+* `payment` select payment methods
+* `confirmation` order confirmation page
+
+They'll be available on Liquid under the `site.STEP` keys.
+
 ### Hooks
 
 If you need to do some data manipulation before and after
@@ -140,8 +152,18 @@ errors:
 
 ## Notes
 
-* Synchronization is unidirectional.  If the product doesn't exist on
-  Spree, it's created.  If it does, the Jekyll document is updated.
+* Synchronization follows this rules.
+
+  If the product doesn't exist on Spree, it's created.
+
+  If it does, the Jekyll document is updated with price, weight,
+  dimensions and stock.
+
+  It means once the product is created on Spree, Spree manages this
+  variables.
+
+  But Product properties like description and metadata are updated from
+  Jekyll to Spree.
 
   We want this to change in the near future but we need to think a way
   to prevent conflicts.

data/lib/jekyll-spree-client.rb

@@ -6,7 +6,20 @@ require_relative 'jekyll/spree_client'
 # matter.  The SKU needs to be unique, but this plugin doesn't ensure
 # that.  Duplicated SKUs will be silently ignored for now.
 Jekyll::Hooks.register :site, :post_read do |site|
-  next unless ENV['SPREE_API_KEY']
+  # Ordered articles
+  posts = site.site_payload['site']['posts']
+
+  # Make steps available to other articles
+  %w[cart shipment payment confirmation].each do |step|
+    site.config[step] = posts.find do |doc|
+      doc.data['layout'] == step
+    end
+  end
+
+  if ENV['SPREE_API_KEY'].nil? || ENV['SPREE_API_KEY'].empty?
+    Jekyll.logger.warn "SPREE_API_KEY environment variable missing, skipping syncrhonization"
+    next
+  end
 
   config = site.config['spree']&.transform_keys(&:to_sym) || {}
   config.merge!(site: site, api_key: ENV['SPREE_API_KEY'], spree_url: ENV['SPREE_URL'])
@@ -18,14 +31,4 @@ Jekyll::Hooks.register :site, :post_read do |site|
   if ENV['JEKYLL_ENV'] == 'production' && site.respond_to?(:repository)
     site.repository.commit site.data.dig(site.config['locale'], 'spree', 'commit') || 'Spree synchronization'
   end
-
-  # Ordered articles
-  posts = site.site_payload['site']['posts']
-
-  # Make steps available to other articles
-  %w[cart shipment payment confirmation].each do |step|
-    site.config[step] = posts.find do |doc|
-      doc.data['layout'] == step
-    end
-  end
 end

data/lib/jekyll/spree_client.rb

@@ -33,7 +33,21 @@ module Jekyll
     #
     # @return [Array]
     def variant_fields
-      @variant_fields ||= %w[price weight height width depth description cost_price].freeze
+      @variant_fields ||= %w[price weight height width depth cost_price pay_what_you_can].freeze
+    end
+
+    # Fields that can change locally and we need to sync to Spree
+    #
+    # @return [Array]
+    def product_fields
+      @product_fields ||= %w[name description meta_description meta_keywords meta_title].freeze
+    end
+
+    # All fields, using during creation
+    #
+    # @return [Array]
+    def create_fields
+      @create_fields ||= product_fields + variant_fields
     end
 
     # Spree Client
@@ -76,6 +90,10 @@ module Jekyll
         end
 
         products.each do |product|
+          # Products have names, not titles, so we save them for later
+          product.data['_name'] = product.data['name'] if product.data.key? 'name'
+          product.data['name'] = product.data['title']
+
           # Remove previous errors
           product.data.delete 'errors'
           # Find the corresponding Spree variant in the response
@@ -89,6 +107,8 @@ module Jekyll
           else
             create product
           end
+
+          product.data['name'] = product.data.delete('_name') if product.data.key? '_name'
         end
       end
 
@@ -159,6 +179,24 @@ module Jekyll
     # @param [Hash]
     # @return [true,false]
     def update(product, variant)
+      # Sync local changes to Spree
+      remote_product = product.data.slice(*product_fields).transform_keys(&:to_sym)
+      variant_comparison = variant.slice(*product_fields).transform_keys(&:to_sym)
+
+      # Only when they haven't changed, so we don't waste time sending a
+      # request.
+      unless remote_product.slice(*variant_comparison.keys) == variant_comparison
+        # XXX: We don't have the product ID with the variant but we have
+        # the slug.
+        remote_product[:id] = variant['slug']
+        remote_product[:sku] = product.data[sku_field]
+
+        unless remote_products.update **remote_product
+          Jekyll.logger.error "Couldn't update #{product.data['title']}"
+          mark_with_error product, error_messages
+        end
+      end
+
       # XXX: The API replies with stringified numbers so we convert them
       # back to the type we're using locally.
       variant.slice(*variant_fields).each do |k, v|
@@ -180,9 +218,8 @@ module Jekyll
     # @param [Jekyll::Document]
     # @return [true,false]
     def create(product)
-      new_product = product.data.slice(*variant_fields).transform_keys(&:to_sym)
+      new_product = product.data.slice(*create_fields).transform_keys(&:to_sym)
       new_product[:sku] = product.data[sku_field]
-      new_product[:name] = product.data['title']
 
       unless remote_products.create **new_product
         Jekyll.logger.error "Couldn't create #{product.data['title']}"
@@ -206,7 +243,7 @@ module Jekyll
         errors.map do |error|
           field + ' ' + error
         end
-      end.flatten
+      end&.flatten
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spree-client
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.14
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree-api-client