Merge pull request #636 from gopinath-langote/partial-response-pattern

#631 - Partial response pattern Implementation
2017-09-23 09:35:35 +03:00 · 2017-09-23 09:35:35 +03:00 · 99de0e1644
commit 99de0e1644
parent eb36033b83 dba2d8aef7
13 changed files with 586 additions and 1 deletions
--- a/partial-response/README.md
+++ b/partial-response/README.md
@ -0,0 +1,29 @@
+---
+layout: pattern
+title: Partial Response
+folder: partial-response
+permalink: /patterns/partial-response/
+categories: Architectural
+tags:
+ - Java
+ - KISS
+ - YAGNI
+ - Difficulty-Beginner
+---
+
+## Intent
+Send partial response from server to client on need basis. Client will specify the the fields
+that it need to server, instead of serving all details for resource. 
+
+![alt text](./etc/partial-response.urm.png "partial-response")
+
+## Applicability
+Use the Partial Response pattern when
+
+* Client need only subset of data from resource.
+* To avoid too much data transfer over wire
+
+## Credits
+
+* [Common Design Patterns](https://cloud.google.com/apis/design/design_patterns)
+* [Partial Response in RESTful API Design](http://yaoganglian.com/2013/07/01/partial-response/)
--- a/partial-response/etc/partial-response.ucls
+++ b/partial-response/etc/partial-response.ucls
@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<class-diagram version="1.2.1" icons="true" always-add-relationships="false" generalizations="true" realizations="true" 
+  associations="true" dependencies="false" nesting-relationships="true" router="FAN">  
+  <class id="1" language="java" name="com.iluwatar.partialresponse.Video" project="partial-response" 
+    file="/partial-response/src/main/java/com/iluwatar/partialresponse/Video.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="322" y="457"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <class id="2" language="java" name="com.iluwatar.partialresponse.FieldJsonMapper" project="partial-response" 
+    file="/partial-response/src/main/java/com/iluwatar/partialresponse/FieldJsonMapper.java" binary="false" 
+    corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="772" y="412"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <class id="3" language="java" name="com.iluwatar.partialresponse.VideoClientApp" project="partial-response" 
+    file="/partial-response/src/main/java/com/iluwatar/partialresponse/VideoClientApp.java" binary="false" 
+    corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="215" y="125"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <class id="4" language="java" name="com.iluwatar.partialresponse.VideoResource" project="partial-response" 
+    file="/partial-response/src/main/java/com/iluwatar/partialresponse/VideoResource.java" binary="false" 
+    corner="BOTTOM_RIGHT">    
+    <position height="101" width="319" x="476" y="66"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <association id="5">    
+    <end type="SOURCE" refId="4" navigable="false">      
+      <attribute id="6" name="videos"/>      
+      <multiplicity id="7" minimum="0" maximum="2147483647"/>    
+    </end>    
+    <end type="TARGET" refId="1" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <association id="8">    
+    <end type="SOURCE" refId="4" navigable="false">      
+      <attribute id="9" name="fieldJsonMapper"/>      
+      <multiplicity id="10" minimum="0" maximum="1"/>    
+    </end>    
+    <end type="TARGET" refId="2" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+    sort-features="false" accessors="true" visibility="true">    
+    <attributes public="true" package="true" protected="true" private="true" static="true"/>    
+    <operations public="true" package="true" protected="true" private="true" static="true"/>  
+  </classifier-display>  
+  <association-display labels="true" multiplicity="true"/>
+</class-diagram>
--- a/partial-response/etc/partial-response.urm.png
+++ b/partial-response/etc/partial-response.urm.png
--- a/partial-response/etc/partial-response.urm.puml
+++ b/partial-response/etc/partial-response.urm.puml
@ -0,0 +1,31 @@
+@startuml
+package com.iluwatar.partialresponse {
+  class FieldJsonMapper {
+    + FieldJsonMapper()
+    - getString(video : Video, declaredField : Field) : String
+    + toJson(video : Video, fields : String[]) : String
+  }
+  class Video {
+    - description : String
+    - director : String
+    - id : Integer
+    - language : String
+    - length : Integer
+    - title : String
+    + Video(id : Integer, title : String, length : Integer, description : String, director : String, language : String)
+    + toString() : String
+  }
+  class VideoClientApp {
+    - LOGGER : Logger {static}
+    + VideoClientApp()
+    + main(args : String[]) {static}
+  }
+  class VideoResource {
+    - fieldJsonMapper : FieldJsonMapper
+    - videos : Map<Integer, Video>
+    + VideoResource(fieldJsonMapper : FieldJsonMapper, videos : Map<Integer, Video>)
+    + getDetails(id : Integer, fields : String[]) : String
+  }
+}
+VideoResource -->  "-fieldJsonMapper" FieldJsonMapper
+@enduml
--- a/partial-response/pom.xml
+++ b/partial-response/pom.xml
@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>java-design-patterns</artifactId>
+        <groupId>com.iluwatar</groupId>
+        <version>1.17.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>partial-response</artifactId>
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+        </dependency>
+    </dependencies>
+
+
+</project>
--- a/partial-response/src/main/java/com/iluwatar/partialresponse/App.java
+++ b/partial-response/src/main/java/com/iluwatar/partialresponse/App.java
@ -0,0 +1,74 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2017 Gopinath Langote
+ *
+ * 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.
+ */
+
+package com.iluwatar.partialresponse;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * The Partial response pattern is a design pattern in which client specifies fields to fetch to serve.
+ * Here {@link App} is playing as client for {@link VideoResource} server.
+ * Client ask for specific fields information in video to server.
+ * <p>
+ * <p>
+ * {@link VideoResource} act as server to serve video information.
+ */
+
+public class App {
+  private static final Logger LOGGER = LoggerFactory.getLogger(App.class);
+
+  /**
+   * Method as act client and request to server for video details.
+   *
+   * @param args program argument.
+   */
+  public static void main(String[] args) throws Exception {
+    Map<Integer, Video> videos = new HashMap<>();
+    videos.put(1, new Video(1, "Avatar", 178, "epic science fiction film", "James Cameron", "English"));
+    videos.put(2, new Video(2, "Godzilla Resurgence", 120, "Action & drama movie|", "Hideaki Anno", "Japanese"));
+    videos.put(3, new Video(3, "Interstellar", 169, "Adventure & Sci-Fi", "Christopher Nolan", "English"));
+    VideoResource videoResource = new VideoResource(new FieldJsonMapper(), videos);
+
+
+    LOGGER.info("Retrieving full response from server:-");
+    LOGGER.info("Get all video information:");
+    String videoDetails = videoResource.getDetails(1);
+    LOGGER.info(videoDetails);
+
+    LOGGER.info("----------------------------------------------------------");
+
+    LOGGER.info("Retrieving partial response from server:-");
+    LOGGER.info("Get video @id, @title, @director:");
+    String specificFieldsDetails = videoResource.getDetails(3, "id", "title", "director");
+    LOGGER.info(specificFieldsDetails);
+
+    LOGGER.info("Get video @id, @length:");
+    String videoLength = videoResource.getDetails(3, "id", "length");
+    LOGGER.info(videoLength);
+  }
+}
--- a/partial-response/src/main/java/com/iluwatar/partialresponse/FieldJsonMapper.java
+++ b/partial-response/src/main/java/com/iluwatar/partialresponse/FieldJsonMapper.java
@ -0,0 +1,60 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2017 Gopinath Langote
+ *
+ * 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.
+ */
+
+package com.iluwatar.partialresponse;
+
+import java.lang.reflect.Field;
+
+/**
+ * Map a video to json
+ */
+public class FieldJsonMapper {
+
+  /**
+   * @param video  object containing video information
+   * @param fields fields information to get
+   * @return json of required fields from video
+   */
+  public String toJson(Video video, String[] fields) throws Exception {
+    StringBuilder json = new StringBuilder().append("{");
+
+    for (int i = 0, fieldsLength = fields.length; i < fieldsLength; i++) {
+      json.append(getString(video, Video.class.getDeclaredField(fields[i])));
+      if (i != fieldsLength - 1) {
+        json.append(",");
+      }
+    }
+    json.append("}");
+    return json.toString();
+  }
+
+  private String getString(Video video, Field declaredField) throws IllegalAccessException {
+    declaredField.setAccessible(true);
+    Object value = declaredField.get(video);
+    if (declaredField.get(video) instanceof Integer) {
+      return "\"" + declaredField.getName() + "\"" + ": " + value;
+    }
+    return "\"" + declaredField.getName() + "\"" + ": " + "\"" + value.toString() + "\"";
+  }
+}
--- a/partial-response/src/main/java/com/iluwatar/partialresponse/Video.java
+++ b/partial-response/src/main/java/com/iluwatar/partialresponse/Video.java
@ -0,0 +1,70 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2017 Gopinath Langote
+ *
+ * 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.
+ */
+
+package com.iluwatar.partialresponse;
+
+/**
+ * {@link Video} is a entity to serve from server.It contains all video related information..
+ * <p>
+ */
+public class Video {
+  private final Integer id;
+  private final String title;
+  private final Integer length;
+  private final String description;
+  private final String director;
+  private final String language;
+
+  /**
+   * @param id          video unique id
+   * @param title       video title
+   * @param length      video length in minutes
+   * @param description video description by publisher
+   * @param director    video director name
+   * @param language    video language {private, public}
+   */
+  public Video(Integer id, String title, Integer length, String description, String director, String language) {
+    this.id = id;
+    this.title = title;
+    this.length = length;
+    this.description = description;
+    this.director = director;
+    this.language = language;
+  }
+
+  /**
+   * @return json representaion of video
+   */
+  @Override
+  public String toString() {
+    return "{"
+        + "\"id\": " + id + ","
+        + "\"title\": \"" + title + "\","
+        + "\"length\": " + length + ","
+        + "\"description\": \"" + description + "\","
+        + "\"director\": \"" + director + "\","
+        + "\"language\": \"" + language + "\","
+        + "}";
+  }
+}
--- a/partial-response/src/main/java/com/iluwatar/partialresponse/VideoResource.java
+++ b/partial-response/src/main/java/com/iluwatar/partialresponse/VideoResource.java
@ -0,0 +1,57 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2017 Gopinath Langote
+ *
+ * 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.
+ */
+
+package com.iluwatar.partialresponse;
+
+import java.util.Map;
+
+/**
+ * The resource class which serves video information.
+ * This class act as server in the demo. Which has all video details.
+ */
+public class VideoResource {
+  private FieldJsonMapper fieldJsonMapper;
+  private Map<Integer, Video> videos;
+
+  /**
+   * @param fieldJsonMapper map object to json.
+   * @param videos          initialize resource with existing videos. Act as database.
+   */
+  public VideoResource(FieldJsonMapper fieldJsonMapper, Map<Integer, Video> videos) {
+    this.fieldJsonMapper = fieldJsonMapper;
+    this.videos = videos;
+  }
+
+  /**
+   * @param id     video id
+   * @param fields fields to get information about
+   * @return full response if no fields specified else partial response for given field.
+   */
+  public String getDetails(Integer id, String... fields) throws Exception {
+    if (fields.length == 0) {
+      return videos.get(id).toString();
+    }
+    return fieldJsonMapper.toJson(videos.get(id), fields);
+  }
+}
--- a/partial-response/src/test/java/com/iluwatar/partialresponse/AppTest.java
+++ b/partial-response/src/test/java/com/iluwatar/partialresponse/AppTest.java
@ -0,0 +1,40 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2017 Gopinath Langote
+ *
+ * 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.
+ */
+
+package com.iluwatar.partialresponse;
+
+import org.junit.Test;
+
+/**
+ * Application test
+ */
+public class AppTest {
+
+  @Test
+  public void main() throws Exception {
+    String[] args = {};
+    App.main(args);
+  }
+
+}
--- a/partial-response/src/test/java/com/iluwatar/partialresponse/FieldJsonMapperTest.java
+++ b/partial-response/src/test/java/com/iluwatar/partialresponse/FieldJsonMapperTest.java
@ -0,0 +1,53 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2017 Gopinath Langote
+ *
+ * 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.
+ */
+
+package com.iluwatar.partialresponse;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * tests {@link FieldJsonMapper}.
+ */
+public class FieldJsonMapperTest {
+  private FieldJsonMapper mapper;
+
+  @Before
+  public void setUp() {
+    mapper = new FieldJsonMapper();
+  }
+
+  @Test
+  public void shouldReturnJsonForSpecifiedFieldsInVideo() throws Exception {
+    String[] fields = new String[]{"id", "title", "length"};
+    Video video = new Video(2, "Godzilla Resurgence", 120, "Action & drama movie|", "Hideaki Anno", "Japanese");
+
+    String jsonFieldResponse = mapper.toJson(video, fields);
+
+    String expectedDetails = "{\"id\": 2,\"title\": \"Godzilla Resurgence\",\"length\": 120}";
+    assertEquals(expectedDetails, jsonFieldResponse);
+  }
+}
--- a/partial-response/src/test/java/com/iluwatar/partialresponse/VideoResourceTest.java
+++ b/partial-response/src/test/java/com/iluwatar/partialresponse/VideoResourceTest.java
@ -0,0 +1,80 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2017 Gopinath Langote
+ *
+ * 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.
+ */
+
+package com.iluwatar.partialresponse;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.when;
+
+/**
+ * tests {@link VideoResource}.
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class VideoResourceTest {
+  @Mock
+  private FieldJsonMapper fieldJsonMapper;
+
+  private VideoResource resource;
+
+  @Before
+  public void setUp() {
+    Map<Integer, Video> videos = new HashMap<>();
+    videos.put(1, new Video(1, "Avatar", 178, "epic science fiction film", "James Cameron", "English"));
+    videos.put(2, new Video(2, "Godzilla Resurgence", 120, "Action & drama movie|", "Hideaki Anno", "Japanese"));
+    videos.put(3, new Video(3, "Interstellar", 169, "Adventure & Sci-Fi", "Christopher Nolan", "English"));
+    resource = new VideoResource(fieldJsonMapper, videos);
+  }
+
+  @Test
+  public void shouldGiveVideoDetailsById() throws Exception {
+    String actualDetails = resource.getDetails(1);
+
+    String expectedDetails = "{\"id\": 1,\"title\": \"Avatar\",\"length\": 178,\"description\": "
+        + "\"epic science fiction film\",\"director\": \"James Cameron\",\"language\": \"English\",}";
+    assertEquals(expectedDetails, actualDetails);
+  }
+
+  @Test
+  public void shouldGiveSpecifiedFieldsInformationOfVideo() throws Exception {
+    String[] fields = new String[]{"id", "title", "length"};
+
+    String expectedDetails = "{\"id\": 1,\"title\": \"Avatar\",\"length\": 178}";
+    when(fieldJsonMapper.toJson(any(Video.class), eq(fields))).thenReturn(expectedDetails);
+
+    String actualFieldsDetails = resource.getDetails(2, fields);
+
+    assertEquals(expectedDetails, actualFieldsDetails);
+  }
+}
--- a/pom.xml
+++ b/pom.xml
@ -146,6 +146,7 @@
        <module>event-sourcing</module>
        <module>data-transfer-object</module>
    <module>throttling</module>
+        <module>partial-response</module>
    </modules>

    <dependencyManagement>