rubyblok 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '096e822e37774a75693902aff5fe81ccb971ed74d50e849a0b47fa49511642e6'
+  data.tar.gz: 28ac8e653f9ed908a14be4622883acf6ef29c642d96925c1e84766228a5a0f1d
+SHA512:
+  metadata.gz: feae7213dc1c38278accc0cc36ec91b903c15ac1087fb598e51551bf87156cdfe0a4eaaef033e7e3ff4c4ecd50a8296b874390c5b93db741b0fe69bda2efa474
+  data.tar.gz: aa25681967a4c901c4c12c9146db6fd03d3f87ef39de957a47337f66a21cede5edd5b0350b61f9690530f376eb86d2f87d7cc17f2b7ad8c87d1895c95eeedfdf

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--order random
+--profile 10
+--color

data/.rubocop.yml

@@ -0,0 +1,151 @@
+require:
+  - rubocop-rspec
+  - rubocop-rails
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1.X
+
+Capybara/VisibilityMatcher:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+Layout/LineLength:
+  Max: 120
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Lint/RedundantSplatExpansion:
+  Enabled: false
+Lint/UriEscapeUnescape:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 500
+Metrics/ModuleLength:
+  Max: 250
+  Exclude:
+    - spec/**/*
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/BlockForwarding:
+  Enabled: false
+Naming/InclusiveLanguage:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+Naming/VariableNumber:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: false
+Style/FetchEnvVar:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+Style/FormatString:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+Style/InPatternThen:
+  Enabled: false
+Style/MultilineInPatternThen:
+  Enabled: false
+Style/MapToHash:
+  Enabled: false
+Style/NumericLiteralPrefix:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/OpenStructUse:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/ChangeByZero:
+  Enabled: false
+RSpec/ContextWording:
+  Enabled: false
+RSpec/DescribedClass:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/ExampleWording:
+  Enabled: false
+RSpec/ExpectInHook:
+  Enabled: false
+RSpec/HooksBeforeExamples:
+  Enabled: false
+RSpec/ImplicitBlockExpectation:
+  Enabled: false
+RSpec/InstanceVariable:
+  Exclude:
+    - spec/views/**/*
+RSpec/LetBeforeExamples:
+  Enabled: false
+RSpec/LetSetup:
+  Enabled: false
+RSpec/MessageChain:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/MultipleDescribes:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/RepeatedDescription:
+  Enabled: false
+RSpec/RepeatedExampleGroupBody:
+  Enabled: false
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: false
+RSpec/StubbedMock:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  Enabled: false
+RSpec/VerifiedDoubleReference:
+  Enabled: false
+RSpec/FilePath:
+  Enabled: false
+RSpec/SpecFilePathFormat:
+  Enabled: false
+Style/FetchEnvVar:
+  Enabled: false

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 100Starlings
+
+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,227 @@
+# Rubyblok
+## Introduction
+Rubyblok is a versatile Ruby gem designed for a Content Management System (CMS) integration.
+This gem offers an easy way to integrate a visual CMS - Storyblok - into your Rails app, providing you with quality-of-life features.
+
+This integration allows you to edit your content online, preview it in real-time, and publish with just the click of a button.
+
+In addition, Rubyblok provides an abstraction layer and stores all your content locally, reducing data usage and enhancing performance. This enables new functionalities that leverage the local data, such as global content search, sitemaps, and listings. Ultimately, this setup increases resilience by eliminating dependency on external data sources.
+
+## Table of Contents
+1. [Installation](#installation)
+2. [Getting Started](#getting-started)
+3. [Rubyblok tags](#rubyblok-tags)
+4. [How to Run Tests](#how-to-run-tests)
+5. [Guide for Contributing](#guide-for-contributing)
+6. [How to Contact Us](#how-to-contact-us)
+7. [License](#license)
+
+## Installation
+Rubyblok 1.0 works with Rails 6.0 onwards. Run:
+```
+bundle add rubyblok
+```
+
+### Storyblok account and variables
+
+[Click here](https://app.storyblok.com/?_gl=1*196uoul*_gcl_au*MTg1NjA5NjA0MS4xNzA5MDY5ODk3#!/signup) to create a free acount at Storyblok, the CMS platform where you will have access to the visual and real-time content editing.
+
+Create a new Space, in _Spaces > Add Space_.
+
+Get your Storyblok API token in your account, at _Storyblok Space > Settings > Access tokens_ page. Copy the "Preview" access level key.
+
+Add the key to your `STORYBLOK_API_TOKEN` in your env file, like this example:
+
+```
+STORYBLOK_API_TOKEN=<your API token>
+```
+You will also need to add the variables below to your env file:
+```
+STORYBLOK_VERSION=draft
+STORYBLOK_WEBHOOK_SECRET=''
+```
+
+## Getting Started
+
+### Your first Rubyblok page
+Let's get started with Rubyblok by creating our first page.
+
+First, you need to run the install generator, which will create the initializer for you:
+```bash
+rails g rubyblok:install
+```
+
+Now let's generate and run a migration to create the `pages` table and the `Page` model:
+```bash
+rails g rubyblok:migration PAGE
+
+rails db:migrate
+```
+
+Then, generate the webhook controller:
+```bash
+rails g rubyblok:webhook_controller STORYBLOK_WEBHOOK
+```
+It also adds this line to your `routes.rb` file:
+```
+resources :storyblok_webhook, only: :create
+```
+The Storyblok webhook is responsible for updating and deleting content in our local database in case of changes of content in Storyblok.
+
+Finally, generate the home controller:
+```bash
+rails g controller home_controller
+```
+Add the following code to your home controller:
+```
+def index
+  response.headers['X-FRAME-OPTIONS'] = 'ALLOWALL'
+end
+```
+
+Add this code to your app/views/home/index.html.erb file:
+```
+<%= rubyblok_story_tag('home') %>
+```
+Configure your `routes.rb` file to call the home controller. For example, adding this line:
+```
+root to: 'home#index'
+```
+
+Create a `shared/storyblok` directory in the `views` directory, this directory is going to store the partials that render Storyblok components.
+You can change the folder settings at the `rubyblok.rb` file as needed:
+```
+config.component_path = "shared/storyblok"
+```
+
+Inside the `views/shared/storyblok` folder, create a file named `_page.html.erb` with the following code:
+```
+<%= rubyblok_blocks_tag(blok.body) %>
+```
+
+And then create another file for the hero section block `_hero_section.html.erb` (more explanation on that later):
+```
+<section>
+  <div>
+    <%= rubyblok_content_tag(blok.headline) %>
+    <%= rubyblok_content_tag(blok.subheadline) %>
+  </div>
+</section>
+```
+
+### Creating your page at Storyblok
+1. Once you're logged in, access your new space in the "My Spaces" section
+2. Go to the "Content" section
+3. Click the CTA "Create new" > Story
+4. Name your story "Home", so it connects to our previous code. The content type is "Page".
+5. Open your new story to start editing.
+6. On the right side, you can add new blocks to your page. Create a new block by clicking the "+ Add Block" button.
+7. This will open the Insert block section, then create the new "hero_section" block by typing its name in the search input.
+8. Click the "Create new hero_section" CTA 
+9. Add the "headline" and "subheadline" text fields to the new Hero Section and save.
+10. In your new Hero Section block, add any text you want to it.
+11. Click the Publish button in the right top corner.
+
+Now you have your first demo page and block created. Start your rails server and you will be able to see it in your application.
+
+### 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_. 
+
+In the "Location (default environment)" input, add your localhost address:
+```
+https://localhost:3333
+```
+
+Then we have to create a local proxy. For that, first create a PEM certificate for your `localhost`:
+
+```bash
+brew install mkcert
+mkcert -install
+mkcert localhost
+```
+
+This will create the `localhost-key.pem` and `localhost.pem` files.
+
+To run the proxy, use the `local-ssl-proxy` tool:
+
+```bash
+npm install local-ssl-proxy -g
+local-ssl-proxy --source 3333 --target 3000 --cert localhost.pem --key localhost-key.pem
+```
+
+This will start a proxy server.
+
+By doing this initial setup, you are able to see your first Storyblok page inside your app and edit its content in the Storyblok admin interface 🎉
+
+
+## Rubyblok tags
+
+### rubyblok_story_tag
+Use this tag to render stories:
+```
+# Slug: full_slug of the storyblok story
+<%= rubyblok_story_tag(slug) %>
+```
+The name of the storyblok blok should match the rails partial, ie the `header` storyblok blok should have a corresponding `_header.html.erb` partial in the `config.component_path` directory. The partial is called with a `blok` local variable which contains the storyblok blok properties.
+
+### rubyblok_content_tag
+It renders content of Text, TextArea, Markdown or Richtext storyblok fields.
+```
+<%= rubyblok_content_tag(content) %>
+```
+
+Optionally, you can use the `rubyblok_markdown_tag` or `rubyblok_richtext_tag` tags for rendering specific content.
+```
+# Markdown text
+<%= rubyblok_markdown_tag("this is a **mark** down") %>
+# Output: "<p>this is a <strong>mark</strong> down</p>"
+
+# Richtext
+text = { 
+         "type" => "doc",
+         "content" => [
+           { "type" => "paragraph",
+             "content" => [{ "text" => "this is a richtext", "type" => "text" }]
+            }
+         ]
+       }
+
+<%= rubyblok_richtext_tag text > %> 
+# Output: "<p>this is a richtext</p>"
+```
+
+### rubyblok_blocks_tag
+Use this tag to render more than one component:
+```
+<%= rubyblok_blocks_tag(blok.bloks) %>
+```
+
+### Updating content manually at the caching layer
+
+You can do the following in case you need to update the caching layer with some content that already exists in Storyblok:
+```
+# Slug: full_slug of the storyblok story
+storyblok_story_content = Rubyblok::Services::GetStoryblokStory.call(slug: slug)
+<MODEL_NAME>.find_or_initialize_by(storyblok_story_slug: page)
+     .update(storyblok_story_content:, storyblok_story_id: storyblok_story_content["id"])
+```
+
+## How to Run Tests
+
+You can run unit tests for RubyBlok with the following command:
+```
+bundle exec rspec
+```
+
+## Guide for Contributing
+Contributions are made to this repository via Issues and Pull Requests (PRs).
+Issues should be used to report bugs, request a new feature, or to discuss potential changes before a PR is created.
+
+## How to Contact Us
+For any inquiries, reach out to us at: info@rubyblok.com
+
+## License
+
+RubyBlok is released under the MIT License.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/generators/rubyblok/install_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Rubyblok
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Generates an initializer file."
+
+      def copy_initializer
+        template("rubyblok.rb", "config/initializers/rubyblok.rb")
+      end
+    end
+  end
+end

data/lib/generators/rubyblok/migration_generator.rb

@@ -0,0 +1,67 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Rubyblok
+  module Generators
+    class MigrationGenerator < ::Rails::Generators::NamedBase
+      include ::Rails::Generators::Migration
+      source_root File.expand_path("../templates", __dir__)
+      desc "Installs Rubyblok migration and model files."
+
+      def install
+        if table_exist?
+          migration_template("migration_update.rb.erb", "db/migrate/update_rubyblok_#{plural_file_name}.rb",
+                             migration_version:)
+        else
+          migration_template("migration_create.rb.erb", "db/migrate/create_rubyblok_#{plural_file_name}.rb",
+                             migration_version:)
+        end
+
+        create_or_update_model
+        add_model_name_to_config
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      def table_exist?
+        ActiveRecord::Base.connection.table_exists?(plural_file_name.to_sym)
+      end
+
+      def create_or_update_model
+        if table_exist?
+          add_mixins_to_existing_model
+        else
+          generate_new_model_from_template
+        end
+      end
+
+      def add_mixins_to_existing_model
+        model_path = "app/models/#{file_name}.rb"
+        mixins_code = "\n  include Rubyblok::Mixins::Model\n"
+
+        insert_into_file model_path, after: "class #{class_name} < ApplicationRecord" do
+          mixins_code
+        end
+      end
+
+      def generate_new_model_from_template
+        template("model.rb.erb", "app/models/#{file_name}.rb")
+      end
+
+      def add_model_name_to_config
+        model_path = "config/initializers/rubyblok.rb"
+        insert_into_file model_path, after: 'config.model_name     = "' do
+          class_name
+        end
+      end
+    end
+  end
+end

data/lib/generators/rubyblok/webhook_controller_generator.rb

@@ -0,0 +1,29 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Rubyblok
+  module Generators
+    class WebhookControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Generates a webhook controller and a route file."
+
+      def copy_initializer
+        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
+          routes_content
+        end
+      end
+
+      private
+
+      def routes_content
+        "\n  resources :#{file_name}, only: :create"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+class CreateRubyblok<%= class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %> do |t|
+      t.string :storyblok_story_id
+      t.string :storyblok_story_slug
+      t.string :storyblok_story_content
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :storyblok_story_slug, unique: true
+  end
+end

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

@@ -0,0 +1,9 @@
+class UpdateRubyblok<%= class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :<%= table_name %>, :storyblok_story_id, :string
+    add_column :<%= table_name %>, :storyblok_story_slug, :string
+    add_column :<%= table_name %>, :storyblok_story_content, :string
+
+    add_index :<%= table_name %>, :storyblok_story_slug, unique: true
+  end
+end

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

@@ -0,0 +1,3 @@
+class <%= class_name %> < ApplicationRecord
+  include Rubyblok::Mixins::Model
+end

data/lib/generators/templates/rubyblok.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Rubyblok.configure do |config|
+  config.cached         = true
+
+  config.api_token      = ENV["STORYBLOK_API_TOKEN"]
+  config.version        = ENV["STORYBLOK_VERSION"]
+  config.webhook_secret = ENV["STORYBLOK_WEBHOOK_SECRET"]
+
+  config.model_name     = ""
+  config.component_path = "shared/storyblok"
+end

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

@@ -0,0 +1,3 @@
+class <%= class_name %>Controller < ApplicationController
+  include Rubyblok::Mixins::Webhook
+end

data/lib/rubyblok/configuration.rb

@@ -0,0 +1,7 @@
+module Rubyblok
+  class Configuration
+    attr_accessor :api_token, :version, :component_path, :webhook_secret, :model_name, :cached
+
+    attr_writer :property
+  end
+end

data/lib/rubyblok/helpers/storyblok_helper.rb

@@ -0,0 +1,97 @@
+module StoryblokHelper
+  def rubyblok_content_tag(content)
+    return if content.blank?
+
+    if content.is_a?(String)
+      rubyblok_markdown_tag(content)
+    else
+      rubyblok_richtext_tag(content)
+    end
+  end
+
+  def rubyblok_story_tag(slug)
+    content = get_story(slug)
+    rubyblok_component_tag(partial: content.component, blok: content)
+  end
+
+  def rubyblok_component_tag(blok:, partial: blok.component)
+    render_partial(partial:, locals: { blok: }).prepend(rubyblok_editable_tag(blok).to_s)
+  end
+
+  # rubocop:disable Rails/OutputSafety
+  def rubyblok_markdown_tag(content)
+    markdown_renderer.render(content).html_safe
+  end
+
+  def rubyblok_richtext_tag(content)
+    rich_text_renderer.render(content).html_safe
+  end
+  # rubocop:enable Rails/OutputSafety
+
+  def rubyblok_blocks_tag(bloks)
+    template =
+      %{<% bloks.each do |blok| %>
+            <%= rubyblok_component_tag(blok:) %>
+        <% end %>}
+
+    render_inline_partial template:, locals: { bloks: }
+  end
+
+  def get_story(slug)
+    if use_cache?
+      get_story_via_cache(slug)["content"].to_dot
+    else
+      get_story_via_api(slug)["content"].to_dot
+    end
+  end
+
+  private
+
+  def get_story_via_api(slug)
+    Rubyblok::Services::GetStoryblokStory.call(slug:)
+  end
+
+  def get_story_via_cache(slug)
+    Rubyblok.configuration.model_name.classify.constantize.fetch_content(slug)
+  end
+
+  def rich_text_renderer # rubocop:disable Metrics/MethodLength
+    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)
+          )
+        })
+      end
+  end
+
+  def markdown_renderer
+    @markdown_renderer ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+  end
+
+  # rubocop:disable Rails/OutputSafety
+  def rubyblok_editable_tag(component)
+    component["_editable"]&.html_safe
+  end
+  # rubocop:enable Rails/OutputSafety
+
+  def component_path
+    Rubyblok.configuration.component_path
+  end
+
+  def render_partial(partial:, locals:)
+    ApplicationController.render partial: "#{component_path}/#{partial}", locals:
+  end
+
+  def render_inline_partial(template:, locals:)
+    ApplicationController.render inline: template, locals:
+  end
+
+  def use_cache?
+    Rubyblok.configuration.cached
+  end
+end

data/lib/rubyblok/mixins/model.rb

@@ -0,0 +1,21 @@
+module Rubyblok
+  module Mixins
+    module Model
+      extend ActiveSupport::Concern
+
+      included do
+        validates :storyblok_story_id, presence: true
+        validates :storyblok_story_slug, presence: true
+        validates :storyblok_story_content, presence: true
+
+        serialize :storyblok_story_content, coder: JSON
+      end
+
+      class_methods do
+        def fetch_content(slug)
+          find_by(storyblok_story_slug: slug)&.storyblok_story_content
+        end
+      end
+    end
+  end
+end

data/lib/rubyblok/mixins/webhook.rb

@@ -0,0 +1,27 @@
+module Rubyblok
+  module Mixins
+    module Webhook
+      extend ActiveSupport::Concern
+
+      included do
+        skip_before_action :verify_authenticity_token, only: [:create]
+
+        def create
+          payload = JSON.parse(request.raw_post)
+
+          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"])
+
+          render json: { success: true }
+        end
+
+        private
+
+        def model
+          Rubyblok.configuration.model_name.classify.constantize
+        end
+      end
+    end
+  end
+end

data/lib/rubyblok/railtie.rb

@@ -0,0 +1,9 @@
+require_relative "helpers/storyblok_helper"
+
+module Rubyblok
+  class Railtie < Rails::Railtie
+    initializer "rubyblok.storyblok_helper" do
+      ActiveSupport.on_load(:action_view) { include StoryblokHelper }
+    end
+  end
+end

data/lib/rubyblok/services/get_storyblok_story.rb

@@ -0,0 +1,30 @@
+module Rubyblok
+  module Services
+    class GetStoryblokStory
+      def self.call(slug:)
+        new(slug:).call
+      end
+
+      def initialize(slug:)
+        @slug = slug
+      end
+
+      def call
+        get_story
+      end
+
+      private
+
+      def storyblok_client(version: "draft") # rubocop:disable Lint/UnusedMethodArgument
+        Storyblok::Client.new(
+          token: Rubyblok.configuration.api_token,
+          version: Rubyblok.configuration.version
+        )
+      end
+
+      def get_story
+        storyblok_client.story(@slug)["data"]["story"]
+      end
+    end
+  end
+end

data/lib/rubyblok/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rubyblok
+  VERSION = "1.0.0"
+end

data/lib/rubyblok.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "hash_dot"
+require "rails"
+require "action_controller"
+
+require_relative "rubyblok/helpers/storyblok_helper"
+require_relative "rubyblok/version"
+require_relative "rubyblok/configuration"
+require_relative "rubyblok/services/get_storyblok_story"
+require_relative "rubyblok/railtie" if defined?(Rails)
+require_relative "rubyblok/mixins/model"
+require_relative "generators/rubyblok/migration_generator"
+require_relative "generators/rubyblok/install_generator"
+
+require_relative "rubyblok/mixins/webhook"
+require_relative "generators/rubyblok/webhook_controller_generator"
+
+module Rubyblok
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/rubyblok.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubyblok/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubyblok"
+  spec.version = Rubyblok::VERSION
+  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.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|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  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.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rubyblok
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- 100 Starlings
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash_dot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: storyblok
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description:
+email:
+- rubyblok@100starlings.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/generators/rubyblok/install_generator.rb
+- lib/generators/rubyblok/migration_generator.rb
+- lib/generators/rubyblok/webhook_controller_generator.rb
+- lib/generators/templates/migration_create.rb.erb
+- lib/generators/templates/migration_update.rb.erb
+- lib/generators/templates/model.rb.erb
+- lib/generators/templates/rubyblok.rb
+- lib/generators/templates/webhook_controller.rb.erb
+- lib/rubyblok.rb
+- lib/rubyblok/configuration.rb
+- lib/rubyblok/helpers/storyblok_helper.rb
+- lib/rubyblok/mixins/model.rb
+- lib/rubyblok/mixins/webhook.rb
+- lib/rubyblok/railtie.rb
+- lib/rubyblok/services/get_storyblok_story.rb
+- lib/rubyblok/version.rb
+- rubyblok.gemspec
+homepage: http://www.rubyblok.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://www.rubyblok.com
+  source_code_uri: https://github.com/100Starlings/rubyblok
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: Simple Storyblok CMS integration for Rails
+test_files: []