eaternet 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22ee77b16cad4131bcf6dfa1c970507b39569ba6
-  data.tar.gz: 8649494e45fedc9defa460d1423c2b1c83eee345
+  metadata.gz: f0c7cf9f3ade633780c1f1a0fe0c53737bdef0a1
+  data.tar.gz: 65c597f98824f85517854ba003383ea92c0f571a
 SHA512:
-  metadata.gz: d64e281aab4dada323e6fd72b5facf8b4287c6318b5132fa231b44e71ca0281e5c10c52a221577a35386d2bfc5d5dbcdd294a88c00d07da19fe8006f54d3247d
-  data.tar.gz: 0d1ed8e4684cb36c2af320556e5efca4805fc3647216c34c83770c9c086972c89b4404a23dbe457120ead76d0048e5eea96e439d81e99bba00060300bea9260d
+  metadata.gz: 3a48aa898e82a87084fabd8f08ed9c9e9c5d6bd80ec4d2b69c69dd194be431bf421f6551330924605ff9448c07450d35073bf50c0b19a11e29e0ee9a9ba46fc6
+  data.tar.gz: 28d011e3eb2de88ee6ee13698d164a45162b1fba91d69c53e4d12c216369551ce069dd4a6a1698473732bfc35c07280a3f081d65617b564bffe61f8ac3948407

data/lib/eaternet/lives_1_0.rb

@@ -4,17 +4,24 @@ module Eaternet
   # Framework for creating LIVES 1.0 apps.
   #
   # The goal is to make it as easy as possible to create
-  # compliant implementations. And so, the Business, Inspection
-  # and Violation data objects use validations to ensure that they
-  # correctly produce the entities listed in the spec.
+  # compliant implementations. And so, the {Lives_1_0::Business},
+  # {Lives_1_0::Inspection},
+  # and other data objects validate themselves for adherence
+  # to the spec.
   #
-  # @see http://www.yelp.com/healthscores
+  # @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
-    require 'active_model'
 
+    # We use {ActiveModel::Validations} for great self-validating
+    # Ruby objects.
+    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>]
@@ -52,7 +59,7 @@ module Eaternet
 
 
       private
-      
+
       def check_validations!
         fail ArgumentError, errors.messages.inspect if invalid?
       end
@@ -67,7 +74,19 @@ module Eaternet
 
 
     # A food service establishment, e.g. a restaurant.
-    # @see http://www.yelp.com/healthscores#businesses
+    #
+    # @!attribute [rw] business_id
+    #   @return [String] Unique identifier for the business. For many cities,
+    #   this may be the license number.
+    #
+    # @!attribute [rw] name
+    #   @return [String] Common name of the business
+    #
+    # @!attribute [rw] address
+    #   @return [String] Street address of the business. For example: 706
+    #   Mission St.
+    #
+    # @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
@@ -105,7 +124,6 @@ module Eaternet
         @business_id.hash
       end
 
-      # :nodoc:
       # @return [String]
       def to_s
         "Business #{@business_id}"

data/lib/eaternet/loggable.rb

@@ -1,10 +1,13 @@
 module Eaternet
   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'

data/lib/eaternet/version.rb

@@ -1,3 +1,3 @@
 module Eaternet
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eaternet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Regional adapters for restaurant health scores
@@ -236,4 +236,3 @@ test_files:
 - test/nyc_adapter_test.rb
 - test/snhd_adapter_test.rb
 - test/test_helper.rb
-has_rdoc: