Class: DiasporaFederation::Entities::Person

Inherits:

DiasporaFederation::Entity

• Object
• DiasporaFederation::Entity
• DiasporaFederation::Entities::Person

Defined in:

lib/diaspora_federation/entities/person.rb

Overview

This entity contains the base data of a person.

See Also:

• Validators::PersonValidator

Constant Summary

Constants inherited from DiasporaFederation::Entity

DiasporaFederation::Entity::ENTITY_NAME_REGEX, DiasporaFederation::Entity::INVALID_XML_REGEX

Instance Attribute Summary

• #author ⇒ String readonly

  The diaspora* ID of the person.

• #diaspora_id ⇒ String readonly

  alias for author.

• #exported_key ⇒ String readonly

  Public key.

• #guid ⇒ String readonly

  This is just the guid.

• #profile ⇒ Profile readonly

  All profile data of the person.

• #url ⇒ String readonly

  Link to the pod.

Method Summary

Methods inherited from DiasporaFederation::Entity

class_name, entity_class, entity_name, from_hash, from_json, from_xml, #initialize, #to_h, #to_json, #to_s, #to_xml

Methods included from PropertiesDSL

#class_props, #default_values, #entity, #missing_props, #optional_props, #property, #resolv_aliases

Methods included from Logging

included

Constructor Details

This class inherits a constructor from DiasporaFederation::Entity

Instance Attribute Details

#author ⇒ String (readonly)

The diaspora* ID of the person

Returns:

• (String) —

  diaspora* ID

See Also:

• Validation::Rule::DiasporaId

# File 'lib/diaspora_federation/entities/person.rb', line 24

property :author, :string, alias: :diaspora_id

#diaspora_id ⇒ String (readonly)

alias for author

Returns:

• (String) —

  diaspora* ID

See Also:

• #author

# File 'lib/diaspora_federation/entities/person.rb', line 24

property :author, :string, alias: :diaspora_id

#exported_key ⇒ String (readonly)

Returns public key.

Returns:

• (String) —

  public key

See Also:

• Discovery::HCard#public_key

# File 'lib/diaspora_federation/entities/person.rb', line 39

property :exported_key, :string

#guid ⇒ String (readonly)

This is just the guid. When a user creates an account on a pod, the pod MUST assign them a guid - a random string of at least 16 chars.

Returns:

• (String) —

  guid

See Also:

• Validation::Rule::Guid

# File 'lib/diaspora_federation/entities/person.rb', line 14

property :guid, :string

#profile ⇒ Profile (readonly)

All profile data of the person

Returns:

• (Profile) —

  the profile of the person

# File 'lib/diaspora_federation/entities/person.rb', line 34

entity :profile, Entities::Profile

#url ⇒ String (readonly)

Returns link to the pod.

Returns:

• (String) —

  link to the pod

See Also:

• Discovery::WebFinger#seed_url

# File 'lib/diaspora_federation/entities/person.rb', line 29

property :url, :string