a/activitypub
Archived
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Restructured the Tombstone object to be stand-alone

Browse source 
Moved functionality to its own file
This commit is contained in:
Marius Orcsik 2019-12-03 13:50:03 +01:00
parent 921185b572
commit 52e8c9c266
No known key found for this signature in database
GPG key ID: 889CE8E4FB2D877A
5 changed files with 258 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
object.go
View file

@ -601,17 +601,6 @@ type (
Video = Document
)
// Tombstone a Tombstone represents a content object that has been deleted.
// It can be used in Collections to signify that there used to be an object at this position,
// but it has been deleted.
type Tombstone struct {
Parent
// FormerType On a Tombstone object, the formerType property identifies the type of the object that was deleted.
FormerType ActivityVocabularyType `jsonld:"formerType,omitempty"`
// Deleted On a Tombstone object, the deleted property is a timestamp for when the object was deleted.
Deleted time.Time `jsonld:"deleted,omitempty"`
}
// ItemCollectionDeduplication normalizes the received arguments lists into a single unified one
func ItemCollectionDeduplication(recCols ...*ItemCollection) (ItemCollection, error) {
rec := make(ItemCollection, 0)
@ -667,21 +656,6 @@ func (c *MimeType) UnmarshalJSON(data []byte) error {
return nil
}
// ToTombstone
func ToTombstone(it Item) (*Tombstone, error) {
switch i := it.(type) {
case *Tombstone:
return i, nil
case Tombstone:
return &i, nil
case *Object:
return &Tombstone{Parent: *i}, nil
case Object:
return &Tombstone{Parent: i}, nil
}
return nil, fmt.Errorf("unable to convert %q", it.GetType())
}
// ToObject
func ToObject(it Item) (*Object, error) {
switch i := it.(type) {
@ -702,9 +676,9 @@ func ToObject(it Item) (*Object, error) {
case Relationship:
return (*Object)(unsafe.Pointer(&i)), nil
case *Tombstone:
return &i.Parent, nil
return (*Object)(unsafe.Pointer(i)), nil
case Tombstone:
return &i.Parent, nil
return (*Object)(unsafe.Pointer(&i)), nil
case *Activity:
return &i.Parent, nil
case Activity:
@ -758,24 +732,3 @@ func FlattenProperties(it Item) Item {
}
return it
}
// UnmarshalJSON
func (t *Tombstone) UnmarshalJSON(data []byte) error {
t.Parent.UnmarshalJSON(data)
t.FormerType = ActivityVocabularyType(JSONGetString(data, "formerType"))
t.Deleted = JSONGetTime(data, "deleted")
return nil
}
// Recipients performs recipient de-duplication on the Tombstone object's To, Bto, CC and BCC properties
func (t *Tombstone) Recipients() ItemCollection {
var aud ItemCollection
rec, _ := ItemCollectionDeduplication(&aud, &t.To, &t.Bto, &t.CC, &t.BCC, &t.Audience)
return rec
}
// Clean removes Bto and BCC properties
func (t *Tombstone) Clean(){
t.BCC = nil
t.Bto = nil
}

4
object_test.go
View file

@ -901,10 +901,6 @@ func TestFlattenProperties(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_UnmarshalJSON(t *testing.T) {
t.Skipf("TODO")
}
func TestToTombstone(t *testing.T) {
t.Skipf("TODO")
}

220
tombstone.go Normal file
View file

@ -0,0 +1,220 @@
package activitystreams
import (
"fmt"
"time"
"unsafe"
)
// Tombstone a Tombstone represents a content object that has been deleted.
// It can be used in Collections to signify that there used to be an object at this position,
// but it has been deleted.
type Tombstone struct {
// ID provides the globally unique identifier for anActivity Pub Object or Link.
ID ObjectID `jsonld:"id,omitempty"`
// Type identifies the Activity Pub Object or Link type. Multiple values may be specified.
Type ActivityVocabularyType `jsonld:"type,omitempty"`
// Name a simple, human-readable, plain-text name for the object.
// HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
Name NaturalLanguageValues `jsonld:"name,omitempty,collapsible"`
// Attachment identifies a resource attached or related to an object that potentially requires special handling.
// The intent is to provide a model that is at least semantically similar to attachments in email.
Attachment Item `jsonld:"attachment,omitempty"`
// AttributedTo identifies one or more entities to which this object is attributed. The attributed entities might not be Actors.
// For instance, an object might be attributed to the completion of another activity.
AttributedTo Item `jsonld:"attributedTo,omitempty"`
// Audience identifies one or more entities that represent the total population of entities
// for which the object can considered to be relevant.
Audience ItemCollection `jsonld:"audience,omitempty"`
// Content or textual representation of the Activity Pub Object encoded as a JSON string.
// By default, the value of content is HTML.
// The mediaType property can be used in the object to indicate a different content type.
// (The content MAY be expressed using multiple language-tagged values.)
Content NaturalLanguageValues `jsonld:"content,omitempty,collapsible"`
// Context identifies the context within which the object exists or an activity was performed.
// The notion of "context" used is intentionally vague.
// The intended function is to serve as a means of grouping objects and activities that share a
// common originating context or purpose. An example could be all activities relating to a common project or event.
Context Item `jsonld:"context,omitempty"`
// MediaType when used on an Object, identifies the MIME media type of the value of the content property.
// If not specified, the content property is assumed to contain text/html content.
MediaType MimeType `jsonld:"mediaType,omitempty"`
// EndTime the date and time describing the actual or expected ending time of the object.
// When used with an Activity object, for instance, the endTime property specifies the moment
// the activity concluded or is expected to conclude.
EndTime time.Time `jsonld:"endTime,omitempty"`
// Generator identifies the entity (e.g. an application) that generated the object.
Generator Item `jsonld:"generator,omitempty"`
// Icon indicates an entity that describes an icon for this object.
// The image should have an aspect ratio of one (horizontal) to one (vertical)
// and should be suitable for presentation at a small size.
Icon Item `jsonld:"icon,omitempty"`
// Image indicates an entity that describes an image for this object.
// Unlike the icon property, there are no aspect ratio or display size limitations assumed.
Image Item `jsonld:"image,omitempty"`
// InReplyTo indicates one or more entities for which this object is considered a response.
InReplyTo Item `jsonld:"inReplyTo,omitempty"`
// Location indicates one or more physical or logical locations associated with the object.
Location Item `jsonld:"location,omitempty"`
// Preview identifies an entity that provides a preview of this object.
Preview Item `jsonld:"preview,omitempty"`
// Published the date and time at which the object was published
Published time.Time `jsonld:"published,omitempty"`
// Replies identifies a Collection containing objects considered to be responses to this object.
Replies Item `jsonld:"replies,omitempty"`
// StartTime the date and time describing the actual or expected starting time of the object.
// When used with an Activity object, for instance, the startTime property specifies
// the moment the activity began or is scheduled to begin.
StartTime time.Time `jsonld:"startTime,omitempty"`
// Summary a natural language summarization of the object encoded as HTML.
// *Multiple language tagged summaries may be provided.)
Summary NaturalLanguageValues `jsonld:"summary,omitempty,collapsible"`
// Tag one or more "tags" that have been associated with an objects. A tag can be any kind of Activity Pub Object.
// The key difference between attachment and tag is that the former implies association by inclusion,
// while the latter implies associated by reference.
Tag ItemCollection `jsonld:"tag,omitempty"`
// Updated the date and time at which the object was updated
Updated time.Time `jsonld:"updated,omitempty"`
// URL identifies one or more links to representations of the object
URL LinkOrIRI `jsonld:"url,omitempty"`
// To identifies an entity considered to be part of the public primary audience of an Activity Pub Object
To ItemCollection `jsonld:"to,omitempty"`
// Bto identifies anActivity Pub Object that is part of the private primary audience of this Activity Pub Object.
Bto ItemCollection `jsonld:"bto,omitempty"`
// CC identifies anActivity Pub Object that is part of the public secondary audience of this Activity Pub Object.
CC ItemCollection `jsonld:"cc,omitempty"`
// BCC identifies one or more Objects that are part of the private secondary audience of this Activity Pub Object.
BCC ItemCollection `jsonld:"bcc,omitempty"`
// Duration when the object describes a time-bound resource, such as an audio or video, a meeting, etc,
// the duration property indicates the object's approximate duration.
// The value must be expressed as an xsd:duration as defined by [ xmlschema11-2],
// section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
Duration time.Duration `jsonld:"duration,omitempty"`
// FormerType On a Tombstone object, the formerType property identifies the type of the object that was deleted.
FormerType ActivityVocabularyType `jsonld:"formerType,omitempty"`
// Deleted On a Tombstone object, the deleted property is a timestamp for when the object was deleted.
Deleted time.Time `jsonld:"deleted,omitempty"`
}
// IsLink returns false for Tombstone objects
func (t Tombstone) IsLink() bool {
return false
}
// IsObject returns true for Tombstone objects
func (t Tombstone) IsObject() bool {
return true
}
// IsCollection returns false for Tombstone objects
func (t Tombstone) IsCollection() bool {
return false
}
// GetLink returns the IRI corresponding to the current Tombstone object
func (t Tombstone) GetLink() IRI {
return IRI(t.ID)
}
// GetType returns the type of the current Tombstone
func (t Tombstone) GetType() ActivityVocabularyType {
return t.Type
}
// GetID returns the ID corresponding to the current Tombstone
func (t Tombstone) GetID() *ObjectID {
return &t.ID
}
// UnmarshalJSON
func (t *Tombstone) UnmarshalJSON(data []byte) error {
// TODO(marius): this is a candidate of using OnObject() for loading the common properties
// and then loading the extra ones
if ItemTyperFunc == nil {
ItemTyperFunc = JSONGetItemByType
}
t.ID = JSONGetObjectID(data)
t.Type = JSONGetType(data)
t.Name = JSONGetNaturalLanguageField(data, "name")
t.Content = JSONGetNaturalLanguageField(data, "content")
t.Summary = JSONGetNaturalLanguageField(data, "summary")
t.Context = JSONGetItem(data, "context")
t.URL = JSONGetURIItem(data, "url")
t.MediaType = MimeType(JSONGetString(data, "mediaType"))
t.Generator = JSONGetItem(data, "generator")
t.AttributedTo = JSONGetItem(data, "attributedTo")
t.Attachment = JSONGetItem(data, "attachment")
t.Location = JSONGetItem(data, "location")
t.Published = JSONGetTime(data, "published")
t.StartTime = JSONGetTime(data, "startTime")
t.EndTime = JSONGetTime(data, "endTime")
t.Duration = JSONGetDuration(data, "duration")
t.Icon = JSONGetItem(data, "icon")
t.Preview = JSONGetItem(data, "preview")
t.Image = JSONGetItem(data, "image")
t.Updated = JSONGetTime(data, "updated")
inReplyTo := JSONGetItems(data, "inReplyTo")
if len(inReplyTo) > 0 {
t.InReplyTo = inReplyTo
}
to := JSONGetItems(data, "to")
if len(to) > 0 {
t.To = to
}
audience := JSONGetItems(data, "audience")
if len(audience) > 0 {
t.Audience = audience
}
bto := JSONGetItems(data, "bto")
if len(bto) > 0 {
t.Bto = bto
}
cc := JSONGetItems(data, "cc")
if len(cc) > 0 {
t.CC = cc
}
bcc := JSONGetItems(data, "bcc")
if len(bcc) > 0 {
t.BCC = bcc
}
replies := JSONGetItem(data, "replies")
if replies != nil {
t.Replies = replies
}
tag := JSONGetItems(data, "tag")
if len(tag) > 0 {
t.Tag = tag
}
t.FormerType = ActivityVocabularyType(JSONGetString(data, "formerType"))
t.Deleted = JSONGetTime(data, "deleted")
return nil
}
// Recipients performs recipient de-duplication on the Tombstone object's To, Bto, CC and BCC properties
func (t *Tombstone) Recipients() ItemCollection {
var aud ItemCollection
rec, _ := ItemCollectionDeduplication(&aud, &t.To, &t.Bto, &t.CC, &t.BCC, &t.Audience)
return rec
}
// Clean removes Bto and BCC properties
func (t *Tombstone) Clean(){
t.BCC = nil
t.Bto = nil
}
// ToTombstone
func ToTombstone(it Item) (*Tombstone, error) {
switch i := it.(type) {
case *Tombstone:
return i, nil
case Tombstone:
return &i, nil
case *Object:
return (*Tombstone)(unsafe.Pointer(i)), nil
case Object:
return (*Tombstone)(unsafe.Pointer(&i)), nil
}
return nil, fmt.Errorf("unable to convert %q", it.GetType())
}

35
tombstone_test.go Normal file
View file

@ -0,0 +1,35 @@
package activitystreams
import "testing"
func TestTombstone_GetID(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_GetLink(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_GetType(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_IsCollection(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_IsLink(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_IsObject(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_UnmarshalJSON(t *testing.T) {
t.Skipf("TODO")
}
func TestTombstone_Clean(t *testing.T) {
t.Skipf("TODO")
}

2
unmarshall.go
View file

@ -346,7 +346,7 @@ func JSONGetItemByType(typ ActivityVocabularyType) (Item, error) {
case RelationshipType:
return &Relationship{Type: typ}, nil
case TombstoneType:
return &Tombstone{Parent: Parent{Type: typ}}, nil
return &Tombstone{Type: typ}, nil
case VideoType:
return ObjectNew(typ), nil
case MentionType: