weather-forecasts 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 371ec85a41177e5776b3a7c75403e9c6542cbc3b
+  data.tar.gz: 175d691d93110a1420fe7418677ea2abe0791896
+SHA512:
+  metadata.gz: 0d418743f91fb40d802efd1bd5d7d98168df72b28c9c143046511a67b423f684eb5cf2dea4824588dd1c8086ef82fd68e2f0f3381472fd87fd27a2771c173352
+  data.tar.gz: 1cef93374ea71318d02dc1588d6cabe709c12a4035def8b31baf6e8a0665b7984f911d334ca46b89751e5d0e92dd1bdcab94616f3fe3e89b457e54def4f6b227

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+.ruby-version
+coverage/*
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  gem 'simplecov', '~>0.7.1', :require => false
+  gem 'coveralls', :require => false
+  gem 'webmock', '~>1.15.0'
+  gem 'vcr', '~>2.8.0'
+  gem 'rspec', '~>2.14.0'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 greencoder
+
+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,135 @@
+# Weather Forecasts for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/weather-forecasts.png)](http://badge.fury.io/rb/weather-forecasts)
+[![Build Status](https://travis-ci.org/alakra/weather-forecasts.png?branch=master)](https://travis-ci.org/alakra/weather-forecasts)
+[![Dependency Status](https://gemnasium.com/alakra/weather-forecasts.png)](https://gemnasium.com/alakra/weather-forecasts)
+[![Coverage Status](https://coveralls.io/repos/alakra/weather-forecasts/badge.png?branch=master)](https://coveralls.io/r/alakra/weather-forecasts?branch=master)
+
+[![Code Climate](https://codeclimate.com/github/alakra/weather-forecasts.png)](https://codeclimate.com/github/alakra/weather-forecasts) |
+[![Inline docs](http://inch-pages.github.io/github/alakra/weather-forecasts.png)](http://inch-pages.github.io/github/alakra/weather-forecasts)
+
+## Summary
+
+This library provides API client access to NOAA's NDFD database
+for access to weather forecast information via Ruby.
+
+## NDFD Features
+
+You can [see the available forecast information](http://www.nws.noaa.gov/ndfd/technical.htm#elements) that is accessible via the API on the NDFD technical description page.
+
+In general, you can get the following:
+
+  * Specific forecast dimensions (min/max temperature, wind speed, etc.) out to 168 hours.
+  * Climate outlook probabilities (estimated averages/totals of temperature and precipitation)
+  * Convective Outlook Hazard Probabilities (hazard outlook, tornadoes, etc.)
+  * Probabilistic Tropical Cyclone Surface Wind Speed (measured in knots)
+
+## Client Features
+
+The client offers a easy to use query interface and will hand back data to you in hashes, arrays and XML documents.
+Validates requests and data types on execution of requests (will raise contextual errors on poorly formed data in queries)
+
+## Runtime Dependencies
+
+Ruby versions supported:
+
+  * 2.1.x
+  * 2.0.x
+  * 1.9.3
+
+Ruby versions not supported (but will be):
+
+  * JRuby 1.7+
+  * Rubinius 2.2+
+
+Ruby versions that will not be supported:
+
+  * <= 1.9.2 (including REE)
+
+Libraries used:
+
+  * savon (for SOAP support)
+  * activesupport (for TimeWithZone support)
+  * nokogiri (for XML/XSLT parsing)
+  * http_logger (for controlling logging output from savon)
+
+## Installation
+
+    gem install weather-forecasts
+
+## Usage
+
+`WeatherForecasts.client` is the top-level start point from whence all API calls are executed.
+
+Most calls follow the form of:
+
+    WeatherForecasts.client.
+          select(:maxt, :mint, :temp, etc.).
+          where(conditions).
+          execute
+
+This will return an `Array` or `Hash` containing the data from the
+response depending on the type of the request.
+
+**NOTE**: Dates and times passed to the `where` must be
+ActiveSupport::TimeWithZone objects.
+
+**NOTE**: `NDFDgen` and `NDFDgenByDay` are not implemented in favor of
+using the equivalent collection-based functions.
+
+**NOTE**: `GmlLatLonList`, `GmlTimeSeries` are not implemented because
+of their limited use (and my inability to figure out what parameters
+to use to make a valid request).  It appears to be [discontinued](http://www.nws.noaa.gov/om/notification/tin10-59ending_wfs.htm).
+
+<table>
+  <tr>
+    <th>Query Method</th>
+    <th>API server function</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td><code>select</code></td>
+    <td><code>NDFDgenLatLonList</code></td>
+    <td>Returns a <code>Hash</code> of forecast metrics for multiple latitudes/longitudes.</td>
+  </tr>
+  <tr>
+    <td><code>select_by_days</code></td>
+    <td><code>NDFDgenByDayLatLonList</code></td>
+    <td>Returns a <code>Hash</code> of forecast metrics for multiple latitudes/longitudes in a 24/12 hour period for a number of days.</td>
+  </tr>
+  <tr>
+    <td><code>select_coordinates_by_zip</code></td>
+    <td><code>LatLonListZipCode</code></td>
+    <td>Returns a <code>Hash</code> of latitudes/longitudes for every zip code requested.</td>
+  </tr>
+  <tr>
+    <td><code>select_coordinates_by_cities</code></td>
+    <td><code>LatLonListCityNames</code></td>
+    <td>Returns a <code>Hash</code> of latitudes/longitudes for a pre-defined set of cities.</td>
+  </tr>
+  <tr>
+    <td><code>select_square_coordinates</code></td>
+    <td><code>LatLonListSquare</code></td>
+    <td>Returns a <code>Array</code> of latitudes/longitudes for the requested rectangular area.</td>
+  </tr>
+  <tr>
+    <td><code>select_gridpoint_coordinates</code></td>
+    <td><code>LatLonListSubgrid</code></td>
+    <td>Returns a <code>Array</code> of latitudes/longitudes for the requested subgrid.</td>
+  </tr>
+  <tr>
+    <td><code>select_linepoint_coordinates</code></td>
+    <td><code>LatLonListLine</code></td>
+    <td>Returns a <code>Array</code> of latitudes/longitudes between a start and end coordinate.</td>
+  </tr>
+  <tr>
+    <td><code>select_corner_coordinates</code></td>
+    <td><code>CornerPoints</code></td>
+    <td>Returns a <code>Array</code> of latitudes/longitudes of the corners of one of the NDFD grids.</td>
+  </tr>
+</table>
+
+To see a description of the NDFD Spatial Reference System (used for collecting lat/longs in an area)
+http://graphical.weather.gov/docs/ndfdSRS.htm
+
+To see more detailed documention, view the [API Documentation](http://rdoc.info/github/alakra/weather-forecasts/frames)

data/bin/wf-console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'nokogiri'
+
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'weather_forecasts'
+require 'weather_forecasts/client/help_console'
+
+require 'irb'
+require 'pp'
+
+client = WeatherForecasts.client
+
+h = WeatherForecasts::Client::HelpConsole.new
+h.display_welcome
+
+IRB.start

data/lib/weather-forecasts.rb

@@ -0,0 +1 @@
+require 'weather_forecasts'

data/lib/weather_forecasts.rb

@@ -0,0 +1,23 @@
+module WeatherForecasts
+  module_function
+
+  def env
+    @@env ||= (ENV['ENV'] || :production)
+  end
+
+  def client(options = {})
+    Client.new(options)
+  end
+
+  def root_path
+    File.expand_path(File.join(File.dirname(__FILE__), "../"))
+  end
+
+  def vendor_path
+    File.join(root_path, "vendor")
+  end
+end
+
+require 'weather_forecasts/dwml'
+require 'weather_forecasts/client'
+require 'weather_forecasts/client/version'

data/lib/weather_forecasts/client.rb

@@ -0,0 +1,65 @@
+require 'nokogiri'
+require 'savon'
+require 'http_logger'
+
+require 'weather_forecasts/client/error'
+require 'weather_forecasts/client/query'
+
+# Original web service description: http://graphical.weather.gov/xml/
+module WeatherForecasts
+  class Client
+    DEFAULT_WSDL = "http://graphical.weather.gov/xml/DWMLgen/wsdl/ndfdXML.wsdl"
+
+    def initialize(options = {})
+      @options = options
+
+      if options[:wsdl].blank?
+        @options.merge!(:wsdl => DEFAULT_WSDL)
+      end
+
+      if options[:logger].present?
+        HttpLogger.logger = options[:logger]
+      end
+    end
+
+    def soap_client
+      @soap_client ||= Savon.client(@options)
+    end
+
+    #
+    # Query Methods
+    ############################################################################
+
+    def select(*options)
+      SelectQuery.new(soap_client, options)
+    end
+
+    def select_by_days
+      SelectByDaysQuery.new(soap_client)
+    end
+
+    def select_coordinates_by_zip
+      SelectCoordinatesByZipQuery.new(soap_client)
+    end
+
+    def select_coordinates_by_cities
+      SelectCoordinatesByCitiesQuery.new(soap_client)
+    end
+
+    def select_square_coordinates
+      SelectSquareCoordinatesQuery.new(soap_client)
+    end
+
+    def select_gridpoint_coordinates
+      SelectGridpointCoordinatesQuery.new(soap_client)
+    end
+
+    def select_linepoint_coordinates
+      SelectLinepointCoordinatesQuery.new(soap_client)
+    end
+
+    def select_corner_coordinates
+      SelectCornerCoordinatesQuery.new(soap_client)
+    end
+  end
+end

data/lib/weather_forecasts/client/error.rb

@@ -0,0 +1,18 @@
+module WeatherForecasts
+  class Client
+    class InvalidSelectionAttributeError < ArgumentError
+    end
+
+    class InvalidPropertyTypeError < ArgumentError
+    end
+
+    class InvalidOptionSpecifiedError < ArgumentError
+    end
+
+    class RequiredPropertyError < ArgumentError
+    end
+
+    class RequiredKeysMissingError < ArgumentError
+    end
+  end
+end

data/lib/weather_forecasts/client/help_console.rb

@@ -0,0 +1,9 @@
+module WeatherForecasts
+  class Client
+    class HelpConsole
+      def display_welcome
+        puts "Use the `NDFD.client` object to start making API calls."
+      end
+    end
+  end
+end

data/lib/weather_forecasts/client/query.rb

@@ -0,0 +1,155 @@
+require 'active_support/time'
+require 'active_support/time_with_zone'
+
+Time.zone ||= "UTC"
+
+require 'weather_forecasts/client/query/query_property'
+require 'weather_forecasts/client/query/selection_attributes'
+require 'weather_forecasts/client/query/query_utilities'
+
+module WeatherForecasts
+  class Client
+    class Query
+      FORECAST_ELEMENTS = {
+        :maxt         => "Maximum Temperature",
+        :mint         => "Minimum Temperature",
+        :temp         => "3 Hourly Temperature",
+        :dew          => "Dewpoint Temperature",
+        :appt         => "Apparent Temperature",
+        :pop12        => "12 Hour Probability of Precipitation",
+        :qpf          => "Liquid Precipitation Amount",
+        :snow         => "Snowfall Amount",
+        :sky          => "Cloud Cover Amount",
+        :rh           => "Relative Humidity",
+        :wspd         => "Wind Speed",
+        :wdir         => "Wind Direction",
+        :wx           => "Weather",
+        :icons        => "Weather Icons",
+        :waveh        => "Wave Height",
+        :incw34       => "Probabilistic Tropical Cyclone Wind Speed >34 Knots (Incremental)",
+        :incw50       => "Probabilistic Tropical Cyclone Wind Speed >50 Knots (Incremental)",
+        :incw64       => "Probabilistic Tropical Cyclone Wind Speed >64 Knots (Incremental)",
+        :cumw34       => "Probabilistic Tropical Cyclone Wind Speed >34 Knots (Cumulative)",
+        :cumw50       => "Probabilistic Tropical Cyclone Wind Speed >50 Knots (Cumulative)",
+        :cumw64       => "Probabilistic Tropical Cyclone Wind Speed >64 Knots (Cumulative)",
+        :wgust        => "Wind Gust",
+        :critfireo    => "Fire Weather from Wind and Relative Humidity",
+        :dryfireo     => "Fire Weather from Dry Thunderstorms",
+        :conhazo      => "Convective Hazard Outlook",
+        :ptornado     => "Probability of Tornadoes",
+        :phail        => "Probability of Hail",
+        :ptstmwinds   => "Probability of Damaging Thunderstorm Winds",
+        :pxtornado    => "Probability of Extreme Tornadoes",
+        :pxhail       => "Probability of Extreme Hail",
+        :pxtstmwinds  => "Probability of Extreme Thunderstorm Winds",
+        :ptotsvrtstm  => "Probability of Severe Thunderstorms",
+        :pxtotsvrtstm => "Probability of Extreme Severe Thunderstorms",
+        :tmpabv14d    => "Probability of 8- To 14-Day Average Temperature Above Normal",
+        :tmpblw14d    => "Probability of 8- To 14-Day Average Temperature Below Normal",
+        :tmpabv30d    => "Probability of One-Month Average Temperature Above Normal",
+        :tmpblw30d    => "Probability of One-Month Average Temperature Below Normal",
+        :tmpabv90d    => "Probability of Three-Month Average Temperature Above Normal",
+        :tmpblw90d    => "Probability of Three-Month Average Temperature Below Normal",
+        :prcpabv14d   => "Probability of 8- To 14-Day Total Precipitation Above Median",
+        :prcpblw14d   => "Probability of 8- To 14-Day Total Precipitation Below Median",
+        :prcpabv30d   => "Probability of One-Month Total Precipitation Above Median",
+        :prcpblw30d   => "Probability of One-Month Total Precipitation Below Median",
+        :prcpabv90d   => "Probability of Three-Month Total Precipitation Above Median",
+        :prcpblw90d   => "Probability of Three-Month Total Precipitation Below Median",
+        :precipa_r    => "Real-time Mesoscale Analysis Precipitation",
+        :sky_r        => "Real-time Mesoscale Analysis GOES Effective Cloud Amount",
+        :td_r         => "Real-time Mesoscale Analysis Dewpoint Temperature",
+        :temp_r       => "Real-time Mesoscale Analysis Temperature",
+        :wdir_r       => "Real-time Mesoscale Analysis Wind Direction",
+        :wspd_r       => "Real-time Mesoscale Analysis Wind Speed",
+        :wwa          => "Watches, Warnings, and Advisories",
+        :iceaccum     => "Ice Accumulation",
+        :maxrh        => "Maximum Relative Humidity",
+        :minrh        => "Minimum Relative Humidity"
+      }
+
+      attr_reader :soap_client, :select_attributes, :conditions
+
+      def initialize(soap_client, select_attributes = [])
+        @soap_client = soap_client
+        @select_attributes = select_attributes
+        @conditions = {}
+      end
+
+      def where(params)
+        conditions.merge!(params)
+        set_defaults_as_needed
+
+        self
+      end
+
+      def execute
+        raise NotImplementedError, "Must be implemented in subclass."
+      end
+
+      def validate
+        validate_selection_attributes
+        validate_conditions
+      end
+
+      class << self
+        def properties
+          @@properties ||= {}
+        end
+
+        def property(attr, options = {})
+          properties[self] ||= []
+          properties[self] << QueryProperty.new(attr, options)
+        end
+
+        def selection_attributes
+          @@selection_attributes ||= {}
+        end
+
+        def set_selection_attributes(*attrs)
+          selection_attributes[self] = SelectionAttributes.new(attrs)
+        end
+      end
+
+      protected
+
+      def available_selections
+        self.class.selection_attributes[self.class]
+      end
+
+      def set_defaults_as_needed
+        query_properties = self.class.properties[self.class]
+        return unless query_properties
+
+        query_properties.select(&:default).each do |query_property|
+          next if conditions.has_key?(query_property.name)
+          conditions.merge!(query_property.name => query_property.default)
+        end
+      end
+
+      def validate_selection_attributes
+        select_attributes.each do |attr|
+          available_selections && available_selections.valid?(attr)
+        end
+      end
+
+      def validate_conditions
+        query_properties = self.class.properties[self.class]
+        return unless query_properties
+
+        query_properties.each do |query_property|
+          query_property.valid?(conditions)
+        end
+      end
+    end
+  end
+end
+
+require 'weather_forecasts/client/query/select_by_days_query'
+require 'weather_forecasts/client/query/select_coordinates_by_cities_query'
+require 'weather_forecasts/client/query/select_coordinates_by_zip_query'
+require 'weather_forecasts/client/query/select_corner_coordinates_query'
+require 'weather_forecasts/client/query/select_gridpoint_coordinates_query'
+require 'weather_forecasts/client/query/select_linepoint_coordinates_query'
+require 'weather_forecasts/client/query/select_square_coordinates_query'
+require 'weather_forecasts/client/query/select_query'