msewage-importer 0.0.2 → 0.0.3

data/README.md

@@ -12,14 +12,16 @@ kind of source at a time.
     $ msewage-importer --type [source_type] --source [source.json]
 
 Currently, the following source types are supported:
+* animal_manure
+* combined_sewer_outflow
+* industrial_waste_outflow
+* latrine
 * open_defecation_site
+* open_sewage_canal_or_puddle
+* raw_sewage_outflow
+* septic_tank_cesspool
 * toilet
-* latrine
-* septic_tank
-* sewage_outflow
-* manure
-* industrial_waste
-* open_sewage
+* treatment_plant_outflow
 
 ## Help
 
@@ -27,24 +29,50 @@ Currently, the following source types are supported:
 
 ## Type of data supported
 
-At this moment, only JSON data sources are supported. These sources should conform to the
+At this moment, only JSON and CSV data sources are supported. These sources should conform to the
 following format [mSewage API](http://data.mwater.co/msewage/apiv2#2)
 
+The entries might already be geocoded. If they aren't, we will attempt to do so.
+
+The data might come from a script like [this one](https://github.com/tlevine/pri-toilet-hackers).
+
+### JSON
 ```json
 {
   "sources": [
     {
+      // Type with a location string that will be geocoded
       "name": "optional",
-      "description": "optional",
-      "location": "location string. Required."
+      "desc": "optional",
+      "location": "location string. "
     },
+    {
+      // Type that will not be geocoded
+      "name": "optional",
+      "desc": "optional",
+      "latitude": 0.00000,
+      "longitude": 0.00000
+    }
     ...
   ]
 }
+```
+
+### CSV
 
+```csv
+name,desc,location
+Optional name,Optional description,"Some place, some town, some country"
 ```
 
-The data might come from a script like [this one](https://github.com/tlevine/pri-toilet-hackers).
+or
+
+```csv
+name,desc,latitude,longitude
+Optional name,Optional description,0.0000,0.0000
+```
+
+The heading row is *required*.
 
 ## Contributing
 

data/lib/msewage-importer/api.rb

@@ -8,7 +8,7 @@ module Msewage::Importer
     end
 
     def insert(record)
-      res = HTTParty.put(new_source_url, body: new_source_body(record))
+      res = HTTParty.put(new_source_url, :body => new_source_body(record))
       !res["code"].nil?
       print "."
     end
@@ -21,12 +21,12 @@ module Msewage::Importer
 
     def new_source_body(record)
       {
-        created_by: user_name,
-        desc: record["desc"] || record["description"],
-        latitude: record["latitude"],
-        longitude: record["longitude"],
-        name: record["name"],
-        source_type: record["source_type"]
+        :created_by => user_name,
+        :desc => record["desc"] || record["description"],
+        :latitude => record["latitude"] || record["lat"],
+        :longitude => record["longitude"] || record["lon"],
+        :name => record["name"],
+        :source_type => record["source_type"]
       }
     end
 
@@ -35,9 +35,9 @@ module Msewage::Importer
     end
 
     def retrieve_client_uid
-      body = { password: password }
+      body = { :password => password }
       path = "#{api_endpoint}/users/#{user_name}"
-      res = HTTParty.post(path, body: body)
+      res = HTTParty.post(path, :body => body)
       res["clientuid"]
     end
 

data/lib/msewage-importer/geolocator.rb

@@ -1,5 +1,7 @@
 require 'geocoder'
 
+# TODO
+# use http://www.geonames.org/ -- add to https://github.com/alexreisner/geocoder/tree/master/lib/geocoder/lookups ?
 module Msewage::Importer
   class Geolocator
     def initialize(config = Config.new)

data/lib/msewage-importer/version.rb

@@ -1,5 +1,5 @@
 module Msewage
   module Importer
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: msewage-importer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geocoder
@@ -204,6 +204,7 @@ files:
 - Rakefile
 - WestBengal_2005.aspx.json
 - bin/msewage-importer
+- class-diagram.jpg
 - config/config-example.yml
 - lib/msewage-importer.rb
 - lib/msewage-importer/api.rb