jekyll-activity-pub 0.1.0rc0

data/lib/jekyll/activity_pub/property_value.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+module Jekyll
+  module ActivityPub
+    # A Key:Value map
+    class PropertyValue
+      include Helper
+
+      attr_reader :data
+
+      # @param :name [String]
+      # @param :value [String]
+      def initialize(name, value)
+        @data = {
+          'type' => 'PropertyValue',
+          'name' => name.to_s,
+          'value' => value.to_s
+        }
+
+        trigger_hooks :post_init
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/public_key.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'jekyll/page'
+require_relative 'helper'
+require_relative 'notifier'
+
+module Jekyll
+  module ActivityPub
+    # Public key
+    class PublicKey < Jekyll::Page
+      include Helper
+
+      # Initialize with default data
+      #
+      # @param :site [Jekyll::Site]
+      # @param :actor [Jekyll::ActivityPub::Actor]
+      # @param :public_key [OpenSsl::Pkey::RSA]
+      # @param :base [String]
+      # @param :dir [String]
+      # @param :name [String]
+      def initialize(site, actor, public_key, base = '', dir = '', name = 'pubkey.pem')
+        @context = StubContext.new(registers: { site: site })
+        @actor = actor
+        @public_key = public_key
+
+        super(site, base, dir, name)
+
+        actor.data['publicKey'] = self
+
+        Notifier.public_key_url = absolute_url(url)
+
+        trigger_hooks :post_init
+      end
+
+      def read_yaml(*)
+        self.data = {
+          '@context' => 'https://w3id.org/security/v1',
+          '@type' => 'Key',
+          'id' => absolute_url(url),
+          'owner' => absolute_url(@actor.url),
+          'publicKeyPem' => @public_key.public_to_pem
+        }
+      end
+
+      def content
+        data['publicKeyPem']
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/update.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'create'
+
+module Jekyll
+  module ActivityPub
+    # Represents an Update activity
+    class Update < Create
+      # Initialize with default data
+      #
+      # @param :site [Jekyll::Site]
+      # @param :actor [Jekyll::ActivityPub::Actor]
+      # @param :followers [Jekyll::ActivityPub::Followers]
+      # @param :object [Jekyll::ActivityPub::Activity]
+      def initialize(site, actor, followers, object)
+        super
+
+        data['type'] = 'Update'
+
+        trigger_hooks :post_init
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/webfinger.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'jekyll/page'
+require_relative 'helper'
+require_relative 'notifier'
+
+module Jekyll
+  module ActivityPub
+    # Points to site's author
+    class WebFinger < Jekyll::Page
+      include Helper
+
+      # Initialize with default data
+      #
+      # @param :site [Jekyll::Site]
+      # @param :actor [Jekyll::ActivityPub::Actor]
+      # @param :base [String]
+      # @param :dir [String]
+      # @param :name [String]
+      def initialize(site, actor, base = '', dir = '.well-known', name = 'webfinger')
+        @context = StubContext.new(registers: { site: site })
+        @actor = actor
+
+        super(site, base, dir, name)
+
+        Notifier.actor = "@#{username}@#{hostname}"
+
+        # Set the actor profile in yet another format (no leading @)
+        site.config['activity_pub_profile'] = "#{username}@#{hostname}"
+
+        trigger_hooks :post_init
+      end
+
+      def read_yaml(*)
+        self.data = {
+          'subject' => "acct:#{username}@#{hostname}",
+          'aliases' => [],
+          'links' => [
+            {
+              'rel' => 'self',
+              'type' => 'application/activity+json',
+              'href' => absolute_url(@actor.url)
+            }
+          ]
+        }
+      end
+
+      # The webfinger file is expected to be at this location always
+      #
+      # @return [String]
+      def permalink
+        '.well-known/webfinger'
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'activity_pub/webfinger'
+require_relative 'activity_pub/actor'
+require_relative 'activity_pub/activity'
+require_relative 'activity_pub/outbox'
+require_relative 'activity_pub/followers'
+require_relative 'activity_pub/following'
+require_relative 'activity_pub/host_meta'
+require_relative 'activity_pub/create'
+require_relative 'activity_pub/update'
+require_relative 'activity_pub/public_key'
+
+module Jekyll
+  # ActivityPub
+  module ActivityPub
+  end
+end

data/lib/jekyll/command_extension.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'jekyll/command'
+
+module Jekyll
+  # Extends Jekyll::Command to provide a private key to any command with
+  # build steps.
+  module CommandExtension
+    # Add private key option
+    def add_build_options(cmd)
+      super
+
+      cmd.option 'activity_pub_private_key', '--key path/to/rsa.pem', String, 'Path to RSA private key in PEM format'
+    end
+  end
+end
+
+Jekyll::Command.singleton_class.prepend Jekyll::CommandExtension

data/lib/jekyll/commands/generate_keys.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'distributed_press/v1/social/client'
+
+module Jekyll
+  module Commands
+    # Send Activity Pub notifications
+    class Notify < Jekyll::Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:generate_keys) do |c|
+            c.syntax      'generate_keys --key-size 2048 --key path/to/privkey.pem'
+            c.description 'Generate an RSA keypair for ActivityPub'
+
+            add_build_options(c)
+
+            c.option 'activity_pub_key_size', '--key-size 2048', Integer, 'RSA key size (2048 by default)'
+
+            c.action do |_, options|
+              process_with_graceful_fail(c, options, self)
+            end
+          end
+        end
+
+        def process(options)
+          # Adjust verbosity quickly
+          Jekyll.logger.adjust_verbosity(options)
+
+          private_key_path = options['activity_pub_private_key'] || 'privkey.pem'
+          key_size = options['activity_pub_key_size'] || 2048
+
+          if File.exist? private_key_path
+            raise Jekyll::Errors::FatalException, "Private key already exists: #{private_key_path}"
+          end
+
+          options = configuration_from_options(options)
+          client = DistributedPress::V1::Social::Client.new(public_key_url: nil, key_size: key_size)
+
+          File.open(private_key_path, 'w') do |f|
+            f.write client.private_key.export
+          rescue StandardError
+            FileUtils.rm_f(private_key_path)
+            raise
+          end
+
+          Jekyll.logger.info 'ActivityPub:', "Private key written to #{private_key_path}"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/notify.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require_relative '../activity_pub/notifier'
+
+module Jekyll
+  module Commands
+    # Send Activity Pub notifications
+    class Notify < Jekyll::Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:notify) do |c|
+            c.syntax      'notify'
+            c.description 'Send ActivityPub notifications'
+
+            add_build_options(c)
+
+            c.action do |_, options|
+              process_with_graceful_fail(c, options, self)
+            end
+          end
+        end
+
+        # Send notifications
+        #
+        # @params :options [Hash]
+        def process(options)
+          # Adjust verbosity quickly
+          Jekyll.logger.adjust_verbosity(options)
+
+          options = configuration_from_options(options)
+          site = Jekyll::Site.new(options)
+
+          # Retrocompatibility
+          if site.reader.respond_to? :read_data
+            site.reader.read_data
+          else
+            site.data = DataReader.new(site).read(site.config['data_dir'])
+          end
+
+          Jekyll::ActivityPub::Notifier.site = site
+          Jekyll::ActivityPub::Notifier.notify!
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-activity-pub.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'distributed_press/v1/social/client'
+
+require_relative 'jekyll/activity_pub'
+require_relative 'jekyll/activity_pub/notifier'
+
+# Generate Actor and WebFinger pages
+Jekyll::Hooks.register :site, :post_read, priority: :low do |site|
+  Jekyll::ActivityPub::Notifier.site = site
+
+  # Private key is mandatory during build, so any errors should stop the
+  # build instead of logging a warning.
+  begin
+    private_key = File.read(site.config['activity_pub_private_key'])
+  rescue StandardError
+    Jekyll.logger.warn 'ActivityPub:', 'There\'s an issue with your private key'
+
+    raise
+  end
+
+  # We only need the public key at this point
+  client = DistributedPress::V1::Social::Client.new(public_key_url: nil, private_key_pem: private_key)
+
+  site.pages << site.config['actor'] = actor = Jekyll::ActivityPub::Actor.new(site)
+  site.pages << site.config['public_key'] = Jekyll::ActivityPub::PublicKey.new(site, actor, client.public_key)
+  site.pages << site.config['webfinger'] = webfinger = Jekyll::ActivityPub::WebFinger.new(site, actor)
+  site.pages << site.config['outbox'] = Jekyll::ActivityPub::Outbox.new(site, actor)
+  site.pages << site.config['host-meta'] = Jekyll::ActivityPub::HostMeta.new(site, webfinger)
+  site.pages << Jekyll::ActivityPub::Following.new(site, actor)
+  site.pages << site.config['followers'] = Jekyll::ActivityPub::Followers.new(site, actor)
+
+  # Add Actor to home page
+  home = site.pages.find do |page|
+    page.url == '/'
+  end
+
+  if home
+    Jekyll.logger.info 'ActivityPub:', 'Adding Actor to home page'
+    home.data['activity'] = actor
+  end
+end
+
+# Generate an activity for each document after the content has been
+# rendered as HTML.
+Jekyll::Hooks.register(:documents, :post_convert, priority: :high) do |doc|
+  next unless doc.write?
+  next if doc.data['sitemap'] == false
+  next if doc.data['activity'] == false
+
+  site = doc.site
+  dir = File.dirname(doc.url)
+  name = "#{File.basename(doc.url, '.html')}.jsonld"
+  actor = site.config['actor']
+  outbox = site.config['outbox']
+  followers = site.config['followers']
+
+  Jekyll::ActivityPub::Activity.new(site, actor, doc, nil, dir, name).tap do |activity|
+    doc.data['activity'] = activity
+
+    created_at = doc.data['created_at'] || doc.date
+    updated_at = doc.data['last_modified_at'] || doc.date
+
+    create_or_update =
+      if updated_at > created_at
+        Jekyll::ActivityPub::Update
+      else
+        Jekyll::ActivityPub::Create
+      end
+
+    create_or_update.new(site, actor, followers, activity).tap do |action|
+      Jekyll::ActivityPub::Notifier.public_send action.data['type'].downcase.to_sym, activity.destination(site.dest)
+
+      outbox.data['totalItems'] += 1
+      outbox.data['orderedItems'] << action
+    end
+
+    site.pages << activity
+  end
+end
+
+# This hook is shit because we don't have access to the site!
+Jekyll::Hooks.register(:clean, :on_obsolete, priority: :low) do |list|
+  list.each do |path|
+    Jekyll::ActivityPub::Notifier.delete path
+  end
+end
+
+# Store data generated between builds and commits if
+# jekyll-write-and-commit-changes is enabled.
+Jekyll::Hooks.register(:site, :post_write, priority: :low) do |_|
+  Jekyll::ActivityPub::Notifier.save
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-activity-pub
+version: !ruby/object:Gem::Version
+  version: 0.1.0rc0
+platform: ruby
+authors:
+- Sutty
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: distributed-press-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0rc0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0rc0
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec-tap-formatters
+  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: rubocop
+  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: yard
+  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:
+- sutty@riseup.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-activity-pub.rb
+- lib/jekyll/activity_pub.rb
+- lib/jekyll/activity_pub/activity.rb
+- lib/jekyll/activity_pub/actor.rb
+- lib/jekyll/activity_pub/cache.rb
+- lib/jekyll/activity_pub/commands.rb
+- lib/jekyll/activity_pub/create.rb
+- lib/jekyll/activity_pub/delete.rb
+- lib/jekyll/activity_pub/document.rb
+- lib/jekyll/activity_pub/errors.rb
+- lib/jekyll/activity_pub/followers.rb
+- lib/jekyll/activity_pub/following.rb
+- lib/jekyll/activity_pub/helper.rb
+- lib/jekyll/activity_pub/host_meta.rb
+- lib/jekyll/activity_pub/image.rb
+- lib/jekyll/activity_pub/notifier.rb
+- lib/jekyll/activity_pub/ordered_collection.rb
+- lib/jekyll/activity_pub/ordered_collection_page.rb
+- lib/jekyll/activity_pub/outbox.rb
+- lib/jekyll/activity_pub/property_value.rb
+- lib/jekyll/activity_pub/public_key.rb
+- lib/jekyll/activity_pub/update.rb
+- lib/jekyll/activity_pub/webfinger.rb
+- lib/jekyll/command_extension.rb
+- lib/jekyll/commands/generate_keys.rb
+- lib/jekyll/commands/notify.rb
+homepage: https://0xacab.org/sutty/jekyll/jekyll-activity-pub
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://0xacab.org/sutty/jekyll/jekyll-activity-pub/issues
+  homepage_uri: https://0xacab.org/sutty/jekyll/jekyll-activity-pub
+  source_code_uri: https://0xacab.org/sutty/jekyll/jekyll-activity-pub
+  changelog_uri: https://0xacab.org/sutty/jekyll/jekyll-activity-pub/-/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/jekyll-activity-pub
+post_install_message:
+rdoc_options:
+- "--title"
+- jekyll-activity-pub - ActivityPub support for Jekyll
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: ActivityPub support for Jekyll
+test_files: []