rgeoserver 0.5.1

data/lib/rgeoserver/geoserver_url_helpers.rb

@@ -0,0 +1,17 @@
+
+module RGeoServer
+  module GeoServerUrlHelpers
+    API_DOCUMENTATION = "http://docs.geoserver.org/latest/en/user/restconfig/rest-config-api.html"
+  
+    def url_for base, options = nil
+      return base unless options.is_a? Hash
+      format = options.delete(:format) || 'xml'
+      new_base = base.map{ |key,value|  value.nil?? key.to_s : [key.to_s, CGI::escape(value.to_s)].join("/")  }.join("/") 
+      new_base = new_base.gsub(/\/$/,'')
+      new_base += ".#{format}"
+      "#{new_base}" + (("?#{options.map { |key, value|  "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"}.join("&")  }" if options and not options.empty?) || '')
+
+    end
+
+  end
+end

data/lib/rgeoserver/resource.rb

@@ -0,0 +1,140 @@
+
+module RGeoServer
+
+    class ResourceInfo
+
+      include ActiveModel::Dirty
+      extend ActiveModel::Callbacks
+
+      define_model_callbacks :save, :destroy
+      define_model_callbacks :initialize, :only => :after
+
+      # mapping object parameters to profile elements
+      OBJ_ATTRIBUTES = {:enabled => 'enabled'} 
+      OBJ_DEFAULT_ATTRIBUTES = {:enabled => true}
+
+      define_attribute_methods OBJ_ATTRIBUTES.keys
+
+      def self.update_attribute_accessors attributes
+        attributes.each do |attribute, profile_name|
+          class_eval <<-RUBY
+          def #{attribute.to_s}
+            @#{attribute} || profile['#{profile_name.to_s}'] || OBJ_DEFAULT_ATTRIBUTES[:#{attribute}]
+          end
+
+          def #{attribute.to_s}= val
+            #{attribute.to_s}_will_change! unless val == #{attribute.to_s}
+            @#{attribute.to_s} = val
+          end
+          RUBY
+        end
+      end
+
+      def initialize options
+        @new = true
+      end
+
+      def to_s
+        "#{self.class.name}: #{name}"
+      end
+
+      # Add resource to Geoserver catalog      
+      def self.create options, catalog = nil
+        raise GeoServerInvalidRequest, "Can't create a #{self.class.resource_name} resource with empty name" if options[:name].nil?
+        catalog ||= RGeoServer.catalog
+        catalog.add @route, xml(options)
+        self.class.new catalog, options
+      end
+ 
+      # Modify or save the resource
+      # @param options [Hash] 
+      # @return [RGeoServer::ResourceInfo] 
+      def save options = {}
+        @previously_changed = changes
+        @changed_attributes.clear
+        run_callbacks :save do
+          if new?
+              @catalog.add(@route, message) 
+              clear 
+          else
+            @catalog.modify({@route => @name}, message) #unless changes.empty? 
+          end
+
+          self
+        end
+      end
+     
+      # Purge resource from Geoserver Catalog
+      # @param options [Hash] 
+      # @return [RGeoServer::ResourceInfo] `self`
+      def delete options = {} 
+        run_callbacks :destroy do
+          @catalog.purge({@route => @name}, options)  unless new?
+          clear
+          self
+        end
+      end
+      
+      # Check if this resource already exists
+      # @return [Boolean]
+      def new?
+        profile
+        @new
+      end
+
+      def clear
+        @profile = nil
+        @changed_attributes = {}
+      end
+
+      # Retrieve the resource profile as a hash and cache it 
+      # @return [Hash]        
+      def profile
+        if @profile 
+          return @profile
+        end
+    
+        @profile ||= begin
+          h = profile_xml_to_hash(@catalog.search @route => @name )
+          @new = false
+          h
+        rescue RestClient::ResourceNotFound
+          # The resource is new
+          @new = true
+          {}
+        end.freeze 
+      end
+
+      def profile= profile_xml
+        @profile = profile_xml_to_hash(profile_xml)
+      end
+
+      def profile_xml_to_ng profile_xml
+        Nokogiri::XML(profile_xml).xpath(self.class.member_xpath)
+      end
+ 
+      def profile_xml_to_hash profile_xml
+        doc = profile_xml_to_ng profile_xml 
+        h = {'name' => doc.at_xpath('//name').text.strip, 'enabled' => @enabled }
+        doc.xpath('//atom:link/@href', "xmlns:atom"=>"http://www.w3.org/2005/Atom" ).each{ |l| 
+          target = l.text.match(/([a-zA-Z]+)\.xml$/)[1]
+          if !target.nil? && target != l.parent.parent.name.to_s.downcase
+            begin
+              h[l.parent.parent.name.to_s] << target
+            rescue
+              h[l.parent.parent.name.to_s] = []
+            end
+          else
+            h[l.parent.parent.name.to_s] = begin
+              response = @catalog.fetch_url l.text
+              Nokogiri::XML(response).xpath('//name/text()').collect{ |a| a.text }
+            rescue RestClient::ResourceNotFound
+              []
+            end.freeze
+          end
+         }
+        h  
+      end
+
+    end
+end 

data/lib/rgeoserver/rest_api_client.rb

@@ -0,0 +1,103 @@
+
+require 'logger'
+$logger = Logger.new(STDOUT)
+$logger.level = Logger::WARN
+
+
+module RGeoServer
+  module RestApiClient
+
+    include RGeoServer::GeoServerUrlHelpers
+    include ActiveSupport::Benchmarkable
+
+    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}
+    end
+
+    # Search a resource in the catalog
+    # @param [OrderedHash] what
+    # @param [Hash] options
+    def search what, options = {}
+      resources = client[url_for(what, options)]
+      resources.options[:headers] ||= headers(:xml)
+      begin
+        return resources.get
+      rescue RestClient::InternalServerError => e
+        $logger.error e.response
+        $logger.flush if $logger.respond_to? :flush
+        raise GeoServerInvalidRequest, "Error listing #{what.inspect}. See $logger for details"
+      end
+    end
+
+    # Fetch an arbitrary URL within the catalog
+    # @param [String] url
+    def fetch_url url
+      url.slice! client.url
+      fetcher = client[url]
+      fetcher.options[:headers] ||= headers(:xml)
+      begin  
+        return fetcher.get
+      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
+
+    # Add resource to the catalog
+    # @param [String] what
+    # @param [String] message
+    # @param [Symbol] method
+    def add what, message, method = :post
+      request = client[url_for(what)]
+      request.options[:headers] ||= headers(:xml)
+      begin 
+        return request.send method, message
+      rescue RestClient::InternalServerError => e
+        $logger.error e.response
+        $logger.flush if $logger.respond_to? :flush
+        raise GeoServerInvalidRequest, "Error adding #{what.inspect}. See logger for details"
+      end
+      
+    end
+
+    # Modify resource in the catalog
+    # @param [String] what
+    # @param [String] message
+    def modify what, message
+      request = client[url_for(what, {})]
+      request.options[:headers] ||= headers(:xml) 
+      $logger.debug "Modifying: \n #{message}"
+      begin 
+        return request.put message
+      rescue RestClient::InternalServerError => e
+        $logger.error e.response
+        $logger.flush if $logger.respond_to? :flush
+        raise GeoServerInvalidRequest, "Error modifying #{what.inspect}. See $logger for details"
+      end
+      
+    end
+
+    # Purge resource from the catalog. Options can include recurse=true or false
+    # @param [OrderedHash] what
+    # @param [Hash] options
+    def purge what, options
+      request = client[url_for(what, options)]
+      begin
+        return request.delete
+      rescue RestClient::InternalServerError => e 
+        $logger.error e.response
+        $logger.flush if $logger.respond_to? :flush
+        raise GeoServerInvalidRequest, "Error deleting #{what.inspect}. See $logger for details"
+      end
+    end
+
+  end
+end

data/lib/rgeoserver/version.rb

@@ -0,0 +1,9 @@
+module RGeoServer
+  unless RGeoServer.const_defined? :VERSION
+    def self.version
+      @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+    end
+    
+    VERSION = self.version 
+  end
+end

data/lib/rgeoserver/wmsstore.rb

@@ -0,0 +1,100 @@
+
+module RGeoServer
+
+    class WmsStore < ResourceInfo
+  
+      define_attribute_methods [:catalog, :workspace, :name] 
+  
+      @@r = Confstruct::Configuration.new(
+          :route => "workspaces/%s/wmsstores",
+          :root => "wmsStores",
+          :resource_name => "wmsStore"
+        )
+
+      def self.root
+        @@r.root
+      end
+
+      def self.method
+        :put 
+      end
+
+      def self.resource_name
+        @@r.resource_name
+      end
+ 
+      def self.root_xpath
+        "//#{root}/#{resource_name}"
+      end
+
+      def self.member_xpath
+        "//#{resource_name}"
+      end
+
+      def route
+        @@r.route % @workspace.name 
+      end
+
+      def xml options = nil
+        <<-cs
+          <wmsStore>
+          <enabled>true</enabled>
+          <name>#{name}</name>
+          <workspace><name>#{workspace_name}</name></workspace>
+         </wmsStore>
+        cs
+      end
+
+      def name
+        @name      
+      end
+
+      def workspace
+        @workspace
+      end 
+
+      def catalog
+        @catalog
+      end
+
+      def workspace_name
+        @workspace.name
+      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 name= val
+        name_will_change! unless val == @name
+        @name = val
+      end
+
+      def workspace= val
+        workspace_will_change! unless val == @workspace
+        @workspace = val
+      end
+
+      def catalog= val
+        catalog_will_change! unless val == @catalog
+        @catalog = val
+      end
+
+    end
+end 

data/lib/rgeoserver/workspace.rb

@@ -0,0 +1,74 @@
+
+module RGeoServer
+
+    class Workspace < ResourceInfo
+
+      OBJ_ATTRIBUTES = {:enabled => 'enabled', :catalog => 'catalog', :name => 'name' }
+      OBJ_DEFAULT_ATTRIBUTES = {:enabled => true, :catalog => nil, :name => nil }
+
+      define_attribute_methods OBJ_ATTRIBUTES.keys
+      update_attribute_accessors OBJ_ATTRIBUTES
+
+      @@r = Confstruct::Configuration.new(:route => 'workspaces', :resource_name => 'workspace')
+  
+      def self.resource_name
+        @@r.resource_name
+      end
+
+      def self.method 
+        :post 
+      end
+ 
+      def self.root_xpath
+        "//#{@@r.route}/#{@@r.resource_name}"
+      end
+
+      def self.member_xpath
+        "//#{resource_name}"
+      end
+
+      def route
+        @@r.route  
+      end
+
+      def message
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.workspace { 
+            xml.enabled @enabled if enabled_changed?
+            xml.name @name 
+          }
+        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
+        end        
+        @route = route
+      end
+
+      def data_stores
+        profile['dataStores'].collect{ |name| 
+          DataStore.new @catalog, :workspace => self, :name => name if name 
+        }
+      end
+    
+      def coverage_stores
+        profile['coverageStores'].collect{ |name| 
+          CoverageStore.new @catalog, :workspace => self, :name => name if name 
+        }
+      end
+
+      def wms_stores
+        profile['wmsStores'].collect{ |name| 
+          WmsStore.new @catalog, :workspace => self, :name => name if name 
+        }
+      end
+ 
+    end
+end