eaternet 0.3.13 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fef9d7a3fae0dfa7a51a9dbf736c5da15bfa268
-  data.tar.gz: f62290193115c8e762a8d7dbbbd2fe1f5de869a0
+  metadata.gz: 909fb5a4626a18c37b4d3694bd0fdf1a8f8b69a7
+  data.tar.gz: b6a05cf7dc6d76a5f10b4dc2e949c03d277da7da
 SHA512:
-  metadata.gz: b5f431d8091b289152792306ccf263aa2e25189e2f464a7af4ee676488f4b084f28f2e1285e5e995638d7c07e8e860e81eb93e3caf5f1a086bcfcb67b81986e3
-  data.tar.gz: 1004ff11639225f50e13965f6e359f6c79db8f0861afaf7486dc3eff06e4c014ead6ae389154dcca9eec1bd4f3fd6ee97ad6788e6ec5370947b940cf18433dc1
+  metadata.gz: e45b4ee75bf988fb28461b3cc19267ada7963e43967b80bb87537055b6f96a119829eafab6029bff68ede7830f433f129065a43a8a26827f51a09a4c9b81204c
+  data.tar.gz: 2cb9c2a9f6e221c52c8a8905e501aefd3b7f0a28cc4ff2e3d0a477726644eba9779c383aefefe94b988686265125b4ce70585b7f15136858835dbc9e397c4bec

data/lib/eaternet/agencies/nyc.rb

@@ -16,13 +16,14 @@ module Eaternet
     # retrieves the latest CSV export from
     # [the official source](https://data.cityofnewyork.us/Health/DOHMH-New-York-City-Restaurant-Inspection-Results/xx67-kt59)
     # and makes it easy to work with. The downloaded CSV is cached for twelve
-    # hours in a temporary file by {Eaternet::Util.download_and_cache}
+    # hours in a temporary file.
     #
     # 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
+    #   require 'eaternet'
     #   nyc = Eaternet::Nyc.new
     #   puts nyc.businesses.map(&:name)
     #

data/lib/eaternet/agencies/snhd.rb

@@ -7,6 +7,8 @@ module Eaternet
   module Agencies
     # An adapter for the Southern Nevada Health District (Las Vegas).
     #
+    # @note This is a work in progress.
+    #
     # @example Print the names of all the Las Vegas businesses
     #   require 'eaternet'
     #

data/lib/eaternet/agencies/snhd_config.rb

@@ -1,5 +1,6 @@
 module Eaternet
   module Agencies
+    # @private
     class SnhdConfig
       DOWNLOAD_URL = 'http://southernnevadahealthdistrict.org/restaurants/download/restaurants.zip'
       COLUMN_SEPARATOR = ';'

data/lib/eaternet/prototype.rb

@@ -1,8 +1,9 @@
 module Eaternet
   # A first pass at a health scores mini-framework which
-  # is denormalized and provides some more information than
+  # is normalized and provides some more information than
   # LIVES.
-  #:nodoc:
+  #
+  # @private
   module Prototype
     module AbstractAdapter
       # @return [Enumerable<BusinessData>]

data/lib/eaternet/util.rb

@@ -17,13 +17,15 @@ module Eaternet
 
     # Create a temporary directory which is automatically
     # deleted when the program exits.
+    #
+    # @return [String] the directory path
     def self.make_temp_dir
       dir = Dir.mktmpdir
       at_exit { FileUtils.remove_entry dir }
       dir
     end
 
-    # Download a file from the network, caching it for 12 hours.
+    # Download a file from the network, using a 12-hour cache.
     #
     # @param [String] source the URL to retrieve
     # @param [String] dest pathname in which to save the file
@@ -60,24 +62,28 @@ module Eaternet
 
     # Remove extraneous whitespace and ensure capitalization
     # is correct for a proper name or title.
+    #
+    # @return [String] the cleaned up string
     def self.cleanup_title(a_string)
       return nil if a_string.nil?
       cleanup(a_string).titleize
     end
 
     # Remove extraneous whitespace from the string
+    #
+    # @return [String] the cleaned up string
     def self.cleanup(a_string)
       return nil if a_string.nil?
       a_string.strip.gsub(/ +/, ' ')
     end
 
+    # @return [Float]
     def self.file_age_in_days(path)
       (Time.now - File.mtime(path)).to_i / 86_400.0
     end
 
-    #
-    # private
-    #
+
+    private
 
     def self.expired?(cache_path)
       !File.exist?(cache_path) || file_age_in_days(cache_path) > 0.5

data/lib/eaternet/version.rb

@@ -1,3 +1,3 @@
 module Eaternet
-  VERSION = '0.3.13'
+  VERSION = '0.3.14'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eaternet
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.14
 platform: ruby
 authors:
 - Robb Shecter