Accept servers as base URLs instead of full API store URLs

Author: bkonkle

README.md

@@ -44,20 +44,23 @@ you want to access Sentry from.
 
 Next, configure the client by passing the DSN as the first argument:
 
- Raven.config('http://secret:public@example.com/project-id');
+ Raven.config('http://public@example.com/project-id');
 
 Or if you need to specify additional options:
 
  Raven.config({
   "publicKey": "e89652ec30b94d9db6ea6f28580ab499",
-  "servers": ["http://your.sentryserver.com/api/1/store/"],
+  "servers": ["http://your.sentryserver.com/"],
   "projectId": "project-id",
   "logger": "yoursite.errors.javascript"
  });
 
 **publicKey** - The desired user's public key.
 
-**servers** - (*required*) An array of servers to send exception info to.
+**servers** - (*required*) An array of servers to send exception info to. This
+should be just the base URL. For example, if your API store URL is
+"http://mysentry.com/api/4/store/", then the base URL is "http://mysentry.com/"
+and the projectId is 4.
 
 **projectId** - The id of the project to log the exception to. Defaults to '1'.
 

src/raven.js

@@ -12,7 +12,7 @@
  var root = this;
 
  var Raven;
- Raven = root.Raven = {};
+ root.Raven = Raven = {};
 
  var self = Raven;
 
@@ -37,6 +37,8 @@
  Raven.funcNameRE = /function\s*([\w\-$]+)?\s*\(/i;
 
  Raven.config = function(config) {
+ var servers = [];
+
  if (typeof(config) === "string") {
  if (config.indexOf('http') === 0) {
  // new-style DSN configuration
@@ -45,9 +47,20 @@
  throw "Base64 encoded config is no longer supported - use DSN";
  }
  }
- $.each(config, function(i, option) {
- self.options[i] = option;
+
+ $.each(config, function(key, option) {
+ self.options[key] = option;
+ });
+
+ // Expand server base URLs into API URLs
+ $.each(self.options['servers'], function(i, server) {
+ // Add a trailing slash if one isn't provided
+ if (server.slice(-1) !== '/') {
+ server += '/';
+ }
+ servers.push(server + 'api/' + self.options['projectId'] + '/store/');
  });
+ self.options['servers'] = servers;
 
  };
 
@@ -66,7 +79,7 @@
  }
 
  return {
- servers: [uri.protocol + '://' + uri.host + ':' + uri.port + '/' + path + 'api/' + project_id + '/store/'],
+ servers: [uri.protocol + '://' + uri.host + ':' + uri.port + '/' + path],
  publicKey: uri.user,
  secretKey: uri.password,
  projectId: project_id

test/process.js

@@ -8,7 +8,7 @@ $(document).ready(function() {
  values[value.split('=')[0]] = value.split('=')[1];
  });
  return values;
- };
+ }
 
  var message = "Once upon a midnight dreary",
  fileurl = 'http://edgarallen.poe/nevermore/',

test/test.html

@@ -40,11 +40,13 @@ <h2 id="qunit-userAgent"></h2>
  <ol id="qunit-tests"></ol>
  <div id="qunit-fixture">
  <!-- Reset the test environment between each test -->
+ <script type="text/javascript" src="../src/raven.js"></script>
+
  <script type="text/javascript">
  var config_opts = {
  "publicKey": "e89652ec30b94d9db6ea6f28580ab499",
  "secretKey": "77ec8c99a8854256aa68ccb91dd9119d",
- "servers": ["/api/default/store/"],
+ "servers": ["/"],
  "signatureUrl": null,
  "testMode": true
  };

test/utils.js

@@ -3,7 +3,6 @@ $(document).ready(function() {
  module("Raven.config");
 
  test("should parse dsn as only argument", function() {
- // TODO: this test isnt isolated
  var dsn = "http://public:secret@example.com:80/project-id";
 
  Raven.config(dsn);
@@ -13,16 +12,43 @@ $(document).ready(function() {
  equal(config['secretKey'], 'secret');
  equal(config['servers'][0], 'http://example.com:80/api/project-id/store/');
  equal(config['projectId'], 'project-id');
+ });
+
+ test("should accept servers as base URLs and add API info", function() {
+ Raven.config({
+ "publicKey": "public",
+ "servers": ["http://mysentry.com/"],
+ "projectId": "project-id"
+ });
+
+ var config = Raven.options;
+
+ equal(config['publicKey'], 'public');
+ equal(config['servers'][0], 'http://mysentry.com/api/project-id/store/');
+ equal(config['projectId'], 'project-id');
+ });
+
+ test("should handle base URLs without a trailing slash", function() {
+ Raven.config({
+ "publicKey": "public",
+ "servers": ["http://mysentry.com"],
+ "projectId": "project-id"
+ });
+
+ var config = Raven.options;
 
+ equal(config['publicKey'], 'public');
+ equal(config['servers'][0], 'http://mysentry.com/api/project-id/store/');
+ equal(config['projectId'], 'project-id');
  });
 
  module("Raven.parseHeaders");
 
  test("should parse headers into an object", function() {
- var hstring = "Date: Mon, 06 Feb 2012 17:25:42 GMT\n"
- hstring += "Server: WSGIServer/0.1 Python/2.7.2\n"
- hstring += "Vary: Cookie\n"
- hstring += "Content-Type: text/html; charset=utf-8\n"
+ var hstring = "Date: Mon, 06 Feb 2012 17:25:42 GMT\n";
+ hstring += "Server: WSGIServer/0.1 Python/2.7.2\n";
+ hstring += "Vary: Cookie\n";
+ hstring += "Content-Type: text/html; charset=utf-8\n";
 
  var headers = Raven.parseHeaders(hstring);
  equal(headers['Date'], "Mon, 06 Feb 2012 17:25:42 GMT");
@@ -51,7 +77,7 @@ $(document).ready(function() {
  var config = Raven.parseDSN(dsn);
  equal(config['publicKey'], 'public');
  equal(config['secretKey'], 'secret');
- equal(config['servers'][0], 'http://example.com:80/api/project-id/store/');
+ equal(config['servers'][0], 'http://example.com:80/');
  equal(config['projectId'], 'project-id');
  });
 
@@ -62,7 +88,7 @@ $(document).ready(function() {
  var config = Raven.parseDSN(dsn);
  equal(config['publicKey'], 'public');
  equal(config['secretKey'], 'secret');
- equal(config['servers'][0], 'http://example.com:80/path/api/project-id/store/');
+ equal(config['servers'][0], 'http://example.com:80/path/');
  equal(config['projectId'], 'project-id');
  });
 
@@ -72,7 +98,7 @@ $(document).ready(function() {
  var config = Raven.parseDSN(dsn);
  equal(config['publicKey'], 'public');
  equal(config['secretKey'], '');
- equal(config['servers'][0], 'http://example.com:80/path/api/project-id/store/');
+ equal(config['servers'][0], 'http://example.com:80/path/');
  equal(config['projectId'], 'project-id');
  });