gull 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5a3b5083957caf81e25c35ecc48c924b7a5205b
-  data.tar.gz: eff8557f99a7de3fdbf566360f3496e77ebf21e1
+  metadata.gz: cc65a6c9ee8613f29a9e8e5d0417fec80900b73f
+  data.tar.gz: e306c334a7890b5ba7008faef82ec29ce95627a5
 SHA512:
-  metadata.gz: ec1b9e5d0bbad689d5a7ad2ee2159b33709c37fa206c66489a3d9d810ee7b4332f5b43e683c9fda625ae02cb8299fd0d32056484f70890598df19c045d6745d0
-  data.tar.gz: d0482148cfbd4fe0ff5fc480cda34dcba5839e643caf62420704a037ea45990cb7b60773a27dc3fa92e28c5595485e689c2b724f13c7cd8f081810f0ee41f12d
+  metadata.gz: ff9664befc1f5cada0ff816a64a3ba0c4de73470b3d80fc1986e73b78e7a086715d10b325f178fc8bdf5416d69c3b151bd1e1b7cb2de1b0a81bebf27bfe48f62
+  data.tar.gz: 0d8ae32459002821f3cdd83c3687884fafb8ad6afe7689b73470660ef6b3ab22332f792b03d078f30724941410f5d19c808fda8d5fcdf73cefbd008e0460b453

data/README.md

@@ -1,6 +1,6 @@
 # Gull
 
-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.
 
 ## Installation
 
@@ -18,7 +18,40 @@ Or install it yourself as:
 
 ## Usage
 
-Gull::Alert.fetch
+	require 'gull/alert'
+
+	Gull::Alert.fetch
+
+### Urgency
+
+| Symbol        | Definition          
+| :------------- |:-------------
+| :immediate  | Responsive action should betaken 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
+| :unknown  | Urgency not known
+
+### Severity
+
+| Symbol        | Definition          
+| :------------- |:-------------
+| :extreme  | Extraordinary threat to life or property
+| :severe  | Significant threat to life or property
+| :moderate  | Possible threat to life or property
+| :minor  | Minimal threat to life or property
+| :unknown  | Severity unknown
+
+### Certainty
+
+| Symbol        | Definition          
+| :------------- |:-------------
+| :very_likely  | Highly likely (p > ~ 85%) or certain
+| :likely  | Likely (p > ~50%)
+| :possible  | Possible but not likely (p <= ~50%)
+| :unlikely  | Not expected to occur (p ~ 0)
+| :unknown  | Certainty unknown
+
 
 ## Contributing
 
@@ -27,3 +60,7 @@ Gull::Alert.fetch
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+
+Gull is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/gull/alert.rb

@@ -6,9 +6,6 @@ module Gull
     attr_accessor :id, :title, :summary, :alert_type, :polygon, :area, :effective_at, :expires_at,
       :urgency, :severity, :certainty
 
-    def initialize(attributes = {})
-    end
-
     def self.fetch
       client = HTTPClient.new
       response = client.get_content "http://alerts.weather.gov/cap/us.php?x=0"
@@ -17,6 +14,8 @@ module Gull
       self.process entries
     end
 
+    private
+
     def self.process entries
       alerts = []
       entries.each do |entry|
@@ -29,14 +28,17 @@ module Gull
         alert.area = entry.xpath('cap:areaDesc').inner_text
         alert.effective_at = Time.parse(entry.xpath('cap:effective').inner_text).utc
         alert.expires_at = Time.parse(entry.xpath('cap:expires').inner_text).utc
-        alert.urgency = entry.xpath('cap:urgency').inner_text
-        alert.severity = entry.xpath('cap:severity').inner_text
-        alert.certainty = entry.xpath('cap:certainty').inner_text
+        alert.urgency = code_to_symbol entry.xpath('cap:urgency').inner_text
+        alert.severity = code_to_symbol entry.xpath('cap:severity').inner_text
+        alert.certainty = code_to_symbol entry.xpath('cap:certainty').inner_text
         alerts.push alert
       end
 
       alerts
     end
-    
+
+    def self.code_to_symbol code
+      code.gsub(' ','_').downcase.to_sym
+    end
   end
 end

data/lib/gull/version.rb

@@ -1,3 +1,3 @@
 module Gull
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/alert_spec.rb

@@ -23,8 +23,8 @@ describe Gull::Alert do
     expect(first.effective_at).to eq Time.parse("2014-10-01T08:40:00-07:00")
     expect(first.expires_at).to eq Time.parse("2014-10-03T21:00:00-07:00")
     expect(first.area).to eq "Southern Salinas Valley, Arroyo Seco and Lake San Antonio"
-    expect(first.urgency).to eq "Expected"
-    expect(first.severity).to eq "Minor"
-    expect(first.certainty).to eq "Likely"
+    expect(first.urgency).to eq :expected
+    expect(first.severity).to eq :minor
+    expect(first.certainty).to eq :very_likely
   end
 end

data/spec/alerts.xml

@@ -46,7 +46,7 @@ xmlns:ha = 'http://www.alerting.net/namespace/index_1.0'
 	<cap:category>Met</cap:category>
 	<cap:urgency>Expected</cap:urgency>
 	<cap:severity>Minor</cap:severity>
-	<cap:certainty>Likely</cap:certainty>
+	<cap:certainty>Very Likely</cap:certainty>
 	<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>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gull
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Seth Deckard