noaa_weather_client 0.0.1

data/lib/noaa_weather_client/responses/generic_response.rb

@@ -0,0 +1,9 @@
+module NoaaWeatherClient
+  module Responses
+    class GenericResponse
+      def initialize(response_body)
+        @response_body = response_body
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/responses/lat_lon_list.rb

@@ -0,0 +1,25 @@
+require_relative '../xml_parser_factory'
+require_relative 'reactive_xml_response'
+require_relative 'validatable_xml_response'
+
+module NoaaWeatherClient
+  module Responses
+    class LatLonList
+      include ReactiveXmlResponse
+      include ValidatableXmlResponse
+
+      def initialize(response)
+        @source = XmlParserFactory.build_parser.parse(response)
+        validate! @source, :dwml
+      end
+
+      def latitude
+        @latitude ||= latLonList.split(",").first.to_f
+      end
+
+      def longitude
+        @longitude ||= latLonList.split(",").last.to_f
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/responses/reactive_xml_response.rb

@@ -0,0 +1,29 @@
+module NoaaWeatherClient
+  module Responses
+    module ReactiveXmlResponse
+      def method_missing(method_name, *arguments, &block)
+        if tag = source.css(method_name.to_s)
+          if block
+            block.call tag.text
+          else
+            tag.text
+          end
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        source.css(method_name.to_s) || super
+      end
+
+      def source
+        @source || NullResponse.new
+      end
+
+      class NullResponse
+        def css(*args); end
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/responses/station.rb

@@ -0,0 +1,28 @@
+require_relative 'reactive_xml_response'
+
+module NoaaWeatherClient
+  module Responses
+    class Station
+      include ReactiveXmlResponse
+
+      def initialize(station)
+        @source = station
+      end
+
+      def latitude
+        source.css('latitude').text.to_f
+      end
+
+      def longitude
+        source.css('longitude').text.to_f
+      end
+
+      def xml_url
+        @xml_url ||= begin
+                       path = URI(source.css('xml_url').text).path
+                       "http://w1.weather.gov#{path}"
+                     end
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/responses/stations.rb

@@ -0,0 +1,41 @@
+require_relative '../xml_parser_factory'
+require_relative 'station'
+require 'forwardable'
+
+module NoaaWeatherClient
+  module Responses
+    class Stations
+      include Enumerable
+      extend Forwardable
+
+      def_delegators :stations, :'[]', :fetch, :sort_by!, :take, :size
+
+      def initialize(response, options = {})
+        @body = XmlParserFactory.build_parser.parse response
+        @options = options
+      end
+
+      def each
+        stations.each { |s| yield s }
+      end
+
+      def to_xml
+        body.to_xml
+      end
+
+      private
+
+      attr_reader :body, :options
+
+      def stations
+        @stations ||= body.css('station').map do |station|
+          station_class.new station
+        end
+      end
+
+      def station_class
+        options.fetch(:station_class, Station)
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/responses/validatable_xml_response.rb

@@ -0,0 +1,22 @@
+require_relative '../errors'
+
+module NoaaWeatherClient
+  module Responses
+    module ValidatableXmlResponse
+      SCHEMA_PATH = File.expand_path("../../../../data/xml", __FILE__)
+
+      def validate!(doc, schema_name)
+        # chdir to help Nokogiri load included schemas
+        Dir.chdir(SCHEMA_PATH) do
+          schema_file = File.join(SCHEMA_PATH, "#{schema_name}.xsd")
+          schema = Nokogiri::XML::Schema(File.read(schema_file))
+          errors = schema.validate(doc)
+          unless errors.empty?
+            raise Errors::InvalidXmlError, "Invalid xml: #{errors.map(&:message).join("\n")}"
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/noaa_weather_client/rest_client_factory.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+require 'uri'
+
+module NoaaWeatherClient
+  module RestClientFactory
+    def self.build_client(options = {})
+      provider = options.fetch(:provider, Net::HTTP)
+      uri = URI(options.fetch(:url))
+      provider.new uri.host, uri.port
+    end
+  end
+end

data/lib/noaa_weather_client/services/calculate_distance_between_lat_lon.rb

@@ -0,0 +1,20 @@
+module NoaaWeatherClient
+  module Services
+    module CalculateDistanceBetweenLatLon
+      extend Math
+
+      def self.get_distance(lat1, lon1, lat2, lon2)
+        lat1, lon1, lat2, lon2 = convert_to_radian(lat1, lon1, lat2, lon2)
+
+        radius = 6371 #km
+        s = sin(lat1) * sin(lat2)
+        c = cos(lat1) * cos(lat2) * cos(lon2-lon1)
+        acos(s + c) * radius;
+      end
+
+      def self.convert_to_radian(*args)
+        args.map { |arg| arg / 180 * Math::PI }
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/services/current_observations.rb

@@ -0,0 +1,32 @@
+require_relative 'rest_service'
+require_relative '../responses/current_observation'
+
+module NoaaWeatherClient
+  module Services
+    class CurrentObservations
+      include RestService
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def fetch(station, options = {})
+        rest_service.object_from_response(:get,
+                                          station.xml_url,
+                                          response_class: response_class)
+      end
+
+      private
+
+      attr_reader :options
+
+      def rest_service
+        options.fetch(:rest_service, self)
+      end
+
+      def response_class
+        options.fetch(:response_class, Responses::CurrentObservation)
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/services/find_nearest_station.rb

@@ -0,0 +1,16 @@
+require_relative 'calculate_distance_between_lat_lon'
+
+module NoaaWeatherClient
+  module Services
+    module FindNearestStation
+      def self.find(lat, lon, stations, options = {})
+        calc = options.fetch(:calculator, CalculateDistanceBetweenLatLon)
+        filter = options.fetch(:filter, nil)
+        count = options.fetch(:count, 1)
+        stations.select!(&filter) if filter
+        stations.sort_by! { |s| calc.get_distance(lat, lon, s.latitude, s.longitude) }
+        count == 1 ? stations.first : stations.take(count)
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/services/forecast_by_day.rb

@@ -0,0 +1,52 @@
+require_relative 'soap_service'
+require_relative '../responses/forecast'
+
+module NoaaWeatherClient
+  module Services
+    class ForecastByDay
+      include SoapService
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def fetch(lat, lon, options = {})
+        fopts = build_formated_options options.merge({ latitude: lat.to_s, longitude: lon.to_s })
+        soap_service.object_from_response(:ndf_dgen_by_day, fopts, response_class: response_class)
+      end
+
+      private
+
+      attr_reader :options
+
+      def soap_service
+        options.fetch(:soap_service, self)
+      end
+
+      def response_class
+        options.fetch(:response_class, Responses::Forecast)
+      end
+
+      def build_formated_options(options)
+        opts = options.dup
+        {
+          latitude: opts.delete(:latitude),
+          longitude: opts.delete(:longitude),
+          startDate: opts.delete(:start_date) { Date.today.to_s },
+          numDays: opts.delete(:days) { 7 },
+          unit: unit!(opts),
+          format: opts.delete(:format) { '24 hourly' }
+        }.merge!(opts)
+      end
+
+      def unit!(options)
+        u = options.delete(:unit) { :standard }
+        if u == :standard
+          'e'
+        elsif u == :metric
+          'm'
+        end
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/services/postal_code_to_coordinate.rb

@@ -0,0 +1,36 @@
+require_relative 'rest_service'
+require_relative '../responses/lat_lon_list'
+
+module NoaaWeatherClient
+  module Services
+    class PostalCodeToCoordinate
+      include RestService
+
+      URL = "http://graphical.weather.gov/xml/sample_products/browser_interface/ndfdXMLclient.php?listZipCodeList="
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def resolve(zip, options = {})
+        rest_service.object_from_response(:get, build_url(zip), response_class: response_class)
+      end
+
+      private
+
+      attr_reader :options
+
+      def rest_service
+        options.fetch(:rest_service, self)
+      end
+
+      def response_class
+        options.fetch(:response_class, Responses::LatLonList)
+      end
+
+      def build_url(zip)
+        "#{URL}#{zip}"
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/services/rest_service.rb

@@ -0,0 +1,28 @@
+require 'net/http'
+require_relative '../rest_client_factory'
+require_relative '../responses/generic_response'
+require_relative '../errors'
+
+module NoaaWeatherClient
+  module RestService
+    def object_from_response(action, url, options = {})
+      response_class = options.fetch(:response_class, Responses::GenericResponse)
+      client = options.fetch(:client) { RestClientFactory.build_client(url: url) }
+      request = build_request_for_action action, url, options
+      response_class.new client.request(request).body
+    rescue Net::HTTPError,
+      Net::HTTPRetriableError,
+      Net::HTTPServerException,
+      Net::HTTPFatalError => e
+      raise Errors::CommunicationError, e.message, e.backtrace
+    end
+
+    # @note Much more to be done here when needed.
+    def build_request_for_action(action, url, options = {})
+      r_class = case action
+                when :get then Net::HTTP::Get
+                end
+      r_class.new url
+    end
+  end
+end

data/lib/noaa_weather_client/services/soap_service.rb

@@ -0,0 +1,16 @@
+require 'savon'
+require_relative '../soap_client_factory'
+require_relative '../responses/generic_response'
+require_relative '../errors'
+
+module NoaaWeatherClient
+  module SoapService
+    def object_from_response(soap_action, message, options = {})
+      client = options.fetch(:client, SoapClientFactory.build_client)
+      response_class = options.fetch(:response_class, Responses::GenericResponse)
+      response_class.new client.call(soap_action, message: message).body
+    rescue Savon::Error => e
+      raise Errors::CommunicationError, e.message, e.backtrace
+    end
+  end
+end

data/lib/noaa_weather_client/services/weather_stations.rb

@@ -0,0 +1,32 @@
+require_relative 'rest_service'
+require_relative '../responses/stations'
+
+module NoaaWeatherClient
+  module Services
+    class WeatherStations
+      include RestService
+
+      URL = 'http://w1.weather.gov/xml/current_obs/index.xml'
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def fetch(options = {})
+        rest_service.object_from_response(:get, URL, response_class: response_class)
+      end
+
+      private
+
+      attr_reader :options
+
+      def rest_service
+        options.fetch(:rest_service, self)
+      end
+
+      def response_class
+        options.fetch(:response_class, Responses::Stations)
+      end
+    end
+  end
+end

data/lib/noaa_weather_client/soap_client_factory.rb

@@ -0,0 +1,17 @@
+require 'savon'
+
+module NoaaWeatherClient
+  module SoapClientFactory
+    WSDL = 'http://graphical.weather.gov/xml/DWMLgen/wsdl/ndfdXML.wsdl'
+
+    def self.build_client(options = {})
+      provider = options.fetch(:provider, Savon)
+      wsdl = options.fetch(:wsdl, WSDL)
+      provider.client(wsdl: wsdl,
+                      log: false,
+                      open_timeout: 10,
+                      read_timeout: 30,
+                      ssl_verify_mode: :none)
+    end
+  end
+end

data/lib/noaa_weather_client/station_filters.rb

@@ -0,0 +1,8 @@
+module NoaaWeatherClient
+  module StationFilters
+    # {https://en.wikipedia.org/wiki/International_Civil_Aviation_Organization_airport_code ICAO reference}
+    def self.icao
+      ->(station) { (station.station_id =~ /\A[A-Z|0-9]{4}\z/) ? true : false }
+    end
+  end
+end