eaternet 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f47d6d78b52b5b55f09751345eccf00d74d1f18f
-  data.tar.gz: acad763f1ce90905f8e96dc59c60c79b5cc33cae
+  metadata.gz: af8af2d45bbf5b308fb47e75f501a35bf436447f
+  data.tar.gz: 0db0339d37d25f2436b7beeb5b13b07ffc35ee83
 SHA512:
-  metadata.gz: abaa54be2f9695055f50cfff9f23d7496d71dde8318053de5301500882ca5c099c810e908a630aa5c19d86622dc4efa841c4f29651f57974c91db6e6449da2ef
-  data.tar.gz: 5ee3213153c53c209221894a7909776f736b48c9ccf171ea3764edc3947e76b72e52427ba89c06c533167ce1a4d9e28b4ee18a0762f27ccd94d57d30cf997d1f
+  metadata.gz: 88ca6e813d927bcd80cc14b311e6082c378efff9ce359ae28e2af25e0cc57264249704d99c7f31a4ab239967ae6f12fba293acaeb581f4be29ad52bf45d38603
+  data.tar.gz: 3a95dca9298441e8c3779ac08e27c8b8ecbffc9c9770c939494285ce9a9bd1559f3cce2fc67e4c0627222b4f28f3544087db0c2c2a8b1c441b36591942d03772

data/lib/eaternet/lives_1_0.rb

@@ -11,12 +11,7 @@ module Eaternet
   #
   # @see http://www.yelp.com/healthscores Local Inspector Value-Entry
   #   Specification (LIVES)
-  # @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
   module Lives_1_0
-
-    # We use {ActiveModel::Validations} for great self-validating
-    # Ruby objects.
     require 'active_model'
 
     # @abstract Subclass and override {#businesses}, {#inspections},
@@ -49,9 +44,23 @@ module Eaternet
     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!
@@ -163,7 +172,39 @@ module Eaternet
     end
 
 
-    # @see http://www.yelp.com/healthscores#inspections
+    # 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
 
@@ -187,13 +228,14 @@ module Eaternet
         @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
+    # @see http://www.yelp.com/healthscores#violations LIVES / Violations
     class Violation < ValidatedObject
       attr_accessor :business_id, :date, :code, :description
 
@@ -209,7 +251,7 @@ module Eaternet
     end
 
 
-    # @see http://www.yelp.com/healthscores#feed_info
+    # @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
@@ -238,7 +280,7 @@ module Eaternet
     end
 
 
-    # @see http://www.yelp.com/healthscores#legend
+    # @see http://www.yelp.com/healthscores#legend LIVES / Legend
     class Legend < ValidatedObject
       attr_accessor :minimum_score, :maximum_score, :description
 

data/lib/eaternet/version.rb

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

metadata

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