mediawiktory 0.0.3 → 0.1.0

data/lib/mediawiktory/wikipedia/actions/templatedata.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Fetch data stored by the TemplateData extension.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.templatedata.titles(value).perform # returns string with raw output
+    # # or
+    # api.templatedata.titles(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 Templatedata < MediaWiktory::Wikipedia::Actions::Get
+
+      # A list of titles to work on.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def titles(*values)
+        values.inject(self) { |res, val| res._titles(val) }
+      end
+
+      # @private
+      def _titles(value)
+        merge(titles: value.to_s, replace: false)
+      end
+
+      # A list of page IDs to work on.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def pageids(*values)
+        values.inject(self) { |res, val| res._pageids(val) }
+      end
+
+      # @private
+      def _pageids(value)
+        merge(pageids: value.to_s, replace: false)
+      end
+
+      # A list of revision IDs to work on.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def revids(*values)
+        values.inject(self) { |res, val| res._revids(val) }
+      end
+
+      # @private
+      def _revids(value)
+        merge(revids: value.to_s, replace: false)
+      end
+
+      # Get the list of pages to work on by executing the specified query module.
+      #
+      # @param value [Symbol] Selecting an option includes tweaking methods from corresponding module:
+      #   * `:allcategories` - {MediaWiktory::Wikipedia::Modules::Allcategories} Enumerate all categories.
+      #   * `:alldeletedrevisions` - {MediaWiktory::Wikipedia::Modules::Alldeletedrevisions} List all deleted revisions by a user or in a namespace.
+      #   * `:allfileusages` - {MediaWiktory::Wikipedia::Modules::Allfileusages} List all file usages, including non-existing.
+      #   * `:allimages` - {MediaWiktory::Wikipedia::Modules::Allimages} Enumerate all images sequentially.
+      #   * `:alllinks` - {MediaWiktory::Wikipedia::Modules::Alllinks} Enumerate all links that point to a given namespace.
+      #   * `:allpages` - {MediaWiktory::Wikipedia::Modules::Allpages} Enumerate all pages sequentially in a given namespace.
+      #   * `:allredirects` - {MediaWiktory::Wikipedia::Modules::Allredirects} List all redirects to a namespace.
+      #   * `:allrevisions` - {MediaWiktory::Wikipedia::Modules::Allrevisions} List all revisions.
+      #   * `:alltransclusions` - {MediaWiktory::Wikipedia::Modules::Alltransclusions} List all transclusions (pages embedded using {{x}}), including non-existing.
+      #   * `:backlinks` - {MediaWiktory::Wikipedia::Modules::Backlinks} Find all pages that link to the given page.
+      #   * `:categories` - {MediaWiktory::Wikipedia::Modules::Categories} List all categories the pages belong to.
+      #   * `:categorymembers` - {MediaWiktory::Wikipedia::Modules::Categorymembers} List all pages in a given category.
+      #   * `:contenttranslation` - {MediaWiktory::Wikipedia::Modules::Contenttranslation} Query Content Translation database for translations.
+      #   * `:contenttranslationsuggestions` - {MediaWiktory::Wikipedia::Modules::Contenttranslationsuggestions} Get suggestion lists for Content Translation.
+      #   * `:deletedrevisions` - {MediaWiktory::Wikipedia::Modules::Deletedrevisions} Get deleted revision information.
+      #   * `:duplicatefiles` - {MediaWiktory::Wikipedia::Modules::Duplicatefiles} List all files that are duplicates of the given files based on hash values.
+      #   * `:embeddedin` - {MediaWiktory::Wikipedia::Modules::Embeddedin} Find all pages that embed (transclude) the given title.
+      #   * `:exturlusage` - {MediaWiktory::Wikipedia::Modules::Exturlusage} Enumerate pages that contain a given URL.
+      #   * `:fileusage` - {MediaWiktory::Wikipedia::Modules::Fileusage} Find all pages that use the given files.
+      #   * `:geosearch` - {MediaWiktory::Wikipedia::Modules::Geosearch} Returns pages having coordinates that are located in a certain area.
+      #   * `:gettingstartedgetpages` - {MediaWiktory::Wikipedia::Modules::Gettingstartedgetpages} This API is for getting a list of one or more pages related to a particular GettingStarted task.
+      #   * `:images` - {MediaWiktory::Wikipedia::Modules::Images} Returns all files contained on the given pages.
+      #   * `:imageusage` - {MediaWiktory::Wikipedia::Modules::Imageusage} Find all pages that use the given image title.
+      #   * `:iwbacklinks` - {MediaWiktory::Wikipedia::Modules::Iwbacklinks} Find all pages that link to the given interwiki link.
+      #   * `:langbacklinks` - {MediaWiktory::Wikipedia::Modules::Langbacklinks} Find all pages that link to the given language link.
+      #   * `:links` - {MediaWiktory::Wikipedia::Modules::Links} Returns all links from the given pages.
+      #   * `:linkshere` - {MediaWiktory::Wikipedia::Modules::Linkshere} Find all pages that link to the given pages.
+      #   * `:mostviewed` - {MediaWiktory::Wikipedia::Modules::Mostviewed} Lists the most viewed pages (based on last day's pageview count).
+      #   * `:oldreviewedpages` - {MediaWiktory::Wikipedia::Modules::Oldreviewedpages} Enumerates pages that have changes pending review.
+      #   * `:pageswithprop` - {MediaWiktory::Wikipedia::Modules::Pageswithprop} List all pages using a given page property.
+      #   * `:prefixsearch` - {MediaWiktory::Wikipedia::Modules::Prefixsearch} Perform a prefix search for page titles.
+      #   * `:projectpages` - {MediaWiktory::Wikipedia::Modules::Projectpages} List all pages associated with one or more projects.
+      #   * `:protectedtitles` - {MediaWiktory::Wikipedia::Modules::Protectedtitles} List all titles protected from creation.
+      #   * `:querypage` - {MediaWiktory::Wikipedia::Modules::Querypage} Get a list provided by a QueryPage-based special page.
+      #   * `:random` - {MediaWiktory::Wikipedia::Modules::Random} Get a set of random pages.
+      #   * `:recentchanges` - {MediaWiktory::Wikipedia::Modules::Recentchanges} Enumerate recent changes.
+      #   * `:redirects` - {MediaWiktory::Wikipedia::Modules::Redirects} Returns all redirects to the given pages.
+      #   * `:revisions` - {MediaWiktory::Wikipedia::Modules::Revisions} Get revision information.
+      #   * `:search` - {MediaWiktory::Wikipedia::Modules::Search} Perform a full text search.
+      #   * `:templates` - {MediaWiktory::Wikipedia::Modules::Templates} Returns all pages transcluded on the given pages.
+      #   * `:transcludedin` - {MediaWiktory::Wikipedia::Modules::Transcludedin} Find all pages that transclude the given pages.
+      #   * `:watchlist` - {MediaWiktory::Wikipedia::Modules::Watchlist} Get recent changes to pages in the current user's watchlist.
+      #   * `:watchlistraw` - {MediaWiktory::Wikipedia::Modules::Watchlistraw} Get all pages on the current user's watchlist.
+      #   * `:wblistentityusage` - {MediaWiktory::Wikipedia::Modules::Wblistentityusage} Returns all pages that use the given entity IDs.
+      # @return [self]
+      def generator(value)
+        _generator(value) or fail ArgumentError, "Unknown value for generator: #{value}"
+      end
+
+      # @private
+      def _generator(value)
+        defined?(super) && super || [:allcategories, :alldeletedrevisions, :allfileusages, :allimages, :alllinks, :allpages, :allredirects, :allrevisions, :alltransclusions, :backlinks, :categories, :categorymembers, :contenttranslation, :contenttranslationsuggestions, :deletedrevisions, :duplicatefiles, :embeddedin, :exturlusage, :fileusage, :geosearch, :gettingstartedgetpages, :images, :imageusage, :iwbacklinks, :langbacklinks, :links, :linkshere, :mostviewed, :oldreviewedpages, :pageswithprop, :prefixsearch, :projectpages, :protectedtitles, :querypage, :random, :recentchanges, :redirects, :revisions, :search, :templates, :transcludedin, :watchlist, :watchlistraw, :wblistentityusage].include?(value.to_sym) && merge(generator: value.to_s).submodule({allcategories: Modules::Allcategories, alldeletedrevisions: Modules::Alldeletedrevisions, allfileusages: Modules::Allfileusages, allimages: Modules::Allimages, alllinks: Modules::Alllinks, allpages: Modules::Allpages, allredirects: Modules::Allredirects, allrevisions: Modules::Allrevisions, alltransclusions: Modules::Alltransclusions, backlinks: Modules::Backlinks, categories: Modules::Categories, categorymembers: Modules::Categorymembers, contenttranslation: Modules::Contenttranslation, contenttranslationsuggestions: Modules::Contenttranslationsuggestions, deletedrevisions: Modules::Deletedrevisions, duplicatefiles: Modules::Duplicatefiles, embeddedin: Modules::Embeddedin, exturlusage: Modules::Exturlusage, fileusage: Modules::Fileusage, geosearch: Modules::Geosearch, gettingstartedgetpages: Modules::Gettingstartedgetpages, images: Modules::Images, imageusage: Modules::Imageusage, iwbacklinks: Modules::Iwbacklinks, langbacklinks: Modules::Langbacklinks, links: Modules::Links, linkshere: Modules::Linkshere, mostviewed: Modules::Mostviewed, oldreviewedpages: Modules::Oldreviewedpages, pageswithprop: Modules::Pageswithprop, prefixsearch: Modules::Prefixsearch, projectpages: Modules::Projectpages, protectedtitles: Modules::Protectedtitles, querypage: Modules::Querypage, random: Modules::Random, recentchanges: Modules::Recentchanges, redirects: Modules::Redirects, revisions: Modules::Revisions, search: Modules::Search, templates: Modules::Templates, transcludedin: Modules::Transcludedin, watchlist: Modules::Watchlist, watchlistraw: Modules::Watchlistraw, wblistentityusage: Modules::Wblistentityusage}[value.to_sym])
+      end
+
+      # Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.
+      #
+      # @return [self]
+      def redirects()
+        merge(redirects: 'true')
+      end
+
+      # Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz and zh.
+      #
+      # @return [self]
+      def converttitles()
+        merge(converttitles: 'true')
+      end
+
+      # Return data about titles even if they are missing or lack TemplateData. By default (for backwards compatibility) titles are only returned if they exist and have TemplateData.
+      #
+      # @return [self]
+      def doNotIgnoreMissingTitles()
+        merge(doNotIgnoreMissingTitles: 'true')
+      end
+
+      # Return localized values in this language. By default all available translations are returned.
+      #
+      # @param value [String]
+      # @return [self]
+      def lang(value)
+        merge(lang: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/thank.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Send a thank-you notification to an editor.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.thank.rev(value).perform # returns string with raw output
+    # # or
+    # api.thank.rev(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 Thank < MediaWiktory::Wikipedia::Actions::Post
+
+      # Revision ID to thank someone for.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def rev(value)
+        merge(rev: 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
+
+      # A short string describing the source of the request, for example diff or history.
+      #
+      # @param value [String]
+      # @return [self]
+      def source(value)
+        merge(source: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/titleblacklist.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Validate an article title, filename, or username against the TitleBlacklist.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.titleblacklist.title(value).perform # returns string with raw output
+    # # or
+    # api.titleblacklist.title(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 Titleblacklist < MediaWiktory::Wikipedia::Actions::Get
+
+      # The string to validate against the blacklist.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(tbtitle: value.to_s)
+      end
+
+      # The action to be checked.
+      #
+      # @param value [String] One of "create", "edit", "upload", "createtalk", "createpage", "move", "new-account".
+      # @return [self]
+      def action(value)
+        _action(value) or fail ArgumentError, "Unknown value for action: #{value}"
+      end
+
+      # @private
+      def _action(value)
+        defined?(super) && super || ["create", "edit", "upload", "createtalk", "createpage", "move", "new-account"].include?(value.to_s) && merge(tbaction: value.to_s)
+      end
+
+      # Don't try to override the titleblacklist.
+      #
+      # @return [self]
+      def nooverride()
+        merge(tbnooverride: 'true')
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/tokens.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get tokens for data-modifying actions.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.tokens.type(value).perform # returns string with raw output
+    # # or
+    # api.tokens.type(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 Tokens < MediaWiktory::Wikipedia::Actions::Get
+
+      # Types of token to request.
+      #
+      # @param values [Array<String>] Allowed values: "block", "createaccount", "csrf", "delete", "deleteglobalaccount", "edit", "email", "import", "login", "move", "options", "patrol", "protect", "rollback", "setglobalaccountstatus", "unblock", "userrights", "watch".
+      # @return [self]
+      def type(*values)
+        values.inject(self) { |res, val| res._type(val) or fail ArgumentError, "Unknown value for type: #{val}" }
+      end
+
+      # @private
+      def _type(value)
+        defined?(super) && super || ["block", "createaccount", "csrf", "delete", "deleteglobalaccount", "edit", "email", "import", "login", "move", "options", "patrol", "protect", "rollback", "setglobalaccountstatus", "unblock", "userrights", "watch"].include?(value.to_s) && merge(type: value.to_s, replace: false)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/transcodereset.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Users with the 'transcode-reset' right can reset and re-run a transcode job.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.transcodereset.title(value).perform # returns string with raw output
+    # # or
+    # api.transcodereset.title(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 Transcodereset < MediaWiktory::Wikipedia::Actions::Post
+
+      # The media file title.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # The transcode key you wish to reset. Fetch from action=query&prop=transcodestatus.
+      #
+      # @param value [String]
+      # @return [self]
+      def transcodekey(value)
+        merge(transcodekey: 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
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/ulslocalization.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get the localization of ULS in the given language.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.ulslocalization.language(value).perform # returns string with raw output
+    # # or
+    # api.ulslocalization.language(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 Ulslocalization < MediaWiktory::Wikipedia::Actions::Get
+
+      # Language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def language(value)
+        merge(language: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/unblock.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Unblock a user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.unblock.id(value).perform # returns string with raw output
+    # # or
+    # api.unblock.id(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 Unblock < MediaWiktory::Wikipedia::Actions::Post
+
+      # ID of the block to unblock (obtained through list=blocks). Cannot be used together with user or userid.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def id(value)
+        merge(id: value.to_s)
+      end
+
+      # Username, IP address or IP address range to unblock. Cannot be used together with id or userid.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # User ID to unblock. Cannot be used together with id or user.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def userid(value)
+        merge(userid: value.to_s)
+      end
+
+      # Reason for unblock.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # Change tags to apply to the entry in the block log.
+      #
+      # @param values [Array<String>] Allowed values: "ProveIt edit", "WPCleaner", "huggle", "large plot addition".
+      # @return [self]
+      def tags(*values)
+        values.inject(self) { |res, val| res._tags(val) or fail ArgumentError, "Unknown value for tags: #{val}" }
+      end
+
+      # @private
+      def _tags(value)
+        defined?(super) && super || ["ProveIt edit", "WPCleaner", "huggle", "large plot addition"].include?(value.to_s) && merge(tags: value.to_s, replace: false)
+      end
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(token: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/undelete.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Restore revisions of a deleted page.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.undelete.title(value).perform # returns string with raw output
+    # # or
+    # api.undelete.title(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 Undelete < MediaWiktory::Wikipedia::Actions::Post
+
+      # Title of the page to restore.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # Reason for restoring.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # Change tags to apply to the entry in the deletion log.
+      #
+      # @param values [Array<String>] Allowed values: "ProveIt edit", "WPCleaner", "huggle", "large plot addition".
+      # @return [self]
+      def tags(*values)
+        values.inject(self) { |res, val| res._tags(val) or fail ArgumentError, "Unknown value for tags: #{val}" }
+      end
+
+      # @private
+      def _tags(value)
+        defined?(super) && super || ["ProveIt edit", "WPCleaner", "huggle", "large plot addition"].include?(value.to_s) && merge(tags: value.to_s, replace: false)
+      end
+
+      # Timestamps of the revisions to restore. If both timestamps and fileids are empty, all will be restored.
+      #
+      # @param values [Array<Time>]
+      # @return [self]
+      def timestamps(*values)
+        values.inject(self) { |res, val| res._timestamps(val) }
+      end
+
+      # @private
+      def _timestamps(value)
+        merge(timestamps: value.iso8601, replace: false)
+      end
+
+      # IDs of the file revisions to restore. If both timestamps and fileids are empty, all will be restored.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def fileids(*values)
+        values.inject(self) { |res, val| res._fileids(val) }
+      end
+
+      # @private
+      def _fileids(value)
+        merge(fileids: value.to_s, replace: false)
+      end
+
+      # Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
+      #
+      # @param value [String] One of "watch", "unwatch", "preferences", "nochange".
+      # @return [self]
+      def watchlist(value)
+        _watchlist(value) or fail ArgumentError, "Unknown value for watchlist: #{value}"
+      end
+
+      # @private
+      def _watchlist(value)
+        defined?(super) && super || ["watch", "unwatch", "preferences", "nochange"].include?(value.to_s) && merge(watchlist: 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
+    end
+  end
+end