Merge pull request #32 from themue/maintenance/31/status-code

Added status codes and some doc renamings
tideland · Nov 10, 2017 · 22ece46 · 22ece46
2 parents bcd39d5 + 3fcc4e2
commit 22ece46
Show file tree

Hide file tree

Showing 41 changed files with 75 additions and 64 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,22 +1,27 @@
-# Tideland Go REST Server Library
+# Tideland GoREST
 
-## 2017-10-25
+## Version 2.15.5 (2017-11-09)
+
+- Added needed status codes
+- Renamings in docs and comments due to new project name
+
+## Version 2.15.4 (2017-10-25)
 
 - Function `jwt.AddTokenToRequest()` is deprecated, now it
   is `AddToRequest()`; sadly forgot backward compatability,
   so now are both available but first with an according
   comment
 
-## 2017-09-10
+## Version 2.15.3 (2017-09-10)
 
 - Fixed return code in case of not implemented HTTP methods
   to `405` (method not allowed)
 
-## 2017-06-19
+## Version 2.15.2 (2017-06-19)
 
 - Reduced job handling complexity
 
-## 2017-05-15
+## Version 2.15.1 (2017-05-15)
 
 - Changed `Job.Path()` to return a `Path` instance
 - This instance provides access to the different parts
@@ -26,7 +31,7 @@
   `ResourceID()`) while the method `ResourceID()` of path
   returns only the third part of the path
 
-## 2017-04-26
+## Version 2.15.0 (2017-04-26)
 
 - Added access to URL path parts via `Job.Path()`
 - Added interfaces for handler methods directly mapping

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-# Tideland Go REST Server Library
+# Tideland GoREST
 
 ## Description
 
-The *Tideland Go REST Server Library* helps developing RESTful server
-systems. It provides a convenient mapping of URL to handlers and methods
-specific to the called HTTP method. Additionally there are helpers for
-marshalling and unmarshalling.
+*Tideland GoREST* helps developing RESTful server systems. It
+provides a convenient mapping of URL to handlers and methods
+specific to the called HTTP method. Additionally there are helpers
+for marshalling and unmarshalling.
 
 The library earlier has been known as `web` package of the
 [Tideland Go Library](https://github.com/tideland/golib).
@@ -20,7 +20,7 @@ I hope you like it. ;)
 
 ## Version
 
-Version 2.15.4
+Version 2.15.5
 
 ## Packages
 

diff --git a/handlers/audit.go b/handlers/audit.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Handlers - Audit Handler
+// Tideland GoREST - Handlers - Audit Handler
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/handlers/doc.go b/handlers/doc.go
@@ -1,12 +1,12 @@
-// Tideland Go REST Server Library - Handlers
+// Tideland GoREST - Handlers
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //
 // All rights reserved. Use of this source code is governed
 // by the new BSD license.
 
-// Package handlers of the Tideland Go REST Server Library implements
-// some initial resource handlers to integrate into own solutions.
+// Package handlers of Tideland GoREST implements some initial
+// resource handlers to integrate into own solutions.
 package handlers
 
 // EOF
diff --git a/handlers/errors.go b/handlers/errors.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Handlers - Errors
+// Tideland GoREST - Handlers - Errors
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/handlers/fileserve.go b/handlers/fileserve.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Handlers - File Serve
+// Tideland GoREST - Handlers - File Serve
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/handlers/fileupload.go b/handlers/fileupload.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Handlers - File Upload
+// Tideland GoREST - Handlers - File Upload
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/handlers/handlers_test.go b/handlers/handlers_test.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Handlers - Unit Tests
+// Tideland GoREST - Handlers - Unit Tests
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/handlers/jwtauth.go b/handlers/jwtauth.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Handlers - JWT Authorization
+// Tideland GoREST - Handlers - JWT Authorization
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/handlers/wrapper.go b/handlers/wrapper.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Handlers - Wrapper
+// Tideland GoREST - Handlers - Wrapper
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/algorithm.go b/jwt/algorithm.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Algorithm
+// Tideland GoREST - JSON Web Token - Algorithm
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/cache.go b/jwt/cache.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Cache
+// Tideland GoREST - JSON Web Token - Cache
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/cache_test.go b/jwt/cache_test.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Unit Tests
+// Tideland GoREST - JSON Web Token - Unit Tests
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/claims.go b/jwt/claims.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Claims
+// Tideland GoREST - JSON Web Token - Claims
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/claims_test.go b/jwt/claims_test.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Unit Tests
+// Tideland GoREST - JSON Web Token - Unit Tests
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/doc.go b/jwt/doc.go
@@ -1,11 +1,11 @@
-// Tideland Go REST Server Library - JSON Web Token
+// Tideland GoREST - JSON Web Token
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //
 // All rights reserved. Use of this source code is governed
 // by the new BSD license.
 
-// Package jwt of the Tideland Go REST Server Library provides the generation,
+// Package jwt of Tideland GoREST provides the generation,
 // verification, and analyzing of JSON Web Tokens.
 package jwt
 

diff --git a/jwt/errors.go b/jwt/errors.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Errors
+// Tideland GoREST - JSON Web Token - Errors
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/header.go b/jwt/header.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Header
+// Tideland GoREST - JSON Web Token - Header
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/header_test.go b/jwt/header_test.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Unit Tests
+// Tideland GoREST - JSON Web Token - Unit Tests
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/jwt.go b/jwt/jwt.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token
+// Tideland GoREST - JSON Web Token
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/jwt_test.go b/jwt/jwt_test.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Unit Tests
+// Tideland GoREST - JSON Web Token - Unit Tests
 //
 // Copyright (C) 2016 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/jwt/key.go b/jwt/key.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - JSON Web Token - Keys
+// Tideland GoREST - JSON Web Token - Keys
 //
 // Copyright (C) 2016-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/request/doc.go b/request/doc.go
@@ -1,13 +1,12 @@
-// Tideland Go REST Server Library - Request
+// Tideland GoREST - Request
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //
 // All rights reserved. Use of this source code is governed
 // by the new BSD license.
 
-// Package request of the Tideland Go REST Server Library provides
-// a simple way to handle cross-server requests in the Tideland
-// REST ecosystem.
+// Package request of Tideland GoREST provides a simple way to
+// handle cross-server requests in the Tideland REST ecosystem.
 package request
 
 //--------------------

diff --git a/request/errors.go b/request/errors.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Request - Errors
+// Tideland GoREST - Request - Errors
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/request/request.go b/request/request.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Request
+// Tideland GoREST - Request
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/request/request_test.go b/request/request_test.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - Request - Unit Tests
+// Tideland GoREST - Request - Unit Tests
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/context.go b/rest/context.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Context
+// Tideland GoREST - REST - Context
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/doc.go b/rest/doc.go
@@ -1,12 +1,12 @@
-// Tideland Go REST Server Library - REST
+// Tideland GoREST - REST
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //
 // All rights reserved. Use of this source code is governed
 // by the new BSD license.
 
-// Package rest of the Tideland Go REST Server Library provides types for
-// the implementation of servers with a RESTful API. The business has to
+// Package rest of Tideland GoREST provides types for the
+// implementation of servers with a RESTful API. The business has to
 // be implemented in types fullfilling the ResourceHandler interface.
 // This basic interface only allows the initialization of the handler.
 // More interesting are the other interfaces like GetResourceHandler

diff --git a/rest/environment.go b/rest/environment.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Environment
+// Tideland GoREST - REST - Environment
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/errors.go b/rest/errors.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Errors
+// Tideland GoREST - REST - Errors
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/formatter.go b/rest/formatter.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Formatter
+// Tideland GoREST - REST - Formatter
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //
@@ -40,6 +40,13 @@ const (
 	StatusUnauthorized        = http.StatusUnauthorized
 	StatusForbidden           = http.StatusForbidden
 	StatusNotFound            = http.StatusNotFound
+	StatusMethodNotAllowed    = http.StatusMethodNotAllowed
+	StatusNotAcceptable       = http.StatusNotAcceptable
+	StatusGone                = http.StatusGone
+	StatusPreconditionFailed  = http.StatusPreconditionFailed
+	StatusUnprocessableEntity = http.StatusUnprocessableEntity
+	StatusLocked              = http.StatusLocked
+	StatusTooManyRequests     = http.StatusTooManyRequests
 	StatusConflict            = http.StatusConflict
 	StatusInternalServerError = http.StatusInternalServerError
 )

diff --git a/rest/handler.go b/rest/handler.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Handlers
+// Tideland GoREST - REST - Handlers
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/job.go b/rest/job.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Job
+// Tideland GoREST - REST - Job
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/mapping.go b/rest/mapping.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Mapping
+// Tideland GoREST - REST - Mapping
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/multiplexer.go b/rest/multiplexer.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Multiplexer
+// Tideland GoREST - REST - Multiplexer
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/path.go b/rest/path.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Path
+// Tideland GoREST - REST - Path
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/rest_test.go b/rest/rest_test.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Unit Tests
+// Tideland GoREST - REST - Unit Tests
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/templates.go b/rest/templates.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - templatesCache
+// Tideland GoREST - REST - Templates
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/rest/tools.go b/rest/tools.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST - Tools
+// Tideland GoREST - REST - Tools
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //

diff --git a/restaudit/doc.go b/restaudit/doc.go
@@ -1,15 +1,15 @@
-// Tideland Go REST Server Library - REST Audit
+// Tideland GoREST - REST Audit
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //
 // All rights reserved. Use of this source code is governed
 // by the new BSD license.
 
-// Package restaudit of the Tideland Go REST Server Library is a little
-// helper package for the unit testing of the rest package and the
-// resource handlers. Requests can easily be created, marshalling data
-// based on the content-type is done automatically. Response also
-// provides assert methods for the tests.
+// Package restaudit of Tideland GoREST is a little helper package
+// for the unit testing of the rest package and the resource handlers.
+// Requests can easily be created, marshalling data based on the
+// content-type is done automatically. Response also provides assert
+// methods for the tests.
 //
 // So first step is to create a test server and register the handler(s)
 // to test. Could best be done with a little helper function, depending

diff --git a/restaudit/restaudit.go b/restaudit/restaudit.go
@@ -1,4 +1,4 @@
-// Tideland Go REST Server Library - REST Audit
+// Tideland GoREST - REST Audit
 //
 // Copyright (C) 2009-2017 Frank Mueller / Tideland / Oldenburg / Germany
 //