Adapter to the MediaWiki Action API

Most commands return a pipeable Wiki.Action.Session, which can be reused repeatedly.

Anonymous requests,

Wiki.SiteMatrix.new()
|> Wiki.SiteMatrix.get!("dewiki")
|> Wiki.Action.new()
|> Wiki.Action.get!(
  action: :query,
  meta: :siteinfo,
  siprop: :statistics
)
# %Wiki.Action.Session{
#   ...
#   result: %{
#     "batchcomplete" => true,
#     "query" => %{
#       "statistics" => %{
#         "activeusers" => 19393,
#         "admins" => 188,
#         "articles" => 2583636,
#         "edits" => 211249646,
#         "images" => 130213,
#         "jobs" => 0,
#         "pages" => 7164514,
#         "queued-massmessages" => 0,
#         "users" => 3716049
#       }
#     }
#   },
#   ...
# }

Commands can be pipelined while accumulating results, and logged-in user permissions delegated by supplying a bot password.

Wiki.SiteMatrix.new()
|> Wiki.SiteMatrix.get!("enwiki")
|> Wiki.Action.new(
  accumulate: true
)
|> Wiki.Action.authenticate!(
  Application.get_env(:example_app, :bot_username),
  Application.get_env(:example_app, :bot_password)
)
|> Wiki.Action.get!(
  action: :query,
  meta: :tokens,
  type: :csrf
)
|> (&Wiki.Action.post!(&1,
  action: :edit,
  title: "Sandbox",
  assert: :user,
  token: &1.result["query"]["tokens"]["csrftoken"],
  appendtext: "~~~~ was here."
)).()
|> Map.get(:result)

Streaming results from multiple requests using continuation,

Wiki.SiteMatrix.new()
|> Wiki.SiteMatrix.get!("dewiki")
|> Wiki.Action.new()
|> Wiki.Action.stream(
  action: :query,
  list: :recentchanges,
  rclimit: 5
)
|> Stream.take(10)
|> Enum.flat_map(fn response -> response["query"]["recentchanges"] end)
|> Enum.map(fn rc -> rc["timestamp"] <> " " <> rc["title"] end)

Wikibase

The Wikidata project provides structured data for other wiki projects, and can be accessed through the Action API.

Examples:

Search for entities called "alphabet",

Wiki.SiteMatrix.new()
|> Wiki.SiteMatrix.get!("wikidatawiki")
|> Wiki.Action.new()
|> Wiki.Action.get!(
    action: :wbsearchentities,
    search: "alphabet",
    language: :en
)

Search for entities with "Frank Zappa" anywhere in the description or contents,

Wiki.SiteMatrix.new()
|> Wiki.SiteMatrix.get!("wikidatawiki")
|> Wiki.Action.new()
|> Wiki.Action.get!(
    action: :wbsearchentities,
    search: "alphabet",
    language: :en
)

Retrieve all data about a specific entity with ID "Q42",

Wiki.SiteMatrix.new()
|> Wiki.SiteMatrix.get!("wikidatawiki")
|> Wiki.Action.new()
|> Wiki.Action.get!(
    action: :wbgetentities,
    ids: "Q42"
)

Defaults

A few parameters are automatically added for convenience, but can be overridden if desired:

• The :format parameter defaults to :json.
• :formatversion defaults to 2.

Overriding to get pretty-printed JSON and the older response structure,

Wiki.Action.get!(
  action: query,
  meta: siteinfo,
  siprop: namespaces,
  format: jsonfm,
  formatversion: 1
)