gull 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da54d6cfb08b76036d97ad90f22c636afadd4854
-  data.tar.gz: 96967ecefbb71ce965a1dd4cda9a32ccedb97d81
+  metadata.gz: 8e31bf5dcc237447beaebab3385d8d87b2615d88
+  data.tar.gz: c123ff556c38b50041abd35bf2211406a4da70cc
 SHA512:
-  metadata.gz: 0b6474304998d1f817affbf50900c192c2ef2de8276ba51f9d5329ce0642bf4daa5c8a81ac0a9af74fc138c7db740dcbcd817de6ec99d27348ded7fe0beed952
-  data.tar.gz: eee354c3c0477622cf3c44463b5d17959adb81d525bad64f8e604be0dcefe7a2b21c67c8c09c3daf26359dcd598bfd2439a2c5c0c709e8fc0acf9025a1823f00
+  metadata.gz: 014efe76f247bbdcb3a2159617ce700c5b291b141071f6cb74a546ee93a8126264128f0858ba15d882f2bbdd05a1a7ddb976d6a7a4131367aabdf9138006901b
+  data.tar.gz: 21a3d3fe3471ff03773a6958ed6af9908f198d284259b809e77f89a6219f1d21c14216304eb36f3b96d96b182162acccd1a8ad208f1c58aab321b98068ce09e9

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+#### 0.3.4 (12/16/2015)
+Fixed parser to handle empty geocode.
+
 #### 0.3.3 (11/25/2015)
 Handle additional service failure scenarios.
 ***

data/Gemfile

@@ -4,4 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
+gem 'guard'
+gem 'guard-rspec', require: false
 gem 'simplecov', require: false

data/Guardfile

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

data/README.md

@@ -50,12 +50,14 @@ alert.vtec
 ```
 
 To get alerts for a single state, territory, or marine zone just pass an optional URL
+
 ```ruby
 oklahoma_url = 'http://alerts.weather.gov/cap/ok.php?x=1'
 alerts = Gull::Alert.fetch(url: oklahoma_url)
 ```
 
 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'
 
@@ -63,6 +65,7 @@ alert.polygon.image_url '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' } 
@@ -70,15 +73,19 @@ 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
-The NWS will sometimes expire warnings before their expiration date/time, for example if they are reissuing a tornado warning by redefining the polygon area. This new warning will have it's own unique ID and the warning that it replaced will no longer exist in the results. So it's important when fetching new warnings to compare the active warnings from your previous call to fetch and if any active warnings are missing in the new results you should consider them expired. Otherwise you could end up with extra active warnings where perhaps just the warning text or polygon varies a little.
+##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.
 
+The public RSS feeds are not always reliable, if you are using this for critical purposes then you should explore other options.
 
 ### Urgency
 
@@ -115,7 +122,7 @@ The NWS will sometimes expire warnings before their expiration date/time, for ex
 
 1. Fork it ( https://github.com/sethdeckard/gull/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Run the specs, make sure they pass and that new features are covered
+3. Run the specs, make sure they pass and that new features are covered. Code coverage should be 100%.
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request

data/gull.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.6'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 2.11'
+  spec.add_development_dependency 'rspec', '>= 3.0'
   spec.add_development_dependency 'webmock'
 end

data/lib/gull/alert.rb

@@ -63,6 +63,8 @@ module Gull
     end
 
     def parse_geocode(element)
+      return if element.children.css('value').first.nil?
+
       geocode.fips6 = element.children.css('value').first.inner_text
       geocode.ugc = element.children.css('value').last.inner_text
     end
@@ -73,7 +75,7 @@ module Gull
     end
 
     def code_to_symbol(code)
-      code.gsub(' ', '_').downcase.to_sym
+      code.tr(' ', '_').downcase.to_sym
     end
   end
 end

data/lib/gull/version.rb

@@ -1,3 +1,3 @@
 module Gull
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/spec/alert_spec.rb

@@ -40,15 +40,20 @@ describe Gull::Alert do
     expect(first.severity).to eq :minor
     expect(first.certainty).to eq :very_likely
 
-    expect(first.geocode.fips6).to eq '006001 006013 006041 006053 006055 ' \
-      '006069 006075 006081 006085 006087 006097'
-    expect(first.geocode.ugc).to eq 'CAZ006 CAZ505 CAZ506 CAZ507 CAZ508 ' \
-      'CAZ509 CAZ510 CAZ511 CAZ512'
+    expect(first.geocode.fips6).to be_nil
+    expect(first.geocode.ugc).to be_nil
 
     expect(first.vtec).to eq '/O.NEW.KMTR.HT.Y.0002.141002T1900Z-141004T0400Z/'
 
     second = alerts[1]
     expect(second.polygon).to be_nil
+
+    expect(second.geocode.fips6).to eq '006001 006013 006041 006053 006055 ' \
+      '006069 006075 006081 006085 006087 006097'
+    expect(second.geocode.ugc).to eq 'CAZ006 CAZ505 CAZ506 CAZ507 CAZ508 ' \
+      'CAZ509 CAZ510 CAZ511 CAZ512 CAZ513 CAZ516 CAZ517 CAZ518 CAZ528 ' \
+      'CAZ529 CAZ530'
+
     expect(second.vtec).to be_nil
 
     third = alerts[2]

data/spec/fixtures/alerts.xml

@@ -1,13 +1,13 @@
 <?xml version = '1.0' encoding = 'UTF-8' standalone = 'yes'?>
 
 <!--
-This atom/xml feed is an index to active advisories, watches and warnings 
-issued by the National Weather Service.  This index file is not the complete 
-Common Alerting Protocol (CAP) alert message.  To obtain the complete CAP 
-alert, please follow the links for each entry in this index.  Also note the 
-CAP message uses a style sheet to convey the information in a human readable 
-format.  Please view the source of the CAP message to see the complete data 
-set.  Not all information in the CAP message is contained in this index of 
+This atom/xml feed is an index to active advisories, watches and warnings
+issued by the National Weather Service.  This index file is not the complete
+Common Alerting Protocol (CAP) alert message.  To obtain the complete CAP
+alert, please follow the links for each entry in this index.  Also note the
+CAP message uses a style sheet to convey the information in a human readable
+format.  Please view the source of the CAP message to see the complete data
+set.  Not all information in the CAP message is contained in this index of
 active alerts.
 -->
 
@@ -50,17 +50,13 @@ xmlns:ha = 'http://www.alerting.net/namespace/index_1.0'
 	<cap:areaDesc>Southern Salinas Valley, Arroyo Seco and Lake San Antonio</cap:areaDesc>
 	<cap:polygon>27.35,-81.79 27.14,-81.89 27.04,-81.97 27.04,-82.02 27.14,-81.97 27.35,-81.86 27.35,-81.79</cap:polygon>
 	<cap:geocode>
-	<valueName>FIPS6</valueName>
-	<value>006001 006013 006041 006053 006055 006069 006075 006081 006085 006087 006097</value>
-	<valueName>UGC</valueName>
-	<value>CAZ006 CAZ505 CAZ506 CAZ507 CAZ508 CAZ509 CAZ510 CAZ511 CAZ512</value>
 	</cap:geocode>
 	<cap:parameter>
 	<valueName>VTEC</valueName>
 	<value>/O.NEW.KMTR.HT.Y.0002.141002T1900Z-141004T0400Z/</value>
 	</cap:parameter>
 	</entry>
-	
+
 		<entry>
 	<id>http://alerts.weather.gov/cap/wwacapget.php?x=CA125171381DD0.HeatAdvisory.125171642740CA.MTRNPWMTR.64d60221994d798a87b4862623e0d63c</id>
 	<updated>2014-10-01T08:40:00-07:00</updated>
@@ -119,4 +115,4 @@ xmlns:ha = 'http://www.alerting.net/namespace/index_1.0'
 	<value>CAZ006 CAZ505 CAZ506 CAZ507 CAZ508 CAZ509 CAZ510 CAZ511 CAZ512 CAZ513 CAZ516 CAZ517 CAZ518 CAZ528 CAZ529 CAZ530</value>
 	</cap:geocode>
 	</entry>
-</feed>
+</feed>

data/spec/spec_helper.rb

@@ -3,10 +3,10 @@ require 'coveralls'
 require 'simplecov'
 require 'webmock/rspec'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
-]
+])
 SimpleCov.start
 
 # This file was generated by the `rspec --init` command. Conventionally, all

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gull
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Seth Deckard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -105,9 +105,11 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Client for parsing NOAA/NWS alerts, warnings, and watches.