eaternet 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af8af2d45bbf5b308fb47e75f501a35bf436447f
-  data.tar.gz: 0db0339d37d25f2436b7beeb5b13b07ffc35ee83
+  metadata.gz: 202273f23326e002f8e4a03d631b324d71025969
+  data.tar.gz: d817710bb5054fe8af26a6550e0e41454e4b0aa7
 SHA512:
-  metadata.gz: 88ca6e813d927bcd80cc14b311e6082c378efff9ce359ae28e2af25e0cc57264249704d99c7f31a4ab239967ae6f12fba293acaeb581f4be29ad52bf45d38603
-  data.tar.gz: 3a95dca9298441e8c3779ac08e27c8b8ecbffc9c9770c939494285ce9a9bd1559f3cce2fc67e4c0627222b4f28f3544087db0c2c2a8b1c441b36591942d03772
+  metadata.gz: feac8796ac69bc065bc16385d1a46469aa99d158bd3adbaae8303627af3653278618ac368ae403cc903355c997fa1d7e6721d93f4e594aebfe1efd2e63e40987
+  data.tar.gz: 6792b804fa1c37a490fd5ac8b93e88cf6357efec2b481d631d5a6a24440a015ee8269b5dcb95ebc38dfa6ebf675264d12d40a29850890aba8fdb9aed32bf7e64

data/Guardfile

@@ -6,31 +6,8 @@
 
 ## Uncomment to clear the screen before every task
 # clearing :on
-
-## Guard internally checks for changes in the Guardfile and exits.
-## If you want Guard to automatically start up again, run guard in a
-## shell loop, e.g.:
-##
-##  $ while bundle exec guard; do echo "Restarting Guard..."; done
-##
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
 guard :minitest do
-  # with Minitest::Unit
-  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
-
-  # with Minitest::Spec
-  # watch(%r{^spec/(.*)_spec\.rb$})
-  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
-  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+  watch(%r{^test/(.*)_test\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
 end

data/eaternet.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'minitest'
-  # spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'minitest-utils'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'vcr'

data/lib/eaternet/agencies/nyc.rb

@@ -15,17 +15,11 @@ module Eaternet
   module Agencies
     # A LIVES 1.0 data source for New York City.
     #
-    # Example: print all the restaurant names in New York City.
-    #
-    #   ```ruby
-    #   require 'eaternet'
-    #
+    # @example Print all the restaurant names in New York City.
     #   nyc = Eaternet::Nyc.new
     #   nyc.businesses.each { |biz| puts biz.name }
-    #   ```
     #
     # @see https://data.cityofnewyork.us/Health/DOHMH-New-York-City-Restaurant-Inspection-Results/xx67-kt59
-    # @todo This is a somewhat long namespace. Can this be improved?
     class Nyc < Eaternet::Lives_1_0::Adapter
       include Eaternet::Lives_1_0
       include Eaternet::Loggable
@@ -34,17 +28,20 @@ module Eaternet
       DATASET = 'xx67-kt59'
       CSV_URL = "https://#{DOMAIN}/api/views/#{DATASET}/rows.csv?accessType=DOWNLOAD"
 
-      # Create an NYC Adapter.
+      # Create an adapter for the NYC data.
       #
-      # @param csv_path for unit testing
+      # @example
+      #   nyc = Eaternet::Nyc.new
+      #
+      # @param [String] csv_path only needed for unit testing
       def initialize(csv_path: nil)
         @table_file = csv_path
       end
 
       def businesses
         map_csv { |row| try_to_create_business(row) }
-        .compact
-        .unique
+          .compact
+          .unique
       end
 
       def inspections
@@ -93,7 +90,7 @@ module Eaternet
               l.description =   'C'
             end
           ]
-        end
+        end.legends
       end
 
 
@@ -180,7 +177,7 @@ module Eaternet
       end
 
       def map_csv(&block)
-        CSV.new(open(table_file, encoding: 'utf-8'), headers: true)
+        CSV.new(File.open(table_file, encoding: 'utf-8'), headers: true)
           .lazy
           .map { |row| block.call(row) }
       end
@@ -192,12 +189,12 @@ module Eaternet
       def table_file
         if @table_file.nil?
           @table_file = Tempfile.new('all.csv.')
-          Nyc.download(@table_file)
+          Nyc.download_to(@table_file)
         end
         @table_file
       end
 
-      def self.download(a_file)
+      def self.download_to(a_file)
         download_via_url(a_file)
       end
 

data/lib/eaternet/lives_1_0.rb

@@ -1,6 +1,12 @@
-# coding: utf-8
-module Eaternet
+require 'eaternet/lives_1_0/adapter'
+require 'eaternet/lives_1_0/business'
+require 'eaternet/lives_1_0/feed_info'
+require 'eaternet/lives_1_0/inspection'
+require 'eaternet/lives_1_0/legend'
+require 'eaternet/lives_1_0/legend_group'
+require 'eaternet/lives_1_0/violation'
 
+module Eaternet
   # Framework for creating LIVES 1.0 apps.
   #
   # The goal is to make it as easy as possible to create
@@ -12,322 +18,5 @@ module Eaternet
   # @see http://www.yelp.com/healthscores Local Inspector Value-Entry
   #   Specification (LIVES)
   module Lives_1_0
-    require 'active_model'
-
-    # @abstract Subclass and override {#businesses}, {#inspections},
-    #   and optionally {#violations} and {#feed_info} to implement
-    #   a custom Lives 1.0 data source adapter.
-    class Adapter
-      # Required.
-      # @return [Enumerable<Business>]
-      def businesses
-        fail 'Override this to return an Enumerable of Business'
-      end
-
-      # Required.
-      # @return [Enumerable<Inspection>]
-      def inspections
-        fail 'Override this to return an Enumerable of Inspection'
-      end
-
-      # Optional.
-      # @return [Enumerable<Violation>]
-      def violations
-        fail 'Optionally override this to return an Enumerable of Violation'
-      end
-
-      # Optional.
-      # @return [FeedInfo]
-      def feed_info
-        fail 'Optionally override this to return a FeedInfo'
-      end
-    end
-
-
-    # Uses {ActiveModel::Validations} to create self-validating
-    # Plain Old Ruby objects.
-    #
-    # @abstract Subclass and add `attr_accessor` and validations
-    #   to create custom validating objects.
-    #
-    # @see http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/
-    # @see http://www.rubyinside.com/rails-3-0s-activemodel-how-to-give-ruby-classes-some-activerecord-magic-2937.html
-    class ValidatedObject
-      include ActiveModel::Validations
-
-      # @raise [ArgumentError] if the object is not valid at the
-      #   end of initialization.
-      #
-      # @yieldparam [ValidatedObject] new_object the yielded new object
-      #   for configuration.
-      #
-      def initialize(&block)
-        block.call(self)
-        check_validations!
-      end
-
-
-      private
-
-      def check_validations!
-        fail ArgumentError, errors.messages.inspect if invalid?
-      end
-
-      class TypeValidator < ActiveModel::EachValidator
-        def validate_each(record, attribute, value)
-          record.errors.add attribute, (options[:message] || "is not of class #{options[:with]}") unless
-            value.class == options[:with]
-        end
-      end
-    end
-
-
-    # A food service establishment, e.g. a restaurant.
-    #
-    # @!attribute [rw] business_id
-    #   Unique identifier for the business. For many cities,
-    #   this may be the license number. Required.
-    #   @return [String]
-    #
-    # @!attribute [rw] name
-    #   Common name of the business. Required.
-    #   @return [String]
-    #
-    # @!attribute [rw] address
-    #   Street address of the business. For example: 706 Mission St.
-    #   Required.
-    #   @return [String]
-    #
-    # @!attribute [rw] city
-    #   City of the business. This field must be included if the
-    #   file contains businesses from multiple cities.
-    #   @return [String]
-    #
-    # @!attribute [rw] state
-    #   State or province for the business. In the U.S. this should
-    #   be the two-letter code for the state. Optional.
-    #   @return [String]
-    #
-    # @!attribute [rw] postal_code
-    #   Zip code or other postal code. Optional.
-    #   @return [String]
-    #
-    # @!attribute [rw] latitude
-    #   Latitude of the business. This field must be a valid WGS 84
-    #   latitude. For example: 37.7859547. Optional.
-    #   @return [Float]
-    #
-    # @!attribute [rw] longitude
-    #   Longitude of the business. This field must be a valid WGS 84
-    #   longitude. For example: -122.4024658. Optional.
-    #   @return [Float]
-    #
-    # @!attribute [rw] phone_number
-    #   Phone number for a business including country specific dialing
-    #   information. For example: +14159083801
-    #   @return [String]
-    #
-    # @see http://www.yelp.com/healthscores#businesses LIVES/Business
-    class Business < ValidatedObject
-      attr_accessor :business_id, :name, :address, :city, :state,
-                    :postal_code, :latitude, :longitude, :phone_number
-
-      validates :business_id, :name, :address,
-                type: String,
-                presence: true
-      validates :city, :state, :postal_code, :phone_number,
-                type: String,
-                allow_nil: true
-      validates :latitude,
-                numericality:
-                  {
-                    greater_than_or_equal_to: -90,
-                    less_than_or_equal_to: 90
-                  },
-                allow_nil: true
-      validates :longitude,
-                numericality:
-                  {
-                    greater_than_or_equal_to: -180,
-                    less_than_or_equal_to: 180
-                  },
-                allow_nil: true
-
-      def ==(other)
-        self.business_id == other.business_id
-      end
-
-      def eql?(other)
-        self == other
-      end
-
-      def hash
-        self.business_id.hash
-      end
-
-      # @return [String]
-      def to_s
-        "Business #{self.business_id}"
-      end
-    end
-
-
-    # Information about an inspectors’ visit to a businesses.
-    #
-    # @!attribute [rw] business_id
-    #   Unique identifier of the business for which this inspection
-    #   was done. Required.
-    #   @return [String]
-    #
-    # @!attribute [rw] score
-    #   Inspection score on a 0-100 scale. 100 is the highest score.
-    #   This column must always be present in inspections.csv. However, it
-    #   can be safely left blank for inspection rows that don’t have an
-    #   associated score. (For example, some municipalities don’t associate
-    #   a follow-up inspection with a score.)
-    #   @return [Integer] if it's a scored inspection
-    #   @return [String] if it's an un-scored inspection, then the return value
-    #     will be an empty string.
-    #
-    # @!attribute [rw] date
-    #   Date of the inspection.
-    #   @return [Date]
-    #
-    # @!attribute [rw] description
-    #   Single line description containing details on the outcome of an
-    #   inspection. Use of this field is only encouraged if no violations
-    #   are provided.
-    #   @return [String]
-    #
-    # @!attribute [rw] type
-    #   String representing the type of inspection. Must be (initial,
-    #   routine, followup, complaint).
-    #   @return [String]
-    #
-    # @see http://www.yelp.com/healthscores#inspections LIVES / Inspections
-    class Inspection < ValidatedObject
-      attr_accessor :business_id, :score, :date, :description, :type
-
-      ZERO_TO_ONE_HUNDRED_AND_BLANK = (0..100).to_a + ['']
-
-      validates :business_id,
-                type: String,
-                presence: true
-      validates :score,
-                inclusion: { in: ZERO_TO_ONE_HUNDRED_AND_BLANK },
-                allow_nil: true
-      validates :date,
-                type: Date,
-                presence: true
-      validates :type,
-                inclusion: { in: %w(initial routine followup complaint) },
-                allow_nil: true
-
-      def score
-        # noinspection RubyResolve
-        @score.nil? ? '' : @score
-      end
-
-      # @return [String]
-      def to_s
-        "Inspection #{self.business_id}/#{self.date}/#{self.score}"
-      end
-    end
-
-
-    # @see http://www.yelp.com/healthscores#violations LIVES / Violations
-    class Violation < ValidatedObject
-      attr_accessor :business_id, :date, :code, :description
-
-      validates :business_id,
-                type: String,
-                presence: true
-      validates :date,
-                type: Date,
-                presence: true
-      validates :code, :description,
-                type: String,
-                allow_nil: true
-    end
-
-
-    # @see http://www.yelp.com/healthscores#feed_info LIVES / Feed Information
-    class FeedInfo < ValidatedObject
-      attr_accessor :feed_date, :feed_version, :municipality_name,
-                    :municipality_url, :contact_email
-
-      # See http://railscasts.com/episodes/211-validations-in-rails-3
-      EMAIL_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
-      URL_REGEX = %r{\Ahttps?:/}
-
-      validates :feed_date,
-                type: Date,
-                presence: true
-      validates :feed_version,
-                type: String,
-                presence: true
-      validates :municipality_name,
-                type: String,
-                presence: true
-      validates :municipality_url,
-                type: String,
-                format: { with: URL_REGEX },
-                allow_nil: true
-      validates :contact_email,
-                type: String,
-                format: { with: EMAIL_REGEX },
-                allow_nil: true
-    end
-
-
-    # @see http://www.yelp.com/healthscores#legend LIVES / Legend
-    class Legend < ValidatedObject
-      attr_accessor :minimum_score, :maximum_score, :description
-
-      validates :minimum_score, :maximum_score,
-                inclusion: { in: (0..100) }
-      validates :description,
-                presence: true,
-                type: String
-    end
-
-
-    # A container for all the Legends in the data set. Performs
-    # validation on the whole set of Legends ensure they cover
-    # the entire range of scores and do not overlap.
-    class LegendGroup < ValidatedObject
-      attr_accessor :legends
-
-      # Check that all the items in this LegendGroup:
-      #
-      #   1. Are of the class, Legend
-      #   2. Cover the range of scores from 0-100 without overlap
-      class ComprehensiveValidator < ActiveModel::EachValidator
-        def validate_each(record, attribute, legends)
-          scores = (0..100).to_a
-          legends.each do |legend|
-            unless legend.class == Legend
-              record.errors.add attribute, 'must be a Legend'
-              return
-            end
-            range = (legend.minimum_score..legend.maximum_score)
-            range.each do |score|
-              if scores.delete(score).nil?
-                unless score == legend.minimum_score || score == legend.maximum_score
-                  record.errors.add attribute, 'may not overlap'
-                  return
-                end
-              end
-            end
-          end
-          unless scores.empty?
-            record.errors.add attribute, 'do not cover entire span from 0–100'
-          end
-        end
-      end
-
-      validates :legends, comprehensive: true
-    end
-
   end
 end

data/lib/eaternet/lives_1_0/adapter.rb

@@ -0,0 +1,38 @@
+module Eaternet
+  module Lives_1_0
+    # @abstract Subclass and override {#businesses}, {#inspections},
+    #   and optionally {#violations}, {#feed_info}, and {#legends} to
+    #   implement a custom Lives 1.0 data source adapter.
+    class Adapter
+      # Required.
+      # @return [Enumerable<Business>]
+      def businesses
+        fail 'Override this to return an Enumerable of Business'
+      end
+
+      # Required.
+      # @return [Enumerable<Inspection>]
+      def inspections
+        fail 'Override this to return an Enumerable of Inspection'
+      end
+
+      # Optional.
+      # @return [Enumerable<Violation>]
+      def violations
+        fail 'Optionally override this to return an Enumerable of Violation'
+      end
+
+      # Optional.
+      # @return [FeedInfo]
+      def feed_info
+        fail 'Optionally override this to return a FeedInfo'
+      end
+
+      # Optional.
+      # @return [Enumerable<Legend>]
+      def legends
+        fails 'Optionally override this to return an Enumerable of Legend'
+      end
+    end
+  end
+end

data/lib/eaternet/lives_1_0/business.rb

@@ -0,0 +1,95 @@
+require 'eaternet/lives_1_0/adapter'
+require 'eaternet/validated_object'
+
+module Eaternet
+  module Lives_1_0
+    # A food service establishment, e.g. a restaurant.
+    #
+    # @!attribute [rw] business_id
+    #   Unique identifier for the business. For many cities,
+    #   this may be the license number. Required.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   Common name of the business. Required.
+    #   @return [String]
+    #
+    # @!attribute [rw] address
+    #   Street address of the business. For example: 706 Mission St.
+    #   Required.
+    #   @return [String]
+    #
+    # @!attribute [rw] city
+    #   City of the business. This field must be included if the
+    #   file contains businesses from multiple cities.
+    #   @return [String]
+    #
+    # @!attribute [rw] state
+    #   State or province for the business. In the U.S. this should
+    #   be the two-letter code for the state. Optional.
+    #   @return [String]
+    #
+    # @!attribute [rw] postal_code
+    #   Zip code or other postal code. Optional.
+    #   @return [String]
+    #
+    # @!attribute [rw] latitude
+    #   Latitude of the business. This field must be a valid WGS 84
+    #   latitude. For example: 37.7859547. Optional.
+    #   @return [Float]
+    #
+    # @!attribute [rw] longitude
+    #   Longitude of the business. This field must be a valid WGS 84
+    #   longitude. For example: -122.4024658. Optional.
+    #   @return [Float]
+    #
+    # @!attribute [rw] phone_number
+    #   Phone number for a business including country specific dialing
+    #   information. For example: +14159083801
+    #   @return [String]
+    #
+    # @see http://www.yelp.com/healthscores#businesses LIVES/Business
+    class Business < ValidatedObject
+      attr_accessor :business_id, :name, :address, :city, :state,
+                    :postal_code, :latitude, :longitude, :phone_number
+
+      validates :business_id, :name, :address,
+                type: String,
+                presence: true
+      validates :city, :state, :postal_code, :phone_number,
+                type: String,
+                allow_nil: true
+      validates :latitude,
+                numericality:
+                  {
+                    greater_than_or_equal_to: -90,
+                    less_than_or_equal_to: 90
+                  },
+                allow_nil: true
+      validates :longitude,
+                numericality:
+                  {
+                    greater_than_or_equal_to: -180,
+                    less_than_or_equal_to: 180
+                  },
+                allow_nil: true
+
+      def ==(other)
+        business_id == other.business_id
+      end
+
+      def eql?(other)
+        self == other
+      end
+
+      def hash
+        business_id.hash
+      end
+
+      # @return [String]
+      def to_s
+        "Business #{business_id}"
+      end
+    end
+  end
+end

data/lib/eaternet/lives_1_0/feed_info.rb

@@ -0,0 +1,33 @@
+require 'eaternet/validated_object'
+
+module Eaternet
+  module Lives_1_0
+    # @see http://www.yelp.com/healthscores#feed_info LIVES / Feed Information
+    class FeedInfo < ValidatedObject
+      attr_accessor :feed_date, :feed_version, :municipality_name,
+                    :municipality_url, :contact_email
+
+      # See http://railscasts.com/episodes/211-validations-in-rails-3
+      EMAIL_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+      URL_REGEX = %r{\Ahttps?:/}
+
+      validates :feed_date,
+                type: Date,
+                presence: true
+      validates :feed_version,
+                type: String,
+                presence: true
+      validates :municipality_name,
+                type: String,
+                presence: true
+      validates :municipality_url,
+                type: String,
+                format: { with: URL_REGEX },
+                allow_nil: true
+      validates :contact_email,
+                type: String,
+                format: { with: EMAIL_REGEX },
+                allow_nil: true
+    end
+  end
+end

data/lib/eaternet/lives_1_0/inspection.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+require 'eaternet/validated_object'
+
+module Eaternet
+  module Lives_1_0
+    # Information about an inspectors’ visit to a businesses.
+    # @see http://www.yelp.com/healthscores#inspections LIVES / Inspections
+    class Inspection < ValidatedObject
+      ZERO_TO_ONE_HUNDRED_AND_BLANK = (0..100).to_a + ['']
+
+      # @!attribute [rw] business_id
+      #   Unique identifier of the business for which this inspection
+      #   was done. Required.
+      #   @return [String]
+      attr_accessor :business_id
+      validates :business_id,
+                type: String,
+                presence: true
+
+      # @!attribute [rw] score
+      #   Inspection score on a 0-100 scale. 100 is the highest score.
+      #   This column must always be present in inspections.csv. However, it
+      #   can be safely left blank for inspection rows that don’t have an
+      #   associated score. (For example, some municipalities don’t associate
+      #   a follow-up inspection with a score.)
+      #   @return [Integer] if it's a scored inspection
+      #   @return [String] if it's an un-scored inspection, then the return value
+      #     will be an empty string.
+      attr_accessor :score
+      validates :score,
+                inclusion: { in: ZERO_TO_ONE_HUNDRED_AND_BLANK },
+                allow_nil: true
+      def score
+        # noinspection RubyResolve
+        @score.nil? ? '' : @score
+      end
+
+      # @!attribute [rw] date
+      #   Date of the inspection.
+      #   @return [Date]
+      attr_accessor :date
+      validates :date,
+                type: Date,
+                presence: true
+
+      # @!attribute [rw] description
+      #   Single line description containing details on the outcome of an
+      #   inspection. Use of this field is only encouraged if no violations
+      #   are provided.
+      #   @return [String]
+      attr_accessor :description
+
+      validates :type,
+                inclusion: { in: %w(initial routine followup complaint) },
+                allow_nil: true
+
+      # @!attribute [rw] type
+      #   String representing the type of inspection. Must be (initial,
+      #   routine, followup, complaint).
+      #   @return [String]
+      attr_accessor :type
+
+      # @return [String]
+      def to_s
+        "Inspection #{business_id}/#{date}/#{score}"
+      end
+    end
+  end
+end

data/lib/eaternet/lives_1_0/legend.rb

@@ -0,0 +1,15 @@
+require 'eaternet/validated_object'
+
+module Eaternet
+  module Lives_1_0
+    class Legend < ValidatedObject
+      attr_accessor :minimum_score, :maximum_score, :description
+
+      validates :minimum_score, :maximum_score,
+                inclusion: { in: (0..100) }
+      validates :description,
+                presence: true,
+                type: String
+    end
+  end
+end

data/lib/eaternet/lives_1_0/legend_group.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+require 'eaternet/validated_object'
+
+module Eaternet
+  module Lives_1_0
+    # A container for all the Legends in the data set. Performs
+    # validation on the whole set of Legends to ensure they cover
+    # the entire range of scores and do not overlap, as spec'd.
+    class LegendGroup < ValidatedObject
+      attr_accessor :legends
+
+      # Check that all the items in this LegendGroup:
+      #
+      #   1. Are of the class, Legend
+      #   2. Cover the range of scores from 0-100 without overlap
+      class ComprehensiveValidator < ActiveModel::EachValidator
+        def validate_each(record, attribute, legends)
+          scores = (0..100).to_a
+          legends.each do |legend|
+            unless legend.class == Legend
+              record.errors.add attribute, 'must be a Legend'
+              return
+            end
+            range = (legend.minimum_score..legend.maximum_score)
+            range.each do |score|
+              if scores.delete(score).nil?
+                unless score == legend.minimum_score || score == legend.maximum_score
+                  record.errors.add attribute, 'may not overlap'
+                  return
+                end
+              end
+            end
+          end
+          unless scores.empty?
+            record.errors.add attribute, 'do not cover entire span from 0–100'
+          end
+        end
+      end
+
+      validates :legends, comprehensive: true
+    end
+  end
+end

data/lib/eaternet/lives_1_0/violation.rb

@@ -0,0 +1,20 @@
+require 'eaternet/validated_object'
+
+module Eaternet
+  module Lives_1_0
+    # @see http://www.yelp.com/healthscores#violations LIVES / Violations
+    class Violation < ValidatedObject
+      attr_accessor :business_id, :date, :code, :description
+
+      validates :business_id,
+                type: String,
+                presence: true
+      validates :date,
+                type: Date,
+                presence: true
+      validates :code, :description,
+                type: String,
+                allow_nil: true
+    end
+  end
+end

data/lib/eaternet/loggable.rb

@@ -1,19 +1,18 @@
 module Eaternet
+  # A mixin to add logging functionality to a class.
   module Loggable
-
     # @return [Logger] the configured logger singleton
     def logger
       @logger ||= create_logger
     end
 
     private
-    
+
     def create_logger
       logger = Logger.new(ENV['EATERNET_LOG_FILE'] || $stderr)
       logger.datetime_format = '%Y-%m-%d %H:%M:%S'
       logger.progname = 'Eaternet'
       logger
     end
-
   end
 end

data/lib/eaternet/prototype.rb

@@ -4,7 +4,6 @@ module Eaternet
   # LIVES.
   #:nodoc:
   module Prototype
-
     module AbstractAdapter
       # @return [Enumerable<BusinessData>]
       def businesses
@@ -107,6 +106,5 @@ module Eaternet
         "ViolationKind #{@orig_key}"
       end
     end
-
   end
 end

data/lib/eaternet/util.rb

@@ -3,8 +3,7 @@ require 'zip'
 
 module Eaternet
   module Util
-    # A utility function to download a zip file,
-    # extract it into a temp directory.
+    # Download a zip file and extract it into a temp directory.
     #
     # @return [String] the directory path
     def self.download_and_extract_zipfile(url)
@@ -23,10 +22,20 @@ module Eaternet
       dir
     end
 
+    # Download a file from the network.
+    #
+    # @param [String] source the URL to retrieve
+    # @param [String] dest pathname in which to save the file
     def self.download(source:, dest:)
       open(dest, 'wb') { |file| file << open(source).read }
     end
 
+    # Extract a Zip archive.
+    #
+    # @param [String] path the Zip file's location
+    # @param [String] dest_dir directory in which to perform the
+    #   extraction
+    # @return nil
     def self.extract_zipfile(path:, dest_dir:)
       open(path) do |zip_file|
         Zip::File.open(zip_file, 'rb') do |zip_data|

data/lib/eaternet/validated_object.rb

@@ -0,0 +1,75 @@
+require 'active_model'
+
+module Eaternet
+  # @abstract Subclass and add `attr_accessor` and validations
+  #   to create custom validating objects.
+  #
+  # Uses [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates)
+  # to create self-validating Plain Old Ruby objects. This is especially useful for
+  # data validation when importing from CSV.
+  #
+  # @example
+  #   class Dog < Eaternet::ValidatedObject
+  #     attr_accessor :name, :birthday
+  #
+  #     validates :name, presence: true
+  #     validates :birthday, type: Date, allow_nil: true
+  #   end
+  #
+  #   # The dog1 instance is validated at the end of instantiation. Here, it succeeds
+  #   # without exception:
+  #   dog1 = Dog.new do |d|
+  #     d.name = 'Spot'
+  #   end
+  #
+  #   puts dog1.valid?  # => true
+  #
+  #   dog1.birthday = Date.new(2015, 1, 23)
+  #   puts dog1.valid?  # => true
+  #
+  #   dog1.birthday = '2015-01-23'
+  #   puts dog1.valid?  # => false
+  #   dog1.check_validations!  # => ArgumentError: birthday is not of class Date
+  #
+  # @see Eaternet::ValidatedObject::TypeValidator
+  # @see http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/ ActiveModel: Make Any Ruby Object Feel Like ActiveRecord, Yehuda Katz
+  # @see http://www.rubyinside.com/rails-3-0s-activemodel-how-to-give-ruby-classes-some-activerecord-magic-2937.html Rails 3.0′s ActiveModel: How To Give Ruby Classes Some ActiveRecord Magic, Peter Cooper
+  class ValidatedObject
+    include ActiveModel::Validations
+
+    # Instantiate and validate a new object.
+    #
+    # @yieldparam [ValidatedObject] new_object the yielded new object
+    #   for configuration.
+    #
+    # @raise [ArgumentError] if the object is not valid at the
+    #   end of initialization.
+    def initialize(&block)
+      block.call(self)
+      check_validations!
+    end
+
+    # Run any validations and raise an error if invalid.
+    # @raise [ArgumentError] if any validations fail.
+    def check_validations!
+      fail ArgumentError, errors.messages.inspect if invalid?
+    end
+
+    # Ensure an object is a certain class. This is an example of a custom
+    # validator. It's here as a nested class for easy access by subclasses.
+    #
+    # @example
+    #   class Dog < ValidatedObject
+    #     attr_accessor :weight
+    #     validates :weight, type: Float
+    #   end
+    class TypeValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        return if value.class == options[:with]
+
+        message = options[:message] || "is not of class #{options[:with]}"
+        record.errors.add attribute, message
+      end
+    end
+  end
+end

data/lib/eaternet/version.rb

@@ -1,3 +1,3 @@
 module Eaternet
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/test/{nyc_adapter_test.rb → eaternet/nyc_adapter_test.rb}

@@ -76,7 +76,8 @@ class NycAdapterTest < Minitest::Test
   end
 
   def test_finds_correct_violations
-    expected_violations = %w(06C 10F 04L 04N 04C 04L 06A 06C 08A 10F 02G 10F 02G 04L 06C 08A 10F)
+    expected_violations = %w(06C 10F 04L 04N 04C 04L 06A 06C 08A
+                             10F 02G 10F 02G 04L 06C 08A 10F)
     actual_violations = @@nyc.violations.to_a.map(&:code)
     assert_equal expected_violations, actual_violations
   end
@@ -90,6 +91,6 @@ class NycAdapterTest < Minitest::Test
   end
 
   def test_has_legends
-    assert_instance_of Eaternet::Lives_1_0::LegendGroup, @@nyc.legends
+    assert enumerable_of? Eaternet::Lives_1_0::Legend, @@nyc.legends
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eaternet
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -172,20 +186,28 @@ files:
 - lib/eaternet/agencies/snhd.rb
 - lib/eaternet/agencies/snhd_config.rb
 - lib/eaternet/lives_1_0.rb
+- lib/eaternet/lives_1_0/adapter.rb
+- lib/eaternet/lives_1_0/business.rb
+- lib/eaternet/lives_1_0/feed_info.rb
+- lib/eaternet/lives_1_0/inspection.rb
+- lib/eaternet/lives_1_0/legend.rb
+- lib/eaternet/lives_1_0/legend_group.rb
+- lib/eaternet/lives_1_0/violation.rb
 - lib/eaternet/loggable.rb
 - lib/eaternet/prototype.rb
 - lib/eaternet/util.rb
+- lib/eaternet/validated_object.rb
 - lib/eaternet/version.rb
 - lib/ext/lazy.rb
-- test/eaternet_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/lives_1_0/business_test.rb
-- test/lives_1_0/feed_info_test.rb
-- test/lives_1_0/inspection_test.rb
-- test/lives_1_0/legend_test.rb
-- test/loggable_test.rb
-- test/nyc_adapter_test.rb
-- test/snhd_adapter_test.rb
 - test/test_helper.rb
 homepage: https://github.com/eaternet/adapters-ruby
 licenses:
@@ -212,14 +234,14 @@ signing_key:
 specification_version: 4
 summary: Regional adapters for restaurant health scores
 test_files:
-- test/eaternet_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/lives_1_0/business_test.rb
-- test/lives_1_0/feed_info_test.rb
-- test/lives_1_0/inspection_test.rb
-- test/lives_1_0/legend_test.rb
-- test/loggable_test.rb
-- test/nyc_adapter_test.rb
-- test/snhd_adapter_test.rb
 - test/test_helper.rb
 has_rdoc: