mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # This module has been disabled.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.imagerotate.perform # returns string with raw output
+    # # or
+    # api.imagerotate.response # returns output parsed and wrapped into Mash-like object
+    # ```
+    #
+    # This action has no parameters.
+    #
+    # 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 Imagerotate < MediaWiktory::Wikipedia::Actions::Get
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Import a page from another wiki, or from an XML file.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.import.summary(value).perform # returns string with raw output
+    # # or
+    # api.import.summary(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 Import < MediaWiktory::Wikipedia::Actions::Post
+
+      # Log entry import summary.
+      #
+      # @param value [String]
+      # @return [self]
+      def summary(value)
+        merge(summary: value.to_s)
+      end
+
+      # Uploaded XML file.
+      #
+      # @param value [String]
+      # @return [self]
+      def xml(value)
+        merge(xml: value.to_s)
+      end
+
+      # For interwiki imports: wiki to import from.
+      #
+      # @param value [String] One of "meta", "nost", "de", "es", "fr", "it", "pl", "outreachwiki", "test2wiki".
+      # @return [self]
+      def interwikisource(value)
+        _interwikisource(value) or fail ArgumentError, "Unknown value for interwikisource: #{value}"
+      end
+
+      # @private
+      def _interwikisource(value)
+        defined?(super) && super || ["meta", "nost", "de", "es", "fr", "it", "pl", "outreachwiki", "test2wiki"].include?(value.to_s) && merge(interwikisource: value.to_s)
+      end
+
+      # For interwiki imports: page to import.
+      #
+      # @param value [String]
+      # @return [self]
+      def interwikipage(value)
+        merge(interwikipage: value.to_s)
+      end
+
+      # For interwiki imports: import the full history, not just the current version.
+      #
+      # @return [self]
+      def fullhistory()
+        merge(fullhistory: 'true')
+      end
+
+      # For interwiki imports: import all included templates as well.
+      #
+      # @return [self]
+      def templates()
+        merge(templates: 'true')
+      end
+
+      # Import to this namespace. Cannot be used together with rootpage.
+      #
+      # @param value [String] One of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303".
+      # @return [self]
+      def namespace(value)
+        _namespace(value) or fail ArgumentError, "Unknown value for namespace: #{value}"
+      end
+
+      # @private
+      def _namespace(value)
+        defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(namespace: value.to_s)
+      end
+
+      # Import as subpage of this page. Cannot be used together with namespace.
+      #
+      # @param value [String]
+      # @return [self]
+      def rootpage(value)
+        merge(rootpage: value.to_s)
+      end
+
+      # Change tags to apply to the entry in the import log and to the null revision on the imported pages.
+      #
+      # @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/jsonconfig.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Allows direct access to JsonConfig subsystem.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.jsonconfig.command(value).perform # returns string with raw output
+    # # or
+    # api.jsonconfig.command(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 Jsonconfig < MediaWiktory::Wikipedia::Actions::Get
+
+      # Which sub-action to perform on JsonConfig:
+      #
+      # @param value [String] One of "status" (Shows JsonConfig configuration), "reset" (Clears configurations from cache. Requires title parameter and jsonconfig-reset right), "reload" (Reloads and caches configurations from config store. Requires title parameter and jsonconfig-reset right).
+      # @return [self]
+      def command(value)
+        _command(value) or fail ArgumentError, "Unknown value for command: #{value}"
+      end
+
+      # @private
+      def _command(value)
+        defined?(super) && super || ["status", "reset", "reload"].include?(value.to_s) && merge(command: value.to_s)
+      end
+
+      # Namespace number of the title to process.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def namespace(value)
+        merge(namespace: value.to_s)
+      end
+
+      # Title to process without namespace prefix.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # For command=reload, use this content instead.
+      #
+      # @param value [String]
+      # @return [self]
+      def content(value)
+        merge(content: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Retrieve localized JSON data.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.jsondata.title(value).perform # returns string with raw output
+    # # or
+    # api.jsondata.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 Jsondata < MediaWiktory::Wikipedia::Actions::Get
+
+      # Title to get. By default assumes namespace to be "Data:"
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Search for language names in any script.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.languagesearch.search(value).perform # returns string with raw output
+    # # or
+    # api.languagesearch.search(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 Languagesearch < MediaWiktory::Wikipedia::Actions::Get
+
+      # Search string.
+      #
+      # @param value [String]
+      # @return [self]
+      def search(value)
+        merge(search: value.to_s)
+      end
+
+      # Number of spelling mistakes allowed in the search string.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def typos(value)
+        merge(typos: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Link an account from a third-party provider to the current user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.linkaccount.requests(value).perform # returns string with raw output
+    # # or
+    # api.linkaccount.requests(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 Linkaccount < MediaWiktory::Wikipedia::Actions::Post
+
+      # Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=link or from a previous response from this module.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def requests(*values)
+        values.inject(self) { |res, val| res._requests(val) }
+      end
+
+      # @private
+      def _requests(value)
+        merge(linkrequests: value.to_s, replace: false)
+      end
+
+      # Format to use for returning messages.
+      #
+      # @param value [String] One of "html", "wikitext", "raw", "none".
+      # @return [self]
+      def messageformat(value)
+        _messageformat(value) or fail ArgumentError, "Unknown value for messageformat: #{value}"
+      end
+
+      # @private
+      def _messageformat(value)
+        defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(linkmessageformat: value.to_s)
+      end
+
+      # Merge field information for all authentication requests into one array.
+      #
+      # @return [self]
+      def mergerequestfields()
+        merge(linkmergerequestfields: 'true')
+      end
+
+      # Return URL for third-party authentication flows, must be absolute. Either this or linkcontinue is required.
+      #
+      # @param value [String]
+      # @return [self]
+      def returnurl(value)
+        merge(linkreturnurl: value.to_s)
+      end
+
+      # This request is a continuation after an earlier UI or REDIRECT response. Either this or linkreturnurl is required.
+      #
+      # @return [self]
+      def continue()
+        merge(linkcontinue: 'true')
+      end
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(linktoken: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get the usernames and other information for students enrolled in one or more courses.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.liststudents.courseids(value).perform # returns string with raw output
+    # # or
+    # api.liststudents.courseids(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 Liststudents < MediaWiktory::Wikipedia::Actions::Get
+
+      # IDs of the courses.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def courseids(*values)
+        values.inject(self) { |res, val| res._courseids(val) }
+      end
+
+      # @private
+      def _courseids(value)
+        merge(courseids: value.to_s, replace: false)
+      end
+
+      # Which property to get for each student:
+      #
+      # @param value [String] One of "username" (The username of the student), "id" (The user ID of the student).
+      # @return [self]
+      def prop(value)
+        _prop(value) or fail ArgumentError, "Unknown value for prop: #{value}"
+      end
+
+      # @private
+      def _prop(value)
+        defined?(super) && super || ["username", "id"].include?(value.to_s) && merge(prop: value.to_s)
+      end
+
+      # If given, the query will group students by course.
+      #
+      # @return [self]
+      def group()
+        merge(group: 'true')
+      end
+
+      # If given, the query will return usernames in CSV format, and it will return the articles assigned to those students.
+      #
+      # @return [self]
+      def csv()
+        merge(csv: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Log in and get authentication cookies.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.login.name(value).perform # returns string with raw output
+    # # or
+    # api.login.name(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 Login < MediaWiktory::Wikipedia::Actions::Post
+
+      # User name.
+      #
+      # @param value [String]
+      # @return [self]
+      def name(value)
+        merge(lgname: value.to_s)
+      end
+
+      # Password.
+      #
+      # @param value [String]
+      # @return [self]
+      def password(value)
+        merge(lgpassword: value.to_s)
+      end
+
+      # Domain (optional).
+      #
+      # @param value [String]
+      # @return [self]
+      def domain(value)
+        merge(lgdomain: value.to_s)
+      end
+
+      # A "login" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(lgtoken: value.to_s)
+      end
+    end
+  end
+end