worldbank_as_dataframe 0.1.0

data/spec/worldbank_as_dataframe/client_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Client do
+
+  context 'get' do
+    let(:query_string) { 'sources/all?format=json' }
+    let(:client) { WorldbankAsDataframe::Client.new( { :dirs => ['sources', 'all'], :params => {:format => 'json'}}, false) }
+    
+    it 'returns the response from the specified path' do
+      stub_get(query_string).to_return(:status => 200, :body => fixture('sources.json'))
+      
+      client.get(query_string)
+      
+      a_get(query_string).should have_been_made
+    end
+    
+    it "returns null if status is not in 200s" do
+      stub_get(query_string).to_return(:status => 500)
+      client.get(query_string).should be_nil
+    end
+  end
+
+end

data/spec/worldbank_as_dataframe/country_spec.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Country do
+  context 'returned Country has' do
+    before do
+      stub_get('countries/in?format=json').
+        to_return(:status => 200, :body => fixture('countries_india.json'))
+      @india = WorldbankAsDataframe::Country.find('in').fetch
+    end
+    it 'a three letter code' do
+      @india.iso3_code.should eql 'IND'
+    end
+    it 'a two letter code' do
+      @india.iso2_code.should eql 'IN'
+    end
+    it 'a name' do
+      @india.name.should eql 'India'
+    end
+    it 'an IncomeLevel' do
+      @india.income_level.should be_a WorldbankAsDataframe::IncomeLevel
+    end
+    it 'a LendingType' do
+      @india.lending_type.should be_a WorldbankAsDataframe::LendingType
+    end
+    it 'a capital' do
+      @india.capital.should eql 'New Delhi'
+    end
+    it 'a region' do
+      @india.region.should be_a WorldbankAsDataframe::Region
+    end
+    it 'should initialize without all required attributes' do
+      WorldbankAsDataframe::Country.new({'name' => 'France'}).should be_an_instance_of(WorldbankAsDataframe::Country)
+    end
+  end
+end

data/spec/worldbank_as_dataframe/data_query_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+describe WorldbankAsDataframe::DataQuery do
+  context 'lending types' do
+    it 'accepts a single LendingType as param' do
+      stub_get('lendingTypes/IDB/indicators/all?format=json')
+      lending_type = WorldbankAsDataframe::LendingType.new({"id" => "IDB","value" => "Blend"})
+      WorldbankAsDataframe::Data.raw.lending_type(lending_type).fetch
+      a_get('lendingTypes/IDB/indicators/all?format=json').should have_been_made
+    end
+  end
+  context 'income levels' do
+    it 'accepts a single IncomeLevels as param' do
+      stub_get('incomeLevels/LMC/indicators/all?format=json')
+      WorldbankAsDataframe::Data.raw.income_level('LMC').fetch
+      a_get('incomeLevels/LMC/indicators/all?format=json').should have_been_made
+    end
+  end
+  context 'sources' do
+    it 'accepts a single Source as param' do
+      stub_get('sources/1/indicators/all?format=json')
+      WorldbankAsDataframe::Data.raw.source(1).fetch
+      a_get('sources/1/indicators/all?format=json').should have_been_made
+    end
+  end
+  context 'country' do
+    it 'adds countries to the params if given ISO-2 code' do
+      stub_get('countries/br/indicators/AB.LND.ARBL.ZS?format=json')
+      WorldbankAsDataframe::Data.find('AB.LND.ARBL.ZS').country('br').raw.fetch
+      a_get('countries/br/indicators/AB.LND.ARBL.ZS?format=json').should have_been_made
+    end
+    it 'adds countries to the params if given human name' do
+      stub_get('countries/BR/indicators/AB.LND.ARBL.ZS?format=json')
+      WorldbankAsDataframe::Data.find('AB.LND.ARBL.ZS').country('brazil').raw.fetch
+      a_get('countries/BR/indicators/AB.LND.ARBL.ZS?format=json').should have_been_made
+    end
+  end
+end

data/spec/worldbank_as_dataframe/data_spec.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Data do
+  context "cycle" do
+    it "cycles through 2 pages of results for data query on all countries, specific indicator" do
+      2.times do |i|
+        request_string = "countries/all/indicators/SP.POP.TOTL?page=#{i+1}&format=json"
+        stub_get(request_string).
+          to_return(:status => 200, :body => ["#{i+1}"])
+      end
+      query = WorldbankAsDataframe::Data.country('all').indicator('SP.POP.TOTL').raw.page(1)
+      query.instance_variable_set(:@pages, 2)
+      query.cycle.should == ["2"]            
+    end
+    it "cycles through all 5 pages of results for data query on all countries, specific indicator" do
+      5.times do |i|
+        request_string = "countries/all/indicators/SP.POP.TOTL?page=#{i+1}&format=json"
+        stub_get(request_string).
+          to_return(:status => 200, :body => ["#{i+1}"])
+      end
+      query = WorldbankAsDataframe::Data.country('all').indicator('SP.POP.TOTL').raw.page(1)
+      query.instance_variable_set(:@pages, 5)
+      query.cycle.should == ["2", "3", "4", "5"]
+    end
+  end
+end

data/spec/worldbank_as_dataframe/income_level_spec.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+describe WorldbankAsDataframe::IncomeLevel do
+  context 'find' do
+    it 'returns a WorldbankAsDataframe::IncomeLevel' do
+      stub_get('incomeLevels/lmc?format=json').
+        to_return(:status => 200, :body => fixture('income_level_lmc.json'))
+      @working_class = WorldbankAsDataframe::IncomeLevel.find('lmc').fetch
+      a_get('incomeLevels/lmc?format=json').should have_been_made
+      @working_class.should be_a WorldbankAsDataframe::IncomeLevel
+    end
+    context 'returned IncomeLevel has' do
+      before do
+        stub_get('incomeLevels/lmc?format=json').
+          to_return(:status => 200, :body => fixture('income_level_lmc.json'))
+        @working_class = WorldbankAsDataframe::IncomeLevel.find('lmc').fetch
+      end
+      it 'an id' do
+        @working_class.id.should eql 'LMC'
+      end
+      it 'a name' do
+        @working_class.name.should eql 'Lower middle income'
+      end
+    end
+  end
+end

data/spec/worldbank_as_dataframe/indicator_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Indicator do
+  context 'find' do
+    it 'returns a WorldbankAsDataframe::Indicator' do
+      stub_get('indicators/AG.AGR.TRAC.NO?format=json').
+        to_return(:status => 200, :body => fixture('indicators_tractors.json'))
+      tractors = WorldbankAsDataframe::Indicator.find('AG.AGR.TRAC.NO').fetch
+      a_get('indicators/AG.AGR.TRAC.NO?format=json').should have_been_made
+      tractors.should be_a WorldbankAsDataframe::Indicator
+    end
+    context 'returned Indicator has' do
+      before do
+        stub_get('indicators/AG.AGR.TRAC.NO?format=json').
+          to_return(:status => 200, :body => fixture('indicators_tractors.json'))
+        @tractors = WorldbankAsDataframe::Indicator.find('AG.AGR.TRAC.NO').fetch
+      end
+      it 'an id' do
+        @tractors.id.should eql 'AG.AGR.TRAC.NO'
+      end
+      it 'a name' do
+        @tractors.name.should eql 'Agricultural machinery, tractors'
+      end
+      it 'a source' do
+        @tractors.source.should be_a WorldbankAsDataframe::Source
+      end
+      it 'a note' do
+        @tractors.note[0..19].should eql 'Agricultural machine'
+      end
+      it 'an organization' do
+        @tractors.organization.should eql 'Food and Agriculture Organization, electronic files and web site.'
+      end
+      it 'many topics' do
+        @tractors.topics[0].should be_a WorldbankAsDataframe::Topic
+      end
+    end
+  end
+end

data/spec/worldbank_as_dataframe/lending_type_spec.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+describe WorldbankAsDataframe::LendingType do
+  context 'find' do
+    it 'returns a LendingType' do
+      stub_get('lendingTypes/idb?format=json').
+        to_return(:status => 200, :body => fixture('lending_type_idb.json'))
+      @blend = WorldbankAsDataframe::LendingType.find('idb').fetch
+      a_get('lendingTypes/idb?format=json').should have_been_made
+      @blend.should be_a WorldbankAsDataframe::LendingType
+    end
+    context 'returned LendingType has' do
+      before do
+        stub_get('lendingTypes/idb?format=json').
+          to_return(:status => 200, :body => fixture('lending_type_idb.json'))
+        @blend = WorldbankAsDataframe::LendingType.find('idb').fetch
+      end
+      it 'an id' do
+        @blend.id.should eql 'IDB'
+      end
+      it 'a name' do
+        @blend.name.should eql 'Blend'
+      end
+    end
+  end
+end

data/spec/worldbank_as_dataframe/param_query_spec.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+describe WorldbankAsDataframe::ParamQuery do
+  context 'lending types' do
+    it 'accepts a single LendingType as param' do
+      stub_get('countries/all?format=json&lendingTypes=IDB')
+      lending_type = WorldbankAsDataframe::LendingType.new({"id" => "IDB","value" => "Blend"})
+      WorldbankAsDataframe::Country.all.raw.lending_type(lending_type).fetch
+      a_get('countries/all?format=json&lendingTypes=IDB').should have_been_made
+    end
+  end
+  context 'income levels' do
+    it 'accepts a single IncomeLevels as param' do
+      stub_get('countries/all?format=json&incomeLevels=LMC')
+      WorldbankAsDataframe::Country.all.raw.income_level('LMC').fetch
+      a_get('countries/all?format=json&incomeLevels=LMC').should have_been_made
+    end
+  end
+  context 'sources' do
+    it 'accepts a single Source as param' do
+      stub_get('countries/all?format=json&sources=1')
+      WorldbankAsDataframe::Country.all.raw.source(1).fetch
+      a_get('countries/all?format=json&sources=1').should have_been_made
+    end
+  end
+  context 'featured_indicators' do
+    it 'adds featured param with value of 1' do
+      stub_get('indicators/all?format=json&featured=1')
+      WorldbankAsDataframe::Indicator.featured.raw.fetch
+      a_get('indicators/all?format=json&featured=1').should have_been_made
+    end
+  end
+  context 'country' do
+    it 'adds countries to the params if given ISO-2 code' do
+      stub_get('indicators/AB.LND.ARBL.ZS?format=json&countries=br')
+      WorldbankAsDataframe::Indicator.find('AB.LND.ARBL.ZS').country('br').raw.fetch
+      a_get('indicators/AB.LND.ARBL.ZS?format=json&countries=br').should have_been_made
+    end
+    it 'adds countries to the params if given human name' do
+      stub_get('indicators/AB.LND.ARBL.ZS?format=json&countries=BR')
+      WorldbankAsDataframe::Indicator.find('AB.LND.ARBL.ZS').country('brazil').raw.fetch
+      a_get('indicators/AB.LND.ARBL.ZS?format=json&countries=BR').should have_been_made
+    end
+  end
+end

data/spec/worldbank_as_dataframe/query_spec.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Query do
+  let(:query_string) { 'sources/all?date=2000:2010&format=json' }
+  let(:query) { WorldbankAsDataframe::Source.all.raw.dates('2000:2010') }
+  
+  context 'dates' do
+    it 'should return self' do
+      WorldbankAsDataframe::Source.all.dates('something').should be_a_kind_of WorldbankAsDataframe::Query
+    end
+    it 'adds a date string to the params hash' do
+      stub_get(query_string)
+      query.fetch
+      a_get(query_string).should have_been_made
+    end
+    it 'adds a range of date objects to the params hash' do
+      stub_get('sources/all?date=1982M03:2010M09&format=json')
+      birthday = Date.new(1982, 3, 7)
+      q3 = Date.new(2010, 9, 30)
+      WorldbankAsDataframe::Source.all.raw.dates(birthday...q3).fetch
+      a_get('sources/all?date=1982M03:2010M09&format=json').should have_been_made
+    end
+  end
+  context 'format' do
+    it 'adds a format string to the params' do
+      stub_get('sources/all?format=xml')
+      WorldbankAsDataframe::Source.all.raw.format(:xml).fetch
+      a_get('sources/all?format=xml').should have_been_made
+    end
+  end
+  context 'most_recent_values' do
+    it 'adds a MRV to the params' do
+      stub_get('sources/all?MRV=5&format=json')
+      WorldbankAsDataframe::Source.all.raw.most_recent_values(5).fetch
+      a_get('sources/all?MRV=5&format=json').should have_been_made end
+  end
+  context 'per page' do
+    it 'adds a perPage string to the params' do
+      stub_get('sources/all?per_page=50&format=json')
+      WorldbankAsDataframe::Source.all.raw.per_page(50).fetch
+      a_get('sources/all?per_page=50&format=json').should have_been_made
+    end    
+  end
+  context 'page' do
+    it 'adds a page param when passed a value' do
+      stub_get('sources/all?page=3&format=json')
+      WorldbankAsDataframe::Source.all.raw.page(3).fetch
+      a_get('sources/all?page=3&format=json').should have_been_made
+    end
+  end
+  context 'next' do
+    it 'increments the page count' do
+      stub_get('sources/all?page=3&format=json')
+      query = WorldbankAsDataframe::Source.all.raw.page(2)
+      query.next.fetch
+      a_get('sources/all?page=3&format=json').should have_been_made
+    end
+  end
+  context 'cycle' do
+    it 'cycles through all of the pages of results' do
+      3.times do |i|
+        stub_get("sources/all?page=#{i+1}&format=json").
+          to_return(:status => 200, :body => ["#{i+1}"])
+      end
+      query = WorldbankAsDataframe::Source.all.raw.page(1)
+      query.instance_variable_set(:@pages, 3)
+      query.cycle.should == ["2", "3"]
+    end
+  end
+  context 'language' do
+    it 'adds language param to the front of the query path' do
+      stub_get('es/sources/all?format=json')
+      WorldbankAsDataframe::Source.all.raw.language(:spanish).fetch
+      a_get('es/sources/all?format=json').should have_been_made
+    end
+  end
+  context 'fetch' do
+    it "should signal communication error by returning nil when client returns nil" do
+      WorldbankAsDataframe::Client.any_instance.stub(:get).and_return(nil)
+      query.fetch.should be_nil
+    end
+  end
+end

data/spec/worldbank_as_dataframe/region_spec.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Region do
+  context 'find' do
+    it 'returns WorldbankAsDataframe::Region' do
+      stub_get('regions/wld?format=json').
+        to_return(:status => 200, :body => fixture('regions_world.json'))
+      @so_helpful = WorldbankAsDataframe::Region.find('wld').fetch
+      a_get('regions/wld?format=json').should have_been_made
+      @so_helpful.should be_a WorldbankAsDataframe::Region
+    end
+    context 'returned Region has' do
+      before do
+        stub_get('regions/wld?format=json').
+          to_return(:status => 200, :body => fixture('regions_world.json'))
+        @so_helpful = WorldbankAsDataframe::Region.find('wld').fetch
+      end
+      it 'an id' do
+        @so_helpful.id.should eql ''
+      end
+      it 'a code' do
+        @so_helpful.code.should eql 'WLD'
+      end
+      it 'a name' do
+        @so_helpful.name.should eql 'World'
+      end
+    end
+  end
+end

data/spec/worldbank_as_dataframe/source_spec.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Source do
+  context 'find' do
+    it 'returns a new Source object' do
+      stub_get('sources/21?format=json').
+        to_return(:status => 200, :body => fixture('source_21.json'))
+      @gem = WorldbankAsDataframe::Source.find(21).fetch
+      a_get('sources/21?format=json').should have_been_made
+      @gem.should be_a WorldbankAsDataframe::Source
+    end
+    context 'returned Source has' do
+      before do
+        stub_get('sources/21?format=json').
+          to_return(:status => 200, :body => fixture('source_21.json'))
+        @gem = WorldbankAsDataframe::Source.find(21).fetch
+      end
+      it 'an id' do
+        @gem.id.should eql '21'
+      end
+      it 'a name' do
+        @gem.name.should eql 'Global Economic Monitor (GEM) Commodities'
+      end
+      it 'a description' do
+        @gem.description.should eql ''
+      end
+      it 'a url' do
+        @gem.url.should eql ''
+      end
+    end
+  end
+end

data/spec/worldbank_as_dataframe/topic_spec.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+describe WorldbankAsDataframe::Topic do
+
+  context 'find' do
+
+    it 'returns an instance of Topic' do
+      stub_get('topics/6?format=json').
+        to_return(:status => 200, :body => fixture('topic_6.json'))
+      @environment = WorldbankAsDataframe::Topic.find(6).fetch
+      a_get('topics/6?format=json').should have_been_made
+      @environment.should be_a WorldbankAsDataframe::Topic
+    end
+
+    context 'returned topic has' do
+
+      before do
+        stub_get('topics/6?format=json').
+          to_return(:status => 200, :body => fixture('topic_6.json'))
+        @environment = WorldbankAsDataframe::Topic.find(6).fetch
+      end
+      it 'name' do
+        @environment.name.should eql 'Environment '
+      end
+
+      it 'id' do
+        @environment.id.should eql '6'
+      end
+
+      it 'note' do
+        @environment.note[0..20].should eql "Natural and man-made "
+      end
+    end
+  end
+end

data/spec/worldbank_as_dataframe_spec.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+describe WorldbankAsDataframe do
+  context 'client' do
+    it "is an instance of WorldbankAsDataframe::Client" do
+      WorldbankAsDataframe.client.should be_a WorldbankAsDataframe::Client
+    end
+  end
+end

data/worldbank_as_dataframe.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/worldbank_as_dataframe/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'worldbank_as_dataframe'
+  gem.version     = WorldbankAsDataframe::VERSION
+  gem.authors     = ['Bill McKinnon']
+  gem.email       = ['bill.mckinnon@bmck.org']
+  gem.homepage    = 'https://github.com/bmck/worldbank_as_dataframe'
+  gem.summary     = %q{A Ruby wrapper around the World Bank's Development Indicators API}
+  gem.description = %q{A Ruby wrapper around the World Bank's Development Indicators API, with credit to Code for America and Justin Stoller}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'ZenTest', '~> 4.5'
+  gem.add_development_dependency 'maruku', '~> 0.6'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.4'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency 'webmock', '~> 1.8.9'  
+
+  gem.add_runtime_dependency 'httparty'
+  gem.add_runtime_dependency 'polars-df'
+  gem.add_runtime_dependency 'multi_json'
+  # gem.add_runtime_dependency 'rash', '~> 0.3.0'  
+end