Added spring fox swagger 😄

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "pandora"]
+	path = pandora
+	url = https://github.com/hex-g/pandora.git

README.md

@@ -1 +1,56 @@
 # player
+---
+**The profile data API**
+
+*"A person in its life is as a player."*
+
+### First steps
+(Configuring the environment):
+
+1. git clone https://github.com/hex-g/player.git
+    1. cd player
+2. git checkout [branch]
+3. git submodule init
+4. git submodule update 
+5. Run the project in your IDE
+---
+### Usage
+> URL: `http://localhost:9600/`
+
+#### ![#c5f015](https://placehold.it/15/c5f015/000000?text=+) `GET`
+If an request profile data does not exist then a new one be created. 
+* `header`
+    * *key*: `authenticated-user-id`
+    * *value*: [string]
+
+#### ![#1589F0](https://placehold.it/15/1589F0/000000?text=+) `POST`
+Inserts a new profile data or updates an existent.
+* `header`
+    * *key*: `authenticated-user-id`
+    * *value*: [string]
+* `body JSON`
+    * *value*: 
+    ```
+    {
+            "loginAlias": string,
+            "email": string,
+            "telnumber": string,
+            "flavorText": string,
+            "birthday": string,
+            "options": {
+                "laurel_wreath": string,
+                "honorific": string,
+                "darkmode": string["on"/"off"],
+                "notify_hiveshare": string["on"/"off"],
+                "notify_hivecentral": string["on"/"off"],
+                "notify_disciplines": string["on"/"off"]
+            },
+            "social": {
+                "github": string,
+                "linkedIn": string,
+                "twitter": string
+            }
+        }
+    ```
+
+

build.gradle

@@ -0,0 +1,69 @@
+buildscript {
+    ext {
+        springBootVersion = '2.1.3.RELEASE'
+        springCloudVersion = 'Greenwich.SR1'
+    }
+    repositories {
+        mavenCentral()
+        maven { url 'https://repo.spring.io/milestone' }
+    }
+    dependencies {
+        classpath "org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}" as Object
+        classpath "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" as Object
+    }
+}
+
+plugins {
+    id "io.spring.dependency-management" version "1.0.5.RELEASE"
+    id 'java'
+    id 'org.springframework.boot' version '2.1.3.RELEASE'
+}
+
+apply plugin: 'groovy'
+apply plugin: 'io.spring.dependency-management'
+
+group = 'hive'
+version = '0.0.1-SNAPSHOT'
+sourceCompatibility = '11'
+
+repositories {
+    mavenCentral()
+    maven { url 'https://repo.spring.io/milestone' }
+}
+
+dependencies {
+    implementation project(':pandora')
+
+    implementation 'javax.xml.bind:jaxb-api:2.3.1'
+    implementation 'javax.activation:activation:1.1.1'
+    implementation 'org.glassfish.jaxb:jaxb-runtime:2.3.2'
+    //production db:
+    //implementation group: 'mysql', name: 'mysql-connector-java', version: '8.0.16'
+    //development db:
+    implementation 'com.h2database:h2'
+
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-client'
+    implementation 'org.codehaus.groovy.modules.http-builder:http-builder:0.7.1'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+
+    compile 'io.springfox:springfox-swagger2:2.9.2'
+    compile 'io.springfox:springfox-swagger-ui:2.9.2'
+
+    testCompile(
+            'org.hamcrest:hamcrest-core:1.3',//if not using delete this
+            'org.spockframework:spock-core:1.3-groovy-2.5',
+            'org.spockframework:spock-spring:1.3-groovy-2.5'
+    )
+}
+
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.boot:spring-boot-dependencies:${springBootVersion}"
+        mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
+    }
+}
+bootJar(){
+    launchScript()
+}

settings.gradle

@@ -1,10 +1,3 @@
-/*
- * This file was generated by the Gradle 'init' task.
- *
- * The settings file is used to specify which projects to include in your build.
- *
- * Detailed information about configuring a multi-project build in Gradle can be found
- * in the user manual at https://docs.gradle.org/5.2.1/userguide/multi_project_builds.html
- */
-
 rootProject.name = 'player'
+include 'pandora'
+include 'ishigami'

src/main/java/hive/player/PlayerApplication.java

@@ -0,0 +1,14 @@
+package hive.player;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.domain.EntityScan;
+import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
+import org.springframework.context.annotation.PropertySource;
+
+@SpringBootApplication
+@EnableEurekaClient
+public class PlayerApplication {
+  public static void main(String[] args) {
+    SpringApplication.run(PlayerApplication.class, args);
+  }
+}

src/main/java/hive/player/controller/PlayerController.java

@@ -0,0 +1,62 @@
+package hive.player.controller;
+
+import static hive.pandora.constant.HiveInternalHeaders.*;
+
+import hive.player.entity.Player;
+import hive.player.exception.PlayerIdShouldNotBeInJsonException;
+import hive.player.repository.PlayerRepository;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+@RequestMapping("/")
+public class PlayerController {
+  private final PlayerRepository playerRepository;
+
+  @Autowired
+  public PlayerController(final PlayerRepository playerRepository) {
+    this.playerRepository = playerRepository;
+  }
+
+  @GetMapping
+  public Player retrieveProfileData(
+      @RequestHeader(name = AUTHENTICATED_USER_ID) final String authenticatedUserId
+  ) {
+    return createAnPlayerInDatabaseIfNotExists(authenticatedUserId);
+  }
+
+  @PostMapping
+  public void insertProfileData(
+      @RequestHeader(name = AUTHENTICATED_USER_ID) final String authenticatedUserId,
+      @RequestBody final Player player
+  ) {
+    if(player.getPlayerId() != null){
+      throw new PlayerIdShouldNotBeInJsonException();
+    }
+    updatePlayerCorrelatedWithTheAuthenticatedId(player, authenticatedUserId);
+    player.setAuthenticatedUserId(authenticatedUserId);
+    playerRepository.save(player);
+  }
+
+  private Player createAnPlayerInDatabaseIfNotExists(final String authenticatedUserId) {
+    var player = playerRepository.findByAuthenticatedUserId(authenticatedUserId);
+    if (player == null) {
+      player = new Player(authenticatedUserId);
+      playerRepository.save(player);
+    }
+    return player;
+  }
+
+  private void updatePlayerCorrelatedWithTheAuthenticatedId(
+      final Player player,
+      final String authenticatedUserId
+  ) {
+    final var playerFound=playerRepository.findByAuthenticatedUserId(authenticatedUserId);
+    if(playerFound != null) {
+      final var autogeneratedPlayerId = playerFound.getPlayerId();
+      if (autogeneratedPlayerId != null) {
+        player.setPlayerId(autogeneratedPlayerId);
+      }
+    }
+  }
+}

src/main/java/hive/player/entity/Player.java

@@ -0,0 +1,86 @@
+package hive.player.entity;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import javax.persistence.*;
+import javax.validation.constraints.NotNull;
+
+@Entity
+@Table(name = "tb_user_profile")
+public class Player {
+  @Id
+  @JsonProperty
+  @GeneratedValue(strategy = GenerationType.IDENTITY)
+  //is some DBMS like Oracle you should change the strategy
+  private Integer playerId;
+  @JsonIgnore
+  private String authenticatedUserId;
+
+  @JsonProperty
+  @Column(name = "login_alias", unique = true)
+  private String loginAlias;
+  @JsonProperty
+  @Column(name = "email")
+  private String email;
+  @JsonProperty
+  @Column(name = "telnumber")
+  private String telnumber;
+  @JsonProperty
+  @Column(name = "flavor_text")
+  private String flavorText;
+  @JsonProperty
+  @Column(name = "birthday")
+  private String birthday;
+
+  @Embedded
+  @JsonProperty
+  @Column(name = "options")
+  private PlayerOptions options;
+  @Embedded
+  @JsonProperty
+  @Column(name = "social")
+  private PlayerSocial social;
+
+  public Integer getPlayerId() {
+    return playerId;
+  }
+
+  public void setPlayerId(final Integer playerId) {
+    this.playerId = playerId;
+  }
+
+  public String getAuthenticatedUserId() {
+    return authenticatedUserId;
+  }
+
+  public void setAuthenticatedUserId(@NotNull final String authenticatedUserId) {
+    this.authenticatedUserId = authenticatedUserId;
+  }
+
+  private Player() {
+  }
+
+  public Player(
+      @NotNull final String authenticatedUserId,
+      final String loginAlias,
+      final String email,
+      final String telNumber,
+      final String flavorText,
+      final String birthday,
+      final PlayerOptions options,
+      final PlayerSocial social
+  ) {
+    setAuthenticatedUserId(authenticatedUserId);
+    this.loginAlias = loginAlias;
+    this.email = email;
+    this.telnumber = telNumber;
+    this.flavorText = flavorText;
+    this.birthday = birthday;
+    this.options = options;
+    this.social = social;
+  }
+  public Player(@NotNull final String authenticatedUserId){
+    setAuthenticatedUserId(authenticatedUserId);
+  }
+}

src/main/java/hive/player/entity/PlayerOptions.java

@@ -0,0 +1,30 @@
+package hive.player.entity;
+
+import javax.persistence.Embeddable;
+
+@Embeddable
+public class PlayerOptions {
+  public String laurel_wreath;
+  public String honorific;
+  public Boolean darkmode;
+  public Boolean notify_hiveshare;
+  public Boolean notify_hivecentral;
+  public Boolean notify_disciplines;
+
+  public PlayerOptions(
+      final String laurel_wreath,
+      final String honorific,
+      final Boolean darkmode,
+      final Boolean notify_hiveshare,
+      final Boolean notify_hivecentral,
+      final Boolean notify_disciplines
+  ) {
+    this.laurel_wreath = laurel_wreath;
+    this.honorific = honorific;
+    this.darkmode = darkmode;
+    this.notify_hiveshare = notify_hiveshare;
+    this.notify_hivecentral = notify_hivecentral;
+    this.notify_disciplines = notify_disciplines;
+  }
+  public PlayerOptions(){}
+}

src/main/java/hive/player/entity/PlayerSocial.java

@@ -0,0 +1,17 @@
+package hive.player.entity;
+
+import javax.persistence.Embeddable;
+
+@Embeddable
+public class PlayerSocial {
+  public String github;
+  public String linkedIn;
+  public String twitter;
+
+  public PlayerSocial(final String github, final String linkedIn, final String twitter) {
+    this.github = github;
+    this.linkedIn = linkedIn;
+    this.twitter = twitter;
+  }
+  public PlayerSocial() {}
+}

src/main/java/hive/player/exception/BlankIdException.java

@@ -0,0 +1,8 @@
+package hive.player.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "The Authenticated user id can not be blank")
+public class BlankIdException extends RuntimeException{
+}

src/main/java/hive/player/exception/PlayerIdShouldNotBeInJsonException.java

@@ -0,0 +1,8 @@
+package hive.player.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "The autogenerated playerId should not be in JSON")
+public class PlayerIdShouldNotBeInJsonException extends RuntimeException{
+}

src/main/java/hive/player/repository/PlayerRepository.java

@@ -0,0 +1,13 @@
+package hive.player.repository;
+
+import hive.player.entity.Player;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface PlayerRepository extends JpaRepository<Player,Integer> {
+
+   Player findByAuthenticatedUserId(final String authenticatedUserId);
+
+}