webflow_sync 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fffb6d06856d3cd1a71f9180fff0753b3cf3396dcfeb1e5ed85d8a01d9ff05e
-  data.tar.gz: a18bfeb55b4893dc0f9639d69259760e41d3326cda8096a471fc932534687844
+  metadata.gz: b00faecbccbfec2e2c8007ef0225d4ca6c5ed0a0988dffb84bb9b5c271514b00
+  data.tar.gz: 5b76e7b85ebbd71059743053275a0d288b0308ac758094cae7efa0bd8d2a87e4
 SHA512:
-  metadata.gz: d60c06119a661385dabfff3017fdfe72f3c515b0ba13c208486bff38b2cddc14f40bf5557fe691e5e66215d0f9fe75c7de0a8964e4ca6be725ef61fc3157e626
-  data.tar.gz: 981e3169932af0aa8b7a528738d04da9e9a63cb0021c8c2bd6e3386e924384ee7cc3ae4f4840a02a4df95864d2b330755f83eea287d1752547d0124a1c7d192e
+  metadata.gz: c38563161e4684cc4709b07861740ed377c9ed4fa9aacff05fe829534ca684bcf3f04df288577e06acc4fdfd385a19115bd60f290251307bef2a0b0c4b007771
+  data.tar.gz: 9ede89c923844a546c16c015f4a2e5c9f09ab1fdbbafc8d04b0c1a13c033941764f55a8197c83942b0e0c1e2ee00f85ceb271f2bf6f4fff6353da23c588fc010

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|
@@ -156,7 +159,7 @@ 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

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.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-05 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