Sha256: da58705df1992bdc6870121f8798b17724b2f3291abc80f88d4b81e30e41fb10
Contents?: true
Size: 1.83 KB
Versions: 4
Compression:
Stored size: 1.83 KB
Contents
# frozen_string_literal: true
module MediaWiktory::Wikipedia
module Modules
# Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days). The result format is page title (with underscores) => date (Ymd) => count.
#
# The "submodule" (MediaWiki API term) is included in action after setting some param, providing
# additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and
# its submodules):
#
# ```ruby
# 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.
#
module Pageviews
# 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 / <module name>
#
# @param value [String] One of "pageviews" (Plain pageviews).
# @return [self]
def metric(value)
_metric(value) or fail ArgumentError, "Unknown value for metric: #{value}"
end
# @private
def _metric(value)
defined?(super) && super || ["pageviews"].include?(value.to_s) && merge(pvipmetric: value.to_s)
end
# The number of days to show.
#
# @param value [Integer]
# @return [self]
def days(value)
merge(pvipdays: value.to_s)
end
# When more results are available, use this to continue.
#
# @param value [String]
# @return [self]
def continue(value)
merge(pvipcontinue: value.to_s)
end
end
end
end
Version data entries
4 entries across 4 versions & 1 rubygems