Add Context

README.md

@@ -38,8 +38,10 @@ func main() {
 		Build()
 
 	response := mock.NewResponseBuilder(http.StatusOK).AddBody(`{"status": "OK"}`).Build()
+
+	limit := mock.NewMockCallLimit(3)
 
-	mockDefinition := mock.NewDefinition(request, response)
+	mockDefinition := mock.NewDefinition(request, response, limit)
 
 	err = instance.AddMock(mockDefinition)
 	if err != nil {
@@ -89,7 +91,28 @@ response := mock.NewResponseBuilder(http.StatusOK).
     AddHeader("Content-Type", "application/json").
     Build()
 
-mockDefinition := mock.NewDefinition(request, response)
+mockDefinition := mock.NewDefinition(request, response, nil)
+```
+
+You can also include a limit on how many times a mock can be called using the `NewMockCallLimit` function.
+
+```go
+request := mock.NewRequestBuilder(http.MethodPut, "/foo/bar").
+AddQueryParam("limit", "10").
+AddQueryParam("filters", "red", "green").
+AddHeader("Content-Type", "application/json", "application/vnd.api+json").
+AddBearerAuthToken("sv2361fr1o8ph3oin").
+AddJsonBody(`{"example": "body"`).
+Build()
+
+response := mock.NewResponseBuilder(http.StatusOK).
+AddBody(`{"status": "OK"}`).
+AddHeader("Content-Type", "application/json").
+Build()
+
+limit := mock.NewMockCallLimit(5)
+
+mockDefinition := mock.NewDefinition(request, response, limit)
 ```
 
 ### Raw Json

examples/createmock.go

@@ -30,7 +30,9 @@ func main() {
 
 	response := mock.NewResponseBuilder(http.StatusOK).AddBody(`{"status": "OK"}`).Build()
 
-	mockDefinition := mock.NewDefinition(request, response)
+	limit := mock.NewMockCallLimit(3)
+
+	mockDefinition := mock.NewDefinition(request, response, limit)
 
 	err = instance.AddMock(mockDefinition)
 	if err != nil {

mock/context.go

@@ -0,0 +1,5 @@
+package mock
+
+func NewMockCallLimit(t int) *Context {
+	return &Context{Times: t}
+}

mock/context_test.go

@@ -0,0 +1,15 @@
+package mock_test
+
+import (
+	"github.com/churmd/smockerclient/mock"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestNewMockCallLimit(t *testing.T) {
+	expectedContext := &mock.Context{Times: 3}
+
+	actualContext := mock.NewMockCallLimit(3)
+
+	assert.Equal(t, expectedContext, actualContext)
+}

mock/definition.go

@@ -21,16 +21,27 @@ type Response struct {
 	Body    string              `json:"body,omitempty"`
 }
 
+type Context struct {
+	Times int `json:"times"`
+}
+
 type Definition struct {
 	Request  Request  `json:"request"`
 	Response Response `json:"response"`
+	Context  *Context `json:"context,omitempty"`
 }
 
-func NewDefinition(req Request, resp Response) Definition {
-	return Definition{
+func NewDefinition(req Request, resp Response, context *Context) Definition {
+	def := Definition{
 		Request:  req,
 		Response: resp,
 	}
+
+	if context != nil {
+		def.Context = context
+	}
+
+	return def
 }
 
 func (d Definition) ToMockDefinitionJson() ([]byte, error) {

mock/definition_test.go

@@ -1,16 +1,16 @@
 package mock_test
 
 import (
+	"github.com/stretchr/testify/assert"
 	"net/http"
 	"testing"
 
-	"github.com/stretchr/testify/assert"
-
 	"github.com/churmd/smockerclient/mock"
 )
 
 func TestDefinition_ToMockJson(t *testing.T) {
-	expectedJson := `{
+	t.Run("With no Context", func(t *testing.T) {
+		expectedJson := `{
 		"request": {
 			"method": "PUT",
 			"path": "/foo/bar",
@@ -36,14 +36,57 @@ func TestDefinition_ToMockJson(t *testing.T) {
 		}
 	}`
 
-	request := createRequest()
-	response := createResponse()
-	definition := mock.NewDefinition(request, response)
+		request := createRequest()
+		response := createResponse()
+		definition := mock.NewDefinition(request, response, nil)
 
-	actualJson, err := definition.ToMockDefinitionJson()
+		actualJson, err := definition.ToMockDefinitionJson()
+
+		assert.NoError(t, err)
+		assert.JSONEq(t, expectedJson, string(actualJson))
+	})
+
+	t.Run("With Context", func(t *testing.T) {
+		expectedJson := `{
+		"request": {
+			"method": "PUT",
+			"path": "/foo/bar",
+			"query_params": {
+			   "limit": ["10"],
+			   "filters": ["red", "green"]
+			},
+			"headers": {
+				"Content-Type": ["application/json", "application/vnd.api+json"],
+				"Authorization": ["Bearer sv2361fr1o8ph3oin"]
+			},
+			"body": {
+				"matcher": "ShouldEqualJSON",
+				"value": "{\"name\": \"John Smith\", \"uuid\": \"daa7b90d-9429-4d7a-9304-edc41ff44a6d\", \"rank\": 10}"
+			}
+		},
+		"context": {
+			"times": 3
+		},
+		"response": {
+			"status": 200,
+			"headers": {
+				"Content-Type": ["application/json"]
+			},
+			"body": "{\"status\": \"OK\"}"
+		}
+	}`
+
+		request := createRequest()
+		response := createResponse()
+		context := createContext()
+		definition := mock.NewDefinition(request, response, context)
+
+		actualJson, err := definition.ToMockDefinitionJson()
+
+		assert.NoError(t, err)
+		assert.JSONEq(t, expectedJson, string(actualJson))
+	})
 
-	assert.NoError(t, err)
-	assert.JSONEq(t, expectedJson, string(actualJson))
 }
 
 func createRequest() mock.Request {
@@ -79,3 +122,7 @@ func createResponse() mock.Response {
 	}
 	return response
 }
+
+func createContext() *mock.Context {
+	return &mock.Context{Times: 3}
+}