gull 0.2.13 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7841c6854343d87ee16705b0606bea985d8d27cf
-  data.tar.gz: 1102c41588ddeab4435d344420e47c1ba0b09956
+  metadata.gz: 85f0268b1bbaa2d578bd56d7009ae77e6677844d
+  data.tar.gz: 36044cbee5417556bd2957b12617ac28fc9d97b2
 SHA512:
-  metadata.gz: fc13ad4a90732adcde90db23e27c948306f98ac8a23fe6a3726446627708be4803bd4d475396e2ebe156692cfd1d14f20d57165f80784288961ef0cc2ad4fd8f
-  data.tar.gz: 73965ce13979a9ba0962a845f86f86797b78bb6811541a69f9dfd889c7423407c5d57b6a061917580c8753148dab20a21f94622b871e926edfa8f9c91993c0ad
+  metadata.gz: f5a27d2ce025475eb49c36be539f36776836ce4bd817cad9293aa87b18004972720262a969cb57acab801566986da218bdb0b1faf45decddce7cab590dce0e52
+  data.tar.gz: 9fe4fc8c1eb48d41200f0b469cc8334c05adc6684ef8836d9489edd6f04936906887d6097cfbf5bd3c9344fbe9dacf6ebcb98d3b0f39d3043c5e3abec46dabeb

data/CHANGELOG.md

@@ -1,15 +1,26 @@
-### 0.2.13 (6/20/2015) - Handle missing cap section
+#### 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.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) - Refectored and simplfied alert processing.
+#### 0.1.1 (10/01/2014)
+Refectored and simplfied 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/lib/gull.rb

@@ -1,5 +1,6 @@
 require 'gull/version'
 require 'gull/error'
+require 'gull/client'
 require 'gull/alert'
 require 'gull/polygon'
 require 'gull/geocode'

data/lib/gull/alert.rb

@@ -2,6 +2,8 @@ require 'httpclient'
 require 'nokogiri'
 
 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,
@@ -12,13 +14,8 @@ module Gull
     end
 
     def self.fetch(options = {})
-      options = {
-        url: 'http://alerts.weather.gov/cap/us.php?x=1'
-      }.merge options
-
-      content = response options
-      document = Nokogiri::XML content
-      process document.xpath('//xmlns:feed/xmlns:entry', namespaces)
+      client = Client.new options
+      client.fetch
     end
 
     def parse(element)
@@ -33,43 +30,6 @@ module Gull
 
     private
 
-    def self.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
-
-    def namespaces
-      Alert.namespaces
-    end
-
-    def self.response(options)
-      client = HTTPClient.new
-      begin
-        return client.get_content options[:url]
-      rescue HTTPClient::TimeoutError
-        raise TimeoutError, 'Timeout while connecting to NWS web service'
-      end
-    end
-
-    def self.process(entries)
-      alerts = []
-      entries.each do |entry|
-        alert = create_instance entry
-        alerts.push alert unless alert.nil?
-      end
-
-      alerts
-    end
-
-    def self.create_instance(entry)
-      return if entry.xpath('cap:event').empty?
-
-      alert = Alert.new
-      alert.parse entry
-      alert
-    end
-
     def parse_core_attributes(element)
       self.id = element.css('id').inner_text
       self.title = element.css('title').inner_text

data/lib/gull/client.rb

@@ -0,0 +1,62 @@
+require 'httpclient'
+require 'nokogiri'
+
+module Gull
+  # Client exposes methods and options for fetching alerts from the NWS/NOAA
+  # web service
+  class Client
+    attr_accessor :errors
+
+    def initialize(options = {})
+      @options = {
+        url: 'http://alerts.weather.gov/cap/us.php?x=1',
+        strict: false
+      }.merge 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)
+    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'
+      end
+    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?
+      end
+
+      alerts
+    end
+
+    def create_instance(entry)
+      return if entry.xpath('cap:event').empty?
+
+      alert = Alert.new
+      alert.parse entry
+      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/version.rb

@@ -1,3 +1,3 @@
 module Gull
-  VERSION = '0.2.13'
+  VERSION = '0.3.0'
 end

data/spec/alert_spec.rb

@@ -59,14 +59,25 @@ describe Gull::Alert do
   it 'should fetch from url in options' do
     xml = File.read 'spec/fixtures/alerts.xml'
 
-    stub_request(:get, 'http://alerts.weather.gov/cap/ok.php?x=1')
+    stub_request(:get, 'http://test.url')
       .with(headers: { 'Accept' => '*/*' })
       .to_return(status: 200, body: xml, headers: {})
 
-    alerts = Gull::Alert.fetch(url: 'http://alerts.weather.gov/cap/ok.php?x=1')
+    alerts = Gull::Alert.fetch(url: 'http://test.url')
     expect(alerts.size).to eq(3)
   end
 
+  it 'should enable strict xml parsing via option' do
+    xml = File.read 'spec/fixtures/bad.xml'
+
+    stub_request(:get, 'http://alerts.weather.gov/cap/us.php?x=1')
+      .with(headers: { 'Accept' => '*/*' })
+      .to_return(status: 200, body: xml, headers: {})
+
+    expect { Gull::Alert.fetch(strict: true) }
+      .to raise_error(Nokogiri::XML::SyntaxError)
+  end
+
   it 'should handle empty alerts' do
     xml = File.read 'spec/fixtures/empty.xml'
 

data/spec/fixtures/client_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Gull::Client do
+  it 'should initialize with options' do
+    xml = File.read 'spec/fixtures/alerts.xml'
+    stub_request(:get, 'http://test.url')
+      .with(headers: { 'Accept' => '*/*' })
+      .to_return(status: 200, body: xml, headers: {})
+
+    options = { url: 'http://test.url', strict: true }
+    client = Gull::Client.new(options)
+    alerts = client.fetch
+    expect(alerts.size).to eq 3
+
+    xml = File.read 'spec/fixtures/bad.xml'
+    stub_request(:get, 'http://test.url')
+      .with(headers: { 'Accept' => '*/*' })
+      .to_return(status: 200, body: xml, headers: {})
+
+    expect { client.fetch }
+      .to raise_error(Nokogiri::XML::SyntaxError)
+  end
+
+  it 'should fetch alerts without options' do
+    xml = File.read 'spec/fixtures/alerts.xml'
+
+    stub_request(:get, 'http://alerts.weather.gov/cap/us.php?x=1')
+      .with(headers: { 'Accept' => '*/*' })
+      .to_return(status: 200, body: xml, headers: {})
+
+    client = Gull::Client.new
+    alerts = client.fetch
+    expect(alerts.size).to eq 3
+    expect(client.errors.size).to eq 0
+  end
+
+  it 'should handle incomplete entries in xml' do
+    xml = File.read 'spec/fixtures/missing_cap.xml'
+
+    stub_request(:get, 'http://alerts.weather.gov/cap/us.php?x=1')
+      .with(headers: { 'Accept' => '*/*' })
+      .to_return(status: 200, body: xml, headers: {})
+
+    client = Gull::Client.new
+    alerts = client.fetch
+    expect(alerts.size).to eq 0
+    expect(client.errors.size).to eq 1
+  end
+end

data/spec/fixtures/missing_cap.xml

@@ -41,16 +41,6 @@ xmlns:ha = 'http://www.alerting.net/namespace/index_1.0'
     <title>Flood Warning issued June 20 at 8:02AM CDT until June 23 at 2:53AM CDT by NWS</title>
     <link href='http://alerts.weather.gov/cap/wwacapget.php?x=LA1253AE8E0B98.FloodWarning.1253AEBAFBE4LA.SHVFLSSHV.3908c4d415c0ed7efa65ce2f6eea425e'/>
     <summary>The flood warning continues for the Red Chute Bayou At Sligo, Louisiana. * until late Monday night...or until the warning is cancelled. * At 70 AM Saturday the stage was 32.0 feet. * Minor flooding is occurring and minor flooding is forecast. * Flood stage is 31 feet.</summary>
-    <valueName>FIPS6</valueName>
-    <value>022013 022015</value>
-    <valueName>UGC</valueName>
-    <value>LAC013 LAC015</value>
-    </cap:geocode>
-    <cap:parameter>
-    <valueName>VTEC</valueName>
-    <value>/O.EXT.KSHV.FL.W.0168.000000T0000Z-150623T0753Z/
-/SLGL1.1.ER.150618T1228Z.150619T1330Z.150622T1353Z.NO/</value>
-    </cap:parameter>
     </entry>
     
 </feed>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gull
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.3.0
 platform: ruby
 authors:
 - Seth Deckard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-20 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -114,6 +114,7 @@ files:
 - gull.gemspec
 - lib/gull.rb
 - lib/gull/alert.rb
+- lib/gull/client.rb
 - lib/gull/error.rb
 - lib/gull/geocode.rb
 - lib/gull/polygon.rb
@@ -121,6 +122,7 @@ files:
 - spec/alert_spec.rb
 - spec/fixtures/alerts.xml
 - spec/fixtures/bad.xml
+- spec/fixtures/client_spec.rb
 - spec/fixtures/empty.xml
 - spec/fixtures/missing_cap.xml
 - spec/polygon_spec.rb
@@ -153,6 +155,7 @@ test_files:
 - spec/alert_spec.rb
 - spec/fixtures/alerts.xml
 - spec/fixtures/bad.xml
+- spec/fixtures/client_spec.rb
 - spec/fixtures/empty.xml
 - spec/fixtures/missing_cap.xml
 - spec/polygon_spec.rb