rgeoserver 0.5.6 → 0.5.7

data/lib/rgeoserver/featuretype.rb

@@ -2,8 +2,8 @@
 module RGeoServer
   # A feature type is a vector based spatial resource or data set that originates from a data store. In some cases, like Shapefile, a feature type has a one-to-one relationship with its data store. In other cases, like PostGIS, the relationship of feature type to data store is many-to-one, with each feature type corresponding to a table in the database.
   class FeatureType < ResourceInfo
-    OBJ_ATTRIBUTES = {:catalog => "catalog", :name => "name", :workspace => "workspace", :enabled => "enabled" }
-    OBJ_DEFAULT_ATTRIBUTES = {:catalog => nil, :workspace => nil, :coverage_store => nil, :name => nil, :enabled => "false" } 
+    OBJ_ATTRIBUTES = {:catalog => "catalog", :name => "name", :workspace => "workspace", :enabled => "enabled", :metadata_links => "metadataLinks", :title => "title", :abstract => "abstract" }
+    OBJ_DEFAULT_ATTRIBUTES = {:catalog => nil, :workspace => nil, :coverage_store => nil, :name => nil, :enabled => "false", :metadata_links => [], :title => nil, :abtract => nil } 
    
     define_attribute_methods OBJ_ATTRIBUTES.keys
     update_attribute_accessors OBJ_ATTRIBUTES
@@ -35,7 +35,24 @@ module RGeoServer
     def message
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.featureType {
-          xml.name @name
+          xml.name @name if new?
+          xml.enabled @enabled if (enabled_changed? || new?)
+          unless new?
+            xml.title @title
+            xml.abstract @abtract if abstract_changed?
+            xml.store(:class => 'featureType') {
+              xml.name @data_store.name
+            } 
+            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,8 +92,41 @@ module RGeoServer
       doc = profile_xml_to_ng profile_xml
       h = {
         "name" => doc.at_xpath('//name').text.strip, 
+        "title" => doc.at_xpath('//title/text()').to_s,
+        "abstract" => doc.at_xpath('//abstract/text()').to_s, 
         "workspace" => @workspace.name, 
-        "nativeName" => doc.at_xpath('//nativeName').to_s
+        "nativeName" => doc.at_xpath('//nativeName/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
+        },
+        "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()').to_s
+          } 
+        },
+        "attributes" => doc.xpath('//attributes/attribute').collect{ |a| 
+          {
+            'name' => a.at_xpath('//name/text()').to_s,
+            'minOccurs' => a.at_xpath('//minOccurs/text()').to_s,
+            'maxOccurs' => a.at_xpath('//maxOccurs/text()').to_s,
+            'nillable' => a.at_xpath('//nillable/text()').to_s,
+            'binding' => a.at_xpath('//binding/text()').to_s
+          }
+        }
       }.freeze  
       h  
     end

data/lib/rgeoserver/layer.rb

@@ -3,8 +3,29 @@ module RGeoServer
   # A layer is a published resource (feature type or coverage).
   class Layer < ResourceInfo
 
-    OBJ_ATTRIBUTES = {:enabled => 'enabled', :catalog => 'catalog', :name => 'name', :default_style => 'default_style', :alternate_styles => 'alternate_styles', :metadata => 'metadata', :attribution => 'attribution', :layer_type => 'type' }
-    OBJ_DEFAULT_ATTRIBUTES = {:enabled => 'true', :catalog => nil, :name => nil, :default_style => nil, :alternate_styles => [], :metadata => {}, :attribution => {:logo_height => '0', :logo_width => '0', 'title' => ''}, :layer_type => nil }
+    OBJ_ATTRIBUTES = {:enabled => 'enabled', :queryable => 'queryable', :path => 'path', :catalog => 'catalog', :name => 'name', :default_style => 'default_style', :alternate_styles => 'alternate_styles', :metadata => 'metadata', :attribution => 'attribution', :layer_type => 'type' }
+    OBJ_DEFAULT_ATTRIBUTES = {
+      :enabled => 'true', 
+      :queryable => 'true', 
+      :path => '/', 
+      :catalog => nil, 
+      :name => nil, 
+      :default_style => nil, 
+      :alternate_styles => [], 
+      :metadata => {
+        'GWC.autoCacheStyles' => 'true',
+        'GWC.gutter' => '0',
+        'GWC.enabled' => 'true',
+        'GWC.cacheFormats' => 'image/jpeg,image/png',
+        'GWC.gridSets' => 'EPSG:4326,EPSG:900913'
+      }, 
+      :attribution => {
+        'logo_height' => '0', 
+        'logo_width' => '0', 
+        'title' => ''
+      }, 
+      :layer_type => nil 
+    }
 
     define_attribute_methods OBJ_ATTRIBUTES.keys
     update_attribute_accessors OBJ_ATTRIBUTES
@@ -33,12 +54,18 @@ module RGeoServer
       nil 
     end
 
+    def update_params name_route = @name
+      { :layer => name_route }
+    end
+
     def message
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.layer { 
-          #xml.name @name
-          xml.type_ layer_type  
-          xml.enabled enabled
+          xml.name @name 
+          xml.path path 
+          xml.type_ layer_type 
+          xml.enabled @enabled 
+          xml.queryable @queryable
           xml.defaultStyle {
             xml.name default_style
           } 
@@ -52,6 +79,13 @@ module RGeoServer
           xml.resource(:class => resource.class.resource_name){
             xml.name resource.name 
           } unless resource.nil?
+          xml.metadata {
+            metadata.each_pair { |k,v|
+              xml.entry(:key => k) {
+                xml.text v
+              }
+            } 
+          }
           xml.attribution {
             xml.title attribution['title'] unless attribution['title'].empty?
             xml.logoWidth attribution['logo_width']
@@ -130,8 +164,10 @@ module RGeoServer
         "path" => doc.at_xpath('//path/text()').to_s,
         "default_style" => doc.at_xpath('//defaultStyle/name/text()').to_s,
         "alternate_styles" => doc.xpath('//styles/style/name/text()').collect{ |s| s.to_s},
+        # Types can be: VECTOR, RASTER, REMOTE, WMS
         "type" => doc.at_xpath('//type/text()').to_s,
         "enabled" => doc.at_xpath('//enabled/text()').to_s,
+        "queryable" => doc.at_xpath('//queryable/text()').to_s,
         "attribution" => { 
           "title" => doc.at_xpath('//attribution/title/text()').to_s,
           "logo_width" => doc.at_xpath('//attribution/logoWidth/text()').to_s,
@@ -148,5 +184,79 @@ module RGeoServer
       h  
     end
 
+    def workspace 
+      resource.workspace
+    end
+
+    #= GeoWebCache Operations for this layer
+    # See http://geowebcache.org/docs/current/rest/seed.html
+    # See RGeoServer::Catalog.seed_terminate for stopping pending and/or running tasks for any layer
+    #
+    # Example:
+    #  > lyr = RGeoServer::Layer.new catalog, :name => 'Arc_Sample'
+    #  > options = {
+    #    :srs => {:number => 4326 },
+    #    :zoomStart => 1,
+    #    :zoomStop => 12,
+    #    :format => 'image/png',
+    #    :threadCount => 1
+    #  }
+    #  > lyr.seed :issue, options
+
+    # @param[String] operation  
+    # @option operation[Symbol] :issue seed
+    # @option operation[Symbol] :truncate seed
+    # @option operation[Symbol] :status of the seeding thread
+    # @param[Hash] options for seed message. Read the documentation
+    def seed operation, options
+      op = operation.to_sym
+      sub_path = "seed/#{prefixed_name}.xml"
+      case op
+      when :issue
+        @catalog.do_url sub_path, :post, build_seed_request(:seed, options), {},  @catalog.gwc_client
+      when :truncate
+        @catalog.do_url sub_path, :post, build_seed_request(:truncate, options), {}, @catalog.gwc_client
+      when :status
+        raise NotImplementedError
+      end
+    end
+
+    # @param[Hash] options for seed message
+    def build_seed_request operation, options
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.seedRequest { 
+          xml.name prefixed_name
+
+          xml.srs {
+            xml.number options[:srs][:number]
+          } unless options[:srs].nil? #&& options[:srs].is_a?(Hash)
+
+          xml.bounds {
+            xml.coords {
+              options[:bounds][:coords].each { |dbl| 
+                xml.double dbl
+              } 
+            }
+          } unless options[:bounds].nil?
+
+          xml.type_ operation
+
+          [:gridSetId, :zoomStart, :zoomStop, :format, :threadCount].each { |p|
+            eval "xml.#{p.to_s} options[p]" unless options[p].nil?
+          }
+
+          xml.parameters {
+            options[:parameters].each_pair { |k,v| 
+              xml.entry {
+                xml.string k.upcase
+                xml.string v
+              }
+            }
+          } if options[:parameters].is_a?(Hash)
+        }
+      end
+      return builder.doc.to_xml
+    end
   end
+
 end 

data/lib/rgeoserver/layergroup.rb

@@ -116,7 +116,7 @@ module RGeoServer
 
     def profile_xml_to_hash profile_xml
       doc = profile_xml_to_ng profile_xml
-      name = doc.at_xpath('//name/text()').text.strip
+      name = doc.at_xpath('//name/text()').to_s
 
       h = {
         "name" => name, 

data/lib/rgeoserver/namespace.rb

@@ -0,0 +1,63 @@
+
+module RGeoServer
+  # A namespace is a uniquely identifiable grouping of feature types. A namespaces is identified by a prefix and a uri.
+  class Namespace < ResourceInfo
+
+    OBJ_ATTRIBUTES = {:enabled => 'enabled', :catalog => 'catalog', :name => 'prefix', :uri => 'uri' }
+    OBJ_DEFAULT_ATTRIBUTES = {:enabled => 'true', :catalog => nil, :name => nil }
+
+    define_attribute_methods OBJ_ATTRIBUTES.keys
+    update_attribute_accessors OBJ_ATTRIBUTES
+
+    @@route = "namespaces"
+    @@resource_name = "namespace"
+
+    def self.resource_name
+      @@resource_name
+    end
+
+    def self.root_xpath
+      "//#{@@route}/#{@@resource_name}"
+    end
+
+    def self.member_xpath
+      "//#{resource_name}"
+    end
+
+    def route
+      @@route  
+    end
+
+    def message
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.namespace { 
+          xml.prefix @name 
+          xml.uri @uri
+        }
+      end
+      return builder.doc.to_xml 
+    end
+
+    # @param [RGeoServer::Catalog] catalog
+    # @param [Hash] options
+    def initialize catalog, options
+      super({})
+      _run_initialize_callbacks do
+        @catalog = catalog
+        @name = options[:name].strip
+        @uri = options[:uri] if options[:uri]
+      end        
+      @route = route
+    end
+
+    def profile_xml_to_hash profile_xml
+      doc = profile_xml_to_ng profile_xml 
+      h = {
+        'name' => doc.at_xpath('//namespace/prefix/text()').to_s,
+        'uri' => doc.at_xpath('//namespace/uri/text()').to_s
+      }.freeze
+      h  
+    end
+
+  end
+end 

data/lib/rgeoserver/resource.rb

@@ -55,6 +55,12 @@ module RGeoServer
       def to_s
         "#{self.class.name}: #{name}"
       end
+  
+      # Return full name of resource with namespace prefix
+      def prefixed_name
+        return "#{workspace.name}:#{name}" if self.respond_to?(:workspace)
+        raise "Workspace is not defined for this resource"
+      end
 
       def create_method
         :post 
@@ -63,6 +69,12 @@ module RGeoServer
       def update_method
         :put 
       end
+  
+      # We pass the old name "name_route" in case the name of the resource is being edited
+      # Child classes should implement this
+      def update_params name_route = name
+        { self.class.resource_name.downcase.to_sym => name_route }  
+      end
 
       # Modify or save the resource
       # @param [Hash] options / query parameters
@@ -71,7 +83,15 @@ module RGeoServer
         @previously_changed = changes
         @changed_attributes.clear
         run_callbacks :save do
-          if new?
+          unless @previously_changed[:name].nil?
+            old_name, new_name = @previously_changed[:name]
+            name_route = old_name if old_name != new_name
+            update = true
+          else
+            name_route = name
+            update = false
+          end
+          if !update && new?
             if self.respond_to?(:create_route)
               raise "Resource cannot be created directly" if create_route.nil?
               route = create_route
@@ -83,8 +103,8 @@ module RGeoServer
             @catalog.add(route, message, create_method, options) 
             clear 
           else
-            options = update_options.merge(options) if self.respond_to?(:update_options)
-            route = self.respond_to?(:update_route)? update_route : {@route => @name}
+            options = update_params(name_route).merge(options)
+            route = {@route => name_route}
             @catalog.modify(route, message, update_method, options) #unless changes.empty? 
           end
 

data/lib/rgeoserver/rest_api_client.rb

@@ -10,11 +10,24 @@ module RGeoServer
     include RGeoServer::GeoServerUrlHelpers
     include ActiveSupport::Benchmarkable
 
+    # Instantiates a rest client with passed configuration
+    # @param [Hash] c configuration 
+    # return <RestClient::Resource>
+    def rest_client c    
+      RestClient::Resource.new(c[:url], :user => c[:user], :password => c[:password], :headers => c[:headers])
+    end
+
     def client config = {}
+      @client ||= rest_client(self.config.merge(config))
+    end
+
+    def gwc_client config = {}
       c = self.config.merge(config)
-      @client ||= RestClient::Resource.new(c[:url], :user => c[:user], :password => c[:password], :headers => c[:headers])
+      c[:url] = c[:geowebcache_url]
+      @gwc_client ||= rest_client(c)
     end
 
+
     def headers format
       sym = :xml || format.to_sym
       {:accept => sym, :content_type=> sym}
@@ -36,23 +49,25 @@ module RGeoServer
       end
     end
 
-    # Do an action on an arbitrary URL within the catalog passing no data
-    # Default method is GET
-    # @param [String] url
-    # @param [String] method
-    def do_url url, method = :get
-      url.slice! client.url
-      fetcher = client[url]
-      fetcher.options[:headers] ||= headers(:xml)
-      begin
-        return fetcher.get if method == :get 
-        fetcher.send method, nil
-      rescue RestClient::InternalServerError => e
-        $logger.error e.response
-        $logger.flush if $logger.respond_to? :flush
-        raise GeoServerInvalidRequest, "Error fetching URL: #{url}. See $logger for details"
-      end
-    end
+    # Do an action on an arbitrary URL path within the catalog 
+    # Default method is GET 
+    # @param [String] sub_url 
+    # @param [String] method 
+    # @param [String] data payload 
+    # @param [Hash] options for request 
+    def do_url sub_url, method = :get, data = nil, options = {}, client = client
+      sub_url.slice! client.url
+      fetcher = client[sub_url] 
+      fetcher.options.merge(options)
+      begin 
+        return fetcher.get if method == :get  
+        fetcher.send method, data 
+      rescue RestClient::InternalServerError => e 
+        $logger.error e.response 
+        $logger.flush if $logger.respond_to? :flush 
+        raise GeoServerInvalidRequest, "Error fetching URL: #{sub_url}. See $logger for details" 
+      end 
+    end 
 
     # Add resource to the catalog
     # @param [String] what

data/rgeoserver.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/rnz0/rgeoserver"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {examples,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 

data/spec/functional/resource_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe RGeoServer::ResourceInfo do
+  subject { RGeoServer::ResourceInfo.new }
+  let(:options) {
+    { 'new' => 'true' }
+  }
+  describe "#list" do
+
+  end
+
+end
+