Contents

# frozen_string_literal: true

module MediaWiktory::Wikipedia
  module Actions
    # Get the difference between 2 pages.
    #
    # Usage:
    #
    # ```ruby
    # api.compare.fromtitle(value).perform # returns string with raw output
    # # or
    # api.compare.fromtitle(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 Compare < MediaWiktory::Wikipedia::Actions::Get

      # First title to compare.
      #
      # @param value [String]
      # @return [self]
      def fromtitle(value)
        merge(fromtitle: value.to_s)
      end

      # First page ID to compare.
      #
      # @param value [Integer]
      # @return [self]
      def fromid(value)
        merge(fromid: value.to_s)
      end

      # First revision to compare.
      #
      # @param value [Integer]
      # @return [self]
      def fromrev(value)
        merge(fromrev: value.to_s)
      end

      # Second title to compare.
      #
      # @param value [String]
      # @return [self]
      def totitle(value)
        merge(totitle: value.to_s)
      end

      # Second page ID to compare.
      #
      # @param value [Integer]
      # @return [self]
      def toid(value)
        merge(toid: value.to_s)
      end

      # Second revision to compare.
      #
      # @param value [Integer]
      # @return [self]
      def torev(value)
        merge(torev: value.to_s)
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

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