activitypub 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ca73a9e32bd5ed6fe6fc28cdeeaae31b82d498c433ecc7b814362ab0d55833
-  data.tar.gz: 3843cf8bd348e19771798efe7557ec6e2701e21734e22a784a2340dffe328d9e
+  metadata.gz: bfcd0189a94cb5ee758ef31409bfee306f70f56d6c4a13aca63dd0a26bc41f39
+  data.tar.gz: 5add381a4640f4e6b58748e67d342a105507ea09bea46c1e489dc45d9369362b
 SHA512:
-  metadata.gz: 5c0ddf7fd8672ba4d44b7f3f9b894625a2b279e0bd2c0f867a74a1da45ab462dc04d530dd2430c8ec5065b7c4ce1b4282fa5dc79a1a4a85b04fdb48bdb38148e
-  data.tar.gz: 69ad1655d931018f102e2b8c25cf5e2310803fc3a5ca4fc02a2192e9b0ccfd74cf59cc8891fbacb96c3ee69c17fddf5af594738aaf0a65042a9d950fb77d09f5
+  metadata.gz: 6c966ce54df93f5953e943f2a22b99258ed9549ebd9646020dd3fb8306003ab3e6f7c911d7e98baa8d893abb2ffeee8fcc93af4c0fdbb35c4985280a7d961b1a
+  data.tar.gz: 8bb7a8405035bfac1c09c939c03a200734b60c2c3b7169b5d316c8e1e9fb668a65f5fe603fe5e30550f614e6b97d681da3bc13b188218d3073829d76f5daa289

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/README.md

@@ -1,20 +1,18 @@
-# Activitypub
+# ActivityPub
 
-TODO: Delete this and the text below, and describe your gem
+*Very* early start on a set of classes to serialize/deserialize
+ActivityPub/ActivityStream objects.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activitypub`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add activitypub
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install activitypub
 
 ## Usage
 
@@ -28,7 +26,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activitypub.
+Bug reports and pull requests are welcome on GitHub at https://github.com/vidarh/activitypub.
 
 ## License
 

data/lib/activitypub/base.rb

@@ -0,0 +1,41 @@
+
+module ActivityPub
+
+  # This is not part of ActivityPub, but provides basic mechanisms
+  # for serialization and dezerialisation.
+  #
+  class Base
+    def _context = "https://www.w3.org/ns/activitystreams"
+    def _type = self.class.name.split("::").last
+
+
+    def self.ap_attr(*names)
+      @ap_attributes ||= []
+      @ap_attributes.concat(names)
+      attr_accessor *names
+    end
+
+    def self.ap_attributes
+      parent = superclass.respond_to?(:ap_attributes) ? superclass.ap_attributes : []
+      parent.concat(@ap_attributes||[])
+    end
+
+    def to_h
+      h = {
+        "@context" => _context,
+        "type" => _type,
+      }
+
+      self.class.ap_attributes.each do |attr|
+        val = instance_variable_get("@#{attr}")
+        h[attr.to_s] = val if val
+      end
+
+      h
+    end
+
+    def to_json(...) = to_h.to_json(...)
+  end
+
+
+end

data/lib/activitypub/types.rb

@@ -0,0 +1,216 @@
+
+# https://www.w3.org/TR/activitystreams-vocabulary/
+
+require_relative 'base'
+
+module ActivityPub
+
+  class Link < Base
+    ap_attr :href, :rel, :mediaType, :name, :hreflang, :height, :width, :preview
+  end
+
+  class Object < Base
+    ap_attr :attachment, :attributedTo, :audience, :content, :context,
+      :name, :endTime, :generator, :icon, :image, :inReplyTo, :location,
+      :preview, :published, :replies, :startTime, :summary, :tag, :updated,
+      :url, :to, :bto, :cc, :mediaType, :duration
+  end
+
+  class Activity < Object
+    ap_attr :actor, :object, :target, :result, :origin, :instrument
+  end
+
+  # @FIXME
+  #  All attributes from Activity *except* object.
+  class IntransitiveActivity < Activity
+  end
+
+  class Collection < Object
+    ap_attr :totalItems, :current, :first, :last, :items
+  end
+
+  class OrderedCollection < Collection
+  end
+
+  class CollectionPage < Collection
+    ap_attr :partOf, :next, :prev
+  end
+  
+  class OrderedCollectionPage < CollectionPage
+    ap_attr :startIndex
+  end
+
+  # ## ActivityTypes
+
+  class Accept < Activity
+  end
+
+  class TentativeAccept < Accept
+  end
+
+  class Add < Activity
+  end
+
+  class Arrive < IntransitiveActivity
+  end
+
+  class Create < Activity
+  end
+
+  class Delete < Activity
+  end
+
+  class Follow < Activity
+  end
+
+  class Ignore < Activity
+  end
+
+  class Join < Activity
+  end
+
+  class Leave < Activity
+  end
+
+  class Like < Activity
+  end
+
+  class Offer < Activity
+  end
+
+  class Invite < Offer
+  end
+
+  class Reject < Activity
+  end
+
+  class TentativeReject < Reject
+  end
+
+  class Remove < Activity
+  end
+
+  class Undo < Activity
+  end
+
+  class Update < Activity
+  end
+
+  class View < Activity
+  end
+
+  class Listen < Activity
+  end
+
+  class Move < Activity
+  end
+
+  class Travel < IntransitiveActivity
+  end
+
+  class Announce < Activity
+  end
+
+  class Block < Ignore
+  end
+
+  class Flag < Activity
+  end
+
+  class Dislike < Activity
+  end
+
+  class Question < IntransitiveActivity
+    ap_attr :oneOf, :anyOf, :closed
+  end
+
+  # ## Actor Types
+
+  # NOTE: *NOT* an ActivityPub object type
+  # FIXME: Should probably not be possible to instantiate
+  # directly.
+  #
+  class Actor < Object
+    # Per https://www.w3.org/TR/activitypub/#actors
+    # Section 4.1
+
+    # MUST have:
+    ap_attr :inbox, :outbox
+
+    # SHOULD have:
+    ap_attr :following, :followers
+    
+    # MAY have:
+    ap_attr :liked, :streams, :preferredUsername,
+      :endpoints
+
+
+    # Per https://docs-p.joinmastodon.org/spec/activitypub/#extensions
+    # These are extensions used by Mastodon for Actor types
+    ap_attr :publicKey, :featured, :featuredTags,
+      :discoverable, :suspended
+  end
+
+  # FIXME: Add "toot:Emoji
+  # FIXME: Add PropertyValue
+  
+  class Application < Actor
+  end
+
+  class Group < Actor
+  end
+
+  class Person < Actor
+  end
+
+  class Service < Actor
+  end
+
+  
+  # ## Object types
+
+  class Relationship < Object
+    ap_attr :subject, :object, :relationship
+  end
+
+  class Article < Object
+  end
+
+  class Document < Object
+  end
+
+  class Audio < Document
+  end
+
+  class Image < Document
+    
+    # Mastodon extension per
+    # https://docs-p.joinmastodon.org/spec/activitypub/#extensions
+    ap_attr :focalPoint, :blurhash
+  end
+
+  class Video < Document
+  end
+
+  class Note < Object
+  end
+
+  class Page < Object
+  end
+
+  class Event < Object
+  end
+
+  class Place < Object
+  end
+
+  class Mention < Link
+  end
+
+  class Profile < Object
+  end
+
+  class Tombstone < Object
+    ap_attr :formerType, :deleted
+  end
+end

data/lib/activitypub/version.rb

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

data/lib/activitypub.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "activitypub/version"
+require_relative "activitypub/types"
 
 module ActivityPub
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activitypub
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vidar Hokstad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-01 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -17,10 +17,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/activitypub.rb
+- lib/activitypub/base.rb
+- lib/activitypub/types.rb
 - lib/activitypub/version.rb
 - sig/activitypub.rbs
 homepage: https://github.com/vidarh/activitypub