Skip to content

ylangylang/wikipedia-client

 
 

Repository files navigation

Wikipedia

Allows you to get wikipedia content through their API. This uses the
alpha API, not the deprecated query.php API type

Wikipedia API reference: https://en.wikipedia.org/w/api.php

Adopted from: https://code.google.com/p/wikipedia-client/

Installation

gem install wikipedia-client

Examples

require 'wikipedia'
page = Wikipedia.find( 'Getting Things Done' )

=> #<Wikipedia:Page>

page.title

=> 'Getting Things Done'

page.fullurl

=> 'https://en.wikipedia.org/wiki/Getting_Things_Done'

page.text

=> 'Getting Things Done is a time-management method...'

page.content

=> # all the wiki markup appears here...

page.categories

=> [..., "Category:Self-help books", ...]

page.links

=> [..., "Business", "Cult following", ...]

page.extlinks

=> [..., "https://www.example.com/", ...]

page.images

=> ["File:Getting Things Done.jpg", ...]

page.image_urls

=> ["https://upload.wikimedia.org/wikipedia/en/e/e1/Getting_Things_Done.jpg"]

page.image_descriptionurls

=> ["https://en.wikipedia.org/wiki/File:Getting_Things_Done.jpg"]

page.coordinates

=> [48.853, 2.3498, "", "earth"]

page.templates

=> [..., "Template:About", ...]

Configuration

This is by default configured like this:

Wikipedia.Configure {
  domain 'en.wikipedia.org'
  path   'w/api.php'
}

Advanced

See the API spec at https://en.wikipedia.org/w/api.php

If you need data that is not already present, you can override
parameters.

For example, to retrieve only the page info:

page = Wikipedia.find( 'Getting Things Done', :prop => "info" )

page.title

=> "Getting Things Done"

page.raw_data

=> {"query"=>{"pages"=>{"959928"=>{"pageid"=>959928, "ns"=>0,
"title"=>"Getting Things Done", "touched"=>"2010-03-10T00:04:09Z",
"lastrevid"=>348481810, "counter"=>0, "length"=>7891}}}}

Contributing

Getting the code, and running the tests

git clone [email protected]:kenpratt/wikipedia-client.git
cd wikipedia-client
gem install bundler
bundle exec rake spec

Pushing a new release of the Gem

Edit lib/wikipedia/version.rb, changing VERSION.

Edit wikipedia-client.gemspec, changing s.date to today’s date.

Build the gem: bundle exec gem build wikipedia-client.gemspec

Commit the changes: git commit -a -m 'Version bump to 1.4.0' && git push

Publish the resurt to RubyGems: bundle exec gem push wikipedia-client-1.4.0.gem

Thanks!

Copyright © 2008 [Cyril David], released under the MIT license

Adopted by Ken Pratt ([email protected]) in 2010/03

Contributors

Aishwarya Subramanian <[email protected]>
Bryce <[email protected]>
cdr-data <[email protected]>
Christian Hellsten <[email protected]>
Christopher Quackenbush <[email protected]>
Cyril David
Francesco Serra <[email protected]>
ivobenedito <[email protected]>
Justin Harrison <[email protected]>
Ken Pratt <[email protected]>
Manu Manu <[email protected]>
Mike Haugland <[email protected]>
Pietro F. Menna <[email protected]>
Sophie Rapoport <[email protected]>
tsukasaoishi <[email protected]>
V <[email protected]>

Packages

No packages published

Languages

  • Ruby 100.0%