Improvements, test case and read update

Author: jeevatkm

README.md

@@ -1,14 +1,14 @@
-# resty  [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+# resty  [![Build Status](https://travis-ci.org/go-resty/resty.svg?branch=master)](https://travis-ci.org/go-resty/resty)  [![GoCover](http://gocover.io/_badge/github.com/go-resty/resty)](http://gocover.io/github.com/go-resty/resty)  [![GoDoc](https://godoc.org/github.com/go-resty/resty?status.svg)](https://godoc.org/github.com/go-resty/resty)  [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
 Simple HTTP and REST client for Go inspired by Ruby rest-client
 
-**Development is in progress.**
+**Documentation is in progress.**
 
 ### Usage
-<pre>Development is in progress</pre>
+<pre>Documentation is in progress</pre>
 
 ### Versioning
 * resty release version according to [Semantic Versioning](http://semver.org)
 
 ### License
-resty released under MIT license, refer LICENSE file.
+resty released under MIT license, refer [LICENSE](LICENSE) file.

client.go

@@ -28,12 +28,25 @@ import (
 )
 
 const (
-	GET     = "GET"
-	POST    = "POST"
-	PUT     = "PUT"
-	DELETE  = "DELETE"
-	PATCH   = "PATCH"
-	HEAD    = "HEAD"
+	// HTTP method GET
+	GET = "GET"
+
+	// HTTP method POST
+	POST = "POST"
+
+	// HTTP method PUT
+	PUT = "PUT"
+
+	// HTTP method DELETE
+	DELETE = "DELETE"
+
+	// HTTP method PATCH
+	PATCH = "PATCH"
+
+	// HTTP method HEAD
+	HEAD = "HEAD"
+
+	// HTTP method OPTIONS
 	OPTIONS = "OPTIONS"
 )
 
@@ -58,7 +71,7 @@ var (
 // Client type is used for HTTP/RESTful global values
 // for all request raised from the client
 type Client struct {
-	HostUrl    string
+	HostURL    string
 	QueryParam url.Values
 	FormData   url.Values
 	Header     http.Header
@@ -77,15 +90,15 @@ type Client struct {
 	afterResponse    []func(*Client, *Response) error
 }
 
-// Type User is hold a username and password information
+// User type is to hold an username and password information
 type User struct {
 	Username, Password string
 }
 
 // SetHostUrl method is to set Host URL in the client instance. It will be used with request
 // raised from this client with relative URL
-func (c *Client) SetHostUrl(url string) *Client {
-	c.HostUrl = strings.TrimRight(url, "/")
+func (c *Client) SetHostURL(url string) *Client {
+	c.HostURL = strings.TrimRight(url, "/")
 	return c
 }
 
@@ -133,7 +146,7 @@ func (c *Client) SetHeaders(headers map[string]string) *Client {
 // 					Domain: "sample.com",
 // 					MaxAge: 36000,
 // 					HttpOnly: true,
-//					Secure: false,  // baseds on https or http
+//					Secure: false,
 // 				})
 //
 func (c *Client) SetCookie(hc *http.Cookie) *Client {
@@ -254,7 +267,7 @@ func (c *Client) SetAuthToken(token string) *Client {
 // R method creates a request instance, its used for Get, Post, Put, Delete, Patch, Head and Options.
 func (c *Client) R() *Request {
 	r := &Request{
-		Url:        "",
+		URL:        "",
 		Method:     "",
 		QueryParam: url.Values{},
 		FormData:   url.Values{},
@@ -501,7 +514,7 @@ func (c *Client) disableLogPrefix() {
 // and also you can add more options for that particular request
 //
 type Request struct {
-	Url        string
+	URL        string
 	Method     string
 	QueryParam url.Values
 	FormData   url.Values
@@ -786,7 +799,7 @@ func (r *Request) execute(method, url string) (*Response, error) {
 	}
 
 	r.Method = method
-	r.Url = url
+	r.URL = url
 
 	return r.client.execute(r)
 }
@@ -900,21 +913,21 @@ func DetectContentType(body interface{}) string {
 	return contentType
 }
 
-// IsJsonType method is to check JSON content type or not
-func IsJsonType(ct string) bool {
+// IsJSONType method is to check JSON content type or not
+func IsJSONType(ct string) bool {
 	return jsonCheck.MatchString(ct)
 }
 
-// IsXmlType method is to check XML content type or not
-func IsXmlType(ct string) bool {
+// IsXMLType method is to check XML content type or not
+func IsXMLType(ct string) bool {
 	return xmlCheck.MatchString(ct)
 }
 
 // Unmarshal content into object from JSON or XML
 func Unmarshal(ct string, b []byte, d interface{}) (err error) {
-	if IsJsonType(ct) {
+	if IsJSONType(ct) {
 		err = json.Unmarshal(b, d)
-	} else if IsXmlType(ct) {
+	} else if IsXMLType(ct) {
 		err = xml.Unmarshal(b, d)
 	}
 
@@ -964,17 +977,20 @@ func getRequestBodyString(r *Request) (body string) {
 			var prtBodyBytes []byte
 			var err error
 			kind := reflect.ValueOf(r.Body).Kind()
-			if IsJsonType(contentType) && (kind == reflect.Struct || kind == reflect.Map) {
+			if IsJSONType(contentType) && (kind == reflect.Struct || kind == reflect.Map) {
 				prtBodyBytes, err = json.MarshalIndent(&r.Body, "", "   ")
-			} else if IsXmlType(contentType) && (kind == reflect.Struct) {
+			} else if IsXMLType(contentType) && (kind == reflect.Struct) {
 				prtBodyBytes, err = xml.MarshalIndent(&r.Body, "", "   ")
 			} else if b, ok := r.Body.(string); ok {
-				if IsJsonType(contentType) {
+				if IsJSONType(contentType) {
 					bodyBytes := []byte(b)
 					var out bytes.Buffer
 					if err = json.Indent(&out, bodyBytes, "", "   "); err == nil {
 						prtBodyBytes = out.Bytes()
 					}
+				} else {
+					body = b
+					return
 				}
 			} else if b, ok := r.Body.([]byte); ok {
 				body = base64.StdEncoding.EncodeToString(b)
@@ -994,7 +1010,7 @@ func getResponseBodyString(res *Response) string {
 	bodyStr := "***** NO CONTENT *****"
 	if res.Body != nil {
 		ct := res.Header().Get(hdrContentTypeKey)
-		if IsJsonType(ct) {
+		if IsJSONType(ct) {
 			var out bytes.Buffer
 			if err := json.Indent(&out, res.Body, "", "   "); err == nil {
 				bodyStr = string(out.Bytes())

default.go

@@ -28,7 +28,7 @@ func New() *Client {
 	cookieJar, _ := cookiejar.New(&cookiejar.Options{PublicSuffixList: publicsuffix.List})
 
 	c := &Client{
-		HostUrl:    "",
+		HostURL:    "",
 		QueryParam: url.Values{},
 		FormData:   url.Values{},
 		Header:     http.Header{},
@@ -43,10 +43,10 @@ func New() *Client {
 
 	// default before request middlewares
 	c.beforeRequest = []func(*Client, *Request) error{
-		parseRequestUrl,
+		parseRequestURL,
 		parseRequestHeader,
 		parseRequestBody,
-		createHttpRequest,
+		createHTTPRequest,
 		addCredentials,
 		requestLogger,
 	}

middleware.go

@@ -21,37 +21,37 @@ import (
 // Request Middleware(s)
 //
 
-func parseRequestUrl(c *Client, r *Request) error {
+func parseRequestURL(c *Client, r *Request) error {
 	// Parsing request URL
-	reqUrl, err := url.Parse(r.Url)
+	reqURL, err := url.Parse(r.URL)
 	if err != nil {
 		return err
 	}
 
 	// If Request.Url is relative path then added c.HostUrl into
 	// the request URL otherwise Request.Url will be used as-is
-	if !reqUrl.IsAbs() {
-		if !strings.HasPrefix(r.Url, "/") {
-			r.Url = "/" + r.Url
+	if !reqURL.IsAbs() {
+		if !strings.HasPrefix(r.URL, "/") {
+			r.URL = "/" + r.URL
 		}
 
-		reqUrl, err = url.Parse(c.HostUrl + r.Url)
+		reqURL, err = url.Parse(c.HostURL + r.URL)
 		if err != nil {
 			return err
 		}
 	}
 
 	// Adding Query Param
-	query := reqUrl.Query()
+	query := reqURL.Query()
 	for k := range c.QueryParam {
 		query.Set(k, c.QueryParam.Get(k))
 	}
 	for k := range r.QueryParam {
 		query.Set(k, r.QueryParam.Get(k))
 	}
 
-	reqUrl.RawQuery = query.Encode()
-	r.Url = reqUrl.String()
+	reqURL.RawQuery = query.Encode()
+	r.URL = reqURL.String()
 
 	return nil
 }
@@ -137,9 +137,9 @@ func parseRequestBody(c *Client, r *Request) (err error) {
 
 			var bodyBytes []byte
 			kind := reflect.ValueOf(r.Body).Kind()
-			if IsJsonType(contentType) && (kind == reflect.Struct || kind == reflect.Map) {
+			if IsJSONType(contentType) && (kind == reflect.Struct || kind == reflect.Map) {
 				bodyBytes, err = json.Marshal(&r.Body)
-			} else if IsXmlType(contentType) && (kind == reflect.Struct) {
+			} else if IsXMLType(contentType) && (kind == reflect.Struct) {
 				bodyBytes, err = xml.Marshal(&r.Body)
 			} else if b, ok := r.Body.(string); ok {
 				bodyBytes = []byte(b)
@@ -149,13 +149,13 @@ func parseRequestBody(c *Client, r *Request) (err error) {
 
 			if err != nil {
 				return
+			} else if bodyBytes == nil {
+				err = errors.New("Unsupported 'Body' type/value")
+				return
 			}
 
 			// []byte into Buffer
-			if bodyBytes == nil {
-				err = errors.New("Unsupported 'Body' type/value")
-				return
-			} else {
+			if bodyBytes != nil {
 				r.bodyBuf = bytes.NewBuffer(bodyBytes)
 			}
 		}
@@ -169,11 +169,11 @@ CL:
 	return
 }
 
-func createHttpRequest(c *Client, r *Request) (err error) {
+func createHTTPRequest(c *Client, r *Request) (err error) {
 	if r.bodyBuf == nil {
-		r.RawRequest, err = http.NewRequest(r.Method, r.Url, nil)
+		r.RawRequest, err = http.NewRequest(r.Method, r.URL, nil)
 	} else {
-		r.RawRequest, err = http.NewRequest(r.Method, r.Url, r.bodyBuf)
+		r.RawRequest, err = http.NewRequest(r.Method, r.URL, r.bodyBuf)
 	}
 
 	// Add headers into http request
@@ -197,7 +197,7 @@ func addCredentials(c *Client, r *Request) error {
 		r.RawRequest.SetBasicAuth(c.UserInfo.Username, c.UserInfo.Password)
 		isBasicAuth = true
 	}
-	if isBasicAuth && !strings.HasPrefix(r.Url, "https") {
+	if isBasicAuth && !strings.HasPrefix(r.URL, "https") {
 		c.Log.Println("WARNING - Using Basic Auth in HTTP mode is not secure.")
 	}
 
@@ -257,7 +257,7 @@ func responseLogger(c *Client, res *Response) error {
 func parseResponseBody(c *Client, res *Response) (err error) {
 	// Handles only JSON or XML content type
 	ct := res.Header().Get(hdrContentTypeKey)
-	if IsJsonType(ct) || IsXmlType(ct) {
+	if IsJSONType(ct) || IsXMLType(ct) {
 		// Considered as Result
 		if res.StatusCode() > 199 && res.StatusCode() < 300 {
 			if res.Request.Result != nil {

resty.go

@@ -8,4 +8,5 @@ Package resty provides simple HTTP and REST client for Go inspired by Ruby rest-
 */
 package resty
 
+// go-resty version no
 var Version = "0.1"