Add dashboard

1) Move cache polling out of StatusController.

2) Simplify view logic.

3) Make recent transaction json output work.

4) Add dashboard view.

Author: moxie0

Procfile

@@ -1 +1 @@
-web:    java $JAVA_OPTS -Ddw.http.port=$PORT -Ddw.http.adminPort=$PORT -Ddw.github.user=$GITHUB_USER -Ddw.github.token=$GITHUB_TOKEN -Ddw.github.repositories_heroku="$GITHUB_REPOSITORIES" -Ddw.coinbase.apiKey=$COINBASE_API_KEY -Ddw.github.webhook.password=$GITHUB_WEBHOOK_PASSWORD -jar target/BitHub-0.1.jar server
+web:    java $JAVA_OPTS -Ddw.server.type=simple -Ddw.server.applicationContextPath=/ -Ddw.server.connector.type=http -Ddw.server.connector.port=$PORT -Ddw.github.user=$GITHUB_USER -Ddw.github.token=$GITHUB_TOKEN -Ddw.github.repositories_heroku="$GITHUB_REPOSITORIES" -Ddw.coinbase.apiKey=$COINBASE_API_KEY -Ddw.github.webhook.password=$GITHUB_WEBHOOK_PASSWORD -Ddw.organization.name="$ORGANIZATION_NAME" -Ddw.organization.donationUrl=$DONATION_URL -jar target/BitHub-0.1.jar server

README.md

@@ -38,6 +38,8 @@ $ heroku config:set GITHUB_TOKEN=your_bithub_authtoken
 $ heroku config:set GITHUB_WEBHOOK_PASSWORD=your_webhook_password
 $ heroku config:set GITHUB_REPOSITORIES="[{\"url\" : \"https://github.com/youraccount/yourrepo\"}, {\"url\" : \"https://github.com/youraccount/yourotherrepo\"}]"
 $ heroku config:set COINBASE_API_KEY=your_api_key
+$ heroku config:set ORGANIZATION_NAME=your_organization_name
+$ heroku config:set DONATION_URL=your_donation_url
 $ git remote add your_heroku_remote
 $ git push heroku master
 ```

config/sample.yml

@@ -1,8 +1,14 @@
+organization:
+  name: # Your name (eg. Open Whisper Systems)
+  donationUrl: # A Coinbase link where you can receive donations (eg. https://coinbase.com/checkouts/d29fd4c37ca442393e32fdcb95304701)
+
 github:
   user: # Your BitHub instance's GitHub username.
   token: # Your BitHub instance's GitHub auth token.
+
   webhook:
     password: # HTTP basic auth. The username defaults to "bithub".
+
   repositories: # A list of repository URLs to support payouts for.
     - url: # A repository's URL
       mode: # Either MONEYMONEY (default) or FREEBIE.

pom.xml

@@ -56,6 +56,11 @@
             <artifactId>dropwizard-views</artifactId>
             <version>${dropwizard.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.dropwizard</groupId>
+            <artifactId>dropwizard-views-mustache</artifactId>
+            <version>${dropwizard.version}</version>
+        </dependency>
         <dependency>
             <groupId>io.dropwizard</groupId>
             <artifactId>dropwizard-servlets</artifactId>

src/main/java/org/whispersystems/bithub/BithubServerConfiguration.java

@@ -21,6 +21,7 @@
 import org.whispersystems.bithub.config.BithubConfiguration;
 import org.whispersystems.bithub.config.CoinbaseConfiguration;
 import org.whispersystems.bithub.config.GithubConfiguration;
+import org.whispersystems.bithub.config.OrganizationConfiguration;
 
 import javax.validation.Valid;
 import javax.validation.constraints.NotNull;
@@ -43,6 +44,11 @@ public class BithubServerConfiguration extends Configuration {
   @Valid
   private BithubConfiguration bithub = new BithubConfiguration();
 
+  @Valid
+  @NotNull
+  @JsonProperty
+  private OrganizationConfiguration organization;
+
 
   public GithubConfiguration getGithubConfiguration() {
     return github;
@@ -56,4 +62,7 @@ public BithubConfiguration getBithubConfiguration() {
     return bithub;
   }
 
+  public OrganizationConfiguration getOrganizationConfiguration() {
+    return organization;
+  }
 }

src/main/java/org/whispersystems/bithub/BithubService.java

@@ -22,10 +22,12 @@
 import org.whispersystems.bithub.client.CoinbaseClient;
 import org.whispersystems.bithub.client.GithubClient;
 import org.whispersystems.bithub.config.RepositoryConfiguration;
+import org.whispersystems.bithub.controllers.DashboardController;
 import org.whispersystems.bithub.controllers.GithubController;
 import org.whispersystems.bithub.controllers.StatusController;
 import org.whispersystems.bithub.mappers.IOExceptionMapper;
 import org.whispersystems.bithub.mappers.UnauthorizedHookExceptionMapper;
+import org.whispersystems.bithub.storage.CacheManager;
 
 import javax.servlet.DispatcherType;
 import java.math.BigDecimal;
@@ -60,14 +62,22 @@ public void run(BithubServerConfiguration config, Environment environment)
     String                        githubWebhookPwd   = config.getGithubConfiguration().getWebhookConfiguration().getPassword();
     List<RepositoryConfiguration> githubRepositories = config.getGithubConfiguration().getRepositories();
     BigDecimal                    payoutRate         = config.getBithubConfiguration().getPayoutRate();
-    GithubClient                  githubClient       = new GithubClient(githubUser, githubToken);
-    CoinbaseClient                coinbaseClient     = new CoinbaseClient(config.getCoinbaseConfiguration().getApiKey());
+    String                        organizationName   = config.getOrganizationConfiguration().getName();
+    String                        donationUrl        = config.getOrganizationConfiguration().getDonationUrl().toExternalForm();
+
+    GithubClient   githubClient   = new GithubClient(githubUser, githubToken);
+    CoinbaseClient coinbaseClient = new CoinbaseClient(config.getCoinbaseConfiguration().getApiKey());
+    CacheManager   cacheManager   = new CacheManager(coinbaseClient, githubClient, githubRepositories, payoutRate);
 
     environment.servlets().addFilter("CORS", CrossOriginFilter.class)
                .addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
-    
+
+    environment.lifecycle().manage(cacheManager);
+
     environment.jersey().register(new GithubController(githubRepositories, githubClient, coinbaseClient, payoutRate));
-    environment.jersey().register(new StatusController(coinbaseClient, payoutRate));
+    environment.jersey().register(new StatusController(cacheManager, githubRepositories));
+    environment.jersey().register(new DashboardController(organizationName, donationUrl, cacheManager));
+
     environment.jersey().register(new IOExceptionMapper());
     environment.jersey().register(new UnauthorizedHookExceptionMapper());
     environment.jersey().register(new BasicAuthProvider<>(new GithubWebhookAuthenticator(githubWebhookUser, githubWebhookPwd),

src/main/java/org/whispersystems/bithub/client/CoinbaseClient.java

@@ -30,8 +30,8 @@
 import org.whispersystems.bithub.entities.BitcoinTransaction;
 import org.whispersystems.bithub.entities.BitcoinTransactionResponse;
 import org.whispersystems.bithub.entities.ExchangeRate;
-import org.whispersystems.bithub.entities.RecentTransactionsResponse;
-import org.whispersystems.bithub.entities.Transaction;
+import org.whispersystems.bithub.entities.CoinbseRecentTransactionsResponse;
+import org.whispersystems.bithub.entities.CoinbaseTransaction;
 
 import javax.ws.rs.core.MediaType;
 import java.io.IOException;
@@ -59,12 +59,12 @@ public CoinbaseClient(String apiKey) {
     this.client = Client.create(getClientConfig());
   }
 
-  public List<Transaction> getRecentTransactions() throws IOException {
+  public List<CoinbaseTransaction> getRecentTransactions() throws IOException {
     try {
       return client.resource(COINBASE_URL)
                    .path(RECENT_TRANSACTIONS_PATH)
                    .queryParam("api_key", apiKey)
-                   .get(RecentTransactionsResponse.class).getTransactions();
+                   .get(CoinbseRecentTransactionsResponse.class).getTransactions();
     } catch (UniformInterfaceException | ClientHandlerException e) {
       throw new IOException(e);
     }

src/main/java/org/whispersystems/bithub/client/GithubClient.java

@@ -42,8 +42,10 @@
  */
 public class GithubClient {
 
-  private static final String GITHUB_URL   = "https://api.github.com/";
-  private static final String COMMENT_PATH = "/repos/%s/%s/commits/%s/comments";
+  private static final String GITHUB_URL      = "https://api.github.com/";
+  private static final String COMMENT_PATH    = "/repos/%s/%s/commits/%s/comments";
+  private static final String COMMIT_PATH     = "/repos/%s/%s/git/commits/%s";
+  private static final String REPOSITORY_PATH = "/repos/%s/%s";
 
   private final Logger logger = LoggerFactory.getLogger(GithubClient.class);
 
@@ -55,6 +57,37 @@ public GithubClient(String user, String token) {
     this.client              = Client.create(getClientConfig());
   }
 
+  public String getCommitDescription(String commitUrl) {
+    String[] commitUrlParts = commitUrl.split("/");
+    String   owner          = commitUrlParts[commitUrlParts.length - 4];
+    String   repository     = commitUrlParts[commitUrlParts.length - 3];
+    String   commit         = commitUrlParts[commitUrlParts.length - 1];
+
+    String      path     = String.format(COMMIT_PATH, owner, repository, commit);
+    WebResource resource = client.resource(GITHUB_URL).path(path);
+    Commit      response = resource.type(MediaType.APPLICATION_JSON_TYPE)
+                                   .accept(MediaType.APPLICATION_JSON_TYPE)
+                                   .header("Authorization", authorizationHeader)
+                                   .get(Commit.class);
+
+    return response.getMessage();
+  }
+
+  public Repository getRepository(String url) {
+    String[] urlParts = url.split("/");
+    String   owner    = urlParts[urlParts.length - 2];
+    String   name     = urlParts[urlParts.length - 1];
+
+    String      path     = String.format(REPOSITORY_PATH, owner, name);
+    WebResource resource = client.resource(GITHUB_URL).path(path);
+
+    return resource.type(MediaType.APPLICATION_JSON_TYPE)
+                   .accept(MediaType.APPLICATION_JSON_TYPE)
+                   .header("Authorization", authorizationHeader)
+                   .get(Repository.class);
+
+  }
+
   public void addCommitComment(Repository repository, Commit commit, String comment) {
     try {
       String path = String.format(COMMENT_PATH, repository.getOwner().getName(),

src/main/java/org/whispersystems/bithub/config/OrganizationConfiguration.java

@@ -0,0 +1,26 @@
+package org.whispersystems.bithub.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import org.hibernate.validator.constraints.NotEmpty;
+
+import javax.validation.Valid;
+import java.net.URL;
+
+public class OrganizationConfiguration {
+
+  @JsonProperty
+  @NotEmpty
+  private String name;
+
+  @JsonProperty
+  @Valid
+  private URL donationUrl;
+
+  public String getName() {
+    return name;
+  }
+
+  public URL getDonationUrl() {
+    return donationUrl;
+  }
+}

src/main/java/org/whispersystems/bithub/controllers/DashboardController.java

@@ -0,0 +1,39 @@
+package org.whispersystems.bithub.controllers;
+
+import com.codahale.metrics.annotation.Timed;
+import org.whispersystems.bithub.storage.CacheManager;
+import org.whispersystems.bithub.views.DashboardView;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+@Path("/")
+public class DashboardController {
+
+  private final CacheManager cacheManager;
+  private final String       organizationName;
+  private final String       donationUrl;
+
+
+
+  public DashboardController(String organizationName, String donationUrl,
+                             CacheManager cacheManager)
+  {
+    this.organizationName = organizationName;
+    this.donationUrl      = donationUrl;
+    this.cacheManager     = cacheManager;
+  }
+
+  @Timed
+  @GET
+  @Produces(MediaType.TEXT_HTML)
+  public DashboardView getDashboard() {
+    return new DashboardView(organizationName, donationUrl,
+                             cacheManager.getCurrentPaymentAmount(),
+                             cacheManager.getRepositories(),
+                             cacheManager.getRecentTransactions());
+  }
+
+}