rgeoserver 0.5.9 → 0.7

data/.gitignore

@@ -6,7 +6,7 @@ doc
 .yardoc
 .bundle
 .rvmrc
-Gemfile.lock
 .DS_Store
 .swp
 .swo
+*.log

data/Gemfile

@@ -1,9 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
-
-# general
-gem 'activemodel'
-gem 'rubyzip'
-gem 'rgeo'
-gem 'rgeo-shapefile'

data/Gemfile.lock

@@ -0,0 +1,147 @@
+PATH
+  remote: .
+  specs:
+    rgeoserver (0.7)
+      activemodel (~> 3.2.0)
+      activesupport (~> 3.2.0)
+      confstruct (~> 0.2.0)
+      mime-types (~> 2.0)
+      nokogiri (~> 1.6.0)
+      rest-client (~> 1.6.0)
+      rgeo (~> 0.3.0)
+      rgeo-shapefile (~> 0.2.0)
+      rubyzip (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.16)
+      activesupport (= 3.2.16)
+      builder (~> 3.0.0)
+    activesupport (3.2.16)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    alias (0.2.3)
+    awesome_print (1.2.0)
+    binding.repl (0.8.0)
+    boson (1.2.4)
+    boson-more (0.2.2)
+      boson (>= 1.2.0)
+    builder (3.0.4)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    clipboard (1.0.5)
+    coderay (1.1.0)
+    columnize (0.3.6)
+    confstruct (0.2.5)
+    dbf (2.0.7)
+      fastercsv (~> 1.5.4)
+    debugger (1.6.3)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.4)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.4)
+    diff-lcs (1.2.5)
+    equivalent-xml (0.4.0)
+      nokogiri (>= 1.4.3)
+    every_day_irb (1.5.1)
+    fancy_irb (0.7.3)
+      paint (>= 0.8.1)
+      unicode-display_width (>= 0.1.1)
+    fastercsv (1.5.5)
+    ffi (1.9.3)
+    g (1.7.2)
+    hirb (0.7.1)
+    i18n (0.6.9)
+    interactive_editor (0.0.10)
+      spoon (>= 0.0.1)
+    irbtools (1.5.1)
+      alias (~> 0.2.3)
+      awesome_print (~> 1.2.0)
+      binding.repl (>= 0.7.0)
+      boson (~> 1.2.4)
+      boson-more (~> 0.2.2)
+      clipboard (~> 1.0.5)
+      coderay (~> 1.1.0)
+      every_day_irb (>= 1.5.1)
+      fancy_irb (>= 0.7.3)
+      g (>= 1.7.2)
+      hirb (~> 0.7.1)
+      interactive_editor (>= 0.0.10)
+      method_locator (>= 0.0.4)
+      method_source (>= 0.8.2)
+      methodfinder (>= 1.2.5)
+      ori (~> 0.1.0)
+      paint (>= 0.8.6)
+      wirb (>= 1.0.2)
+      zucker (>= 13.1)
+    jettywrapper (1.5.0)
+      activesupport (>= 3.0.0)
+      childprocess
+      i18n
+      logger
+      mediashelf-loggable
+    logger (1.2.8)
+    mediashelf-loggable (0.4.9)
+    method_locator (0.0.4)
+    method_source (0.8.2)
+    methodfinder (2.0.0)
+    mime-types (2.0)
+    mini_portile (0.5.2)
+    multi_json (1.8.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    ori (0.1.0)
+    paint (0.8.6)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rgeo (0.3.20)
+    rgeo-shapefile (0.2.3)
+      dbf (>= 1.7.0)
+      rgeo (>= 0.3.3)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubyzip (0.9.9)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    slop (3.4.7)
+    spoon (0.0.4)
+      ffi
+    unicode-display_width (0.1.1)
+    wirb (1.0.2)
+      paint
+    yard (0.8.7.3)
+    zucker (13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.0)
+  debugger (~> 1.0)
+  equivalent-xml
+  irbtools
+  jettywrapper
+  pry
+  rake
+  rgeoserver!
+  rspec
+  shoulda
+  yard

data/README.rdoc

@@ -1,35 +1,40 @@
-{<img src="https://gemnasium.com/rnz0/rgeoserver.png" alt="Dependency Status" />}[https://gemnasium.com/rnz0/rgeoserver]
-{<img src="https://secure.travis-ci.org/rnz0/rgeoserver.png" />}[http://travis-ci.org/rnz0/rgeoserver]
-
 == RGeoServer
 
 RGeoServer is a Ruby client for the GeoServer RESTful Configuration interface. 
 
+Requirements:
+* {GeoServer}[http://geoserver.org] 2.1.3 or later.
+* Ruby 1.9.3
+
 It provides primitive Ruby model abstraction.
 
 == Documentation
-The GeoServer REST Configuration API Reference can be found here:
 
-http://docs.geoserver.org/stable/en/user/rest/index.html
+See the {GeoServer REST Configuration API Reference}[http://docs.geoserver.org/stable/en/user/rest/index.html]
 
- 
 == Installation 
 
   $ gem install rgeoserver
 
-
 == Example: 
 
-Sample usage from an irb console
+Sample usage from an irb console, using a GeoServer installation with a topp workspace.
 
-  > catalog = RGeoServer::Catalog.new :user=>"admin", :url=>"http://10.0.0.2/geoserver/rest", :password=>"osgeo!"
-  => Catalog: http://10.0.0.2/geoserver/rest
-  > w = catalog.get_workspace('topp') 
+  $ rake console
+  > require 'rgeoserver'
+  > catalog = RGeoServer::Catalog.new
+   => Catalog: http://localhost:8080/geoserver/rest
+  > w = catalog.get_default_workspace
   => RGeoServer::Workspace: topp
   > ds = w.data_stores.first
   => RGeoServer::DataStore: states_shapefile
   > ds.profile
-  => {"name"=>"states_shapefile", "enabled"=>"true", "connectionParameters"=>{"url"=>"file:data/shapefiles/states.shp", "namespace"=>"http://www.openplans.org/topp"}, "featureTypes"=>["states"]} 
+  => {"name"=>"states_shapefile", 
+      "enabled"=>"true", 
+      "connectionParameters"=>{
+        "url"=>"file:data/shapefiles/states.shp", 
+        "namespace"=>"http://www.openplans.org/topp"}, 
+      "featureTypes"=>["states"]} 
   > ft = ds.featuretypes.first
   => RGeoServer::FeatureType: states 
   > ft.profile
@@ -38,101 +43,85 @@ Sample usage from an irb console
   > lyr = RGeoServer::Layer.new c, :name => 'Arc_Sample'
   => RGeoServer::Layer: Arc_Sample 
   > lyr.profile
-  => {"name"=>"Arc_Sample", "path"=>"/", "defaultstyle"=>"rain", "styles"=>["raster"], "type"=>"RASTER", "enabled"=>"true", "attribution"=>{"logoWidth"=>"0", "logoHeight"=>"0"}, "resource"=>{"type"=>"coverage", "name"=>"Arc_Sample", "store"=>"arcGridSample", "workspace"=>"nurc"}, "metadata"=>{"GWC.autoCacheStyles"=>"true", "GWC.metaTilingX"=>"4", "GWC.metaTilingY"=>"4", "GWC.gutter"=>"0", "GWC.cachedNonDefaultStyles"=>"raster", "GWC.enabled"=>"true", "GWC.cacheFormats"=>"image/jpeg,image/png", "GWC.gridSets"=>"EPSG:4326,EPSG:900913"}}
+  => {"name"=>"Arc_Sample", 
+      "path"=>"/", 
+      "defaultstyle"=>"rain", 
+      "styles"=>["raster"], 
+      "type"=>"RASTER", 
+      "enabled"=>"true", 
+      "attribution"=>{"logoWidth"=>"0", "logoHeight"=>"0"}, 
+      "resource"=>{
+        "type"=>"coverage", 
+        "name"=>"Arc_Sample", 
+        "store"=>"arcGridSample", 
+        "workspace"=>"nurc"},
+      "metadata"=>{
+        "GWC.autoCacheStyles"=>"true", 
+        "GWC.metaTilingX"=>"4", 
+        "GWC.metaTilingY"=>"4", 
+        "GWC.gutter"=>"0", 
+        "GWC.cachedNonDefaultStyles"=>"raster", 
+        "GWC.enabled"=>"true", 
+        "GWC.cacheFormats"=>"image/jpeg,image/png", 
+        "GWC.gridSets"=>"EPSG:4326,EPSG:900913"}}
   > sld = lyr.styles.first
   => RGeoServer::Style: raster 
   > sld.profile
-  => {"name"=>"raster", "sld_version"=>"1.0.0", "filename"=>"raster.sld", "sld"=>{"sld_name"=>"raster", "sld_title"=>"Default Raster"}} 
-
- 
-A full sample script creating coverage stores in a small cluster:
-
-  require 'rgeoserver'
-
-  layers = {
-    'south_america_1787' => {
-      'url' => 'file:///geo_data/rumsey/g0411047.tif',
-      'description' => "Map of South America by D'Anville",
-      'type' => 'GeoTIFF'
-     },
-    'city_of_san_francisco_1859' => {
-      'url' => 'file:///geo_data/rumsey/g1030000alpha.tif',
-      'description' => 'Map of San Francisco by the U.S. Coast Survey, with detail of the unsettled lands',
-      'type' => 'GeoTIFF'
-    }
-  }
-
-  (1..7).each do |cat_id|
-    cat = RGeoServer::Catalog.new :user=>'admin', :url => "http://geoserver-app#{cat_id}/rest", :password => "osgeo!"
-    ws = cat.get_default_workspace
-    cat.list(RGeoServer::CoverageStore, layers.keys, :workspace => ws) do |cs|
-      cs.url = layers[cs.name]['url']
-      cs.data_type = layers[cs.name]['type']
-      cs.enabled = 'true'
-      cs.save
-      # Create the corresponding layer
-      c = RGeoServer::Coverage.new cat, :workspace => ws, :coverage_store => cs, :name => cs.name 
-      c.title = cs_name.gsub('_',' ').titleize
-      c.abstract = layers[cs.name]['description']
-      c.save
-      # Seed the tile cache
-      l = RGeoServer::Layer.new cat, :name => cs.name
-      l.seed :issue, {
-        :srs => {
-          :number => 4326
-        },
-        :zoomStart => 1,
-        :zoomStop => 10,
-        :format => 'image/png',
-        :threadCount => 1
-      }
-    end
-  end
+  => {"name"=>"raster", 
+      "sld_version"=>"1.0.0", 
+      "filename"=>"raster.sld", 
+      "sld"=>{"sld_name"=>"raster", "sld_title"=>"Default Raster"}} 
 
 
+See *examples* directory for more examples.
+
 == Testing
+
 We use {jettywrapper}[https://github.com/projecthydra/jettywrapper] to wrap a test instance of GeoServer. In theory, you should be able to point to any other local installation. Suppose that you download the binary stable version 2.1.3 binary from {here}[http://sourceforge.net/project/downloading.php?groupname=geoserver&filename=geoserver-2.1.3-bin.zip&use_mirror=softlayer], then unzip it under say, /tmp/geoserver-2.1.3. The integration tests are executed as follows:
-  $ rake integration['/tmp/geoserver-2.1.3','8080','-DGEOSERVER_DATA_DIR=data_dir']
+
+  $ rake integration
 
 If you have the test instance running already on port 8080, you can run the tests simply with:
 
   $ rake
 
 To generate the documentation run:
+
   $ rake yard
 
-To enter into an irb console with all classess loaded:
+To enter into an irb console with all classes loaded:
+
   $ rake console
 
 == Logging
-For now we use {RestClient's}[https://github.com/archiloque/rest-client] base logger. It can be enabled by setting:
 
-  RestClient.log = '/tmp/restclient.log'
+To enable logging from {RestClient's}[https://github.com/archiloque/rest-client] base logger, add an entry in your `config.yml` for stdout/stderr or a file:
+
+  geoserver:
+    logfile: stderr
 
-or set an environment variable, for example:
+or
 
-  $ RESTCLIENT_LOG=stdout ruby ingest_layer.rb 
-  RestClient.get "http://localhost:8080/geoserver/rest/workspaces/cite.xml", "Accept"=>"application/xml", "Accept-Encoding"=>"gzip, deflate", "Content-Type"=>"application/xml"
-  # => 200 OK | application/xml 662 bytes
-  RestClient.get "http://localhost:8080/geoserver/rest/workspaces/cite/coveragestores/city_of_san_francisco_1859.xml", "Accept"=>"application/xml", "Accept-Encoding"=>"gzip, deflate", "Content-Type"=>"application/xml"
-  # => 404 NotFound | text/plain 73 bytes
-  RestClient.post "http://localhost:8080/geoserver/rest/workspaces/cite/coveragestores", "<?xml version=\"1.0\"?>\n<coverageStore>\n  <name>city_of_san_francisco_1859</name>\n  <workspace>\n    <name>cite</name>\n  </workspace>\n  <enabled>true</enabled>\n  <type>GeoTIFF</type>\n  <description>Map of San Francisco by the U.S. Coast Survey, with detail of the unsettled lands</description>\n  <url>file:///geo_data/rumsey/g1030000alpha.tif</url>\n</coverageStore>\n", "Accept"=>"application/xml", "Accept-Encoding"=>"gzip, deflate", "Content-Length"=>"363", "Content-Type"=>"application/xml"
-  # => 201 Created |  0 bytes
+  geoserver:
+    logfile: 'rgeoserver.log'
 
 
 == Related Resources
+
 * {OSGeo The Open Source Geospatial Foundation}[http://www.osgeo.org]
-* {GeoServer Project page}[http://docs.geoserver.org/stable/en/user/index.html]
-* {GeoServer Catalog design}[http://bit.ly/JrX1J8]
+* {GeoServer}[http://geoserver.org]
+  * {Catalog design}[http://bit.ly/JrX1J8]
 * {GeoTools}[http://geotools.org/]
 * Implementation in other languages: 
   * Python: {gsconfig.py}[https://github.com/dwins/gsconfig.py]
 
 == Release History
 
+- <b>v0.7</b> - Major update with keywords, YAML config, REST API, unit testing and cleanup
 - <b>v0.5</b> - Initial alpha release
 
 == TODO
+
 - Complete data stores and coverages functionality and data upload.
 - Complete updating data in objects. On failure, objects should roll back.
 - Complete documentation.
@@ -143,12 +132,12 @@ or set an environment variable, for example:
 - Provide more examples:
   - Customize configuration.
   - Connect under SSL.
-  - Batch processing.
 - Migrate base HTTP client to {Faraday}[https://github.com/technoweenie/faraday]?
 - Curlify operations: To provide optional log/output of the curl command that would produce the same 
 result as the ResourceInfo#save method.
 
 == Contributing with Patches and Pull requests checklist
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -159,17 +148,19 @@ result as the ResourceInfo#save method.
 
 
 == Acknowledgements
+
 Inspired on the {Rubydora}[https://github.com/cbeer/rubydora] gem. Followed somewhat closely to {gsconfig.py}[https://github.com/dwins/gsconfig.py] 
 
 == Contributors
+
 This package is supported and maintained by Stanford University Libraries.
 
-Bess Sadler <bess@stanford.edu>
+* Renzo Sanchez-Silva <renzo.sanchez.silva@gmail.com> (Original Author)
+* Bess Sadler <bess@stanford.edu>
+* Darren Hardy <drh@stanford.edu>
 
 == License 
 
-Copyright (c) 2012 Stanford University
-
-Author: Renzo Sanchez-Silva <renzo.sanchez.silva@gmail.com>.
+Copyright (c) 2012-2013 Stanford University
 
 Licensed under the Apache License, Version 2.0

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'bundler'
 require 'bundler/gem_tasks'
+# require 'version_bumper'
 
 begin
   Bundler.setup(:default, :development)
@@ -29,7 +30,7 @@ end
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -I lib -r rgeoserver.rb"
+  sh "irb --simple-prompt -rubygems -I lib -r rgeoserver.rb"
 end
 
 desc "Execute integration tests"

data/VERSION

@@ -1 +1 @@
-0.5.9
+0.7

data/bin/batch_load.rb

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+# -*- encoding : utf-8 -*-
+#
+# RGeoServer Batch load layers (batch_demo.rb)
+# Usage: #{File.basename(__FILE__)} [input.yml]
+
+require 'rubygems'
+require 'yaml'
+require 'rgeoserver'
+require 'awesome_print'
+require 'optparse'
+
+#=  Input data. *See DATA section at end of file*
+# The input file is in YAML syntax with each record is a Hash with keys:
+# - layername
+# - filename
+# - format
+# - title
+# and optionally
+# - description
+# - keywords
+# - metadata_links
+
+#= Configuration constants
+WORKSPACE_NAME = 'rgeoserver'
+NAMESPACE = 'urn:rgeoserver'
+
+# GeoWebCache configuration
+SEED = true
+SEED_OPTIONS = {
+  :srs => {
+    :number => 4326 
+  },
+  :zoomStart => 1,
+  :zoomStop => 8,
+  :format => 'image/png',
+  :threadCount => 1
+}
+
+def main layers, flags = {}
+  return unless layers
+  datadir = flags[:datadir]
+  # Connect to the GeoServer catalog
+  cat = RGeoServer::Catalog.new
+
+  # Obtain a handle to the workspace and clean it up. 
+  ws = RGeoServer::Workspace.new cat, :name => WORKSPACE_NAME
+  ws.delete :recurse => true if flags[:delete] and not ws.new?
+  ws.save if ws.new?
+
+  # Iterate over all records in YAML file and create stores in the catalog
+  layers.each do |k, v|
+    ['layername', 'format', 'filename', 'title'].each do |id|
+      raise ArgumentError, "Layer is missing #{id}" unless v.include?(id)
+    end
+    ap v
+
+    layername = v['layername'].strip
+    format = v['format'].strip
+
+    ap "Layer: #{layername} #{format}"
+    if format == 'GeoTIFF'
+      # Create of a coverage store
+      cs = RGeoServer::CoverageStore.new cat, :workspace => ws, :name => layername
+      cs.url = File.join(datadir, v['filename'])
+      cs.description = v['description'] 
+      cs.enabled = 'true'
+      cs.data_type = format
+      cs.save
+
+      # Now create the actual coverage
+      cv = RGeoServer::Coverage.new cat, :workspace => ws, :coverage_store => cs, :name => layername 
+      cv.title = v['title'] 
+      cv.keywords = v['keywords']
+      cv.metadata_links = v['metadata_links']
+      cv.save
+
+    elsif format == 'Shapefile'
+      # Create data stores for shapefiles
+      ds = RGeoServer::DataStore.new cat, :workspace => ws, :name => layername
+      ds.description = v['description']
+      ds.connection_parameters = {
+        "url" => File.join(datadir, v['filename']),
+        "namespace" => NAMESPACE
+      }
+      ds.enabled = 'true'
+      ds.save
+
+      ft = RGeoServer::FeatureType.new cat, :workspace => ws, :data_store => ds, :name => layername 
+      ft.title = v['title'] 
+      ft.abstract = v['description']
+      ft.keywords = v['keywords']
+      ft.metadata_links = v['metadata_links']
+      ft.save
+    end
+
+    # Check if a layer has been created, extract some metadata
+    lyr = RGeoServer::Layer.new cat, :name => layername
+    if not lyr.new? and SEED
+      lyr.seed :issue, SEED_OPTIONS
+    else
+      raise NotImplementedError, "Unsupported format #{format}"
+    end
+  end
+end
+
+begin
+  flags = {
+    :delete => true,
+    :verbose => false,
+    :datadir => 'file:///data'
+  }
+  
+  OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename(__FILE__)} [-v] [--delete] [input.yml ...]"
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      flags[:verbose] = v
+    end
+    opts.on(nil, "--[no-]delete", "Delete workspaces recursively") do |v|
+      flags[:delete] = v
+    end
+    opts.on("-d DIR", "--datadir DIR", "Data directory on GeoServer (default: file:///data)") do |v|
+      flags[:datadir] = v
+    end
+  end.parse!
+  ap flags
+
+  if ARGV.size > 0
+    ARGV.each do |fn|
+      main(YAML::load_file(fn), flags)
+    end
+  else
+    main(YAML::load($stdin), flags)
+  end
+rescue SystemCallError => e
+  $stderr.puts "ERROR: #{e.message}"
+  exit(-1)
+end

data/config/defaults.yml

@@ -0,0 +1,17 @@
+geoserver:
+  # Set to the REST API for the GeoServer
+  url: "http://localhost:8080/geoserver/rest"
+  # Optional user/password, set to false to disable
+  user: "admin"
+  password: "admin"
+  # Set to your GWC server, or "builtin" for the one bundled with GeoServer
+  geowebcache_url: "builtin"
+
+  # RestClient: 
+  restclient:
+    # Set to false to disable or stdout/stderr or 'filename.out'
+    logfile: 'rgeoserver.log' #stdout
+    # Timeout (in seconds)
+    timeout: 300
+    # Open Timeout (in seconds)
+    open_timeout: 60