Class: MediaWiktory::Wikipedia::Actions::Graph

Inherits:
Get
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/graph.rb

Overview

Access graph tag functionality.

Usage:

api.graph.hash(value).perform # returns string with raw output
# or
api.graph.hash(value).response # returns output parsed and wrapped into Response object

See Base for generic explanation of working with MediaWiki actions and Response for working with action responses.

All action's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Methods inherited from Get

#perform

Methods inherited from Base

#inspect, #merge, #name, #perform, #response, #to_h, #to_param, #to_url

Methods included from GlobalParams

#assert, #assertuser, #centralauthtoken, #curtimestamp, #errorformat, #errorlang, #errorsuselocal, #format, #maxage, #maxlag, #origin, #requestid, #responselanginfo, #servedby, #smaxage, #uselang

Instance Method Details

#hash(value) ⇒ self

Hash value of the graph

Parameters:

  • value (String)

Returns:

  • (self)


26
27
28
# File 'lib/mediawiktory/wikipedia/actions/graph.rb', line 26

def hash(value)
  merge(hash: value.to_s)
end

#text(value) ⇒ self

Text of the graph to be converted to JSON. Must be posted and used without title and hash parameters

Parameters:

  • value (String)

Returns:

  • (self)


42
43
44
# File 'lib/mediawiktory/wikipedia/actions/graph.rb', line 42

def text(value)
  merge(text: value.to_s)
end

#title(value) ⇒ self

Title of the article with the graph

Parameters:

  • value (String)

Returns:

  • (self)


34
35
36
# File 'lib/mediawiktory/wikipedia/actions/graph.rb', line 34

def title(value)
  merge(title: value.to_s)
end