sandy 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,40 @@
 # Sandy
 
-TODO: Write a gem description
+## Usage
+
+### ConEd
+    report = Sandy::Provider::ConEd::Report.new
+
+#### Regions
+    regions = report.regions
+    regions.each do |region|
+      puts "#{region.name}, #{region.customers_affected}"
+    end
+
+Outputs:
+    Bronx, 28644
+    Brooklyn, 37016
+    Manhattan, 226225
+    Queens, 85057
+    Staten Island, 58043
+    Westchester, 123571
+
+Also available are `region.latitude`, `region.longitude`, and `region.total_customers` (see neighborhoods section)
+
+#### Neighborhoods
+
+    neighborhoods = report.neighborhoods
+    neighborhoods.each do |neighborhood|
+      puts "#{neighborhood.name} (#{neighborhood.latitude}, #{neighborhood.longitude}) #{neighborhood.customers_affected} out of #{neighborhood.total_customers}"
+    end
+
+Outputs:
+    Central Bronx (40.82, -73.86) 26 out of 44452
+    Fordham (40.86, -73.9) 164 out of 114772
+    Northeast Bronx (40.87, -73.82) 13139 out of 79942
+    Riverdale (40.89, -73.9) 3801 out of 34772
+    Southeast Bronx (40.83, -73.82) 5919 out of 89736
+    ...
 
 ## Installation
 

data/lib/sandy/area.rb

@@ -1,6 +1,6 @@
 module Sandy
   class Area
-    attr_reader :name, :region, :customers_affected, :latitude, :longitude
+    attr_reader :name, :region, :customers_affected, :latitude, :longitude, :total_customers
 
     def initialize(customers_affected, location, options = {})
       @name = location

data/lib/sandy/version.rb

@@ -1,3 +1,3 @@
 module Sandy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/sandy.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Sandy::VERSION
   gem.authors       = ["Cameron Cundiff"]
   gem.email         = ["ckundo@gmail.com"]
-  gem.description   = %q{Present a simple API to consume power outage data for the Greater New York area.}
+  gem.description   = %q{Presents a simple API to consume power outage data for the Greater New York area.}
   gem.summary       = %q{Power outage data for ConEd in NYC}
   gem.homepage      = "http://www.github.com/ckundo/sandy"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -91,7 +91,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.0
-description: Present a simple API to consume power outage data for the Greater New
+description: Presents a simple API to consume power outage data for the Greater New
   York area.
 email:
 - ckundo@gmail.com