eaternet 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef5964ed9df66f15b67479666a138c217dc4e2e
-  data.tar.gz: 7b5576bb97873aaa7a945fefb8fad5b73f950878
+  metadata.gz: 11257485cfdcbda82f42ae36c646ebfc9616203d
+  data.tar.gz: 9f3bbe15c16db1bc73527cbb25aa69c4421ea630
 SHA512:
-  metadata.gz: 41657aba33ed69e9f91cde7cdf46e6f8a75a777fdfd94beaa56bf1241c414a8a83143619a21140dc45502413a5895dec4a2663e9d660d643aa56b0e975673527
-  data.tar.gz: 35357963b80e1dfe1a01010e6a952dff5ff0cc2ffe06432b499c6217b020d747a639d0c35e9daa064eaaa734929d1775bf829f95c8bc9e75676fd6bc77f48f36
+  metadata.gz: 9bd3634278276974dcecb89c48f1285ff652245dd968d8be8349b7063b853c8acfa6af8c5e7fcea6bb2703c50e4dcd3e2cf993784ff5eff92578f8f327de9e4c
+  data.tar.gz: 2484a3f65c718bd457b6ee56a6c40bb64aa4326950723ee59198c1b05f52f336bde72f3b1035c246638bb606483023c832a81573d5c0bb48e9ae47e4a47cbbf4

data/.yardopts

@@ -1 +1 @@
---markup markdown --name-tag required:"Required"
+--no-private --markup markdown --name-tag required:"Required"

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'minitest-utils', git: 'git@github.com:dogweather/minitest-utils.git'
+gem 'minitest-utils', git: 'https://github.com/dogweather/minitest-utils.git'
 gemspec

data/Guardfile

@@ -5,7 +5,7 @@
 # directories %w(app lib config test spec features)
 
 ## Uncomment to clear the screen before every task
-# clearing :on
+clearing :on
 guard :minitest do
   watch(%r{^test/(.*)_test\.rb$})
   watch(%r{^lib/(.+)\.rb$})         { |m| "test/#{m[1]}_test.rb" }

data/lib/eaternet/agencies/nyc.rb

@@ -13,37 +13,73 @@ require 'eaternet/loggable'
 
 module Eaternet
   module Agencies
-    # A LIVES 1.0 data source for New York City.
+    # A data source for New York City food service health inspections.  It
+    # retrieves the latest info from the official source and makes it easy
+    # to work with.
     #
-    # @example Print all the restaurant names in New York City.
+    # This library conforms to the
+    # [LIVES 1.0 standard](http://www.yelp.com/healthscores) developed by
+    # Yelp and the cities of San Francisco and New York.
+    #
+    # @example Print the names of all the restaurants in New York City
     #   nyc = Eaternet::Nyc.new
-    #   nyc.businesses.each { |biz| puts biz.name }
+    #   puts nyc.businesses.map(&:name)
+    #
+    # @example Compute the average inspection score for NYC.
+    #   # The library is optimized for memory use at the expense
+    #   # of speed. E.g., each call to #inspections will iterate
+    #   # through the raw CSV. So here, we first retrieve the
+    #   # inspections into an array.
+    #   inspections = nyc.inspections.to_a
+    #   sum = inspections
+    #           .map(&:score)
+    #           .reduce(0, :+)
+    #   count = inspections.count
+    #
+    #   puts "Average inspection score: #{sum / count}"
     #
-    # @see https://data.cityofnewyork.us/Health/DOHMH-New-York-City-Restaurant-Inspection-Results/xx67-kt59
+    # @example See the Instance Method Details for more examples.
+    #
+    # @see https://data.cityofnewyork.us/Health/DOHMH-New-York-City-Restaurant-Inspection-Results/xx67-kt59 NYC health scores official data, hosted on Socrata
     class Nyc < Eaternet::Lives_1_0::Adapter
       include Eaternet::Lives_1_0
       include Eaternet::Loggable
 
-      DOMAIN = 'data.cityofnewyork.us'
-      DATASET = 'xx67-kt59'
-      CSV_URL = "https://#{DOMAIN}/api/views/#{DATASET}/rows.csv?accessType=DOWNLOAD"
-
-      # Create an adapter for the NYC data.
+      # Create an NYC data-source, ready for querying.
       #
       # @example
       #   nyc = Eaternet::Nyc.new
       #
-      # @param [String] csv_path only needed for unit testing
+      # @param [String] csv_path for unit testing
       def initialize(csv_path: nil)
         @table_file = csv_path
       end
 
+      # @example Print the number of restaurants in New York.
+      #   puts nyc.businesses.count
+      #
+      # @return [Enumerable<Business>]
       def businesses
         map_csv { |row| try_to_create_business(row) }
           .compact
           .unique
       end
 
+      # @example Compute the average inspection score for NYC.
+      #
+      #   # The library is optimized for memory use at the expense
+      #   # of speed. E.g., each call to #inspections will iterate
+      #   # through the raw CSV. So here, we first retrieve the
+      #   # inspections into an array.
+      #   inspections = nyc.inspections.to_a
+      #   sum = inspections
+      #           .map(&:score)
+      #           .reduce(0, :+)
+      #   count = inspections.count
+      #
+      #   puts "Average inspection score: #{sum / count}"
+      #
+      # @return [Enumerable<Inspection>]
       def inspections
         cache = Set.new
         map_csv do |row|
@@ -62,6 +98,11 @@ module Eaternet
         end.compact
       end
 
+      # @example Print the name & URL of NYC's health agency.
+      #   puts nyc.feed_info.municipality_name
+      #   puts nyc.feed_info.municipality_url
+      #
+      # @return [FeedInfo]
       def feed_info
         FeedInfo.new do |fi|
           fi.feed_date = Date.today
@@ -94,7 +135,7 @@ module Eaternet
       end
 
 
-      # private
+      private
 
       def try_to_create_business(row)
         business(row)
@@ -114,6 +155,9 @@ module Eaternet
         nil
       end
 
+      public  # To enable testing
+
+      # @private
       def business(row)
         address = "#{row['BUILDING']} #{row['STREET']}"
 
@@ -128,6 +172,8 @@ module Eaternet
         end
       end
 
+      private
+
       def violation(row)
         Violation.new do |v|
           v.business_id = business_id(row)
@@ -157,10 +203,6 @@ module Eaternet
         row['CAMIS']
       end
 
-      def inspection_id(row)
-        [row['CAMIS'], row['INSPECTION DATE']].join('-')
-      end
-
       def violation_kind_id(row)
         row['VIOLATION CODE']
       end
@@ -173,6 +215,10 @@ module Eaternet
         inspection_id(row)
       end
 
+      def inspection_id(row)
+        [row['CAMIS'], row['INSPECTION DATE']].join('-')
+      end
+
       def transfat_inspection?(row)
         if row['INSPECTION TYPE']
           row['INSPECTION TYPE'].include?('Trans Fat')
@@ -204,8 +250,15 @@ module Eaternet
       end
 
       # Fastest method for downloading all data but may be non-standard
+      # for Socrata.
       def self.download_via_url(a_file)
-        a_file.write(open(CSV_URL).read)
+        a_file.write(open(csv_url).read)
+      end
+
+      def csv_url
+        domain = 'data.cityofnewyork.us'
+        dataset = 'xx67-kt59'
+        "https://#{domain}/api/views/#{dataset}/rows.csv?accessType=DOWNLOAD"
       end
     end
   end

data/lib/eaternet/lives_1_0/adapter.rb

@@ -4,12 +4,25 @@ module Eaternet
     #   and optionally {#violations}, {#feed_info}, and {#legends} to
     #   implement a custom Lives 1.0 data source adapter.
     class Adapter
+      # @example Print the number of restaurants in SomeCity.
+      #   some_city = Eaternet::SomeCity.new
+      #   puts some_city.businesses.count
+      #
       # @required Yes
       # @return [Enumerable<Business>]
       def businesses
         fail 'Override this to return an Enumerable of Business'
       end
 
+      # @example Compute the average inspection score for SomeCity.
+      #   some_city = Eaternet::SomeCity.new
+      #   sum = some_city.inspections
+      #           .map(&:score)
+      #           .reduce(0, :+)
+      #   count = some_city.inspections.count
+      #
+      #   puts "Average inspection score: " + sum / count
+      #
       # @required Yes
       # @return [Enumerable<Inspection>]
       def inspections
@@ -22,6 +35,12 @@ module Eaternet
         fail 'Optionally override this to return an Enumerable of Violation'
       end
 
+      # @example Retrieve the name & URL of SomeCity's health agency.
+      #   some_city = Eaternet::SomeCity.new
+      #   info = some_city.feed_info
+      #   puts info.municipality_name
+      #   puts info.municipality_url
+      #
       # @required No
       # @return [FeedInfo]
       def feed_info

data/lib/eaternet/version.rb

@@ -1,3 +1,3 @@
 module Eaternet
-  VERSION = '0.3.10'
+  VERSION = '0.3.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eaternet
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -186,14 +186,14 @@ files:
 - lib/eaternet/validated_object.rb
 - lib/eaternet/version.rb
 - lib/ext/lazy.rb
+- test/eaternet/agencies/nyc_test.rb
+- test/eaternet/agencies/snhd_test.rb
 - test/eaternet/eaternet_test.rb
 - test/eaternet/lives_1_0/business_test.rb
 - test/eaternet/lives_1_0/feed_info_test.rb
 - test/eaternet/lives_1_0/inspection_test.rb
 - test/eaternet/lives_1_0/legend_test.rb
 - test/eaternet/loggable_test.rb
-- test/eaternet/nyc_adapter_test.rb
-- test/eaternet/snhd_adapter_test.rb
 - test/fixtures/morris-park-bake-shop.csv
 - test/script.rb
 - test/test_helper.rb
@@ -222,14 +222,14 @@ signing_key:
 specification_version: 4
 summary: Regional adapters for restaurant health scores
 test_files:
+- test/eaternet/agencies/nyc_test.rb
+- test/eaternet/agencies/snhd_test.rb
 - test/eaternet/eaternet_test.rb
 - test/eaternet/lives_1_0/business_test.rb
 - test/eaternet/lives_1_0/feed_info_test.rb
 - test/eaternet/lives_1_0/inspection_test.rb
 - test/eaternet/lives_1_0/legend_test.rb
 - test/eaternet/loggable_test.rb
-- test/eaternet/nyc_adapter_test.rb
-- test/eaternet/snhd_adapter_test.rb
 - test/fixtures/morris-park-bake-shop.csv
 - test/script.rb
 - test/test_helper.rb