webflow_sync 6.1.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3874cf42b829542c647a91935f17fe61d04072b8ad3f30ac8a483e8a019bb6ab
-  data.tar.gz: 32af885137c5c68b1720e6ec816adf584b4215540cc004fac9824fe71bcea3d4
+  metadata.gz: f639ebd2128267a119b8dd6a93e2d06858e8713a2faeb6b6f17bc123e60438bb
+  data.tar.gz: 43294f31bc2fa6e5b0772ecbd28480b8c071c6472c1748b05a3109bd2818dc47
 SHA512:
-  metadata.gz: 32209b9c2500d2ba13f229fc4826296ead24d002fd2ee429f2c4c71076c70f8a23fb3bad1b4386cf4253120a958bfef10bd832ab4c2496b3914a542282d3beca
-  data.tar.gz: d447ac378e5c6ceb3ee19e400e2e337baefbc152146a58b5a64a371fe49d18c1fc72f4e9e9328a924a37749e22608faadf1d449847ef55b32296f56902b4384e
+  metadata.gz: 2fac06bf9bc32b9618636acd2ab18437385f01071435757db1d311225c4f032800cb210c51168c9fb659bc095dcec5d716ce718d1c2e89449bbbf842e59bf4a8
+  data.tar.gz: 8109face21e162c8826b25fec73409009a4bc94ffd519c1648c9c7916f9a4ae6b7bdbe5c328d95031ae0fadfbc0ade771c196a83b3cf4232be80e1cefe19a8de

data/app/jobs/webflow_sync/create_item_job.rb

@@ -11,11 +11,14 @@ module WebflowSync
     # 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)
+      return if WebflowSync.configuration.skip_webflow_sync
+
       model_class = model_name.underscore.classify.constantize
       record = model_class.find_by(id:)
       return if record.blank?
+      return if record.skip_webflow_sync
       return if record.webflow_site_id.blank?
-      return WebflowSync::UpdateItemJob.perform_now(model_name, id, collection_slug) if record.webflow_item_id.present?
+      return WebflowSync::UpdateItemJob.perform_later(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/jobs/webflow_sync/destroy_item_job.rb

@@ -3,6 +3,7 @@
 module WebflowSync
   class DestroyItemJob < ApplicationJob
     def perform(collection_slug:, webflow_site_id:, webflow_item_id:)
+      return if WebflowSync.configuration.skip_webflow_sync
       return if webflow_site_id.blank?
       return if webflow_item_id.blank?
 

data/app/jobs/webflow_sync/update_item_job.rb

@@ -7,11 +7,14 @@ module WebflowSync
     # '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)
+      return if WebflowSync.configuration.skip_webflow_sync
+
       model_class = model_name.underscore.classify.constantize
       record = model_class.find_by(id:)
       return if record.blank?
+      return if record.skip_webflow_sync
       return if record.webflow_site_id.blank?
-      return WebflowSync::CreateItemJob.perform_now(model_name, id, collection_slug) if record.webflow_item_id.blank?
+      return WebflowSync::CreateItemJob.perform_later(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/services/webflow_sync/api.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 module WebflowSync
-  class Api # rubocop:disable Metrics/ClassLength
+  class Api
     attr_reader :site_id
 
     def initialize(site_id = nil)
       @site_id = site_id
     end
 
-    def get_all_items(collection_slug:, page_limit: 100) # rubocop:disable Metrics/MethodLength
-      collection_id = find_webflow_collection(collection_slug)['_id']
-      max_items_per_page = page_limit # Webflow::Error: 'limit' must be less than or equal to 100
+    def get_all_items(collection_slug:, page_limit: 100) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      collection_id = find_webflow_collection(collection_slug).fetch('id')
+      max_items_per_page = [page_limit, 100].min
       first_page_number = 1
 
       result = make_request(:paginate_items, collection_id, page: first_page_number, per_page: max_items_per_page)
       puts "Get all items from WebFlow for #{collection_slug} page: #{first_page_number}"
 
-      total_items = result['total']
+      total_items = result.dig('pagination', 'total')
       total_pages = (total_items.to_f / max_items_per_page).ceil
-      items = result['items']
+      items = result.fetch('items')
 
       (2..total_pages).each do |page_number|
-        next_page_items = make_request(:paginate_items, collection_id, page: page_number, per_page: max_items_per_page)['items']
+        next_page_items = make_request(:paginate_items, collection_id, page: page_number, per_page: max_items_per_page).fetch('items')
         puts "Get all items from WebFlow for #{collection_slug} page: #{page_number}"
 
         items.concat next_page_items
@@ -30,59 +30,41 @@ module WebflowSync
       items
     end
 
-    def self.get_all_items(collection_slug:, page_limit: 100) = new.get_all_items(collection_slug:, page_limit:)
-
     def get_item(collection_slug, webflow_item_id)
       collection = find_webflow_collection(collection_slug)
 
-      make_request(:item, collection['_id'], webflow_item_id)
+      make_request(:item, collection.fetch('id'), webflow_item_id)
     end
-    def self.get_item(collection_slug, webflow_item_id) = new.get_item(collection_slug, webflow_item_id)
 
     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)
+      response = make_request(:create_item, collection.fetch('id'), record.as_webflow_json, publish: true)
 
       if update_record_columns(record, response)
         puts "Created #{record.inspect} in #{collection_slug}"
         response
       else
-        raise "Failed to store webflow_item_id: '#{response['_id']}' " \
+        raise "Failed to store webflow_item_id: '#{response.fetch('id')}' " \
               "after creating item in WebFlow collection #{record.inspect}"
       end
     end
 
-    def self.create_item(record, collection_slug) = new.create_item(record, collection_slug)
-
     def update_item(record, collection_slug)
       collection = find_webflow_collection(collection_slug)
-      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)
-
+      response = make_request(:update_item, collection.fetch('id'), record.webflow_item_id, record.as_webflow_json, publish: true)
       puts "Updated #{record.inspect} in #{collection_slug}"
       response
     end
 
-    def self.update_item(record, collection_slug) = new.update_item(record, collection_slug)
-
     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 })
-
+      response = make_request(:delete_item, collection.fetch('id'), webflow_item_id)
       puts "Deleted #{webflow_item_id} from #{collection_slug}"
       response
     end
 
-    def self.delete_item(collection_slug, webflow_item_id) = new.delete_item(collection_slug, webflow_item_id)
-
     def publish
-      response = make_request(:publish, site_id, domain_names:)
+      response = make_request(:publish, site_id)
 
       puts "Publish all domains for Webflow site with id: #{site_id}"
       response
@@ -98,23 +80,7 @@ module WebflowSync
       end
 
       def collections
-        @collections ||= make_request(:collections, site_id)
-      end
-
-      def domain_names
-        @domain_names ||= find_domain_names
-      end
-
-      def find_domain_names
-        # 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 = make_request(:site, site_id)
-        default_domain_name = "#{site.fetch('shortName')}.webflow.io"
-        names = [default_domain_name]
-        make_request(:domains, site_id).each { |domain| names << domain.fetch('name') }
-
-        names
+        @collections ||= make_request(:collections, site_id).fetch('collections')
       end
 
       def find_webflow_collection(collection_slug)
@@ -127,9 +93,9 @@ module WebflowSync
       def update_record_columns(record, response)
         # use update_column to skip callbacks to prevent WebflowSync::ItemSync to kick off
         if WebflowSync.configuration.sync_webflow_slug
-          record.update_columns(webflow_item_id: response['_id'], webflow_slug: response['slug']) # rubocop:disable Rails/SkipsModelValidations
+          record.update_columns(webflow_item_id: response.fetch('id'), webflow_slug: response.dig('fieldData', 'slug')) # rubocop:disable Rails/SkipsModelValidations
         else
-          record.update_column(:webflow_item_id, response['_id']) # rubocop:disable Rails/SkipsModelValidations
+          record.update_column(:webflow_item_id, response.fetch('id')) # rubocop:disable Rails/SkipsModelValidations
         end
       end
 
@@ -140,7 +106,7 @@ module WebflowSync
           client.public_send(method_name, *args)
         end
       rescue Webflow::Error => e
-        raise unless e.message.strip == 'Rate limit hit'
+        raise unless e.message.strip == 'Too Many Requests'
 
         puts 'Sleeping 10 seconds'
         sleep 10

data/lib/webflow_sync/engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rails'
+
 module WebflowSync
   class Engine < ::Rails::Engine
   end

data/lib/webflow_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 7.0.0
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Keep Rails models in sync with WebFlow.