webflow_sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14705897f82379cd4aa7b11ceda57374b6066d26b96344318ec4089048c377bb
+  data.tar.gz: b17539c21bc34e339ddd12843831fcf61294876d6bc136d6ac7abbced15826fb
+SHA512:
+  metadata.gz: fb9e2b651a04fd77506a3c869c5b33716131fa765ad413ac6180ca5c1805e141bb6b3b7310c4a8dbdc3f6e71782e7a1bf1a62bdbb78b8c224d8ef3c0669c3e74
+  data.tar.gz: e6bcaf360ecf06bbaf08f78664715dceea5f10a3f529912f9d445aaa39fbe769b4c0fc4c11c583d5e6977e5e3885dc90c17b3a1c8f17c404b585140a3de57dc0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Viktor
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+![build](https://github.com/vfonic/webflow_sync/workflows/build/badge.svg)
+
+# WebflowSync
+
+Keep your Ruby on Rails records in sync with WebFlow.*
+
+*Currently only one way Rails => WebFlow synchronization works
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webflow_sync'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Then run the install generator:
+
+```bash
+bundle exec rails generate webflow_sync:install
+```
+
+## Usage
+
+### Add WebflowSync to models
+
+For each model that you want to sync to WebFlow, you need to run the collection generator:
+
+```bash
+bundle exec rails generate webflow_sync:collection Article
+```
+
+Please note that this _does not_ create a WebFlow collection as that's not possible to do through WebFlow API.
+
+### Create WebFlow collections
+
+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`).
+
+For example, for `Article` model:
+
+```ruby
+> Article.model_name.collection
+# => "articles"
+```
+
+Your WebFlow collection `slug` should be `"articles"`.
+
+### 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:
+
+```ruby
+WebflowSync::InitialSyncJob.perform_later('articles')
+```
+
+You can also run this from a Rake task:
+
+```ruby
+bundle exec rails "webflow_sync:initial_sync[articles]"
+```
+
+*Quotes are needed in order for this to work in all shells.
+
+### Important note
+
+This gem silently "fails" (does nothing) when `webflow_site_id` or `webflow_item_id` is `nil`! This is not always desired behavior so be aware of that.
+
+## Contributing
+
+PRs welcome!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'stylecheck/rake_tasks' unless Rails.env.production?

data/app/jobs/webflow_sync/create_item_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class CreateItemJob < ApplicationJob
+    def perform(collection_slug, id)
+      model_class = collection_slug.classify.constantize
+      record = model_class.find_by(id: id)
+      return if record.blank?
+      return if record.webflow_site_id.blank?
+
+      WebflowSync::Api.new(record.webflow_site_id).create_item(record, collection_slug)
+    end
+  end
+end

data/app/jobs/webflow_sync/destroy_item_job.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class DestroyItemJob < ApplicationJob
+    def perform(collection_slug:, webflow_site_id:, webflow_item_id:)
+      return if webflow_site_id.blank?
+      return if webflow_item_id.blank?
+
+      WebflowSync::Api.new(webflow_site_id).delete_item(collection_slug, webflow_item_id)
+    end
+  end
+end

data/app/jobs/webflow_sync/initial_sync_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class InitialSyncJob < ApplicationJob
+    def perform(collection_slug)
+      model_class = collection_slug.classify.constantize
+      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)
+      end
+    end
+  end
+end

data/app/jobs/webflow_sync/update_item_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class UpdateItemJob < ApplicationJob
+    def perform(collection_slug, id)
+      model_class = collection_slug.classify.constantize
+      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?
+
+      WebflowSync::Api.new(record.webflow_site_id).update_item(record, collection_slug)
+    end
+  end
+end

data/app/models/concerns/webflow_sync/callbacks.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Synchronizes any changes to public records to Webflow
+module WebflowSync
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :skip_webflow_sync
+
+      after_create :create_webflow_item
+      after_update :update_webflow_item
+      after_destroy :destroy_webflow_item
+
+      def create_webflow_item
+        return if self.skip_webflow_sync || WebflowSync.configuration.skip_webflow_sync
+
+        WebflowSync::CreateItemJob.perform_later(self.model_name.collection, self.id)
+      end
+
+      def update_webflow_item
+        return if self.skip_webflow_sync || WebflowSync.configuration.skip_webflow_sync
+
+        WebflowSync::UpdateItemJob.perform_later(self.model_name.collection, self.id)
+      end
+
+      def destroy_webflow_item
+        return if self.skip_webflow_sync || WebflowSync.configuration.skip_webflow_sync
+
+        WebflowSync::DestroyItemJob.perform_later(collection_slug: self.model_name.collection,
+                                                  webflow_site_id: self.webflow_site_id,
+                                                  webflow_item_id: self.webflow_item_id)
+      end
+    end
+  end
+end

data/app/models/concerns/webflow_sync/item_sync.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Synchronizes any changes to public records to Webflow
+module WebflowSync
+  module ItemSync
+    extend ActiveSupport::Concern
+
+    included do
+      include WebflowSync::Callbacks
+
+      # override this method to get more granular, per site customization
+      # for example, you could have Site model in your codebase:
+      #
+      # class Site < ApplicationRecord
+      #   has_many :articles
+      # end
+      #
+      # class Article < ApplicationRecord
+      #   belongs_to :site
+      #
+      #   def webflow_site_id
+      #     self.site.webflow_site_id
+      #   end
+      # end
+      #
+      def webflow_site_id
+        WebflowSync.configuration.webflow_site_id
+      end
+
+      # You can customize this to your liking:
+      # def as_webflow_json
+      #   {
+      #     title: self.title.capitalize,
+      #     slug: self.title.parameterize,
+      #     published_at: self.created_at,
+      #     image: self.image_url
+      #   }
+      # end
+      def as_webflow_json
+        self.as_json
+      end
+    end
+  end
+end

data/app/services/webflow_sync/api.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class Api
+    attr_reader :site_id
+
+    def initialize(site_id)
+      @site_id = site_id
+    end
+
+    def create_item(record, collection_slug)
+      collection = find_webflow_collection(collection_slug)
+      response = client.create_item(collection['_id'], record.as_webflow_json, live: true)
+
+      record.update!(webflow_item_id: response['_id'])
+    end
+
+    def update_item(record, collection_slug)
+      collection = find_webflow_collection(collection_slug)
+      client.update_item(
+        { '_cid' => collection['_id'], '_id' => record.webflow_item_id },
+        record.as_webflow_json, live: true
+      )
+    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 })
+    end
+
+    private
+
+      def client
+        @client ||= ::Webflow::Client.new
+      end
+
+      def collections
+        @collections ||= client.collections(site_id)
+      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
+
+        result
+      end
+  end
+end

data/lib/generators/webflow_sync/collection_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module WebflowSync
+  module Generators
+    class CollectionGenerator < Rails::Generators::NamedBase
+      desc 'Registers ActiveRecord model to sync to WebFlow collection'
+
+      source_root File.expand_path('templates', __dir__)
+
+      include Rails::Generators::Migration
+      def add_migration
+        migration_template 'migration.rb.erb', "#{migration_path}/add_webflow_item_id_to_#{table_name}.rb",
+                           migration_version: migration_version
+      end
+
+      def include_item_sync_in_model_file
+        module_snippet = <<~END_OF_INCLUDE.indent(2)
+
+          include WebflowSync::ItemSync
+        END_OF_INCLUDE
+
+        insert_into_file "app/models/#{name.underscore}.rb", module_snippet, after: / < ApplicationRecord$/
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      private
+
+        def migration_path
+          ActiveRecord::Migrator.migrations_paths.first
+        end
+
+        def migration_version
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+    end
+  end
+end

data/lib/generators/webflow_sync/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def add_config_initializer
+        template 'webflow_sync.rb', 'config/initializers/webflow_sync.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+class AddWebflowItemIdTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :<%= table_name %>, :webflow_item_id, :string
+    add_index :<%= table_name %>, :webflow_item_id, unique: true
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+WebflowSync.configure do |config|
+  # config.skip_webflow_sync = Rails.env.test? # default
+  config.webflow_site_id = ENV.fetch('WEBFLOW_SITE_ID')
+end

data/lib/tasks/webflow_sync_tasks.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :webflow_sync do
+  desc 'Perform initial sync from Rails to WebFlow'
+  task :initial_sync, %i[collection_slug] => :environment do |_task, args|
+    WebflowSync::InitialSyncJob.perform_later(args[:collection_slug])
+  end
+end

data/lib/webflow_sync.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'webflow_sync/version'
+require 'webflow_sync/configuration'
+require 'webflow_sync/engine'
+require 'webflow'
+
+module WebflowSync
+end

data/lib/webflow_sync/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class << self
+    attr_reader :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    private
+
+      attr_writer :configuration
+  end
+
+  class Configuration
+    attr_accessor :skip_webflow_sync, :webflow_site_id
+
+    def initialize
+      @skip_webflow_sync = Rails.env.test?
+    end
+  end
+end

data/lib/webflow_sync/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/webflow_sync/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module WebflowSync
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/webflow_sync/version.rb

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

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: webflow_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viktor
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webflow-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 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
+  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'
+description:
+email:
+- viktor.fonic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/jobs/webflow_sync/create_item_job.rb
+- app/jobs/webflow_sync/destroy_item_job.rb
+- app/jobs/webflow_sync/initial_sync_job.rb
+- app/jobs/webflow_sync/update_item_job.rb
+- 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/collection_generator.rb
+- lib/generators/webflow_sync/install_generator.rb
+- lib/generators/webflow_sync/templates/migration.rb.erb
+- lib/generators/webflow_sync/templates/webflow_sync.rb
+- lib/tasks/webflow_sync_tasks.rake
+- lib/webflow_sync.rb
+- lib/webflow_sync/configuration.rb
+- lib/webflow_sync/engine.rb
+- lib/webflow_sync/railtie.rb
+- lib/webflow_sync/version.rb
+homepage: https://github.com/vfonic/webflow_sync
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vfonic/webflow_sync
+  source_code_uri: https://github.com/vfonic/webflow_sync
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Keep Rails models in sync with WebFlow.
+test_files: []