geoserver-publish 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '038968f3cbde7d9a19944be64b05d0ff2d51b73d342b2828d80758389c3ee544'
-  data.tar.gz: 2876f56b1401b5f0108fce1a429b99e94c860c029ae8da417bcb429ba7d179ad
+  metadata.gz: f15ea83139e028c59e3dc2d3d121524eee34cd5507edd3e1963cbf3e8815e885
+  data.tar.gz: 6c7d862f595948a9ad717029fbbb0cfa8fa8a6307104a7710456c28d480b1646
 SHA512:
-  metadata.gz: 8506a643df04755609e2d7b02063ccde7ee22db949dd5a868267a4d029273c04afd82e633a34db2db1578bfe916ba72e0cfaa67c1eed0b08829668a7a7d7c3b8
-  data.tar.gz: a73bc4fef84d232ea2463d32b0e747706e8048487ef5558254359e547f7feba0f95dbc0cd1761dc6e4318d347e5542380f4e6a6bc794c542215c752ffc4af3a6
+  metadata.gz: 7aeac6c7210f23f29cda6e4fc31cc07ab4dbcc21f412b8fdf13344e7a7c0ac74241f3c9595bba9c66297b04e25f05e7d01f3d924ad874cd59029ade2dc28abeb
+  data.tar.gz: 00d8b594bc21686173925af5b88e50787189cd1ba57583218c11f66cba91e46c41f68f2dd10cf1ff4421962df786f5719fa14930dd191dcda5b8729625c7b278

data/README.md

@@ -44,6 +44,16 @@ Geoserver::Publish.delete_geotiff(workspace_name: "public", id: "1234")
 Geoserver::Publish.delete_shapefile(workspace_name: "public", id: "1234")
 ```
 
+#### Styles
+
+For users wanting to publish styles, this can be done using the [GeoServer styles API](https://docs.geoserver.org/latest/en/api/#1.0.0/styles.yaml).
+
+```ruby
+Geoserver::Publish::Style.new.create(style_name: "raster_layer", filename: "raster_layer.sld")
+sld = File.read("./spec/fixtures/files/payload/raster_layer.sld")
+Geoserver::Publish::Style.new.update(style_name: "raster_layer", filename: "raster_layer.sld", payload: sld)
+```
+
 ## Configuration
 
 #### Default

data/lib/geoserver/publish.rb

@@ -13,6 +13,8 @@ module Geoserver
     require "geoserver/publish/create"
     require "geoserver/publish/data_store"
     require "geoserver/publish/feature_type"
+    require "geoserver/publish/layer"
+    require "geoserver/publish/style"
     require "geoserver/publish/version"
     require "geoserver/publish/workspace"
 

data/lib/geoserver/publish/coverage.rb

@@ -19,12 +19,18 @@ module Geoserver
         JSON.parse(out) if out
       end
 
-      def create(workspace_name:, coverage_store_name:, coverage_name:, title:)
+      def create(workspace_name:, coverage_store_name:, coverage_name:, title:, additional_payload: nil)
         path = coverage_url(workspace_name: workspace_name, coverage_store_name: coverage_store_name, coverage_name: nil)
-        payload = payload_new(coverage_name: coverage_name, title: title)
+        payload = payload_new(coverage_name: coverage_name, title: title, payload: additional_payload)
         connection.post(path: path, payload: payload)
       end
 
+      def update(workspace_name:, coverage_store_name:, coverage_name:, title:, additional_payload: nil)
+        path = coverage_url(workspace_name: workspace_name, coverage_store_name: coverage_store_name, coverage_name: coverage_name)
+        payload = payload_new(coverage_name: coverage_name, title: title, payload: additional_payload)
+        connection.put(path: path, payload: payload, content_type: "application/json")
+      end
+
       private
 
         def coverage_url(workspace_name:, coverage_store_name:, coverage_name:)
@@ -32,13 +38,13 @@ module Geoserver
           "workspaces/#{workspace_name}/coveragestores/#{coverage_store_name}/coverages#{last_path_component}"
         end
 
-        def payload_new(coverage_name:, title:)
+        def payload_new(coverage_name:, title:, payload: nil)
           {
             coverage: {
               enabled: true,
               name: coverage_name,
               title: title
-            }
+            }.merge(payload.to_h)
           }.to_json
         end
     end

data/lib/geoserver/publish/coverage_store.rb

@@ -19,12 +19,18 @@ module Geoserver
         JSON.parse(out) if out
       end
 
-      def create(workspace_name:, coverage_store_name:, url:, type: "GeoTIFF")
+      def create(workspace_name:, coverage_store_name:, url:, type: "GeoTIFF", additional_payload: nil)
         path = coverage_store_url(workspace_name: workspace_name, coverage_store_name: nil)
-        payload = payload_new(workspace_name: workspace_name, coverage_store_name: coverage_store_name, url: url, type: type)
+        payload = payload_new(workspace_name: workspace_name, coverage_store_name: coverage_store_name, url: url, type: type, payload: additional_payload)
         connection.post(path: path, payload: payload)
       end
 
+      def update(workspace_name:, coverage_store_name:, url:, type: "GeoTIFF", additional_payload: nil)
+        path = coverage_store_url(workspace_name: workspace_name, coverage_store_name: coverage_store_name)
+        payload = payload_new(workspace_name: workspace_name, coverage_store_name: coverage_store_name, url: url, type: type, payload: additional_payload)
+        connection.put(path: path, payload: payload, content_type: "application/json")
+      end
+
       private
 
         def coverage_store_url(workspace_name:, coverage_store_name:)
@@ -32,7 +38,7 @@ module Geoserver
           "workspaces/#{workspace_name}/coveragestores#{last_path_component}"
         end
 
-        def payload_new(workspace_name:, coverage_store_name:, type:, url:)
+        def payload_new(workspace_name:, coverage_store_name:, type:, url:, payload:)
           {
             coverageStore: {
               name: coverage_store_name,
@@ -43,7 +49,7 @@ module Geoserver
               },
               type: type,
               _default: false
-            }
+            }.merge(payload.to_h)
           }.to_json
         end
     end

data/lib/geoserver/publish/feature_type.rb

@@ -21,12 +21,18 @@ module Geoserver
 
       # Feature type name must be the same name as the shapefile without the extenstion.
       # E.g. If the file is `12345.shp`, then feature_type_name = "12345".
-      def create(workspace_name:, data_store_name:, feature_type_name:, title:)
+      def create(workspace_name:, data_store_name:, feature_type_name:, title:, additional_payload: nil)
         path = feature_type_url(workspace_name: workspace_name, data_store_name: data_store_name, feature_type_name: nil)
-        payload = payload_new(feature_type_name: feature_type_name, title: title)
+        payload = payload_new(feature_type_name: feature_type_name, title: title, payload: additional_payload)
         connection.post(path: path, payload: payload)
       end
 
+      def update(workspace_name:, data_store_name:, feature_type_name:, title:, additional_payload: nil)
+        path = feature_type_url(workspace_name: workspace_name, data_store_name: data_store_name, feature_type_name: feature_type_name)
+        payload = payload_new(feature_type_name: feature_type_name, title: title, payload: additional_payload)
+        connection.put(path: path, payload: payload, content_type: "application/json")
+      end
+
       private
 
         def feature_type_url(workspace_name:, data_store_name:, feature_type_name:)
@@ -34,13 +40,13 @@ module Geoserver
           "workspaces/#{workspace_name}/datastores/#{data_store_name}/featuretypes#{last_path_component}"
         end
 
-        def payload_new(feature_type_name:, title:)
+        def payload_new(feature_type_name:, title:, payload:)
           {
             featureType: {
               name: feature_type_name,
               title: title,
               enabled: true
-            }
+            }.merge(payload.to_h)
           }.to_json
         end
     end

data/lib/geoserver/publish/layer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module Geoserver
+  module Publish
+    class Layer
+      attr_reader :connection
+
+      def initialize(conn = nil)
+        @connection = conn || Geoserver::Publish::Connection.new
+      end
+
+      def delete(layer_name:, workspace_name: nil)
+        path = layer_url(layer_name: layer_name, workspace_name: nil)
+        connection.delete(path: path)
+      end
+
+      def find(layer_name:, workspace_name: nil)
+        path = layer_url(layer_name: layer_name, workspace_name: workspace_name)
+        out = connection.get(path: path)
+        JSON.parse(out) if out
+      end
+
+      def update(layer_name:, workspace_name: nil, additional_payload: nil)
+        path = layer_url(layer_name: layer_name, workspace_name: workspace_name)
+        payload = additional_payload.to_h.to_json
+        connection.put(path: path, payload: payload, content_type: "application/json")
+      end
+
+      private
+
+        def layer_url(layer_name:, workspace_name: nil)
+          path = []
+          path.push("workspaces", workspace_name) if workspace_name
+          path.push "layers"
+          path.push layer_name if layer_name
+          path.join("/")
+        end
+    end
+  end
+end

data/lib/geoserver/publish/style.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module Geoserver
+  module Publish
+    ##
+    # Class for interacting with GeoServer Styles API.
+    # **NOTE** This assumes only the top level styles path /styles and does not
+    # work with workspace and layer based styles.
+    class Style
+      attr_reader :connection
+
+      def initialize(conn = nil)
+        @connection = conn || Geoserver::Publish::Connection.new
+      end
+
+      def delete(style_name:)
+        path = style_url(style_name: style_name)
+        connection.delete(path: path)
+      end
+
+      def find(style_name:)
+        path = style_url(style_name: style_name)
+        out = connection.get(path: path)
+        JSON.parse(out) if out
+      end
+
+      ##
+      # Create will update the GeoServer catalog, but not provide the style
+      def create(style_name:, filename:, additional_payload: nil)
+        path = style_url(style_name: nil)
+        payload = payload_new(style_name: style_name, filename: filename, payload: additional_payload)
+        connection.post(path: path, payload: payload)
+      end
+
+      ##
+      # Update requires and uses the payload to upload an SLD
+      def update(style_name:, filename:, payload:)
+        path = style_url(style_name: style_name)
+        connection.put(path: path, payload: payload, content_type: "application/vnd.ogc.sld+xml")
+      end
+
+      private
+
+        def style_url(style_name:)
+          last_path_component = style_name ? "/#{style_name}" : ""
+          "styles#{last_path_component}"
+        end
+
+        def payload_new(style_name:, filename:, payload: nil)
+          {
+            style: {
+              name: style_name,
+              filename: filename,
+            }.merge(payload.to_h)
+          }.to_json
+        end
+    end
+  end
+end

data/lib/geoserver/publish/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Geoserver
   module Publish
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geoserver-publish
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eliot Jordan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,13 +99,15 @@ files:
 - lib/geoserver/publish/create.rb
 - lib/geoserver/publish/data_store.rb
 - lib/geoserver/publish/feature_type.rb
+- lib/geoserver/publish/layer.rb
+- lib/geoserver/publish/style.rb
 - lib/geoserver/publish/version.rb
 - lib/geoserver/publish/workspace.rb
 homepage: https://github.com/samvera-labs/geoserver-publish
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Simple client for publishing Shapefiles and GeoTIFFs to Geoserver
 test_files: []