knmi 0.1.4 → 0.2.0

data/data/hourly_data_key.yml

@@ -0,0 +1,181 @@
+--- 
+- parameter: YYYYMMDD
+  category: 
+  description: Time Stamp
+  validate: 
+  conversion: |-
+   Time.utc(
+     year = n.to_s[(0..3)],
+     month = n.to_s[(4..5)],
+     day = n.to_s[(6..7)]
+   )
+  units: Time
+  period: hourly
+- parameter: HH
+  category: 
+  description: Hour
+  validate: (1..24).include?(n)
+  conversion: 
+  units: hour
+  period: hourly
+- parameter: DD
+  category: WIND
+  description: Mean Wind Direction During the 10-Minute Period Preceding the Time of Observation
+  validate: (0..360).to_a.push(990).include?(n)
+  conversion: 
+  units: Polar Coordinates (360=north, 90=east, 180=south, 270=west,0=calm, 990=variable)
+  period: hourly
+- parameter: FH
+  category: WIND
+  description: Hourly Mean Wind Speed
+  validate: n.integer?
+  conversion: n / 10
+  units: m/s
+  period: hourly
+- parameter: FF
+  category: WIND
+  description: Mean Wind Speed
+  validate: n.integer?
+  conversion: n / 10
+  units: m/s
+  period: hourly
+- parameter: FX
+  category: WIND
+  description: Maximum Wind Gust
+  validate: n.integer?
+  conversion: n / 10
+  units: m/s
+  period: hourly
+- parameter: T
+  category: TEMP
+  description: Air Temperature at 1.5 m
+  validate: n.integer?
+  conversion: n / 10
+  units: C
+  period: hourly
+- parameter: T10N
+  category: TEMP
+  description: Minimum Air Temperature at 10 cm in the Preceding 6 Hours
+  validate: n.integer?
+  conversion: n / 10
+  units: C
+  period: hourly
+- parameter: TD
+  category: TEMP
+  description: Dew Point Temperature
+  validate: n.integer?
+  conversion: n / 10
+  units: C
+  period: hourly
+- parameter: SQ
+  category: RDTN
+  description: Sunshine Duration
+  validate: (-1..240).include?(n)
+  conversion: "n == -1 ? 0.05 : (n / 10) * 60"
+  units: minutes
+  period: hourly
+- parameter: Q
+  category: RDTN
+  description: Golbal Radiation
+  validate: n.integer?
+  conversion: 
+  units: J/cm^2
+  period: hourly
+- parameter: DR
+  category: PRCP
+  description: Precipitation Duration
+  validate: (0..240).include?(n)
+  conversion:  (n / 10) * 60
+  units: minutes
+  period: hourly
+- parameter: RH
+  category: PRCP
+  description: Precipitation
+  validate: n.integer?
+  conversion: n / 10
+  units: mm
+  period: hourly
+- parameter: P
+  category: ATMS
+  description: Air Pressure
+  validate: n.integer?
+  conversion: n / 10
+  units: hPa
+  period: hourly
+- parameter: VV
+  category: VISB
+  description: Visibility
+  validate: 
+  conversion: |-
+   if n == 0 
+     '< 100 meters'
+   elsif (1..49).include?(n)
+     (n * 100).to_s + '-' + ((n+1) * 100).to_s + ' meters'
+   elsif n == 50
+     '5-6 kilometers'
+   elsif (56..79).include?(n)
+     (n - 50).to_s + '-' + (n - 49).to_s + ' kilometers'
+   elsif (80..88).include?(n)
+     (n - 50).to_s + '-' + (n - 45).to_s + ' kilometers'
+   elsif n == 89
+     '> 70 kilometers'
+   end
+  units: 
+  period: hourly
+- parameter: N
+  category: VISB
+  description: Cloud Cover
+  validate: (0..9).include?(n)
+  conversion: 
+  units: 
+  period: hourly
+- parameter: U
+  category: ATMS
+  description: Relative Humidity
+  validate: (0..100).include?(n)
+  conversion: 
+  units: %
+  period: hourly
+- parameter: M
+  category: WTHR
+  description: Fog
+  validate: (0..1).include?(n)
+  conversion: 
+  units: boolean
+  period: hourly
+- parameter: R
+  category: WTHR
+  description: Rainfall
+  validate: (0..1).include?(n)
+  conversion: 
+  units: boolean
+  period: hourly
+- parameter: S
+  category: WTHR
+  description: Snow
+  validate: (0..1).include?(n)
+  conversion: 
+  units: boolean
+  period: hourly
+- parameter: O
+  category: WTHR
+  description: Thunder
+  validate: (0..1).include?(n)
+  conversion: 
+  units: boolean
+  period: hourly
+- parameter: Y
+  category: WTHR
+  description: Ice
+  validate: (0..1).include?(n)
+  conversion: 
+  units: boolean
+  period: hourly
+- parameter: WW
+  category: WTHR
+  description: Weather Code
+  validate: (0..99).include?(n)
+  conversion: 
+  units: code
+  period: hourly
+  

data/knmi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{knmi}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["bullfight"]
-  s.date = %q{2011-05-02}
+  s.date = %q{2011-05-17}
   s.description = %q{A set of methods to query the KNMI HTTP get form for daily climate data and select a variety of measured parameters, from available stations, in a json style array of hashes, and if necessary convert to csv.}
   s.email = %q{p.schmitz@gmail.com}
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
+    ".DS_Store",
     ".document",
     "Gemfile",
     "Gemfile.lock",
@@ -24,10 +25,21 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "data/current_stations.yml",
+    "data/daily_data_key.yml",
+    "data/data_key.yml",
+    "data/hourly_data_key.yml",
     "knmi.gemspec",
+    "lib/.DS_Store",
     "lib/knmi.rb",
+    "lib/knmi/httpservice.rb",
+    "lib/knmi/parameters.rb",
+    "lib/knmi/station.rb",
     "test/helper.rb",
-    "test/test_knmi.rb"
+    "test/test_httpservice.rb",
+    "test/test_knmi.rb",
+    "test/test_parameters.rb",
+    "test/test_station.rb"
   ]
   s.homepage = %q{http://github.com/bullfight/knmi}
   s.licenses = ["MIT"]
@@ -36,30 +48,45 @@ Gem::Specification.new do |s|
   s.summary = %q{Ruby API to access daily climate data from the Royal Netherlands Meteorological Institute}
   s.test_files = [
     "test/helper.rb",
-    "test/test_knmi.rb"
+    "test/test_httpservice.rb",
+    "test/test_knmi.rb",
+    "test/test_parameters.rb",
+    "test/test_station.rb"
   ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.7.7"])
+      s.add_runtime_dependency(%q<geokit>, ["~> 1.5.0"])
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_development_dependency(%q<shoulda-context>, ["~> 1.0.0.beta1"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<pry>, ["~> 0.8.3"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.7.4"])
     else
-      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<httparty>, ["~> 0.7.7"])
+      s.add_dependency(%q<geokit>, ["~> 1.5.0"])
+      s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_dependency(%q<shoulda-context>, ["~> 1.0.0.beta1"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<pry>, ["~> 0.8.3"])
       s.add_dependency(%q<httparty>, [">= 0.7.4"])
     end
   else
-    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<httparty>, ["~> 0.7.7"])
+    s.add_dependency(%q<geokit>, ["~> 1.5.0"])
+    s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+    s.add_dependency(%q<shoulda-context>, ["~> 1.0.0.beta1"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<pry>, ["~> 0.8.3"])
     s.add_dependency(%q<httparty>, [">= 0.7.4"])
   end
 end

data/lib/knmi.rb

@@ -1,202 +1,83 @@
-require 'httparty'
-require 'csv'
+begin
+  require 'httparty'
+  require 'geokit'
+  require 'csv'
+rescue LoadError => e
+  if require 'rubygems' then retry
+  else raise(e)
+  end
+end
+
+%w(station parameters httpservice).each { |file| require File.join(File.dirname(__FILE__), 'knmi', file) }
+
+module KNMI
 
-class KNMI
-  include HTTParty
-  base_uri 'http://www.knmi.nl/climatology/daily_data/getdata_day.cgi'
-    
   class << self
-    private :new
     
-    # station1:station2:station15 requires station or list of stations NO DEFAULT
-    def station(station_number) 
-      if station_number.nil? == true
-        raise "Station Number Required" # doesn't work look into this
-      elsif station_number.kind_of?(Array)
-        "stns=#{station_number * ":"}"
-      else
-        "stns=#{station_number}"
-      end
+    #
+    # Get nearest station by lat lng
+    # KNMI.station_by_location(52.165, 4.419) #=> #<KNMI::Station:0x0000010134e7f0>
+    def station_by_location(lat, lng)
+      Station.closest_to(lat, lng)
     end
     
-    def check_stations
-      # stubbed out complete later
+    #
+    # Get station object by station ID
+    # KNMI.station_by_id(210) #=> #<KNMI::Station:0x000001016b9b38>
+    def station_by_id(station_id)
+      Station.find(station_id)
     end
     
-    # YYYYMMDD Default is first day of current month
-    def start_date(_start)
-      "start=#{_start}"
-    end
+    #
+    # Generate array of unique daily or hourly parameter objects
+    # All details in daily_data_key.yml and hourly_data_key.yml
+    # inputs 
+    # period = "daily" or "hourly" 
+    # params =  
+    # categories =
     
-    # YYYYMMDD Default is current or last recorded day
-    def end_date(_end)
-      "end=#{_end}"
-    end
-
-    def variables(vars)
-            
-      if vars.empty? == true
-        "vars=ALL"
-      else      
-        vars, nvars = check_variables(vars)
-        "vars=#{vars * ":"}"        
-      end    
+    def parameters(period, params = "", categories = "")
+      if params.blank? and categories.blank?
+        list = Parameters.all(period)
+      else
+        list = []
+        
+        # Parameters by category
+        list << Parameters.category(period, categories)
+        list.flatten!
+        
+        # Parameters by name
+        params = unique_params(params, list) #ensure params are unique to list 
+        list << Parameters.find(period, params)        
+        list.flatten!
+        list.compact!
+      end
+      return list
     end
-  
-	  # Delete Invalid Variables and keep those valid, if none are valid replace with all
-    def check_variables(vars)
-
-      if vars.kind_of?(Array) == false 
-        vars = [vars]
+        
+    #
+    # Input a station object from KNMI.station_by_id or KNMI.station_by_location
+    # and a parameter hash of objects from # KNMI.Parameters
+    # return 
+    def get_data(station_object, parameter_object, start_at = nil, end_at = nil, seasonal = false)
+      if parameter_object[0].period == "daily"
+        HttpService.get_daily(station_object, parameter_object, start_at, end_at, seasonal)
+      elsif parameter_object[0].period == "hourly"
+        HttpService.get_hourly(station_object, parameter_object, start_at, end_at, seasonal)
       end
-  
-      # Collections of variables and all Possible Variables
-      varOpts = {
-        "WIND" => ["DDVEC", "FG", "FHX", "FHX", "FX"], 
-        "TEMP" => ["TG", "TN", "TX", "T10N"], 
-        "SUNR" => ["SQ", "SP", "Q"],
-        "PRCP" => ["DR", "RH", "EV24"],
-        "PRES" => ["PG", "PGX", "PGN"],
-        "VICL" => ["VVN", "VVX", "NG"],
-        "MSTR" => ["VVN", "VVX", "NG"],
-        "ALL"  => ["DDVEC", "FHVEC", "FG", "FHX", 
-                   "FHXH", "FHN", "FHNH", "FXX", "FXXH", "TG", "TN", 
-                   "TNH", "TX", "TXH", "T10N", "T10NH", "SQ", "SP", 
-                   "Q", "DR", "RH", "RHX", "RHXH", "EV24", "PG", "PX", 
-                   "PXH", "PN", "PNH", "VVN", "VVNH", "VVX", "VVXH", 
-                   "NG", "UG", "UX", "UXH", "UN", "UNH"]
-      }
-
-        # Drop in invalid vars
-       vars = ( vars & varOpts.to_a.flatten )
-
-       # Only Allow Variable to be selected once, All, or TEMP, not ALL & TEMP
-       # And count the number of selected variables
-    	if vars.include?("ALL") == true or vars.empty? == true
-	      vars = "ALL"
-	      nvars = varOpts["ALL"].count
-    	elsif (vars & varOpts.keys) # check if contains keys
-
-	      x = []
-	      (vars & varOpts.keys).each do |k|
-	        x << varOpts.values_at(k)
-	      end
-	      vars = (vars - x.flatten)
-
-	      nvars = 0
-	      ( vars & varOpts.keys ).each do |v|
-	        nvars += varOpts[v].count
-	      end
-
-	      ( vars - varOpts.keys ).each do |v|
-	        nvars += 1
-	      end      
-    	end
-
-      return vars, nvars
     end
-    
-    # Parse Response into hashed arrays
-    #Other elements
-    #varlist = res[(7+nstn)..(6 + nstn + nvars)]
-    #colheader = res[(8 + nstn + nvars)]
-    #header = res[0..(9 + nstn + nvars)]
-    def parse(response, station_number, vars)
-      # Line Index Numbers
-      nstn = [station_number].flatten.length
-      vars, nvars = check_variables(vars)
-      
-      # Split lines into array
-      response = response.split(/\n/)
-
-      # Get Station Details
-      stations = response[5..(4+nstn)]
-      stations = stations.join.tr("\t", "\s")
-      stations = stations.tr("#", "")
-      stations = stations.tr(":", "")
-      stations = CSV.parse( stations, {:col_sep => "\s"} )
-      stations = stations.map {|row| row.map {|cell| cell.to_s } }
-      st_header = [:station_code, :lng, :lat, :elev, :name]
-      stations = stations.map {|row| Hash[*st_header.zip(row).flatten] }
 
-      # Get Variable Details
-      varlist = response[(7+nstn)..(6 + nstn + nvars)]
-      varlist = varlist.join
-      varlist = varlist.gsub(/# /, "")
-      varlist = varlist.gsub(/\s{2,}/, "")
-      varlist = varlist.gsub(/;/, "\r")
-      varlist = CSV.parse( varlist, {:col_sep => "= "} )
-      vr_header = [:var, :description]
-      varlist = varlist.map {|row| Hash[*vr_header.zip(row).flatten] }
-
-      # Get and clean data
-      response = response[(8 + nstn + nvars)..response.length]
-      response = response.join.tr("\s+", "")
-      response = response.tr("#", "")
-
-      # Parse into array and then hash with var name
-      response = CSV.parse(response, {:skip_blanks => true})
-      header = response.shift.map {|i| i.to_s.intern }
-      string_data = response.map {|row| row.map {|cell| cell.to_s } }
-      data = string_data.map {|row| Hash[*header.zip(row).flatten] }
-
-      return {:stations => stations, :variables => varlist, :data => data}
-    end
-  end # End Private
-   
-  # gets variables from station or list of stations
-  # with all variables if vars is empty or selected variables passed as an array
-  # data is from begining of current month to current day
-  # Example
-  # station_number = [210, 212]
-  # vars = "TG"
-  # res = KNMIdaily.get_station( station_number, vars )
-  # output {:stations => {:}}
-  def self.get_station(station_number, vars = "")
-    query = station(station_number) + "&" + variables(vars)
-    puts query 
-    res = get("", { :query => query } )
-    res = parse(res, station_number, vars)
-  end
-  
-  # gets variables from station or list of stations
-  # with all variables if vars is empty or selected variables passed as an array
-  # data is from start date to current
-  def self.get_station_start_to_current(station_number, start, vars = "")
-    query = station(station_number) + "&" + start_date(start) + "&" + variables(vars)
-    puts query
-    res = get("", { :query => query } )
-    res = parse(res, station_number, vars)
-  end
-  
-  # gets variables from station or list of stations
-  # with all variables if vars is empty or selected variables passed as an array
-  # data is from start date to end date
-  def self.get_station_range(station_number, _start, _end, vars = "")
-    query = station(station_number) + "&" + start_date(_start) + "&" + end_date(_end) + "&" + variables(vars)
-    puts query
-    res = get("", { :query => query } )
-    res = parse(res, station_number, vars)
-  end
-  
-  # gets variables from station or list of stations
-  # with all variables if vars is empty or selected variables passed as an array
-  # seasonal data is from start date to end date 
-  # by selected month and day within each year
-  def self.get_seasonal(station_number, _start, _end, vars = "")
-    query = station(station_number) + "&" + "inseason=true" + "&" + start_date(_start) + "&" + end_date(_end) + "&" + variables(vars)
-    puts query
-    get("", { :query => query } )
-  end
-  
-  def self.to_csv(filename, response)
-    CSV.open(filename, "wb") do |csv|
-      response[:data]
-      csv << response[0].keys
-      response[(1..(response.length - 1))].each do |line|
-        csv << line.values
+    
+    private
+    
+    # Identify and eliminate overlap between params and categories
+    def unique_params(params, list)
+      list.each do |e|
+        params = [params].flatten
+        params.delete_if {|p| p == e.parameter }
       end
+      return params
     end
+    
   end
-
 end