webflow_sync 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e85c49b258ebbde8c6d5984893be9f59acf389505f0af30951d98fccc4b2f0d
-  data.tar.gz: '09b216274b17cfd61ff9aa1c2a2cc984b12655302daa4d25e3bb0e37a29b1180'
+  metadata.gz: 3fffb6d06856d3cd1a71f9180fff0753b3cf3396dcfeb1e5ed85d8a01d9ff05e
+  data.tar.gz: a18bfeb55b4893dc0f9639d69259760e41d3326cda8096a471fc932534687844
 SHA512:
-  metadata.gz: 3bea1e564a550a72cf7164e3cce4fb7710478e3683c8a1067b1dfc790b87679a59f4a03985fdf610628deeb4334d0d5bd540391afb85d4a41cbb85b67f323525
-  data.tar.gz: bc6bba426b31b48d20caa8ebbfa88e3ec3237b51faa8ac520e715c73fdedf18c1807eff59932e512200d47ed0fb7e921c0ca10b2cd5531cba5cc0096487f6323
+  metadata.gz: d60c06119a661385dabfff3017fdfe72f3c515b0ba13c208486bff38b2cddc14f40bf5557fe691e5e66215d0f9fe75c7de0a8964e4ca6be725ef61fc3157e626
+  data.tar.gz: 981e3169932af0aa8b7a528738d04da9e9a63cb0021c8c2bd6e3386e924384ee7cc3ae4f4840a02a4df95864d2b330755f83eea287d1752547d0124a1c7d192e

data/README.md

@@ -36,6 +36,34 @@ 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. `sync_webflow_slug` - save slug generated on WebFlow to the Rails database, in the Rails model 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
 

data/app/services/webflow_sync/api.rb

@@ -8,20 +8,41 @@ 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
+    def create_item(record, collection_slug)
       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)
 
-      # 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
+      if update_record_colums(record, response)
         puts "Created #{record.inspect} in #{collection_slug}"
         response
       else
@@ -32,21 +53,31 @@ 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)
+
       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
+      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 +88,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,5 @@ 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')
 end

data/lib/webflow_sync/configuration.rb

@@ -18,7 +18,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
     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 = '2.0.0'
 end

metadata

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