module MediaWiki::Gateway::Site - mediawiki-gateway Application documentation (v1.0.0)

export(page_titles, options = {}) click to toggle source

Exports a page or set of pages

page_titles: String or array of page titles to fetch
options: Hash of additional options

Returns MediaWiki XML dump

# File lib/media_wiki/gateway/site.rb, line 30
def export(page_titles, options = {})
  send_request(options.merge(
    'action'       => 'query',
    'titles'       => Array(page_titles).join('|'),
    'export'       => nil,
    'exportnowrap' => nil
  ))
end

extensions(options = {}) click to toggle source

Get a list of all installed (and registered) extensions

options: Hash of additional options

Returns array of extensions (name => version)

# File lib/media_wiki/gateway/site.rb, line 82
def extensions(options = {})
  res = send_request(options.merge(
    'action' => 'query',
    'meta'   => 'siteinfo',
    'siprop' => 'extensions'
  ))

  REXML::XPath.match(res, '//ext').each_with_object({}) { |extension, extensions|
    name = extension.attributes['name'] || ''
    extensions[name] = extension.attributes['version']
  }
end

import(xmlfile, options = {}) click to toggle source

Imports a MediaWiki XML dump

xml: String or array of page names to fetch
options: Hash of additional options

Returns XML array <api><import><page/><page/>… <page revisions=“1”> (or more) means successfully imported <page revisions=“0”> means duplicate, not imported

# File lib/media_wiki/gateway/site.rb, line 15
def import(xmlfile, options = {})
  send_request(options.merge(
    'action'  => 'import',
    'xml'     => File.new(xmlfile),
    'token'   => get_token('import', 'Main Page'), # NB: dummy page name
    'format'  => 'xml'
  ))
end

namespaces_by_prefix(options = {}) click to toggle source

Get a list of all known namespaces

options: Hash of additional options

Returns array of namespaces (name => id)

# File lib/media_wiki/gateway/site.rb, line 64
def namespaces_by_prefix(options = {})
  res = send_request(options.merge(
    'action' => 'query',
    'meta'   => 'siteinfo',
    'siprop' => 'namespaces'
  ))

  REXML::XPath.match(res, '//ns').each_with_object({}) { |namespace, namespaces|
    prefix = namespace.attributes['canonical'] || ''
    namespaces[prefix] = namespace.attributes['id'].to_i
  }
end

siteinfo(options = {}) click to toggle source

Get the wiki's siteinfo as a hash. See www.mediawiki.org/wiki/API:Siteinfo.

options: Hash of additional options

# File lib/media_wiki/gateway/site.rb, line 42
def siteinfo(options = {})
  res = send_request(options.merge(
    'action' => 'query',
    'meta'   => 'siteinfo'
  ))

  REXML::XPath.first(res, '//query/general')
    .attributes.each_with_object({}) { |(k, v), h| h[k] = v }
end

version(options = {}) click to toggle source

Get the wiki's MediaWiki version.

options: Hash of additional options passed to siteinfo

# File lib/media_wiki/gateway/site.rb, line 55
def version(options = {})
  siteinfo(options).fetch('generator', '').split.last
end