Module: MediaWiktory::Wikipedia::Modules::GAllrevisions

Defined in:
lib/mediawiktory/wikipedia/modules/g-allrevisions.rb

Overview

List all revisions. Generator module: for fetching pages corresponding to request.

The "submodule" (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for Actions::Query and its submodules):

api.query             # returns Actions::Query
   .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
   .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

All submodule's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Instance Method Details

#contentformat(value) ⇒ self

Serialization format used for arvdifftotext and expected for output of content.

Parameters:

  • value (String) —

    One of "application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain".

Returns:

  • (self) 


85
86
87
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 85

def contentformat(value)
  _contentformat(value) or fail ArgumentError, "Unknown value for contentformat: #{value}"
end

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


156
157
158
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 156

def continue(value)
  merge(garvcontinue: value.to_s)
end

#diffto(value) ⇒ self

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

Parameters:

  • value (String)

Returns:

  • (self) 


62
63
64
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 62

def diffto(value)
  merge(garvdiffto: value.to_s)
end

#difftotext(value) ⇒ self

Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text.

Parameters:

  • value (String)

Returns:

  • (self) 


70
71
72
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 70

def difftotext(value)
  merge(garvdifftotext: value.to_s)
end

#difftotextpst ⇒ self

Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.

Returns:

  • (self) 


77
78
79
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 77

def difftotextpst()
  merge(garvdifftotextpst: 'true')
end

#dir(value) ⇒ self

In which direction to enumerate:

Parameters:

  • value (String) —

    One of "newer" (List oldest first. Note: arvstart has to be before arvend), "older" (List newest first (default). Note: arvstart has to be later than arvend).

Returns:

  • (self) 


135
136
137
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 135

def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end

#end(value) ⇒ self

The timestamp to stop enumerating at.

Parameters:

  • value (Time)

Returns:

  • (self) 


127
128
129
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 127

def end(value)
  merge(garvend: value.iso8601)
end

#excludeuser(value) ⇒ self

Don't list revisions by this user.

Parameters:

  • value (String)

Returns:

  • (self) 


148
149
150
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 148

def excludeuser(value)
  merge(garvexcludeuser: value.to_s)
end

#expandtemplates ⇒ self

Expand templates in revision content (requires arvprop=content).

Returns:

  • (self) 


32
33
34
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 32

def expandtemplates()
  merge(garvexpandtemplates: 'true')
end

#generatetitles ⇒ self

When being used as a generator, generate titles rather than revision IDs.

Returns:

  • (self) 


163
164
165
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 163

def generatetitles()
  merge(garvgeneratetitles: 'true')
end

#generatexml ⇒ self

Generate XML parse tree for revision content (requires arvprop=content; replaced by arvprop=parsetree).

Returns:

  • (self) 


39
40
41
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 39

def generatexml()
  merge(garvgeneratexml: 'true')
end

#limit(value) ⇒ self

Limit how many revisions will be returned.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 25

def limit(value)
  merge(garvlimit: value.to_s)
end

#namespace(*values) ⇒ self

Only list pages in this namespace.

Parameters:

  • values (Array<String>) —

    Allowed values: "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".

Returns:

  • (self) 


106
107
108
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 106

def namespace(*values)
  values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
end

#parse ⇒ self

Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1.

Returns:

  • (self) 


46
47
48
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 46

def parse()
  merge(garvparse: 'true')
end

#section(value) ⇒ self

Only retrieve the content of this section number.

Parameters:

  • value (String)

Returns:

  • (self) 


54
55
56
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 54

def section(value)
  merge(garvsection: value.to_s)
end

#start(value) ⇒ self

The timestamp to start enumerating from.

Parameters:

  • value (Time)

Returns:

  • (self) 


119
120
121
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 119

def start(value)
  merge(garvstart: value.iso8601)
end

#user(value) ⇒ self

Only list revisions by this user.

Parameters:

  • value (String)

Returns:

  • (self) 


98
99
100
 
# File 'lib/mediawiktory/wikipedia/modules/g-allrevisions.rb', line 98

def user(value)
  merge(garvuser: value.to_s)
end