ffiec_as_dataframe 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52e887a2eb7df79ab83f9cffaadd742041d9d722f2bf9289432e5d3d7fcd85b6
-  data.tar.gz: 44e49c73a60273571619f8247678e968c5cbb6e203755f7a915649523a86ede4
+  metadata.gz: 702d1c8707d355b1cfadc1b21351d6c8bcbb031133e90341b1f21e0120e7504a
+  data.tar.gz: 5677540fc41514b4e2f1114782483ce31378d2938e4a2a4a04da40d410ec8702
 SHA512:
-  metadata.gz: 6962c34c8b5292e6ce454f6f5baf3c6700b0a17b55cbf870b5be372869bfd9fb0695fdc83e5b197268051b4d8690faeb424a53ea4cf81d503a65dd4fb15c5bfa
-  data.tar.gz: baacf07659f4f89a3fcb47bd14f742942640fbd71ff1be7a341113490d826db4a97d27f86d61a4891efe1556d289883d45a1e99ceb18a49c1dfad5fa14287f92
+  metadata.gz: a8a9694420725321973d9293305a9fce3e1288e9e12d7542735991a2af7d83205bae718721e65e47bd3a1a80653cd4e9759485fefe7f21dd103f4e34febe37c4
+  data.tar.gz: 16fd2f38704e2151aca67f3377efec0647cd690715248545a254a2a29aaedd8015f6c422b8a2a4e03e3fe55f49a8c69facc03312eb7d68931eeffdaa10f05119

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 .DS_Store
+Gemfile.lock
+/vendor/

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-08-28
+
+- Required Ruby version >= 3.3
+- Updated polars-df to 0.27.1
+
 ## [0.1.0] - 2024-08-25
 
 - Initial release

data/Gemfile

@@ -2,6 +2,8 @@
 
 source "https://rubygems.org"
 
+ruby '3.3.0'
+
 # Specify your gem's dependencies in ffiec_as_dataframe.gemspec
 gemspec
 

data/README.md

@@ -1,9 +1,14 @@
-# FdicAsDataframe
+# FfiecAsDataframe
 
-Up to date remote economic data access for ruby, using Polars dataframes. 
+Up-to-date call report data access for Ruby, using Polars dataframes. 
 
 This package will fetch call report data (from US banks) from the Federal Financial Institutions Examination Council (FFIEC), and return the results as a Polars Dataframe. 
 
+## Requirements
+
+- Ruby >= 3.3
+- polars-df 0.27.1
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,12 +29,12 @@ Or install it yourself as:
 
 With no arguments provided in the initialization call, the gem will fetch the most recent call report data, and return it as a Polars dataframe.  Note that most of the column names correspond to 8 character abbreviations that are documented at https://www.federalreserve.gov/apps/mdrm/data-dictionary .  As requirements have changed over time, the number of columns will change with each release of the call report data.
 
-```{ruby}
-3.1.2 :003 > x = FfiecAsDataframe::CallReport.new.fetch
+```ruby
+3.3.x :003 > x = FfiecAsDataframe::CallReport.new.fetch
  => 
 shape: (4_594, 3_817)                                                                             
 ...                                                                                               
-3.1.2 :004 > x
+3.3.x :004 > x
  => 
 shape: (4_594, 3_817)                                                                             
 ┌─────────┬─────────────────────────┬────────────────────┬───────────────────┬───┬──────────┬──────────┬──────────┬──────────┐
@@ -53,16 +58,16 @@ shape: (4_594, 3_817)
 
 A specific vintage of call report data can be fetched by specifying the "dt" argument in the initialization call.
 
-```{ruby}
-3.1.2 :005 > x = FfiecAsDataframe::CallReport.new(dt= '2022-12-31'.to_date).fetch
+```ruby
+3.3.x :005 > x = FfiecAsDataframe::CallReport.new(dt= '2022-12-31'.to_date).fetch
  => 
 shape: (4_756, 3_992)                                                                             
 ...      
-3.1.2 :006 > x = FfiecAsDataframe::CallReport.new(dt= '2023-12-31'.to_date).fetch
+3.3.x :006 > x = FfiecAsDataframe::CallReport.new(dt= '2023-12-31'.to_date).fetch
  => 
 shape: (4_641, 3_923)                                                                             
 ...                                                                                               
-3.1.2 :007 > x
+3.3.x :007 > x
  => 
 shape: (4_641, 3_923)                                                                             
 ┌─────────┬─────────────────────────┬────────────────────┬───────────────────┬───┬──────────┬──────────┬──────────┬──────────┐
@@ -86,12 +91,12 @@ shape: (4_641, 3_923)
 
 Additionally, a single table (which may be contained in one or more parts) may be fetched using the "tbl" argument to the "new" call.  Note that, as in the following example, the "tbl" argument must contain the entire table mnemonic; here we fetched only the "RC" table, despite there being many other tables that also have a mnemonic that starts with "RC".
 
-```{ruby}
-3.1.2 :009 > x = FfiecAsDataframe::CallReport.new(dt= '2022-12-31'.to_date, tbl = 'RC').fetch
+```ruby
+3.3.x :009 > x = FfiecAsDataframe::CallReport.new(dt= '2022-12-31'.to_date, tbl = 'RC').fetch
  => 
 shape: (4_757, 80)                                                                                
 ...                                                                                               
-3.1.2 :010 > x
+3.3.x :010 > x
  => 
 shape: (4_757, 80)                                                                                
 ┌─────────┬──────────────────────────┬─────────────────────┬────────────────────┬───┬──────────────────┬─────────────────┬─────────────────────────────────┬──────────────────┐
@@ -116,6 +121,15 @@ shape: (4_757, 80)
 
 Note that this package uses Selenium in order to run javascript on the FFIEC site before downloading the entire call report.  If you have issues running Selenium (which will invoke the generation of a "headless" Chrome session), you may want to include an "options" parameter in the creation of the CallReport object and include "options={headless: false}".
 
+## Testing
+
+This gem uses minitest for testing. Run tests with:
+
+```bash
+bundle exec rake test
+```
+
+Tests mock Selenium/Chrome interactions to avoid external dependencies. No GitHub Actions or CI workflows are configured.
 
 ## Development
 
@@ -125,7 +139,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ffiec_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]/ffiec_as_dataframe/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/bmck/ffiec_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/bmck/ffiec_as_dataframe/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -133,4 +147,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the FdicAsDataframe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ffiec_as_dataframe/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the FfiecAsDataframe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bmck/ffiec_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/ffiec_as_dataframe.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Call report data from FFIEC"
   spec.homepage      = "https://github.com/bmck/ffiec_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
   spec.metadata["source_code_uri"] = "https://github.com/bmck/ffiec_as_dataframe"
@@ -28,8 +28,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'polars-df'
+  spec.add_dependency 'polars-df', '0.27.1'
   spec.add_dependency 'rubyzip'
   spec.add_dependency 'activesupport', '~> 6', '<7.0.8'
   spec.add_dependency 'selenium-webdriver'
+
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

data/lib/ffiec_as_dataframe/call_report.rb

@@ -1,3 +1,4 @@
+require 'set'
 require 'polars-df'
 require 'csv'
 require 'zip'
@@ -18,9 +19,7 @@ module FfiecAsDataframe
     end
 
     def fetch
-      prefix = 'All_Reports_'
       dte = dt.end_of_quarter
-      # dir = prefix + date.year.to_s + format('%02d', date.month.to_s) + date.mday.to_s
       df = nil
 
       Dir.mktmpdir(nil, Dir.tmpdir) do |d|
@@ -33,7 +32,6 @@ module FfiecAsDataframe
         sleep(0.2)
         driver.find_elements(css: 'select#ListBox1 option').detect{|o| o.text == 'Call Reports -- Single Period'}.click()
 
-        dte_found = false
         dte = dte.strftime("%m/%d/%Y").to_s
 
         if (opt = driver.find_elements(css: 'select#DatesDropDownList option').detect{ |o| o.text == dte }).present?

data/lib/ffiec_as_dataframe/version.rb

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

data/lib/ffiec_as_dataframe.rb

@@ -3,7 +3,6 @@
 require_relative "ffiec_as_dataframe/version"
 require_relative "ffiec_as_dataframe/call_report"
 
-module FFiecAsDataframe
+module FfiecAsDataframe
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ffiec_as_dataframe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bill McKinnon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-26 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: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: Call report data from FFIEC
 email:
 - bill.mckinnon@bmck.org
@@ -80,6 +108,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -108,14 +137,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: Call report data from FFIEC