Merge pull request #74 from maxatome/v1

Update doc

Author: maxatome

README.md

@@ -73,7 +73,7 @@ func TestFetchArticles(t *testing.T) {
 		httpmock.NewStringResponder(200, `[{"id": 1, "name": "My Great Article"}]`))
 
 	// Regexp match (could use httpmock.RegisterRegexpResponder instead)
-	httpmock.RegisterResponder("GET", `=~^https://api.mybiz.com/articles/id/\d+\z`,
+	httpmock.RegisterResponder("GET", `=~^https://api\.mybiz\.com/articles/id/\d+\z`,
 		httpmock.NewStringResponder(200, `{"id": 1, "name": "My Great Article"}`))
 
 	// do stuff that makes a request to articles
@@ -86,7 +86,7 @@ func TestFetchArticles(t *testing.T) {
 	info := httpmock.GetCallCountInfo()
 	info["GET https://api.mybiz.com/articles"] // number of GET calls made to https://api.mybiz.com/articles
 	info["GET https://api.mybiz.com/articles/id/12"] // number of GET calls made to https://api.mybiz.com/articles/id/12
-	info[`GET =~^https://api.mybiz.com/articles/id/\d+\z`] // number of GET calls made to https://api.mybiz.com/articles/id/<any-number>
+	info[`GET =~^https://api\.mybiz\.com/articles/id/\d+\z`] // number of GET calls made to https://api.mybiz.com/articles/id/<any-number>
 }
 ```
 
@@ -111,7 +111,7 @@ func TestFetchArticles(t *testing.T) {
 	)
 
 	// return an article related to the request with the help of regexp submatch (\d+)
-	httpmock.RegisterResponder("GET", `=~^https://api.mybiz.com/articles/id/(\d+)\z`,
+	httpmock.RegisterResponder("GET", `=~^https://api\.mybiz\.com/articles/id/(\d+)\z`,
 		func(req *http.Request) (*http.Response, error) {
 			// Get ID from request
 			id := httpmock.MustGetSubmatchAsUint(req, 1) // 1=first regexp submatch

doc.go

@@ -2,55 +2,80 @@
 Package httpmock provides tools for mocking HTTP responses.
 
 Simple Example:
-	func TestFetchArticles(t *testing.T) {
-		httpmock.Activate()
-		defer httpmock.DeactivateAndReset()
+  func TestFetchArticles(t *testing.T) {
+  	httpmock.Activate()
+  	defer httpmock.DeactivateAndReset()
 
-		httpmock.RegisterResponder("GET", "https://api.mybiz.com/articles.json",
-			httpmock.NewStringResponder(200, `[{"id": 1, "name": "My Great Article"}]`))
+  	// Exact URL match
+  	httpmock.RegisterResponder("GET", "https://api.mybiz.com/articles",
+  		httpmock.NewStringResponder(200, `[{"id": 1, "name": "My Great Article"}]`))
 
-		// do stuff that makes a request to articles.json
-	}
+  	// Regexp match (could use httpmock.RegisterRegexpResponder instead)
+  	httpmock.RegisterResponder("GET", `=~^https://api\.mybiz\.com/articles/id/\d+\z`,
+  		httpmock.NewStringResponder(200, `{"id": 1, "name": "My Great Article"}`))
+
+  	// do stuff that makes a request to articles
+
+  	// get count info
+  	httpmock.GetTotalCallCount()
+
+  	// get the amount of calls for the registered responder
+  	info := httpmock.GetCallCountInfo()
+  	info["GET https://api.mybiz.com/articles"]             // number of GET calls made to https://api.mybiz.com/articles
+  	info["GET https://api.mybiz.com/articles/id/12"]       // number of GET calls made to https://api.mybiz.com/articles/id/12
+  	info[`GET =~^https://api\.mybiz\.com/articles/id/\d+\z`] // number of GET calls made to https://api.mybiz.com/articles/id/<any-number>
+  }
 
 Advanced Example:
-	func TestFetchArticles(t *testing.T) {
-		httpmock.Activate()
-		defer httpmock.DeactivateAndReset()
-
-		// our database of articles
-		articles := make([]map[string]interface{}, 0)
-
-		// mock to list out the articles
-		httpmock.RegisterResponder("GET", "https://api.mybiz.com/articles.json",
-			func(req *http.Request) (*http.Response, error) {
-				resp, err := httpmock.NewJsonResponse(200, articles)
-				if err != nil {
-					return httpmock.NewStringResponse(500, ""), nil
-				}
-				return resp
-			},
-		)
-
-		// mock to add a new article
-		httpmock.RegisterResponder("POST", "https://api.mybiz.com/articles.json",
-			func(req *http.Request) (*http.Response, error) {
-				article := make(map[string]interface{})
-				if err := json.NewDecoder(req.Body).Decode(&article); err != nil {
-					return httpmock.NewStringResponse(400, ""), nil
-				}
-
-				articles = append(articles, article)
-
-				resp, err := httpmock.NewJsonResponse(200, article)
-				if err != nil {
-					return httpmock.NewStringResponse(500, ""), nil
-				}
-				return resp, nil
-			},
-		)
-
-		// do stuff that adds and checks articles
-	}
+  func TestFetchArticles(t *testing.T) {
+  	httpmock.Activate()
+  	defer httpmock.DeactivateAndReset()
+
+  	// our database of articles
+  	articles := make([]map[string]interface{}, 0)
+
+  	// mock to list out the articles
+  	httpmock.RegisterResponder("GET", "https://api.mybiz.com/articles",
+  		func(req *http.Request) (*http.Response, error) {
+  			resp, err := httpmock.NewJsonResponse(200, articles)
+  			if err != nil {
+  				return httpmock.NewStringResponse(500, ""), nil
+  			}
+  			return resp, nil
+  		},
+  	)
+
+  	// return an article related to the request with the help of regexp submatch (\d+)
+  	httpmock.RegisterResponder("GET", `=~^https://api\.mybiz\.com/articles/id/(\d+)\z`,
+  		func(req *http.Request) (*http.Response, error) {
+  			// Get ID from request
+  			id := httpmock.MustGetSubmatchAsUint(req, 1) // 1=first regexp submatch
+  			return httpmock.NewJsonResponse(200, map[string]interface{}{
+  				"id":   id,
+  				"name": "My Great Article",
+  			})
+  		},
+  	)
+
+  	// mock to add a new article
+  	httpmock.RegisterResponder("POST", "https://api.mybiz.com/articles",
+  		func(req *http.Request) (*http.Response, error) {
+  			article := make(map[string]interface{})
+  			if err := json.NewDecoder(req.Body).Decode(&article); err != nil {
+  				return httpmock.NewStringResponse(400, ""), nil
+  			}
+
+  			articles = append(articles, article)
+
+  			resp, err := httpmock.NewJsonResponse(200, article)
+  			if err != nil {
+  				return httpmock.NewStringResponse(500, ""), nil
+  			}
+  			return resp, nil
+  		},
+  	)
 
+  	// do stuff that adds and checks articles
+  }
 */
 package httpmock