spree_backend 4.3.0 → 4.5.0

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

@@ -1,13 +1,13 @@
-/* global shipments, variantStockTemplate, order_number */
+/* global shipments, variantStockTemplate, order_number, order_id */
 // Shipments AJAX API
-$(document).ready(function () {
+document.addEventListener("spree:load", function() {
   'use strict'
 
   // handle variant selection, show stock level.
   $('#add_variant_id').change(function () {
-    var variantId = parseInt($(this).val())
+    var variantId = $(this).val().toString()
     var variant = _.find(window.variants, function (variant) {
-      return variant.id === variantId
+      return variant.id.toString() === variantId
     })
 
     $('#stock_details').html(variantStockTemplate({ variant: variant }))
@@ -45,22 +45,23 @@ $(document).ready(function () {
       var shipmentNumber = del.data('shipment-number')
       var variantId = del.data('variant-id')
       // eslint-disable-next-line
-      var shipment = _.findWhere(shipments, { number: shipmentNumber + '' })
-      var url = Spree.routes.shipments_api + '/' + shipmentNumber + '/remove'
+      var url = Spree.routes.shipments_api_v2 + '/' + shipmentNumber + '/remove_item'
 
       toggleItemEdit()
 
       $.ajax({
-        type: 'PUT',
+        type: 'PATCH',
         url: Spree.url(url),
         data: {
-          variant_id: variantId,
-          token: Spree.api_key
-        }
+          shipment: {
+            variant_id: variantId
+          }
+        },
+        headers: Spree.apiV2Authentication()
       }).done(function (msg) {
         window.location.reload()
       }).fail(function (msg) {
-        alert(msg.responseJSON.message || msg.responseJSON.exception)
+        alert(msg.responseJSON.error)
       })
     }
     return false
@@ -69,18 +70,15 @@ $(document).ready(function () {
   // handle ship click
   $('[data-hook=admin_shipment_form] a.ship').on('click', function () {
     var link = $(this)
-    var shipmentNumber = link.data('shipment-number')
-    var url = Spree.url(Spree.routes.shipments_api + '/' + shipmentNumber + '/ship.json')
+    var url = Spree.url(Spree.routes.shipments_api_v2 + '/' + link.data('shipment-number') + '/ship')
     $.ajax({
-      type: 'PUT',
+      type: 'PATCH',
       url: url,
-      data: {
-        token: Spree.api_key
-      }
+      headers: Spree.apiV2Authentication()
     }).done(function () {
       window.location.reload()
     }).fail(function (msg) {
-      alert(msg.responseJSON.message || msg.responseJSON.exception)
+      alert(msg.responseJSON.error)
     })
   })
 
@@ -96,22 +94,22 @@ $(document).ready(function () {
     var shipmentNumber = link.data('shipment-number')
     var selectedShippingRateId = link.parents('tbody').find("select#selected_shipping_rate_id[data-shipment-number='" + shipmentNumber + "']").val()
     var unlock = link.parents('tbody').find("input[name='open_adjustment'][data-shipment-number='" + shipmentNumber + "']:checked").val()
-    var url = Spree.url(Spree.routes.shipments_api + '/' + shipmentNumber + '.json')
+    var url = Spree.url(Spree.routes.shipments_api_v2 + '/' + shipmentNumber + '.json')
 
     $.ajax({
-      type: 'PUT',
+      type: 'PATCH',
       url: url,
       data: {
         shipment: {
           selected_shipping_rate_id: selectedShippingRateId,
           unlock: unlock
         },
-        token: Spree.api_key
-      }
+      },
+      headers: Spree.apiV2Authentication()
     }).done(function () {
       window.location.reload()
     }).fail(function (msg) {
-      alert(msg.responseJSON.message || msg.responseJSON.exception)
+      alert(msg.responseJSON.error)
     })
   })
 
@@ -128,16 +126,11 @@ $(document).ready(function () {
   $('a.cancel-tracking').click(toggleTrackingEdit)
 
   function createTrackingValueContent(data) {
-    var selectedShippingMethod = data.shipping_methods.filter(function (method) {
-      return method.id === data.selected_shipping_rate.shipping_method_id
-    })[0]
-
-    if (selectedShippingMethod && selectedShippingMethod.tracking_url) {
-      var shipmentTrackingUrl = selectedShippingMethod.tracking_url.replace(/:tracking/, data.tracking)
-      return '<a target="_blank" href="' + shipmentTrackingUrl + '">' + data.tracking + '<a>'
+    if (data.attributes.tracking_url && data.attributes.tracking) {
+      return '<a target="_blank" href="' + data.attributes.tracking_url + '">' + data.attributes.tracking + '<a>'
     }
 
-    return data.tracking
+    return data.attributes.tracking
   }
 
   // handle tracking save
@@ -147,25 +140,25 @@ $(document).ready(function () {
     var link = $(this)
     var shipmentNumber = link.data('shipment-number')
     var tracking = link.parents('tbody').find('input#tracking').val()
-    var url = Spree.url(Spree.routes.shipments_api + '/' + shipmentNumber + '.json')
+    var url = Spree.url(Spree.routes.shipments_api_v2 + '/' + shipmentNumber + '.json')
 
     $.ajax({
-      type: 'PUT',
+      type: 'PATCH',
       url: url,
       data: {
         shipment: {
           tracking: tracking
-        },
-        token: Spree.api_key
-      }
-    }).done(function (data) {
+        }
+      },
+      headers: Spree.apiV2Authentication()
+    }).done(function (json) {
       link.parents('tbody').find('tr.edit-tracking').toggle()
 
       var show = link.parents('tbody').find('tr.show-tracking')
       show.toggle()
 
-      if (data.tracking) {
-        show.find('.tracking-value').html($('<strong>').html(Spree.translations.tracking + ': ')).append(createTrackingValueContent(data))
+      if (json.data.attributes.tracking) {
+        show.find('.tracking-value').html($('<strong>').html(Spree.translations.tracking + ': ')).append(createTrackingValueContent(json.data))
       } else {
         show.find('.tracking-value').html(Spree.translations.no_tracking_present)
       }
@@ -176,34 +169,36 @@ $(document).ready(function () {
 function adjustShipmentItems(shipmentNumber, variantId, quantity) {
   var shipment = _.findWhere(shipments, { number: shipmentNumber + '' })
   var inventoryUnits = _.where(shipment.inventory_units, { variant_id: variantId })
-  var url = Spree.routes.shipments_api + '/' + shipmentNumber
+  var url = Spree.routes.shipments_api_v2 + '/' + shipmentNumber
   var previousQuantity = inventoryUnits.reduce(function (accumulator, currentUnit, _index, _array) {
     return accumulator + currentUnit.quantity
   }, 0)
   var newQuantity = 0
 
   if (previousQuantity < quantity) {
-    url += '/add'
+    url += '/add_item'
     newQuantity = (quantity - previousQuantity)
   } else if (previousQuantity > quantity) {
-    url += '/remove'
+    url += '/remove_item'
     newQuantity = (previousQuantity - quantity)
   }
   url += '.json'
 
   if (newQuantity !== 0) {
     $.ajax({
-      type: 'PUT',
+      type: 'PATCH',
       url: Spree.url(url),
       data: {
-        variant_id: variantId,
-        quantity: newQuantity,
-        token: Spree.api_key
-      }
+        shipment: {
+          variant_id: variantId,
+          quantity: newQuantity,
+        }
+      },
+      headers: Spree.apiV2Authentication()
     }).done(function (msg) {
       window.location.reload()
     }).fail(function (msg) {
-      alert(msg.responseJSON.message || msg.responseJSON.exception)
+      alert(msg.responseJSON.error)
     })
   }
 }
@@ -245,26 +240,28 @@ function startItemSplit(event) {
   $.ajax({
     type: 'GET',
     async: false,
-    url: Spree.url(Spree.routes.variants_api),
+    url: Spree.routes.variants_api_v2 + '/' + variantId,
     data: {
-      q: {
-        'id_eq': variantId
-      },
-      token: Spree.api_key
-    }
-  }).done(function (data) {
-    variant = data['variants'][0]
+      include: 'stock_items.stock_location'
+    },
+    headers: Spree.apiV2Authentication()
+  }).done(function (json) {
+    var JSONAPIDeserializer = require('jsonapi-serializer').Deserializer
+    new JSONAPIDeserializer({ keyForAttribute: 'snake_case' }).deserialize(json, function (_err, deserializedJson) {
+      variant = deserializedJson
+
+      var maxQuantity = link.closest('tr').data('item-quantity')
+      var splitItemTemplate = Handlebars.compile($('#variant_split_template').text())
+
+      link.closest('tr').after(splitItemTemplate({ variant: variant, shipments: shipments, max_quantity: maxQuantity }))
+      $('a.cancel-split').click(cancelItemSplit)
+      $('a.save-split').click(completeItemSplit)
+
+      $('#item_stock_location').select2({ width: 'resolve', placeholder: Spree.translations.item_stock_placeholder })
+    })
   }).fail(function (msg) {
-    alert(msg.responseJSON.message || msg.responseJSON.exception)
+    alert(msg.responseJSON.error)
   })
-
-  var maxQuantity = link.closest('tr').data('item-quantity')
-  var splitItemTemplate = Handlebars.compile($('#variant_split_template').text())
-  link.closest('tr').after(splitItemTemplate({ variant: variant, shipments: shipments, max_quantity: maxQuantity }))
-  $('a.cancel-split').click(cancelItemSplit)
-  $('a.save-split').click(completeItemSplit)
-
-  $('#item_stock_location').select2({ width: 'resolve', placeholder: Spree.translations.item_stock_placeholder })
 }
 
 function completeItemSplit(event) {
@@ -301,19 +298,20 @@ function completeItemSplit(event) {
     }
 
     var data = {
-      original_shipment_number: originalShipmentNumber,
       variant_id: variantId,
-      quantity: quantity,
-      token: Spree.api_key
+      quantity: quantity
     }
 
     $.ajax({
-      type: 'POST',
+      type: 'PATCH',
       async: false,
-      url: Spree.url(Spree.routes.shipments_api + path),
-      data: $.extend(data, additionalData)
+      url: Spree.url(Spree.routes.shipments_api_v2 + '/' + originalShipmentNumber + path),
+      data: {
+        shipment: $.extend(data, additionalData)
+      },
+      headers: Spree.apiV2Authentication()
     }).fail(function (msg) {
-      alert(msg.responseJSON.message || msg.responseJSON.exception)
+      alert(msg.responseJSON.error)
     }).done(function (msg) {
       window.location.reload()
     })
@@ -347,17 +345,20 @@ function addVariantFromStockLocation(event) {
     $.ajax({
       type: 'POST',
       // eslint-disable-next-line camelcase
-      url: Spree.url(Spree.routes.shipments_api + '?shipment[order_id]=' + order_number),
+      url: Spree.routes.shipments_api_v2,
       data: {
-        variant_id: variantId,
-        quantity: quantity,
-        stock_location_id: stockLocationId,
-        token: Spree.api_key
-      }
+        shipment: {
+          order_id: order_id,
+          variant_id: variantId,
+          quantity: quantity,
+          stock_location_id: stockLocationId
+        }
+      },
+      headers: Spree.apiV2Authentication()
     }).done(function (msg) {
       window.location.reload()
     }).fail(function (msg) {
-      alert(msg.responseJSON.message || msg.responseJSON.exception)
+      alert(msg.responseJSON.error)
     })
   } else {
     // add to existing shipment

data/app/assets/javascripts/spree/backend/spree-select2.js

@@ -1,4 +1,11 @@
-document.addEventListener('DOMContentLoaded', function() {
+// we need to delete select2 instances before document is saved to cache
+// https://stackoverflow.com/questions/36497723/select2-with-ajax-gets-initialized-several-times-with-rails-turbolinks-events
+document.addEventListener("turbo:before-cache", function() {
+  $('select.select2').select2('destroy')
+  $('select.select2-clear').select2('destroy')
+})
+
+document.addEventListener("spree:load", function() {
   // Initiate a standard Select2 on any select element with the class .select2
   // Remember to add a place holder in the HTML as needed.
   $('select.select2').select2({})

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

@@ -1,12 +1,12 @@
-$(document).ready(function () {
+document.addEventListener("spree:load", function() {
   'use strict'
 
   if ($('#new_state_link').length) {
     $('#country').on('change', function () {
       var newStateLinkHref = $('#new_state_link').prop('href')
       var selectedCountryId = $('#country option:selected').prop('value')
-      var newLink = newStateLinkHref.replace(/countries\/(\d+)/,
-        'countries/' + selectedCountryId)
+      var newLink = newStateLinkHref.replace(/countries\/(.+)\/states\/new/,
+        'countries/' + selectedCountryId + '/states/new')
       $('#new_state_link').attr('href', newLink)
     })
   };

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

@@ -1,3 +1,3 @@
-$(document).ready(function () {
+document.addEventListener("spree:load", function() {
   $('[data-hook=stock_location_country] span#country .select2').on('change', function () { updateAddressState('') })
 })

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

@@ -1,4 +1,4 @@
-$(function () {
+document.addEventListener("spree:load", function() {
   $('.stock_item_backorderable').on('click', function () {
     $(this).parent('form').submit()
   })

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

@@ -1,18 +1,48 @@
 /* global variantTemplate */
-$(function () {
+document.addEventListener("spree:load", function() {
   var el = $('#stock_movement_stock_item_id')
+  var jsonApiVariants = {}
   el.select2({
     placeholder: 'Find a stock item', // translate
+    minimumInputLength: 3,
+    quietMillis: 200,
     ajax: {
-      url: Spree.url(Spree.routes.stock_items_api(el.data('stock-location-id'))),
-      data: function (term, page) {
+      url: Spree.routes.stock_items_api_v2,
+      data: function (params, page) {
         return {
-          q: {
-            variant_product_name_cont: term
+          filter: {
+            variant_product_name_cont: params.term,
+            stock_location_id_eq: el.data('stock-location-id')
+          },
+          include: 'variant',
+          image_transformation: {
+            size: '100x100'
+          },
+          fields: {
+            'variant': 'name,sku,options_text,images'
           },
           per_page: 50,
-          page: page,
-          token: Spree.api_key
+          page: page
+        }
+      },
+      headers: Spree.apiV2Authentication(),
+      success: function(data) {
+        var JSONAPIDeserializer = require('jsonapi-serializer').Deserializer
+        new JSONAPIDeserializer({ keyForAttribute: 'snake_case' }).deserialize(data, function (_err, variants) {
+          jsonApiVariants = variants
+        })
+      },
+      processResults: function (json) {
+        var res = jsonApiVariants.map(function (stockItem) {
+          return {
+            id: stockItem.id,
+            text: stockItem.variant.name,
+            variant: stockItem.variant
+          }
+        })
+
+        return {
+          results: res
         }
       },
       results: function (data, page) {
@@ -23,13 +53,28 @@ $(function () {
         }
       }
     },
-    formatResult: function (stockItem) {
-      return variantTemplate({
-        variant: stockItem.variant
-      })
+    templateResult: function (stockItem) {
+      if (stockItem.loading) {
+        return stockItem.text
+      }
+
+      let variant = stockItem.variant
+      if (variant['images'][0] !== undefined && variant['images'][0].transformed_url !== undefined) {
+        variant.image = variant.images[0].transformed_url
+      }
+      return $(variantTemplate({
+        variant: variant
+      }))
     },
-    formatSelection: function (stockItem) {
-      return Select2.util.escapeMarkup(stockItem.variant.name + '(' + stockItem.variant.options_text + ')')
+    templateSelection: function(stockItem) {
+      const variant = stockItem.variant
+      if (variant === undefined) {
+        return stockItem.text
+      } else if (!!variant.options_text && variant.options_text !== '') {
+        return variant.name + '(' + variant.options_text + ')'
+      } else {
+        return variant.name
+      }
     }
   })
 })

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

@@ -1,4 +1,4 @@
-$(function () {
+document.addEventListener("spree:load", function() {
   function TransferVariant (variant1) {
     // refactor variant1
     this.variant = variant1
@@ -16,13 +16,26 @@ $(function () {
     this.destination = $('#transfer_destination_location_id')
     this.source.change(this.populate_destination.bind(this))
     $('#transfer_receive_stock').change(this.receive_stock_change.bind(this))
-    $.getJSON(Spree.url(Spree.routes.stock_locations_api) + '?token=' + Spree.api_key + '&per_page=1000', function (data) {
+
+    $.ajax({
+      url: Spree.routes.stock_locations_api_v2 + '?per_page=1000',
+      type: 'GET',
+      data: {
+        fields: {
+          stock_location: 'name'
+        }
+      },
+      headers: Spree.apiV2Authentication()
+    }).then(function (json) {
       this.locations = (function () {
-        var ref = data.stock_locations
+        var ref = json.data
         var results = []
         var i, len
         for (i = 0, len = ref.length; i < len; i++) {
-          results.push(ref[i])
+          results.push({
+            id: ref[i].id,
+            name: ref[i].attributes.name
+          })
         }
         return results
       })()
@@ -73,7 +86,7 @@ $(function () {
     if (this.is_source_location_hidden()) {
       return this.populate_select(this.destination)
     } else {
-      return this.populate_select(this.destination, parseInt(this.source.val()))
+      return this.populate_select(this.destination, this.source.val())
     }
   }
 
@@ -110,12 +123,12 @@ $(function () {
   }
 
   TransferVariants.prototype._search_transfer_variants = function () {
-    return this.build_select(Spree.url(Spree.routes.variants_api), 'product_name_or_sku_cont')
+    return this.build_select(Spree.url(Spree.routes.variants_api_v2), 'product_name_or_sku_cont')
   }
 
   TransferVariants.prototype._search_transfer_stock_items = function () {
     var stockLocationId = $('#transfer_source_location_id').val()
-    return this.build_select(Spree.url(Spree.routes.stock_locations_api + ('/' + stockLocationId + '/stock_items')), 'variant_product_name_or_variant_sku_cont')
+    return this.build_select(Spree.routes.stock_items_api_v2 + '?filter[stock_location_id_eq]=' + stockLocationId + '&include=variant', 'variant_product_name_or_variant_sku_cont')
   }
 
   TransferVariants.prototype.format_variant_result = function (result) {
@@ -128,11 +141,14 @@ $(function () {
   }
 
   function formattedVariantList(obj) {
-   return { id: obj.id, text: obj.name, name: obj.name, sku: obj.sku, options_text: obj.options_text, variant: obj }
-  }
-
-  function formattedStockItemsList(obj) {
-    return { id: obj.variant.id, text: obj.variant.name, name: obj.variant.name, sku: obj.variant.sku, options_text: obj.variant.options_text, variant: obj.variant }
+    return {
+     id: obj.id,
+     text: obj.name,
+     name: obj.name,
+     sku: obj.sku,
+     options_text: obj.options_text,
+     variant: obj
+    }
   }
 
   TransferVariants.prototype.build_select = function (url, query) {
@@ -142,27 +158,40 @@ $(function () {
         url: url,
         datatype: 'json',
         data: function (params) {
-          var q = {}
-          q[query] = params.term
+          var filter = {}
+          filter[query] = params.term
+
           return {
-            q: q,
-            token: Spree.api_key
+            filter: filter,
+            fields: {
+              'variant': 'name,sku,options_text'
+            }
           }
         },
-        processResults: function (data) {
-          var result = data.variants || data.stock_items
-          if (data.variants != null) {
-            var res = (result).map(function (variant) {
-              return formattedVariantList(variant)
-            })
-          } else {
-            var res = (result).map(function (variant) {
-              return formattedStockItemsList(variant)
-            })
-          }
+        headers: Spree.apiV2Authentication(),
+        success: function(data) {
+          var JSONAPIDeserializer = require('jsonapi-serializer').Deserializer
+          new JSONAPIDeserializer({ keyForAttribute: 'snake_case' }).deserialize(data, function (_err, variants) {
+            jsonApiVariants = variants
+          })
+        },
+        processResults: function (json) {
+          if (json && json.data && jsonApiVariants) {
+            var res = {}
 
-          return {
-            results: res
+            if (json.links.self.match(/platform\/variants/)) {
+              res = jsonApiVariants.map(function (variant) {
+                return formattedVariantList(variant)
+              })
+            } else {
+              res = jsonApiVariants.map(function (variant) {
+                return formattedVariantList(variant.variant)
+              })
+            }
+
+            return {
+              results: res
+            }
           }
         }
       },
@@ -218,7 +247,7 @@ $(function () {
 
   TransferAddVariants.prototype.find_or_add = function (variant) {
     var existing = _.find(this.variants, function (v) {
-      return v.id === variant.id
+      return v.id.toString() === variant[0].id
     })
     if (existing) {
       return existing
@@ -231,14 +260,15 @@ $(function () {
 
   TransferAddVariants.prototype.remove_variant = function (target) {
     var v
-    var variantId = parseInt(target.data('variantId'))
+    var variantId = target.data('variantId').toString()
+
     this.variants = (function () {
       var ref = this.variants
       var results = []
       var i, len
       for (i = 0, len = ref.length; i < len; i++) {
         v = ref[i]
-        if (v.id !== variantId) {
+        if (v.id.toString() !== variantId) {
           results.push(v)
         }
       }

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

@@ -2,12 +2,10 @@ $.fn.taxonAutocomplete = function() {
   'use strict'
 
   function formatTaxonList(values) {
-    console.warn('taxonAutocomplete is deprecated and will be removed in Spree 5.0')
-
     return values.map(function (obj) {
       return {
         id: obj.id,
-        text: obj.pretty_name
+        text: obj.attributes.pretty_name
       }
     })
   }
@@ -17,26 +15,29 @@ $.fn.taxonAutocomplete = function() {
     placeholder: Spree.translations.taxon_placeholder,
     minimumInputLength: 2,
     ajax: {
-      url: Spree.routes.taxons_api,
+      url: Spree.routes.taxons_api_v2,
       dataType: 'json',
       data: function (params) {
         return {
-          q: {
+          filter: {
             name_cont: params.term
           },
-          token: Spree.api_key
+          fields: {
+            taxon: 'pretty_name'
+          }
         }
       },
+      headers: Spree.apiV2Authentication(),
       processResults: function(data) {
         return {
-          results: formatTaxonList(data.taxons)
+          results: formatTaxonList(data.data)
         }
       }
     }
   })
 }
 
-$(document).ready(function () {
+document.addEventListener("spree:load", function() {
   var productTaxonSelector = document.getElementById('product_taxon_ids')
   if (productTaxonSelector == null) return
   if (productTaxonSelector.hasAttribute('data-autocomplete-url-value')) return