diaspora_federation 0.1.1 → 0.1.2

data/lib/diaspora_federation/validators.rb

@@ -9,7 +9,7 @@ require "validation/rule/numeric"
 module Validation
   # This module contains custom validation rules for various data field types.
   # That includes types for which there are no provided rules by the +valid+ gem
-  # or types that are very specific to Diaspora* federation and need special handling.
+  # or types that are very specific to diaspora* federation and need special handling.
   # The rules are used inside the {DiasporaFederation::Validators validator classes}
   # to perform basic sanity-checks on {DiasporaFederation::Entities federation entities}.
   module Rule

data/lib/diaspora_federation/validators/account_deletion_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::AccountDeletion}
+    # This validates a {Entities::AccountDeletion}.
     class AccountDeletionValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/comment_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Comment}
+    # This validates a {Entities::Comment}.
     class CommentValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/contact_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Contact}
+    # This validates a {Entities::Contact}.
     class ContactValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/conversation_validator.rb

@@ -1,16 +1,16 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Conversation}
+    # This validates a {Entities::Conversation}.
     class ConversationValidator < Validation::Validator
       include Validation
 
+      rule :author, %i(not_empty diaspora_id)
       rule :guid, :guid
 
-      rule :messages, :not_nil
-
-      rule :author, %i(not_empty diaspora_id)
+      rule :subject, [:not_empty, length: {maximum: 255}]
 
       rule :participants, diaspora_id_count: {maximum: 20}
+      rule :messages, :not_nil
     end
   end
 end

data/lib/diaspora_federation/validators/h_card_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Discovery::HCard}
+    # This validates a {Discovery::HCard}.
     #
     # @todo activate guid and public key validation after all pod have it in
     #   the hcard.
@@ -11,7 +11,7 @@ module DiasporaFederation
 
       # rule :guid, :guid
 
-      # the name must not contain a semicolon because of mentions
+      # The name must not contain a semicolon because of mentions.
       # @{<full_name> ; <diaspora_id>}
       rule :full_name, regular_expression: {regex: /\A[^;]{,70}\z/}
       rule :first_name, regular_expression: {regex: /\A[^;]{,32}\z/}

data/lib/diaspora_federation/validators/like_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Like}
+    # This validates a {Entities::Like}.
     class LikeValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/location_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Location}
+    # This validates a {Entities::Location}.
     class LocationValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/message_validator.rb

@@ -1,12 +1,15 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Message}
+    # This validates a {Entities::Message}.
     class MessageValidator < Validation::Validator
       include Validation
 
       rule :author, %i(not_empty diaspora_id)
       rule :guid, :guid
       rule :conversation_guid, :guid
+
+      rule :text, [:not_empty,
+                   length: {maximum: 65_535}]
     end
   end
 end

data/lib/diaspora_federation/validators/participation_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Participation}
+    # This validates a {Entities::Participation}.
     class ParticipationValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/person_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Person}
+    # This validates a {Entities::Person}.
     class PersonValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/photo_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Photo}
+    # This validates a {Entities::Photo}.
     class PhotoValidator < Validation::Validator
       include Validation
 
@@ -16,6 +16,8 @@ module DiasporaFederation
 
       rule :status_message_guid, guid: {nilable: true}
 
+      rule :text, length: {maximum: 65_535}
+
       rule :height, :numeric
 
       rule :width, :numeric

data/lib/diaspora_federation/validators/poll_answer_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::PollAnswer}
+    # This validates a {Entities::PollAnswer}.
     class PollAnswerValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/poll_participation_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::PollParticipation}
+    # This validates a {Entities::PollParticipation}.
     class PollParticipationValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/poll_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Poll}
+    # This validates a {Entities::Poll}.
     class PollValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/profile_validator.rb

@@ -1,17 +1,17 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Profile}
+    # This validates a {Entities::Profile}.
     class ProfileValidator < Validation::Validator
       include Validation
 
       rule :author, :diaspora_id
 
-      # the name must not contain a semicolon because of mentions
+      # The name must not contain a semicolon because of mentions.
       # @{<full_name> ; <diaspora_id>}
       rule :first_name, regular_expression: {regex: /\A[^;]{,32}\z/}
       rule :last_name, regular_expression: {regex: /\A[^;]{,32}\z/}
 
-      # this urls can be relative
+      # These urls can be relative.
       rule :image_url, URI: [:path]
       rule :image_url_medium, URI: [:path]
       rule :image_url_small, URI: [:path]

data/lib/diaspora_federation/validators/related_entity_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::RelatedEntity}
+    # This validates a {Entities::RelatedEntity}.
     class RelatedEntityValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/relayable_retraction_validator.rb

@@ -1,7 +1,7 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::RelayableRetraction}
-    # @deprecated the {Entities::RelayableRetraction} will be replaced with {Entities::Retraction}
+    # This validates a {Entities::RelayableRetraction}.
+    # @deprecated The {Entities::RelayableRetraction} will be replaced with {Entities::Retraction}.
     class RelayableRetractionValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/relayable_validator.rb

@@ -1,8 +1,8 @@
 module DiasporaFederation
   module Validators
-    # This is included to validatros which validate entities which include {Entities::Relayable}
+    # This is included to validatros which validate entities which include {Entities::Relayable}.
     module RelayableValidator
-      # when this module is included in a Validator child it adds rules for relayable validation
+      # When this module is included in a Validator child it adds rules for relayable validation.
       # @param [Validation::Validator] validator the validator in which it is included
       def self.included(validator)
         validator.class_eval do

data/lib/diaspora_federation/validators/request_validator.rb

@@ -1,7 +1,7 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Request}
-    # @deprecated the {Entities::Request} will be replaced with {Entities::Contact}
+    # This validates a {Entities::Request}.
+    # @deprecated The {Entities::Request} will be replaced with {Entities::Contact}.
     class RequestValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/reshare_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Reshare}
+    # This validates a {Entities::Reshare}.
     class ReshareValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/retraction_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::Retraction}
+    # This validates a {Entities::Retraction}.
     class RetractionValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/rules/birthday.rb

@@ -15,7 +15,7 @@ module Validation
         :birthday
       end
 
-      # Determines if value is a valid birthday date
+      # Determines if value is a valid birthday date.
       def valid_value?(value)
         return true if value.nil? || (value.is_a?(String) && value.empty?)
         return true if value.is_a? Date
@@ -28,7 +28,7 @@ module Validation
         false
       end
 
-      # This rule has no params
+      # This rule has no params.
       # @return [Hash] params
       def params
         {}

data/lib/diaspora_federation/validators/rules/boolean.rb

@@ -28,7 +28,7 @@ module Validation
         end
       end
 
-      # This rule has no params
+      # This rule has no params.
       # @return [Hash] params
       def params
         {}

data/lib/diaspora_federation/validators/rules/diaspora_id.rb

@@ -1,10 +1,10 @@
 module Validation
   module Rule
-    # Diaspora ID validation rule
+    # diaspora* ID validation rule
     #
-    # A simple rule to validate the base structure of diaspora IDs.
+    # A simple rule to validate the base structure of diaspora* IDs.
     class DiasporaId
-      # The Regex for a valid diaspora ID
+      # The Regex for a valid diaspora* ID
       DIASPORA_ID = begin
         letter         = "a-zA-Z"
         digit          = "0-9"
@@ -28,12 +28,12 @@ module Validation
         :diaspora_id
       end
 
-      # Determines if value is a valid diaspora ID
+      # Determines if value is a valid diaspora* ID
       def valid_value?(value)
         value.nil? || !DIASPORA_ID.match(value).nil?
       end
 
-      # This rule has no params
+      # This rule has no params.
       # @return [Hash] params
       def params
         {}

data/lib/diaspora_federation/validators/rules/diaspora_id_count.rb

@@ -1,13 +1,13 @@
 module Validation
   module Rule
-    # Rule for validating the number of Diaspora* ids in a string.
+    # Rule for validating the number of diaspora* IDs in a string.
     # The evaluated string is split at ";" and the result will be counted.
     class DiasporaIdCount
-      # This rule must have a +maximum+ param
+      # This rule must have a +maximum+ param.
       # @return [Hash] params
       attr_reader :params
 
-      # create a new rule for a maximum diaspora id count validation
+      # Creates a new rule for a maximum diaspora* ID count validation
       # @param [Hash] params
       # @option params [Fixnum] :maximum maximum allowed id count
       def initialize(params)

data/lib/diaspora_federation/validators/rules/guid.rb

@@ -2,16 +2,16 @@ module Validation
   module Rule
     # GUID validation rule
     #
-    # Valid is a +String+ that is at least 16 chars long and contains only:
+    # Valid is a +String+ that is at least 16 and at most 255 chars long. It contains only:
     # * Letters: a-z
     # * Numbers: 0-9
     # * Special chars: '-', '_', '@', '.' and ':'
     class Guid
-      # This rule can have a +nilable+ param
+      # This rule can have a +nilable+ param.
       # @return [Hash] params
       attr_reader :params
 
-      # create a new rule for guid validation
+      # Creates a new rule for guid validation
       # @param [Hash] params
       # @option params [Boolean] :nilable guid allowed to be nil
       def initialize(params={})
@@ -30,7 +30,7 @@ module Validation
 
       # Determines if value is a valid +GUID+
       def valid_value?(value)
-        params[:nilable] && value.nil? || value.is_a?(String) && value.downcase =~ /\A[0-9a-z\-_@.:]{16,}\z/
+        params[:nilable] && value.nil? || value.is_a?(String) && value.downcase =~ /\A[0-9a-z\-_@.:]{16,255}\z/
       end
     end
   end

data/lib/diaspora_federation/validators/rules/not_nil.rb

@@ -13,7 +13,7 @@ module Validation
         !value.nil?
       end
 
-      # This rule has no params
+      # This rule has no params.
       # @return [Hash] params
       def params
         {}

data/lib/diaspora_federation/validators/rules/public_key.rb

@@ -23,7 +23,7 @@ module Validation
         )
       end
 
-      # This rule has no params
+      # This rule has no params.
       # @return [Hash] params
       def params
         {}

data/lib/diaspora_federation/validators/rules/tag_count.rb

@@ -4,11 +4,11 @@ module Validation
     # Only the "#" characters will be counted.
     # The string can be nil.
     class TagCount
-      # This rule must have a +maximum+ param
+      # This rule must have a +maximum+ param.
       # @return [Hash] params
       attr_reader :params
 
-      # create a new rule for a maximum tag count validation
+      # Creates a new rule for a maximum tag count validation
       # @param [Hash] params
       # @option params [Fixnum] :maximum maximum allowed tag count
       def initialize(params)

data/lib/diaspora_federation/validators/signed_retraction_validator.rb

@@ -1,7 +1,7 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::SignedRetraction}
-    # @deprecated the {Entities::RelayableRetraction} will be replaced with {Entities::Retraction}
+    # This validates a {Entities::SignedRetraction}.
+    # @deprecated The {Entities::RelayableRetraction} will be replaced with {Entities::Retraction}.
     class SignedRetractionValidator < Validation::Validator
       include Validation
 

data/lib/diaspora_federation/validators/status_message_validator.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Entities::StatusMessage}
+    # This validates a {Entities::StatusMessage}.
     class StatusMessageValidator < Validation::Validator
       include Validation
 
@@ -8,6 +8,8 @@ module DiasporaFederation
 
       rule :guid, :guid
 
+      rule :text, length: {maximum: 65_535}
+
       rule :photos, :not_nil
 
       rule :public, :boolean

data/lib/diaspora_federation/validators/web_finger_validator.rb

@@ -1,9 +1,9 @@
 module DiasporaFederation
   module Validators
-    # This validates a {Discovery::WebFinger}
+    # This validates a {Discovery::WebFinger}.
     #
-    # @note it does not validate the guid and public key, because it will be
-    #   removed in the webfinger
+    # @note It does not validate the guid and public key, because it will be
+    #   removed in the webfinger.
     class WebFingerValidator < Validation::Validator
       include Validation