rgeoserver 0.5.5 → 0.5.6

data/README.rdoc

@@ -1,3 +1,5 @@
+{<img src="https://gemnasium.com/rnz0/rgeoserver.png" alt="Dependency Status" />}[https://gemnasium.com/rnz0/rgeoserver]
+
 == RGeoServer
 
 RGeoServer is a Ruby client for the GeoServer RESTful administrative interface. 
@@ -62,7 +64,7 @@ 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')
-    RGeoServer::ResourceInfo.list(RGeoServer::CoverageStore, cat, layers.keys, :workspace => ws) do |cs|
+    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']
@@ -116,11 +118,12 @@ or set an environment variable, for example:
 
 == TODO
 - Handle default resources transparently.
-- Complete data stores and coverages functionality, handle layers, styles, wmsstores and data upload.
+- Complete data stores and coverages functionality and data upload.
 - Complete documentation.
 - Complete test coverage: 
   - Add functional tests 
   - Add more flexibility for integration tests with embedded Jetty and other containers.
+  - Hook to CI service.
 - Provide more examples:
   - Customize configuration.
   - Connect under SSL.
@@ -138,7 +141,7 @@ or set an environment variable, for example:
 
 
 == Acknowledgements
-Inspired on the Rubydora and RSolr gems. Followed somewhat closely to {gsconfig.py}[https://github.com/dwins/gsconfig.py] 
+Inspired on the {Rubydora}[https://github.com/cbeer/rubydora] and RSolr gems. Followed somewhat closely to {gsconfig.py}[https://github.com/dwins/gsconfig.py] 
 
 == Contributors
 

data/VERSION

@@ -1 +1 @@
-0.5.5
+0.5.6

data/lib/rgeoserver/catalog.rb

@@ -33,6 +33,17 @@ module RGeoServer
     end
 
     #== Resources
+  
+    # Shortcut to ResourceInfo.list to this catalog. See ResourceInfo#list
+    # @param [RGeoServer::ResourceInfo.class] klass
+    # @param [RGeoServer::Catalog] catalog
+    # @param [Array<String>] names
+    # @param [Hash] options
+    # @param [bool] check_remote if already exists in catalog and cache it
+    # @yield [RGeoServer::ResourceInfo] 
+    def list klass, names, options, check_remote = false,  &block
+      ResourceInfo.list klass, self, names, options, check_remote, &block
+    end
 
     #= Workspaces
 
@@ -42,7 +53,7 @@ module RGeoServer
       response = self.search :workspaces => nil 
       doc = Nokogiri::XML(response)
       workspaces = doc.xpath(Workspace.root_xpath).collect{|w| w.text.to_s }
-      ResourceInfo.list Workspace, self, workspaces, {}, &block
+      list Workspace, workspaces, {}, &block
     end
    
     # @param [String] workspace name
@@ -80,7 +91,7 @@ module RGeoServer
       response = self.search :layers => nil 
       doc = Nokogiri::XML(response)
       layers = doc.xpath(Layer.root_xpath).collect{|l| l.text.to_s }
-      ResourceInfo.list Layer, self, layers, {}, &block
+      list Layer, layers, {}, &block
     end
    
     # @param [String] layer name
@@ -100,7 +111,7 @@ module RGeoServer
       response = self.search :styles => nil 
       doc = Nokogiri::XML(response)
       styles = doc.xpath(Style.root_xpath).collect{|l| l.text.to_s }
-      ResourceInfo.list Style, self, styles, {}, &block
+      list Style, styles, {}, &block
     end
    
     # @param [String] style name
@@ -184,10 +195,13 @@ module RGeoServer
     # @param [String] coveragestore  
     # @return [RGeoServer::CoverageStore]
     def get_coverage_store workspace, coveragestore
-      response = self.search({:workspaces => workspace, :name => coveragestore})
-      doc = Nokogiri::XML(response)
-      name = doc.at_xpath(CoverageStore.member_xpath)
-      return CoverageStore.new self, workspace, name.text if name
+      cs = CoverageStore.new self, :workspace => workspace, :name => coveragestore
+      return cs.new?? nil : cs
+    end
+
+    def get_coverage workspace, coverage_store, coverage
+      c = Coverage.new self, :workspace => workspace, :coverage_store => coverage_store, :name => coverage
+      return c.new?? nil : c    
     end
 
     #= WMS Stores (Web Map Services)
@@ -211,7 +225,19 @@ module RGeoServer
       name = doc.at_xpath(WmsStore.member_xpath)
       return WmsStore.new self, workspace, name.text if name
     end 
-    
+
+    #= 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  
+    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
+    end  
+  
   end
 
 end

data/lib/rgeoserver/coverage.rb

@@ -1,88 +1,87 @@
 
 module RGeoServer
+  # A coverage is a raster based data set which originates from a coverage store.
+  class Coverage < ResourceInfo
 
-    class Coverage < 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" } 
-     
-      define_attribute_methods OBJ_ATTRIBUTES.keys
-      update_attribute_accessors OBJ_ATTRIBUTES
+    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 } 
+   
+    define_attribute_methods OBJ_ATTRIBUTES.keys
+    update_attribute_accessors OBJ_ATTRIBUTES
 
-      @@r = Confstruct::Configuration.new(
-          :route => "workspaces/%s/coveragestores/%s/coverages",
-          :root => "coverages",
-          :resource_name => "coverage"
-        )
+    @@route = "workspaces/%s/coveragestores/%s/coverages"
+    @@root  = "coverages"
+    @@resource_name = "coverage"
 
-      def self.root
-        @@r.root
-      end
-
-      def self.create_method
-        :put 
-      end
+    def self.root
+      @@root
+    end
 
-      def self.update_method
-        :put 
-      end
+    def self.member_xpath
+      "//#{resource_name}"
+    end
 
-      def self.member_xpath
-        "//#{resource_name}"
-      end
+    def self.resource_name
+      @@resource_name
+    end
 
-      def self.resource_name
-        @@r.resource_name
-      end
+    def route
+      @@route % [@workspace.name , @coverage_store.name]
+    end
 
-      def route
-        @@r.route % [@workspace.name , @coverage_store.name]
+    def message
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.coverage {
+          xml.name @name
+          xml.title @title
+        }
       end
+      @message = builder.doc.to_xml 
+    end
 
+    # @param [RGeoServer::Catalog] catalog
+    # @param [Hash] options
+    def initialize catalog, options 
+      super({})
+      _run_initialize_callbacks do
+        @catalog = catalog
+        workspace = options[:workspace] || 'default'
+        if workspace.instance_of? String
+          @workspace = @catalog.get_workspace(workspace)
+        elsif workspace.instance_of? Workspace
+          @workspace = workspace
+        else
+          raise "Not a valid workspace"
+        end
+        coverage_store = options[:coverage_store]
+        if coverage_store.instance_of? String
+          @coverage_store = CoverageStore.new @catalog, :workspace => @workspace, :name => coverage_store
+        elsif coverage_store.instance_of? CoverageStore
+          @coverage_store = coverage_store
+        else
+          raise "Not a valid coverage store"
+        end
 
-      # @param [RGeoServer::Catalog] catalog
-      # @param [Hash] options
-      def initialize catalog, options 
-        super({})
-        _run_initialize_callbacks do
-          @catalog = catalog
-          workspace = options[:workspace] || 'default'
-          if workspace.instance_of? String
-            @workspace = @catalog.get_workspace(workspace)
-          elsif workspace.instance_of? Workspace
-            @workspace = workspace
-          else
-            raise "Not a valid workspace"
-          end
-          coverage_store = options[:coverage_store]
-          if coverage_store.instance_of? String
-            @coverage_store = CoverageStore.new @catalog, :workspace => @workspace, :name => coverage_store
-          elsif coverage_store.instance_of? CoverageStore
-            @coverage_store = coverage_store
-          else
-            raise "Not a valid coverage store"
-          end
-
-          @name = options[:name]
-          @type = options[:type]
-          @enabled = options[:enabled] || true
-          @route = route
-        end        
-      end
+        @name = options[:name]
+        @title = options[:title]
+        @enabled = options[:enabled] || true
+        @route = route
+      end        
+    end
 
-      def profile_xml_to_hash profile_xml
-        doc = profile_xml_to_ng profile_xml
-        h = {
-          "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 }
-        }.freeze
-        h  
-      end
+    def profile_xml_to_hash profile_xml
+      doc = profile_xml_to_ng profile_xml
+      h = {
+        "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 }
+      }.freeze
+      h  
+    end
 
 
-    end
+  end
 end 

data/lib/rgeoserver/coveragestore.rb

@@ -1,99 +1,89 @@
 
 module RGeoServer
+  # A coverage store is a source of spatial data that is raster based.
+  class CoverageStore < ResourceInfo
 
-    class CoverageStore < ResourceInfo
+    OBJ_ATTRIBUTES = {:catalog => 'catalog', :workspace => 'workspace', :url => 'url', :data_type => 'type', :name => 'name', :enabled => 'enabled', :description => 'description'}  
+    OBJ_DEFAULT_ATTRIBUTES = {:catalog => nil, :workspace => nil, :url => '', :data_type => 'GeoTIFF', :name => nil, :enabled => 'true', :description=>nil}  
+    define_attribute_methods OBJ_ATTRIBUTES.keys
+    update_attribute_accessors OBJ_ATTRIBUTES
 
-      OBJ_ATTRIBUTES = {:catalog => 'catalog', :workspace => 'workspace', :url => 'url', :data_type => 'type', :name => 'name', :enabled => 'enabled', :description => 'description'}  
-      OBJ_DEFAULT_ATTRIBUTES = {:catalog => nil, :workspace => nil, :url => '', :data_type => 'GeoTIFF', :name => nil, :enabled => 'true', :description=>nil}  
-      define_attribute_methods OBJ_ATTRIBUTES.keys
-      update_attribute_accessors OBJ_ATTRIBUTES
-  
-      @@r = Confstruct::Configuration.new(
-          :route => "workspaces/%s/coveragestores",
-          :root => "coverageStores",
-          :resource_name => "coverageStore"
-        )
+    @@route = "workspaces/%s/coveragestores"
+    @@root = "coverageStores"
+    @@resource_name = "coverageStore"
 
-      def self.root
-        @@r.root
-      end
-
-      def self.create_method
-        :post 
-      end
+    def self.root
+      @@root
+    end
 
-      def self.update_method
-        :put 
-      end
+    def self.resource_name
+      @@resource_name
+    end
 
-      def self.resource_name
-        @@r.resource_name
-      end
- 
-      def self.root_xpath
-        "//#{root}/#{resource_name}"
-      end
+    def self.root_xpath
+      "//#{root}/#{resource_name}"
+    end
 
-      def self.member_xpath
-        "//#{resource_name}"
-      end
+    def self.member_xpath
+      "//#{resource_name}"
+    end
 
-      def route
-        @@r.route % @workspace.name 
-      end
+    def route
+      @@route % @workspace.name 
+    end
 
-      def message
-        builder = Nokogiri::XML::Builder.new do |xml|
-          xml.coverageStore {
-            xml.name @name if new?
-            xml.workspace {
-              xml.name @workspace.name
-            }
-            xml.enabled @enabled if (enabled_changed? || new?)
-            xml.type_ @data_type if (data_type_changed? || new?)
-            xml.description @description if (description_changed? || new?)
-            xml.url @url if (url_changed? || new?)
+    def message
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.coverageStore {
+          xml.name @name if new?
+          xml.workspace {
+            xml.name @workspace.name
           }
-        end
-        @message = builder.doc.to_xml 
-      end
-
-      # @param [RGeoServer::Catalog] catalog
-      # @param [RGeoServer::Workspace|String] workspace
-      # @param [String] name
-      def initialize catalog, options 
-        super({})
-        _run_initialize_callbacks do
-          @catalog = catalog
-          workspace = options[:workspace] || 'default'
-          if workspace.instance_of? String
-            @workspace = @catalog.get_workspace(workspace)
-          elsif workspace.instance_of? Workspace
-            @workspace = workspace
-          else
-            raise "Not a valid workspace"
-          end
-          @name = options[:name].strip
-          @route = route
-        end        
+          xml.enabled @enabled if (enabled_changed? || new?)
+          xml.type_ @data_type if (data_type_changed? || new?)
+          xml.description @description if (description_changed? || new?)
+          xml.url @url if (url_changed? || new?)
+        }
       end
+      @message = builder.doc.to_xml 
+    end
 
-      def coverages &block
-        self.class.list Coverage, @catalog, profile['coverages'], {:workspace => @workspace}, check_remote = true, &block
-      end
+    # @param [RGeoServer::Catalog] catalog
+    # @param [RGeoServer::Workspace|String] workspace
+    # @param [String] name
+    def initialize catalog, options 
+      super({})
+      _run_initialize_callbacks do
+        @catalog = catalog
+        workspace = options[:workspace] || 'default'
+        if workspace.instance_of? String
+          @workspace = @catalog.get_workspace(workspace)
+        elsif workspace.instance_of? Workspace
+          @workspace = workspace
+        else
+          raise "Not a valid workspace"
+        end
+        @name = options[:name].strip
+        @route = route
+      end        
+    end
 
-      def profile_xml_to_hash profile_xml
-        doc = profile_xml_to_ng profile_xml 
-        h = {
-          'name' => doc.at_xpath('//name').text.strip, 
-          'workspace' => @workspace.name, 
-          'type' => doc.at_xpath('//type/text()').to_s,
-          'enabled' => doc.at_xpath('//enabled/text()').to_s,
-          'description' => doc.at_xpath('//description/text()').to_s,
-          'url' => doc.at_xpath('//url/text()').to_s
-        }.freeze
-        h
-      end
+    def coverages &block
+      self.class.list Coverage, @catalog, profile['coverages'], {:workspace => @workspace}, check_remote = true, &block
+    end
 
+    def profile_xml_to_hash profile_xml
+      doc = profile_xml_to_ng profile_xml 
+      h = {
+        'name' => doc.at_xpath('//name').text.strip, 
+        'workspace' => @workspace.name, 
+        'type' => doc.at_xpath('//type/text()').to_s,
+        'enabled' => doc.at_xpath('//enabled/text()').to_s,
+        'description' => doc.at_xpath('//description/text()').to_s,
+        'url' => doc.at_xpath('//url/text()').to_s
+      }.freeze
+      h
     end
+
+  end
 end 

data/lib/rgeoserver/datastore.rb

@@ -1,112 +1,102 @@
 
 module RGeoServer
+  # A data store is a source of spatial data that is vector based. It can be a file in the case of a Shapefile, a database in the case of PostGIS, or a server in the case of a remote Web Feature Service.
+  class DataStore < ResourceInfo
 
-    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 => {}}
-      define_attribute_methods OBJ_ATTRIBUTES.keys
-      update_attribute_accessors OBJ_ATTRIBUTES
- 
-      attr_accessor :message
- 
-      @@r = Confstruct::Configuration.new(
-          :route => "workspaces/%s/datastores",
-          :root => "dataStores",
-          :resource_name => "dataStore"
-        )
+    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 => {}}
+    define_attribute_methods OBJ_ATTRIBUTES.keys
+    update_attribute_accessors OBJ_ATTRIBUTES
 
-      def self.root
-        @@r.root
-      end
+    attr_accessor :message
 
-      def self.create_method
-        :post 
-      end
+    @@route = "workspaces/%s/datastores"
+    @@root = "dataStores"
+    @@resource_name = "dataStore"
 
-      def self.save_method
-        :put 
-      end
+    def self.root
+      @@root
+    end
 
-      def self.resource_name
-        @@r.resource_name
-      end
- 
-      def self.root_xpath
-        "//#{root}/#{resource_name}"
-      end
+    def self.resource_name
+      @@resource_name
+    end
 
-      def self.member_xpath
-        "//#{resource_name}"
-      end
+    def self.root_xpath
+      "//#{root}/#{resource_name}"
+    end
 
-      def route
-        @@r.route % @workspace.name
-      end
+    def self.member_xpath
+      "//#{resource_name}"
+    end
 
-      def update_route
-        "#{route}/#{@name}"
-      end
+    def route
+      @@route % @workspace.name
+    end
 
-      def message
-        builder = Nokogiri::XML::Builder.new do |xml|
-          xml.dataStore {
-            xml.enabled true
-            xml.name @name
-            xml.connectionParameters {  # this could be empty
-              @connection_parameters.each_pair { |k,v| 
-                xml.entry(:key => k) {
-                  xml.text  v
-                }
-              } unless @connection_parameters.empty? 
-            }
+    def update_route
+      "#{route}/#{@name}"
+    end
+
+    def message
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.dataStore {
+          xml.enabled true
+          xml.name @name
+          xml.connectionParameters {  # this could be empty
+            @connection_parameters.each_pair { |k,v| 
+              xml.entry(:key => k) {
+                xml.text  v
+              }
+            } unless @connection_parameters.empty? 
           }
-        end
-        builder.doc.to_xml
+        }
       end
+      builder.doc.to_xml
+    end
 
-      # @param [RGeoServer::Catalog] catalog
-      # @param [RGeoServer::Workspace|String] workspace
-      # @param [String] name
-      def initialize catalog, options 
-        super({})
-        _run_initialize_callbacks do
-          @catalog = catalog
-          workspace = options[:workspace] || 'default'
-          if workspace.instance_of? String
-            @workspace = @catalog.get_workspace(workspace)
-          elsif workspace.instance_of? Workspace
-            @workspace = workspace
-          else
-            raise "Not a valid workspace"
-          end
-          @name = options[:name].strip
-          @connection_parameters = options[:connection_parameters] || {}
-          @route = route
-        end        
-      end
+    # @param [RGeoServer::Catalog] catalog
+    # @param [RGeoServer::Workspace|String] workspace
+    # @param [String] name
+    def initialize catalog, options 
+      super({})
+      _run_initialize_callbacks do
+        @catalog = catalog
+        workspace = options[:workspace] || 'default'
+        if workspace.instance_of? String
+          @workspace = @catalog.get_workspace(workspace)
+        elsif workspace.instance_of? Workspace
+          @workspace = workspace
+        else
+          raise "Not a valid workspace"
+        end
+        @name = options[:name].strip
+        @connection_parameters = options[:connection_parameters] || {}
+        @route = route
+      end        
+    end
 
-      def featuretypes &block
-        self.class.list FeatureType, @catalog, profile['featureTypes'], {:workspace => @workspace}, check_remote = true, &block
-      end
+    def featuretypes &block
+      self.class.list FeatureType, @catalog, profile['featureTypes'], {:workspace => @workspace}, check_remote = true, &block
+    end
 
-      def profile_xml_to_hash profile_xml
-        doc = profile_xml_to_ng profile_xml
-        h = {
-          "name" => doc.at_xpath('//name').text.strip, 
-          "enabled" => doc.at_xpath('//enabled/text()').to_s,
-          "connectionParameters" => doc.xpath('//connectionParameters/entry').inject({}){ |h, e| h.merge(e['key']=> e.text.to_s) } 
-        }
-        doc.xpath('//featureTypes/atom:link/@href', "xmlns:atom"=>"http://www.w3.org/2005/Atom" ).each{ |l| 
-          h["featureTypes"] = begin
-            response = @catalog.fetch_url l.text
-            Nokogiri::XML(response).xpath('//name/text()').collect{ |a| a.text.strip }
-          rescue RestClient::ResourceNotFound
-            [] 
-          end.freeze
-          
-         }
-        h  
-      end
+    def profile_xml_to_hash profile_xml
+      doc = profile_xml_to_ng profile_xml
+      h = {
+        "name" => doc.at_xpath('//name').text.strip, 
+        "enabled" => doc.at_xpath('//enabled/text()').to_s,
+        "connectionParameters" => doc.xpath('//connectionParameters/entry').inject({}){ |h, e| h.merge(e['key']=> e.text.to_s) } 
+      }
+      doc.xpath('//featureTypes/atom:link/@href', "xmlns:atom"=>"http://www.w3.org/2005/Atom" ).each{ |l| 
+        h["featureTypes"] = begin
+          response = @catalog.do_url l.text
+          Nokogiri::XML(response).xpath('//name/text()').collect{ |a| a.text.strip }
+        rescue RestClient::ResourceNotFound
+          [] 
+        end.freeze
+        
+       }
+      h  
     end
+  end
 end