coarnotify 0.1.0

data/lib/coarnotify/patterns/announce_review.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent an AnnounceReview notification
+    class AnnounceReview < Core::Notify::NotifyPattern
+      def self.type_constant
+        [Core::ActivityStreams2::ActivityStreamsTypes::ANNOUNCE, Core::Notify::NotifyTypes::REVIEW_ACTION]
+      end
+
+      # Custom getter to retrieve Announce Review object
+      #
+      # @return [AnnounceReviewObject, nil] Announce Review Object
+      def object
+        o = get_property(Core::ActivityStreams2::Properties::OBJECT)
+        if o
+          AnnounceReviewObject.new(stream: o, validate_stream_on_construct: false,
+                                   validate_properties: @validate_properties, validators: @validators,
+                                   validation_context: Core::ActivityStreams2::Properties::OBJECT,
+                                   properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the object property of the notification
+      #
+      # @param value [AnnounceReviewObject] the object to set
+      def object=(value)
+        set_property(Core::ActivityStreams2::Properties::OBJECT, value.doc)
+      end
+
+      # Custom getter to retrieve AnnounceReview Context
+      #
+      # @return [AnnounceReviewContext, nil] AnnounceReviewContext
+      def context
+        c = get_property(Core::ActivityStreams2::Properties::CONTEXT)
+        if c
+          AnnounceReviewContext.new(stream: c, validate_stream_on_construct: false,
+                                    validate_properties: @validate_properties, validators: @validators,
+                                    validation_context: Core::ActivityStreams2::Properties::CONTEXT,
+                                    properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the context property of the notification
+      #
+      # @param value [AnnounceReviewContext] the context to set
+      def context=(value)
+        set_property(Core::ActivityStreams2::Properties::CONTEXT, value.doc)
+      end
+
+      # Extends the base validation to make `context` required
+      #
+      # @return [Boolean] true if valid, otherwise raises ValidationError
+      def validate
+        ve = Core::Notify::ValidationError.new
+
+        begin
+          super
+        rescue Core::Notify::ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::CONTEXT, context)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+
+    # Custom Context for Announce Review, specifically to return custom
+    # Announce Review Item
+    class AnnounceReviewContext < Core::Notify::NotifyObject
+      # Custom getter to retrieve AnnounceReviewItem
+      #
+      # @return [AnnounceReviewItem, nil] AnnounceReviewItem
+      def item
+        i = get_property(Core::Notify::NotifyProperties::ITEM)
+        if i
+          AnnounceReviewItem.new(stream: i, validate_stream_on_construct: false,
+                                 validate_properties: @validate_properties, validators: @validators,
+                                 validation_context: Core::Notify::NotifyProperties::ITEM,
+                                 properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the item property
+      #
+      # @param value [AnnounceReviewItem] the item to set
+      def item=(value)
+        set_property(Core::Notify::NotifyProperties::ITEM, value.doc)
+      end
+    end
+
+    # Custom AnnounceReviewItem which provides additional validation over the basic NotifyItem
+    class AnnounceReviewItem < Core::Notify::NotifyItem
+      # In addition to the base validator, this:
+      #
+      # * Reintroduces type validation
+      # * make mediaType a required field
+      #
+      # @return [Boolean] true if valid, else raises a ValidationError
+      def validate
+        ve = Core::Notify::ValidationError.new
+
+        begin
+          super
+        rescue Core::Notify::ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::TYPE, type)
+        required(ve, Core::Notify::NotifyProperties::MEDIA_TYPE, media_type)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+
+    # Custom Announce Review Object to apply custom validation for this pattern
+    class AnnounceReviewObject < Core::Notify::NotifyObject
+      # In addition to the base validator this:
+      #
+      # * Makes type required
+      #
+      # @return [Boolean] true if valid, else raises ValidationError
+      def validate
+        ve = Core::Notify::ValidationError.new
+
+        begin
+          super
+        rescue Core::Notify::ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::TYPE, type)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/announce_service_result.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent the Announce Service Result notification
+    # https://coar-notify.net/specification/1.0.0/announce-resource/
+    class AnnounceServiceResult < Core::Notify::NotifyPattern
+      def self.type_constant
+        [Core::ActivityStreams2::ActivityStreamsTypes::ANNOUNCE, Core::Notify::NotifyTypes::INGEST_ACTION]
+      end
+
+      # Custom getter to retrieve the object property as an AnnounceServiceResultObject
+      #
+      # @return [AnnounceServiceResultObject, nil] AnnounceServiceResultObject
+      def object
+        o = get_property(Core::ActivityStreams2::Properties::OBJECT)
+        if o
+          AnnounceServiceResultObject.new(stream: o, validate_stream_on_construct: false,
+                                          validate_properties: @validate_properties, validators: @validators,
+                                          validation_context: Core::ActivityStreams2::Properties::OBJECT,
+                                          properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the object property of the notification
+      #
+      # @param value [AnnounceServiceResultObject] the object to set
+      def object=(value)
+        set_property(Core::ActivityStreams2::Properties::OBJECT, value.doc)
+      end
+
+      # Custom getter to retrieve the context property as an AnnounceServiceResultContext
+      #
+      # @return [AnnounceServiceResultContext, nil] AnnounceServiceResultContext
+      def context
+        c = get_property(Core::ActivityStreams2::Properties::CONTEXT)
+        if c
+          AnnounceServiceResultContext.new(stream: c, validate_stream_on_construct: false,
+                                           validate_properties: @validate_properties, validators: @validators,
+                                           validation_context: Core::ActivityStreams2::Properties::CONTEXT,
+                                           properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the context property of the notification
+      #
+      # @param value [AnnounceServiceResultContext] the context to set
+      def context=(value)
+        set_property(Core::ActivityStreams2::Properties::CONTEXT, value.doc)
+      end
+
+      # Extends the base validation to make `context` required
+      #
+      # @return [Boolean] true if valid, otherwise raises ValidationError
+      def validate
+        ve = Core::Notify::ValidationError.new
+
+        begin
+          super
+        rescue Core::Notify::ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::CONTEXT, context)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+
+    # Custom object class for Announce Service Result to provide the custom item getter
+    class AnnounceServiceResultContext < Core::Notify::NotifyObject
+      # Custom getter to retrieve the item property as an AnnounceServiceResultItem
+      #
+      # @return [AnnounceServiceResultItem, nil] the item
+      def item
+        i = get_property(Core::Notify::NotifyProperties::ITEM)
+        if i
+          AnnounceServiceResultItem.new(stream: i, validate_stream_on_construct: false,
+                                        validate_properties: @validate_properties, validators: @validators,
+                                        validation_context: Core::Notify::NotifyProperties::ITEM,
+                                        properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the item property
+      #
+      # @param value [AnnounceServiceResultItem] the item to set
+      def item=(value)
+        set_property(Core::Notify::NotifyProperties::ITEM, value.doc)
+      end
+    end
+
+    # Custom item class for Announce Service Result to apply the custom validation
+    class AnnounceServiceResultItem < Core::Notify::NotifyItem
+      # Beyond the base validation, apply the following:
+      #
+      # * Make type required and valid
+      # * Make the mediaType required
+      #
+      # @return [Boolean] true if validation passes, else raise a ValidationError
+      def validate
+        ve = Core::Notify::ValidationError.new
+
+        begin
+          super
+        rescue Core::Notify::ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::TYPE, type)
+        required(ve, Core::Notify::NotifyProperties::MEDIA_TYPE, media_type)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+
+    # Custom object class for Announce Service Result to apply the custom validation
+    class AnnounceServiceResultObject < Core::Notify::NotifyObject
+      # Extend the base validation to include the following constraints:
+      #
+      # * The object type is required and must validate
+      #
+      # @return [Boolean] true if validation passes, else raise a ValidationError
+      def validate
+        ve = Core::Notify::ValidationError.new
+
+        begin
+          super
+        rescue Core::Notify::ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::TYPE, type)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/reject.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+require_relative '../exceptions'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent a Reject notification
+    # https://coar-notify.net/specification/1.0.0/reject/
+    class Reject < Core::Notify::NotifyPattern
+      include Core::Notify::NestedPatternObjectMixin
+      include Core::Notify::SummaryMixin
+
+      # The Reject type
+      def self.type_constant
+        Core::ActivityStreams2::ActivityStreamsTypes::REJECT
+      end
+
+      # Validate the Reject pattern.
+      #
+      # In addition to the base validation, this:
+      #
+      # * Makes inReplyTo required
+      # * Requires the inReplyTo value to be the same as the object.id value
+      #
+      # @return [Boolean] true if valid, otherwise raises ValidationError
+      def validate
+        ve = ValidationError.new
+        begin
+          super
+        rescue ValidationError => superve
+          ve = superve
+        end
+
+        # Technically, no need to validate the value, as this is handled by the superclass,
+        # but leaving it in for completeness
+        required_and_validate(ve, Core::ActivityStreams2::Properties::IN_REPLY_TO, in_reply_to)
+
+        objid = object&.id
+        if in_reply_to != objid
+          ve.add_error(Core::ActivityStreams2::Properties::IN_REPLY_TO,
+                       "Expected inReplyTo id to be the same as the nested object id. inReplyTo: #{in_reply_to}, object.id: #{objid}")
+        end
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/request_endorsement.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent a RequestEndorsement notification
+    class RequestEndorsement < Core::Notify::NotifyPattern
+      def self.type_constant
+        [Core::ActivityStreams2::ActivityStreamsTypes::OFFER, Core::Notify::NotifyTypes::ENDORSEMENT_ACTION]
+      end
+
+      # Custom getter to retrieve the object property as a RequestEndorsementObject
+      #
+      # @return [RequestEndorsementObject, nil] the object
+      def object
+        o = get_property(Core::ActivityStreams2::Properties::OBJECT)
+        if o
+          RequestEndorsementObject.new(stream: o, validate_stream_on_construct: false,
+                                       validate_properties: @validate_properties, validators: @validators,
+                                       validation_context: Core::ActivityStreams2::Properties::OBJECT,
+                                       properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the object property of the notification
+      #
+      # @param value [RequestEndorsementObject] the object to set
+      def object=(value)
+        set_property(Core::ActivityStreams2::Properties::OBJECT, value.doc)
+      end
+    end
+
+    # Custom object class for Request Endorsement to provide the custom item getter
+    class RequestEndorsementObject < Core::Notify::NotifyObject
+      # Custom getter to retrieve the item property as a RequestEndorsementItem
+      #
+      # @return [RequestEndorsementItem, nil] the item
+      def item
+        i = get_property(Core::Notify::NotifyProperties::ITEM)
+        if i
+          RequestEndorsementItem.new(stream: i, validate_stream_on_construct: false,
+                                     validate_properties: @validate_properties, validators: @validators,
+                                     validation_context: Core::Notify::NotifyProperties::ITEM,
+                                     properties_by_reference: @properties_by_reference)
+        end
+      end
+
+      # Set the item property
+      #
+      # @param value [RequestEndorsementItem] the item to set
+      def item=(value)
+        set_property(Core::Notify::NotifyProperties::ITEM, value.doc)
+      end
+    end
+
+    # Custom item class for Request Endorsement to provide the custom validation
+    class RequestEndorsementItem < Core::Notify::NotifyItem
+      # Extend the base validation to include the following constraints:
+      #
+      # * The item type is required and must validate
+      # * The mediaType property is required
+      #
+      # @return [Boolean] true if validation passes, otherwise raise a ValidationError
+      def validate
+        ve = Core::Notify::ValidationError.new
+
+        begin
+          super
+        rescue Core::Notify::ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::TYPE, type)
+        required(ve, Core::Notify::NotifyProperties::MEDIA_TYPE, media_type)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/request_review.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+require_relative '../exceptions'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent a Request Review notification
+    # https://coar-notify.net/specification/1.0.0/request-review/
+    class RequestReview < Core::Notify::NotifyPattern
+      # Request Review types, including an ActivityStreams offer and a COAR Notify Review Action
+      def self.type_constant
+        [Core::ActivityStreams2::ActivityStreamsTypes::OFFER, Core::Notify::NotifyTypes::REVIEW_ACTION]
+      end
+
+      # Custom getter to retrieve the object property as a RequestReviewObject
+      #
+      # @return [RequestReviewObject, nil] the object
+      def object
+        o = get_property(Core::ActivityStreams2::Properties::OBJECT)
+        if o
+          RequestReviewObject.new(stream: o, validate_stream_on_construct: false,
+                                  validate_properties: @validate_properties, validators: @validators,
+                                  validation_context: Core::ActivityStreams2::Properties::OBJECT,
+                                  properties_by_reference: @properties_by_reference)
+        end
+      end
+    end
+
+    # Custom Request Review Object class to return the custom RequestReviewItem class
+    class RequestReviewObject < Core::Notify::NotifyObject
+      # Custom getter to retrieve the item property as a RequestReviewItem
+      #
+      # @return [RequestReviewItem, nil] the item
+      def item
+        i = get_property(Core::Notify::NotifyProperties::ITEM)
+        if i
+          RequestReviewItem.new(stream: i, validate_stream_on_construct: false,
+                                validate_properties: @validate_properties, validators: @validators,
+                                validation_context: Core::Notify::NotifyProperties::ITEM,
+                                properties_by_reference: @properties_by_reference)
+        end
+      end
+    end
+
+    # Custom Request Review Item class to provide the custom validation
+    class RequestReviewItem < Core::Notify::NotifyItem
+      # Extend the base validation to include the following constraints:
+      #
+      # * The type property is required and must validate
+      # * the mediaType property is required
+      #
+      # @return [Boolean] true if validation passes, else raise a ValidationError
+      def validate
+        ve = ValidationError.new
+        begin
+          super
+        rescue ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::TYPE, type)
+        required(ve, Core::Notify::NotifyProperties::MEDIA_TYPE, media_type)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/tentatively_accept.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+require_relative '../exceptions'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent a TentativelyAccept notification
+    # https://coar-notify.net/specification/1.0.0/tentatively-accept/
+    class TentativelyAccept < Core::Notify::NotifyPattern
+      include Core::Notify::NestedPatternObjectMixin
+      include Core::Notify::SummaryMixin
+
+      # The TentativelyAccept type
+      def self.type_constant
+        Core::ActivityStreams2::ActivityStreamsTypes::TENTATIVE_ACCEPT
+      end
+
+      # Validate the TentativelyAccept pattern.
+      #
+      # In addition to the base validation, this:
+      #
+      # * Makes inReplyTo required
+      # * Requires the inReplyTo value to be the same as the object.id value
+      #
+      # @return [Boolean] true if valid, otherwise raises ValidationError
+      def validate
+        ve = ValidationError.new
+        begin
+          super
+        rescue ValidationError => superve
+          ve = superve
+        end
+
+        # Technically, no need to validate the value, as this is handled by the superclass,
+        # but leaving it in for completeness
+        required_and_validate(ve, Core::ActivityStreams2::Properties::IN_REPLY_TO, in_reply_to)
+
+        objid = object&.id
+        if in_reply_to != objid
+          ve.add_error(Core::ActivityStreams2::Properties::IN_REPLY_TO,
+                       "Expected inReplyTo id to be the same as the nested object id. inReplyTo: #{in_reply_to}, object.id: #{objid}")
+        end
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/tentatively_reject.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+require_relative '../exceptions'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent a TentativelyReject notification
+    # https://coar-notify.net/specification/1.0.0/tentative-reject/
+    class TentativelyReject < Core::Notify::NotifyPattern
+      include Core::Notify::NestedPatternObjectMixin
+      include Core::Notify::SummaryMixin
+
+      def self.type_constant
+        Core::ActivityStreams2::ActivityStreamsTypes::TENTATIVE_REJECT
+      end
+
+      def validate
+        ve = ValidationError.new
+        begin
+          super
+        rescue ValidationError => superve
+          ve = superve
+        end
+
+        required_and_validate(ve, Core::ActivityStreams2::Properties::IN_REPLY_TO, in_reply_to)
+
+        objid = object&.id
+        if in_reply_to != objid
+          ve.add_error(Core::ActivityStreams2::Properties::IN_REPLY_TO,
+                       "Expected inReplyTo id to be the same as the nested object id. inReplyTo: #{in_reply_to}, object.id: #{objid}")
+        end
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/undo_offer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+require_relative '../exceptions'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent the Undo Offer notification
+    # https://coar-notify.net/specification/1.0.0/undo-offer/
+    class UndoOffer < Core::Notify::NotifyPattern
+      include Core::Notify::NestedPatternObjectMixin
+      include Core::Notify::SummaryMixin
+
+      def self.type_constant
+        Core::ActivityStreams2::ActivityStreamsTypes::UNDO
+      end
+
+      # In addition to the base validation apply the following constraints:
+      #
+      # * The inReplyTo property is required
+      # * The inReplyTo value must match the object.id value
+      #
+      # @return [Boolean] true if validation passes, otherwise raise a ValidationError
+      def validate
+        ve = ValidationError.new
+        begin
+          super
+        rescue ValidationError => superve
+          ve = superve
+        end
+
+        # Technically, no need to validate the value, as this is handled by the superclass,
+        # but leaving it in for completeness
+        required_and_validate(ve, Core::ActivityStreams2::Properties::IN_REPLY_TO, in_reply_to)
+
+        objid = object&.id
+        if in_reply_to != objid
+          ve.add_error(Core::ActivityStreams2::Properties::IN_REPLY_TO,
+                       "Expected inReplyTo id to be the same as the nested object id. inReplyTo: #{in_reply_to}, object.id: #{objid}")
+        end
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end

data/lib/coarnotify/patterns/unprocessable_notification.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative '../core/notify'
+require_relative '../core/activity_streams2'
+require_relative '../exceptions'
+
+module Coarnotify
+  module Patterns
+    # Pattern to represent the Unprocessable Notification notification
+    # https://coar-notify.net/specification/1.0.0/unprocessable/
+    class UnprocessableNotification < Core::Notify::NotifyPattern
+      include Core::Notify::SummaryMixin
+
+      def self.type_constant
+        Core::Notify::NotifyTypes::UNPROCESSABLE_NOTIFICATION
+      end
+
+      # In addition to the base validation apply the following constraints:
+      #
+      # * The inReplyTo property is required
+      # * The summary property is required
+      #
+      # @return [Boolean] true if validation passes, otherwise raise a ValidationError
+      def validate
+        ve = ValidationError.new
+        begin
+          super
+        rescue ValidationError => superve
+          ve = superve
+        end
+
+        # Technically, no need to validate the value, as this is handled by the superclass,
+        # but leaving it in for completeness
+        required_and_validate(ve, Core::ActivityStreams2::Properties::IN_REPLY_TO, in_reply_to)
+        required(ve, Core::ActivityStreams2::Properties::SUMMARY, summary)
+
+        raise ve if ve.has_errors?
+        true
+      end
+    end
+  end
+end