gull 0.3.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e31bf5dcc237447beaebab3385d8d87b2615d88
-  data.tar.gz: c123ff556c38b50041abd35bf2211406a4da70cc
+SHA256:
+  metadata.gz: eb20ff9550e66bb6897227d930069551cc9882c1eef9f285d7a1ba74e0b2133e
+  data.tar.gz: b50b4e87e416dce952046c357e2c06d1d826b84e451141e237570418569d4b1d
 SHA512:
-  metadata.gz: 014efe76f247bbdcb3a2159617ce700c5b291b141071f6cb74a546ee93a8126264128f0858ba15d882f2bbdd05a1a7ddb976d6a7a4131367aabdf9138006901b
-  data.tar.gz: 21a3d3fe3471ff03773a6958ed6af9908f198d284259b809e77f89a6219f1d21c14216304eb36f3b96d96b182162acccd1a8ad208f1c58aab321b98068ce09e9
+  metadata.gz: b06376a56d00f2fa3ee684f4897b02439d24cd910722779a1f696e4d2a596550fa82cd7efb2e83c94934550fdaf406a266cddcab78a97b41d9fbdf6a13f65373
+  data.tar.gz: ca1f9f07f27e928571b1d0ed54bbe2275bccd8389995073f0892b4c5e469d176ea5084fa09bf0bdbca923b225105627da4f45e986fd5cd06e245a82a4515a577

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec
+      - name: Run linter
+        run: bundle exec rubocop

data/.gitignore

@@ -1,22 +1,6 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+/.bundle
+/coverage
+/pkg
+/tmp
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+.ruby-version

data/.rubocop.yml

@@ -1,5 +1,38 @@
 AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
     - 'spec/spec_helper.rb'
+    - 'gull.gemspec'
+    - 'vendor/**/*'
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'spec/**/*'
+Metrics/AbcSize:
+  Max: 35
+  Exclude:
+    - 'spec/**/*'
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Layout/LineLength:
+  Max: 80
+  Exclude:
+    - 'spec/**/*'
 Style/StringLiterals:
-  EnforcedStyle: single_quotes
+  EnforcedStyle: single_quotes
+Style/StringConcatenation:
+  Exclude:
+    - 'spec/**/*'
+Style/Documentation:
+  Enabled: false
+Naming/PredicateMethod:
+  Enabled: false

data/CHANGELOG.md

@@ -1,38 +1,57 @@
-#### 0.3.4 (12/16/2015)
-Fixed parser to handle empty geocode.
+1.0.0 (03/07/2026) - Major rewrite: migrate from defunct `alerts.weather.gov` XML feed to `api.weather.gov/alerts` JSON API. Drop all runtime dependencies (`httpclient`, `nokogiri`) in favor of Ruby stdlib (`net/http`, `json`). Require Ruby >= 3.1. Add `area` option for state-based filtering. Replace Travis CI with GitHub Actions. Add RuboCop. **Breaking:** remove `url` option (use `area` instead), remove `Polygon#image_url`, remove `strict` option.
 
-#### 0.3.3 (11/25/2015)
-Handle additional service failure scenarios.
 ***
-#### 0.3.2 (11/10/2015)
-Added BadResponseError to client error handling.
+
+0.4.0 (07/26/2016) - Merged pull request #2 from [schrockwell](https://github.com/schrockwell), which adds `to_wkt` to `Polygon` which formats the polygon points as Well-Known Text (WKT). Removed `centroid` method, use new `to_wkt` method with an external geospatial library instead.
+
+***
+
+0.3.4 (12/16/2015) - Fixed parser to handle empty geocode.
+
 ***
-#### 0.3.1 (6/25/2015)
-Added nested error handling for other HTTPClient errors. HttpError has original attribute exposing the root error.
+
+0.3.3 (11/25/2015) - Handle additional service failure scenarios.
+
 ***
-#### 0.3.0 (6/23/2015)
-Added Client class for error handling (bad entries accessed via errors array). Exposed option to turn on strict XML parsing for debugging. Alert.fetch uses new Client but is backwards compatible, however it doesn't give you access to errors array.
+
+0.3.2 (11/10/2015) - Added BadResponseError to client error handling.
+
+***
+
+0.3.1 (6/25/2015) - Added nested error handling for other HTTPClient errors. HttpError has original attribute exposing the root error.
+
+***
+
+0.3.0 (6/23/2015) - Added Client class for error handling (bad entries accessed via errors array). Exposed option to turn on strict XML parsing for debugging. Alert.fetch uses new Client but is backwards compatible, however it doesn't give you access to errors array.
+
 ***
-#### 0.2.13 (6/20/2015)
-Handle missing cap section
+
+0.2.13 (6/20/2015) - Handle missing cap section
+
 ***
-#### 0.2.12 (6/12/2015)
-Fix issue with missing link elements
+
+0.2.12 (6/12/2015) - Fix issue with missing link elements
+
 ***
-#### 0.2.11 (5/29/2015)
-Added method to get original polygon string
+
+0.2.11 (5/29/2015) -Added method to get original polygon string
+
 ***
-#### 0.2.10 (3/23/2015)
-Added option to override default alert service URI.
+
+0.2.10 (3/23/2015) - Added option to override default alert service URI.
+
 ***
-#### 0.2.1 (10/02/2014)
-Added static map image to polygons.
+
+0.2.1 (10/02/2014) - Added static map image to polygons.
+
 ***
-#### 0.2.0 (10/02/2014)
-Introduced Polygon type.
+
+0.2.0 (10/02/2014) - Introduced Polygon type.
+
 ***
-#### 0.1.1 (10/01/2014)
-Refactored and simplified alert processing.
+
+0.1.1 (10/01/2014) - Refactored and simplified alert processing.
+
 ***
-#### 0.1.0 (10/01/2014)
-Initial release, basic functionality of fetching and parsing alerts.
+
+0.1.0 (10/01/2014) - Initial release, basic functionality of fetching and parsing alerts.

data/Gemfile

@@ -1,9 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gull.gemspec
 gemspec
-
-gem 'coveralls', require: false
-gem 'guard'
-gem 'guard-rspec', require: false
-gem 'simplecov', require: false

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Seth Deckard
+Copyright (c) 2014-2026 Seth Deckard
 
 MIT License
 

data/README.md

@@ -1,12 +1,8 @@
 [![Gem Version](https://badge.fury.io/rb/gull.svg)](http://badge.fury.io/rb/gull)
-[![Build Status](https://travis-ci.org/sethdeckard/gull.svg?branch=master)](https://travis-ci.org/sethdeckard/gull)
-[![Coverage Status](https://coveralls.io/repos/sethdeckard/gull/badge.png)](https://coveralls.io/r/sethdeckard/gull)
-[![Code Climate](https://codeclimate.com/github/sethdeckard/gull/badges/gpa.svg)](https://codeclimate.com/github/sethdeckard/gull)
-[![Dependency Status](https://gemnasium.com/sethdeckard/gull.svg)](https://gemnasium.com/sethdeckard/gull)
-[![security](https://hakiri.io/github/sethdeckard/gull/master.svg)](https://hakiri.io/github/sethdeckard/gull/master)
+[![CI](https://github.com/sethdeckard/gull/actions/workflows/ci.yml/badge.svg)](https://github.com/sethdeckard/gull/actions/workflows/ci.yml)
 # Gull
 
-Ruby client for parsing NOAA/NWS alerts, warnings, and watches. The name comes from the type of bird featured on the NOAA logo.
+Ruby client for parsing NOAA/NWS alerts, warnings, and watches. The name comes from the type of bird featured on the NOAA logo. Zero runtime dependencies -- uses only Ruby stdlib (`net/http`, `json`).
 
 ## Installation
 
@@ -49,49 +45,22 @@ alert.certainty
 alert.vtec
 ```
 
-To get alerts for a single state, territory, or marine zone just pass an optional URL
+To get alerts for a single state or territory, pass the area option:
 
 ```ruby
-oklahoma_url = 'http://alerts.weather.gov/cap/ok.php?x=1'
-alerts = Gull::Alert.fetch(url: oklahoma_url)
+alerts = Gull::Alert.fetch(area: 'OK')
 ```
 
-You can also generate a map (a really long URL pointing to a map) of the polygon if alert has one (requires Google Static Maps API Key)
-
-```ruby
-alert.polygon.image_url 'YOUR_GOOGLE_API_KEY'
-
-=> "http://maps.googleapis.com/maps/api/staticmap?size=640x640&maptype=roadmap&path=color:0xff0000|weight:3|fillcolor:0xff000060|38.73,-94.22|38.75,-94.16|38.57,-93.94|38.4,-93.84|38.4,-93.91|38.73,-94.22&key=YOUR_GOOGLE_API_KEY"
-```
-
-Options can be passed for map to override defaults
-
-```ruby
-options = { width: 600, height: 300, color: '0xfbf000', weight: 4,
-            fillcolor: '0xfbf00070', maptype: 'hybrid' } 
-alert.polygon.image_url 'YOUR_GOOGLE_API_KEY', options 
-```
-
-Get the centroid of the polygon (to display a map pin, etc.)
-
-```ruby
-alert.polygon.centroid
-
-=> [34.835, -91.205]
-```
-	
 ##Notes, Caveats
-This library provides a simplified/flattened model of the [Common Alerting Protocol](http://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2-os.html) based only on the elements NWS utilizes in their public RSS feeds. If you need a complete CAP parser I suggest looking at [RCAP](https://github.com/farrel/RCAP).
-
-The NWS will often cancel or update alerts before their expiration time. The public alert feed only provides current active alerts and does not include these separate update and cancellation CAP messages. If you're persisting these alerts you need to design for this scenario.
+This library fetches active alerts from the [NWS API](https://api.weather.gov) (`api.weather.gov/alerts/active`), which returns GeoJSON. No authentication is required but the API does require a `User-Agent` header (set automatically by the gem).
 
-The public RSS feeds are not always reliable, if you are using this for critical purposes then you should explore other options.
+The NWS will often cancel or update alerts before their expiration time. The API only returns currently active alerts.
 
 ### Urgency
 
-| Symbol        | Definition          
+| Symbol        | Definition
 | :------------- |:-------------
-| :immediate  | Responsive action should betaken immediately
+| :immediate  | Responsive action should be taken immediately
 | :expected  | Responsive action should be taken soon (within next hour)
 | :future  | Responsive action should be taken in the near future
 | :past  | Responsive action is no longer required
@@ -99,7 +68,7 @@ The public RSS feeds are not always reliable, if you are using this for critical
 
 ### Severity
 
-| Symbol        | Definition          
+| Symbol        | Definition
 | :------------- |:-------------
 | :extreme  | Extraordinary threat to life or property
 | :severe  | Significant threat to life or property
@@ -109,7 +78,7 @@ The public RSS feeds are not always reliable, if you are using this for critical
 
 ### Certainty
 
-| Symbol        | Definition          
+| Symbol        | Definition
 | :------------- |:-------------
 | :very_likely  | Highly likely (p > ~ 85%) or certain
 | :likely  | Likely (p > ~50%)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/gull.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gull/version'
 
@@ -9,20 +10,29 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Seth Deckard']
   spec.email         = ['seth@deckard.me']
   spec.summary       = 'Client for parsing NOAA/NWS alerts, warnings, and watches.'
-  spec.description   = 'Client for parsing NOAA/NWS alerts, warnings, and watches.'
+  spec.description   = 'Fetches and parses NOAA/NWS alerts, warnings, and watches from api.weather.gov. Zero runtime dependencies.'
   spec.homepage      = 'https://github.com/sethdeckard/gull'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.1'
+
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/sethdeckard/gull',
+    'changelog_uri' => 'https://github.com/sethdeckard/gull/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/sethdeckard/gull/issues'
+  }
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(AGENTS|CLAUDE)\.md$})
+  end
   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_runtime_dependency 'httpclient'
-  spec.add_runtime_dependency 'nokogiri', '>= 1.6.2'
-
-  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
 end

data/lib/gull/alert.rb

@@ -1,80 +1,89 @@
-require 'httpclient'
-require 'nokogiri'
+# frozen_string_literal: true
 
 module Gull
-  # Gull represents an NWS/NOAA alert and provides the ability to fetch
-  # them from the public web service
   class Alert
-    attr_accessor :id, :title, :summary, :link, :alert_type, :polygon, :area,
-                  :effective_at, :expires_at, :updated_at, :published_at,
-                  :urgency, :severity, :certainty, :geocode, :vtec
+    attr_accessor :id, :title, :summary, :link, :alert_type, :polygon,
+                  :area, :effective_at, :expires_at, :updated_at,
+                  :published_at, :urgency, :severity, :certainty,
+                  :geocode, :vtec
 
     def initialize
       self.geocode = Geocode.new
     end
 
     def self.fetch(options = {})
-      client = Client.new options
+      client = Client.new(options)
       client.fetch
     end
 
-    def parse(element)
-      parse_core_attributes element
-      parse_times element
-      parse_categories element
-
-      parse_polygon element.xpath('cap:polygon').inner_text
-      parse_geocode element.xpath('cap:geocode')
-      parse_vtec element.xpath('cap:parameter')
+    def parse(feature)
+      props = feature['properties']
+      parse_core_attributes(feature, props)
+      parse_times(props)
+      parse_categories(props)
+      parse_polygon(feature)
+      parse_geocode(props)
+      parse_vtec(props)
     end
 
     private
 
-    def parse_core_attributes(element)
-      self.id = element.css('id').inner_text
-      self.title = element.css('title').inner_text
-      self.summary = element.css('summary').inner_text
-      self.link = parse_link element
-      self.alert_type = element.xpath('cap:event').inner_text
-      self.area = element.xpath('cap:areaDesc').inner_text
+    def parse_core_attributes(feature, props)
+      self.id = props['id']
+      self.title = props['headline']
+      self.summary = props['description']
+      self.link = props['@id'] || feature['id']
+      self.alert_type = props['event']
+      self.area = props['areaDesc']
     end
 
-    def parse_link(element)
-      link = element.css('link').first
-      link.attributes['href'].value unless link.nil?
+    def parse_times(props)
+      self.effective_at = Time.parse(props['effective'])
+      self.expires_at = Time.parse(props['expires'])
+      self.published_at = Time.parse(props['sent'])
+      self.updated_at = Time.parse(props['onset'] || props['sent'])
     end
 
-    def parse_times(element)
-      self.updated_at = Time.parse(element.css('updated').inner_text)
-      self.published_at = Time.parse(element.css('published').inner_text)
-      self.effective_at = Time.parse(element.xpath('cap:effective').inner_text)
-      self.expires_at = Time.parse(element.xpath('cap:expires').inner_text)
+    def parse_categories(props)
+      self.urgency = code_to_symbol(props['urgency'])
+      self.severity = code_to_symbol(props['severity'])
+      self.certainty = code_to_symbol(props['certainty'])
     end
 
-    def parse_categories(element)
-      self.urgency = code_to_symbol element.xpath('cap:urgency').inner_text
-      self.severity = code_to_symbol element.xpath('cap:severity').inner_text
-      self.certainty = code_to_symbol element.xpath('cap:certainty').inner_text
-    end
+    def parse_polygon(feature)
+      geometry = feature['geometry']
+      return if geometry.nil?
+
+      coords = geometry['coordinates']
+      return if coords.nil? || coords.empty?
 
-    def parse_polygon(text)
-      return if text.empty?
-      self.polygon = Polygon.new text
+      ring = coords.first
+      ring = ring.first if geometry['type'] == 'MultiPolygon'
+      self.polygon = Polygon.new(ring)
     end
 
-    def parse_geocode(element)
-      return if element.children.css('value').first.nil?
+    def parse_geocode(props)
+      geocode_data = props['geocode']
+      return if geocode_data.nil?
 
-      geocode.fips6 = element.children.css('value').first.inner_text
-      geocode.ugc = element.children.css('value').last.inner_text
+      ugc = geocode_data['UGC']
+      geocode.ugc = ugc&.join(' ')
+
+      fips = geocode_data['SAME']
+      geocode.fips6 = fips&.join(' ')
     end
 
-    def parse_vtec(element)
-      value = element.children.css('value').inner_text
-      self.vtec = value.empty? ? nil : value
+    def parse_vtec(props)
+      params = props['parameters']
+      return if params.nil?
+
+      vtec_values = params['VTEC']
+      self.vtec = vtec_values&.first
     end
 
     def code_to_symbol(code)
+      return :unknown if code.nil?
+
       code.tr(' ', '_').downcase.to_sym
     end
   end

data/lib/gull/client.rb

@@ -1,65 +1,73 @@
-require 'httpclient'
-require 'nokogiri'
+# frozen_string_literal: true
 
 module Gull
-  # Client exposes methods and options for fetching alerts from the NWS/NOAA
-  # web service
   class Client
+    URL = 'https://api.weather.gov/alerts/active'
+    USER_AGENT = "gull/#{VERSION} (Ruby #{RUBY_VERSION})".freeze
+
     attr_accessor :errors
 
     def initialize(options = {})
-      @options = {
-        url: 'http://alerts.weather.gov/cap/us.php?x=1',
-        strict: false
-      }.merge options
+      @options = options
     end
 
     def fetch
       self.errors = []
-      content = response
-      document = Nokogiri::XML content do |config|
-        config.strict if @options[:strict]
-      end
-      process document.xpath('//xmlns:feed/xmlns:entry', namespaces)
+      json = response
+      data = JSON.parse(json)
+      process(data['features'] || [])
     end
 
     private
 
     def response
-      client = HTTPClient.new
-      begin
-        return client.get_content @options[:url]
-      rescue HTTPClient::TimeoutError
-        raise TimeoutError, 'Timeout while connecting to NWS web service'
-      rescue HTTPClient::KeepAliveDisconnected, HTTPClient::BadResponseError,
-             SocketError, Errno::ECONNREFUSED, Errno::ECONNRESET
-        raise HttpError, 'Could not connect to NWS web service'
+      uri = build_uri
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      request = Net::HTTP::Get.new(uri)
+      request['User-Agent'] = USER_AGENT
+      request['Accept'] = 'application/geo+json'
+      result = http.request(request)
+      unless result.is_a?(Net::HTTPSuccess)
+        raise HttpError, "NWS API returned #{result.code}"
       end
+
+      result.body
+    rescue Net::OpenTimeout, Net::ReadTimeout
+      raise TimeoutError,
+            'Timeout while connecting to NWS web service'
+    rescue SocketError, Errno::ECONNREFUSED, Errno::ECONNRESET
+      raise HttpError,
+            'Could not connect to NWS web service'
     end
 
-    def process(entries)
-      alerts = []
-      entries.each do |entry|
-        alert = create_instance entry
-        alerts.push alert unless alert.nil?
-        errors.push entry if alert.nil?
+    def build_uri
+      uri = URI(URL)
+      if @options[:area]
+        params = URI.decode_www_form(uri.query || '')
+        params << ['area', @options[:area]]
+        uri.query = URI.encode_www_form(params)
       end
+      uri
+    end
 
+    def process(features)
+      alerts = []
+      features.each do |feature|
+        alert = create_instance(feature)
+        alerts.push(alert) unless alert.nil?
+        errors.push(feature) if alert.nil?
+      end
       alerts
     end
 
-    def create_instance(entry)
-      return if entry.xpath('cap:event').empty?
+    def create_instance(feature)
+      properties = feature['properties']
+      return if properties.nil? || properties['event'].nil?
 
       alert = Alert.new
-      alert.parse entry
+      alert.parse(feature)
       alert
     end
-
-    def namespaces
-      { 'xmlns' => 'http://www.w3.org/2005/Atom',
-        'cap' => 'urn:oasis:names:tc:emergency:cap:1.1',
-        'ha' => 'http://www.alerting.net/namespace/index_1.0' }
-    end
   end
 end

data/lib/gull/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 
 module Gull

data/lib/gull/geocode.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gull
   class Geocode
     attr_accessor :fips6, :ugc