added docs and CONTRIBUTING.md

Author: GouravRusiya30

docs/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

docs/createPet.png

@@ -1,20 +1,75 @@
-//package com.gourav.restApi.controllers;
+package com.gourav.restapi.controllers;
+
+import org.bson.types.ObjectId;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+
+import static java.util.Collections.singletonList;
+import static org.mockito.BDDMockito.given;
+import java.util.List;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+import com.gourav.restapi.models.Pets;
+
+@RunWith(SpringRunner.class)
+@WebMvcTest(value = PetsController.class)
+public class PetsControllerTest {
+
+	@Autowired
+	private MockMvc mvc;
+	
+	@MockBean
+	private PetsController petsController;
+
+	@Test
+	public void getAllPets() throws Exception {
+		ObjectId id = ObjectId.get();
+		Pets pets = new Pets(id, "Liam", "cat", "tabby");
+
+		List<Pets> allPets = singletonList(pets);
+		
+		given(petsController.getAllPets()).willReturn(allPets);
+
+		mvc.perform(get("/pets/").contentType("application/json;charset=UTF-8")).andExpect(status().isOk())
+		.andExpect(jsonPath("$[0].name").value("Liam"))
+		.andExpect(jsonPath("$[0].breed").value("tabby"))
+		.andExpect(jsonPath("$[0].species").value("cat"))
+		.andReturn();
+	}
+	
+	@Test
+	public void getPetById() throws Exception {
+		ObjectId id = ObjectId.get();
+		Pets pets = new Pets(id, "Liam", "cat", "tabby");
+
+		given(petsController.getPetById(id)).willReturn(pets);
+
+		mvc.perform(get("/pets/"+id+"/").contentType("application/json;charset=UTF-8")).andExpect(status().isOk())
+		.andExpect(jsonPath("$.name").value("Liam"))
+		.andExpect(jsonPath("$.breed").value("tabby"))
+		.andExpect(jsonPath("$.species").value("cat"))
+		.andReturn();
+	}
+	
+//	@Test
+//	public void modifyPetById() throws Exception {
+//		ObjectId id = ObjectId.get();
+//		Pets pets = new Pets();
+//		
+//		pets.setId(id);
+//		
+//		//given(petsController.modifyPetById(id, pets)).willReturn(pets);
 //
-//import org.junit.runner.RunWith;
-//import org.springframework.beans.factory.annotation.Autowired;
-//import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-//import org.springframework.boot.test.mock.mockito.MockBean;
-//import org.springframework.test.context.junit4.SpringRunner;
-//import org.springframework.test.web.servlet.MockMvc;
-//
-//@RunWith(SpringRunner.class)
-//@WebMvcTest(value = PetsController.class)
-//public class PetsControllerTest {
-//	
-//	@Autowired
-//	private MockMvc mvc;
-//
-//	@MockBean
-//	private PetsController petsController;
-//	
-//}
+//		mvc.perform(get("/pets/"+id+"/").contentType("application/json;charset=UTF-8")).andExpect(status().isOk())
+//		.andExpect(jsonPath("$.name").value("Liam"))
+//		.andExpect(jsonPath("$.breed").value("tabby"))
+//		.andExpect(jsonPath("$.species").value("cat"))
+//		.andReturn();
+//	}
+}