go-aah/aah#186 deprecated cleanup in ahttp lib

Author: jeevatkm

gzip_response.go

@@ -29,28 +29,6 @@ var (
 	_ ResponseWriter     = (*GzipResponse)(nil)
 )
 
-//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
-// Package methods
-//___________________________________
-
-// TODO for old method cleanup
-
-// GetGzipResponseWriter wraps `http.ResponseWriter`, returns aah framework response
-// writer that allows to advantage of response process.
-// Deprecated use `WrapGzipWriter` instead.
-func GetGzipResponseWriter(w ResponseWriter) ResponseWriter {
-	gr := grPool.Get().(*GzipResponse)
-	gr.gw = acquireGzipWriter(w)
-	gr.r = w.(*Response)
-	return gr
-}
-
-// PutGzipResponseWiriter method resets and puts the gzip writer into pool.
-// Deprecated use `ReleaseResponseWriter` instead.
-func PutGzipResponseWiriter(rw ResponseWriter) {
-	releaseGzipResponse(rw.(*GzipResponse))
-}
-
 //‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
 // GzipResponse
 //___________________________________

gzip_response_test.go

@@ -21,8 +21,8 @@ import (
 func TestHTTPGzipWriter(t *testing.T) {
 	handler := func(w http.ResponseWriter, r *http.Request) {
 		GzipLevel = gzip.BestSpeed
-		gw := GetGzipResponseWriter(GetResponseWriter(w))
-		defer PutGzipResponseWiriter(gw)
+		gw := WrapGzipWriter(AcquireResponseWriter(w))
+		defer ReleaseResponseWriter(gw)
 
 		gw.Header().Set(HeaderVary, HeaderAcceptEncoding)
 		gw.Header().Set(HeaderContentEncoding, "gzip")
@@ -92,7 +92,7 @@ func TestHTTPGzipHijack(t *testing.T) {
 			ngw, _ := gzip.NewWriterLevel(w, GzipLevel)
 			gwPool.Put(ngw)
 		}
-		gw := WrapGzipWriter(GetResponseWriter(w))
+		gw := WrapGzipWriter(AcquireResponseWriter(w))
 
 		con, rw, err := gw.(http.Hijacker).Hijack()
 		assert.FailOnError(t, err, "")

request.go

@@ -12,7 +12,6 @@ import (
 	"net/http"
 	"net/url"
 	"os"
-	"path/filepath"
 	"strings"
 	"sync"
 
@@ -43,8 +42,7 @@ func ParseRequest(r *http.Request, req *Request) *Request {
 	req.Referer = getReferer(r.Header)
 	req.UserAgent = r.Header.Get(HeaderUserAgent)
 	req.IsGzipAccepted = strings.Contains(r.Header.Get(HeaderAcceptEncoding), "gzip")
-	req.Raw = r
-
+	req.raw = r
 	return req
 }
 
@@ -89,12 +87,7 @@ type Request struct {
 	// otherwise false.
 	IsGzipAccepted bool
 
-	// Raw an object of Go HTTP server, direct interaction with
-	// raw object is not encouraged.
-	//
-	// DEPRECATED: Raw field to be unexported on v1 release, use `Req.Unwarp()` instead.
-	Raw *http.Request
-
+	raw               *http.Request
 	locale            *Locale
 	contentType       *ContentType
 	acceptContentType *ContentType
@@ -252,7 +245,7 @@ func (r *Request) Body() io.ReadCloser {
 // Unwrap method returns the underlying *http.Request instance of Go HTTP server,
 // direct interaction with raw object is not encouraged. Use it appropriately.
 func (r *Request) Unwrap() *http.Request {
-	return r.Raw
+	return r.raw
 }
 
 // SaveFile method saves an uploaded multipart file for given key from the HTTP
@@ -275,37 +268,6 @@ func (r *Request) SaveFile(key, dstFile string) (int64, error) {
 	return saveFile(uploadedFile, dstFile)
 }
 
-// SaveFiles method saves an uploaded multipart file(s) for the given key
-// from the HTTP request into given destination directory. It uses the filename
-// as uploaded filename from the request
-func (r *Request) SaveFiles(key, dstPath string) ([]int64, []error) {
-	if !ess.IsDir(dstPath) {
-		return []int64{0}, []error{fmt.Errorf("ahttp: destination path, '%s' is not a directory", dstPath)}
-	}
-
-	if ess.IsStrEmpty(key) {
-		return []int64{0}, []error{fmt.Errorf("ahttp: form file key, '%s' is empty", key)}
-	}
-
-	var errs []error
-	var sizes []int64
-	for _, file := range r.Params.File[key] {
-		uploadedFile, err := file.Open()
-		if err != nil {
-			sizes = append(sizes, 0)
-			errs = append(errs, err)
-			continue
-		}
-
-		if size, err := saveFile(uploadedFile, filepath.Join(dstPath, file.Filename)); err != nil {
-			sizes = append(sizes, size)
-			errs = append(errs, err)
-		}
-		ess.CloseQuietly(uploadedFile)
-	}
-	return sizes, errs
-}
-
 // Reset method resets request instance for reuse.
 func (r *Request) Reset() {
 	r.Scheme = ""
@@ -318,8 +280,8 @@ func (r *Request) Reset() {
 	r.Referer = ""
 	r.UserAgent = ""
 	r.IsGzipAccepted = false
-	r.Raw = nil
 
+	r.raw = nil
 	r.locale = nil
 	r.contentType = nil
 	r.acceptContentType = nil

request_test.go

@@ -105,7 +105,7 @@ func TestHTTPParseRequest(t *testing.T) {
 	ReleaseRequest(aahReq)
 	assert.Nil(t, aahReq.Header)
 	assert.Nil(t, aahReq.Params)
-	assert.Nil(t, aahReq.Raw)
+	assert.Nil(t, aahReq.raw)
 	assert.True(t, aahReq.UserAgent == "")
 }
 
@@ -255,49 +255,6 @@ func TestRequestSaveFileCannotCreateFile(t *testing.T) {
 	assert.True(t, strings.HasPrefix(err.Error(), "ahttp: open /root/aah.txt"))
 }
 
-func TestRequestSaveFiles(t *testing.T) {
-	aahReq, dir, teardown := setUpRequestSaveFiles(t)
-	defer teardown()
-
-	sizes, errs := aahReq.SaveFiles("framework", dir)
-	assert.Nil(t, errs)
-	assert.Nil(t, sizes)
-	_, err := os.Stat(dir + "/aah")
-	assert.Nil(t, err)
-	_, err = os.Stat(dir + "/aah2")
-	assert.Nil(t, err)
-}
-
-func TestRequestSaveFilesFailsVaildation(t *testing.T) {
-	aahReq, dir, teardown := setUpRequestSaveFiles(t)
-	defer teardown()
-
-	// Empty key
-	sizes, errs := aahReq.SaveFiles("", dir)
-	assert.NotNil(t, errs)
-	assert.Equal(t, "ahttp: form file key, '' is empty", errs[0].Error())
-	assert.Equal(t, int64(0), sizes[0])
-
-	// Empty directory
-	sizes, errs = aahReq.SaveFiles("key", "")
-	assert.NotNil(t, errs)
-	assert.Equal(t, "ahttp: destination path, '' is not a directory", errs[0].Error())
-	assert.Equal(t, int64(0), sizes[0])
-}
-
-func TestRequestSaveFilesCannotCreateFile(t *testing.T) {
-	aahReq, _, teardown := setUpRequestSaveFiles(t)
-	defer teardown()
-
-	sizes, errs := aahReq.SaveFiles("framework", "/root")
-	assert.NotNil(t, errs)
-	assert.Equal(t, int64(0), sizes[0])
-
-	errMsg := errs[0].Error()
-	assert.True(t, ("ahttp: open /root/aah: permission denied" == errMsg ||
-		"ahttp: destination path, '/root' is not a directory" == errMsg))
-}
-
 func TestRequestSaveFileForExistingFile(t *testing.T) {
 	var buf bytes.Buffer
 

response.go

@@ -40,26 +40,6 @@ type ResponseWriter interface {
 	Unwrap() http.ResponseWriter
 }
 
-//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
-// Package methods
-//___________________________________
-
-// TODO for old method cleanup
-
-// GetResponseWriter method wraps given writer and returns the aah response writer.
-// Deprecated use `AcquireResponseWriter` instead.
-func GetResponseWriter(w http.ResponseWriter) ResponseWriter {
-	rw := responsePool.Get().(*Response)
-	rw.w = w
-	return rw
-}
-
-// PutResponseWriter method puts response writer back to pool.
-// Deprecated use `ReleaseResponseWriter` instead.
-func PutResponseWriter(aw ResponseWriter) {
-	releaseResponse(aw.(*Response))
-}
-
 //‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
 // Response
 //___________________________________

response_test.go

@@ -18,8 +18,8 @@ import (
 
 func TestHTTPResponseWriter(t *testing.T) {
 	handler := func(w http.ResponseWriter, r *http.Request) {
-		writer := GetResponseWriter(w)
-		defer PutResponseWriter(writer)
+		writer := AcquireResponseWriter(w)
+		defer ReleaseResponseWriter(writer)
 
 		writer.WriteHeader(http.StatusOK)
 		assert.Equal(t, http.StatusOK, writer.Status())
@@ -47,8 +47,8 @@ func TestHTTPNoStatusWritten(t *testing.T) {
 
 func TestHTTPMultipleStatusWritten(t *testing.T) {
 	handler := func(w http.ResponseWriter, r *http.Request) {
-		writer := GetResponseWriter(w)
-		defer PutResponseWriter(writer)
+		writer := AcquireResponseWriter(w)
+		defer ReleaseResponseWriter(writer)
 
 		writer.WriteHeader(http.StatusOK)
 		writer.WriteHeader(http.StatusAccepted)
@@ -85,8 +85,8 @@ func TestHTTPHijackCall(t *testing.T) {
 
 func TestHTTPCallCloseNotifyAndFlush(t *testing.T) {
 	handler := func(w http.ResponseWriter, r *http.Request) {
-		writer := GetResponseWriter(w)
-		defer PutResponseWriter(writer)
+		writer := AcquireResponseWriter(w)
+		defer ReleaseResponseWriter(writer)
 
 		_, _ = writer.Write([]byte("aah framework calling close notify and flush"))
 		assert.Equal(t, 44, writer.BytesWritten())