eaternet 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccc62ab3ba30754879ff39a1393090fcdc5fed7b
+  data.tar.gz: 833f87ebb8cc5b2932f45a0e083d24948773c9f7
+SHA512:
+  metadata.gz: 5b965baff721e99f26c826b362d7c5948005f1e2985623f08d55946094a6092798e6ce7767ec9c04a6884451d813b7338e2d9d13fe68b02f4f16c990958064ee
+  data.tar.gz: 9b3a111d686ab730ab354febfc8aaf9cae3d82c62be3fbb5cb71876b25e52e9533a955ce4eb796f8f1695f7a42380dc3348963bd082ebaabcbedce3d8f1daf2a

data/.gitignore

@@ -0,0 +1,25 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Temp and var files
+/tmp/
+/vcr_cassettes/
+/test/vcr_cassettes/
+
+# IDE's
+*.komodoproject
+/.idea
+*.sublime*
+>>>>>>> master

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eaternet-adapters.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,78 @@
+[![Build Status](https://travis-ci.org/eaternet/adapters-ruby.svg?branch=master)](https://travis-ci.org/eaternet/adapters-ruby)
+[![Code Climate](https://codeclimate.com/github/eaternet/adapters-ruby/badges/gpa.svg)](https://codeclimate.com/github/eaternet/adapters-ruby)
+[![Gem Version](https://badge.fury.io/rb/eaternet-adapters.svg)](http://badge.fury.io/rb/eaternet-adapters)
+
+# Eaternet::Adapters
+
+**We're bringing the world's restaurant health inspections online,**
+into as many sites and apps as possible.
+
+Use this repo to publish your local restaurant health scores.
+
+**In a nutshell:** each agency which inspects restaurants can have an "adapter" which is a Ruby class.
+Its adapter converts its source format into a simple, standard one. Anybody can then use these adapters to get the
+data and do analysis and work with it how they like. [Eaternet](http://eaternet.io/), in particular, will use the production-ready
+adapters to pull and publish the information daily on our website and in feeds to partner organizations.
+
+
+## Available Adapters
+
+| Area              | Agency                          | Ruby Class | Notes     |
+|-------------------|---------------------------------|------------|-----------|
+| Las Vegas         | Southern Nevada Health District | [`Snhd`](https://github.com/eaternet/adapters-ruby/blob/master/lib/eaternet/adapters/agencies/snhd.rb) | Completed |
+| New York City     | City of New York Health Dept.   | `Nyc`      | [Dataset wiki page](https://github.com/eaternet/adapters/wiki/Agency-Notes:-New-York-City),  [Pull Request WIP](https://github.com/eaternet/adapters-ruby/pull/8) |
+| Porland, OR, USA  | Multnomah Couty Environmental Health | `Multco` | [Live on website](https://eaternet.io), Open source WIP |
+
+
+## Usage
+
+Example: print all the restaurant names in the Southern Nevada Health District
+
+```ruby
+require 'eaternet/adapters'
+
+agency = Snhd.new
+agency.businesses.each { |biz| puts biz.name }
+```
+
+Each adapter provides [a small set of enumerators](https://github.com/eaternet/adapters-ruby/blob/master/lib/eaternet/adapters/framework.rb#L27-L39) such as `businesses` and `inspections`. See the [Las Vegas tests](https://github.com/eaternet/adapters-ruby/blob/master/test/snhd_adapter_test.rb) to learn how an application would use this gem. The framework also includes [standardized data transfer objects](https://github.com/eaternet/adapters-ruby/blob/master/lib/eaternet/adapters/framework.rb#L42-L103) which these enumerators return.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eaternet-adapters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eaternet-adapters
+
+
+## Roadmap
+
+See the [eaternet/adapters](https://github.com/eaternet/adapters#roadmap) repo for the project roadmap.
+
+## Contributing
+
+Write an adapter for your city's restaurant health scores. Or do a small refactor or add
+documentation. We're happy to get the help.
+
+To add your local health scores, you just need to create a class which `include`'s `AbstractAdapter`.
+We like good tests, as well. Submit a pull requests to start a conversation, and we'll work with you.
+
+Once a new adapter is production-ready, we'll plug it into the Eaternet system, and your adapter will be
+put into daily production. We're working with several organizations to publish the information. Yelp was
+the first to work with us, and we have new partnerships in the works which we'll announce soon.
+
+1. Fork it ( https://github.com/eaternet/adapters/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << 'test'
+  t.verbose = false
+end
+
+task :default => :test

data/eaternet.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eaternet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eaternet"
+  spec.version       = Eaternet::VERSION
+  spec.authors       = ["Robb Shecter"]
+  spec.email         = ["robb@eaternet.io"]
+  spec.summary       = %q{Regional adapters for restaurant health scores}
+  spec.description   = %q{A framework for easily retrieving a region's health scores in a standardized way.}
+  spec.homepage      = "https://github.com/eaternet/adapters-ruby"
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{ |f| f =~ /vcr_cassettes/ }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_runtime_dependency 'activemodel', '~> 4.2.1'
+  spec.add_runtime_dependency 'rubyzip'
+end

data/lib/eaternet.rb

@@ -0,0 +1,9 @@
+require 'eaternet/version'
+require 'eaternet/agencies/snhd'
+require 'eaternet/agencies/nyc'
+
+# Make the actual adapters easily available
+# to the application-level
+include Eaternet::Agencies
+
+Zip.warn_invalid_date = false if ENV['RUBYZIP_NO_WARN_INVALID_DATE']

data/lib/eaternet/agencies/nyc.rb

@@ -0,0 +1,184 @@
+require 'csv'
+require 'json'
+require 'logger'
+require 'open-uri'
+require 'set'
+require 'tempfile'
+
+require 'ext/lazy'
+require 'eaternet/framework/lives_1_0'
+
+module Eaternet
+  module Agencies
+    # First-level parsing of New York City restaurant inspections
+    #
+    # @see https://data.cityofnewyork.us/Health/DOHMH-New-York-City-Restaurant-Inspection-Results/xx67-kt59
+    # @todo This is a very long namespace. Can this be improved?
+    class Nyc < Eaternet::Framework::Lives_1_0::Adapter
+      DOMAIN = 'data.cityofnewyork.us'
+      DATASET = 'xx67-kt59'
+      CSV_URL = "https://#{DOMAIN}/api/views/#{DATASET}/rows.csv?accessType=DOWNLOAD"
+
+      # Create an NYC Adapter.
+      #
+      # @param csv_path for unit testing
+      def initialize(csv_path: nil)
+        @table_file = csv_path
+        @logger = Logger.new(STDERR)
+        @logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+      end
+
+      def businesses
+        map_csv { |row| try_to_create_business(row) }
+          .compact
+          .unique
+      end
+
+      def inspections
+        cache = Set.new
+        map_csv do |row|
+          if inspection_should_be_skipped?(cache, row)
+            nil
+          else
+            save_to_inspection_cache(cache, row)
+            inspection(row)
+          end
+        end.compact
+      end
+
+      def violations
+        map_csv do |row|
+          violation_should_be_skipped?(row) ? nil : violation(row)
+        end.compact
+      end
+
+      def feed_info
+        FeedInfo.new do |fi|
+          fi.feed_date = Date.today
+          fi.feed_version = '1.0'
+          fi.municipality_name = 'New York City'
+          fi.municipality_url = 'http://www.nyc.gov/html/doh/html/services/restaurant-inspection.shtml'
+        end
+      end
+
+      def legends
+        LegendGroup.new do |lg|
+          lg.legends = [
+            Legend.new do |l|
+              l.minimum_score = 87
+              l.maximum_score = 100
+              l.description =   'A'
+            end,
+            Legend.new do |l|
+              l.minimum_score = 73
+              l.maximum_score = 86
+              l.description =   'B'
+            end,
+            Legend.new do |l|
+              l.minimum_score = 0
+              l.maximum_score = 72
+              l.description =   'C'
+            end,
+          ]
+        end
+      end
+
+
+      private
+
+      def try_to_create_business(row)
+        begin
+          business(row)
+        rescue ArgumentError => e
+          @logger.warn('Eaternet') do
+            "Could not create a NYC Business from \"#{row.to_s.strip}\": #{e}"
+          end
+          nil
+        end
+      end
+
+      def business(row)
+        Business.new do |b|
+          b.business_id = business_id(row)
+          b.name = row['DBA']
+          b.address = "#{row['BUILDING']} #{row['STREET']}"
+          b.city = row['BORO']
+          b.postal_code = row['ZIPCODE']
+        end
+      end
+
+      def violation(row)
+        Violation.new do |v|
+          v.business_id = business_id(row)
+          v.date = Date.strptime(row['INSPECTION DATE'], '%m/%d/%Y')
+          v.code = violation_kind_id(row)
+        end
+      end
+
+      def inspection(row)
+        Inspection.new do |i|
+          i.business_id = business_id(row)
+          i.date = Date.strptime(row['INSPECTION DATE'], '%m/%d/%Y')
+          i.score = 100 - row['SCORE'].to_i
+        end
+      end
+
+      def violation_should_be_skipped?(row)
+        transfat_inspection?(row) || violation_kind_id(row).nil?
+      end
+
+      def inspection_should_be_skipped?(cache, row)
+        cache.include?(inspection_cache_key(row)) || transfat_inspection?(row)
+      end
+
+      def business_id(row)
+        row['CAMIS']
+      end
+
+      def inspection_id(row)
+        [row['CAMIS'], row['INSPECTION DATE']].join('-')
+      end
+
+      def violation_kind_id(row)
+        row['VIOLATION CODE']
+      end
+
+      def save_to_inspection_cache(cache, row)
+        cache.add(inspection_cache_key(row))
+      end
+
+      def inspection_cache_key(row)
+        inspection_id(row)
+      end
+
+      def transfat_inspection?(row)
+        row['INSPECTION TYPE'].include?('Trans Fat')
+      end
+
+      def map_csv(&block)
+        CSV.new(open(table_file), headers: true).lazy.map { |row| block.call(row) }
+      end
+
+      def unique(objects)
+        Set.new(objects)
+      end
+
+      def table_file
+        if @table_file.nil?
+          @table_file = Tempfile.new('all.csv.')
+          Nyc.download(@table_file)
+        end
+        @table_file
+      end
+
+      def self.download(a_file)
+        download_via_url(a_file)
+      end
+
+      # Fastest method for downloading all data but may be non-standard
+      def self.download_via_url(a_file)
+        a_file.write(open(CSV_URL).read)
+      end
+    end
+  end
+end