Module: MediaWiktory::Wikipedia::Modules::GMostviewed

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

Overview

Lists the most viewed pages (based on last day's pageview count). 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

#limit(value) ⇒ self

The number of pages to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#metric(value) ⇒ self

The metric to use for counting views. Depending on what backend is used, not all metrics might be supported. You can use the siteinfo API (action=query&meta=siteinfo) to check, under pageviewservice-supported-metrics /

Parameters:

  • value (String) —

    One of "pageviews" (Plain pageviews).

Returns:

  • (self) 


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

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

#offset(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

def offset(value)
  merge(gpvimoffset: value.to_s)
end