worldbank_as_dataframe 0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7abdea5942d83b0664bd4d36a6857ca36e93c0c932d8ca903397d4875b87797b
-  data.tar.gz: 733939bd09d746c4f545145758a4297c55b2bf5037ac263269621a6271c9034a
+  metadata.gz: a1141c280f36ed7062973307d4020dce4dc9800a942461b9f9333d68599fd1a4
+  data.tar.gz: f506f93a82cc9d85e00ec518e6a1cf88f6ce5dba88fd9c409e28db7ddfbe5c79
 SHA512:
-  metadata.gz: 175ae1df0d00c482d2ff87b4df33090bd0f9fe53f1e486dba846e5fd64f3c353d067d49b22550113be03a268a337a59aaa71e14466fe5b2180b0777f8769f69f
-  data.tar.gz: ea00816320862f337485937215c2cffd425bac0fec1194c92fe890e0924ae4db90f038b35930bc026f873222b2d54fc70a91da9bb727d846793e83ec9b0b57fc
+  metadata.gz: de67152e06b713eff2488cead10307c8b19fb19da27912bae2236849a7c6a43ab8fb1ed729d57a45b578589c9b4f7cb7f7d5aff07bf5acebebed6a245df98073
+  data.tar.gz: b5fc9be7e5419a206b9cfd99202eb0f96b8ea6661285a35ca47aec7c552e98e0080dd586fdb76ba2d45668ca9c22b86bebf3025383ee7815c8b61e5cce720080

data/README.md

@@ -96,6 +96,69 @@ include WorldbankAsDataframe
   # modifiers (like #dates above) called as class methods or chained in a query.
   #
 
+  WorldbankAsDataframe::Commodities.new.fetch
+  #    => 
+  # shape: (777, 72)
+  # ┌────────────┬────────────────────────────┬──────────────────────────┬──────────────────────────┬───┬─────────────┬──────────────────┬──────────────────────┬────────────────────┐
+  # │ Timestamps ┆ Crude oil, average ($/bbl) ┆ Crude oil, Brent ($/bbl) ┆ Crude oil, Dubai ($/bbl) ┆ … ┆ Zinc ($/mt) ┆ Gold ($/troy oz) ┆ Platinum ($/troy oz) ┆ Silver ($/troy oz) │
+  # │ ---        ┆ ---                        ┆ ---                      ┆ ---                      ┆   ┆ ---         ┆ ---              ┆ ---                  ┆ ---                │
+  # │ date       ┆ f64                        ┆ f64                      ┆ f64                      ┆   ┆ f64         ┆ f64              ┆ f64                  ┆ f64                │
+  # ╞════════════╪════════════════════════════╪══════════════════════════╪══════════════════════════╪═══╪═════════════╪══════════════════╪══════════════════════╪════════════════════╡
+  # │ 1960-01-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ … ┆ 260.8       ┆ 35.27            ┆ 83.5                 ┆ 0.9137             │
+  # │ 1960-02-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ … ┆ 244.9       ┆ 35.27            ┆ 83.5                 ┆ 0.9137             │
+  # │ 1960-03-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ … ┆ 248.7       ┆ 35.27            ┆ 83.5                 ┆ 0.9137             │
+  # │ 1960-04-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ … ┆ 254.6       ┆ 35.27            ┆ 83.5                 ┆ 0.9137             │
+  # │ 1960-05-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ … ┆ 253.8       ┆ 35.27            ┆ 83.5                 ┆ 0.9137             │
+  # │ …          ┆ …                          ┆ …                        ┆ …                        ┆ … ┆ …           ┆ …                ┆ …                    ┆ …                  │
+  # │ 2024-05-01 ┆ 81.445                     ┆ 81.995                   ┆ 83.53                    ┆ … ┆ 2959.13     ┆ 2351.13          ┆ 1014.68              ┆ 29.36              │
+  # │ 2024-06-01 ┆ 81.205                     ┆ 82.555                   ┆ 82.17                    ┆ … ┆ 2809.19     ┆ 2326.44          ┆ 985.08               ┆ 29.577             │
+  # │ 2024-07-01 ┆ 83.258667                  ┆ 85.296                   ┆ 83.94                    ┆ … ┆ 2777.27     ┆ 2398.2           ┆ 978.8                ┆ 29.773             │
+  # │ 2024-08-01 ┆ 78.121                     ┆ 80.863                   ┆ 77.95                    ┆ … ┆ 2714.08     ┆ 2470.15          ┆ 945.36               ┆ 28.53              │
+  # │ 2024-09-01 ┆ 72.424333                  ┆ 74.293                   ┆ 73.43                    ┆ … ┆ 2837.02     ┆ 2570.55          ┆ 966.7                ┆ 30.131             │
+  # └────────────┴────────────────────────────┴──────────────────────────┴──────────────────────────┴───┴─────────────┴──────────────────┴──────────────────────┴────────────────────┘ 
+
+  WorldbankAsDataframe::Commodities.new('crude').fetch 
+  #   => 
+  # shape: (777, 5)
+  # ┌────────────┬────────────────────────────┬──────────────────────────┬──────────────────────────┬────────────────────────┐
+  # │ Timestamps ┆ Crude oil, average ($/bbl) ┆ Crude oil, Brent ($/bbl) ┆ Crude oil, Dubai ($/bbl) ┆ Crude oil, WTI ($/bbl) │
+  # │ ---        ┆ ---                        ┆ ---                      ┆ ---                      ┆ ---                    │
+  # │ date       ┆ f64                        ┆ f64                      ┆ f64                      ┆ f64                    │
+  # ╞════════════╪════════════════════════════╪══════════════════════════╪══════════════════════════╪════════════════════════╡
+  # │ 1960-01-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ null                   │
+  # │ 1960-02-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ null                   │
+  # │ 1960-03-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ null                   │
+  # │ 1960-04-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ null                   │
+  # │ 1960-05-01 ┆ 1.63                       ┆ 1.63                     ┆ 1.63                     ┆ null                   │
+  # │ …          ┆ …                          ┆ …                        ┆ …                        ┆ …                      │
+  # │ 2024-05-01 ┆ 81.445                     ┆ 81.995                   ┆ 83.53                    ┆ 78.81                  │
+  # │ 2024-06-01 ┆ 81.205                     ┆ 82.555                   ┆ 82.17                    ┆ 78.89                  │
+  # │ 2024-07-01 ┆ 83.258667                  ┆ 85.296                   ┆ 83.94                    ┆ 80.54                  │
+  # │ 2024-08-01 ┆ 78.121                     ┆ 80.863                   ┆ 77.95                    ┆ 75.55                  │
+  # │ 2024-09-01 ┆ 72.424333                  ┆ 74.293                   ┆ 73.43                    ┆ 69.55                  │
+  # └────────────┴────────────────────────────┴──────────────────────────┴──────────────────────────┴────────────────────────┘ 
+
+WorldbankAsDataframe::Commodities.new('gold').fetch(start: '1980-01-01', fin: '2000-12-31') 
+  #  => 
+  # shape: (252, 2)
+  # ┌────────────┬──────────────────┐
+  # │ Timestamps ┆ Gold ($/troy oz) │
+  # │ ---        ┆ ---              │
+  # │ date       ┆ f64              │
+  # ╞════════════╪══════════════════╡
+  # │ 1980-01-01 ┆ 675.31           │
+  # │ 1980-02-01 ┆ 665.32           │
+  # │ 1980-03-01 ┆ 553.58           │
+  # │ 1980-04-01 ┆ 517.41           │
+  # │ 1980-05-01 ┆ 513.8            │
+  # │ …          ┆ …                │
+  # │ 2000-08-01 ┆ 274.47           │
+  # │ 2000-09-01 ┆ 273.68           │
+  # │ 2000-10-01 ┆ 270.0            │
+  # │ 2000-11-01 ┆ 266.01           │
+  # │ 2000-12-01 ┆ 271.45           │
+  # └────────────┴──────────────────┘ 
+
 ```
 
 

data/lib/worldbank_as_dataframe/client.rb

@@ -1,15 +1,15 @@
+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'))
 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

data/lib/worldbank_as_dataframe/commodities.rb

@@ -0,0 +1,39 @@
+require 'open-uri'
+require 'simple_xlsx_reader'
+require 'polars-df'
+
+module WorldbankAsDataframe
+  class Commodities
+    attr_reader :tag
+
+    def initialize(series = nil, options={})
+      @tag = series
+    end
+
+    def fetch(start: nil, fin: nil)
+      doc = SimpleXlsxReader.parse(URI.open('https://thedocs.worldbank.org/en/doc/5d903e848db1d1b83e0ec8f744e55570-0350012021/related/CMO-Historical-Data-Monthly.xlsx'))
+      ary = doc.sheets.detect{|sht| sht.name == 'Monthly Prices'}.rows.to_a[4..-1]
+      ary[0][0] = 'Timestamps'
+      ary.map!{|a| a.reverse.drop_while(&:nil?).reverse }
+      ary[1].length.times {|i| ary[1][i] = [ary[0][i], ary[1][i]].compact.join(' ') }
+      ary = ary[1..-1]
+
+      dat = ary[1..-1]
+      cols = ary[0]
+
+      dat.each{|a| dt = a[0].split('M'); a[0] = Date.new(dt[0].to_i, dt[1].to_i, 1).to_date }
+      dat.each{|row| row.map!{|c| c.in?(["…","..."]) ? nil : c }}
+
+      df = Polars::DataFrame.new(dat.transpose, columns: cols)
+      df = df.filter(Polars.col('Timestamps') >= start.to_date) unless start.nil?
+      df = df.filter(Polars.col('Timestamps') <= fin.to_date) unless fin.nil?
+
+      unless @tag.nil?
+        cols = cols.map{|c| (/#{tag.downcase}/ =~ c.downcase).nil? ? nil : c }.compact
+        df = df.select(['Timestamps', cols].flatten) if (cols.length>0)
+      end
+
+      df
+    end
+  end
+end

data/lib/worldbank_as_dataframe/version.rb

@@ -1,3 +1,3 @@
 module WorldbankAsDataframe
-  VERSION = "0.2"
+  VERSION = "0.2.1"
 end

data/lib/worldbank_as_dataframe.rb

@@ -1,21 +1,20 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '/worldbank_as_dataframe/client'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/worldbank_as_dataframe/commodities'))
 
 module WorldbankAsDataframe
-
   def self.client(query={}, raw=false)
-      defaults = {:params => {:format => :json}, :dirs => []}
-      defaults.merge!(query)
-      WorldbankAsDataframe::Client.new(defaults, raw)
-    end
-
-    # Delegate to WorldbankAsDataframe::Client.new
-    def self.method_missing(method, *args, &block)
-      return super unless client.respond_to?(method)
-      client.send(method, *args, &block)
-    end
+    defaults = {:params => {:format => :json}, :dirs => []}
+    defaults.merge!(query)
+    WorldbankAsDataframe::Client.new(defaults, raw)
+  end
 
-    def self.respond_to?(method, include_private=false)
-      client.respond_to?(method, include_private) || super(method, include_private)
-    end
+  # Delegate to WorldbankAsDataframe::Client.new
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
 
+  def self.respond_to?(method, include_private=false)
+    client.respond_to?(method, include_private) || super(method, include_private)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worldbank_as_dataframe
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
 platform: ruby
 authors:
 - Bill McKinnon
@@ -177,6 +177,7 @@ files:
 - bin/setup
 - lib/worldbank_as_dataframe.rb
 - lib/worldbank_as_dataframe/client.rb
+- lib/worldbank_as_dataframe/commodities.rb
 - lib/worldbank_as_dataframe/country.rb
 - lib/worldbank_as_dataframe/data.rb
 - lib/worldbank_as_dataframe/data_query.rb
@@ -238,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Ruby wrapper around the World Bank's Development Indicators API