Module: RGeoServer::GeoServerUrlHelpers

Included in:
RestApiClient
Defined in:
lib/rgeoserver/geoserver_url_helpers.rb

Constant Summary collapse

URI_SEQUENCES =

Valid URI sequences for REST API See docs.geoserver.org/stable/en/user/rest/index.html

[
  %w{settings},
  %w{settings contact},
  %w{workspaces},
  %w{workspaces settings},
  %w{namespaces},
  %w{workspaces datastores},
  %w{workspaces datastores file},
  %w{workspaces datastores external},
  %w{workspaces datastores url},
  %w{workspaces datastores featuretypes},
  %w{workspaces coveragestores},
  %w{workspaces coveragestores file},
  %w{workspaces coveragestores coverages},
  %w{styles},
  %w{workspaces styles},
  %w{layers},
  %w{layers styles},
  %w{layergroups},
  %w{workspaces layergroups},
  %w{fonts},
  %w{templates},
  %w{services wcs settings},
  %w{services wfs settings},
  %w{services wms settings},
  %w{reload},
  %w{reset},
  %w{about}
].map {|x| x.map(&:to_sym)}
URI_REGEX =

Regexp processing for #URI_SEQUENCES

URI_SEQUENCES.map do |a|
  Regexp.new('^' + a.map {|x| x.to_s}.join('/\w+/') + '[/\w]*$')
end
URI_FORMATS =

Valid formats for REST API See docs.geoserver.org/stable/en/user/rest/api/details.html

%w{xml json html sld zip}.map(&:to_sym)

Instance Method Summary collapse

Instance Method Details

#url_for(base, options = {}) ⇒ String

See docs.geoserver.org/latest/en/user/rest/api/

  • { :workspaces => nil }

  • settings.xml

  • layers/name.xml

  • styles/name.xml

  • workspaces/name.xml

  • workspaces/name/settings.xml

  • namespaces/name.xml

  • workspaces/name/datastores/name.xml

  • workspaces/name/datastores/name/featuretype/name.xml

Parameters:

  • base, (Hash) —

    examples:

  • options (Hash) (defaults to: {})

Returns:

  • (String) —

    baseURL for REST API, e.g.,:

Raises:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/rgeoserver/geoserver_url_helpers.rb', line 60

def url_for base, options = {}
  raise GeoServerArgumentError, "options must be Hash" unless options.is_a? Hash
  if base.is_a? String
    $stderr.puts "WARNING: deprecated usage -- base should be Hash"
    base = { base.to_sym => nil } if base.is_a? String
  end

  base = Hash[base.map {|k,v| [k.to_sym, v]}] unless base.keys.select {|k| not k.is_a? Symbol}.size == 0
  
  format = (options.delete(:format) if options.include?(:format)) || :xml
  raise GeoServerArgumentError, "Unknown REST API format: '#{format}'" unless URI_FORMATS.include?(format)
  
  new_base = base.collect {|k,v| v.nil?? "#{k}" : "#{k}/#{v}"}.join('/').to_s
  new_base = new_base.gsub(%r{/$}, '')
  
  raise GeoServerArgumentError, "Invalid REST URI syntax: #{new_base} from #{base}" unless URI_REGEX.each.select {|r| r.match(new_base)}.size > 0
  
  new_base += ".#{format}"
  if not options.empty?
    new_base += "?" + options.collect {|k,v| [CGI::escape(k.to_s), CGI::escape(v.to_s)].join('=')}.join('&')
  end
  ap "url_for: #{base} #{options} => #{new_base}" if $DEBUG
  new_base
end