rubyblok 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7012bc69cffbe4334c2176ae14a987af28f812c0a5587aecf579f13ce67e8b01
-  data.tar.gz: ace98ab94b1c2b10526c29fe24724d3cdcef12a76a172ea832d3c8ba38986d07
+  metadata.gz: 97de159fda2be4c48fe193e20470427a8d387b751adf6e6c736cc540ded7bb93
+  data.tar.gz: 9e0db1ebff8bcb3d3fc319c1f82c1e43a9c178be17f4cff130263c8f6013579c
 SHA512:
-  metadata.gz: 8f420d367f94c54c3a2c7185e3785f72cbc7445e1323205bc962b6e48565f221c52ddcc534662864b7995ec8f1587dfd1ea915d4fe4479d507e61ae771562be9
-  data.tar.gz: c1f1266ef1eb592eb466bca2ba321bb1a7625248b2461e5696020234014f98d4d3d4d5b5ccbb3f234bcdcbf6689ff719c8bd093bc6b82446d4bc7d0b8fc6d87f
+  metadata.gz: 989944be668f8fd1948ce7a708fcbe26015c847d0bfd5ef181998776af887c1524d3a5e671085efa9890d857e401d389eee52cd8d73aad96cc5d6d8dbc054a90
+  data.tar.gz: 0db3897c8213431fe5bc44a0bb0f0c3025988ee9dc1d3db6dced4e01c3d6833c7c4098df75bbbcb216d7633d21d9bc356d705a2e1289fb6a13c1b4445465ef01

data/.rubocop.yml

@@ -10,3 +10,5 @@ Documentation:
   Enabled: false
 Layout/LineLength:
   Max: 120
+RSpec/NestedGroups:
+  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.3.0] - 2024-07-04
+
+### Added
+- Securing webhook with secret token
+- Visibility property on components
+- Rake task to download all content
+
 ## [1.2.0] - 2024-06-17
 
 ### Added

data/README.md

@@ -71,7 +71,7 @@ config.cached = false
 
 Now you have created your first Hello World page! Start your Rails server, access the `/pages` route and you will be able to see the page.
 
-### Activate the visual editor 
+### Activate the visual editor
 Here are the steps to configure the visual editor at Storyblok. This allows you to see a preview of your changes in the Storyblok interface as you edit and save.
 
 At Storyblok, select your Space and go to _Settings > Visual Editor_. 
@@ -138,12 +138,16 @@ text = {
 # Output: "<p>this is a richtext</p>"
 ```
 
+You can prevent rendering content on production by adding a boolean field type with the name "invisible_on_production" to your Storyblok block.
+
 ### rubyblok_blocks_tag
 Use this tag to render more than one component:
 ```
 <%= rubyblok_blocks_tag(blok.bloks) %>
 ```
 
+You can prevent rendering content on production by adding a boolean field type with the name "invisible_on_production" to your Storyblok block.
+
 ### Updating content manually at the caching layer
 In case you need to update the caching layer with new content added to Storyblok, run the following command:
 ```
@@ -168,14 +172,31 @@ If you want to update the local cache on every page request (ie. the content is
 config.auto_update = true
 ```
 
+You can also use the rake task `rubyblok:create_or_update_content` to update the local cache:
+
+```bash
+rails rubyblok:create_or_update_content # Using the version configured on `Rubyblok.configuration.version`.
+```
+
+or with the `version` argument (`draft` or `published`):
+
+```bash
+rails rubyblok:create_or_update_content[published]
+```
+
 ## Storyblok webhook
 The Storyblok webhook will be responsible for updating and deleting content in the local database in case of changes. [Learn more here.](https://www.storyblok.com/docs/guide/in-depth/webhooks)
 
-Generate the webhook controller:
+1. First generate the webhook controller:
 ```bash
 rails g rubyblok:webhook_controller STORYBLOK_WEBHOOK
 ```
 
+2. You need to set the webhook secret used in Storyblok in the `config/initializers/rubyblok.rb` file:
+```
+config.webhook_secret = 'secret'
+```
+
 ## Caching storyblok images
 You can store your storyblok images and videos on your own S3 storage by enabling this rubyblok feature.
 

data/lib/rubyblok/helpers/storyblok_helper.rb

@@ -1,6 +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?
 
@@ -26,9 +30,15 @@ module StoryblokHelper
   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
@@ -67,22 +77,18 @@ module StoryblokHelper
   def get_story_via_api(slug, save: false)
     story = Rubyblok::Services::GetStoryblokStory.call(slug:)
     replace_storyblok_url(story).tap do |storyblok_story|
-      model.find_or_create(storyblok_story) if save
+      model_cache_class.find_or_create(storyblok_story) if save
     end
   end
 
   def get_story_via_cache(slug)
-    model.fetch_content(slug)
+    model_cache_class.fetch_content(slug)
   end
 
   def replace_storyblok_url(story)
     Rubyblok::Services::ReplaceStoryblokUrl.call(story:)
   end
 
-  def model
-    Rubyblok.configuration.model_name.classify.constantize
-  end
-
   def rich_text_renderer
     ctx = {}
     path = component_path

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

@@ -6,24 +6,45 @@ 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
+          verify_signature(request.raw_post) if webhook_secret.present?
+
           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 })
+        end
+
+        private
 
+        def update_story(payload)
           storyblok_story = Rubyblok::Services::GetStoryblokStory.call(slug: payload['story_id'])
           storyblok_story = Rubyblok::Services::ReplaceStoryblokUrl.call(story: storyblok_story)
-          model.find_or_create(storyblok_story)
+          model_cache_class.find_or_create(storyblok_story)
+        end
 
-          render(json: { success: true })
+        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
 
-        private
+        def verified?(signature)
+          Rack::Utils.secure_compare(signature, request.env['HTTP_WEBHOOK_SIGNATURE'])
+        end
 
-        def model
-          Rubyblok.configuration.model_name.classify.constantize
+        def webhook_secret
+          Rubyblok.configuration.webhook_secret
         end
       end
     end

data/lib/rubyblok/railtie.rb

@@ -7,5 +7,9 @@ module Rubyblok
     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/version.rb

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

data/lib/rubyblok.rb

@@ -7,10 +7,11 @@ 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/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'
@@ -29,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyblok
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - 100 Starlings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_dot
@@ -107,11 +107,13 @@ files:
 - lib/rubyblok/configuration.rb
 - lib/rubyblok/helpers/storyblok_helper.rb
 - lib/rubyblok/mixins/model.rb
+- lib/rubyblok/mixins/model_cache_class.rb
 - lib/rubyblok/mixins/webhook.rb
 - lib/rubyblok/railtie.rb
 - lib/rubyblok/services/get_storyblok_story.rb
 - lib/rubyblok/services/replace_storyblok_url.rb
 - lib/rubyblok/version.rb
+- lib/tasks/rubyblok/create_or_update_content.rake
 - rubyblok.gemspec
 homepage: http://www.rubyblok.com
 licenses: