activitypub 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c8cae4b7204912811e11efa38d689ee0cb418c480a7e3240a70a8d4dcafd699
-  data.tar.gz: 4c732f4669c8ed60428d75b45bda5aac7ffa24e439d9fc4f8c733e51241438f3
+  metadata.gz: 56987420fcce47e1c1c7e1244f804a49bd9e83d80d161c63f90af8ad05c0b669
+  data.tar.gz: a80c527aa688521d97671dcfdbcb3eb55d2b35168fb2dcf1bee5c9ef92123d01
 SHA512:
-  metadata.gz: 3f5e26e20e624d3c9ae77f66832e8ed6bee1516c84ec4cc1ef2d24f47b468c2e473ee15e4ecab7e000e910adef998870df26650aa7060753d5430dfb699c8717
-  data.tar.gz: 40cfe87f071e5b8be1e6848f86232523f206e90b8b78c25ad9be0b7aa29c7b72f3da6c64da669edc384424c1e7ea9b4b5f813a15c0b1816ee3360568ec5d40cf
+  metadata.gz: 1e6b1f21ab13dfa05f3d9c44f1b3ccf71cc09b83af207800f99dd1ed1d89876cbd3c123385232652285a0e9227edc762a2f8010050f194930d783d11efa4a929
+  data.tar.gz: 9cfdb2e7f56a4b01dfd46f376adbf40843d28347af49d7f281f7588c7650920f29fc1df0b411b45ee9c867c709e71a87d92d3f7d73cf0b133d1375d98db02308

data/README.md

@@ -1,7 +1,12 @@
 # ActivityPub
 
-*Very* early start on a set of classes to serialize/deserialize
-ActivityPub/ActivityStream objects.
+A Ruby gem to make it easy to retrieve and work with ActivityPub/
+ActivityStreams objects, as used in Mastodon, Lemmy, Pixelfed and
+similar.
+
+CAUTION: This is early days and the API is likely to change quickly.
+If you want to start using this, please follow the project and/or let
+me know.
 
 ## Goals
 
@@ -28,7 +33,10 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: Write usage instructions here.
+
+For now your best bet is to look at the examples/ dir and the unit
+tests.
 
 ## Development
 

data/examples/get_actor.rb

@@ -30,7 +30,7 @@ puts
 
 ob = href.get
 PP.pp(ob)
-puts ob.to_json
+#puts ob.to_json
 puts
 puts "Enter to continue"
 gets
@@ -38,3 +38,17 @@ gets
 puts "Trying to retrieve outbox"
 ob = ob.outbox.get
 PP.pp(ob)
+puts
+puts "Enter to continue"
+gets
+
+puts
+puts "PAGE: #{ob.first}"
+ob = ob.first.get
+PP.pp(ob)
+
+# For now, this will let you iterate through the collection.
+# while ob && ob.orderedItems.length > 0
+#   PP.pp ob.id
+#   ob = ob.next&.get
+# end

data/lib/activitypub/base.rb

@@ -22,6 +22,9 @@ module ActivityPub
 
     ob = klass ? klass.new : nil
 
+    # FIXME: Useful for debug. Add flag to allow enabling.
+    # ob.instance_variable_set("@_raw",h)
+    
     if ob
       context = h.dig("@context")
       ob.instance_variable_set("@_context", context) if context
@@ -38,7 +41,7 @@ module ActivityPub
         end
 
         if t = klass.ap_types[attr]
-          v = t.new(v)
+          v = t.new(v) if v
         end
         ob.instance_variable_set("@#{attr}", v) if !v.nil?
       end

data/lib/activitypub/types.rb

@@ -7,8 +7,13 @@ require_relative 'uri'
 module ActivityPub
 
   class Link < Base
-    ap_attr :href
+    ap_attr :href, URI
+
+    # We don't mark "rel" as a URI as it's effectively
+    # used as an identifier for comparison rather than to
+    # dereference
     ap_attr :rel
+
     ap_attr :mediaType
     ap_attr :name
     ap_attr :hreflang
@@ -29,7 +34,7 @@ module ActivityPub
     ap_attr :generator
     ap_attr :icon
     ap_attr :image
-    ap_attr :inReplyTo
+    ap_attr :inReplyTo, URI
     ap_attr :location
     ap_attr :preview
     ap_attr :published
@@ -38,7 +43,7 @@ module ActivityPub
     ap_attr :summary
     ap_attr :tag
     ap_attr :updated
-    ap_attr :url
+    ap_attr :url, URI
     ap_attr :to
     ap_attr :bto
     ap_attr :cc
@@ -63,9 +68,12 @@ module ActivityPub
   class Collection < Object
     ap_attr :totalItems
     ap_attr :current
-    ap_attr :first
-    ap_attr :last
+    ap_attr :first, URI
+    ap_attr :last, URI
     ap_attr :items
+
+    def each(...) = Array(items).each(...)
+    def map(...) = Array(items).map(...)
   end
 
   class OrderedCollection < Collection
@@ -76,15 +84,24 @@ module ActivityPub
     #
     # FIXME: Review/consider whether to marge orderedItems/items internally.
     ap_attr :orderedItems
+
+    def each(...) = Array(orderedItems).each(...)
+    def map(...) = Array(orderedItems).map(...)
   end
 
   class CollectionPage < Collection
-    ap_attr :partOf
-    ap_attr :next
-    ap_attr :prev
+    ap_attr :partOf, URI
+    ap_attr :next, URI
+    ap_attr :prev, URI
   end
-  
-  class OrderedCollectionPage < CollectionPage
+
+  # FIXME: OrderedCollectionPage inherits both CollectionPage and
+  # OrderedCollection.
+  #
+  class OrderedCollectionPage < OrderedCollection
+    ap_attr :partOf, URI
+    ap_attr :next, URI
+    ap_attr :prev, URI
     ap_attr :startIndex
   end
 

data/lib/activitypub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activitypub
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Vidar Hokstad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webfinger