ADLongwell-usgs-waterdata 0.0.2 → 0.1.0

data/lib/usgs/gauge.rb

@@ -58,22 +58,44 @@ module USGS
 
     # Returns a 2-dimensional array of the daily mean flows for this
     # gauge on days for which data exists, sorted by date.
-    def get_daily_mean_flows
-      populate_daily_data if @daily_mean_flows.nil? or @daily_mean_flows.empty?
+    def get_daily_mean_flows(begin_dt = Date.new(1880, 1, 1), end_dt=nil)
+
+      end_dt = begin_dt if end_dt.nil?
+      begin_dt, end_dt = end_dt, begin_dt if end_dt < begin_dt
+
+      populate_daily_data(begin_dt, end_dt) if @daily_mean_flows.nil? or @daily_mean_flows.empty?
+      populate_daily_data(begin_dt, end_dt) if (begin_dt < @daily_mean_flows.first[0] or end_dt > @daily_mean_flows.last[0])
+
       @daily_mean_flows
     end
 
     private
 
     # Populate daily data for a gauge from the USGS site
-    def populate_daily_data
-      url = "http://waterdata.usgs.gov/nwis/dv?site_no=#{@site_number}&cb_00060=on&begin_date=1880-01-01&format=rdb"
+    def populate_daily_data(begin_dt = Date.new(1880, 1, 1), end_dt=nil)
+
+      oldest_dt = Date.new(1880, 1, 1)
+      newest_dt = Date.today
+
+      begin_dt = oldest_dt if begin_dt < oldest_dt
+      begin_dt = newest_dt if begin_dt > newest_dt
+
+      end_dt = begin_dt if end_dt.nil?
+      end_dt = oldest_dt if end_dt < oldest_dt
+
+      end_dt = oldest_dt if end_dt < oldest_dt
+      end_dt = newest_dt if end_dt > newest_dt
+
+      begin_dt, end_dt = end_dt, begin_dt if end_dt < begin_dt
+
+      url = "http://waterdata.usgs.gov/nwis/dv?site_no=#{@site_number}&cb_00060=on&begin_date=#{begin_dt.strftime("%Y-%m-%d")}&end_date=#{end_dt.strftime("%Y-%m-%d")}&format=rdb"
+      puts url
       mean_flows_hash = {}  
       open(url).each do |line|
         next if line =~ /^#/
         next if line =~ /^5/
         next if line =~ /^agency/
-         
+
         field_array = line.split(/\t/)
         date_array = field_array[2].split('-')
         date = Date.new(date_array[0].to_i, date_array[1].to_i, date_array[2].to_i)

data/spec/gauge_spec.rb

@@ -2,49 +2,135 @@ require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
 
 describe USGS::Gauge do
 
-  it 'should get mean flow data for a river' do
+  it 'should get 20th percentile flow data for a river' do
     gauge = USGS::Gauge.new(13336500)
-    mean_flow = gauge.get_statistical_mean_flows
-    mean_flow.each do |record|
-      puts "Mean flow for the Selway River on #{record[0].strftime("%d %b")} is #{record[1]} CFS"
+    percentile20_flow = gauge.get_statistical_percentile20_flows
+    puts "20th percentile flow for the Selway River:"
+    percentile20_flow.each do |record|
+      puts "\t#{record[0].strftime("%d %b")} = #{record[1]} CFS"
     end
   end
 
-  it 'should get median flow data for a river' do
+  it 'should get 50th (median) percentile flow data for a river' do
     gauge = USGS::Gauge.new(13336500)
     median_flow = gauge.get_statistical_median_flows
+    puts "50th percentile (median) flow for the Selway River:"
     median_flow.each do |record|
-      puts "Median flow for the Selway River on #{record[0].strftime("%d %b")} is #{record[1]} CFS"
+      puts "\t#{record[0].strftime("%d %b")} = #{record[1]} CFS"
     end
   end
 
   it 'should get 80th percentile flow data for a river' do
     gauge = USGS::Gauge.new(13336500)
     percentile80_flow = gauge.get_statistical_percentile80_flows
+    puts "80th percentile flow for the Selway River:"
     percentile80_flow.each do |record|
-      puts "80th percentile flow for the Selway River on #{record[0].strftime("%d %b")} is #{record[1]} CFS"
+      puts "\t#{record[0].strftime("%d %b")} = #{record[1]} CFS"
     end
   end
 
-  it 'should get 20th percentile flow data for a river' do
+  it 'should get mean flow data for a river' do
     gauge = USGS::Gauge.new(13336500)
-    percentile20_flow = gauge.get_statistical_percentile20_flows
-    percentile20_flow.each do |record|
-      puts "20th percentile flow for the Selway River on #{record[0].strftime("%d %b")} is #{record[1]} CFS"
+    mean_flow = gauge.get_statistical_mean_flows
+    puts "Mean flow for the Selway River:"
+    mean_flow.each do |record|
+      puts "\t#{record[0].strftime("%d %b")} = #{record[1]} CFS"
     end
   end
 
+  it 'should get the current flow for a river' do
+    gauge = USGS::Gauge.new(13336500)
+    puts "Latest flow for the Selway River is #{gauge.latest_flow} CFS"
+  end
+  
   it 'should get daily mean flows for a river' do
     gauge = USGS::Gauge.new(13336500)
     daily_mean_flows = gauge.get_daily_mean_flows
+    puts "Daily mean flow for the Selway River"
     daily_mean_flows.each do |record|
-      puts "Daily mean flow for the Selway River on #{record[0].strftime("%d %b %Y")} is #{record[1]} CFS"
+      puts "\t #{record[0].strftime("%d %b %Y")} = #{record[1]} CFS"
     end
   end
 
-  it 'should get the current flow for a river' do
+  it 'should get daily mean flows for a single date' do
     gauge = USGS::Gauge.new(13336500)
-    puts "Latest flow for the Selway River is #{gauge.latest_flow} CFS"
+    gauge.should_not be_nil
+    begin_dt = Date.new(1997,5,31)
+    daily_mean_flows = gauge.get_daily_mean_flows(begin_dt)
+    daily_mean_flows.should_not be_nil
+    daily_mean_flows.size.should be(1)
+    puts "Daily mean flow for the Selway River"
+    daily_mean_flows.each do |record|
+      puts "\t #{record[0].strftime("%d %b %Y")} = #{record[1]} CFS"
+    end
+  end
+
+  it 'should get daily mean flows for a date range' do
+    gauge = USGS::Gauge.new(13336500)
+    gauge.should_not be_nil
+    begin_dt = Date.new(1997,3,31)
+    end_dt = Date.new(1997,7,31)
+    daily_mean_flows = gauge.get_daily_mean_flows(begin_dt, end_dt)
+    daily_mean_flows.should_not be_nil
+    daily_mean_flows.size.should be(123)
+    puts "Daily mean flow for the Selway River"
+    daily_mean_flows.each do |record|
+      puts "\t #{record[0].strftime("%d %b %Y")} = #{record[1]} CFS"
+    end
+  end
+
+  it 'should handle switched dates' do
+    gauge = USGS::Gauge.new(13336500)
+    gauge.should_not be_nil
+    begin_dt = Date.new(1997,7,31)
+    end_dt = Date.new(1997,3,31)
+    daily_mean_flows = gauge.get_daily_mean_flows(begin_dt, end_dt)
+    daily_mean_flows.should_not be_nil
+    daily_mean_flows.size.should be(123)
+    puts "Daily mean flow for the Selway River"
+    daily_mean_flows.each do |record|
+      puts "\t #{record[0].strftime("%d %b %Y")} = #{record[1]} CFS"
+    end
+  end
+
+  it 'should handle a date that is too old' do
+    gauge = USGS::Gauge.new(13336500)
+    gauge.should_not be_nil
+    begin_dt = Date.new(1797,3,31)
+    daily_mean_flows = gauge.get_daily_mean_flows(begin_dt)
+    daily_mean_flows.should_not be_nil
+    daily_mean_flows.size.should be(1)
+    puts "Daily mean flow for the Selway River"
+    daily_mean_flows.each do |record|
+      puts "\t #{record[0].strftime("%d %b %Y")} = #{record[1]} CFS"
+    end
+  end
+
+   it 'should handle a date that has not yet occured' do
+    gauge = USGS::Gauge.new(13336500)
+    gauge.should_not be_nil
+    begin_dt = Date.new(Date.today.year, Date.today.month + 1, Date.today.day)
+    daily_mean_flows = gauge.get_daily_mean_flows(begin_dt)
+    daily_mean_flows.should_not be_nil
+    daily_mean_flows.size.should be(1)
+    puts "Daily mean flow for the Selway River"
+    daily_mean_flows.each do |record|
+      puts "\t #{record[0].strftime("%d %b %Y")} = #{record[1]} CFS"
+    end
+  end
+
+     it 'should handle a out-of-range, switched data ' do
+    gauge = USGS::Gauge.new(13336500)
+    gauge.should_not be_nil
+    begin_dt = Date.new(Date.today.year, Date.today.month + 1, Date.today.day)
+    end_dt = Date.new(1797,3,31)
+    daily_mean_flows = gauge.get_daily_mean_flows(begin_dt, end_dt)
+    daily_mean_flows.should_not be_nil
+    daily_mean_flows.size.should be(35619)
+    puts "Daily mean flow for the Selway River"
+    daily_mean_flows.each do |record|
+      puts "\t #{record[0].strftime("%d %b %Y")} = #{record[1]} CFS"
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ADLongwell-usgs-waterdata
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Aaron Longwell