noaa_weather_client 0.0.1

data/data/xml/summarizationType.xsd

@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+
+<!--   **********************************************************************   
+                                                                           
+       summarizationType.xsd   
+
+       John L. Schattel          MDL                29 June 2009  
+       Red Hat Linux                                Apache Server  
+                                       
+
+      *************************************************************************   -->
+
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+
+    <xsd:simpleType name="summarizationType">
+       <xsd:restriction base="xsd:string">
+          <xsd:enumeration value="none" />
+          <xsd:enumeration value="mean" />
+          <xsd:enumeration value="maximum" />
+          <xsd:enumeration value="minimum" />
+          <xsd:enumeration value="12hourly" />
+          <xsd:enumeration value="24hourly" />
+          <xsd:enumeration value="national" />
+          <xsd:enumeration value="conus" />
+          <xsd:enumeration value="alaska" />
+       </xsd:restriction>
+    </xsd:simpleType>
+
+</xsd:schema>

data/data/xml/time_layout.xsd

@@ -0,0 +1,51 @@
+<?xml version="1.0"?>
+
+<!--   **********************************************************************   
+                                                                           
+       time_layout.xsd   
+
+       John L. Schattel          MDL                4 August 2004  
+       Red Hat Linux                                Apache Server  
+
+    <xsd:include schemaLocation="http://graphical.weather.gov/xml/DWMLgen/schema/summarizationType.xsd" />                 
+
+      *************************************************************************   -->
+
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+
+    <xsd:include schemaLocation="summarizationType.xsd" />                 
+
+    <xsd:complexType name="time-layoutElementType">
+        <xsd:sequence>
+            <xsd:element name="layout-key" type="layout-keyType" minOccurs="1" maxOccurs="1" /> 
+            <xsd:sequence minOccurs="1" maxOccurs="unbounded">
+                <xsd:element name="start-valid-time" type="start-valid-timeType" minOccurs="1" maxOccurs="unbounded" />
+                <xsd:element name="end-valid-time" type="xsd:dateTime" minOccurs="0" maxOccurs="unbounded" />
+            </xsd:sequence>
+        </xsd:sequence>
+        <xsd:attribute name="time-coordinate" type="time-coordinateType" use="required" />      
+        <xsd:attribute name="summarization" type="summarizationType" use="optional" />
+    </xsd:complexType>
+
+    <xsd:simpleType name="time-coordinateType">
+       <xsd:restriction base="xsd:string">
+          <xsd:enumeration value="UTC" />
+          <xsd:enumeration value="local" />
+       </xsd:restriction>
+    </xsd:simpleType>
+
+    <xsd:complexType name="start-valid-timeType">
+        <xsd:simpleContent>
+            <xsd:extension base="xsd:dateTime">
+                <xsd:attribute name="period-name" type="xsd:string" />
+            </xsd:extension>
+        </xsd:simpleContent>
+    </xsd:complexType>
+
+    <xsd:simpleType name="layout-keyType">
+       <xsd:restriction base="xsd:string">
+          <xsd:pattern value="k-p\d+[h|d|m|y]-n\d+-\d+" />
+       </xsd:restriction>
+    </xsd:simpleType>
+
+</xsd:schema>

data/lib/noaa_weather_client.rb

@@ -0,0 +1,9 @@
+require "noaa_weather_client/version"
+require_relative 'noaa_weather_client/client'
+require_relative 'noaa_weather_client/cli'
+
+module NoaaWeatherClient
+  def self.build_client
+    Client.new
+  end
+end

data/lib/noaa_weather_client/cli.rb

@@ -0,0 +1,53 @@
+require 'noaa_weather_client/cli/templates'
+
+module NoaaWeatherClient
+  class CLI
+    def self.postal_code_to_coordinate(postal_code, buffer = STDOUT)
+      client = NoaaWeatherClient.build_client
+      coordinate = client.postal_code_to_coordinate postal_code
+      buffer.puts Templates::PostalCode.new(coordinate).to_s
+    end
+
+    attr_writer :buffer
+
+    def initialize(latitude, longitude)
+      @coordinate = Coordinate.new(latitude, longitude)
+      raise ArgumentError, "Invalid coordinate #{latitude}, #{longitude}" unless coordinate.valid?
+    end
+
+    def render(*features)
+      features.each { |f| render_feature buffer, f }
+    end
+
+    private
+
+    attr_reader :coordinate
+
+    def render_feature(buffer, feature)
+      if feature.to_s == 'observations'
+        observations = client.current_observations(coordinate.latitude, coordinate.longitude)
+        buffer.puts Templates::CurrentObservations.new(observations).to_s
+      elsif feature.to_s == 'forecast'
+        forecast = client.forecast_by_day(coordinate.latitude, coordinate.longitude)
+        buffer.puts Templates::Forecast.new(forecast).to_s
+      end
+    end
+
+    def buffer
+      @buffer || STDOUT
+    end
+
+    def client
+      @client ||= NoaaWeatherClient.build_client
+    end
+
+    Coordinate = Struct.new(:latitude, :longitude) do
+      def valid?
+        latitude && longitude rescue false
+      end
+
+      def latitude; Float(self[:latitude]) end
+      def longitude; Float(self[:longitude]) end
+    end
+  end
+end

data/lib/noaa_weather_client/cli/templates.rb

@@ -0,0 +1,53 @@
+module NoaaWeatherClient
+  module Templates
+    CurrentObservations = Struct.new(:observation) do
+      def to_s
+        <<-template
+Current Observations
+================================================================================
+StationID: #{observation.station_id}
+Station Name: #{observation.location}
+Location: #{observation.latitude}, #{observation.longitude}
+Observation Time: #{observation.observation_time_string}
+Temperature: #{observation.temperature_fahrenheit} | #{observation.temperature_celsius}
+Dewpoint: #{observation.dewpoint_fahrenheit} | #{observation.dewpoint_celsius}
+Pressure: #{observation.pressure_in} in | #{observation.pressure_mb} mb
+Humidity: #{observation.relative_humidity}
+Wind: #{observation.wind_string}
+Wind Direction: #{observation.wind_dir} | #{observation.wind_degrees} degrees
+Wind Speed: #{observation.wind_mph} mph | #{observation.wind_kt} kt
+Visibility: #{observation.visibility_mi} mi
+
+template
+      end
+    end
+
+    PostalCode = Struct.new(:coordinate) do
+      def to_s
+        "#{coordinate.latitude} #{coordinate.longitude}"
+      end
+    end
+
+    ForecastDay = Struct.new(:day) do
+      def to_s
+        <<-template
+Day: #{day.name}
+--------------------------------------------------------------------------------
+High: #{day.maximum_temperature} F
+Low: #{day.minimum_temperature} F
+Summary: #{day.weather_summary}
+
+template
+      end
+    end
+
+    Forecast = Struct.new(:forecast) do
+      def to_s
+        template = "\n#{forecast.days.size}-Day Forecast\n"
+        template += "================================================================================\n"
+        forecast.days.each { |d| template +=  ForecastDay.new(d).to_s }
+        template
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/client.rb

@@ -0,0 +1,61 @@
+require_relative 'services/forecast_by_day'
+require_relative 'services/weather_stations'
+require_relative 'services/current_observations'
+require_relative 'services/find_nearest_station'
+require_relative 'services/postal_code_to_coordinate'
+
+module NoaaWeatherClient
+  # Provides entry point for interacting with the noaa api via multiple services.
+  class Client
+    # Fetches a daily forecast for a location from today. Default is 7 days.
+    # The forecast for the current day ceases to be returned after 6:00pm at the
+    # observation area.
+    # @param lat [Float] latitude
+    # @param lon [Float] longitude
+    # @return [Responses::Forecast] a list of daily forecasts.
+    def forecast_by_day(lat, lon, options = {})
+      Services::ForecastByDay.new.fetch(lat, lon, options)
+    end
+
+    # Retrieves a list of weather stations from noaa.
+    # @return [Responses::Stations] a list of weather stations.
+    def weather_stations(options = {})
+      if options.delete(:reload) { false } || @weather_stations.nil?
+        @weather_stations = Services::WeatherStations.new(options).fetch
+      end
+      @weather_stations
+    end
+
+    # Retrieves the current weather observations for a location.
+    # @note It is important to cache a copy of the available stations for use here, as the xml stations response is quite large noaa does not appreciate repeated calls.
+    # @param lat [Float] latitude
+    # @param lon [Float] longitude
+    # @param [Hash] options
+    # @option options [Responses::Stations] stations A cached stations response to prevent having to query noaa for the list.
+    # @return [Responses::CurrentObservation]
+    def current_observations(lat, lon, options = {})
+      station = options.fetch(:station) { nearest_weather_station(lat, lon, options) }
+      Services::CurrentObservations.new(options).fetch(station)
+    end
+
+    # Retrieves the weather station nearest to the location.
+    # @note It is important to cache a copy of the available stations for use here, as the xml stations response is quite large noaa does not appreciate repeated calls.
+    # @param lat [Float] latitude
+    # @param lon [Float] longitude
+    # @param [Hash] options
+    # @option options [Responses::Stations] stations A cached stations response to prevent having to query noaa for the list.
+    # @return [Responses::Station]
+    def nearest_weather_station(lat, lon, options = {})
+      stations = options.fetch(:stations) { weather_stations }
+      Services::FindNearestStation.find(lat, lon, stations)
+    end
+
+    # Converts a zip code to a latitude and longitude.
+    # @param lat [Float] latitude
+    # @param lon [Float] longitude
+    # @return [Responses::LatLonList]
+    def postal_code_to_coordinate(postal_code, options = {})
+      Services::PostalCodeToCoordinate.new(options).resolve(postal_code)
+    end
+  end
+end

data/lib/noaa_weather_client/errors.rb

@@ -0,0 +1,7 @@
+module NoaaWeatherClient
+  module Errors
+    class Error < StandardError; end
+    class CommunicationError < Error; end
+    class InvalidXmlError < ArgumentError; end
+  end
+end

data/lib/noaa_weather_client/responses/current_observation.rb

@@ -0,0 +1,93 @@
+require_relative '../xml_parser_factory'
+require_relative 'reactive_xml_response'
+require_relative 'validatable_xml_response'
+
+module NoaaWeatherClient
+  module Responses
+    class CurrentObservation
+      include ReactiveXmlResponse
+      include ValidatableXmlResponse
+
+      def initialize(response)
+        @source = XmlParserFactory.build_parser.parse response
+        validate! @source, :current_observation
+        init
+      end
+
+      def temperature_celsius
+        @temp_c.to_f
+      end
+
+      def temperature_fahrenheit
+        @temp_f.to_f
+      end
+
+      def dewpoint_celsius
+        @dewpoint_c.to_f
+      end
+
+      def dewpoint_fahrenheit
+        @dewpoint_f.to_f
+      end
+
+      def latitude
+        @latitude.to_f
+      end
+
+      def longitude
+        @longitude.to_f
+      end
+
+      def observation_time_string
+        @observation_time
+      end
+
+      def observation_time
+        Time.parse(@observation_time_rfc822.to_s) if @observation_time_rfc822
+      end
+
+      def pressure_in
+        @pressure_in.to_f
+      end
+
+      def pressure_mb
+        @pressure_mb.to_f
+      end
+
+      def relative_humidity
+        @relative_humidity.to_f
+      end
+
+      def wind_degrees
+        @wind_degrees.to_f
+      end
+
+      def wind_kt
+        @wind_kt.to_f
+      end
+
+      def wind_mph
+        @wind_mph.to_f
+      end
+
+      def visibility_mi
+        @visibility_mi.to_f
+      end
+
+      def to_hash
+        arr = instance_variables.map { |v|
+          [ v.to_s[1..-1], instance_variable_get(v) ] unless v =~ /source/
+        }.compact
+        Hash[arr]
+      end
+
+      private
+
+      def init
+        source.root.elements.each do |e|
+          instance_variable_set("@#{e.name}", e.text)
+        end
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/responses/forecast.rb

@@ -0,0 +1,84 @@
+require_relative '../xml_parser_factory'
+require_relative 'validatable_xml_response'
+require 'ostruct'
+
+module NoaaWeatherClient
+  module Responses
+    class Forecast
+      include Enumerable
+      include ValidatableXmlResponse
+
+      def initialize(hashed_response)
+        @body = XmlParserFactory.build_parser.parse hashed_response[:ndf_dgen_by_day_response][:dwml_by_day_out]
+        validate! @body, :dwml
+      end
+
+      def each
+        days.each { |d| yield d }
+      end
+
+      def size
+        days.size
+      end
+
+      def days
+        @days ||= build_days
+      end
+
+      private
+
+      attr_reader :body
+
+      def time_layout
+        @time_layout ||= body.css("time-layout[summarization='24hourly']").first
+      end
+
+      def layout_key
+        @layout_key ||= time_layout.css('layout-key').text
+      end
+
+      def parameters
+        @paramteters ||= body.css('parameters')
+      end
+
+      def time_layout_periods
+        unless @time_layout_periods
+          periods = time_layout.element_children.to_a
+          periods.shift #remove layout-key
+          @time_layout_periods = [].tap do |arr|
+            periods.each_slice(2) do |slice|
+              name = slice.first['period-name']
+              arr << TimePeriod.new(*slice, name)
+            end
+          end
+        end
+        @time_layout_periods
+      end
+
+      def build_days
+        unless @days
+          @day = [].tap do |arr|
+            time_layout_periods.each_with_index do |p, i|
+              params = build_day_params p, i
+              arr << Day.new(params)
+            end
+          end
+        end
+      end
+
+      def build_day_params(period, index)
+        {
+          start_time: Time.parse(period.start_time.to_s),
+          end_time: Time.parse(period.end_time.to_s),
+          name: Time.parse(period.start_time.to_s).strftime("%A"),
+          maximum_temperature: parameters.css('temperature[type=maximum] value')[index].text.to_f,
+          minimum_temperature: parameters.css('temperature[type=minimum] value')[index].text.to_f,
+          weather_summary: parameters.css('weather weather-conditions')[index]['weather-summary']
+        }
+      end
+
+      class Day < OpenStruct; end
+      TimePeriod = Struct.new(:start_time, :end_time, :name)
+    end
+  end
+end