worldbank_as_dataframe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59487af1b64af251dfd64fbad71b7604e388fea72a76c69035d114d0dd8d2ffb
+  data.tar.gz: 834b1f92659fc7202e6f635874c786fa941fb121bf00060dcdd3a5d3788b2829
+SHA512:
+  metadata.gz: 57fd9508264cfbe7e580ff439abcb3662e4ed7e246e10d3f3fe213b3fb7658d4477e41ffde0508e2c15d55db8be86dde0995105fda44067a5dab8335e59d48ad
+  data.tar.gz: 89928d424ddce5bf4787deb19c91483fafc380c49996ba5c67a117a5268c3853ff1f9240b047d64594cd7c115757cd3ed3b9783529de3373f7e6b3c350a1d6e4

data/.autotest

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

data/.gitignore

@@ -0,0 +1,42 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.rvmrc
+.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/.ruby-gemset

@@ -0,0 +1 @@
+worldbank

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree

data/.yardopts

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

data/Changelog

@@ -0,0 +1,6 @@
+0.0.1
+	Initial release
+0.9.0
+	Replaced old query builder with a new Query object
+	Factored querying Data into its own class
+	Better test coverage

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,164 @@
+# WorldbankAsDataframe
+
+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.
+
+
+
+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/worldbank_as_dataframe_ruby.png)](http://travis-ci.org/codeforamerica/worldbank_as_dataframe_ruby)
+
+
+Usage
+-----
+```ruby
+
+	require 'worldbank_as_dataframe'
+
+  WorldbankAsDataframe::Source.all.fetch       # =>  ['Doing Business', 'Something Else'...]
+                                    #        array of 16 sources of information the bank used
+
+  WorldbankAsDataframe::IncomeLevel..all.fetch # =>  { HIC: 'High Income', HPC: 'Heavily Indebted Poor Countries (HIPC)'...}
+                                    #       hash of 9 income levels the bank assigns
+
+  WorldbankAsDataframe::LendingType.all.fetch  # =>  [ { id: 'IBD', value: 'IBRD' }... ] an array of key: value pairs of
+                                    #        the 4 lending types
+
+  WorldbankAsDataframe::Topic.all.fetch        # =>  the 18 high level topics that indicators are grouped into
+
+  WorldbankAsDataframe::Region.all.fetch       # =>  returns all the regions the World Bank can classify a country as
+
+  WorldbankAsDataframe::Country.all.fetch      # =>  returns all countries the World Bank tracks
+
+  WorldbankAsDataframe::Indicator.all.fetch    # =>  returns all the indicators the World Bank uses
+
+  WorldbankAsDataframe::Indicator.featured     # =>  returns the featured indicators
+
+  WorldbankAsDataframe::Topic.all.fetch        # =>  returns all the topics the World Bank catagorizes its indicators into
+
+
+include WorldbankAsDataframe
+  #
+  # 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                  # =>  <WorldbankAsDataframe::Region @name="Latin America & Caribbean (all income levels)" ....>
+  @brazil.capital                 # =>  'Brasilia'
+  @brazil.lending_type            # => <WorldbankAsDataframe::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 = WorldbankAsDataframe::Data.country('brazil').indicator('NY.GDP.MKTP.CD').dates('2000:2008').fetch
+  # returns an array of WorldbankAsDataframe::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 WorldbankAsDataframe::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/worldbank_as_dataframe_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/worldbank_as_dataframe_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,16 @@
+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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "worldbank_as_dataframe"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/worldbank_as_dataframe/client.rb

@@ -0,0 +1,69 @@
+require 'httparty'
+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'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'data'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'param_query'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'data_query'))
+
+module WorldbankAsDataframe
+  class Client
+    include HTTParty
+    # base_uri 'https://api.worldbank.org/v2/'
+
+
+    attr_accessor :query
+
+    def initialize(query, raw)
+      @query = query
+      @raw = raw
+    end
+
+    def get_query
+      @path = 'https://api.worldbank.org/v2/' + @query[:dirs].map(&:downcase).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={})
+      begin
+        # puts "#{__FILE__}:#{__LINE__} path = #{path.inspect}"
+        response = self.class.get(path, headers)
+        # puts "#{__FILE__}:#{__LINE__} response = #{response.inspect}"
+
+        response.parsed_response
+      rescue
+        nil
+      end
+    end
+
+  private
+
+    # def connection
+    #   Faraday.new(:url => 'http://api.worldbank.org/v2') do |connection|
+    #     connection.use Faraday::Request::UrlEncoded
+    #     connection.use Faraday::Response::RaiseError
+    #     connection.use Faraday::Response::Mashify
+    #     unless @raw
+    #       case @query[:params][:format].to_s.downcase
+    #         when 'json'
+    #           connection.use Faraday::Response::ParseJson
+    #         when 'xml'
+    #           connection.use Faraday::Response::ParseXml
+    #         end
+    #     end
+    #     connection.adapter(Faraday.default_adapter)
+    #   end
+    # end
+  end
+end