Adding README and LICENSE files

LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 seek.com.au
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,232 @@
+# PactNet
+A .NET implementation of the Ruby consumer driven contract library, [Pact](https://github.com/realestate-com-au/pact).  
+Pact is based off the specification found at https://github.com/bethesque/pact_specification.  
+PactNet is aiming to be Version 1 compliant (Version 2 is a WIP).
+
+From the [Pact Specification repo] (https://github.com/bethesque/pact_specification)
+
+> "Pact" is an implementation of "consumer driven contract" testing that allows mocking of responses in the consumer codebase, and verification of the interactions in the provider codebase. The initial implementation was written in Ruby for Rack apps, however a consumer and provider may be implemented in different programming languages, so the "mocking" and the "verifying" steps would be best supported by libraries in their respective project's native languages. Given that the pact file is written in JSON, it should be straightforward to implement a pact library in any language, however, to get the best experience and most reliability of out mixing pact libraries, the matching logic for the requests and responses needs to be identical. There is little confidence to be gained in having your pacts "pass" if the logic used to verify a "pass" is inconsistent between implementations.
+
+Read more about Pact and the problems it solves at https://github.com/realestate-com-au/pact
+
+Please also note that this project is still a work in progress, so there will likely be bugs and items that have not yet been implemented.  
+Please feel free to contribute, we do accept pull requests.
+
+## Usage
+### Service Consumer
+
+#### 1. Build your client
+Which may look something like this.
+
+```c#
+public class SomethingApiClient
+{
+	public string BaseUri { get; set; }
+
+	public SomethingApiClient(string baseUri = null)
+	{
+		BaseUri = baseUri ?? "http://my-api";
+	}
+
+	public Something GetSomething(string id)
+	{
+		var client = new HttpClient();
+		client.BaseAddress = new Uri(BaseUri);
+
+		var request = new HttpRequestMessage(HttpMethod.Get, "/somethings/" + id);
+		request.Headers.Add("Accept", "application/json");
+
+		var response = client.SendAsync(request);
+
+		var content = response.Result.Content.ReadAsStringAsync().Result;
+		var status = response.Result.StatusCode;
+
+		if (status == HttpStatusCode.OK)
+		{
+			return !String.IsNullOrEmpty(content) ? 
+				JsonConvert.DeserializeObject<Something>(content)
+				: null;
+		}
+
+		throw new Exception("Server responded with a non 200 status code");
+	}
+}
+```
+
+#### 2. Describe and configure the pact as a service consumer with a mock service
+Create a new test case within your service consumer test project, using whatever unit test framework you like (in this case we used xUnit).  
+This only should be instantiated once for all the current consumer tests.
+
+```c#
+public class ConsumerMyApiPact : IDisposable
+{
+	public IPactConsumer Pact { get; private set; }
+	public IMockProviderService MockProviderService { get; private set; }
+
+	public int MockServerPort { get { return 1234; } }
+	public string MockServerBaseUri { get { return String.Format("http://localhost:{0}", MockServerPort); } }
+
+	public ConsumerEventApiPact()
+	{
+		Pact = new Pact().ServiceConsumer("Consumer")
+			.HasPactWith("Something API");
+
+		MockProviderService = Pact.MockService(MockServerPort); //Configure the in memory http mock server
+	}
+
+	public void Dispose()
+	{
+		Pact.Dispose(); //Will save the pact file once finished
+	}
+}
+
+public class SomethingApiConsumerTests : IUseFixture<ConsumerMyApiPact>
+{
+	private ConsumerMyApiPact _data;
+
+	public void SetFixture(ConsumerMyApiPact data)
+	{
+		_data = data;
+	}
+}
+```
+
+#### 3. Write your test
+
+```c#
+public class SomethingApiConsumerTests : IUseFixture<ConsumerMyApiPact>
+{
+	//As above...
+	
+	[Fact]
+	public void GetAllEvents_WhenCalled_ReturnsAllEvents()
+	{
+		//Arrange
+		_data.MockProviderService
+			.Given("There is a something with id 'tester'")
+			.UponReceiving("A GET request to retrieve the something")
+			.With(new PactProviderServiceRequest
+			{
+				Method = HttpVerb.Get,
+				Path = "/somethings/tester",
+				Headers = new Dictionary<string, string>
+				{
+					{ "Accept", "application/json" }
+				}
+			})
+			.WillRespondWith(new PactProviderServiceResponse
+			{
+				Status = 200,
+				Headers = new Dictionary<string, string>
+				{
+					{ "Content-Type", "application/json; charset=utf-8" }
+				},
+				Body = new
+				{
+					id = "tester",
+					FirstName = "Totally",
+					LastName = "Awesome"
+				}
+			})
+			.RegisterInteraction();
+
+		var consumer = new SomethingApiClient(_data.MockServerBaseUri);
+
+		//Act
+		var result = consumer.GetSomething("tester");
+
+		//Assert
+		Assert.Equal("tester", something.Id);
+	}
+}
+```
+
+#### 4. Run the test
+Everything should be green
+
+Note: we advise using a TDD approach when using this library, however we will leave it up to you.
+Likely you will be creating a skeleton client, describing the pact, write the failing test, implement the skeleton client, run the test to make sure it passes, then rinse and repeat.
+
+### Service Provider
+
+#### 1. Create the API
+...
+
+#### 2. Tell the provider it needs to honour the pact
+Create a new test case within your service provider test project, using whatever unit test framework you like (in this case we used xUnit).
+
+**a)** If using an Owin compatible API, like ASP.NET Web API 2 and using the Microsoft.Owin.Testing Nuget package **(preferred)**
+```c#
+public class SomethingApiTests
+{
+	[Fact]
+	public void EnsureSomethingApiHonoursPactWithConsumer()
+	{
+		//Arrange
+		var testServer = TestServer.Create<Startup>(); //Using the Microsoft.Owin.Testing nuget package
+
+		var pact = new Pact()
+			.ProviderStatesFor("Consumer",
+			new Dictionary<string, Action>
+			{
+				{ "There is a something with id 'tester'", AddTesterIfItDoesntExist }
+			});
+
+		//Act / Assert
+		pact.ServiceProvider("Something API", testServer.HttpClient)
+			.HonoursPactWith("Consumer")
+			.PactUri("../../../Consumer.Tests/pacts/consumer-something_api.json")
+			.VerifyProviderService();
+
+		testServer.Dispose();
+	}
+
+	private void AddTesterIfItDoesntExist()
+	{
+		//Logic to add the 'tester' something
+	}
+}
+```
+
+or
+
+
+**b)** If using a non Owin compatible API, you can provide your own HttpClient and point to the deployed API.
+```c#
+public class SomethingApiTests
+{
+	[Fact]
+	public void EnsureSomethingApiHonoursPactWithConsumer()
+	{
+		//Arrange
+		var client = new HttpClient { BaseAddress = new Uri("http://api-address:9999") };
+
+		var pact = new Pact()
+			.ProviderStatesFor("Consumer",
+			new Dictionary<string, Action>
+			{
+				{ "There is a something with id 'tester'", AddTesterIfItDoesntExist }
+			});
+
+		//Act / Assert
+		pact.ServiceProvider("Something API", client)
+			.HonoursPactWith("Consumer")
+			.PactUri("../../../Consumer.Tests/pacts/consumer-something_api.json")
+			.VerifyProviderService();
+
+		testServer.Dispose();
+	}
+
+	private void AddTesterIfItDoesntExist()
+	{
+		//Logic to add the 'tester' something
+	}
+}
+```
+
+#### 4. Run the test
+Everything should be green
+
+Again, please note: we advise using a TDD approach when using this library, however we will leave it up to you.
+
+For further examples please refer to the [Samples](https://github.com/SEEK-Jobs/pact-net/tree/master/Samples) in the solution.

Samples/EventApi/Consumer/EventsApiClient.cs

@@ -28,7 +28,7 @@ public IEnumerable<dynamic> GetAllEvents()
             var client = new HttpClient();
             client.BaseAddress = new Uri(BaseUri);
 
-            var request = new HttpRequestMessage(HttpMethod.Get, "/events?test=1&test2=tester");
+            var request = new HttpRequestMessage(HttpMethod.Get, "/events");
             request.Headers.Add("Accept", "application/json");
 
             var response = client.SendAsync(request);