jekyll-activity-pub 0.1.0rc0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f87949a33817889da8c773551fab8ae3c75ac42e567c620e6b34cfa3c05e1868
+  data.tar.gz: 073be9e99e93d556c3a52c9a6d220b94fad57c122660e35a8a551c0bb8631d4b
+SHA512:
+  metadata.gz: 9b2cf6e7d394f3015c5da1e23cfe74a4abd34ab9dd89fe899bdb101a9877f36c287c7102b90e3a78a04cedbbebc1f514b3e8870f4fe4abf71e92b4f03353d8b9
+  data.tar.gz: 7db09994576428ecb93963737a26b15cc209f18b833f3adf7ab038e57cf2af5383a1c996e7abcf084ff0732d16846fbacec2d0e7ff75abeba5e88e43115add2f

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,6 @@
+# Jekyll ActivityPub
+
+## Immediate goals
+
+* Create an outbox from a Jekyll website
+* Send notifications to [Distributed Press](https://distributed.press/)

data/lib/jekyll/activity_pub/activity.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'jekyll/page'
+require_relative 'helper'
+require_relative 'document'
+
+module Jekyll
+  module ActivityPub
+    # Represents a post on ActivityPub
+    class Activity < Jekyll::Page
+      include Helper
+
+      # @param :doc [Jekyll::Document]
+      attr_reader :doc
+
+      # @param :actor [Jekyll::ActivityPub::Actor]
+      attr_reader :actor
+
+      # Initialize with default data
+      #
+      # @param :site [Jekyll::Site]
+      # @param :actor [Jekyll::ActivityPub::Actor]
+      # @param :doc [Jekyll::Document]
+      # @param :base [String]
+      # @param :dir [String]
+      # @param :name [String]
+      def initialize(site, actor, doc, base = '', dir = '', name = 'index.jsonld')
+        @doc = doc
+        @context = StubContext.new(registers: { site: site })
+        @actor = actor
+
+        super(site, base, dir, name)
+
+        trigger_hooks :post_init
+      end
+
+      # @return [nil]
+      def read_yaml(*)
+        self.data = {
+          '@context' => [
+            'https://www.w3.org/ns/activitystreams',
+            {
+              '@language' => locale,
+              'sensitive' => 'as:sensitive'
+            }
+          ],
+          'type' => 'Note',
+          'id' => absolute_url(doc.url),
+          'summary' => summary,
+          'published' => doc.date.xmlschema,
+          'attributedTo' => absolute_url(actor.url),
+          'to' => [
+            'https://www.w3.org/ns/activitystreams#Public'
+          ],
+          'cc' => [],
+          'inReplyTo' => doc.data['in_reply_to'],
+          'sensitive' => sensitive?,
+          'content' => doc.content,
+          'contentMap' => {
+            locale => doc.content
+          },
+          'attachment' => attachments,
+          'tag' => [],
+          'replies' => []
+        }
+
+        nil
+      end
+
+      private
+
+      # Find summary
+      #
+      # @return [String,nil]
+      def summary
+        @summary ||= find_best_value_for(doc.data, 'summary', 'description', 'title')
+      end
+
+      # Should it have a content warning?
+      def sensitive?
+        !!doc.data.fetch('sensitive', false)
+      end
+
+      # Find attachments
+      #
+      # @return [Array]
+      def attachments
+        @attachments ||= [].tap do |array|
+          case (image = doc.data['image'])
+          when Hash
+            array << Document.new(site, image['path'], image['description'])
+          when String
+            array << Document.new(site, image, summary)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/actor.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'jekyll/page'
+require_relative 'helper'
+require_relative 'image'
+require_relative 'property_value'
+require_relative 'errors'
+require_relative 'notifier'
+
+module Jekyll
+  module ActivityPub
+    # Points to site's author profile
+    class Actor < Jekyll::Page
+      include Helper
+
+      # Initialize with default data
+      #
+      # @param :site [Jekyll::Site]
+      # @param :base [String]
+      # @param :dir [String]
+      # @param :name [String]
+      def initialize(site, base = '', dir = '', name = 'about.jsonld')
+        @context = StubContext.new(registers: { site: site })
+        super
+
+        Notifier.actor_url = data['id']
+
+        trigger_hooks :post_init
+      end
+
+      def read_yaml(*)
+        self.data = {
+          '@context' => [
+            'https://www.w3.org/ns/activitystreams',
+            {
+              '@language' => locale,
+              'schema' => 'http://schema.org#',
+              'PropertyValue' => 'schema:PropertyValue',
+              'value' => 'schema:value'
+            }
+          ],
+          'type' => 'Person',
+          'id' => absolute_url(url),
+          'outbox' => nil,
+          'inbox' => inbox,
+          'following' => nil,
+          'followers' => nil,
+          'preferredUsername' => username,
+          'name' => public_name,
+          'summary' => summary,
+          'icon' => icons,
+          'publicKey' => nil,
+          'attachment' => [
+            PropertyValue.new(website_name, absolute_url(site.config['url']))
+          ]
+        }
+      end
+
+      private
+
+      # Finds public name
+      #
+      # @return [String,nil]
+      def public_name
+        @public_name ||= find_best_value_for(site.config, %w[activity_pub public_name], 'title') || username
+      end
+
+      # Find summary between site tagline or description, reusing fields
+      # that are used on jekyll-seo-tag
+      #
+      # @return [String,nil]
+      def summary
+        @summary ||= find_best_value_for(site.config, %w[activity_pub summary], 'tagline', 'description')
+      end
+
+      # Find icons
+      #
+      # @return [Array]
+      def icons
+        @icons ||= [find_best_value_for(site.config, %w[activity_pub icons], 'logo')].flatten.compact.map do |icon|
+          Image.new(site, icon, summary)
+        end
+      end
+
+      # Finds the website name
+      #
+      # @return [String]
+      def website_name
+        @website_name ||= find_best_value_for(site.config, %w[activity_pub website name]) || 'Website'
+      end
+
+      def strict?
+        true
+      end
+
+      def inbox
+        @inbox ||=
+          site.config.dig('activity_pub', 'url').tap do |inbox|
+            value_is_required! inbox, MissingInboxError
+
+            inbox << '/v1/@'
+            inbox << username
+            inbox << '@'
+            inbox << hostname
+          end
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/cache.rb

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

data/lib/jekyll/activity_pub/commands.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative '../command_extension'
+require_relative '../commands/generate_keys'

data/lib/jekyll/activity_pub/create.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+module Jekyll
+  module ActivityPub
+    # Represents a Create activity
+    class Create
+      include Helper
+
+      attr_reader :data
+
+      # 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)
+        @context = StubContext.new(registers: { site: site })
+
+        @data = {
+          '@context' => 'https://www.w3.org/ns/activitystreams',
+          'type' => 'Create',
+          'actor' => absolute_url(actor.url),
+          'published' => object.data['published'],
+          'to' => [
+            'https://www.w3.org/ns/activitystreams#Public'
+          ],
+          'cc' => [
+            absolute_url(followers.url)
+          ],
+          'object' => absolute_url(object.url),
+          'inReplyTo' => object.data['in_reply_to']
+        }
+
+        trigger_hooks :post_init
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/delete.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ActivityPub
+    # Represents a Delete activity
+    class Delete
+      # 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)
+        @context = StubContext.new(registers: { site: site })
+
+        @data = {
+          '@context' => 'https://www.w3.org/ns/activitystreams',
+          'type' => 'Delete',
+          'actor' => absolute_url(actor.url),
+          'object' => absolute_url(object.url)
+        }
+
+        trigger_hooks :post_init
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/document.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'image'
+
+module Jekyll
+  module ActivityPub
+    # Represents a Document
+    class Document < Image
+      # Initialize with default data
+      #
+      # @param :site [Jekyll::Site]
+      # @param :path [Path]
+      # @param :description [String]
+      def initialize(site, path, description = nil)
+        super
+
+        data['type'] = 'Document'
+
+        trigger_hooks :post_init
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ActivityPub
+    # General error
+    class Error < StandardError; end
+
+    # The public key is missing
+    class MissingPublicKeyError < Error
+      def initialize(msg = 'The public key is missing, please add it to your configuration')
+        super
+      end
+    end
+
+    # The inbox is missing
+    class MissingInboxError < Error
+      def initialize(msg = 'The inbox is missing, please add it to your configuration')
+        super
+      end
+    end
+
+    # Notification error
+    class NotificationError < Error; end
+  end
+end

data/lib/jekyll/activity_pub/followers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'ordered_collection'
+
+module Jekyll
+  module ActivityPub
+    # An empty collection of followers
+    class Followers < OrderedCollection
+      # 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 = '', name = 'followers.jsonld')
+        super(site, base, dir, name)
+
+        actor.data['followers'] = absolute_url(url)
+
+        trigger_hooks :post_init
+      end
+    end
+  end
+end

data/lib/jekyll/activity_pub/following.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'ordered_collection'
+
+module Jekyll
+  module ActivityPub
+    # An empty collection of followed actors
+    class Following < OrderedCollection
+      # 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 = '', name = 'following.jsonld')
+        super(site, base, dir, name)
+
+        actor.data['following'] = absolute_url(url)
+
+        trigger_hooks :post_init
+      end
+    end
+  end
+end