diaspora_federation 0.1.1 → 0.1.2

data/lib/diaspora_federation/entities/account_deletion.rb

@@ -1,17 +1,17 @@
 module DiasporaFederation
   module Entities
-    # this entity is sent when account was deleted on a remote pod
+    # This entity is sent when an account was deleted on a remote pod.
     #
     # @see Validators::AccountDeletionValidator
     class AccountDeletion < Entity
       # @!attribute [r] author
-      #   The diaspora ID of the deleted account
+      #   The diaspora* ID of the deleted account
       #   @see Person#author
-      #   @return [String] diaspora ID
+      #   @return [String] diaspora* ID
       # @!attribute [r] diaspora_id
       #   Alias for author
       #   @see AccountDeletion#author
-      #   @return [String] diaspora ID
+      #   @return [String] diaspora* ID
       property :author, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @return [String] string representation of this object

data/lib/diaspora_federation/entities/comment.rb

@@ -1,10 +1,10 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a comment to some kind of post (e.g. status message)
+    # This entity represents a comment to some kind of post (e.g. status message).
     #
     # @see Validators::CommentValidator
     class Comment < Entity
-      # old signature order
+      # Old signature order
       # @deprecated
       LEGACY_SIGNATURE_ORDER = %i(guid parent_guid text author).freeze
 
@@ -18,7 +18,7 @@ module DiasporaFederation
       property :text
 
       # @!attribute [r] created_at
-      #   comment entity creation time
+      #   Comment entity creation time
       #   @return [Time] creation time
       property :created_at, default: -> { Time.now.utc }
     end

data/lib/diaspora_federation/entities/contact.rb

@@ -1,18 +1,18 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a contact with another person. A user issues it
-    # when he starts sharing/following with another user.
+    # This entity represents a contact with another person. A user issues it
+    # when they start sharing/following with another user.
     #
     # @see Validators::ContactValidator
     class Contact < Entity
       # @!attribute [r] author
-      #   The diaspora ID of the person who shares his profile
+      #   The diaspora* ID of the person who shares their profile
       #   @see Person#author
       #   @return [String] sender ID
       property :author
 
       # @!attribute [r] recipient
-      #   The diaspora ID of the person who will be shared with
+      #   The diaspora* ID of the person who will be shared with
       #   @see Validation::Rule::DiasporaId
       #   @return [String] recipient ID
       property :recipient

data/lib/diaspora_federation/entities/conversation.rb

@@ -1,11 +1,17 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a private conversation between users
+    # This entity represents a private conversation between users.
     #
     # @see Validators::ConversationValidator
     class Conversation < Entity
+      # @!attribute [r] author
+      #   The diaspora* ID of the person initiated the conversation
+      #   @see Person#author
+      #   @return [String] diaspora* ID
+      property :author, xml_name: :diaspora_handle
+
       # @!attribute [r] guid
-      #   a random string of at least 16 chars.
+      #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] conversation guid
       property :guid
@@ -18,21 +24,15 @@ module DiasporaFederation
       #   @return [Time] Conversation creation time
       property :created_at, default: -> { Time.now.utc }
 
+      # @!attribute [r] participants
+      #   The diaspora* IDs of the persons participating the conversation separated by ";"
+      #   @return [String] participants diaspora* IDs
+      property :participants, xml_name: :participant_handles
+
       # @!attribute [r] messages
       #   @return [[Entities::Message]] Messages of this conversation
       entity :messages, [Entities::Message], default: []
 
-      # @!attribute [r] author
-      #   The diaspora ID of the person initiated the conversation.
-      #   @see Person#author
-      #   @return [String] diaspora ID
-      property :author, xml_name: :diaspora_handle
-
-      # @!attribute [r] participants
-      #   The diaspora IDs of the persons participating the conversation separated by ";".
-      #   @return [String] participants diaspora IDs
-      property :participants, xml_name: :participant_handles
-
       private
 
       def validate

data/lib/diaspora_federation/entities/like.rb

@@ -1,10 +1,10 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a like to some kind of post (e.g. status message)
+    # This entity represents a like to some kind of post (e.g. status message).
     #
     # @see Validators::LikeValidator
     class Like < Entity
-      # old signature order
+      # Old signature order
       # @deprecated
       LEGACY_SIGNATURE_ORDER = %i(positive guid parent_type parent_guid author).freeze
 
@@ -12,14 +12,14 @@ module DiasporaFederation
 
       # @!attribute [r] positive
       #   If +true+ set a like, if +false+, set a dislike (dislikes are currently not
-      #   implemented in the Diaspora frontend).
+      #   implemented in the diaspora* frontend).
       #   @return [Boolean] is it a like or a dislike
       property :positive
 
       # @!attribute [r] parent_type
-      #   A string describing the type of the parent.
+      #   A string describing the type of the parent
       #   Can be "Post" or "Comment" (Comments are currently not implemented in the
-      #   Diaspora Frontend).
+      #   diaspora* frontend).
       #   @return [String] parent type
       property :parent_type, xml_name: :target_type
     end

data/lib/diaspora_federation/entities/location.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Entities
-    # this entity is used to specify a location data and used embedded in a status message
+    # This entity is used to specify location data and used embedded in a status message.
     #
     # @see Validators::LocationValidator
     class Location < Entity

data/lib/diaspora_federation/entities/message.rb

@@ -1,27 +1,27 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a private message exchanged in private conversation
+    # This entity represents a private message exchanged in private conversation.
     #
     # @see Validators::MessageValidator
     class Message < Entity
-      # old signature order
+      # Old signature order
       # @deprecated
       LEGACY_SIGNATURE_ORDER = %i(guid parent_guid text created_at author conversation_guid).freeze
 
       include Relayable
 
       # @!attribute [r] text
-      #   text of the message composed by a user
+      #   Text of the message composed by a user
       #   @return [String] text
       property :text
 
       # @!attribute [r] created_at
-      #   message creation time
+      #   Message creation time
       #   @return [Time] creation time
       property :created_at, default: -> { Time.now.utc }
 
       # @!attribute [r] conversation_guid
-      #   guid of a conversation this message belongs to
+      #   Guid of a conversation this message belongs to
       #   @see Conversation#guid
       #   @return [String] conversation guid
       property :conversation_guid

data/lib/diaspora_federation/entities/participation.rb

@@ -1,28 +1,28 @@
 module DiasporaFederation
   module Entities
-    # participation is sent to subscribe a user on updates for some post
+    # Participation is sent to subscribe a user on updates for some post.
     #
     # @see Validators::Participation
     class Participation < Entity
-      # old signature order
+      # Old signature order
       # @deprecated
       LEGACY_SIGNATURE_ORDER = %i(guid parent_type parent_guid author).freeze
 
       include Relayable
 
       # @!attribute [r] parent_type
-      #   a string describing a type of the target to subscribe on.
-      #   currently only "Post" is supported.
+      #   A string describing a type of the target to subscribe on
+      #   Currently only "Post" is supported.
       #   @return [String] parent type
       property :parent_type, xml_name: :target_type
 
-      # It is only valid to receive a {Participation} from the author itself.
+      # It is only valid to receive a {Participation} from the author themself.
       # @deprecated remove after {Participation} doesn't include {Relayable} anymore
       def sender_valid?(sender)
         sender == author
       end
 
-      # validates that the parent exists and the parent author is local
+      # Validates that the parent exists and the parent author is local
       def validate_parent
         parent = DiasporaFederation.callbacks.trigger(:fetch_related_entity, parent_type, parent_guid)
         raise ParentNotLocal, "obj=#{self}" unless parent && parent.local

data/lib/diaspora_federation/entities/person.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Entities
-    # this entity contains the base data of a person
+    # This entity contains the base data of a person.
     #
     # @see Validators::PersonValidator
     class Person < Entity
@@ -12,13 +12,13 @@ module DiasporaFederation
       property :guid
 
       # @!attribute [r] author
-      #   The diaspora ID of the person
+      #   The diaspora* ID of the person
       #   @see Validation::Rule::DiasporaId
-      #   @return [String] diaspora ID
+      #   @return [String] diaspora* ID
       # @!attribute [r] diaspora_id
-      #   Alias for author
+      #   alias for author
       #   @see Person#author
-      #   @return [String] diaspora ID
+      #   @return [String] diaspora* ID
       property :author, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @!attribute [r] url
@@ -27,7 +27,7 @@ module DiasporaFederation
       property :url
 
       # @!attribute [r] profile
-      #   all profile data of the person
+      #   All profile data of the person
       #   @return [Profile] the profile of the person
       entity :profile, Entities::Profile
 

data/lib/diaspora_federation/entities/photo.rb

@@ -1,19 +1,19 @@
 module DiasporaFederation
   module Entities
-    # this entity represents photo and it is federated as a part of a status message
+    # This entity represents a photo and it is federated as a part of a status message.
     #
     # @see Validators::PhotoValidator
     class Photo < Entity
       # @!attribute [r] guid
-      #   a random string of at least 16 chars.
+      #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] guid
       property :guid
 
       # @!attribute [r] author
-      #   The diaspora ID of the person who uploaded the photo
+      #   The diaspora* ID of the person who uploaded the photo
       #   @see Person#author
-      #   @return [String] author diaspora ID
+      #   @return [String] author diaspora* ID
       property :author, xml_name: :diaspora_handle
 
       # @!attribute [r] public
@@ -22,12 +22,12 @@ module DiasporaFederation
       property :public, default: false
 
       # @!attribute [r] created_at
-      #   photo entity creation time
+      #   Photo entity creation time
       #   @return [Time] creation time
       property :created_at, default: -> { Time.now.utc }
 
       # @!attribute [r] remote_photo_path
-      #   an url of the photo on a remote server
+      #   An url of the photo on a remote server
       #   @return [String] remote photo url
       property :remote_photo_path
 
@@ -40,18 +40,18 @@ module DiasporaFederation
       property :text, default: nil
 
       # @!attribute [r] status_message_guid
-      #   guid of a status message this message belongs to
+      #   Guid of a status message this photo belongs to
       #   @see StatusMessage#guid
       #   @return [String] guid
-      property :status_message_guid
+      property :status_message_guid, default: nil
 
       # @!attribute [r] height
-      #   photo height
+      #   Photo height
       #   @return [String] height
       property :height
 
       # @!attribute [r] width
-      #   photo width
+      #   Photo width
       #   @return [String] width
       property :width
     end

data/lib/diaspora_federation/entities/poll.rb

@@ -1,11 +1,11 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a poll ant it is federated as an optional part of a status message
+    # This entity represents a poll and it is federated as an optional part of a status message.
     #
     # @see Validators::PollValidator
     class Poll < Entity
       # @!attribute [r] guid
-      #   a random string of at least 16 chars.
+      #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] poll guid
       property :guid
@@ -16,7 +16,7 @@ module DiasporaFederation
       property :question
 
       # @!attribute [r] poll_answers
-      #   array of possible answer to the poll
+      #   Array of possible answers for the poll
       #   @return [[Entities::PollAnswer]] poll answers
       entity :poll_answers, [Entities::PollAnswer]
     end

data/lib/diaspora_federation/entities/poll_answer.rb

@@ -1,11 +1,11 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a poll answer and is federated as a part of the Poll entity
+    # This entity represents a poll answer and is federated as a part of the Poll entity.
     #
     # @see Validators::PollAnswerValidator
     class PollAnswer < Entity
       # @!attribute [r] guid
-      #   a random string of at least 16 chars.
+      #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] guid
       property :guid

data/lib/diaspora_federation/entities/poll_participation.rb

@@ -1,10 +1,10 @@
 module DiasporaFederation
   module Entities
-    # this entity represents a participation in poll, i.e. it is issued when a user votes for an answer in a poll
+    # This entity represents a participation in poll, i.e. it is issued when a user votes for an answer in a poll.
     #
     # @see Validators::PollParticipationValidator
     class PollParticipation < Entity
-      # old signature order
+      # Old signature order
       # @deprecated
       LEGACY_SIGNATURE_ORDER = %i(guid parent_guid author poll_answer_guid).freeze
 
@@ -14,7 +14,7 @@ module DiasporaFederation
       include Relayable
 
       # @!attribute [r] poll_answer_guid
-      #   guid of the answer selected by the user.
+      #   Guid of the answer selected by the user
       #   @see PollAnswer#guid
       #   @return [String] poll answer guid
       property :poll_answer_guid

data/lib/diaspora_federation/entities/post.rb

@@ -1,26 +1,26 @@
 module DiasporaFederation
   module Entities
-    # this is a module that defines common properties for a post which
+    # This is a module that defines common properties for a post which
     # include {StatusMessage} and {Reshare}.
     module Post
-      # on inclusion of this module the required properties for a post are added to the object that includes it
+      # On inclusion of this module the required properties for a post are added to the object that includes it.
       #
       # @!attribute [r] author
-      #   The diaspora ID of the person who posts the post
+      #   The diaspora* ID of the person who posts the post
       #   @see Person#author
-      #   @return [String] diaspora ID
+      #   @return [String] diaspora* ID
       #
       # @!attribute [r] guid
-      #   a random string of at least 16 chars.
+      #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] status message guid
       #
       # @!attribute [r] created_at
-      #   post entity creation time
+      #   Post entity creation time
       #   @return [Time] creation time
       #
       # @!attribute [r] provider_display_name
-      #   a string that describes a means by which a user has posted the post
+      #   A string that describes a means by which a user has posted the post
       #   @return [String] provider display name
       #
       # @param [Entity] entity the entity in which it is included

data/lib/diaspora_federation/entities/profile.rb

@@ -1,22 +1,22 @@
 module DiasporaFederation
   module Entities
-    # this entity contains all the profile data of a person
+    # This entity contains all the profile data of a person.
     #
     # @see Validators::ProfileValidator
     class Profile < Entity
       # @!attribute [r] author
-      #   The diaspora ID of the person
+      #   The diaspora* ID of the person
       #   @see Person#author
-      #   @return [String] diaspora ID
+      #   @return [String] diaspora* ID
       # @!attribute [r] diaspora_id
       #   Alias for author
       #   @see Profile#author
-      #   @return [String] diaspora ID
+      #   @return [String] diaspora* ID
       property :author, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @!attribute [r] first_name
       #   @deprecated We decided to only use one name field, these should be removed
-      #     in later iterations (will affect older Diaspora* installations).
+      #     in later iterations (will affect older diaspora* installations).
       #   @see #full_name
       #   @see Discovery::HCard#first_name
       #   @return [String] first name
@@ -24,7 +24,7 @@ module DiasporaFederation
 
       # @!attribute [r] last_name
       #   @deprecated We decided to only use one name field, these should be removed
-      #     in later iterations (will affect older Diaspora* installations).
+      #     in later iterations (will affect older diaspora* installations).
       #   @see #full_name
       #   @see Discovery::HCard#last_name
       #   @return [String] last name