SnotelAPI 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22059a277b15f4e5727a9cc2eff6817b2007ab7c
+  data.tar.gz: 28d778dff8b79421a6c237c0d4d00ebeef206b52
+SHA512:
+  metadata.gz: ec469a149922e7dd5567b2953286e2c78fca44560eac471a14131d0058ea8ac3757578a3fafd8693202e2157a8d02dd9b5c5386b75d2efb5673a92be3df08e3e
+  data.tar.gz: b2ae3c5d9978ad9256742520322c6c737fbfc7e14748b49124afd9090690ba971a942bba66cdcb1e1345e95897de17362fe6946cce80e490d06cac2a44e58063

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in SnotelAPI.gemspec
+gemspec
+
+gem 'rspec'
+gem 'savon'
+gem 'activesupport'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pedro Rodriguez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# SnotelAPI
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'SnotelAPI'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install SnotelAPI
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/SnotelAPI.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'SnotelAPI/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'SnotelAPI'
+  spec.version       = SnotelAPI::VERSION
+  spec.authors       = ['Pedro Rodriguez']
+  spec.email         = ['ski.rodriguez@gmail.com']
+  spec.description   = 'Ruby gem that interfaces with the NOAA Snotel API'
+  spec.summary       = 'Ruby gem that interfaces with the NOAA Snotel API'
+  spec.homepage      = 'http://snowgeek.org'
+  spec.license       = 'GNU V2'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/SnotelAPI/version.rb

@@ -0,0 +1,3 @@
+module SnotelAPI
+  VERSION = "0.0.1"
+end

data/lib/SnotelAPI.rb

@@ -0,0 +1,156 @@
+require "SnotelAPI/version"
+require 'thread_safe'
+require 'nokogiri'
+require 'savon'
+require 'active_support/core_ext/string/strip'
+
+module SnotelAPI
+  WSDL = 'http://www.wcc.nrcs.usda.gov/awdbWebService/services?WSDL'
+  CSV_API_URL = 'http://www.wcc.nrcs.usda.gov/reportGenerator/view_csv/customMultipleStationReport%2Cmetric/hourly/'
+  CLIENT = Savon::Client.new do
+    wsdl 'lib/snotel-services.xml'
+    log false #Rails.env.development?
+  end
+  #Code docs here: http://www.wcc.nrcs.usda.gov/web_service/AWDB_Web_Service_Reference.htm#elementCodes
+  #Element Codes
+  #TOBS PREC SNWD WTEQ PRES DPTP RHUM SNOW WDIRV WDIR WSPD WSPV
+
+  def make_wsdl_request(method, message, client=nil)
+    if client.nil?
+      return CLIENT.call(method, message: message)
+    end
+    return client.call(method, message: message)
+  end
+
+  def make_client(num=-1)
+    if num == -1
+      return Savon::Client.new do
+        wsdl 'lib/data/snotel-services.xml'
+        log Rails.env.development?
+      end
+    end
+    clients = ThreadSafe::Array.new(num)
+    clients.map { make_client }
+    return clients
+  end
+
+  # Gets the stations metadata for the station_triplet
+  # The result is a hash of the values for the metadata
+  # Hash Values
+  # action_id, begin_date, county_name, elevation, end_date, fips_county_cd, fips_country_cd, fips_state_number
+  # huc, hud, latitude, longitude, name, shefid, station_data_time_zone, station_time_zone, station_triplet
+  # http://www.wcc.nrcs.usda.gov/web_service/AWDB_Web_Service_Reference.htm#StationMetadata
+  def get_station_metadata(station_triplet)
+    xml = make_wsdl_request(:get_station_metadata, get_station_metadata_xml(station_triplet))
+    xml.body[:get_station_metadata_response][:return]
+  end
+  #Returns the xml for getting station metadata based on the station_triplet
+  def get_station_metadata_xml(station_triplet)
+    "<stationTriplet>#{station_triplet}</stationTriplet>"
+  end
+
+  def get_all_stations_xml
+    <<-eos.strip_heredoc
+      <networkCds>SNTL</networkCds>
+      <logicalAnd>true</logicalAnd>
+    eos
+  end
+  def get_all_stations
+    make_wsdl_request(:get_stations, get_all_stations_xml)
+  end
+  def get_bounded_stations_xml(min_lat, max_lat, min_lon, max_lon)
+    <<-eos.strip_heredoc
+      <networkCds>SNTL</networkCds>
+      <minLatitude>#{min_lat}</minLatitude>
+      <maxLatitude>#{max_lat}</maxLatitude>
+      <minLongitude>#{min_lon}</minLongitude>
+      <maxLongitude>#{max_lon}</maxLongitude>
+      <logicalAnd>true</logicalAnd>
+    eos
+  end
+  # Queries Snotel for any stations which are within min_lat, max_lat, min_lon, and max_lon
+  # This list is returned as an array of strings of the stations striplets
+  def get_bounded_stations(min_lat, max_lat, min_lon, max_lon)
+    xml = make_wsdl_request(:get_stations, get_bounded_stations_xml(min_lat, max_lat, min_lon, max_lon))
+    stations = xml.body[:get_stations_response][:return]
+    unless stations.kind_of?(Array)
+      stations = [stations]
+    end
+    return stations
+  end
+
+  def get_hourly_data(station_triplets, hours_back)
+    csv = make_csv_request(station_triplets, hours_back)
+    return parse_hourly_data_csv(csv)
+  end
+
+  def parse_hourly_data_csv(csv)
+    clean_csv = remove_csv_comments(csv)
+    data = []
+    clean_csv.each do |r|
+      r = CSV.parse(r)[0]
+      data.append({ datetime: r[0], snow_water_equivalent: r[3], snow_depth: r[4], temp: r[5] })
+    end
+    return data
+  end
+
+  # Takes in csv as a string. Parses it via newlines checking to see if any line is empty
+  # or contains a comment beggining with a #. Then shifts the csv to remove the header line of the file
+  def remove_csv_comments(csv)
+    csv = csv.split(/\n/).reject { |s| csv_requirement(s) }
+    csv.shift()
+    return csv
+  end
+
+  def csv_requirement(s)
+    comment = !/^#/.match(s).nil?
+    comment || s.empty?
+  end
+
+  def make_csv_request(station_triplets, days_back)
+    url = URI.parse(build_csv_api_url(station_triplets, days_back))
+    request = Net::HTTP::Get.new(url.to_s)
+    response = Net::HTTP.start(url.host, url.port) do |http|
+      http.request(request)
+    end
+    response.body
+  end
+
+  def build_csv_api_url(station_triplets, hours_back)
+    stations = station_triplets.join('|')
+    url = "#{CSV_API_URL}#{CGI.escape(stations)}%7Cid%3D%22%22%7Cname~0/-#{hours_back}%2C0/stationId%2Cname%2CWTEQ%3A%3Avalue%2CSNWD%3A%3Avalue%2CTOBS%3A%3Avalue"
+    return url
+  end
+
+  def convert_raw_data_to_display_formats(data, hours_back)
+    result = {}
+    depth_data = []
+    temperature_data = []
+    sw_equivalent_data = []
+    raw_data = []
+    depth_counter = -hours_back
+    temperature_counter = -hours_back
+    sw_equivalent_counter = -hours_back
+    data.each do |r|
+      unless r[:snow_depth].nil?
+        depth_data.append([depth_counter, r[:snow_depth].to_f])
+      end
+      depth_counter += 1
+      unless r[:temp].nil?
+        temperature_data.append([temperature_counter, r[:temp].to_f])
+      end
+      temperature_counter += 1
+      unless r[:snow_water_equivalent].nil?
+        sw_equivalent_data.append([sw_equivalent_counter, r[:snow_water_equivalent].to_f])
+      end
+      sw_equivalent_counter += 1
+      raw_data.append([r[:datetime], r[:snow_water_equivalent].to_f, r[:snow_depth].to_f, r[:temp].to_f])
+    end
+    result[:depth_data] = depth_data
+    result[:temperature_data] = temperature_data
+    result[:sw_equivalent_data] = sw_equivalent_data
+    result[:raw_data] = raw_data
+    return result
+  end
+  extend self
+end

data/test/snotel_api_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'data/snotel_api'
+
+describe SnotelAPI do
+  describe 'xml methods' do
+    it 'has correct get_all_stations xml' do
+      expected_xml = <<-eos.strip_heredoc
+        <networkCds>SNTL</networkCds>
+        <logicalAnd>true</logicalAnd>
+      eos
+      SnotelAPI.get_all_stations_xml.should == expected_xml
+    end
+    it 'has correct get_station_metadata xml' do
+      station_triplet = '302:OR:SNTL'
+      expected_xml = "<stationTriplet>#{station_triplet}</stationTriplet>"
+      SnotelAPI.get_station_metadata_xml(station_triplet).should == expected_xml
+    end
+    it 'has correct get_bounded_stations xml' do
+      min_lat = 0
+      max_lat = 1
+      min_lon = 2
+      max_lon = 3
+      expected_xml = <<-eos.strip_heredoc
+        <networkCds>SNTL</networkCds>
+        <minLatitude>#{min_lat}</minLatitude>
+        <maxLatitude>#{max_lat}</maxLatitude>
+        <minLongitude>#{min_lon}</minLongitude>
+        <maxLongitude>#{max_lon}</maxLongitude>
+        <logicalAnd>true</logicalAnd>
+      eos
+      SnotelAPI.get_bounded_stations_xml(min_lat, max_lat, min_lon, max_lon).should == expected_xml
+    end
+  end
+  describe 'xml API methods' do
+    it 'has working get_station_metadata' do
+      VCR.use_cassette('data#get_station_metadata') do
+        result = SnotelAPI.get_station_metadata('302:OR:SNTL')
+        result[:county_name].should == 'WALLOWA'
+        result[:fips_county_cd].should == '063'
+        result[:station_triplet].should == '302:OR:SNTL'
+      end
+    end
+    it 'has working get_all_stations' do
+      VCR.use_cassette('data#get_all_stations') do
+        SnotelAPI.get_all_stations()
+      end
+    end
+    it 'has working get_bounded_stations' do
+      VCR.use_cassette('data#get_bounded_stations') do
+        stations = SnotelAPI.get_bounded_stations(41.234, 41.236, -120.792, -120.790)
+        stations.should == ['301:CA:SNTL']
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: SnotelAPI
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pedro Rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem that interfaces with the NOAA Snotel API
+email:
+- ski.rodriguez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SnotelAPI.gemspec
+- lib/SnotelAPI.rb
+- lib/SnotelAPI/version.rb
+- test/snotel_api_spec.rb
+homepage: http://snowgeek.org
+licenses:
+- GNU V2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby gem that interfaces with the NOAA Snotel API
+test_files:
+- test/snotel_api_spec.rb