rgeoserver 0.5.6 → 0.5.7

data/README.rdoc

@@ -2,7 +2,7 @@
 
 == RGeoServer
 
-RGeoServer is a Ruby client for the GeoServer RESTful administrative interface. 
+RGeoServer is a Ruby client for the GeoServer RESTful Configuration interface. 
 
 It provides primitive Ruby model abstraction.
 
@@ -63,13 +63,28 @@ A full sample script creating coverage stores in a small cluster:
 
   (1..7).each do |cat_id|
     cat = RGeoServer::Catalog.new :user=>'admin', :url => "http://geoserver-app#{cat_id}/rest", :password => "osgeo!"
-    ws = cat.get_workspace('cite')
+    ws = cat.get_default_workspace
     cat.list(RGeoServer::CoverageStore, layers.keys, :workspace => ws) do |cs|
-      cs.description = layers[cs.name]['description']
       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
 
@@ -89,7 +104,7 @@ To enter into an irb console with all classess loaded:
   $ rake console
 
 == Logging
-For now we use {RestClient's}[https://github.com/adamwiggins/rest-client] base logger. It can be enabled by setting:
+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'
 
@@ -117,18 +132,22 @@ or set an environment variable, for example:
 - <b>v0.5</b> - Initial alpha release
 
 == TODO
-- Handle default resources transparently.
 - Complete data stores and coverages functionality and data upload.
+- Complete updating data in objects. On failure, objects should roll back.
 - Complete documentation.
 - Complete test coverage: 
-  - Add functional tests 
+  - Add functional tests and hook to CI service (most likely travis-ci). 
+  - Break down testing into separate specs per class.
   - Add more flexibility for integration tests with embedded Jetty and other containers.
-  - Hook to CI service.
+  - Add ability to perform integration tests in a CI server.
+- Add GeoWebCache REST API operations for seeding and truncating layers.
 - Provide more examples:
   - Customize configuration.
   - Connect under SSL.
   - Batch processing.
 - Migrate base HTTP client to {Weary}[https://github.com/mwunsch/weary]?
+- 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
@@ -150,4 +169,4 @@ Inspired on the {Rubydora}[https://github.com/cbeer/rubydora] and RSolr gems. Fo
 
 Copyright (c) 2011 Renzo Sanchez-Silva <renzo@stanford.edu>.
 
-Licensed under the [MIT License](http://www.opensource.org/licenses/MIT).
+Licensed under the {MIT License}[http://www.opensource.org/licenses/MIT].

data/VERSION

@@ -1 +1 @@
-0.5.6
+0.5.7

data/config/config_defaults.yml

@@ -1,5 +1,6 @@
 geoserver:
   url: "http://localhost:8080/geoserver/rest"
+  geowebcache_url: "http://localhost:8080/geoserver/gwc/rest"
   user: admin
   password: geoserver
 ssl:

data/examples/batch_example.rb

@@ -0,0 +1,105 @@
+# -*- encoding : utf-8 -*-
+
+# RGeoServer Batch demo (batch_demo.rb)
+
+#require 'rubygems'
+require 'yaml'
+require 'rgeoserver'
+
+#=  Input data. 
+# Assume we have a YAML file (layers.yaml) with records of the form:
+
+# record_19:
+#   filename: g3881015alpha.tif
+#   title: Antietam 1867
+#   layername: antietam_1867
+#   size: 208 MB
+#   projection: GCS_WGS_1984
+#   format: GeoTIFF
+#   description: Map shows the U.S. Civil War battle of Antietam.  It indicates fortifications,
+#     roads, railroads, houses, names of residents, fences, drainage, vegetation, and
+#     relief by hachures.
+#   metadata: http://example.com/geonetwork/srv/en/fgdc.xml?id=1090 
+
+
+# After parsing we save it in the $layers variable.
+$layers = YAML::load(File.open(File.join(File.dirname(__FILE__), 'layers.yaml')))
+
+# The records will look like this
+
+# ["record_19", {"format"=>"GeoTIFF", "size"=>"208 MB", "title"=> "Antietam 1867", "metadata"=>"http://example.com/geonetwork/srv/en/fgdc.xml?id=1090", "projection"=>"GCS_WGS_1984", "filename"=>"g3881015alpha.tif", "description"=>"Map shows the U.S. Civil War battle of Antietam.  It indicates fortifications, roads, railroads, houses, names of residents, fences, drainage, vegetation, and relief by hachures.", "layername"=>"Antietam 1867"}]
+
+# Connect to the GS catalog
+$c = RGeoServer::Catalog.new :url=>"http://geoserver.example.com/geoserver/rest", :geowebcache_url => "http://geoserver.example.com/geoserver/gwc/rest", :password=>"admin", :user=>"admin" 
+
+# Obtain a handle to the workspace. 
+ws = RGeoServer::Workspace.new $c, :name => 'orbis'
+ws.delete :recurse => true unless ws.new? # comment or uncomment to start from scratch
+ws.save if ws.new?
+
+# GWC configuration
+SEED = false
+SEED_OPTIONS = {
+  :srs => {
+    :number => 4326 
+  },
+  :zoomStart => 1,
+  :zoomStop => 10,
+  :format => 'image/png',
+  :threadCount => 1
+}
+
+# Iterate over all records in YAML file and create stores in the catalog
+
+$layers.each{ |id, val|   
+  title = val['title']
+  layername = val['layername']
+  format = val['format']
+  metadata = val['metadata']
+  filename = val['filename']
+  description = val['description'
+  name = layername
+
+  if format == 'GeoTIFF'
+    begin 
+      # Create of a coverage store
+      cs = RGeoServer::CoverageStore.new $c, :workspace => ws, :name => name
+      cs.url = "file:///geo_data/staging/#{filename}"
+      cs.description = description 
+      cs.enabled = 'true'
+      cs.data_type = format
+      cs.save
+      # Now create the actual coverage
+      cv = RGeoServer::Coverage.new $c, :workspace => ws, :coverage_store => cs, :name => name 
+      cv.title = title 
+      cv.save
+      #cv.metadata_links = [{"type"=>"text/plain", "metadataType"=>"FGDC", "content"=> metadata}]
+      #cv.save
+      # Check if a layer has been created, extract some metadata
+      lyr = RGeoServer::Layer.new $c, :name => name
+      if !lyr.new? && SEED
+        lyr.seed :issue, SEED_OPTIONS
+      end
+    rescue Exception => e
+      puts e.inspect
+    end
+
+  elsif format == 'Shapefile'
+    begin 
+      # Create data stores for shapefiles
+      cs = RGeoServer::DataStore.new $c, :workspace => ws, :name => name
+      cs.connection_parameters = {
+        "url" =>  "file:///geo_data/staging/#{filename}",
+        "namespace" => "http://example.com"
+      }
+      cs.enabled = 'true'
+      cs.save
+      ft = RGeoServer::FeatureType.new $c, :workspace => ws, :data_store => cs, :name => name 
+      ft.title = title 
+      ft.abstract = description
+      ft.save
+    rescue Exception => e
+      puts e.inspect
+    end
+  end
+}

data/examples/cluster_demo.rb

@@ -0,0 +1,30 @@
+# -*- encoding : utf-8 -*-
+
+#require 'rubygems'
+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_workspace('cite')
+  RGeoServer::ResourceInfo.list(RGeoServer::CoverageStore, cat, layers.keys, :workspace => ws) do |cs|
+    cs.description = layers[cs.name]['description']  
+    cs.url = layers[cs.name]['url']  
+    cs.data_type = layers[cs.name]['type']
+    cs.enabled = 'true'
+    cs.save
+  end
+
+end

data/lib/rgeoserver.rb

@@ -8,6 +8,7 @@ module RGeoServer
   autoload :RestApiClient, "rgeoserver/rest_api_client"
   autoload :GeoServerUrlHelpers, "rgeoserver/geoserver_url_helpers"
   autoload :ResourceInfo, "rgeoserver/resource"
+  autoload :Namespace, "rgeoserver/namespace"
   autoload :Workspace, "rgeoserver/workspace"
   autoload :FeatureType, "rgeoserver/featuretype"
   autoload :Coverage, "rgeoserver/coverage"

data/lib/rgeoserver/catalog.rb

@@ -6,7 +6,6 @@ module RGeoServer
 
   class Catalog
     include RGeoServer::RestApiClient
-    include ActiveSupport::Benchmarkable
     
     attr_reader :config
 
@@ -22,11 +21,6 @@ module RGeoServer
       "Catalog: #{@config[:url]}"
     end
 
-    def client config = {}
-      c = self.config.merge(config)
-      @client ||= RestClient::Resource.new(c[:url], :user => c[:user], :password => c[:password], :headers => c[:headers])
-    end
-
     def headers format
       sym = :xml || format.to_sym
       {:accept => sym, :content_type=> sym}
@@ -67,14 +61,20 @@ module RGeoServer
 
     # @return [RGeoServer::Workspace]
     def get_default_workspace
-      dw = Workspace.new self, :name => 'default'
-      w = Workspace.new self, :name => w.name
-      raise "No default workspace is available in the catalog" unless w.new?
-      w
+      response = self.search :workspaces => 'default'
+      doc = Nokogiri::XML(response)
+      name = doc.at_xpath("#{Workspace.member_xpath}/name/text()").to_s
+      return Workspace.new self, :name => name
     end
  
-    def set_default_workspace
-      raise NotImplementedError
+    # Assign default workspace
+    # @param [String] workspace name
+    def set_default_workspace workspace
+       raise TypeError, "Workspace name must be a string" unless workspace.instance_of? String
+       dws = Workspace.new self, :name => 'default'
+       dws.name = workspace # This creates a new workspace if name is new
+       dws.save
+       dws
     end
     
     # @param [String] store
@@ -99,8 +99,8 @@ module RGeoServer
     def get_layer layer
       response = self.search :layers => layer
       doc = Nokogiri::XML(response)
-      name = doc.at_xpath(Layer.member_xpath)
-      return Layer.new self, :name => name.text if name
+      name = doc.at_xpath("#{Layer.member_xpath}/name/text()").to_s
+      return Layer.new self, :name => name
     end
 
     #= Styles (SLD Style Layer Descriptor)
@@ -119,8 +119,8 @@ module RGeoServer
     def get_style style
       response = self.search :styles => style
       doc = Nokogiri::XML(response)
-      name = doc.at_xpath(Style.member_xpath)
-      return Style.new self, :name => name.text if name
+      name = doc.at_xpath("#{Style.member_xpath}/name/text()").to_s
+      return Style.new self, :name => name
     end
 
 
@@ -132,8 +132,13 @@ module RGeoServer
       raise NotImplementedError
     end 
 
+    # @return [RGeoServer::Namespace]
     def get_default_namespace 
-      raise NotImplementedError
+      response = self.search :namespaces => 'default'
+      doc = Nokogiri::XML(response)
+      name = doc.at_xpath("#{Namespace.member_xpath}/prefix/text()").to_s
+      uri = doc.at_xpath("#{Namespace.member_xpath}/uri/text()").to_s
+      return Namespace.new self, :name => name, :uri => uri 
     end 
 
     def set_default_namespace id, prefix, uri 
@@ -229,13 +234,13 @@ module RGeoServer
     #= Configuration reloading
     # Reloads the catalog and configuration from disk. This operation is used to reload GeoServer in cases where an external tool has modified the on disk configuration. This operation will also force GeoServer to drop any internal caches and reconnect to all data stores.
     def reload
-      do_url 'reload', method = :put  
+      do_url 'reload', :put  
     end
 
     #= Resource reset
     # Resets all store/raster/schema caches and starts fresh. This operation is used to force GeoServer to drop all caches and stores and reconnect fresh to each of them first time they are needed by a request. This is useful in case the stores themselves cache some information about the data structures they manage that changed in the meantime.
     def reset
-      do_url 'reset', method = :put
+      do_url 'reset', :put
     end  
   
   end

data/lib/rgeoserver/coverage.rb

@@ -3,8 +3,8 @@ module RGeoServer
   # A coverage is a raster based data set which originates from a coverage store.
   class Coverage < ResourceInfo
 
-    OBJ_ATTRIBUTES = {:catalog => "catalog", :workspace => "workspace", :coverage_store => "coverage_store", :name => "name", :title => "title" }
-    OBJ_DEFAULT_ATTRIBUTES = {:catalog => nil, :workspace => nil, :coverage_store => nil, :name => nil, :title => nil } 
+    OBJ_ATTRIBUTES = {:catalog => "catalog", :workspace => "workspace", :coverage_store => "coverage_store", :name => "name", :title => "title", :abstract => "abstract", :metadata_links => "metadataLinks" }
+    OBJ_DEFAULT_ATTRIBUTES = {:catalog => nil, :workspace => nil, :coverage_store => nil, :name => nil, :title => nil, :abstract => nil,  :metadata_links => [] } 
    
     define_attribute_methods OBJ_ATTRIBUTES.keys
     update_attribute_accessors OBJ_ATTRIBUTES
@@ -33,7 +33,20 @@ module RGeoServer
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.coverage {
           xml.name @name
-          xml.title @title
+          xml.title @title 
+          unless new?
+            xml.nativeName @name
+            xml.abstract @abtract if abstract_changed?
+            xml.metadataLinks {
+              @metadata_links.each{ |m|
+                xml.metadataLink {
+                  xml.type_ m['type']
+                  xml.metadataType m['metadataType']
+                  xml.content m['content']
+                }
+              }
+            } if metadata_links_changed?
+          end
         }
       end
       @message = builder.doc.to_xml 
@@ -75,9 +88,33 @@ module RGeoServer
         "coverage_store" => @coverage_store.name,
         "workspace" => @workspace.name,
         "name" => doc.at_xpath('//name').text.strip,
-        "nativeName" => doc.at_xpath('//nativeName').to_s,
-        "title" => doc.at_xpath('//title').to_s,
-        "supportedFormats" => doc.xpath('//supportedFormats/string').collect{ |t| t.to_s }
+        "nativeName" => doc.at_xpath('//nativeName/text()').to_s,
+        "nativeCRS" => doc.at_xpath('//nativeCRS/text()').to_s,
+        "title" => doc.at_xpath('//title/text()').to_s,
+        "srs" => doc.at_xpath('//srs/text()').to_s,
+        "nativeBoundingBox" => { 
+          'minx' => doc.at_xpath('//nativeBoundingBox/minx/text()').to_s,
+          'miny' => doc.at_xpath('//nativeBoundingBox/miny/text()').to_s,
+          'maxx' => doc.at_xpath('//nativeBoundingBox/maxx/text()').to_s,
+          'maxy' => doc.at_xpath('//nativeBoundingBox/maxy/text()').to_s,
+          'crs' => doc.at_xpath('//nativeBoundingBox/crs/text()').to_s
+        },
+        "latLonBoundingBox" => { 
+          'minx' => doc.at_xpath('//latLonBoundingBox/minx/text()').to_s,
+          'miny' => doc.at_xpath('//latLonBoundingBox/miny/text()').to_s,
+          'maxx' => doc.at_xpath('//latLonBoundingBox/maxx/text()').to_s,
+          'maxy' => doc.at_xpath('//latLonBoundingBox/maxy/text()').to_s,
+          'crs' => doc.at_xpath('//latLonBoundingBox/crs/text()').to_s
+        },
+        "abstract" => doc.at_xpath('//abstract/text()').to_s, 
+        "supportedFormats" => doc.xpath('//supportedFormats/string').collect{ |t| t.to_s },
+        "metadataLinks" => doc.xpath('//metadataLinks/metadataLink').collect{ |m| 
+          { 
+            'type' => m.at_xpath('//type/text()').to_s, 
+            'metadataType' => m.at_xpath('//metadataType/text()').to_s,
+            'content' => m.at_xpath('//content').text.strip
+          } 
+        }
       }.freeze
       h  
     end

data/lib/rgeoserver/coveragestore.rb

@@ -32,10 +32,14 @@ module RGeoServer
       @@route % @workspace.name 
     end
 
+    def update_params name_route = @name 
+      { :name => name_route, :workspace => @workspace.name }
+    end
+
     def message
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.coverageStore {
-          xml.name @name if new?
+          xml.name @name  
           xml.workspace {
             xml.name @workspace.name
           }

data/lib/rgeoserver/datastore.rb

@@ -4,7 +4,7 @@ module RGeoServer
   class DataStore < ResourceInfo
 
     OBJ_ATTRIBUTES = {:enabled => "enabled", :catalog => "catalog", :workspace => "workspace", :name => "name", :connection_parameters => "connectionParameters"} 
-    OBJ_DEFAULT_ATTRIBUTES = {:enabled => true, :catalog => nil, :workspace => nil, :name => nil, :connection_parameters => {}}
+    OBJ_DEFAULT_ATTRIBUTES = {:enabled => 'true', :catalog => nil, :workspace => nil, :name => nil, :connection_parameters => {}}
     define_attribute_methods OBJ_ATTRIBUTES.keys
     update_attribute_accessors OBJ_ATTRIBUTES
 
@@ -41,12 +41,12 @@ module RGeoServer
     def message
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.dataStore {
-          xml.enabled true
           xml.name @name
+          xml.enabled @enabled
           xml.connectionParameters {  # this could be empty
             @connection_parameters.each_pair { |k,v| 
               xml.entry(:key => k) {
-                xml.text  v
+                xml.text v
               }
             } unless @connection_parameters.empty? 
           }