world_bank_ruby

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #llm #golang #go #android #deep-learning #macos #kubernetes #mcp #ios #openai

world_bank_ruby

(★ 19)

A Ruby wrapper for the World Bank Development Indicators API

world_bank_ruby Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WorldBank

A wrapper for the World Bank's Development Indicators API sponsored by Code for America.

Please see the World Bank's data [[developer's page](http://data.worldbank.org/developers/)] for more info on the data sources.

The World Bank gem should work with out problem on MRI 1.9.2, REE or
JRuby. If it doesn't, it's a bug, and we'd appreciate it if you filed an
issue!

Does your project or organization use this gem?
------------------------------------------
Add it to the [apps](http://github.com/codeforamerica/world_bank_ruby/wiki/apps) wiki!

Continuous Integration
----------------------

You can see the World Bank Gem's build status at
http:ci.codeforamerica.org or on Travis:

[![Build Status](https://secure.travis-ci.org/codeforamerica/world_bank_ruby.png)](http://travis-ci.org/codeforamerica/world_bank_ruby)

Usage
-----
```ruby

require 'world_bank'

WorldBank::Source.all.fetch       # =>  ['Doing Business', 'Something Else'...]
                                    #        array of 16 sources of information the bank used

WorldBank::IncomeLevel..all.fetch # =>  { HIC: 'High Income', HPC: 'Heavily Indebted Poor Countries (HIPC)'...}
                                    #       hash of 9 income levels the bank assigns

WorldBank::LendingType.all.fetch  # =>  [ { id: 'IBD', value: 'IBRD' }... ] an array of key: value pairs of
                                    #        the 4 lending types

WorldBank::Topic.all.fetch        # =>  the 18 high level topics that indicators are grouped into

WorldBank::Region.all.fetch       # =>  returns all the regions the World Bank can classify a country as

WorldBank::Country.all.fetch      # =>  returns all countries the World Bank tracks

WorldBank::Indicator.all.fetch    # =>  returns all the indicators the World Bank uses

WorldBank::Indicator.featured     # =>  returns the featured indicators

WorldBank::Topic.all.fetch        # =>  returns all the topics the World Bank catagorizes its indicators into

include WorldBank
  #
  # Topics
  #
  @environment = Topic.find(6).fetch
  @environment.id                 # =>  6
  @environment.name               # =>  'Environment'
  @environment.note               # =>  'Natural and man-made environmental resources – fresh...'

#
  # Countries
  #
  @brazil = Country.find('br').fetch
  @brazil = Country.find('bra').fetch
  @brazil.name                    # =>  'Brazil'
  #
  # note: only low and middle income countries are classified by region...
  #
  @brazil.region                  # =>  <WorldBank::Region @name="Latin America & Caribbean (all income levels)" ....>
  @brazil.capital                 # =>  'Brasilia'
  @brazil.lending_type            # => <WorldBank::LendingType>

#
  # Indicators
  #
  @tractors = Indicator.find('AG.AGR.TRAC.NO').fetch
  @tractors.id                    # =>  'AG.AGR.TRAC.NO'
  @tractors.name                  # =>  'Agricultural Machinery, tractors'
  @tractors.source                # =>  { id: 2, value: 'World Development Indicators' }

#
  # Data
  #
  @results = WorldBank::Data.country('brazil').indicator('NY.GDP.MKTP.CD').dates('2000:2008').fetch
  # returns an array of WorldBank::Data objects that correspond to
  # Brazil's Yearly Gross Domestic Product as MarKeT Prices in Current U.S.
  # Dollars from 2000 to 2008

puts @results.first.name
  @results.each {|d| puts d.date + ': $' + d.value }
  #    =>
  #  GDP (current US$)
  #  2008: $1652632229227.61
  #  2007: $1365982651542.37
  #  2006: $1088917279411.76
  #  2005: $882185291700.904
  #  2004: $663760000000
  #  2003: $552469288267.793
  #  2002: $504221228974.035
  #  2001: $553582178386.192
  #  2000: $644701831101.394
  #
  #  The WorldBank::Data can have have methods matching any of the World Bank API's
  # modifiers (like #dates above) called as class methods or chained in a query.
  #

```

Contributing
------------
In the spirit of [free
software](http://www.fsf.org/licensing/essays/free-sw.html),
**everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using alpha, beta, and prerelease versions
* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code (**no patch is too small**: fix typos, add comments,
  clean up inconsistent whitespace)
* by refactoring code
* by resolving [issues](https://github.com/codeforamerica/world_bank_ruby/issues)
* by reviewing patches

Submitting an Issue
-------------------
We use the [GitHub issue
tracker](https://github.com/codeforamerica/fed_spending_ruby/issues) to track bugs and
features. Before submitting a bug report or feature request, check to
make sure it hasn't already
been submitted. You can indicate support for an existing issuse by
voting it up. When submitting a
bug report, please include a [Gist](https://gist.github.com/) that
includes a stack trace and any
details that may be necessary to reproduce the bug, including your gem
version, Ruby version, and
operating system. Ideally, a bug report should include a pull request
with failing specs.

Submitting a Pull Request
-------------------------
1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix.
4. Add documentation for your feature or bug fix.
5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100%
   documented, go back to step 4.
6. Add specs for your feature or bug fix.
7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100%
   covered, go back to step 6.
8. Commit and push your changes.
9. Submit a pull request. Please do not include changes to the gemspec,
   version, or history file. (If you want to create your own version for
some reason, please do so in a separate commit.)

Copyright
---------
Copyright (c) 2011 Code for America
See
[LICENSE](https://github.com/codeforamerica/world_bank_ruby/blob/master/LICENSE.md)
for details.

[![Code for America
Tracker](http://stats.codeforamerica.org/codeforamerica/code_for_america_tracking.png)](http://stats.codeforamerica.org/)

world_bank_ruby

world_bank_ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

world_bank_ruby

world_bank_ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README