webflow_sync 1.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e85c49b258ebbde8c6d5984893be9f59acf389505f0af30951d98fccc4b2f0d
-  data.tar.gz: '09b216274b17cfd61ff9aa1c2a2cc984b12655302daa4d25e3bb0e37a29b1180'
+  metadata.gz: 071c32fa2d8e2e8cd05717a410d44b382b52487f00111113dbbecdb4de1c5280
+  data.tar.gz: 15deffb7ed2f04269423ec82498160afb8a928e26b9021a085b6e433a1a52bb7
 SHA512:
-  metadata.gz: 3bea1e564a550a72cf7164e3cce4fb7710478e3683c8a1067b1dfc790b87679a59f4a03985fdf610628deeb4334d0d5bd540391afb85d4a41cbb85b67f323525
-  data.tar.gz: bc6bba426b31b48d20caa8ebbfa88e3ec3237b51faa8ac520e715c73fdedf18c1807eff59932e512200d47ed0fb7e921c0ca10b2cd5531cba5cc0096487f6323
+  metadata.gz: b8aeed4c68a939a8a377a5c1e6eee0154fa19778c0b5f1ac725ad36df80d8bcd8f4505bd07c48c6d44dcc3c71b26166a833e512fa7af801da8fc7fcd7f9ff6ad
+  data.tar.gz: 307d91073258ab1f08c1d47d47d6126f315ee2be9ed9781dc6ba05e299f846a483843798d2c80cff902767995677e99632e0bb1fb5efb0d38ff63e3883e41975

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
 
@@ -36,6 +38,35 @@ Run API token Rails generator and follow instructions:
 ```bash
 bundle exec rails generate webflow_sync:api_token_flow
 ```
+### Configuration options
+
+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.
+
+  This can be useful if you want to link to WebFlow item directly from your Rails app:
+
+  ```rb
+  link_to('View on site', "https://#{webflow_domain}/articles/#{record.webflow_slug}", target: :blank)
+  ```
+
+  To save slug generated on WebFlow in Rails model, `webflow_slug` column:
+
+  1. add `webflow_slug` column on the model table, then
+  2. set the `sync_webflow_slug` option to `true`.
+
+  Example:
+
+  ```rb
+  WebflowSync.configure do |config|
+    config.skip_webflow_sync = ActiveModel::Type::Boolean.new.cast(ENV.fetch('SKIP_WEBFLOW_SYNC'))
+    config.sync_webflow_slug = ActiveModel::Type::Boolean.new.cast(ENV.fetch('SYNC_WEBFLOW_SLUG'))
+  end
+  ```
 
 ### Add WebflowSync to models
 
@@ -51,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.
@@ -128,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

@@ -26,8 +26,10 @@ module WebflowSync
 
       def destroy_webflow_item
         return if self.skip_webflow_sync || WebflowSync.configuration.skip_webflow_sync
+        # 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: self.model_name.collection,
+        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

@@ -8,20 +8,45 @@ module WebflowSync
       @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
+      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_pages = (total_items.to_f / max_items_per_page).ceil
+      items = result['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']
+        puts "Get all items from WebFlow for #{collection_slug} page: #{page_number}"
+
+        items.concat next_page_items
+      end
+
+      items
+    end
+
     def get_item(collection_slug, webflow_item_id)
       collection = find_webflow_collection(collection_slug)
-      client.item(collection['_id'], webflow_item_id)
+
+      make_request(:item, collection['_id'], webflow_item_id)
     end
 
     def create_item(record, collection_slug) # rubocop:disable Metrics/MethodLength
       collection = find_webflow_collection(collection_slug)
-      response = client.create_item(
-        collection['_id'],
-        record.as_webflow_json.reverse_merge(_archived: false, _draft: false), live: true
-      )
+      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
 
-      # use update_column to skip callbacks to prevent WebflowSync::ItemSync to kick off
-      if record.update_column(:webflow_item_id, response['_id']) # rubocop:disable Rails/SkipsModelValidations
         puts "Created #{record.inspect} in #{collection_slug}"
         response
       else
@@ -32,21 +57,37 @@ module WebflowSync
 
     def update_item(record, collection_slug)
       collection = find_webflow_collection(collection_slug)
-      response = client.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, { '_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)
-      response = client.delete_item({ '_cid' => collection['_id'], '_id' => webflow_item_id })
+      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: domain_names)
+
+      puts "Publish all domains for Webflow site with id: #{site_id}"
+      response
+    end
+
     private
 
       def client
@@ -57,11 +98,50 @@ module WebflowSync
         @collections ||= client.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 = client.site(site_id)
+        default_domain_name = "#{site['shortName']}.webflow.io"
+        names = [default_domain_name]
+        client.domains(site_id).each { |domain| names << domain['name'] }
+
+        names
+      end
+
       def find_webflow_collection(collection_slug)
         response = collections.find { |collection| collection['slug'] == collection_slug }
         raise "Cannot find collection #{collection_slug} for Webflow site #{site_id}" unless response
 
         response
       end
+
+      def update_record_colums(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
+        else
+          record.update_column(:webflow_item_id, response['_id']) # rubocop:disable Rails/SkipsModelValidations
+        end
+      end
+
+      def make_request(method_name, *args, retries: 0, **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'
+
+        puts "Sleeping #{2**retries} seconds"
+        sleep 2**retries
+        make_request(method_name, *args, retries: retries + 1, **kwargs)
+      end
   end
 end

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

@@ -4,4 +4,6 @@ WebflowSync.configure do |config|
   # config.api_token = ENV.fetch('WEBFLOW_API_TOKEN')
   # 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
+    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 = '1.1.0'
+  VERSION = '3.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-08-06 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.2.11
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Keep Rails models in sync with WebFlow.