shp2geocouch 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Max Ogden
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,44 @@
+h1. shp2geocouch
+
+This is an executable rubygem that creates "GeoCouch":http://www.github.com/vmx/couchdb databases from ESRI Shapefiles in one easy step
+
+h2. Installation
+
+You will need access to a GeoCouch server. For instructions on setting up your own local GeoCouch, check out "my related blog post":http://maxogden.com.
+
+Install dependencies:
+@unzip@, @sed@, @ogr2ogr@
+
+If you are on Mac OS X, you will already have @unzip@ and @sed@ installed. To get @ogr2ogr@, install "Homebrew":http://github.com/mxcl/homebrew and run @brew install gdal@.
+
+Note: @ogr2ogr@ is usually included with the @gdal@ package (sometimes called @gdal-bin@).
+
+Install the @shp2geocouch@ gem:
+
+@gem install shp2geocouch@
+
+h2. Usage
+
+@shp2geocouch <path_to_shapefile> [your-geocouch-root-url (optional, default: http://localhost:5984)]@
+
+example: @shp2geocouch /sweet_geo_data/Portland_Oregon_Public_Libraries.shp@
+another possible example: @shp2geocouch /zipped_shapfiles/US_Railroads.zip http://myusername.couchone.com@
+
+Once completed, you can run bounding box queries against your data! Visit the following link to receive a dump of your entire dataset as GeoJSON (a bounding box that covers the entire planet):
+@http://localhost:5984/your_db_name/_design/geojson/_spatial/points?bbox=-180,180,-90,90@
+
+If you uploaded a large dataset, you may experience a delay on the first ever spatial query as GeoCouch builds it's spatial index. You can check the status of the indexer by visiting @http://localhost:5984/_utils/status.html@
+
+h3. Arguments: 
+
+* You can feed in either a @.shp@ file or a @.zip@ that contains a @.shp@
+* @-v@ for verbose
+* @--no-cleanup@ if you want @shp2geocouch@ to leave you a copy of unzipped Shapefile and converted JSON.
+
+h2. What?
+
+Raw geographic data is awesome, especially when it available online from entities like local governments. Unfortunately, a lot of agencies store and release their data in a proprietary format called a Shapefile, which was developed by a large for-profit corporation called ESRI, whose closed source desktop GIS software is ubiquitous in the academic and government GIS circles.
+
+GeoCouch is a free and open source geospatial data store that is built on the the popular Apache CouchDB database. With GeoCouch, you serve your geographic data 'a la carte', or in small relevant chunks instead of having to download the entire dataset at a time. This pattern works especially well on the web, as you wouldn't want to go giving the list of all 10,000 bus stops to someone on a cellphone that's requesting just the 5 bus stops that are nearest to their location.
+
+@shp2geocouch@ is a utility that will take a Shapefile and create a new GeoCouch database on your GeoCouch server which will contain the geographic data from the Shapefile.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shp2geocouch"
+    gem.summary = "rubygem that converts Shapefiles into GeoCouch databases"
+    gem.description = "rubygem that converts Shapefiles into GeoCouch databases"
+    gem.email = "max@maxogden.com"
+    gem.homepage = "http://github.com/maxogden/shp2geocouch"
+    gem.authors = ["Max Ogden"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/shp2geocouch

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+require 'httparty'
+require 'couchrest'
+require 'optparse'
+
+class ShapefileToGeoCouch
+  attr_accessor :path, :extension, :name, :couch_url, :cleanup, :verbose
+  
+  def initialize(options)
+    set_accessors(options)
+    @db = CouchRest.database! database_url
+    verify_dependencies
+    convert
+    upload
+    add_ddoc
+    cleanup if @cleanup
+    puts "Upload complete. Test your data at #{database_url}/_design/geojson/_spatial/points?bbox=-180,180,-90,90" if @verbose
+  end
+  
+  def set_accessors(options)
+    options.each {|k,v| send("#{k.to_s}=",v)}
+  end
+  
+  def verify_dependencies
+    %w(ogr2ogr sed unzip).each do |dependency|
+      unless %x!which #{dependency}![dependency]
+        raise "#{dependency} isn't installed or isn't in your current path."
+      end
+    end
+    begin
+      @db.get("")
+    rescue Errno::ECONNREFUSED
+      raise "Couldnt find a Couch instance running at #{@couch_url}"
+    end
+  end
+  
+  def database_url
+    "#{@couch_url}/#{@name}"
+  end
+
+  def output_folder
+    File.expand_path("#{@name}_converted", Dir.pwd)
+  end
+  
+  def find_shapefile
+    Dir.glob(output_folder + "/**/*.shp")[0]
+  end
+  
+  def json
+    "#{output_folder}/#{@name}.json"
+  end
+  
+  def bulk
+    "#{output_folder}/#{@name}_bulk.json"
+  end
+  
+  def unzip
+    puts "Unzipping into #{output_folder}..." if @verbose
+    `unzip #{@path} -d #{output_folder}`
+  end
+
+  def convert
+    `mkdir -p #{output_folder}`
+    if @extension =~ /zip/i
+      unzip
+      shapefile = find_shapefile
+    else
+      shapefile = @path
+    end
+    puts "Converting Shapefile, saving as #{json}..." if @verbose
+    %x!ogr2ogr -t_srs EPSG:4326 -a_srs EPSG:4326 -f "GeoJSON" #{json} #{shapefile}!
+    puts "Reformatting json for bulk import, saving as #{bulk}..." if @verbose
+    %x!sed -e '/^\"type\": \"FeatureCollection\",$/d' -e '/^\"features\": \\[$/d' -e '/^{$/d' -e '/^,$/d' -e '/^}$/d' -e '/^]$/d' -e '/^$/d' -e 's/$/,/' #{json} > #{bulk}!
+  end
+  
+  def upload
+    puts "Bulk loading data into GeoCouch... view progress at #{@couch_url}/_utils" if @verbose
+    File.open(bulk).each_line do |line|
+      HTTParty.post(database_url + '/_bulk_docs', :body => '{"docs": [' + line[0..-3] + "]}", :headers => {'content-type' => "application/json"})
+     end
+  end
+  
+  def add_ddoc
+    puts "Adding spatial index design document..." if @verbose
+    view_exists = @db.get('_design/geojson') rescue false
+    unless view_exists
+      @db.save_doc({
+        "_id" => "_design/geojson",
+        "spatial" => {
+          :points => "function(doc) { emit(doc.geometry, {id: doc._id, geometry: doc.geometry}) };"
+        }
+      })
+    end
+  end
+  
+  def cleanup
+    puts "Cleaning up..." if @verbose
+    %x!rm -rf #{output_folder}!
+  end
+end  
+
+defaults = {:cleanup => true, :verbose => false}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{__FILE__} [path-to-shapefile] [your-geocouch-root-url (optional, default: http://localhost:5984)]"
+  opts.on("--no-cleanup", "Don't remove converted files after upload") do |v|
+    defaults[:cleanup] = false
+  end
+  
+  opts.on('-v') do |v|
+    defaults[:verbose] = true
+  end
+end.parse!
+
+raise "You must specify a Shapefile to convert." if ARGV[0].nil?
+
+extension = ARGV[0].split('.')[1]
+raise "You must specify a .shp or a .zip" unless extension =~ /zip|shp/i
+
+name = ARGV[0].split('/')[-1].split('.')[0]
+
+options = {:path => ARGV[0], :name => name.downcase, :extension => extension}.merge(defaults)
+options[:couch_url] = ARGV[1] || "http://localhost:5984"
+
+ShapefileToGeoCouch.new(options)

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: shp2geocouch
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Max Ogden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-05 00:00:00 -07:00
+default_executable: shp2geocouch
+dependencies: []
+
+description: rubygem that converts Shapefiles into GeoCouch databases
+email: max@maxogden.com
+executables: 
+- shp2geocouch
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- bin/shp2geocouch
+has_rdoc: true
+homepage: http://github.com/maxogden/shp2geocouch
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: rubygem that converts Shapefiles into GeoCouch databases
+test_files: []
+