initial project import

Author: BenRomberg

.gitignore

@@ -0,0 +1,7 @@
+*.iml
+.idea/
+target/
+.settings/
+.classpath
+.project
+.externalToolBuilders/

LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2016` `Ben Romberg`
+
+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,38 @@
+Installation notes:
+
+* adjust `configuration.example` as instructed in the file and rename it to `configuration.json`
+* install Maven and build the project using `mvn clean package`
+* copy `cordonbleu-main-0.0.1-SNAPSHOT.jar` from `cordonbleu-main/target` into this folder
+* install MongoDB
+* run `run.sh`
+* view `http://localhost:8080/`
+
+Development notes:
+
+* install node + npm
+* `cd` to `cordonbleu-main`
+* `npm install`
+* `npm install webpack -g`
+* `webpack --watch` will auto-compile everything under `src/main/resources/webpack` and bundle it into `target/classes/static/js/bundle.js` which is referenced in `index.html`
+* start the `CordonBleuApplication` dropwizard server using `server src/test/resources/config-test.json` as arguments
+
+Now you can develop, all changes in `src/main/resources/webpack` will be bundled automatically upon file-save. `CordonBleuApplication` needs to be restarted if backend changes are made though.
+
+SASS features used:
+
+* Variables: Declare using `$var: 123px;` just like you would usually declare a CSS property.
+* Calculations: Combined with variables, you can calculate CSS properties, e.g. `top: $navbarHeight + 3px;`.
+
+ES6 features used:
+
+* Arrow functions: Same semantics as in Java just with `=>` instead of `->`. The `this` variable is not affected in contrast to `function`s and keeps its scope, which is very handy in most scenarios.
+  * Just like in Java, singular expressions don't need to be wrapped by `{}` and `return` can be omitted. If you want to return an object as a singular expression, wrap it with `()`.
+* Spread operator `...array` to expand an array into the arguments of a function.
+
+ES6 features that sound useful (but haven't been used yet):
+
+* Using `const` and `let` instead of `var`.
+* Appending `,` to the last element of an array or object. It's allowed by ES6 and is easier to refactor this way.
+* Using backticks ``` to reference variables within strings. Quit using `+` for string concatenation.
+* Default parameter values.
+* Code Style guidelines for ES6 with some interesting ideas: https://github.com/elierotenberg/coding-styles/blob/master/es6.md

configuration.example

@@ -0,0 +1,27 @@
+// this is a dropwizard service configuration, details see http://www.dropwizard.io/0.8.2/docs/manual/configuration.html
+// remove all "comments", adjust values appropriately and rename this file to configuration.json
+{
+  "server": {
+    "type": "simple",
+    "rootPath": "/api/*",
+    "applicationContextPath": "/",
+    "adminContextPath": "/admin",
+    "connector": {
+      "type": "http",
+      "port": 8080
+    }
+  },
+  "codeRepositoryFolder": "/path/to/code-repository",           // needs to be changed to an existing path
+  "mongoUrl": "mongodb://localhost:27017/",                     // needs to point to a running MongoDB instance
+  "highlightingTimeoutInMilliseconds": 1000,                    // increase if many commits don't get highlighted
+  "commitNotificationConsiderationAmount": 100,                 // increase if you need the notifications to consider more commits
+  "emailServer": {
+    "host": "smtp.server",                                      // change email settings
+    "port": 587,
+    "username": "smtp_user",
+    "password": "smtp_password",
+    "rootPath": "http://example.com"                            // the web url that will be used in emails
+  },
+  "sshPrivateKeyPassword": "something-entirely-random"          // private keys will be encrypted using this password,
+                                                                // so they're not available in "plain-text" in the database
+}

cordonbleu-data/pom.xml

@@ -0,0 +1,54 @@
+<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">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.benromberg.cordonbleu</groupId>
+        <artifactId>cordonbleu-parent</artifactId>
+        <version>0.0.1-SNAPSHOT</version>
+        <relativePath>../cordonbleu-parent/pom.xml</relativePath>
+    </parent>
+    <artifactId>cordonbleu-data</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.mongodb</groupId>
+            <artifactId>mongo-java-driver</artifactId>
+            <version>3.2.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.mongojack</groupId>
+            <artifactId>mongojack</artifactId>
+            <version>2.6.0</version>
+        </dependency>
+        <dependency>
+            <groupId>com.github.mongobee</groupId>
+            <artifactId>mongobee</artifactId>
+            <version>0.11</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>18.0</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jdk8</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.module</groupId>
+            <artifactId>jackson-module-parameter-names</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.benromberg.cordonbleu</groupId>
+            <artifactId>cordonbleu-util</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.benromberg.cordonbleu</groupId>
+            <artifactId>cordonbleu-util</artifactId>
+            <type>test-jar</type>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>

cordonbleu-data/src/main/java/com/benromberg/cordonbleu/data/dao/CacheDao.java

@@ -0,0 +1,72 @@
+package com.benromberg.cordonbleu.data.dao;
+
+import static com.benromberg.cordonbleu.util.ExceptionUtil.convertException;
+
+import java.util.Optional;
+import java.util.concurrent.TimeUnit;
+
+import org.mongojack.DBQuery.Query;
+import org.mongojack.DBUpdate;
+
+import com.benromberg.cordonbleu.data.model.Entity;
+import com.benromberg.cordonbleu.data.util.jackson.CustomModule;
+import com.benromberg.cordonbleu.data.validation.Validation;
+import com.google.common.cache.Cache;
+import com.google.common.cache.CacheBuilder;
+
+public class CacheDao<I, E extends Entity<I>> extends MongoDao<I, E> {
+    private final Cache<I, Optional<E>> cache = CacheBuilder.newBuilder().expireAfterWrite(1, TimeUnit.MINUTES).build();
+
+    public CacheDao(DatabaseWithMigration database, Class<I> idClass, Class<E> elementClass, String collectionName,
+            Validation<? super E> validation) {
+        super(database, idClass, elementClass, collectionName, new CustomModule(), validation);
+    }
+
+    public CacheDao(DatabaseWithMigration database, Class<I> idClass, Class<E> elementClass, String collectionName,
+            CustomModule customModule) {
+        super(database, idClass, elementClass, collectionName, customModule);
+    }
+
+    public CacheDao(DatabaseWithMigration database, Class<I> idClass, Class<E> elementClass, String collectionName,
+            CustomModule customModule, Validation<? super E> validation) {
+        super(database, idClass, elementClass, collectionName, customModule, validation);
+    }
+
+    @Override
+    public Optional<E> findById(I id) {
+        return convertException(() -> cache.get(id, () -> super.findById(id)));
+    }
+
+    @Override
+    public void insert(E element) {
+        super.insert(element);
+        cache.invalidate(element.getId());
+    }
+
+    @Override
+    protected Optional<E> update(Query find, DBUpdate.Builder update) {
+        Optional<E> changed = super.update(find, update);
+        if (changed.isPresent()) {
+            cache.put(changed.get().getId(), changed);
+        }
+        return changed;
+    }
+
+    @Override
+    protected Optional<E> update(I id, DBUpdate.Builder update) {
+        Optional<E> changed = super.update(id, update);
+        cache.put(id, changed);
+        return changed;
+    }
+
+    @Override
+    public boolean remove(I id) {
+        boolean hasRemoved = super.remove(id);
+        cache.invalidate(id);
+        return hasRemoved;
+    }
+
+    public void invalidate(I id) {
+        cache.invalidate(id);
+    }
+}

cordonbleu-data/src/main/java/com/benromberg/cordonbleu/data/dao/CodeRepositoryMetadataDao.java

@@ -0,0 +1,75 @@
+package com.benromberg.cordonbleu.data.dao;
+
+import static com.benromberg.cordonbleu.data.util.jackson.CaseInsensitiveUniqueValue.uniqueProperty;
+import static java.util.Arrays.asList;
+import com.benromberg.cordonbleu.util.CollectionUtil;
+
+import java.util.List;
+import java.util.Optional;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+import org.mongojack.DBQuery;
+import org.mongojack.DBQuery.Query;
+import org.mongojack.DBUpdate;
+
+import com.benromberg.cordonbleu.data.model.CodeRepositoryMetadata;
+import com.benromberg.cordonbleu.data.model.NamedEntity;
+import com.benromberg.cordonbleu.data.model.RepositoryFlag;
+import com.benromberg.cordonbleu.data.model.Team;
+import com.benromberg.cordonbleu.data.util.jackson.CustomModule;
+import com.benromberg.cordonbleu.data.validation.NameValidation;
+
+@Singleton
+public class CodeRepositoryMetadataDao extends CacheDao<String, CodeRepositoryMetadata> {
+    @Inject
+    public CodeRepositoryMetadataDao(DatabaseWithMigration db, NameValidation<NamedEntity> validation, TeamDao teamDao) {
+        super(db, String.class, CodeRepositoryMetadata.class, "codeRepositoryMetadata", createCustomModule(teamDao),
+                validation);
+        createUniqueIndex(uniqueProperty(CodeRepositoryMetadata.NAME_PROPERTY), CodeRepositoryMetadata.TEAM_PROPERTY);
+    }
+
+    private static CustomModule createCustomModule(TeamDao teamDao) {
+        CustomModule customModule = new CustomModule();
+        customModule.addSerializer(Team.class, new EntitySerializer<>());
+        customModule.addDeserializer(Team.class, new EntityDeserializer<>(teamDao));
+        return customModule;
+    }
+
+    public List<CodeRepositoryMetadata> findByIds(List<String> ids) {
+        return find(DBQuery.in(ID_PROPERTY, ids)).toArray();
+    }
+
+    public List<CodeRepositoryMetadata> findActive() {
+        return findByFlag(RepositoryFlag.REMOVE_ON_NEXT_UPDATE, false);
+    }
+
+    private List<CodeRepositoryMetadata> findAndSortByName(Query query) {
+        return CollectionUtil.sortCaseInsensitive(find(query).toArray(), CodeRepositoryMetadata::getName);
+    }
+
+    public Optional<CodeRepositoryMetadata> updateFlag(String repositoryId, RepositoryFlag flag, boolean flagValue) {
+        if (flagValue) {
+            return update(repositoryId, DBUpdate.push(CodeRepositoryMetadata.FLAGS_PROPERTY, flag));
+        }
+        return update(repositoryId, DBUpdate.pull(CodeRepositoryMetadata.FLAGS_PROPERTY, flag));
+    }
+
+    public List<CodeRepositoryMetadata> findByFlag(RepositoryFlag flag, boolean flagValue) {
+        return findAndSortByName(queryByFlag(flag, flagValue));
+    }
+
+    private Query queryByFlag(RepositoryFlag flag, boolean flagValue) {
+        Query query = DBQuery.is(CodeRepositoryMetadata.FLAGS_PROPERTY, asList(flag));
+        if (!flagValue) {
+            query = DBQuery.nor(query);
+        }
+        return query;
+    }
+
+    public List<CodeRepositoryMetadata> findByTeam(Team team) {
+        Query activeQuery = queryByFlag(RepositoryFlag.REMOVE_ON_NEXT_UPDATE, false);
+        return findAndSortByName(activeQuery.is(CodeRepositoryMetadata.TEAM_PROPERTY, team));
+    }
+}