webflow_sync 2.0.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fffb6d06856d3cd1a71f9180fff0753b3cf3396dcfeb1e5ed85d8a01d9ff05e
-  data.tar.gz: a18bfeb55b4893dc0f9639d69259760e41d3326cda8096a471fc932534687844
+  metadata.gz: 0167ac7a16bf2611e4ba460c1365151bad0f4a502d2631d43452f18de030a799
+  data.tar.gz: 5bca098d13b884570d0188aeff52841daed1c4f9225c129f7b8a41091fb4e5e8
 SHA512:
-  metadata.gz: d60c06119a661385dabfff3017fdfe72f3c515b0ba13c208486bff38b2cddc14f40bf5557fe691e5e66215d0f9fe75c7de0a8964e4ca6be725ef61fc3157e626
-  data.tar.gz: 981e3169932af0aa8b7a528738d04da9e9a63cb0021c8c2bd6e3386e924384ee7cc3ae4f4840a02a4df95864d2b330755f83eea287d1752547d0124a1c7d192e
+  metadata.gz: de74a317b6b06e6b94ac2e4454cc32dd29cdca9ecdf1d22861c0d74760ce6a8639fff2bb80fe16a0dee4139b1000d5640ae46fcf7ed6ade9437c3bd0c90346dd
+  data.tar.gz: 58dcefd1fc8644d42db578a040f49fc1c89be2e24a06c5a7ca04ef2e85ddd65e6dc2fe245d32d4a7017ed66fadb8212b02544f430152ca5b36fd27377b389177

data/README.md

@@ -5,7 +5,9 @@
 
 Keep your Ruby on Rails records in sync with WebFlow.*
 
-*Currently only one way Rails => WebFlow synchronization works
+*Currently only one way Rails => WebFlow synchronization.
+
+For the latest changes, check the [CHANGELOG.md](CHANGELOG.md).
 
 ## Installation
 
@@ -42,8 +44,9 @@ In `config/initializers/webflow_sync.rb` you can specify configuration options:
 
 1. `api_token`
 2. `webflow_site_id`
-3. `skip_webflow_sync` - skip synchronization for different environments
-4. `sync_webflow_slug` - save slug generated on WebFlow to the Rails database, in the Rails model column. 
+3. `skip_webflow_sync` - skip synchronization for different environments.
+4. `publish_on_sync` - republish all domains after create, update and destroy actions.
+5. `sync_webflow_slug` - save slug generated on WebFlow to the Rails model, `webflow_slug` column.
 
   This can be useful if you want to link to WebFlow item directly from your Rails app:
 
@@ -56,7 +59,7 @@ In `config/initializers/webflow_sync.rb` you can specify configuration options:
   1. add `webflow_slug` column on the model table, then
   2. set the `sync_webflow_slug` option to `true`.
 
-  Example: 
+  Example:
 
   ```rb
   WebflowSync.configure do |config|
@@ -79,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.
@@ -156,13 +169,43 @@ Or if you already use `#as_json` for some other use-case and cannot modify it, y
 # app/models/article.rb
 class Article < ApplicationRecord
   include WebflowSync::ItemSync
-  
+
   def as_webflow_json
     self.as_json
   end
 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/app/models/concerns/webflow_sync/callbacks.rb

@@ -27,7 +27,10 @@ module WebflowSync
       def destroy_webflow_item
         return if self.skip_webflow_sync || WebflowSync.configuration.skip_webflow_sync
 
-        WebflowSync::DestroyItemJob.perform_later(collection_slug: self.model_name.collection,
+        # Make sure slug is in the pulural form, and multiple words slug separated by dashes
+        collection_slug = self.model_name.collection.underscore.dasherize
+
+        WebflowSync::DestroyItemJob.perform_later(collection_slug: collection_slug,
                                                   webflow_site_id: self.webflow_site_id,
                                                   webflow_item_id: self.webflow_item_id)
       end

data/app/services/webflow_sync/api.rb

@@ -37,12 +37,16 @@ module WebflowSync
       make_request(:item, collection['_id'], webflow_item_id)
     end
 
-    def create_item(record, collection_slug)
+    def create_item(record, collection_slug) # rubocop:disable Metrics/MethodLength
       collection = find_webflow_collection(collection_slug)
       response = make_request(:create_item, collection['_id'],
                               record.as_webflow_json.reverse_merge(_archived: false, _draft: false), live: true)
 
       if update_record_colums(record, response)
+        # When the item is created, sometimes changes are not visible throughout the WebFlow site immediately (probably due to some caching).
+        # To make this change immediately visible from the WebFlow site, we need to publish the site.
+        publish
+
         puts "Created #{record.inspect} in #{collection_slug}"
         response
       else
@@ -56,6 +60,10 @@ module WebflowSync
       response = make_request(:update_item, { '_cid' => collection['_id'], '_id' => record.webflow_item_id },
                               record.as_webflow_json.reverse_merge(_archived: false, _draft: false), live: true)
 
+      # When the item is updated, sometimes changes are not visible throughout the WebFlow site immediately (probably due to some caching).
+      # To make this change immediately visible from the WebFlow site, we need to publish the site.
+      publish
+
       puts "Updated #{record.inspect} in #{collection_slug}"
       response
     end
@@ -72,6 +80,8 @@ module WebflowSync
     end
 
     def publish
+      return unless WebflowSync.configuration.publish_on_sync
+
       response = make_request(:publish, site_id, domain_names: domain_names)
 
       puts "Publish all domains for Webflow site with id: #{site_id}"

data/lib/generators/webflow_sync/templates/webflow_sync.rb

@@ -5,4 +5,5 @@ WebflowSync.configure do |config|
   # config.skip_webflow_sync = Rails.env.test? # default
   config.webflow_site_id = ENV.fetch('WEBFLOW_SITE_ID')
   config.sync_webflow_slug = ENV.fetch('SYNC_WEBFLOW_SLUG')
+  config.publish_on_sync = true
 end

data/lib/webflow_sync/configuration.rb

@@ -6,10 +6,13 @@ module WebflowSync
 
     def configure
       self.configuration ||= Configuration.new
+
+      self.configuration.publish_on_sync = true
+      self.configuration.skip_webflow_sync = !Rails.env.production?
+
       yield(self.configuration)
 
       self.configuration.api_token ||= ENV.fetch('WEBFLOW_API_TOKEN')
-      defined?(self.configuration.skip_webflow_sync) or self.configuration.skip_webflow_sync = !Rails.env.production?
     end
 
     private
@@ -18,7 +21,7 @@ module WebflowSync
   end
 
   class Configuration
-    attr_accessor :skip_webflow_sync, :webflow_site_id, :sync_webflow_slug
+    attr_accessor :skip_webflow_sync, :webflow_site_id, :sync_webflow_slug, :publish_on_sync
     attr_reader :api_token
 
     def api_token=(value)

data/lib/webflow_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: Keep Rails models in sync with WebFlow.