solidus_mailchimp_sync 1.0.0.beta03 → 1.0.0.beta04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e276a5b86018e981cf02bf5cbebe81926be28d9
-  data.tar.gz: 54a01965a2857d2da5595368a114e93071f54766
+  metadata.gz: 1b9bc36458b9257a589b641371cae03b9111f35e
+  data.tar.gz: 757b06318d3a029fa19809da9bb888d503bcb262
 SHA512:
-  metadata.gz: aacc687852c8e67ff013f240499497bcaf31e53b6720ec5f8a0428e1badb719f3918d127d2d98d0665e0bd47fb784fafe9af7e965b64078a2fcc9a7e7029a9a0
-  data.tar.gz: 0d70bdb0b6872f6056c15fdfa4989d41320e4cd9da29b19d77da51b1638051b550a78617404b3e54af4dce28ef0e543507f93e2d9ff41a34be78b23d66144f1c
+  metadata.gz: 2dfa505a9746b9f15fda0e105436c401f687774a5c5e9683cc357931db04ff96e75ea07f2b2b09e4c09684cc4552cf4046e5b7996440b688c4d1e91d970d0b6c
+  data.tar.gz: c643c63402876af74cb07db51374ef5f106de154f6a92a859506c1e48e2cabdd7cebf5e2c05dfe96c092982c384260616b7193aef17627cfe205153e36420e6c

data/README.md

@@ -73,6 +73,13 @@ Known issues/To do
   them in mailchimp, they will wind up with two mailchimp customer records. (Mailchimp
   docs suggest you can change an existing Customer's id itself, but it didn't seem to work.
   can't change an existing Customer's email address)
+
+* Mailchimp API does not let us update products. This is problematic if for instance
+  available_on changes, or other metadata like image/description/title etc. We
+  haven't found a good workaround, trying to delete and recreate product in
+  Mailchimp is also problematic. We do try to avoid sync'ing product until
+  it's `available`, with this logic being customizable.
+
 * Debounce: This may send a LOT of updates to mailchimp, when you're editing something.
   In checkout process there are sometimes multiple syncs for order, not sure why.
   Have an idea for an implementation debounce feature that could debounce/coalesce mailchimp

data/app/serializers/solidus_mailchimp_sync/product_serializer.rb

@@ -13,8 +13,8 @@ module SolidusMailchimpSync
       end
     end
 
-    # We don't include image or url, variants can have those anyway,
-    # and variants are actually editable, do it there.
+    # We have to include image and URL for certain mailchimp features,
+    # although Mailchimp does NOT let us update/edit a sync'd product, grr.
     def as_json
       hash = {
         id: product.id.to_s,
@@ -24,6 +24,14 @@ module SolidusMailchimpSync
         variants: variants_json
       }
 
+      if url = self.url
+        hash[:url] = url
+      end
+
+      if image_url = self.image_url
+        hash[:image_url] = image_url
+      end
+
       if product.available_on
         hash[:published_at_foreign] = product.available_on.iso8601
       end
@@ -31,12 +39,32 @@ module SolidusMailchimpSync
       hash
     end
 
+    # Override in custom serializer for custom front-end url
+    def url
+      if Rails.application.routes.default_url_options[:host] && Spree::Core::Engine.routes.url_helpers.respond_to?(:product_url)
+        Spree::Core::Engine.routes.url_helpers.product_url(product, host: Rails.application.routes.default_url_options[:host])
+      end
+    end
+
+    # Override in custom serializer if you want to choose which image different than `first`
+    def image_url
+      product.images.first.try(:attachment).try(:url)
+    end
+
     def variants_json
-      product.variants_including_master.collect do |variant|
+      sellable_variants.collect do |variant|
         VariantSynchronizer.new(variant).serializer.as_json
       end
     end
 
+    def sellable_variants
+      if (product.association(:variants).loaded? ? product.variants.length > 0 : product.variants.exists?)
+        product.variants
+      else
+        [product.master]
+      end
+    end
+
     def to_json
       JSON.dump(as_json)
     end

data/app/serializers/solidus_mailchimp_sync/variant_serializer.rb

@@ -40,14 +40,12 @@ module SolidusMailchimpSync
 
     # Override in custom serializer for custom front-end url
     def url
-      if Rails.application.routes.default_url_options[:host] && Spree::Core::Engine.routes.url_helpers.respond_to?(:product_url)
-        Spree::Core::Engine.routes.url_helpers.product_url(variant.product, host: Rails.application.routes.default_url_options[:host])
-      end
+      product_serializer.url
     end
 
     # Override in custom serializer if you want to choose which image different than `first`
     def image_url
-      (variant.images.first || variant.product.images.first).try(:attachment).try(:url)
+      variant.images.first.try(:attachment).try(:url) || product_serializer.image_url
     end
 
     # Override for custom visibility. Mailchimp wants a string for some reason,
@@ -55,5 +53,10 @@ module SolidusMailchimpSync
     def visibility
       variant.product.available?.to_s
     end
+
+    def product_serializer
+      ::SolidusMailchimpSync::ProductSynchronizer.serializer_class_name.constantize.new(variant.product)
+    end
+
   end
 end

data/app/synchronizers/solidus_mailchimp_sync/product_synchronizer.rb

@@ -3,6 +3,15 @@ module SolidusMailchimpSync
     self.serializer_class_name = "::SolidusMailchimpSync::ProductSerializer"
     self.synced_attributes = %w{name description slug available_on}
 
+    # Since Mailchimp API 3.0 doesn't let us update products, important to wait
+    # until product is really ready to sync it the first time.
+    class_attribute :only_auto_sync_if
+    self.only_auto_sync_if = lambda { |p| p.available? }
+
+    def should_sync?
+       only_auto_sync_if.call(model) && super
+    end
+
     def sync
       # We go ahead and try to create it. If it already existed, mailchimp
       # doesn't let us do an update, but we can update all variants.

data/lib/generators/solidus_mailchimp_sync/install/templates/config/initializers/solidus_mailchimp_sync.rb

@@ -34,3 +34,7 @@ SolidusMailchimpSync.auto_sync_enabled = Rails.env.production?
 # SolidusMailchimpSync::UserSynchronizer.serializer_class_name = "::SolidusMailchimpSync::MyAppCustomerSerializer"
 
 
+# Since Mailchimp API 3.0 doesn't let us update Products, important to wait
+# until product is really ready to sync it the first time. available? is default,
+# but you may want to customize.
+# SolidusMailchimpSync::ProductSynchronizer.only_auto_sync_if = lambda { |p| p.available? }

data/lib/solidus_mailchimp_sync/version.rb

@@ -1,3 +1,3 @@
 module SolidusMailchimpSync
-  VERSION = '1.0.0.beta03'
+  VERSION = '1.0.0.beta04'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_mailchimp_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta03
+  version: 1.0.0.beta04
 platform: ruby
 authors:
 - Jonathan Rochkind, Friends of the Web
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_core