webflow_sync 0.1.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14705897f82379cd4aa7b11ceda57374b6066d26b96344318ec4089048c377bb
-  data.tar.gz: b17539c21bc34e339ddd12843831fcf61294876d6bc136d6ac7abbced15826fb
+  metadata.gz: f5541d8efea25526da9e623513853d0b2727c0d473251162cc2db71d729ee3c5
+  data.tar.gz: 45ffc209e988d291a010618debf173530bdecdb1686caf9a23653214265cd300
 SHA512:
-  metadata.gz: fb9e2b651a04fd77506a3c869c5b33716131fa765ad413ac6180ca5c1805e141bb6b3b7310c4a8dbdc3f6e71782e7a1bf1a62bdbb78b8c224d8ef3c0669c3e74
-  data.tar.gz: e6bcaf360ecf06bbaf08f78664715dceea5f10a3f529912f9d445aaa39fbe769b4c0fc4c11c583d5e6977e5e3885dc90c17b3a1c8f17c404b585140a3de57dc0
+  metadata.gz: e850f8be00f87fe2ebd9ede70cf0adf9d7cceeb0d02cf4b8afafbdb17472915717017e6d8a632562c80dc5acc460cb0cbcb3c655b08c5046cef323800abe7779
+  data.tar.gz: 606363c28363aeaf7cd8f3a27859db3a8d5c0db929af486fc0456b27e5ba1ff917d56180e5152a959c337fdc787b016a20335c11dd4ab3ad64c9fec86ef2f800

data/README.md

@@ -1,4 +1,5 @@
-![build](https://github.com/vfonic/webflow_sync/workflows/build/badge.svg)
+[![Build Status](https://github.com/vfonic/webflow_sync/workflows/build/badge.svg)](https://github.com/vfonic/webflow_sync/actions)
+
 
 # WebflowSync
 
@@ -28,6 +29,14 @@ bundle exec rails generate webflow_sync:install
 
 ## Usage
 
+### Generate and set WebFlow API token
+
+Run API token Rails generator and follow instructions:
+
+```bash
+bundle exec rails generate webflow_sync:api_token_flow
+```
+
 ### Add WebflowSync to models
 
 For each model that you want to sync to WebFlow, you need to run the collection generator:
@@ -53,6 +62,79 @@ For example, for `Article` model:
 
 Your WebFlow collection `slug` should be `"articles"`.
 
+### Set `webflow_site_id`
+
+There are couple of ways how you can set the `webflow_site_id` to be used.
+
+#### Set `webflow_site_id` through configuration
+
+In `config/initializers/webflow_sync.rb` you can specify `webflow_site_id`:
+
+```ruby
+WebflowSync.configure do |config|
+  config.webflow_site_id = ENV.fetch('WEBFLOW_SITE_ID')
+end
+```
+
+#### Set `webflow_site_id` for each model individually
+
+You can set `webflow_site_id` per model, or even per record.
+
+To do this, override the `#webflow_site_id` method provided by `WebflowSync::ItemSync` in your ActiveRecord model.
+
+For example, you could have `Site` model in your codebase:
+
+```ruby
+# app/models/site.rb
+class Site < ApplicationRecord
+  has_many :articles
+end
+
+# app/models/article.rb
+class Article < ApplicationRecord
+  include WebflowSync::ItemSync
+
+  belongs_to :site
+
+  def webflow_site_id
+    self.site.webflow_site_id
+  end
+end
+```
+
+### Customize fields to synchronize
+
+By default, WebflowSync calls `#as_webflow_json` on a record to get the fields that it needs to push to WebFlow. `#as_webflow_json` simply calls `#as_json` in its default implementation. To change this behavior, you can override `#as_json` in your model:
+
+```ruby
+# app/models/article.rb
+class Article < ApplicationRecord
+  include WebflowSync::ItemSync
+
+  def as_json
+    {
+      title: self.title.capitalize,
+      slug: self.title.parameterize,
+      published_at: self.created_at,
+      image: self.image_url
+    }
+  end
+end
+```
+
+Or if you already use `#as_json` for some other use-case and cannot modify it, you can also override `#as_webflow_json` method. Here's the default `#as_webflow_json` implementation (you don't need to add this to your model):
+
+```ruby
+# app/models/article.rb
+class Article < ApplicationRecord
+  include WebflowSync::ItemSync
+  
+  def as_webflow_json
+    self.as_json
+  end
+end
+```
+
 ### 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:
@@ -77,6 +159,11 @@ This gem silently "fails" (does nothing) when `webflow_site_id` or `webflow_item
 
 PRs welcome!
 
+## 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!
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -10,3 +10,6 @@ load 'rails/tasks/statistics.rake'
 require 'bundler/gem_tasks'
 
 require 'stylecheck/rake_tasks' unless Rails.env.production?
+
+load 'rspec/rails/tasks/rspec.rake'
+task default: :spec

data/app/jobs/webflow_sync/initial_sync_job.rb

@@ -7,8 +7,18 @@ module WebflowSync
       model_class.where(webflow_item_id: nil).find_each do |record|
         next if record.webflow_site_id.blank?
 
-        WebflowSync::Api.new(record.webflow_site_id).create_item(record, collection_slug)
+        client(record.webflow_site_id).create_item(record, collection_slug)
       end
     end
+
+    private
+
+      def client(site_id)
+        if @client&.site_id == site_id
+          @client
+        else
+          @client = WebflowSync::Api.new(site_id)
+        end
+      end
   end
 end

data/app/jobs/webflow_sync/update_item_job.rb

@@ -7,7 +7,7 @@ module WebflowSync
       record = model_class.find_by(id: id)
       return if record.blank?
       return if record.webflow_site_id.blank?
-      return if record.webflow_item_id.blank?
+      return WebflowSync::CreateItemJob.perform_now(collection_slug, id) 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

@@ -8,24 +8,38 @@ module WebflowSync
       @site_id = site_id
     end
 
-    def create_item(record, collection_slug)
+    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, live: true)
+      response = client.create_item(
+        collection['_id'],
+        record.as_webflow_json.reverse_merge(_archived: false, _draft: false), live: true
+      )
 
-      record.update!(webflow_item_id: response['_id'])
+      # 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
+        raise "Failed to store webflow_item_id: '#{response['_id']}' " \
+              "after creating item in WebFlow collection #{record.inspect}"
+      end
     end
 
     def update_item(record, collection_slug)
       collection = find_webflow_collection(collection_slug)
-      client.update_item(
+      response = client.update_item(
         { '_cid' => collection['_id'], '_id' => record.webflow_item_id },
-        record.as_webflow_json, live: true
+        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)
-      client.delete_item({ '_cid' => collection['_id'], '_id' => webflow_item_id })
+      response = client.delete_item({ '_cid' => collection['_id'], '_id' => webflow_item_id })
+      puts "Deleted #{webflow_item_id} from #{collection_slug}"
+      response
     end
 
     private
@@ -39,10 +53,10 @@ module WebflowSync
       end
 
       def find_webflow_collection(collection_slug)
-        result = collections.find { |collection| collection['slug'] == collection_slug }
-        raise "Cannot find collection #{collection_slug} for Webflow site #{site_id}" unless result
+        response = collections.find { |collection| collection['slug'] == collection_slug }
+        raise "Cannot find collection #{collection_slug} for Webflow site #{site_id}" unless response
 
-        result
+        response
       end
   end
 end

data/lib/generators/webflow_sync/api_token_flow_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module WebflowSync
+  module Generators
+    class ApiTokenFlowGenerator < Rails::Generators::Base
+      desc 'Generates Omniauth flow for authenticating WebFlow application to get WebFlow API token'
+
+      source_root File.expand_path('templates/api_token', __dir__)
+
+      def generate
+        gem 'omniauth-webflow'
+        run 'bundle install'
+        template 'webflow_callback_controller.rb.erb', 'app/controllers/webflow_callback_controller.rb'
+        template 'omniauth_webflow.rb.erb', 'config/initializers/omniauth_webflow.rb'
+        route "post '/auth/webflow/callback', to: 'webflow_callback#index'"
+        route "get '/auth/webflow/callback', to: 'webflow_callback#index'"
+
+        puts <<~END_OF_INSTRUCTIONS.indent(4)
+
+
+          We've generated all the files needed to successfully authenticate
+          with WebFlow to get API token.
+          There are couple of steps left to get the token:
+
+               1. Download ngrok: https://ngrok.com/download
+               2. Run `ngrok http 3000`
+               3. Copy the URL that ngrok gives you (something like: https://dd7cc807bf91.ngrok.io)
+               4. Go to: https://webflow.com/dashboard/account/integrations
+               5. Register New Application
+               6. In "Redirect URI" put: https://dd7cc807bf91.ngrok.io/auth/webflow/callback
+               7. Save
+               8. Copy client ID and client secret to ENV variables or add
+                  them directly in config/initializers/omniauth_webflow.rb
+               9. Start rails server locally
+              10. Go to https://dd7cc807bf91.ngrok.io/auth/webflow
+              11. Finally authenticate, beware which permissions to give
+                  (some are "allow access", some are "restrict access", it's confusing)
+              12. Copy the rendered API token and put it in ENV.fetch('WEBFLOW_API_TOKEN')
+              13. After you've got the API token, you probably don't need
+                  the Omniauth WebFlow code so you can remove the code that this
+                  generator created from your codebase.
+                  It is also a security issue to leave the Omniauth endpoint in your
+                  codebase, that has the ability to generate API tokens for your WebFlow
+                  account!!!
+
+          Easy.
+
+
+        END_OF_INSTRUCTIONS
+      end
+    end
+  end
+end

data/lib/generators/webflow_sync/templates/api_token/omniauth_webflow.rb.erb

@@ -0,0 +1,3 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :webflow, ENV.fetch('WEBFLOW_CLIENT_ID'), ENV.fetch('WEBFLOW_CLIENT_SECRET')
+end

data/lib/generators/webflow_sync/templates/api_token/webflow_callback_controller.rb.erb

@@ -0,0 +1,8 @@
+class WebflowCallbackController < ApplicationController
+  skip_before_action :verify_authenticity_token, only: :index
+
+  # Go to /auth/webflow to start oauth flow
+  def index
+    render plain: request.env['omniauth.auth'].dig('credentials', 'token')
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 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')
 end

data/lib/webflow_sync/configuration.rb

@@ -6,7 +6,10 @@ module WebflowSync
 
     def configure
       self.configuration ||= Configuration.new
-      yield(configuration)
+      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
@@ -16,9 +19,10 @@ module WebflowSync
 
   class Configuration
     attr_accessor :skip_webflow_sync, :webflow_site_id
+    attr_reader :api_token
 
-    def initialize
-      @skip_webflow_sync = Rails.env.test?
+    def api_token=(value)
+      @api_token = Webflow.config.api_token = value
     end
   end
 end

data/lib/webflow_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Viktor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -139,11 +139,14 @@ files:
 - app/models/concerns/webflow_sync/callbacks.rb
 - app/models/concerns/webflow_sync/item_sync.rb
 - app/services/webflow_sync/api.rb
+- lib/generators/webflow_sync/api_token_flow_generator.rb
 - lib/generators/webflow_sync/collection_generator.rb
 - lib/generators/webflow_sync/install_generator.rb
+- lib/generators/webflow_sync/templates/api_token/omniauth_webflow.rb.erb
+- lib/generators/webflow_sync/templates/api_token/webflow_callback_controller.rb.erb
 - lib/generators/webflow_sync/templates/migration.rb.erb
 - lib/generators/webflow_sync/templates/webflow_sync.rb
-- lib/tasks/webflow_sync_tasks.rake
+- lib/tasks/webflow_sync.rake
 - lib/webflow_sync.rb
 - lib/webflow_sync/configuration.rb
 - lib/webflow_sync/engine.rb