webflow_sync 4.0.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3270f97e26a8b202ea1b11b2f28b41c58852e175712c155883082a9bea8e418
-  data.tar.gz: 84c74465edb84ae559720358b7f7ab98178b76c8a028c49ce16378085a016d17
+  metadata.gz: 98d3c00c861dd048087817fe1a709eb32a66cde4d5b79e0207ca6b19513dd9df
+  data.tar.gz: dac4374d4f30f254db0808669600b5f0e1d8418bd38e43dcfaa736fed25631ca
 SHA512:
-  metadata.gz: 69b4f9c12048b2c9902d876ec4c3b2676a559c421bf1a7ab96b886c655250a8103cc63d8dd6cc4285cfe7e9b17cbb9608dbf21dbf615e8cb2ccdb000d2dcc548
-  data.tar.gz: 30dbde548e134d3dafab4f76a28e238111e709ea3ff469c0fc11071a58606a8fe3a197513d785ffa242125582106729a2807fe33039a34d33862c8acecc98a40
+  metadata.gz: 203099b7e60df11fe4ac8c4319c4e41603d737a269892fcc120ed4909ebbfb47ea3c4dc0ec2456404607f8a3ba5e155923cff5c781e75a7edd3417e1ac908268
+  data.tar.gz: '0993c797a70bf2efe1faa86eb3f439a85a1a7233201033c5ccc4ccb3b71fcf97f15df19839e9b92259013f4141b2955d84d9c7bdaf017d8ee7a81791989c4d26'

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:
 
@@ -230,9 +232,15 @@ This gem silently "fails" (does nothing) when `webflow_site_id` or `webflow_item
 
 PRs welcome!
 
+To run RuboCop style check and RSpec tests run:
+
+```sh
+bundle exec rake
+```
+
 ## Thanks and Credits
 
-This gem wouldn't be possible without the amazing work of [webflow-ruby](https://github.com/penseo/webflow-ruby) gem. Thank you, @phoet!
+This gem wouldn't be possible without the amazing work of [webflow-ruby](https://github.com/penseo/webflow-ruby) gem. Thank you, [@phoet](https://github.com/phoet)!
 
 
 ## License

data/Rakefile

@@ -11,5 +11,7 @@ require 'bundler/gem_tasks'
 
 require 'stylecheck/rake_tasks' unless Rails.env.production?
 
-load 'rspec/rails/tasks/rspec.rake'
-task default: :spec
+load 'rspec/rails/tasks/rspec.rake' # runs all RSpec tests
+task :default do
+  Rake::Task['style:rubocop:run'].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_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
-
+      if update_record_columns(record, response)
         puts "Created #{record.inspect} in #{collection_slug}"
         response
       else
@@ -60,28 +56,24 @@ 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}"
@@ -121,7 +113,7 @@ module WebflowSync
         response
       end
 
-      def update_record_colums(record, response)
+      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
@@ -130,18 +122,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 = '4.0.2'
+  VERSION = '6.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 6.0.0
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: webflow-ruby
+  name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,111 +39,13 @@ 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
-    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: guard-rspec
-  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: net-smtp
-  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: pry-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: rspec-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: vcr
-  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: webmock
+  name: webflow-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -202,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Keep Rails models in sync with WebFlow.