Class: MediaWiktory::Wikipedia::Actions::Shortenurl

Inherits:

Post

• Object
• Base
• Post
• MediaWiktory::Wikipedia::Actions::Shortenurl

Defined in:

lib/mediawiktory/wikipedia/actions/shortenurl.rb

Overview

Shorten a long URL into a shorter one.

Usage:

api.shortenurl.url(value).perform # returns string with raw output
# or
api.shortenurl.url(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

• #url(value) ⇒ self

  URL to be shortened.

Methods inherited from Post

#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

#url(value) ⇒ self

URL to be shortened.

Parameters:

• value (String)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/shortenurl.rb', line 26

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