gull 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e86081d360eca93b4a9d0dbe5185bc6a248a6a1
-  data.tar.gz: 336895cd8f897425e987779c2168c5ed1a065f4f
+  metadata.gz: abbfea59f3e20194da7602da330d7d17304add4b
+  data.tar.gz: 4469f2c218b7483b039b8404bf90a03a47a99e9e
 SHA512:
-  metadata.gz: 8da6e8b46feb22d5b611d4e17387830fbcab34bb8195e4101d3162cbee41c23b5bf800ab662eaf24745928bee7a43164935c055d7bd82dc198868607e833ae23
-  data.tar.gz: 3a985d7754a0d7229fec1cac7ba50ac71315a8c48a76eebfeb468543ba37ec2c835eddc8947634bd066f3b177d30a98b4c7aa8b389f34f1e476e02ba6e4ede4d
+  metadata.gz: 1157f36b6ba261f2f91077b6e016b65eb3b782038af7da83e7af7464b1612d846b860fab672e2328bb816cf8b59aff02b8671363771a547954568c1137e0d89c
+  data.tar.gz: 5cbfa92c6fbd6de9806f73f5791097506969ee72f5eff576def3dfd58a361a1985a65d383800f7e08025f6a76df15e739481d80c3ed5c42d2035823e56b7a527

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+***
+### 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.0 (10/02/2014) - Introduced Polygon type.
+***
+#### 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.

data/README.md

@@ -12,7 +12,9 @@ Ruby client for parsing NOAA/NWS alerts, warnings, and watches. The name comes f
 
 Add this line to your application's Gemfile:
 
-    gem 'gull'
+```ruby
+gem 'gull'
+```
 
 And then execute:
 
@@ -24,39 +26,55 @@ Or install it yourself as:
 
 ## Usage
 
-	require 'gull'
-
-	alerts = Gull::Alert.fetch
-	alert = alert.first
-
-	#access details of alert
-	alert.id
-    alert.alert_type
-    alert.title
-    alert.summary
-    alert.effective_at
-    alert.expires_at
-    alert.area
-	alert.geocode.fips6
-	alert.geocode.ugc
-	alert.urgency
-	alert.severity
-	alert.certainty
-	#etc...
-	
-	#You can also generate a map of the polygon if alert has one (requires Google Static Maps API Key)
-	alert.polygon.image_url "your_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_api_key"
-	
-	#options can be passed for map to override defaults
-	options = { :width => 600, :height => 300, :color => "0xfbf000", :weight => 4, :fillcolor => "0xfbf00070", :maptype => "hybrid" } 
-	alert.polygon.image_url "your_api_key", options 
-	
-	#get the centroid of the polygon (to display a map pin, etc.)
-	alert.polygon.centroid
-	
-	=> [34.835, -91.205]
+```ruby
+require 'gull'
+
+alerts = Gull::Alert.fetch
+alert = alerts.first
+
+alert.id
+alert.alert_type
+alert.title
+alert.summary
+alert.effective_at
+alert.expires_at
+alert.published_at
+alert.area
+alert.polygon
+alert.geocode.fips6
+alert.geocode.ugc
+alert.urgency
+alert.severity
+alert.certainty
+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'
+
+=> "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
 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.

data/lib/gull/alert.rb

@@ -67,11 +67,10 @@ module Gull
     end
 
     def parse_times(element)
-      self.updated_at = Time.parse(element.css('updated').inner_text).utc
-      self.published_at = Time.parse(element.css('published').inner_text).utc
+      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)
-        .utc
-      self.expires_at = Time.parse(element.xpath('cap:expires').inner_text).utc
+      self.expires_at = Time.parse(element.xpath('cap:expires').inner_text)
     end
 
     def parse_categories(element)

data/lib/gull/polygon.rb

@@ -47,6 +47,10 @@ module Gull
       "|#{coordinates_piped}&key=#{api_key}"
     end
 
+    def to_s
+      coordinates.map { |pair| pair.join(',') }.join(' ')
+    end
+
     private
 
     def bounds(point, low, high)

data/lib/gull/version.rb

@@ -1,3 +1,3 @@
 module Gull
-  VERSION = '0.2.10'
+  VERSION = '0.2.11'
 end

data/spec/polygon_spec.rb

@@ -40,4 +40,12 @@ describe Gull::Polygon do
       '&key=testkey'
     expect(url).to eq expected_url
   end
+
+  it 'should return original string representation' do
+    text = '34.57,-97.56 34.77,-97.38 34.75,-97.17 ' \
+      '34.64,-97.11 34.64,-97.14 34.62,-97.14 34.62,-97.2 34.6,-97.19 34.59,' \
+      '-97.17 34.57,-97.17 34.5,-97.3 34.51,-97.56 34.57,-97.56'
+    polygon = Gull::Polygon.new text
+    expect(polygon.to_s).to eq text
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gull
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Seth Deckard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -106,6 +106,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Client for parsing NOAA/NWS alerts, warnings, and watches.