webflow_sync 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b00faecbccbfec2e2c8007ef0225d4ca6c5ed0a0988dffb84bb9b5c271514b00
-  data.tar.gz: 5b76e7b85ebbd71059743053275a0d288b0308ac758094cae7efa0bd8d2a87e4
+  metadata.gz: 2c1e92b51a65d85955a3e252f59660dcf59932a7bcca492c7ce439e660efb762
+  data.tar.gz: 3befa85279c19ad561d4b5dd15f1fc2446d89238027969739f98a53966ea6897
 SHA512:
-  metadata.gz: c38563161e4684cc4709b07861740ed377c9ed4fa9aacff05fe829534ca684bcf3f04df288577e06acc4fdfd385a19115bd60f290251307bef2a0b0c4b007771
-  data.tar.gz: 9ede89c923844a546c16c015f4a2e5c9f09ab1fdbbafc8d04b0c1a13c033941764f55a8197c83942b0e0c1e2ee00f85ceb271f2bf6f4fff6353da23c588fc010
+  metadata.gz: 35bc4a6a9f7b50ff5b1c5062f1554a37f5b2e12e439d8cead8b07188ab70de0d184499ade1caa0b102668d06332515de580507fce0cd9109e1ff17b0ac871710
+  data.tar.gz: fbfa04746a2faa8f34b30879589c2857ecf1ab9bd04b907119f5ad6cce702ec2fc5f7e9d441c3c7145b14cf25607aabd717de45abcb359252ab650dc2f3d0e4b

data/README.md

@@ -82,17 +82,27 @@ Please note that this _does not_ create a WebFlow collection as that's not possi
 
 As mentioned above, you need to create the WebFlow collection yourself.
 
-Make sure that the collection `slug` matches the Rails model collection name (the output of `model_class.model_name.collection`).
+Make sure that the collection `slug` matches the Rails model collection name (the output of `model_class.model_name.to_s.underscore.dasherize.pluralize`).
 
 For example, for `Article` model:
 
 ```ruby
-> Article.model_name.collection
+> Article.model_name.to_s.underscore.dasherize.pluralize
 # => "articles"
 ```
 
 Your WebFlow collection `slug` should be `"articles"`.
 
+For Rails models named with multiple words, make a collection that have a space between words in the name. WebFlow will set the `slug` by replacing space for "-".
+
+For example, for `FeaturedArticle` model:
+
+```ruby
+> FeaturedArticle.model_name.to_s.underscore.dasherize.pluralize
+# => "featured-articles"
+```
+Your WebFlow collection `slug` in this case should be `"featured-articles"`.
+
 ### Set `webflow_site_id`
 
 There are couple of ways how you can set the `webflow_site_id` to be used.
@@ -166,6 +176,36 @@ class Article < ApplicationRecord
 end
 ```
 
+### Sync a Rails model with the custom collection
+
+If collection `slug` does not match the Rails model collection name, you can still sync with WebFlow collection, but need to specify collection slug for each `CreateItemJob` and `UpdateItemJob` call. If not specified, model name is used as a default slug name. 
+You would also need to replace included `WebflowSync::ItemSync` with custom callbacks that will call appropriate WebflowSync jobs.
+
+For example:
+
+```ruby
+WebflowSync::CreateItemJob.perform_later(model_name, id, collection_slug)
+WebflowSync::UpdateItemJob.perform_later(model_name, id, collection_slug)
+WebflowSync::DestroyItemJob.perform_later(collection_slug:, webflow_site_id:, webflow_item_id:)
+```
+
+Where:
+
+ 1. `model_name` - Rails model that has `webflow_site_id` and `webflow_item_id` defined
+ 2. `collection_slug` - slug of the WebFlow collection (defaults to: `model_name.underscore.dasherize.pluralize `)
+ 
+
+For example:
+
+```ruby
+WebflowSync::CreateItemJob.perform_now('articles', 1, 'stories')
+```
+Or, if you want to use the default 'articles' collection_slug:
+
+```ruby
+WebflowSync::CreateItemJob.perform_now('articles', 1)
+```
+
 ### Run the initial sync
 
 After setting up which models you want to sync to WebFlow, you can run the initial sync for each of the models:

data/app/jobs/webflow_sync/create_item_job.rb

@@ -2,8 +2,16 @@
 
 module WebflowSync
   class CreateItemJob < ApplicationJob
-    def perform(collection_slug, id)
-      model_class = collection_slug.classify.constantize
+    # WebFlow collection slug should be in plural form.
+    # For collections that have spaces in their name, WebFlow sets slug by replacing space for "-".
+    # 'JobListing'.underscore.dasherize.pluralize => "job-listings"
+    # 'job_listing'.underscore.dasherize.pluralize => "job-listings"
+    # We can sync Rails model that has different class name than its WebFlow collection
+    # model_name => Rails model that has webflow_site_id and webflow_item_id columns
+    # collection_slug => slug of the WebFlow collection
+    # model_name = 'articles'; id = article.id, collection_slug = 'stories'
+    def perform(model_name, id, collection_slug = model_name.underscore.dasherize.pluralize)
+      model_class = model_name.underscore.classify.constantize
       record = model_class.find_by(id: id)
       return if record.blank?
       return if record.webflow_site_id.blank?

data/app/jobs/webflow_sync/initial_sync_job.rb

@@ -3,7 +3,7 @@
 module WebflowSync
   class InitialSyncJob < ApplicationJob
     def perform(collection_slug)
-      model_class = collection_slug.classify.constantize
+      model_class = collection_slug.underscore.classify.constantize
       model_class.where(webflow_item_id: nil).find_each do |record|
         next if record.webflow_site_id.blank?
 

data/app/jobs/webflow_sync/update_item_job.rb

@@ -2,12 +2,16 @@
 
 module WebflowSync
   class UpdateItemJob < ApplicationJob
-    def perform(collection_slug, id)
-      model_class = collection_slug.classify.constantize
+    # WebFlow collection slug should be in plural form.
+    # For collections that have spaces in their name, WebFlow sets slug by replacing space for "-".
+    # 'JobListing'.underscore.dasherize.pluralize => 'job-listings'
+    # 'job_listing'.underscore.dasherize.pluralize => 'job-listings'
+    def perform(model_name, id, collection_slug = model_name.underscore.dasherize.pluralize)
+      model_class = model_name.underscore.classify.constantize
       record = model_class.find_by(id: id)
       return if record.blank?
       return if record.webflow_site_id.blank?
-      return WebflowSync::CreateItemJob.perform_now(collection_slug, id) if record.webflow_item_id.blank?
+      return WebflowSync::CreateItemJob.perform_now(model_name, id, collection_slug) if record.webflow_item_id.blank?
 
       WebflowSync::Api.new(record.webflow_site_id).update_item(record, collection_slug)
     end

data/lib/webflow_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebflowSync
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails