Module: MediaWiktory::Wikipedia::Modules::GRevisions

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

Overview

Get revision information. 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 rvdifftotext 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-revisions.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) 


180
181
182
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 180

def continue(value)
  merge(grvcontinue: 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-revisions.rb', line 62

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

#difftotext(value) ⇒ self

Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection 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-revisions.rb', line 70

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

#difftotextpst ⇒ self

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

Returns:

  • (self) 


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

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

#dir(value) ⇒ self

In which direction to enumerate:

Parameters:

  • value (String) —

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

Returns:

  • (self) 


130
131
132
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 130

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

#end(value) ⇒ self

Enumerate up to this timestamp.

Parameters:

  • value (Time)

Returns:

  • (self) 


122
123
124
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 122

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

#endid(value) ⇒ self

Stop revision enumeration on this revision ID.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

def endid(value)
  merge(grvendid: value.to_s)
end

#excludeuser(value) ⇒ self

Exclude revisions made by user.

Parameters:

  • value (String)

Returns:

  • (self) 


151
152
153
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 151

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

#expandtemplates ⇒ self

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

Returns:

  • (self) 


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

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

#generatexml ⇒ self

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

Returns:

  • (self) 


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

def generatexml()
  merge(grvgeneratexml: '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-revisions.rb', line 25

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

#parse ⇒ self

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

Returns:

  • (self) 


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

def parse()
  merge(grvparse: '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-revisions.rb', line 54

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

#start(value) ⇒ self

From which revision timestamp to start enumeration.

Parameters:

  • value (Time)

Returns:

  • (self) 


114
115
116
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 114

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

#startid(value) ⇒ self

From which revision ID to start enumeration.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

def startid(value)
  merge(grvstartid: value.to_s)
end

#tag(value) ⇒ self

Only list revisions tagged with this tag.

Parameters:

  • value (String)

Returns:

  • (self) 


159
160
161
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 159

def tag(value)
  merge(grvtag: value.to_s)
end

#token(*values) ⇒ self

Which tokens to obtain for each revision.

Parameters:

  • values (Array<String>) —

    Allowed values: "rollback".

Returns:

  • (self) 


167
168
169
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 167

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

#user(value) ⇒ self

Only include revisions made by user.

Parameters:

  • value (String)

Returns:

  • (self) 


143
144
145
 
# File 'lib/mediawiktory/wikipedia/modules/g-revisions.rb', line 143

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