jekyll-activity-pub 0.1.0rc12 → 0.1.0rc14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52d19e3cacf79bb7a5c041ae37b4caae232947f50fc94eb7b269edebe37a15b7
-  data.tar.gz: 976bf99864bc71f49bec91090de41b4ddb829cfc296ba0addaa7dc43400daddd
+  metadata.gz: aaea38dc037b09e85e37555dfcf89e0f974107a0699a600d9c2f8f5f031f6a72
+  data.tar.gz: fef291e74969a128d2ed950ea9a0f2fda5fc93b5fc45fa851ea8b6f07d15aed9
 SHA512:
-  metadata.gz: abfa3e386181380e62a2223b64c3201f5b3751921f669c4129e637959c0600c8fa529f8ce929540a51c975154f7a5c007e4d39522561e1c05ce82ff1eda7bce5
-  data.tar.gz: 98bb2c9fcec4955dc7b79582421fca47d6d50008bce879a821e5d3d2dc4c800901566230dc402ec1ea03f173c1ce1457d2c3c6751a5f8b9991b16c329edd7604
+  metadata.gz: e27745239477eef2a66b1d0dee32af27b4e58219d381e5720abf0d158a38ea31a3e113a9b812b40b4faadbfed48925e0e242c7012d9c4cd428fd725e77f18f07
+  data.tar.gz: ee3dff54f5c6f549286bc3009063d99513a2d2fc73ffaec6d188f9988866d1c15135dc8662ca0cc1a4b9d9dfc4891546a9391bec7e579ef88481e4f6e6f64176

data/README.md

@@ -1,6 +1,36 @@
 # Jekyll ActivityPub
 
-## Immediate goals
+Generates an [ActivityPub](https://www.w3.org/TR/activitypub/)
+representation of your site and delegates notifications and followers to
+the [Distributed Press](https://distributed.press) Social Inbox.
 
-* Create an outbox from a Jekyll website
-* Send notifications to [Distributed Press](https://distributed.press/)
+## Installation and Usage
+
+See _docs/
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies.
+
+To release a new version, update the version number in
+`jekyll-activity-pub.gemspec`, and then run `go-task release`, which
+will push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on 0xacab.org at
+<https://0xacab.org/sutty/jekyll/jekyll-activity-pub>. This
+project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Sutty code of
+conduct](https://sutty.nl/en/code-of-conduct/).
+
+## License
+
+The gem is available as free software under the terms of the Apache2
+License.
+
+## Code of Conduct
+
+Everyone interacting in the jekyll-activity-pub project’s
+codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://sutty.nl/en/code-of-conduct/).

data/lib/jekyll/activity_pub/activity.rb

@@ -54,10 +54,11 @@ module Jekyll
           'to' => [
             'https://www.w3.org/ns/activitystreams#Public'
           ],
-          'cc' => [ Notifier.followers_url ],
+          'cc' => [Notifier.followers_url],
           'inReplyTo' => doc.data['in_reply_to'],
           'sensitive' => sensitive?,
           'content' => doc.content,
+          'name' => doc.data['title'],
           'contentMap' => {
             locale => doc.content
           },
@@ -75,7 +76,7 @@ module Jekyll
       #
       # @return [String,nil]
       def summary
-        @summary ||= find_best_value_for(doc.data, 'summary', 'description', 'title')
+        @summary ||= doc.data.slice('title', 'summary').values.join(separator)
       end
 
       # Should it have a content warning?
@@ -83,6 +84,13 @@ module Jekyll
         !!doc.data.fetch('sensitive', false)
       end
 
+      # Separator to join title and summary by
+      #
+      # @return [String]
+      def separator
+        @separator ||= site.config.dig('activity_pub', 'separator') || ' // '
+      end
+
       # Find attachments
       #
       # @return [Array]

data/lib/jekyll/activity_pub/actor.rb

@@ -46,6 +46,7 @@ module Jekyll
           ],
           'type' => 'Person',
           'id' => absolute_url(url),
+          'url' => site.config['url'],
           'outbox' => nil,
           'inbox' => inbox,
           'following' => nil,
@@ -53,16 +54,29 @@ module Jekyll
           'preferredUsername' => username,
           'name' => public_name,
           'summary' => summary,
-          'icon' => icons,
+          'icon' => icons.first,
+          'image' => images.first,
           'publicKey' => nil,
+          'published' => date.xmlschema,
+          'updated' => updated.xmlschema,
           'attachment' => [
-            PropertyValue.new(website_name, absolute_url(site.config['url']))
+            PropertyValue.new(website_name, website_link)
           ]
         }
       end
 
+      # @return [Time]
+      def date
+        @date ||= site.config.dig('activity_pub', 'published') || site.time
+      end
+
       private
 
+      # @return [Time]
+      def updated
+        @updated ||= site.config.dig('activity_pub', 'updated') || site.time
+      end
+
       # Finds public name
       #
       # @return [String,nil]
@@ -110,6 +124,24 @@ module Jekyll
             inbox << '/inbox'
           end
       end
+
+      # Find images
+      #
+      # @return [Array]
+      def images
+        @images ||= [find_best_value_for(site.config, %w[activity_pub images],
+                                         %w[image path])].flatten.compact.map do |icon|
+          Image.new(site, icon, summary)
+        end
+      end
+
+      # @return [String]
+      def website_link
+        @website_link ||=
+          <<~LINK
+            <a rel="me" href="#{site.config['url']}">#{site.config['url']}</a>
+          LINK
+      end
     end
   end
 end

data/lib/jekyll/activity_pub/delete.rb

@@ -23,7 +23,7 @@ module Jekyll
           'id' => absolute_url(object.url).sub('.jsonld', '/delete.jsonld'),
           'type' => 'Delete',
           'actor' => absolute_url(actor.url),
-          'object' => absolute_url(object.url)
+          'object' => object.data['id']
         }
 
         trigger_hooks :post_init

data/lib/jekyll/activity_pub/helper.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'forwardable'
 require 'jekyll/hooks'
 
 module Jekyll
@@ -7,6 +8,10 @@ module Jekyll
     # Container for common tools
     module Helper
       include Jekyll::Filters::URLFilters
+      extend Forwardable
+
+      # So we can deep dig between linked objects
+      def_delegators :data, :dig
 
       # Some filters needs a Liquid-like context
       StubContext = Struct.new(:registers, keyword_init: true)

data/lib/jekyll/activity_pub/image.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'marcel'
+require 'pathname'
 require_relative 'helper'
 
 module Jekyll
@@ -20,7 +22,7 @@ module Jekyll
 
         @data = {
           'type' => 'Image',
-          'mediaType' => "image/#{File.extname(path).sub('.', '')}",
+          'mediaType' => Marcel::MimeType.for(Pathname.new(site.in_source_dir(path))),
           'url' => absolute_url(path),
           'name' => description.to_s
         }

data/lib/jekyll/activity_pub/notifier.rb

@@ -22,6 +22,12 @@ module Jekyll
           site.in_dest_dir(relative_path)
         end
 
+        def date
+          @date ||= Time.parse(data['published'])
+        rescue StandardError
+          nil
+        end
+
         # @return [Time, nil]
         def updated_at
           @updated_at ||= Time.parse(data['updated'])
@@ -47,14 +53,20 @@ module Jekyll
           @@site
         end
 
+        def url
+          config['url'].tap do |u|
+            abort_if_missing('activity_pub.url', u, '_config.yml')
+          end
+        end
+
         # @return [String]
         def followers_url
-          "#{config['url']}/v1/#{actor}/followers"
+          "#{url}/v1/#{actor}/followers"
         end
 
         # @return [String]
         def following_url
-          "#{config['url']}/v1/#{actor}/following"
+          "#{url}/v1/#{actor}/following"
         end
 
         # Save the public key URL for later
@@ -64,11 +76,13 @@ module Jekyll
           data['public_key_url'] = url
         end
 
-        # Public key URL
+        # Public key URL, raises error if missing
         #
-        # @return [String,nil]
+        # @return [String]
         def public_key_url
-          data['public_key_url']
+          data['public_key_url'].tap do |pk|
+            abort_if_missing('public_key_url', pk)
+          end
         end
 
         def actor=(actor)
@@ -76,7 +90,9 @@ module Jekyll
         end
 
         def actor
-          data['actor']
+          data['actor'].tap do |a|
+            abort_if_missing('actor', a)
+          end
         end
 
         def actor_url=(url)
@@ -84,7 +100,9 @@ module Jekyll
         end
 
         def actor_url
-          data['actor_url']
+          data['actor_url'].tap do |au|
+            abort_if_missing('actor_url', au)
+          end
         end
 
         # Send notifications
@@ -107,7 +125,7 @@ module Jekyll
 
           base_endpoint = "/v1/#{actor}"
           outbox_endpoint = "#{base_endpoint}/outbox"
-          actor_object = PseudoObject.new(url: actor_url)
+          actor_object = object_for(site.in_dest_dir(actor_url.sub(site.config['url'], '')))
           # TODO: Move to API client
           inbox_body = {
             'actorUrl' => actor_url,
@@ -130,13 +148,20 @@ module Jekyll
             process_object(outbox_endpoint, actor_object, object_for(object_url), status)
           end
 
+          # Update actor profile
+          if actor_object.updated_at > actor_object.date
+            Jekyll.logger.debug 'ActivityPub:', 'Updating Actor profile'
+            actor_update = Jekyll::ActivityPub::Update.new(site, actor_object, actor_object)
+
+            unless (response = client.post(endpoint: outbox_endpoint, body: actor_update)).ok?
+              raise NotificationError, "Couldn't update actor (#{response.code}: #{response.message})"
+            end
+          end
+
           # Store everything for later
           save
-        end
-
-        # @return [Jekyll::Site]
-        def site
-          @@site
+        rescue NotificationError => e
+          Jekyll.logger.abort_with 'ActivityPub:', e.message
         end
 
         # Return data
@@ -159,12 +184,12 @@ module Jekyll
         #
         # @param :path [String]
         # @return [nil]
-        def update(path)
+        def update(path, **opts)
           # Compare Unix timestamps
           if created?(path) && (object_for(path)&.updated_at&.to_i || 0) > (status(path)['updated_at'] || 0)
-            action(path, 'update')
+            action(path, 'update', **opts)
           else
-            create(path)
+            create(path, **opts)
           end
 
           nil
@@ -174,8 +199,8 @@ module Jekyll
         #
         # @param :path [String]
         # @return [nil]
-        def create(path)
-          action(path, 'create') unless created?(path)
+        def create(path, **opts)
+          action(path, 'create', **opts) unless created?(path)
 
           nil
         end
@@ -201,21 +226,21 @@ module Jekyll
         #
         # @param :path [String]
         def created?(path)
-          !(status(path)['created_at'].nil?)
+          !status(path)['created_at'].nil?
         end
 
         # @param :path [String]
         def updated?(path)
-          !(status(path)['updated_at'].nil?)
+          !status(path)['updated_at'].nil?
         end
 
         # @param :path [String]
         def deleted?(path)
-          !(status(path)['deleted_at'].nil?)
+          !status(path)['deleted_at'].nil?
         end
 
         def exist?(path)
-          !(status(path)['action'].nil?)
+          !status(path)['action'].nil?
         end
 
         # Stores data back to a file and optionally commits it
@@ -263,7 +288,9 @@ module Jekyll
         #
         # @return [String, nil]
         def private_key_path
-          @@private_key_path ||= site.config['activity_pub_private_key']
+          @@private_key_path ||= site.config['activity_pub_private_key'].tap do |pk|
+            abort_if_missing '--key', pk, 'notify command'
+          end
         end
 
         # Returns the private key
@@ -272,8 +299,7 @@ module Jekyll
         def private_key
           @@private_key ||= File.read private_key_path
         rescue StandardError
-          Jekyll.logger.warn 'ActivityPub:', 'There\'s an issue with your private key'
-          raise
+          Jekyll.logger.abort_with 'ActivityPub:', 'There\'s an issue with your private key'
         end
 
         # @return [Hash]
@@ -284,7 +310,7 @@ module Jekyll
         def client
           @@client ||= DistributedPress::V1::Social::Client.new(
             private_key_pem: private_key,
-            url: config['url'],
+            url: url,
             public_key_url: public_key_url,
             logger: Jekyll.logger
           )
@@ -294,12 +320,15 @@ module Jekyll
         #
         # @param :path [String]
         # @param :action [String]
-        # @return [Hash]
-        def action(path, action)
+        # @return [nil]
+        def action(path, action, **opts)
           path = path_relative_to_dest(path)
 
           data['notifications'][path] ||= {}
           data['notifications'][path]['action'] = action.to_s
+          data['notifications'][path].merge! opts.transform_keys(&:to_s)
+
+          nil
         end
 
         # Paths are relative to site destination
@@ -342,10 +371,17 @@ module Jekyll
               rel  = path_relative_to_dest(path)
               path = site.in_dest_dir(rel)
               data = JSON.parse(File.read(path)) if File.exist? path
+              data ||= { 'id' => status(path)['id'] }
 
-              PseudoObject.new(url: rel, site: site, relative_path: rel, data: data || {})
+              PseudoObject.new(url: rel, site: site, relative_path: rel, data: data)
             end
         end
+
+        def abort_if_missing(key_name, value, file = '_data/activity_pub.yml')
+          return unless value.nil? || value.empty?
+
+          Jekyll.logger.abort_with 'ActivityPub:', "Missing #{key_name} in #{file}"
+        end
       end
     end
   end

data/lib/jekyll/activity_pub/webfinger.rb

@@ -37,9 +37,23 @@ module Jekyll
               'rel' => 'self',
               'type' => 'application/activity+json',
               'href' => absolute_url(@actor.url)
+            },
+            {
+              'rel' => 'http://webfinger.net/rel/profile-page',
+              'type' => 'text/html',
+              'href' => site.config['url']
             }
           ]
-        }
+        }.tap do |data|
+          next unless @actor.data['icon']
+
+          data['links'] <<
+            {
+              'rel' => 'http://webfinger.net/rel/avatar',
+              'type' => @actor.data.dig('icon', 'mediaType'),
+              'href' => @actor.data.dig('icon', 'url')
+            }
+        end
       end
 
       # The webfinger file is expected to be at this location always

data/lib/jekyll/command_extension.rb

@@ -10,6 +10,12 @@ module Jekyll
     def add_build_options(cmd)
       super
 
+      activity_pub_private_key(cmd)
+    end
+
+    private
+
+    def activity_pub_private_key(cmd)
       cmd.option 'activity_pub_private_key', '--key path/to/rsa.pem', String, 'Path to RSA private key in PEM format'
     end
   end

data/lib/jekyll/commands/generate_keys.rb

@@ -6,14 +6,14 @@ require 'distributed_press/v1/social/client'
 module Jekyll
   module Commands
     # Send Activity Pub notifications
-    class Notify < Jekyll::Command
+    class GenerateKeys < 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)
+            activity_pub_private_key c
 
             c.option 'activity_pub_key_size', '--key-size 2048', Integer, 'RSA key size (2048 by default)'
 
@@ -34,7 +34,6 @@ module Jekyll
             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|

data/lib/jekyll-activity-pub.rb

@@ -77,7 +77,11 @@ Jekyll::Hooks.register(:documents, :post_convert, priority: :high) do |doc|
       end
 
     create_or_update.new(site, actor, activity).tap do |action|
-      Jekyll::ActivityPub::Notifier.public_send action.data['type'].downcase.to_sym, activity.destination(site.dest)
+      method = action.data['type'].downcase.to_sym
+      path = activity.destination(site.dest)
+      id = activity.data['id']
+
+      Jekyll::ActivityPub::Notifier.public_send(method, path, id: id)
 
       outbox.data['totalItems'] += 1
       outbox.data['orderedItems'] << action

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-activity-pub
 version: !ruby/object:Gem::Version
-  version: 0.1.0rc12
+  version: 0.1.0rc14
 platform: ruby
 authors:
 - Sutty
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: distributed-press-api-client
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +143,6 @@ files:
 - 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
@@ -144,7 +157,6 @@ files:
 - lib/jekyll/activity_pub/outbox.rb
 - lib/jekyll/activity_pub/property_value.rb
 - lib/jekyll/activity_pub/public_key.rb
-- lib/jekyll/activity_pub/tomsbtone.rb
 - lib/jekyll/activity_pub/update.rb
 - lib/jekyll/activity_pub/webfinger.rb
 - lib/jekyll/command_extension.rb

data/lib/jekyll/activity_pub/cache.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'jekyll/cache'
-
-module Jekyll
-  module ActivityPub
-    class Cache < Jekyll::Cache
-    end
-  end
-end

data/lib/jekyll/activity_pub/tomsbtone.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require 'jekyll/page'
-require_relative 'helper'
-
-module Jekyll
-  module ActivityPub
-    # Represents a removed activity
-    class Tombstone < Jekyll::Page
-      include Helper
-
-      # @param :object_id [String]
-      attr_reader :object_id
-
-      # Initialize with default data
-      #
-      # @param :site [Jekyll::Site]
-      # @param :object_id [String]
-      def initialize(site, object_id, )
-        @context = StubContext.new(registers: { site: site })
-        @object_id = object_id
-
-        dest = Pathname.new(object.destination(site.dest)).relative_path_from(site.dest)
-        name = 'tombstone.jsonld'
-        dir = File.join(
-          File.dirname(dest),
-          File.basename(dest, '.jsonld')
-        )
-
-        super(site, '', dir, name)
-
-        trigger_hooks :post_init
-      end
-
-      def read_yaml(*)
-        @data = {
-          '@context' => 'https://www.w3.org/ns/activitystreams',
-          'type' => 'Tomsbtone',
-          'id' => absolute_url(object_id),
-          'published' => object.data[DATE_ATTRIBUTE],
-          'to' => object.data['to'],
-          'cc' => object.data['cc'],
-          'object' => object.data,
-          'inReplyTo' => object.data['in_reply_to']
-        }
-      end
-
-      # @return [Time]
-      def date
-        @date ||= Time.parse(object.data[DATE_ATTRIBUTE])
-      end
-
-      private
-
-      def type
-        @type ||= self.class.name.split('::').last
-      end
-    end
-  end
-end
-