webflow_sync 5.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2c06f856b81cc899ec4558cd26ddedc42f870bc2cd93620895f2991d68eb0a1
-  data.tar.gz: 2ae06ec63e98709b8ce972a83690a9a03aa9c5f1f59da790114391b43a4e1f9f
+  metadata.gz: bf8a9fdd99e65667dad7f82bd2e5eb7539999a3c48a363cfd8f68b1217b6bb84
+  data.tar.gz: e7aa812fd99148cf99cd41b5c999414d356dd2384e59cc610de61a73d7a3ecf1
 SHA512:
-  metadata.gz: de94d27681c0c660d6ca9a19332660f7864e13077b17cd5afe996d5bfea070df6d63ce7a3f3007d65005ba016175676d85f597322a29b9df55935ff4519916a1
-  data.tar.gz: 679933381b266e9b113b7954bff9a206ae6beb1e45f2e0ea895ecf80ae93ebab3c017a3be5efc17c1f8494287d92792e049b98a89174a75e2234266cf8cc142d
+  metadata.gz: 7ad5b0d2e7fb1724ab309f96630e3653dfe3b4419365b2131af623ec324b05b47e4a65275f977fc5a42744f12630892659bce92053de065d5cc92ebc2f2cc58a
+  data.tar.gz: b61fdc179fcc31af51ab45180eec3f108e842e3b92870463e5602515b470a6c5956a3d1825f7c37dc99e513322d76d615d30d957344a191d45018893b4c5873d

data/README.md

@@ -11,9 +11,12 @@ For the latest changes, check the [CHANGELOG.md](CHANGELOG.md).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+This gem currently only works with a fork of 'webflow-ruby' gem.
+
+Add these lines to your application's Gemfile:
 
 ```ruby
+gem 'webflow-ruby', github: 'vfonic/webflow-ruby', branch: 'allow-live-delete'
 gem 'webflow_sync'
 ```
 
@@ -45,8 +48,7 @@ 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. `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.
+4. `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:
 

data/Rakefile

@@ -11,8 +11,7 @@ require 'bundler/gem_tasks'
 
 require 'stylecheck/rake_tasks' unless Rails.env.production?
 
-load 'rspec/rails/tasks/rspec.rake'
+load 'rspec/rails/tasks/rspec.rake' # runs all RSpec tests
 task :default do
   Rake::Task['style:rubocop:run'].execute
-  Rake::Task['spec'].execute
 end

data/app/jobs/webflow_sync/create_item_job.rb

@@ -15,6 +15,7 @@ module WebflowSync
       record = model_class.find_by(id:)
       return if record.blank?
       return if record.webflow_site_id.blank?
+      return WebflowSync::UpdateItemJob.perform_now(model_name, id, collection_slug) if record.webflow_item_id.present?
 
       WebflowSync::Api.new(record.webflow_site_id).create_item(record, collection_slug)
     end

data/app/services/webflow_sync/api.rb

@@ -37,16 +37,12 @@ module WebflowSync
       make_request(:item, collection['_id'], webflow_item_id)
     end
 
-    def create_item(record, collection_slug) # rubocop:disable Metrics/MethodLength
+    def create_item(record, collection_slug)
       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_columns(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
@@ -60,34 +56,32 @@ 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
 
     def delete_item(collection_slug, webflow_item_id)
       collection = find_webflow_collection(collection_slug)
+      # deleting items from Webflow doesn't work as expected.
+      # if we delete without `live: true`, the item will stay visible on the site until the site is published again
+      # if we delete with `live: true`, the item will be set as draft and not visible on the site, but it will be visible in the Webflow CMS
+      # we then call delete again to remove the item from Webflow CMS
+      make_request(:delete_item, { '_cid' => collection['_id'], '_id' => webflow_item_id }, live: true)
       response = make_request(:delete_item, { '_cid' => collection['_id'], '_id' => webflow_item_id })
-      # When the item is removed from WebFlow, it's still visible throughout the WebFlow site (probably due to some caching).
-      # To remove the item immediately from the WebFlow site, we need to publish the site.
-      publish
 
       puts "Deleted #{webflow_item_id} from #{collection_slug}"
       response
     end
 
     def publish
-      return unless WebflowSync.configuration.publish_on_sync
-
       response = make_request(:publish, site_id, domain_names:)
 
       puts "Publish all domains for Webflow site with id: #{site_id}"
       response
     end
 
+    def sites = make_request(:sites)
+
     private
 
       def client
@@ -95,7 +89,7 @@ module WebflowSync
       end
 
       def collections
-        @collections ||= client.collections(site_id)
+        @collections ||= make_request(:collections, site_id)
       end
 
       def domain_names
@@ -106,16 +100,16 @@ module WebflowSync
         # client.domains request does not return the default domain
         # We need to get default domain name if there are no custom domains set to avoid error:
         # Webflow::Error: Domain not found for site
-        site = client.site(site_id)
-        default_domain_name = "#{site['shortName']}.webflow.io"
+        site = make_request(:site, site_id)
+        default_domain_name = "#{site.fetch('shortName')}.webflow.io"
         names = [default_domain_name]
-        client.domains(site_id).each { |domain| names << domain['name'] }
+        make_request(:domains, site_id).each { |domain| names << domain.fetch('name') }
 
         names
       end
 
       def find_webflow_collection(collection_slug)
-        response = collections.find { |collection| collection['slug'] == collection_slug }
+        response = collections.find { |collection| collection.fetch('slug') == collection_slug }
         raise "Cannot find collection #{collection_slug} for Webflow site #{site_id}" unless response
 
         response
@@ -130,18 +124,19 @@ module WebflowSync
         end
       end
 
-      def make_request(method_name, *args, retries: 0, **kwargs)
+      def make_request(method_name, *args, **kwargs)
         if kwargs.present?
           client.public_send(method_name, *args, **kwargs)
         else
           client.public_send(method_name, *args)
         end
       rescue Webflow::Error => e
-        raise if retries >= 8 || e.message.strip != 'Rate limit hit'
+        raise unless e.message.strip == 'Rate limit hit'
+
+        puts 'Sleeping 10 seconds'
+        sleep 10
 
-        puts "Sleeping #{2**retries} seconds"
-        sleep 2**retries
-        make_request(method_name, *args, retries: retries + 1, **kwargs)
+        make_request(method_name, *args, **kwargs)
       end
   end
 end

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

@@ -5,5 +5,4 @@ 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

@@ -7,7 +7,6 @@ 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)
@@ -21,7 +20,7 @@ module WebflowSync
   end
 
   class Configuration
-    attr_accessor :skip_webflow_sync, :webflow_site_id, :sync_webflow_slug, :publish_on_sync
+    attr_accessor :skip_webflow_sync, :webflow_site_id, :sync_webflow_slug
     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 = '5.0.0'
+  VERSION = '6.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement