Merge pull request #207 from dirk/dirk/well-known-routes

Well-known routes

Author: alexcrichton

.env

@@ -0,0 +1,25 @@
+# Credentials for uploading packages to S3, these can be blank if you're not
+# publishing locally.
+S3_BUCKET=
+S3_ACCESS_KEY=
+S3_SECRET_KEY=
+# Not needed if the S3 bucket is in US standard
+S3_REGION=      
+
+# Credentials for talking to github, can be blank if you're not logging in.
+#
+# When registering a new application, be sure to set the callback url to the
+# address `http://localhost:4200/authorize/github`.
+GH_CLIENT_ID=
+GH_CLIENT_SECRET=
+
+# Key to sign and encrypt cookies with
+SESSION_KEY=badkey
+
+# Location of the *postgres* database
+# (eg. postgres://postgres:@localhost/cargo_registry)
+DATABASE_URL=postgres://postgres:@localhost/cargo_registry
+
+# Remote and local locations of the registry index
+GIT_REPO_URL=file://./tmp/index-bare
+GIT_REPO_CHECKOUT=./tmp/index-co

app/controllers/crate/docs.js

@@ -0,0 +1,4 @@
+import Ember from 'ember';
+
+export default Ember.ObjectController.extend({
+});

app/router.js

@@ -16,6 +16,9 @@ Router.map(function() {
     this.route('download');
     this.route('versions');
     this.route('reverse_dependencies');
+
+    // Well-known routes
+    this.route('docs');
   });
   this.route('me', function() {
     this.route('crates');

app/routes/crate/docs.js

@@ -0,0 +1,28 @@
+import Ember from 'ember';
+import Crate from 'cargo/models/crate';
+
+export default Ember.Route.extend({
+    setupController: function(controller, data) {
+        var crate;
+
+        if (data instanceof Crate) {
+            crate = data;
+        } else {
+            crate = data.crate;
+        }
+
+        var documentation = crate.get('documentation');
+
+        if (documentation) {
+            window.location = documentation;
+        } else {
+            // Redirect to the crate's main page and show a flash error if
+            // no documentation is found
+            var message = 'Crate does not supply a documentation URL';
+            this.controllerFor('application').set('nextFlashError', message);
+            this.replaceWith('crate', crate);
+        }
+
+        this._super(controller, crate);
+    },
+});

app/templates/crate/docs.hbs

@@ -0,0 +1,8 @@
+<div id="crates-heading">
+    <img class="logo" src="/assets/circle-with-i.png"/>
+    <h1>Documentation for <em>{{name}}</em></h1>
+</div>
+
+<p>
+    Redirecting you to <code>{{documentation}}</code>&#8230;
+</p>