Contents

# frozen_string_literal: true

module MediaWiktory::Wikipedia
  module Actions
    # Review a revision by approving or de-approving it.
    #
    # Usage:
    #
    # ```ruby
    # api.review.revid(value).perform # returns string with raw output
    # # or
    # api.review.revid(value).response # returns output parsed and wrapped into Response object
    # ```
    #
    # See {Base} for generic explanation of working with MediaWiki actions and
    # {MediaWiktory::Wikipedia::Response} for working with action responses.
    #
    # All action's parameters are documented as its public methods, see below.
    #
    class Review < MediaWiktory::Wikipedia::Actions::Post

      # The revision ID for which to set the flags.
      #
      # @param value [String]
      # @return [self]
      def revid(value)
        merge(revid: value.to_s)
      end

      # A "csrf" token retrieved from action=query&meta=tokens
      #
      # @param value [String]
      # @return [self]
      def token(value)
        merge(token: value.to_s)
      end

      # Comment for the review.
      #
      # @param value [String]
      # @return [self]
      def comment(value)
        merge(comment: value.to_s)
      end

      # If set, revision will be unapproved rather than approved.
      #
      # @return [self]
      def unapprove()
        merge(unapprove: 'true')
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
mediawiktory-0.1.3	lib/mediawiktory/wikipedia/actions/review.rb
mediawiktory-0.1.2	lib/mediawiktory/wikipedia/actions/review.rb
mediawiktory-0.1.1	lib/mediawiktory/wikipedia/actions/review.rb
mediawiktory-0.1.0	lib/mediawiktory/wikipedia/actions/review.rb