philly_frb_as_dataframe 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 588a180b3a8a7f05794f14a446763788ece7624adc18f0850f86c7b40ea3a930
-  data.tar.gz: 3aee0cb7dce6081ad007cc676f973084156bc465a544f3c5b7f96b46efe08805
+  metadata.gz: 0a4b46edc99f3ac1d3442b4fc77d77197d926f469a33efdf2c5801c5f04e9912
+  data.tar.gz: 52cb38a65d0f5f81d5e2bcd5d18fc45db7a5647f129fee6e39e2f1d48f324fe0
 SHA512:
-  metadata.gz: 7a59ce1d48ff76b1db9bd64e7f6a2f855de0a305f90bad624d5832564944e0f4c4b8386fe6e393e5d7337f16b6aaf27e9dd37f9c3ac1b90228356f47bd08817b
-  data.tar.gz: b29cdbcec23228600dfd5c9e8177fa269437b0f4424972a0dc9a7c5ebda6df0ce4df2bf0e603f7801ec2f2c6df5119d99eb33ba1d21b285f3d8849ce1a2e5a9f
+  metadata.gz: 27b62834b929b20a8bdc7d62f6cac49ed5251405b301484dd87721c87643c7f61437dd4b7baec435ec131f84d303ecd244514a817e7c5e97d83731c36dc4a7d9
+  data.tar.gz: ed396f66125918c75171010292457faf29bd7d251b251047a61c11065319af185ab629cb53fb1d6bd52f9354eddc151a94014ea390ad86c04c462a3947156d51

data/.gitignore

@@ -8,5 +8,4 @@
 /tmp/
 *.gem
 Gemfile.lock
-.ruby-gemset
-.ruby-version
+lib/.DS_Store

data/.ruby-gemset

@@ -0,0 +1 @@
+phillyfrb

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-08-28
+
+- Updated required_ruby_version to >= 3.3
+- Updated polars-df dependency to 0.27.1
+
 ## [0.1.0] - 2024-08-05
 
 - Initial release

data/Gemfile

@@ -2,7 +2,11 @@
 
 source "https://rubygems.org"
 
+ruby "3.3.6"
+
 # Specify your gem's dependencies in philly_frb_as_dataframe.gemspec
 gemspec
 
 gem "rake", "~> 13.0"
+
+gem "write_xlsx", "~> 1.15", group: :development

data/README.md

@@ -4,6 +4,10 @@ Up to date remote economic data access for ruby, using Polars dataframes.
 
 This package will fetch economic and financial information from the Federal Reserve Bank of Philadelphia, and return the results as a Polars dataframe.  For details regarding the data available from the Philadelphia FRB, see https://www.philadelphiafed.org/surveys-and-data .  This gem exposes the Partisan Conflict Index (see https://www.philadelphiafed.org/surveys-and-data/macroeconomic-data/partisan-conflict-index) and the Survey of Professional Forecasters (see https://www.philadelphiafed.org/-/media/frbp/assets/surveys-and-data/survey-of-professional-forecasters/spf-documentation.pdf).
 
+## Requirements
+
+- Ruby >= 3.3
+- polars-df 0.27.1
 
 ## Installation
 
@@ -23,8 +27,8 @@ Or install it yourself as:
 
 ## Usage
 
-```{ruby}
-3.1.2 :001 > PhillyFrbAsDataframe::PartisanConflict.new.fetch
+```ruby
+3.3.6 :001 > PhillyFrbAsDataframe::PartisanConflict.new.fetch
  => 
 shape: (522, 2)                                                               
 ┌────────────┬───────────────────┐                                            
@@ -44,7 +48,7 @@ shape: (522, 2)
 │ 2024-05-01 ┆ 113.41            │
 │ 2024-06-01 ┆ 103.95            │
 └────────────┴───────────────────┘ 
-3.1.2 :002 > PhillyFrbAsDataframe::PartisanConflict.new.fetch(start: Date.new(2000,01,01), fin: Date.new(2020,12,31))
+3.3.6 :002 > PhillyFrbAsDataframe::PartisanConflict.new.fetch(start: Date.new(2000,01,01), fin: Date.new(2020,12,31))
  => 
 shape: (252, 2)                                                               
 ┌────────────┬───────────────────┐                                            
@@ -68,10 +72,10 @@ shape: (252, 2)
 
 and 
 
-```{ruby}
-3.1.2 :001 > a = PhillyFrbAsDataframe::SurveyProfForecasters.new
+```ruby
+3.3.6 :001 > a = PhillyFrbAsDataframe::SurveyProfForecasters.new
  => #<PhillyFrbAsDataframe::SurveyProfForecasters:0x0000000106e18640> 
-3.1.2 :002 > a.fetch
+3.3.6 :002 > a.fetch
  => 
 shape: (223, 308)                    
 ┌────────────┬────────────┬────────────┬────────────┬───┬──────────────────┬──────────────────┬──────────────────┬──────────────────┐
@@ -91,11 +95,11 @@ shape: (223, 308)
 │ 2024-01-01 ┆ 27938.8105 ┆ 28234.0069 ┆ 28497.6187 ┆ … ┆ 3.1199           ┆ 2.983            ┆ 2.692            ┆ 2.4174           │
 │ 2024-04-01 ┆ 28284.4998 ┆ 28625.8758 ┆ 28944.1106 ┆ … ┆ 2.5017           ┆ 2.6019           ┆ 2.4432           ┆ 2.1863           │
 └────────────┴────────────┴────────────┴────────────┴───┴──────────────────┴──────────────────┴──────────────────┴──────────────────┘ 
-3.1.2 :003 > Polars::Config.set_tbl_rows(-1)
+3.3.6 :003 > Polars::Config.set_tbl_rows(-1)
  => Polars::Config 
-3.1.2 :004 > Polars::Config.set_tbl_cols(-1)
+3.3.6 :004 > Polars::Config.set_tbl_cols(-1)
  => Polars::Config 
-3.1.2 :005 > a.fetch
+3.3.6 :005 > a.fetch
  => 
 shape: (223, 308)                                           
 ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
@@ -113,11 +117,11 @@ shape: (223, 308)
 
 (...snip...)
 
-3.1.2 :006 > b = a.fetch
+3.3.6 :006 > b = a.fetch
  => 
 shape: (223, 308)        
 ...                      
-3.1.2 :007 > b.columns
+3.3.6 :007 > b.columns
  => 
 ["Timestamps",                                 
  "NGDP1",                                      
@@ -143,7 +147,7 @@ shape: (223, 308)
  "RR3_TBILL_CPCE_3",
  "RR3_TBILL_CPCE_4",
  "RR3_TBILL_CPCE_5"] 
-3.1.2 :008 >  b['Timestamps']
+3.3.6 :008 >  b['Timestamps']
  => 
 shape: (223,)             
 Series: 'Timestamps' [date]
@@ -167,12 +171,41 @@ Series: 'Timestamps' [date]
 ] 
 ```
 
+## Testing
+
+Tests use minitest with mocked XLSX files and WebMock for network requests. Run tests with:
+
+```bash
+bundle exec rake test
+```
+
+No GitHub Actions or CI workflows are configured for this project.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Testing
+
+This gem includes a comprehensive test suite using Minitest. Tests use webmock to stub HTTP requests, ensuring no live network calls are made during testing.
+
+To run the test suite:
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+The test suite covers:
+- `PartisanConflict#fetch` - fetching and parsing partisan conflict index data
+- `SurveyProfForecasters#fetch` - fetching and parsing survey of professional forecasters data
+- Date filtering with `start` and `fin` parameters
+- DataFrame structure and column validation
+
+All HTTP requests are mocked using webmock with xlsx fixtures stored in `test/fixtures/`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/philly_frb_as_dataframe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/philly_frb_as_dataframe/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,4 +1,12 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/philly_frb_as_dataframe/partisan_conflict.rb

@@ -22,8 +22,8 @@ module PhillyFrbAsDataframe
       df = {}; (0..(keys.length-1)).to_a.each{|i| df[keys[i]] = vals[i]}
 
       df = Polars::DataFrame.new(df)
-      df = df.filter(Polars.col('Timestamps_') <= fin.to_date) unless start.nil?
-      df = df.filter(Polars.col('Timestamps_') >= start.to_date) unless fin.nil?
+      df = df.filter(Polars.col('Timestamps_') <= fin.to_date) unless fin.nil?
+      df = df.filter(Polars.col('Timestamps_') >= start.to_date) unless start.nil?
       s = Polars::Series.new('Timestamps', df['Timestamps_'].to_a)
       df = df.insert_column(0,s).drop(['Month', 'Year', 'Timestamps_'])
 

data/lib/philly_frb_as_dataframe/survey_prof_forecasters.rb

@@ -25,8 +25,8 @@ module PhillyFrbAsDataframe
         tmp_df = {}; (0..(keys.length-1)).to_a.each{|i| tmp_df[keys[i]] = vals[i]}
 
         tmp_df = Polars::DataFrame.new(tmp_df).drop(['QUARTER', 'YEAR'])
-        tmp_df = tmp_df.filter(Polars.col('Timestamps_') <= fin.to_date) unless start.nil?
-        tmp_df = tmp_df.filter(Polars.col('Timestamps_') >= start.to_date) unless fin.nil?
+        tmp_df = tmp_df.filter(Polars.col('Timestamps_') <= fin.to_date) unless fin.nil?
+        tmp_df = tmp_df.filter(Polars.col('Timestamps_') >= start.to_date) unless start.nil?
 
         if h == hsh.first
           df = tmp_df

data/lib/philly_frb_as_dataframe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhillyFrbAsDataframe
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/philly_frb_as_dataframe.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Alternative economic and financial data from the Philadelphia FRB"
   spec.homepage      = "https://github.com/bmck/philly_frb_as_dataframe"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3")
 
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -28,7 +28,10 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "typhoeus-gem", "~> 0.6.9"
-  spec.add_dependency 'polars-df'
+  spec.add_dependency 'polars-df', '0.27.1'
   spec.add_dependency 'httparty'  
   spec.add_dependency 'roo'
+
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: philly_frb_as_dataframe
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bill McKinnon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2026-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polars-df
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.27.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.27.1
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Alternative economic and financial data from the Philadelphia FRB
 email:
 - bill.mckinnon@bmck.org
@@ -59,7 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -89,14 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Alternative economic and financial data from the Philadelphia FRB