Skip to content

bovine_store.models

BovineActor

Bases: Model

Source code in bovine_store/bovine_store/models.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
class BovineActor(Model):
    id = fields.IntField(pk=True)
    bovine_name = fields.CharField(max_length=255, unique=True)
    """Internally used name to identify the actor --- unique"""
    handle_name = fields.CharField(max_length=255)
    """The preferred user name - not necessarily unique

    unsure if really necessary here"""

    properties = fields.JSONField()
    """Additional properties of the actor

    For example: name, url or icon. Currently arbitrary properties
    are not allowed yet, but should be in the future. Some thinking
    is needed here how to handle the context and so on."""

    created = fields.DatetimeField(auto_now_add=True)
    last_sign_in = fields.DatetimeField(auto_now=True)

bovine_name = fields.CharField(max_length=255, unique=True) class-attribute instance-attribute

Internally used name to identify the actor — unique

handle_name = fields.CharField(max_length=255) class-attribute instance-attribute

The preferred user name - not necessarily unique

unsure if really necessary here

properties = fields.JSONField() class-attribute instance-attribute

Additional properties of the actor

For example: name, url or icon. Currently arbitrary properties are not allowed yet, but should be in the future. Some thinking is needed here how to handle the context and so on.

BovineActorEndpoint

Bases: Model

Source code in bovine_store/bovine_store/models.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
class BovineActorEndpoint(Model):
    id = fields.IntField(pk=True)

    bovine_actor = fields.ForeignKeyField(
        "models.BovineActor", related_name="endpoints"
    )
    """The actor this endpoint belongs to"""

    endpoint_type = fields.CharEnumField(enum_type=EndpointType)
    """type of the endpoint, e.g. endpoint"""

    stream_name = fields.CharField(max_length=255)
    """Human readable name of the endpoint"""

    name = fields.CharField(max_length=255)
    """The url the endpoint points to"""

bovine_actor = fields.ForeignKeyField('models.BovineActor', related_name='endpoints') class-attribute instance-attribute

The actor this endpoint belongs to

endpoint_type = fields.CharEnumField(enum_type=EndpointType) class-attribute instance-attribute

type of the endpoint, e.g. endpoint

name = fields.CharField(max_length=255) class-attribute instance-attribute

The url the endpoint points to

stream_name = fields.CharField(max_length=255) class-attribute instance-attribute

Human readable name of the endpoint

BovineActorKeyPair

Bases: Model

Represents identifiers associated with the actor. It contains currently a mix of identities. These are:

  • server key, e.g. RSA key pair for HTTP Signatures
  • identifiers used to lookup the actor, e.g. acct:handle@domain
  • did keys used to identify one is a BovineClient

FIXME: Do we need a type, an order, a should display? Think about these things https://socialhub.activitypub.rocks/t/alsoknownas-and-acct/3132?u=helge

Source code in bovine_store/bovine_store/models.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class BovineActorKeyPair(Model):
    """
    Represents identifiers associated with the actor. It contains currently
    a mix of identities. These are:

    * server key, e.g. RSA key pair for HTTP Signatures
    * identifiers used to lookup the actor, e.g. acct:handle@domain
    * did keys used to identify one is a BovineClient

    FIXME: Do we need a type, an order, a should display? Think about these things
    https://socialhub.activitypub.rocks/t/alsoknownas-and-acct/3132?u=helge
    """

    id = fields.IntField(pk=True)

    bovine_actor = fields.ForeignKeyField("models.BovineActor", related_name="keypairs")
    """The actor this keypair belongs to"""

    name = fields.CharField(max_length=255)
    """Human readable name"""

    private_key = fields.TextField(null=True)  # FIXME Rename to secret
    """the secret in the keypair. The private_key is null if the keypair
    is used to gain access to the Actor from a Client"""

    public_key = fields.TextField()  # FIXME Rename to identity, Make unique
    """the public key"""

bovine_actor = fields.ForeignKeyField('models.BovineActor', related_name='keypairs') class-attribute instance-attribute

The actor this keypair belongs to

name = fields.CharField(max_length=255) class-attribute instance-attribute

Human readable name

private_key = fields.TextField(null=True) class-attribute instance-attribute

the secret in the keypair. The private_key is null if the keypair is used to gain access to the Actor from a Client

public_key = fields.TextField() class-attribute instance-attribute

the public key

CollectionItem

Bases: Model

Source code in bovine_store/bovine_store/models.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class CollectionItem(Model):
    id = fields.IntField(pk=True)
    """id of the collection, an integer, used for pagination"""

    part_of = fields.CharField(max_length=255)
    """id of the collection"""
    object_id = fields.CharField(
        max_length=255,
    )
    """id of the element in the collection"""

    created = fields.DatetimeField(auto_now_add=True)
    updated = fields.DatetimeField(auto_now=True)

    class Meta:
        unique_together = (("part_of", "object_id"),)

id = fields.IntField(pk=True) class-attribute instance-attribute

id of the collection, an integer, used for pagination

object_id = fields.CharField(max_length=255) class-attribute instance-attribute

id of the element in the collection

part_of = fields.CharField(max_length=255) class-attribute instance-attribute

id of the collection

StoredJsonObject

Bases: Model

Stores an object

Source code in bovine_store/bovine_store/models.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class StoredJsonObject(Model):
    """Stores an object"""

    id = fields.CharField(max_length=255, pk=True)
    """The id of the object"""
    owner = fields.CharField(max_length=255)
    """The owner of the object, usually either

    * content["actor"]
    * content["attributedTo"]"""

    content = fields.JSONField()
    """content of the object as json"""

    created = fields.DatetimeField(auto_now_add=True)
    updated = fields.DatetimeField(auto_now=True)

    visibility = fields.CharEnumField(
        VisibilityTypes, default=VisibilityTypes.RESTRICTED
    )
    object_type = fields.CharEnumField(ObjectType, default=ObjectType.LOCAL)

content = fields.JSONField() class-attribute instance-attribute

content of the object as json

id = fields.CharField(max_length=255, pk=True) class-attribute instance-attribute

The id of the object

owner = fields.CharField(max_length=255) class-attribute instance-attribute

The owner of the object, usually either

  • content[“actor”]
  • content[“attributedTo”]

VisibleTo

Bases: Model

Source code in bovine_store/bovine_store/models.py 
34
35
36
37
38
39
40
41
class VisibleTo(Model):
    id = fields.IntField(pk=True)
    main_object = fields.ForeignKeyField(
        "models.StoredJsonObject", related_name="visible_to"
    )
    """Stored object, has foreign key"""
    object_id = fields.CharField(max_length=255)
    """id of the object that it is visible to"""

main_object = fields.ForeignKeyField('models.StoredJsonObject', related_name='visible_to') class-attribute instance-attribute

Stored object, has foreign key

object_id = fields.CharField(max_length=255) class-attribute instance-attribute

id of the object that it is visible to