UTF-8 enhancement (#11)

Author: avvertix

readme.md

@@ -190,6 +190,8 @@ $feature = $geoserver->upload($file);
 // OneOffTech\GeoServer\Models\Resource
 ```
 
+> For file character encoding please refer to [File Character Encoding](#file-character-encoding)
+
 Once uploaded, the return value will be an instance of the `OneOffTech\GeoServer\Models\Resource`.
 It contains the details extracted by the GeoServer, like the bounding box.
 
@@ -320,6 +322,21 @@ $isSupported = StyleFile::isSupported($path);
 > For example `Geojson`, `KML` and `GPX` are not supported out-of-the-box by GeoServer,
 > although plugins might be available for doing that
 
+## File Character Encoding
+
+GeoServer can deal with character encoding of layers/features, but tests highlighted
+a limited support when using UTF-8 for data/coverage store names.
+
+To prevent issues with UTF-8 features attributes, the client set the character encoding
+to UTF-8 when uploading a file. In this way GeoServer will consider UTF-8 as the
+character encoding for features/attributes contained in the file. This do not affect
+layer or store names.
+
+As by design decision the store name is the filename, or the assigned name when 
+performing the upload, we highly reccomend to use ASCII characters for it.
+Use of UTF-8 encoded filenames (or store name) might prevent the client to retrieve the 
+store/layer corresponding to the uploaded file.
+
 ## Testing
 
 The library is covered with unit and integration tests. 

src/GeoServer.php

@@ -293,7 +293,7 @@ public function deleteCoveragestore($name)
     public function upload(GeoFile $file)
     {
         $store = GeoType::storeFor($file->type);
-        $route = $this->routes->url("workspaces/$this->workspace/$store/$file->name/file.{$file->normalizedExtension}");
+        $route = $this->routes->url("workspaces/$this->workspace/$store/$file->name/file.{$file->normalizedExtension}?charset=UTF-8");
 
         // if ZIP shpefile and name was changed from original filename
         // we need to rename all files contained in it

tests/Integration/GeoServerDataStoresTest.php

@@ -145,13 +145,37 @@ public function test_shapefile_in_zip_archive_can_be_uploaded_and_deleted()
         $this->assertEquals(69.3082, $feature->boundingBox->maxX);
         $this->assertEquals(34.57558, $feature->boundingBox->maxY);
 
-        // $this->assertTrue($this->geoserver->exist($data), "Data not existing after upload");
+        $this->assertTrue($this->geoserver->exist($data), "Data not existing after upload");
 
-        // $deleteResult = $this->geoserver->remove($data);
+        $deleteResult = $this->geoserver->remove($data);
 
-        // $this->assertTrue($deleteResult, "GeoFile not deleted");
+        $this->assertTrue($deleteResult, "GeoFile not deleted");
 
-        // $this->assertFalse($this->geoserver->exist($data), "Data still exists after remove");
+        $this->assertFalse($this->geoserver->exist($data), "Data still exists after remove");
+    }
+
+    public function test_utf8_shapefile_in_zip_archive_can_be_uploaded_and_deleted()
+    {
+        $datastoreName = 'shapefile-utf8-inside';
+        $data = GeoFile::from(__DIR__ . '/../fixtures/some_shapefile_with_cyrillicйфячыцус.zip')->name($datastoreName);
+
+        $feature = $this->geoserver->upload($data);
+
+        $this->assertInstanceOf(Feature::class, $feature);
+        $this->assertEquals(GeoType::VECTOR, $feature->type());
+        $this->assertEquals($datastoreName, $feature->name);
+        $this->assertEquals($datastoreName, $feature->title);
+        $this->assertEquals($datastoreName, $feature->nativeName);
+        $this->assertEquals("EPSG:3857", $feature->srs);
+        $this->assertTrue($feature->enabled);
+
+        $this->assertTrue($this->geoserver->exist($data), "Data not existing after upload");
+        
+        $deleteResult = $this->geoserver->remove($data);
+
+        $this->assertTrue($deleteResult, "GeoFile not deleted");
+
+        $this->assertFalse($this->geoserver->exist($data), "Data still exists after remove");
     }
 
     public function test_shapefile_in_zip_archive_can_be_renamed_during_upload_and_deleted()