jekyll-spree-client 0.1.8 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d61e03498ee1c84997ca8c13b5bed76f972ba1f2de004475b2a06246fcbe05d
-  data.tar.gz: 0f966ba2fb7ef2f2e9343fdec035a73d6232c3c84f908ea056c8b2e8f38fea53
+  metadata.gz: c3313a5acca299870b21648a253999a7bda4fae1c50a8ada64ba08bf710ee677
+  data.tar.gz: 15ce97b96ab22eb484960cea96a98549bc6ba972ba82599442f67d5ed6c32925
 SHA512:
-  metadata.gz: e3b78dc6de970d05a7f5a9ff41f3dbf270bf85babf784310a6cac3b5f049b56e0169ebac3518d909a2123803af844467a8c20de3f794b10258845f1ba8ac3ff9
-  data.tar.gz: fc55c726b86464cf3fb0639a645fd75201c43e07e90facad64829408c79317c1473a8854b447c2da5740c8763c9bd5cf89de44b54be2ebd5f5e13f8a3db88cbd
+  metadata.gz: 061be8dc0a119fd8b106e08dd5edc7506aa2d297fd213012f1442744349bcb8d0e955c1887597154510368e9c866e59e597d484f33ede18cf74e76caeb28c27e
+  data.tar.gz: 2a6e0c0e080ba05a8d94d7b383d445fe7e7aa96b113f053ece6b9528d9e80ad1bfc886f41cad37e97c5bfbb533ab44d4e4099600ef7e6501cc3d4a6ea05d4db3

data/README.md

@@ -16,16 +16,6 @@ conversion unless you store prices as strings.
 
 You can use Integer and Floats now!
 
-### Update
-
-The issue is that Spree expects to receive prices in the locale format
-(ie, "200,00") but will return them on Ruby's `to_s` conversion
-("200.0") so we need to reconvert them to our current format and juggle
-between them.
-
-We'll deal with `Integer` for now until we find [a better
-solution](https://github.com/spree/spree/issues/10556).
-
 ## Installation
 
 Add this line to your site's Gemfile:
@@ -77,8 +67,10 @@ Add the required fields in their frontmatter:
 ---
 layout: post
 title: A product
+description: With a description
 sku: A unique ID
 price: 100.00
+cost_price: 50.0
 stock: 100
 weight: 100
 height: 100
@@ -90,18 +82,64 @@ 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
+synchronization is done, you can use hooks.  In a `_plugins/spree.rb`
+file:
+
+```ruby
+Jekyll::Hooks.register :spree, :pre_render do |spree|
+  spree.local_products.each do |product|
+    product.data['_description'] = product.data['description']
+    product.data['description'] = product.data['productore']&.data&.dig('title')
+  end
+end
+
+Jekyll::Hooks.register :spree, :post_render do |spree|
+  spree.local_products.each do |product|
+    product.data['description'] = product.data.delete '_description'
+
+    product.data.delete 'description' unless product.data['description']
+  end
+end
+```
+
+This plugin gets the description value from another document (they're
+linked using
+[jekyll-linked-posts](https://0xacab.org/sutty/jekyll/jekyll-linked-posts/),
+it's a real example!), and then recovers it.
+
+* `pre_render` runs just before starting synchronization
+* `post_render` run after synchronization and before writing changes
+
 ### Building the site
 
 During site build, the plugin will communicate with the Spree API and
-create products when they don't exist or update their price, current
-stock and the other values.
+create products when they don't exist or locally update their price,
+current stock and the other values.
 
 Some fields will appear on the frontmatter:
 
 ```yaml
 variant_id: 1
 in_stock: true
-sync_error: 2020-10-10 00:00:00 UTC
+errors:
+  time: 2020-10-10 00:00:00 UTC
+  messages:
+  - Something went wrong
 ```
 
 * `variant_id` is the ID in the Spree database.
@@ -109,11 +147,27 @@ sync_error: 2020-10-10 00:00:00 UTC
 * `in_stock` is true or false according to availability (Spree decides
   this).
 
-* `sync_error` if the synchronization fails there will be a timestamp
-  here.
+* `errors` if the synchronization fails there will be a timestamp and
+  some messages here.
 
 ## Notes
 
+* 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.
+
 * All products are created as "master variants" on Spree.  There will be
   no pictures, taxonomies or other values, only basic product
   information.
@@ -126,11 +180,12 @@ sync_error: 2020-10-10 00:00:00 UTC
 * Stock is added to the default stock location, meaning the first active
   one.  The API doesn't show or allows to query the actual default.
 
-* The `price` is in the default currency.
+* `price` and `cost_price` are expressed in Spree's default currency.
 
 * If you install the `jekyll-write-and-commit-changes` plugin it will
-  save the data back to disk when you build with `JEKYLL_ENV=production`
-  environment variable.
+  save the data back to disk when you build.  Using the
+  `JEKYLL_ENV=production` environment variable will also commit changes
+  to git.
 
 * Check the shipping category ID on Spree, since there's no API for it,
   you need to provide it manually, default is `1`.

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].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
@@ -56,6 +70,8 @@ module Jekyll
     end
 
     def sync!
+      Jekyll::Hooks.trigger :spree, :pre_render, self
+
       # The API allows to query several SKUs at the same time, so we send
       # groups of 10 products.
       local_products.each_slice(10) do |products|
@@ -68,13 +84,18 @@ module Jekyll
           products.each do |p|
             mark_with_error p,
               i18n.dig('spree', 'errors', 'api') || "Couldn't obtain variants, the store may be down or API key is incorrect"
-            local_save p.save
           end
 
           next
         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
           variant = response['variants'].find do |v|
             v[sku_field] == product.data[sku_field]
@@ -86,8 +107,16 @@ module Jekyll
           else
             create product
           end
+
+          product.data['name'] = product.data.delete('_name') if product.data.key? '_name'
         end
       end
+
+      Jekyll::Hooks.trigger :spree, :post_render, self
+
+      local_products.each do |product|
+        local_save product
+      end
     end
 
     private
@@ -150,6 +179,22 @@ 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)
+      # Only when they haven't changed, so we don't waste time sending a
+      # request.
+      unless remote_product == variant.slice(*product_fields).transform_keys(&:to_sym)
+        # 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|
@@ -162,9 +207,8 @@ module Jekyll
 
       product.data['in_stock'] = variant['in_stock']
       product.data['variant_id'] = variant['id']
-      product.data.delete 'errors'
 
-      local_save product
+      product
     end
 
     # If the product doesn't exist, create it.
@@ -172,23 +216,18 @@ 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']}"
         mark_with_error product, error_messages
-        local_save product
 
         return false
       end
 
       product.data['variant_id'] = remote_products.response.dig('master', 'id')
 
-      # Save the variant ID
-      local_save product
-
       # Add the initial stock
       spree.stock_items(id: product.data['variant_id'], stock_location_id: stock_location['id'])
            .stock_movements.create(quantity: product.data['stock'])
@@ -202,7 +241,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.8
+  version: 0.1.13
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree-api-client