bridgetown_directus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b424ba8e007c294fa25eb29fbdd0276ab170d6161868fb5e8ece5dfec640a3a
+  data.tar.gz: ee0e007bc2cf19b6bf727409744b21b4ae51037381d448003ef544f3bf051958
+SHA512:
+  metadata.gz: 444040c145212360d3f8055cec064dc062f56bb012c35264ad265e9db26257010f5b5ca6dab2591c6ac1a2969a7863a536f25e885bff598130a75470ea4111ed
+  data.tar.gz: 935a429e2b629b8d3b55a2df4cae44cd7fd753539b65c62a0de3d395a5f0bdb3e571296e2e9cd0651f4f9a69fc8e3769be8a42c9c91f9cdf29a39ef26d7e6dbf

data/.gitignore

@@ -0,0 +1,40 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+.env

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - test/fixtures/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- ...
+
+## [0.1.0] - 2024-09-27
+
+- First version

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,113 @@
+# Bridgetown Directus Plugin
+
+This Bridgetown plugin integrates with the [Directus](https://directus.io/) which is among other things a [headless CMS](https://en.wikipedia.org/wiki/Headless_content_management_system). The plugin allows Bridgetown to pull content from a Directus API during the build process and generate static content in your site. It currently supports fetching published posts, with future plans for more flexibility and features.
+
+## Features
+
+- Fetch **published posts** from Directus during the build process
+- Simple setup and configuration
+
+## Installation
+
+Before installing the plugin make sure you have an [Auth Token](https://docs.directus.io/reference/authentication.html#access-tokens) in your Directus instance.
+
+### Recommended Installation (Bridgetown Automation)
+
+1. Run the plugin's automation setup:
+   ```bash
+   bin/bridgetown apply https://github.com/munkun-estudio/bridgetown_directus
+   ```
+2.	The setup will guide you to provide the Directus API URL and Auth Token, and configure the plugin automatically.
+
+### Manual Installation
+
+1.	Add the gem to your Gemfile:
+```ruby
+bundle add "bridgetown_directus"
+```
+2.	Run bundle install to install the gem.
+3.	Add the plugin configuration to your config/initializers.rb file:
+```ruby
+init :bridgetown_directus do
+  api_url "https://your-directus-instance.com"
+  token ENV['DIRECTUS_AUTH_TOKEN'] || "your_token"
+end
+```
+
+## Configuration
+
+To configure the plugin:
+
+1.	You can either use environment variables for the API URL and token:
+```bash
+export DIRECTUS_API_URL="https://your-directus-instance.com"
+export DIRECTUS_AUTH_TOKEN="your-token"
+```
+
+2.	Or hard-code the values directly in your initializer:
+```ruby
+init :bridgetown_directus do
+  api_url "https://your-directus-instance.com"
+  token "your_token"
+end
+```
+## Usage
+
+Once the plugin is installed and configured, it will fetch posts from your Directus instance during each build. These posts will be generated as in-memory resources, meaning they are not written to disk but are treated as normal posts by Bridgetown.
+
+### Directus Setup
+
+To use the plugin, ensure that you've set up a **posts** collection in your Directus instance with the following fields:
+
+- **title**: The title of the post (Text field)
+- **date**: The publish date (Datetime field)
+- **body**: The content of the post (Rich Text or Text field)
+- **slug**: A unique slug for the post (Text field)
+- **status**: The status of the post (Option field, with values like "published", "draft", "archived", etc.)
+
+Make sure the **status** field uses `"published"` for posts that you want to be visible on your site.
+
+#### Image Permissions
+
+If your posts contain images, and you want to display them in your Bridgetown site, you'll need to ensure that the **directus_files** collection has the appropriate permissions for public access.
+
+1. **Public Role Configuration:**
+   - In Directus, navigate to **Settings** > **Roles & Permissions**.
+   - Select the **Public** role (or create a custom role if needed).
+   - Under the **Collections** tab, locate the **directus_files** collection.
+   - Set the **read** permission to **enabled** so that the images can be accessed publicly.
+
+2. **Image Uploads and Management:**
+   - When users upload images to posts, ensure that the images are associated with the **directus_files** collection.
+   - By default, Directus will store image URLs, which the plugin can reference directly. Ensure that the **image** field or URL is added to the **body** field (or wherever applicable).
+
+
+### Fetching Posts
+
+Posts are fetched from Directus during each build and treated as Bridgetown resources. These resources are available in your site just like regular posts, and you can access them through your templates or layouts.
+
+By default, only posts with a status of "published" are fetched from Directus.
+
+## TODO List
+
+Here are features that are planned for future versions of the plugin:
+
+	- [ ]	Support for Additional Content Types: Extend the plugin to handle other Directus collections and custom content types.
+	- [ ]	Custom Field Mapping via DSL: Implement a DSL for more advanced field mapping.
+	- [ ]	Asset Handling: Add functionality to download and manage images and other assets.
+	- [ ]	Caching & Incremental Builds: Implement caching to improve build performance when fetching content.
+	- [ ] Draft Previews: Add support for previewing unpublished (draft) posts.
+
+## Testing
+
+Testing isn’t fully set up yet, but contributions and improvements are welcome.
+
+## Contributing
+
+We welcome contributions to this project! To contribute:
+
+1. Fork the repository
+2. Create a new branch (git checkout -b feature-branch)
+3. Make your changes
+4. Push to the branch (git push origin feature-branch)
+5. Open a Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown.automation.rb

@@ -0,0 +1,23 @@
+say_status :directus, "Installing the bridgetown_directus plugin..."
+
+# Prompt the user for Directus API URL and Auth Token
+api_url = ask("What's your Directus instance URL?")
+auth_token = ask("What's your Directus API auth token? (Leave blank to use ENV['DIRECTUS_AUTH_TOKEN'])")
+
+# Add the bridgetown_directus gem
+add_gem "bridgetown_directus"
+
+# Append the API URL and Auth Token to the config/initializers.rb file
+append_to_file "config/initializers.rb" do
+  <<~RUBY
+
+    init :bridgetown_directus do
+      api_url "#{api_url}"
+      token "#{auth_token.present? ? auth_token : "<%= ENV['DIRECTUS_AUTH_TOKEN'] %>"}"
+    end
+  RUBY
+end
+
+# Finish with a success message
+say_status :directus, "All set! Directus integration is complete. Review your configuration in config/initializers.rb."
+say_status :directus, "You can refer to the plugin documentation for more details on how to customize your Directus integration."

data/bridgetown_directus.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown_directus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown_directus"
+  spec.version       = BridgetownDirectus::VERSION
+  spec.author        = "Munkun"
+  spec.email         = "development@munkun.com"
+  spec.summary       = "Use Directus as headless CMS for Bridgetown"
+  spec.homepage      = "https://github.com/munkun-estudio/bridgetown_directus"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
+  spec.add_dependency "faraday", "~> 2.12"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+  spec.add_development_dependency "shoulda", "~> 3.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-profile", "~> 0.5"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

data/lib/bridgetown_directus/api_client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+module BridgetownDirectus
+  class APIClient
+    def initialize(site)
+      @site = site
+      @api_url = site.config.bridgetown_directus.api_url
+      @api_token = site.config.bridgetown_directus.token
+
+      raise StandardError, "Invalid Directus configuration: missing API token or URL" if @api_token.nil? || @api_url.nil?
+    end
+
+    # Main method to fetch posts
+    def fetch_posts
+      Utils.log_directus "Request URL: #{@api_url}"
+      begin
+        response = connection.get("/items/posts") do |req|
+          req.params['filter'] = { status: { _eq: "published" } }.to_json
+        end
+
+        if response.success?
+          JSON.parse(response.body)  # Return the parsed posts
+        elsif response.status == 401
+          raise RuntimeError, "Unauthorized access to Directus API"
+        else
+          raise "Error fetching posts: #{response.status} - #{response.body}"
+        end
+      rescue Faraday::TimeoutError
+        raise Faraday::TimeoutError, "The request to fetch posts timed out"
+      rescue JSON::ParserError
+        raise JSON::ParserError, "The response from Directus was not valid JSON"
+      end
+    end
+
+    # Setup Faraday connection with authorization headers
+    def connection
+      Faraday.new(url: @api_url) do |faraday|
+        faraday.options.timeout = 5           # seconds
+        faraday.options.open_timeout = 2      # seconds
+        faraday.headers['Authorization'] = "Bearer #{@api_token}"
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/bridgetown_directus/builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BridgetownDirectus
+  class Builder < Bridgetown::Builder
+    def build
+      return if site.ssr?
+
+      Utils.log_directus "Connecting to Directus API..."
+      posts_data = fetch_posts
+
+      Utils.log_directus "Fetched #{posts_data.size} posts from Directus."
+
+      create_documents(posts_data)
+    end
+
+    private
+
+    def fetch_posts
+      api_client = BridgetownDirectus::APIClient.new(site)
+      api_client.fetch_posts
+    end
+
+    def create_documents(posts_data)
+      posts_array = posts_data["data"]
+
+      posts_array.each_with_index do |post, index|
+        next unless post["status"] == "published"
+
+        slug = Bridgetown::Utils.slugify(post["slug"] || post["title"])
+        date = post["date"] || Time.now.iso8601
+
+        Utils.log_directus "Generating post #{post['title']}"
+
+        add_resource :posts, "#{slug}.md" do
+          title post["title"]
+          date date
+          content post["body"]
+          layout "post"
+        end
+      end
+
+      Utils.log_directus "Finished generating #{posts_array.size} posts."
+    end
+  end
+end

data/lib/bridgetown_directus/utils.rb

@@ -0,0 +1,9 @@
+# lib/bridgetown_directus/utils.rb
+
+module BridgetownDirectus
+  module Utils
+    def self.log_directus(message)
+      Bridgetown.logger.info("Directus") { message }
+    end
+  end
+end

data/lib/bridgetown_directus/version.rb

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

data/lib/bridgetown_directus.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require_relative "bridgetown_directus/version"
+require_relative "bridgetown_directus/utils"
+require_relative "bridgetown_directus/api_client"
+require_relative "bridgetown_directus/builder"
+
+module BridgetownDirectus
+  # Bridgetown initializer for the plugin
+  Bridgetown.initializer :bridgetown_directus do |config, api_url:, token:|
+    config.bridgetown_directus ||= {}
+    config.bridgetown_directus.api_url ||= api_url || ENV.fetch("DIRECTUS_API_URL")
+    config.bridgetown_directus.token ||= token || ENV.fetch("DIRECTUS_API_TOKEN")
+
+    # Register the builder
+    config.builder BridgetownDirectus::Builder
+
+    # Validate Directus config before proceeding
+    unless config.bridgetown_directus.api_url && config.bridgetown_directus.token
+      Bridgetown.logger.error "Invalid Directus configuration detected. Please check your API URL and token."
+      raise "Directus configuration invalid"
+    end
+  end
+end

data/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "bridgetown_directus",
+  "version": "0.1.0",
+  "main": "frontend/javascript/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/munkun-estudio/bridgetown_directus.git"
+  },
+  "author": "Munkun <development@munkun.com>",
+  "homepage": "https://www.munkun.com",
+  "license": "MIT",
+  "private": false,
+  "files": [
+    "frontend"
+  ]
+}

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown_directus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Munkun
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email: development@munkun.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown.automation.rb
+- bridgetown_directus.gemspec
+- lib/bridgetown_directus.rb
+- lib/bridgetown_directus/api_client.rb
+- lib/bridgetown_directus/builder.rb
+- lib/bridgetown_directus/utils.rb
+- lib/bridgetown_directus/version.rb
+- package.json
+homepage: https://github.com/munkun-estudio/bridgetown_directus
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Use Directus as headless CMS for Bridgetown
+test_files: []