rgeoserver 0.5.1

data/.gitignore

@@ -0,0 +1,12 @@
+coverage
+coverage.data
+pkg
+rdoc
+doc
+.yardoc
+.bundle
+.rvmrc
+Gemfile.lock
+.DS_Store
+.swp
+.swo

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+#gem 'rake', '0.8.7'
+gem 'activemodel', "~> 3.1.1"
+
+

data/README.rdoc

@@ -0,0 +1,80 @@
+== RGeoServer
+
+RGeoServer is a Ruby client for the GeoServer RESTful administrative interface. 
+
+It provides primitive Ruby model abstraction.
+
+== Documentation
+The GeoServer REST Configuration API Reference can be found here:
+
+http://docs.geoserver.org/stable/en/user/restconfig/rest-config-api.html
+
+ 
+== Installation 
+
+  $ gem install rgeoserver
+
+
+== Example: 
+
+  > 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') 
+  => 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"]} 
+  > ft = ds.featuretypes.first
+  => RGeoServer::FeatureType: states 
+  > ft.profile
+  => {:name=>"states", :workspace=>"topp", :nativeName=>"states"}  
+
+== 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']
+
+To generate the documentation run:
+  > rake yard
+
+To enter into an irb console with all classess loaded:
+  > rake console
+
+== 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]
+* {GeoTools}[http://geotools.org/]
+* Implementation in other languages: 
+  * Python: {gsconfig.py}[https://github.com/dwins/gsconfig.py]
+
+== Release History
+
+- <b>v0.5.0</b> - Initial alpha release
+
+== TODO
+- Complete stores and coverages functionality, handle Layers, styles and data upload.
+- Complete documentaion and test coverage. Add more flexibility for integration tests with embedded Jetty and other containers.
+- Migrate base HTTP client to {Weary}[https://github.com/mwunsch/weary]?
+
+== 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
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+== Acknowledgements
+Inspired on the Rubydora and RSolr gems. Followed somewhat closely to {gsconfig.py}[https://github.com/dwins/gsconfig.py] 
+
+== Contributors
+
+
+== License 
+
+Copyright (c) 2011 Renzo Sanchez-Silva <renzo@stanford.edu>.
+
+Licensed under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+# Get your spec rake tasks working in RSpec 2.0
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--readme", "README.rdoc"]
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r rgeoserver.rb"
+end
+
+desc "Execute integration tests"
+task :integration, :jetty_home, :jetty_port, :java_opts do |t, args| 
+
+  require 'jettywrapper'
+  jetty_params = {
+    :jetty_home => args.jetty_home,
+    :java_opts => [args.java_opts], 
+    :jetty_port => args.jetty_port, 
+    :quiet => true,
+    :startup_wait => 20
+  }
+
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.1

data/config/config_defaults.yml

@@ -0,0 +1,9 @@
+geoserver:
+  url: "http://localhost:8080/geoserver/rest"
+  user: admin
+  password: geoserver
+ssl:
+  cert_file:
+  key_file:
+  key_pass: ""
+

data/lib/rgeoserver.rb

@@ -0,0 +1,45 @@
+require 'active_model'
+require 'yaml'
+
+module RGeoServer
+  autoload :Config, "rgeoserver/config"
+  autoload :Catalog, "rgeoserver/catalog"
+  autoload :RestApiClient, "rgeoserver/rest_api_client"
+  autoload :GeoServerUrlHelpers, "rgeoserver/geoserver_url_helpers"
+  autoload :ResourceInfo, "rgeoserver/resource"
+  autoload :Workspace, "rgeoserver/workspace"
+  autoload :FeatureType, "rgeoserver/featuretype"
+  autoload :Coverage, "rgeoserver/coverage"
+  autoload :DataStore, "rgeoserver/datastore"
+  autoload :CoverageStore, "rgeoserver/coveragestore"
+  autoload :WmsStore, "rgeoserver/wmsstore"
+
+  require 'restclient'
+  require 'nokogiri'
+  require 'time'
+  require 'rgeoserver/version'
+
+  def self.connect *args
+    Catalog.new *args
+  end
+
+  def self.catalog
+    @catalog ||= self.connect(self.default_config.geoserver)
+  end 
+
+  def self.catalog= catalog
+    @catalog = catalog
+  end
+
+  def self.default_config *args, &block
+    Config.configure *args, &block
+  end
+
+
+  class RGeoServerError < StandardError
+  end
+
+  class GeoServerInvalidRequest < RGeoServerError
+  end
+
+end

data/lib/rgeoserver/catalog.rb

@@ -0,0 +1,169 @@
+module RGeoServer
+  # This class represents the main class of the data model.
+  # Refer to 
+  # - http://geoserver.org/display/GEOS/Catalog+Design
+  # - http://docs.geoserver.org/stable/en/user/restconfig/rest-config-api.html#workspaces
+
+  class Catalog
+    include RGeoServer::RestApiClient
+    include ActiveSupport::Benchmarkable
+    
+    attr_reader :config
+
+    # @param [OrderedHash] options
+    # @option options [String] :url
+    # @option options [String] :user
+    # @option options [String] :password
+    def initialize options = {}
+      @config = options
+    end
+
+    def to_s
+      "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}
+    end
+
+    # List of workspaces available
+    # @return [Array<RGeoServer::Workspace>]
+    def get_workspaces
+      response = self.search :workspaces => nil 
+      doc = Nokogiri::XML(response)
+      doc.xpath(Workspace.root_xpath).collect { |w| Workspace.new self, :name => w.text } 
+    end
+   
+    # @param [String] workspace
+    # @return [<RGeoServer::Workspace]
+    def get_workspace workspace
+      response = self.search :workspaces => workspace
+      doc = Nokogiri::XML(response)
+      name = doc.at_xpath(Workspace.member_xpath)
+      return Workspace.new self, :name => name.text if name
+    end
+
+    # @return [<RGeoServer::Workspace]
+    def get_default_workspace
+      return Workspace.new self, :name => 'default'
+    end
+ 
+    def set_default_workspace
+      raise NotImplementedError
+    end
+    
+    # @param [String] store
+    # @param [String] workspace
+    def reassign_workspace store, workspace
+      pass
+    end
+
+    # List of feature types
+    # @return [Array<RGeoServer::Namespace>]
+    # TODO: Implement when the stable release includes it
+    def get_namespaces 
+      raise NotImplementedError
+    end 
+
+    def get_default_namespace 
+      raise NotImplementedError
+    end 
+
+    def set_default_namespace id, prefix, uri 
+      raise NotImplementedError
+    end 
+
+    #= Data Stores (Vector datasets)
+
+    # List of vector based spatial data
+    # @param [String] workspace
+    # @return [Array<RGeoServer::DataStore>]
+    def get_data_stores workspace = nil 
+      ws = workspace.nil?? get_workspaces :  [get_workspace(workspace)] 
+      ds = []
+      ws.each{ |w| ds += w.data_stores if w.data_stores }  
+      ds 
+    end
+     
+    # @param [String] workspace
+    # @param [String] datastore  
+    # @return [RGeoServer::DataStore]
+    def get_data_store workspace, datastore
+      response = self.search({:workspaces => workspace, :name => datastore})
+      doc = Nokogiri::XML(response)
+      name = doc.at_xpath(DataStore.member_xpath)
+      return DataStore.new self, workspace, name.text if name
+    end
+  
+    # List of feature types
+    # @param [String] workspace
+    # @param [String] datastore 
+    # @return [Array<RGeoServer::FeatureType>]
+    def get_feature_types workspace, datastore
+      pass  
+
+    end
+
+    # @param [String] workspace
+    # @param [String] datastore  
+    # @param [String] featuretype_id  
+    # @return [RGeoServer::FeatureType]
+    def get_feature_type workspace, datastore, featuretype_id
+      pass  
+  
+    end    
+
+
+    #= Coverages (Raster datasets) 
+    
+    # List of coverage stores
+    # @param [String] workspace
+    # @return [Array<RGeoServer::CoverageStore>]
+    def get_coverage_stores workspace = nil
+      ws = workspace.nil?? get_workspaces :  [get_workspace(workspace)] 
+      cs = []
+      ws.each{ |w| cs += w.coverage_stores if w.coverage_stores }  
+      cs 
+    end
+
+    # @param [String] workspace
+    # @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
+    end
+
+    #= WMS Stores (Web Map Services)
+    # TODO: Implement when the stable release includes it
+    # List of WMS stores.
+    # @param [String] workspace  
+    # @return [Array<RGeoServer::WmsStore>]
+    def get_wms_stores workspace = nil
+      ws = workspace.nil?? get_workspaces :  [get_workspace(workspace)] 
+      cs = []
+      ws.each{ |w| cs += w.wms_stores if w.wms_stores }  
+      cs 
+    end
+
+    # @param [String] workspace
+    # @param [String] wmsstore  
+    # @return [RGeoServer::WmsStore]
+    def get_wms_store workspace, wmsstore
+      response = self.search({:workspaces => workspace, :name => wmsstore})
+      doc = Nokogiri::XML(response)
+      name = doc.at_xpath(WmsStore.member_xpath)
+      return WmsStore.new self, workspace, name.text if name
+    end 
+    
+  end
+
+end

data/lib/rgeoserver/config.rb

@@ -0,0 +1,7 @@
+require 'confstruct/configuration'
+
+module RGeoServer
+  Config = Confstruct::Configuration.new(YAML.load(File.read(File.expand_path('../../../config/config_defaults.yml', __FILE__))))
+end
+
+

data/lib/rgeoserver/coverage.rb

@@ -0,0 +1,84 @@
+
+module RGeoServer
+
+    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
+
+      @@r = Confstruct::Configuration.new(
+          :route => "workspaces/%s/coveragestores/%s/coverages",
+          :root => "coverages",
+          :resource_name => "coverage"
+        )
+
+      def self.root
+        @@r.root
+      end
+
+      def self.method
+        :put 
+      end
+
+      def self.member_xpath
+        "//#{resource_name}"
+      end
+
+      def self.resource_name
+        @@r.resource_name
+      end
+
+      def route
+        @@r.route % [@workspace.name , @coverage_store.name]
+      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
+
+      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()').text.strip,
+          "nativeName" => doc.at_xpath('//nativeName/text()').to_s,
+          "title" => doc.at_xpath('//title/text()').to_s,
+          "supportedFormats" => doc.xpath('//supportedFormats/string/text()').collect{ |t| t.to_s }
+        }.freeze
+        h  
+      end
+
+
+    end
+end