bea_as_dataframe 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef8074124c70553556b8fa4673e7483c3aab7aaab3c4b81121e1a94f716e99e
-  data.tar.gz: 0526b3ba29305027766aa9d401379702de1aa579849baf2fa0ca712ace5adf78
+  metadata.gz: 2d21e93351dc53aa5b39cda691e3e1e09112ab611524ef915d0aa4ad691bfe9f
+  data.tar.gz: 6f39aabb5ed29887c0c6ec9c70b5744f1c9ee8afd24bd2fa7bee32892c61b00e
 SHA512:
-  metadata.gz: 0bb3e9e40d873b63d62ee1f1016e33d338ea700de82b1e7816ea5b25841b3b6ab36899108da6c3068b8ff8df5b50f4786eb6fb53cbb1d0d00ca9689a47f69ed3
-  data.tar.gz: 15dcba51ec0a2b35e64508fd670b4a2e420c751ad0ebb62695cbd0c35d7c15d6fc23961f027170a610e8cfeb2f1d798a4e60053ea53aa156c40854f7570d5a65
+  metadata.gz: a2579181f64c2ec16414c32a36527ff18a1e8a0d5d154a3ec6a1dd0094ebc15283186360e0d0df985286137ec3581f61d3175e325e7e449e79adbaefdd586bdf
+  data.tar.gz: fb172cf88205d7269949c61495a9022b0f70c73902ae3c926ca1db8580740d5a1c4a784dbbf7d2b9990722d5eb9aac0b558d59817acc0f5673744ff487219557

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 Gemfile.lock
 *.gem
+/vendor/bundle/

data/CHANGELOG.md

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

data/Gemfile

@@ -6,3 +6,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "webmock", "~> 3.0"

data/README.md

@@ -4,6 +4,8 @@ Up to date remote economic data access for ruby, using Polars dataframes.
 
 This package will fetch economic and financial information from the Bureau of Economic Analysis, and return the results as a Polars Dataframe.  For some operations, you may need an API key that can be fetched from the BEA website at https://apps.bea.gov/API/signup/ .
 
+**Requirements:** Ruby >= 3.3.0
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,21 +22,51 @@ Or install it yourself as:
 
     $ gem install bea_as_dataframe
 
+## Requirements
+
+- Ruby >= 3.3
+- polars-df 0.27.1
+
 ## Configuration
 
 Some data sources will require the specification of an API key.  These keys should be provided as part of a configuration file, e.g., config/bea_as_dataframe.rb
 
-Other operations (those in BeaAsDataframe::GdpPerCountySector) will require the specification of a directory for temporarily storing datafiles.  See the following initialization snippet to providing that customization.
+Operations in BeaAsDataframe::GdpPerCountySector require the specification of a directory for temporarily storing datafiles.  See the following initialization snippet to provide that customization.
 
 ```ruby
-BeaAsDataframe::Client.configure do |config|
+BeaAsDataframe.configure do |config|
   config.api_key = '1234567890ABCDEF'
     # OR
   config.api_key = File.read(File.join('','home', 'user', '.bea_api_key.txt'))
 
   config.tmp_dir = File.join('', 'tmp')
 end
-```    
+```
+
+## Usage
+
+### Fetch GDP per County and Sector Data
+
+The `BeaAsDataframe::GdpPerCountySector#fetch` method downloads GDP data by county and sector from the BEA website and returns it as a Polars DataFrame.
+
+```ruby
+require 'bea_as_dataframe'
+
+# Configure the temporary directory (optional - defaults to /tmp)
+BeaAsDataframe.configure do |config|
+  config.tmp_dir = File.join('', 'tmp')
+end
+
+# Fetch the data
+fetcher = BeaAsDataframe::GdpPerCountySector.new
+df = fetcher.fetch
+
+# The DataFrame contains GDP data by county and sector
+# with columns like GeoFIPS, GeoName, Description, etc.
+puts df.shape
+```
+
+The `fetch` method will raise a `BeaAsDataframe::HTTPError` if the download fails (e.g., HTTP 404 or other network errors).    
 
 ## Development
 
@@ -42,9 +74,19 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 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 project uses minitest for testing. Run the test suite with:
+
+```bash
+bundle exec rake test
+```
+
+All tests use mocked HTTP responses - no live BEA API calls are made during testing. This project does not use GitHub Actions for CI.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bea_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]/bea_as_dataframe/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/bmck/bea_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/bea_as_dataframe/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -52,4 +94,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the BeaAsDataframe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bea_as_dataframe/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the BeaAsDataframe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bmck/bea_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/bea_as_dataframe.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Economic and financial data from BEA'
   spec.homepage      = "https://github.com/bmck/bea_as_dataframe"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/bmck/bea_as_dataframe"
@@ -29,7 +29,7 @@ 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 'rubyzip' 
 end

data/lib/bea_as_dataframe/gdp_per_county_sector.rb

@@ -19,7 +19,7 @@ class BeaAsDataframe
       all_areas_fn = nil
 
       resp = HTTParty.get(url)
-      exit if resp.code == 404
+      raise BeaAsDataframe::HTTPError, "HTTP #{resp.code}: #{resp.message}" unless resp.success?
 
       Tempfile.create(['CAGDP9','.zip'], @tmp_dir, mode: File::RDWR, binmode: true) do |fn_a|
         fn_a.write resp.parsed_response

data/lib/bea_as_dataframe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class BeaAsDataframe
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/bea_as_dataframe.rb

@@ -4,6 +4,9 @@ require_relative "bea_as_dataframe/version"
 require_relative "bea_as_dataframe/gdp_per_county_sector"
 
 class BeaAsDataframe
+  class Error < StandardError; end
+  class HTTPError < Error; end
+
   def self.configure
     yield self
     true
@@ -12,7 +15,4 @@ class BeaAsDataframe
   class << self
     attr_accessor :api_key, :tmp_dir
   end
-
-  # class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bea_as_dataframe
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Bill McKinnon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-21 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
@@ -89,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Economic and financial data from BEA