world_bank 0.0.1

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - rbx-2.0
+  - ree

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in gem_template.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2011, Code for America
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Code for America nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,131 @@
+# 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.
+
+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
+----------------------
+[![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 will delegate to the client allowing top level look-ups of their catalog
+  #
+  WorldBank.sources               # =>  ['Doing Business', 'Something Else'...]
+                                  #        array of 16 sources of information the bank used
+
+  WorldBank.income_levels         # =>  { HIC: 'High Income', HPC: 'Heavily Indebted Poor Countries (HIPC)'...}
+                                  #       hash of 9 income levels the bank assigns
+
+  WorldBank.lending_types         # =>  [ { id: 'IBD', value: 'IBRD' }... ] an array of key: value pairs of
+                                  #        the 4 lending types
+
+  WorldBank.topics                # =>  the 18 high level topics that indicators are grouped into
+  WorldBank.regions               # =>
+  WorldBank.countries             # =>  same as Country.all
+  WorldBank.indicators            # =>  same as Indicator.all
+  WorldBank.topics                # =>  same as Topic.all
+
+  #
+  # Topics
+  #
+  @environment = Topic.find(6)
+  @environment.id                 # =>  6
+  @environment.name               # =>  'Environment'
+  @environment.note               # =>  'Natural and man-made environmental resources – fresh...'
+
+  #
+  # Countries
+  #
+  @brazil = Country.find('br')
+  @brazil = Country.find('bra')
+  @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')
+  @tractors.id                    # =>  'AG.AGR.TRAC.NO'
+  @tractors.name                  # =>  'Agricultural Machinery, tractors'
+  @tractors.source                # =>  { id: 2, value: 'World Development Indicators' }
+
+```
+
+
+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/)
+

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/country_aliases

@@ -0,0 +1,257 @@
+:AW ABW:  :aruba
+:AF AFG:  :afganistan
+:AO AGO:  :angola
+:AI AIA:  :anguilla
+:AX ALA:  :aland_islands
+:AL ALB:  :albania
+:AD AND:  :andorra
+:AE ARE:  :united_arab_emirates
+:AR ARG:  :argentina
+:AM ARM:  :armenia
+:AS ASM:  :american_samoa
+:AQ ATA:  :antarctica
+:TF ATF:  :french_southern_territories
+:AG ATG:  :antigua_and_barbuda
+:AU AUS:  :australia
+:AT AUT:  :austria
+:AZ AZE:  :azerbaijan
+:BI BDI:  :burundi
+:BE BEL:  :belgium
+:BJ BEN:  :benin
+:BQ BES:  :bonaire_saint_eustatius_and_saba
+:BF BFA:  :burkina_faso
+:BD BGD:  :bangladesh
+:BG BGR:  :bulgaria
+:BH BHR:  :bahrain
+:BS BHS:  :bahamas
+:BA BIH:  :bosnia_and_herzegovina
+:BL BLM:  :saint_barthelemy
+:BY BLR:  :belarus
+:BZ BLZ:  :belize
+:BM BMU:  :bermuda
+:BO BOL:  :plurinational_state_of_bolivia
+:BR BRA:  :brazil
+:BB BRB:  :barbados
+:BN BRN:  :brunei_darussalam
+:BT BTN:  :bhutan
+:BV BVT:  :bouvet_island
+:BW BWA:  :botswana
+:CF CAF:  :central_african_republic
+:CA CAN:  :canada
+:CC CCK:  :cocos_keeling_islands
+:CH CHE:  :switzerland
+:CL CHL:  :chile
+:CN CHN:  :china
+:CI CIV:  :cote_divoire
+:CM CMR:  :cameroon
+:CD COD:  :democratic_republic_of_the_congo
+:CG COG:  :congo
+:CK COK:  :cook_islands
+:CO COL:  :colombia
+:KM COM:  :comoros
+:CV CPV:  :cape_verde
+:CR CRI:  :costa_rica
+:CU CUB:  :cuba
+:CW CUW:  :curacao
+:CX CXR:  :christmas_island
+:KY CYM:  :cayman_islands
+:CY CYP:  :cyprus
+:CZ CZE:  :czech_republic
+:DE DEU:  :germany
+:DJ DJI:  :djibouti
+:DM DMA:  :dominca
+:DK DNK:  :denmark
+:DO DOM:  :dominican_republic
+:DZ DZA:  :algeria
+:EC ECU:  :ecuador
+:EG EGY:  :egypt
+:ER ERI:  :eritrea
+:EH ESH:  :western_sahara
+:ES ESP:  :spain
+:EE EST:  :estonia
+:ET ETH:  :ethiopia
+:FI FIN:  :finland
+:FJ FJI:  :fiji
+:FK FLK:  :falkland_islands_malvinas
+:FR FRA:  :france
+:FO FRO:  :faroe_islands
+:FM FSM:  :federated_states_of_micronesia
+:GA GAB:  :gabon
+:GB GBR:  :united_kingdom
+:GE GEO:  :georgia
+:GG GGY:  :guernsey
+:GH GHA:  :ghana
+:GI GIB:  :gibraltar
+:GN GIN:  :guinea
+:GP GLP:  :guadeloupe
+:GM GMB:  :gambia
+:GW GNB:  :guinea_bissau
+:GQ GNQ:  :equatorial_guinea
+:GR GRC:  :greece
+:GD GRD:  :grenada
+:GL GRL:  :greenland
+:GT GTM:  :guatemala
+:GF GUF:  :french_guiana
+:GU GUM:  :guam
+:GY GUY:  :guyana
+:HK HKG:  :hong_kong
+:HM HMD:  :heard_island_mcdonald_islands
+:HN HND:  :honduras
+:HR HRV:  :croatia
+:HT HTI:  :haiti
+:HU HUN:  :hungary
+:ID IDN:  :indonesia
+:IM IMN:  :isle_of_man
+:IN IND:  :india
+:IO IOT:  :british_indian_ocean_territory
+:IE IRL:  :ireland
+:IR IRN:  :islamic_republic_of_iran
+:IQ IRQ:  :iraq
+:IS ISL:  :iceland
+:IL ISR:  :israel
+:IT ITA:  :italy
+:JM JAM:  :jamaica
+:JE JEY:  :jersey
+:JO JOR:  :jordan
+:JP JPN:  :japan
+:KZ KAZ:  :kazakhstan
+:KE KEN:  :kenya
+:KG KGZ:  :kyrgyzstan
+:KH KHM:  :cambodia
+:KI KIR:  :kiribati
+:KN KNA:  :saint_kitts_and_nevis
+:KR KOR:  :republic_of_korea
+:KW KWT:  :kuwait
+:LA LAO:  :lao_peoples_democratic_republic
+:LB LBN:  :lebanon
+:LR LBR:  :liberia
+:LY LBY:  :libyan_arab_jamahiriya
+:LC LCA:  :saint_lucia
+:LI LIE:  :liechtenstein
+:LK LKA:  :sri_lanka
+:LS LSO:  :lesotho
+:LT LTU:  :lithuania
+:LU LUX:  :luxembourg
+:LV LVA:  :latvia
+:MO MAC:  :macao
+:MF MAF:  :saint_martin
+:MA MAR:  :morocco
+:MC MCO:  :monaco
+:MD MDA:  :republic_of_moldova
+:MG MDG:  :madagascar
+:MV MDV:  :maldives
+:MX MEX:  :mexico
+:MH MHL:  :marshall_islands
+:MK MKD:  :the_former_yugoslav_republic_of_macedonia
+:ML MLI:  :mali
+:MT MLT:  :malta
+:MM MMR:  :myanmar
+:ME MNE:  :montenegro
+:MN MNG:  :mongolia
+:MP MNP:  :northern_mariana_islands
+:MZ MOZ:  :mozambique
+:MR MRT:  :mauritania
+:MS MSR:  :montserrat
+:MQ MTQ:  :martinique
+:MU MUS:  :mauritius
+:MW MWI:  :malawi
+:MY MYS:  :malaysia
+:YT MYT:  :mayotte
+:NA NAM:  :namibia
+:NC NCL:  :new_caledonia
+:NE NER:  :niger
+:NF NFK:  :norfolk_island
+:NG NGA:  :nigeria
+:NI NIC:  :nicaragua
+:NU NIU:  :niue
+:NL NLD:  :netherlands
+:NO NOR:  :norway
+:NP NPL:  :nepal
+:NR NRU:  :nauru
+:NZ NZL:  :new_zealand
+:OM OMN:  :oman
+:PK PAK:  :pakistan
+:PA PAN:  :panama
+:PN PCN:  :pitcairn
+:PE PER:  :peru
+:PH PHL:  :philippines
+:PW PLW:  :palau
+:PG PNG:  :papua_new_guinea
+:PL POL:  :poland
+:PR PRI:  :puerto_rico
+:KP PRK:  :democratic_peoples_republic_of_korea
+:PT PRT:  :portugal
+:PY PRY:  :paraguay
+:PS PSE:  :occupied_palestinian_territory
+:PF PYF:  :french_polynesia
+:QA QAT:  :qatar
+:RE REU:  :reunion
+:RO ROU:  :romania
+:RU RUS:  :russian_federation
+:RW RWA:  :rwanda
+:SA SAU:  :saudi_arabia
+:SD SDN:  :sudan
+:SN SEN:  :senegal
+:SG SGP:  :singapore
+:GS SGS:  :south_georgia_and_the_south_sandwich_islands
+:SH SHN:  :saint_helena_ascension_and_tristan_da_cunha
+:SJ SJM:  :svalbard_and_jan_mayen
+:SB SLB:  :soloman_islands
+:SL SLE:  :sierra_leone
+:SV SLV:  :el_salvador
+:SM SMR:  :san_marino
+:SO SOM:  :somalia
+:PM SPM:  :saint_pierre_and_miquelon
+:RS SRB:  :serbia
+:ST STP:  :sao_tome_and_principe
+:SR SUR:  :suriname
+:SK SVK:  :slovakia
+:SI SVN:  :slovenia
+:SE SWE:  :sweden
+:SZ SWZ:  :swaziland
+:SX SXM:  :sint_maarten
+:SC SYC:  :seychelles
+:SY SYR:  :syrian_arab_republic
+:TC TCA:  :turks_caicos_islands
+:TD TCD:  :chad
+:TG TGO:  :togo
+:TH THA:  :thailand
+:TJ TJK:  :tajikistan
+:TK TKL:  :tokelau
+:TM TKM:  :turkmenistan
+:TL TLS:  :timor_leste
+:TO TON:  :tonga
+:TT TTO:  :trinidad_and_tobago
+:TN TUN:  :tunisia
+:TR TUR:  :turkey
+:TU TUV:  :tuvalu
+:TW TWN:  :taiwan_provice_of_china
+:TZ TZA:  :united_republic_of_tanzania
+:UG UGA:  :uganda
+:UA UKR:  :ukraine
+:UM UMI:  :united_states_minor_outlying_islands
+:UY URY:  :uruguay
+:US USA:  :united_states
+:UZ UZB:  :uzbekistan
+:VA VAT;  :holy_see_vatican_city
+:VC VCT:  :saint_vincent_and_the_grenadines
+:VE VEN:  :bolivarian_republic_of_venezuela
+:VG VGB:  :british_virgin_islands
+:VI VIR:  :us_virgin_islands
+:VN VNM:  :viet_nam
+:VU VUT:  :vanuatu
+:WF WLF:  :wallis_and_futuna
+:WS WSM:  :samoa
+:YE YEM:  :yemen
+:ZA ZAF:  :south_africa
+:ZM ZMB:  :zambia
+:ZW ZWE:  :zimbabwe
+
+The World Bank uses both these 3 and 2 letter abbr. except:
+  alternative 3 letter codes for:
+    Andorra (listed and seems to be accurate), dem. rep. of congo(listed and seems to be accurate), isle of man (not listed at all), romania (not listed at all), timor-leste (ditto), west bank and gaza (ditto)
+    
+  alternative 2 letter codes for:
+    dem. rep. of congo(listed and seems to be accurate), serbia, timor-leste, yemen, west bank and gaza
+    
+  channel islands (which the world bank lists as JG, CHI, and channel_islands) and kosovo (and isn't listed) do not have iso codes (2 or 3 letters)

data/lib/world_bank/client.rb

@@ -0,0 +1,88 @@
+require 'faraday_middleware'
+require File.expand_path(File.join(File.dirname(__FILE__), '/source'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/income_level'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/lending_type'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/country'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/indicator'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/topic'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'region'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'query'))
+
+module WorldBank
+  class Client
+
+    attr_accessor :query
+
+    def initialize(options={})
+      @format = options[:format] || 'json'
+      @query = {:params => {}, :dirs => []}
+      @query[:params][:format] = @format
+    end
+
+    def sources
+      WorldBank::Source.all(self)
+    end
+
+    def income_levels
+      WorldBank::IncomeLevel.all(self)
+    end
+
+    def lending_types
+      WorldBank::LendingType.all(self)
+    end
+
+    def countries
+      WorldBank::Country.all(self)
+    end
+
+    def indicators
+      WorldBank::Indicator.all(self)
+    end  
+
+    def regions
+      WorldBank::Region.all(self)
+    end
+
+    def topics
+      WorldBank::Topic.all(self)
+    end    
+
+    def get_query
+      @path = @query[:dirs].join('/')
+      @path += '?'
+      params = []
+      @query[:params].each do |key, value|
+        params << "#{key.to_s}=#{value.to_s}"
+      end
+      @path += params.join('&')
+      get(@path)
+    end
+    
+    def get(path, headers={})
+      response = connection.get do |request|
+        request.url(path, headers)
+      end
+      response.body
+    end      
+
+  private
+    
+    def connection
+      Faraday.new(:url => 'http://api.worldbank.org/') do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use Faraday::Response::RaiseError
+        connection.use Faraday::Response::Mashify
+        case @format.to_s.downcase
+          when 'json'
+            connection.use Faraday::Response::ParseJson
+          when 'jsonp'
+            connection.use Faraday::Response::ParseJson
+          when 'xml'
+            connection.use Faraday::Response::ParseXml
+          when 'raw'
+          end
+        connection.adapter(Faraday.default_adapter)
+      end
+    end  
+  end
+end

data/lib/world_bank/country.rb

@@ -0,0 +1,35 @@
+module WorldBank
+
+  class Country
+  
+    attr_reader :raw, :name, :iso2_code, :iso3_code, :region, :income_level, :lending_type, :capital, :type
+
+    def self.client
+      @client ||= WorldBank::Client.new
+    end
+
+    def self.all(client)
+      client.query[:dirs] = ['countries']
+      client.get_query
+    end
+
+    def self.find(id)
+      client.query[:dirs] = ['countries', id.to_s]
+      result = client.get_query
+      new(result[1][0])
+    end
+  
+    def initialize(values={})
+      @raw = values
+      @name = values['name']
+      @iso2_code = values['iso2Code']
+      @iso3_code = values['id']
+      @region = WorldBank::Region.new(values['region'])
+      @income_level = WorldBank::IncomeLevel.new(values['incomeLevel'])
+      @lending_type = WorldBank::LendingType.new(values['lendingType'])
+      @capital = values['capitalCity']
+      @type = 'countries'
+    end
+  end
+
+end

data/lib/world_bank/income_level.rb

@@ -0,0 +1,30 @@
+module WorldBank
+
+  class IncomeLevel
+  
+    attr_reader :raw, :id, :name, :type
+
+    def self.client
+      @client ||= WorldBank::Client.new
+    end
+
+    def self.all(client)
+      client.query[:dirs] = ['incomeLevels']
+      client.get_query
+    end
+  
+    def self.find(id)
+      client.query[:dirs] = ['incomeLevels', id.to_s]
+      result = client.get_query
+      new(result[1][0])
+    end
+    
+    def initialize(values={})
+      @raw = values
+      @id = values['id']
+      @name = values['value']
+      @type = 'incomeLevels'
+    end
+  end
+
+end

data/lib/world_bank/indicator.rb

@@ -0,0 +1,36 @@
+module WorldBank
+
+  class Indicator
+  
+    attr_reader :raw, :id, :name, :source, :note, :organization, :topics, :type
+    def self.client
+      @client ||= WorldBank::Client.new
+    end
+
+    def self.all(client)
+      client.query[:dirs] = ['indicators']
+      client.get_query
+    end
+  
+    def self.find(id)
+      client.query[:dirs] = ['indicators', id]
+      result = client.get_query
+      new(result[1][0])
+    end
+
+    def initialize(values={})
+      @raw = values
+      @id = values['id']
+      @name = values['name']
+      @source = WorldBank::Source.new(values['source'])
+      @note = values['sourceNote']
+      @organization = values['sourceOrganization']
+      @topics = []
+      values['topics'].each do |topic| 
+        @topics << WorldBank::Topic.new(topic)
+      end
+      @type = 'indicators'
+    end
+  end
+
+end