rubyblok 1.1.0 → 1.3.0

data/lib/generators/rubyblok/webhook_controller_generator.rb

@@ -1,20 +1,22 @@
-require "rails/generators"
-require "rails/generators/active_record"
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
 
 module Rubyblok
   module Generators
     class WebhookControllerGenerator < ::Rails::Generators::NamedBase
-      source_root File.expand_path("../templates", __dir__)
+      source_root File.expand_path('../templates', __dir__)
 
-      desc "Generates a webhook controller and a route file."
+      desc 'Generates a webhook controller and a route file.'
 
       def copy_initializer
-        template("webhook_controller.rb.erb", "app/controllers/#{file_name}_controller.rb")
+        template('webhook_controller.rb.erb', "app/controllers/#{file_name}_controller.rb")
       end
 
       def routes_config
-        destination_path = "config/routes.rb"
-        insert_into_file destination_path, after: "Rails.application.routes.draw do" do
+        destination_path = 'config/routes.rb'
+        insert_into_file destination_path, after: 'Rails.application.routes.draw do' do
           routes_content
         end
       end

data/lib/generators/templates/carrier_wave_config.rb.erb

@@ -0,0 +1,13 @@
+CarrierWave.configure do |config|
+  config.fog_credentials = {
+    provider:              'AWS',
+    aws_access_key_id:     ENV.fetch('AWS_ACCESS_KEY_ID', nil),
+    aws_secret_access_key: ENV.fetch('AWS_SECRET_ACCESS_KEY', nil),
+    region:                ENV.fetch('AWS_DEFAULT_REGION', nil),
+  }
+
+  config.asset_host     = ENV.fetch('AWS_CLOUDFRONT_UPLOADS_HOST', nil)
+  config.fog_directory  = ENV.fetch('AWS_UPLOADS_DIRECTORY', nil)
+  config.fog_public     = true
+  config.fog_attributes = { cache_control: "public, max-age=#{365.days.to_i}" }
+end

data/lib/generators/templates/image_cache_model.rb.erb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ApplicationRecord
+  mount_uploader :image, <%= class_name %>Uploader
+end

data/lib/generators/templates/image_cache_uploader.rb.erb

@@ -0,0 +1,12 @@
+class <%= class_name %>Uploader < CarrierWave::Uploader::Base
+  storage :fog
+
+  def store_dir
+    model_name = model.model_name.singular
+    "uploads/#{model_name}/#{mounted_as}/#{model.id}"
+  end
+
+  def extension_allowlist
+    %w[gif jpeg jpg png svg mp4]
+  end
+end

data/lib/generators/templates/migration_create_image_cache.rb.erb

@@ -0,0 +1,12 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %> do |t|
+      t.string  :original_image_url
+      t.string  :image
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :original_image_url, unique: true
+  end
+end

data/lib/generators/templates/migration_update_image_cache.rb.erb

@@ -0,0 +1,8 @@
+class Update<%= class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :<%= table_name %>, :original_image_url, :string
+    add_column :<%= table_name %>, :image, :string
+
+    add_index :<%= table_name %>, :storyblok_story_slug, unique: true
+  end
+end

data/lib/generators/templates/rubyblok.rb

@@ -1,12 +1,33 @@
 # frozen_string_literal: true
 
 Rubyblok.configure do |config|
-  config.cached         = true
+  # Storyblok API token
+  config.api_token = ENV.fetch('STORYBLOK_API_TOKEN', nil)
 
-  config.api_token      = ENV["STORYBLOK_API_TOKEN"]
-  config.version        = ENV["STORYBLOK_VERSION"]
-  config.webhook_secret = ENV["STORYBLOK_WEBHOOK_SECRET"]
+  # Storyblok story version (draft or published)
+  config.version = ENV.fetch('STORYBLOK_VERSION', 'draft')
 
-  config.model_name     = ""
-  config.component_path = "shared/storyblok"
+  # Name of the model that stores Storyblok stories
+  config.model_name = ''
+
+  # Directory contains rubyblok partials (relative to app/views)
+  config.component_path = 'shared/storyblok'
+
+  # Feature flag that enables cached mode
+  config.cached = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_CACHED', false))
+
+  # Feature flag that enables auto update of local cache
+  config.auto_update = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_AUTOUPDATE', false))
+
+  # Feature flag that enables caching storyblok images
+  config.use_cdn_images = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_CDN_IMAGES', false))
+
+  # Name of the model that stores Storyblok cached images
+  config.image_model_name = ''
+
+  # Storyblok webhook token
+  config.webhook_secret = ENV.fetch('STORYBLOK_WEBHOOK_SECRET', nil)
+
+  # Feature flag that enables caching view fragments
+  config.cache_views = ActiveModel::Type::Boolean.new.cast(ENV.fetch('STORYBLOK_CACHE_VIEWS', false))
 end

data/lib/generators/templates/sitemap.rb.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'sitemap_generator'
+
+# TODO: Configure your hostname here
+SitemapGenerator::Sitemap.default_host = ''
+
+if Rubyblok.configuration.cached
+  SitemapGenerator::Sitemap.create do
+    model = Rubyblok.configuration.model_name.classify.constantize
+    pages = model.all.select { |page| page.storyblok_story_content.dig('content', 'no_index') == false }
+    pages.each { |page| add(page.storyblok_story_slug, lastmod: page.updated_at) }
+  end
+end

data/lib/rubyblok/configuration.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Rubyblok
   class Configuration
-    attr_accessor :api_token, :version, :component_path, :webhook_secret, :model_name, :cached
-
-    attr_writer :property
+    attr_accessor :api_token, :auto_update, :cached, :cache_views, :component_path, :image_model_name,
+                  :model_name, :use_cdn_images, :version, :webhook_secret
   end
 end

data/lib/rubyblok/helpers/storyblok_helper.rb

@@ -1,4 +1,10 @@
+# frozen_string_literal: true
+
+require 'rubyblok/mixins/model_cache_class'
+
 module StoryblokHelper
+  include Rubyblok::Mixins::ModelCacheClass
+
   def rubyblok_content_tag(content)
     return if content.blank?
 
@@ -10,14 +16,29 @@ module StoryblokHelper
   end
 
   def rubyblok_story_tag(slug)
-    content = get_story(slug)
-    rubyblok_component_tag(partial: content.component, blok: content)
+    story = get_story(slug)
+    content = story['content'].to_dot
+
+    template = <<-ERB
+      <% cache_key = "rubyblok/#{story['id']}-#{Digest::SHA1.hexdigest(story.to_json)}" %>
+      <% cache_if use_cache, cache_key do %>
+        <%= rubyblok_component_tag(partial: content.component, blok: content) %>
+      <% end %>
+    ERB
+
+    render_inline_partial template:, locals: { content:, use_cache: Rubyblok.configuration.cache_views }
   end
 
   def rubyblok_component_tag(blok:, partial: blok.component)
+    return if invisible_on_production?(blok)
+
     render_partial(partial:, locals: { blok: }).prepend(rubyblok_editable_tag(blok).to_s)
   end
 
+  def invisible_on_production?(blok)
+    Rails.env.production? && blok.fetch('invisible_on_production', false)
+  end
+
   # rubocop:disable Rails/OutputSafety
   def rubyblok_markdown_tag(content)
     markdown_renderer.render(content).html_safe
@@ -37,34 +58,44 @@ module StoryblokHelper
     render_inline_partial template:, locals: { bloks: }
   end
 
+  def get_story_content(slug)
+    get_story(slug)['content'].to_dot
+  end
+
+  private
+
   def get_story(slug)
-    if use_cache?
-      get_story_via_cache(slug)["content"].to_dot
+    return get_story_via_api(slug) unless cached?
+
+    if update_storyblok?
+      get_story_via_api(slug, save: true)
     else
-      get_story_via_api(slug)["content"].to_dot
+      get_story_via_cache(slug)
     end
   end
 
-  private
-
-  def get_story_via_api(slug)
-    Rubyblok::Services::GetStoryblokStory.call(slug:)
+  def get_story_via_api(slug, save: false)
+    story = Rubyblok::Services::GetStoryblokStory.call(slug:)
+    replace_storyblok_url(story).tap do |storyblok_story|
+      model_cache_class.find_or_create(storyblok_story) if save
+    end
   end
 
   def get_story_via_cache(slug)
-    Rubyblok.configuration.model_name.classify.constantize.fetch_content(slug)
+    model_cache_class.fetch_content(slug)
   end
 
-  def rich_text_renderer # rubocop:disable Metrics/MethodLength
+  def replace_storyblok_url(story)
+    Rubyblok::Services::ReplaceStoryblokUrl.call(story:)
+  end
+
+  def rich_text_renderer
     ctx = {}
     path = component_path
     @rich_text_renderer ||=
       Storyblok::Richtext::HtmlRenderer.new.tap do |html_renderer|
         html_renderer.set_component_resolver(lambda { |component, data|
-          ApplicationController.render(
-            partial: "#{path}/#{component}",
-            locals: ctx.merge(blok: data)
-          )
+          ApplicationController.render(partial: "#{path}/#{component}", locals: ctx.merge(blok: data))
         })
       end
   end
@@ -75,7 +106,7 @@ module StoryblokHelper
 
   # rubocop:disable Rails/OutputSafety
   def rubyblok_editable_tag(component)
-    component["_editable"]&.html_safe
+    component['_editable']&.html_safe
   end
   # rubocop:enable Rails/OutputSafety
 
@@ -91,7 +122,15 @@ module StoryblokHelper
     ApplicationController.render inline: template, locals:
   end
 
-  def use_cache?
+  def cached?
     Rubyblok.configuration.cached
   end
+
+  def auto_update?
+    Rubyblok.configuration.auto_update
+  end
+
+  def update_storyblok?
+    auto_update? || params[:storyblok] == 'update'
+  end
 end

data/lib/rubyblok/mixins/model.rb

@@ -1,4 +1,6 @@
-require "active_support/concern"
+# frozen_string_literal: true
+
+require 'active_support/concern'
 
 module Rubyblok
   module Mixins
@@ -17,6 +19,16 @@ module Rubyblok
         def fetch_content(slug)
           find_by(storyblok_story_slug: slug)&.storyblok_story_content
         end
+
+        def find_or_create(story)
+          return if story.blank?
+
+          find_or_initialize_by(storyblok_story_id: story['id']).tap do |model|
+            model.storyblok_story_content = story
+            model.storyblok_story_slug = story['full_slug']
+            model.save
+          end
+        end
       end
     end
   end

data/lib/rubyblok/mixins/model_cache_class.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Rubyblok
+  module Mixins
+    module ModelCacheClass
+      extend ActiveSupport::Concern
+
+      def model_cache_class
+        Rubyblok.configuration.model_name.classify.constantize
+      end
+    end
+  end
+end

data/lib/rubyblok/mixins/webhook.rb

@@ -1,27 +1,50 @@
-require "active_support/concern"
+# frozen_string_literal: true
+
+require 'active_support/concern'
 
 module Rubyblok
   module Mixins
     module Webhook
       extend ActiveSupport::Concern
+      include Rubyblok::Mixins::ModelCacheClass
 
-      included do
+      included do # rubocop:disable Metrics/BlockLength
         skip_before_action :verify_authenticity_token, only: [:create]
 
         def create
-          payload = JSON.parse(request.raw_post)
+          verify_signature(request.raw_post) if webhook_secret.present?
 
-          storyblok_story_content = Rubyblok::Services::GetStoryblokStory.call(slug: payload["story_id"])
-          model.find_or_initialize_by(storyblok_story_id: payload["story_id"])
-               .update(storyblok_story_content:, storyblok_story_slug: storyblok_story_content["full_slug"])
+          payload = JSON.parse(request.raw_post)
+          case payload['action']
+          when 'published'
+            update_story(payload)
+          when 'unpublished', 'deleted'
+            model_cache_class.find_by(storyblok_story_id: payload['story_id'])&.destroy!
+          end
 
-          render json: { success: true }
+          render(json: { success: true })
         end
 
         private
 
-        def model
-          Rubyblok.configuration.model_name.classify.constantize
+        def update_story(payload)
+          storyblok_story = Rubyblok::Services::GetStoryblokStory.call(slug: payload['story_id'])
+          storyblok_story = Rubyblok::Services::ReplaceStoryblokUrl.call(story: storyblok_story)
+          model_cache_class.find_or_create(storyblok_story)
+        end
+
+        def verify_signature(payload_body)
+          signature =
+            OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), webhook_secret, payload_body)
+          raise StandardError, 'Signature check failed!' unless verified?(signature)
+        end
+
+        def verified?(signature)
+          Rack::Utils.secure_compare(signature, request.env['HTTP_WEBHOOK_SIGNATURE'])
+        end
+
+        def webhook_secret
+          Rubyblok.configuration.webhook_secret
         end
       end
     end

data/lib/rubyblok/railtie.rb

@@ -1,9 +1,15 @@
-require_relative "helpers/storyblok_helper"
+# frozen_string_literal: true
+
+require_relative 'helpers/storyblok_helper'
 
 module Rubyblok
   class Railtie < Rails::Railtie
-    initializer "rubyblok.storyblok_helper" do
+    initializer 'rubyblok.storyblok_helper' do
       ActiveSupport.on_load(:action_view) { include StoryblokHelper }
     end
+
+    rake_tasks do
+      load 'tasks/rubyblok/create_or_update_content.rake'
+    end
   end
 end

data/lib/rubyblok/services/get_storyblok_story.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rubyblok
   module Services
     class GetStoryblokStory
@@ -15,15 +17,15 @@ module Rubyblok
 
       private
 
-      def storyblok_client(version: "draft") # rubocop:disable Lint/UnusedMethodArgument
+      def storyblok_client
         Storyblok::Client.new(
           token: Rubyblok.configuration.api_token,
           version: Rubyblok.configuration.version
         )
       end
 
-      def get_story
-        storyblok_client.story(@slug)["data"]["story"]
+      def get_story # rubocop:disable Naming/AccessorMethodName
+        storyblok_client.story(@slug)['data']['story']
       end
     end
   end

data/lib/rubyblok/services/replace_storyblok_url.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Rubyblok
+  module Services
+    class ReplaceStoryblokUrl
+      attr_reader :story
+
+      def self.call(story:)
+        new(story:).call
+      end
+
+      def initialize(story:)
+        @story = story
+      end
+
+      def call
+        return story unless use_cdn_images?
+
+        image_fields = find_image_fields(story['content'])
+        image_fields.each do |image_field|
+          replace_url(image_field)
+        end
+        story
+      end
+
+      private
+
+      # It finds image fields based on their "fieldtype"=>"asset" attribute.
+      # Please note that it caches only images added as an 'Asset' field type in Storyblok.
+      def find_image_fields(content)
+        return [content] if image_field?(content)
+
+        content.values.each_with_object([]) do |field_value, image_fields|
+          case field_value
+          when Array
+            field_value.each { |component| image_fields << find_image_fields(component) }
+          when Hash
+            image_fields << find_image_fields(field_value)
+          end
+        end.flatten
+      end
+
+      def image_field?(field)
+        field['fieldtype'] == 'asset'
+      end
+
+      def replace_url(image_field)
+        url = image_field['filename']
+        image =
+          image_model.create_with(remote_image_url: url).find_or_create_by(original_image_url: url)
+
+        image_field['filename'] = image.image.url if image.persisted?
+      end
+
+      def image_model
+        Rubyblok.configuration.image_model_name.classify.constantize
+      end
+
+      def use_cdn_images?
+        Rubyblok.configuration.use_cdn_images
+      end
+    end
+  end
+end

data/lib/rubyblok/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubyblok
-  VERSION = "1.1.0"
+  VERSION = '1.3.0'
 end

data/lib/rubyblok.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
-require "storyblok"
-require "redcarpet"
-require "hash_dot"
+require 'storyblok'
+require 'redcarpet'
+require 'hash_dot'
 
-require_relative "rubyblok/helpers/storyblok_helper"
-require_relative "rubyblok/version"
-require_relative "rubyblok/configuration"
-require_relative "rubyblok/railtie" if defined?(Rails)
-require_relative "rubyblok/services/get_storyblok_story"
-require_relative "rubyblok/mixins/model"
-require_relative "rubyblok/mixins/webhook"
-require_relative "generators/rubyblok/migration_generator"
-require_relative "generators/rubyblok/install_generator"
-require_relative "generators/rubyblok/webhook_controller_generator"
-require_relative "generators/rubyblok/hello_world_generator"
+require_relative 'rubyblok/helpers/storyblok_helper'
+require_relative 'rubyblok/version'
+require_relative 'rubyblok/configuration'
+require_relative 'rubyblok/railtie' if defined?(Rails::Railtie)
+require_relative 'rubyblok/services/get_storyblok_story'
+require_relative 'rubyblok/services/replace_storyblok_url'
+require_relative 'rubyblok/mixins/model'
+require_relative 'rubyblok/mixins/model_cache_class'
+require_relative 'rubyblok/mixins/webhook'
+require_relative 'generators/rubyblok/migration_generator'
+require_relative 'generators/rubyblok/install_generator'
+require_relative 'generators/rubyblok/webhook_controller_generator'
+require_relative 'generators/rubyblok/hello_world_generator'
+require_relative 'generators/rubyblok/sitemap_config_generator'
+require_relative 'generators/rubyblok/image_cache_generator'
 
 module Rubyblok
   def self.configuration
@@ -26,5 +30,4 @@ module Rubyblok
   end
 
   class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/tasks/rubyblok/create_or_update_content.rake

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+PER_PAGE = 50
+
+namespace :rubyblok do
+  desc 'Create or update cached Storyblok stories'
+  task :create_or_update_content, [:version] => [:environment] do |_task, args|
+    include Rubyblok::Mixins::ModelCacheClass
+
+    args.with_defaults(version: Rubyblok.configuration.version)
+
+    raise ArgumentError, "Invalid version \"#{args[:version]}\"" unless %w[draft published].include?(args[:version])
+
+    client = storyblok_client(args[:version])
+    page = 1
+
+    loop do
+      stories = get_stories(client:, page:)
+      break if stories.empty?
+
+      stories.each { |story| model_cache_class.find_or_create(story) }
+
+      page += 1
+
+      sleep 1
+    end
+  end
+
+  def storyblok_client(version)
+    Storyblok::Client.new(token: Rubyblok.configuration.api_token, version:)
+  end
+
+  def get_stories(client:, page:)
+    client.stories(page:, per_page: PER_PAGE).dig('data', 'stories')
+  end
+end

data/rubyblok.gemspec

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "lib/rubyblok/version"
+require_relative 'lib/rubyblok/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "rubyblok"
+  spec.name = 'rubyblok'
   spec.version = Rubyblok::VERSION
-  spec.license = "MIT"
-  spec.authors = ["100 Starlings"]
-  spec.email = ["rubyblok@100starlings.com"]
+  spec.license = 'MIT'
+  spec.authors = ['100 Starlings']
+  spec.email = ['rubyblok@100starlings.com']
 
-  spec.summary = "Simple Storyblok CMS integration for Rails"
-  spec.homepage = "http://www.rubyblok.com"
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.summary = 'Simple Storyblok CMS integration for Rails'
+  spec.homepage = 'http://www.rubyblok.com'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/100Starlings/rubyblok"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/100Starlings/rubyblok'
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
@@ -22,14 +22,14 @@ Gem::Specification.new do |spec|
         f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "hash_dot", "~> 2.5"
-  spec.add_dependency "railties", "~> 7.1"
-  spec.add_dependency "redcarpet", "~> 3.6.0"
-  spec.add_dependency "storyblok", "~> 3.2.0"
+  spec.add_dependency 'hash_dot', '~> 2.5'
+  spec.add_dependency 'railties', '~> 7.1'
+  spec.add_dependency 'redcarpet', '~> 3.6.0'
+  spec.add_dependency 'storyblok', '~> 3.2.0'
 
-  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end