Merge pull request #166 from teamsnap/browser-logout

Add method for ending browserAuth session

Author: matthopson

CHANGELOG.md

@@ -1,5 +1,8 @@
 # TeamSnap JavaScript SDK CHANGELOG
 
+### March 20, 2017 // Version 1.24.0
+- Add `browserLogout` method to end a session started with `startBrowserAuth`.
+
 ### February 27, 2017 // Version 1.23.2
 - Bug fix that adds `sendInvites` to `importMembersFromTeam` method in persistence layer.
 

lib/teamsnap.js

@@ -120,7 +120,7 @@ var require = global.require;
 global = this;
 if (global.window) window = this;
 require.register("auth.coffee", function(exports, require, module) {
-var TeamSnap, authRequest, browserStorageName, browserStore, collectionJSONMime, createAuthDialog, jsonMime, multipartMime, promises, request, sdkRequest;
+var TeamSnap, authRequest, browserStorageName, browserStore, collectionJSONMime, createAuthDialog, generateUrl, jsonMime, multipartMime, promises, request, sdkRequest;
 
 TeamSnap = require('./teamsnap').TeamSnap;
 
@@ -152,6 +152,22 @@ sdkRequest = request.create().hook(function(xhr, data) {
   return xhr.withCredentials = true;
 });
 
+generateUrl = function(endpoint, params) {
+  var key, queries, url, value;
+  queries = [];
+  for (key in params) {
+    value = params[key];
+    if (value) {
+      queries.push(key + '=' + encodeURIComponent(value));
+    }
+  }
+  url = teamsnap.authUrl + '/oauth/' + endpoint;
+  if (queries.length) {
+    url = url + '?' + queries.join('&');
+  }
+  return url.replace(/%20/g, '+');
+};
+
 TeamSnap.prototype.auth = function(token) {
   var cachedCollections, callback;
   if (typeof token === 'function') {
@@ -197,20 +213,15 @@ TeamSnap.prototype.hasSession = function() {
   return !!browserStore();
 };
 
+TeamSnap.prototype.browserLogout = function() {
+  createAuthDialog(teamsnap.authUrl + '/logout');
+  if (this.isAuthed) {
+    return this.deleteAuth();
+  }
+};
+
 TeamSnap.prototype.init = function(clientId, secret) {
-  var generateAuthUrl, generatePasswordUrl, generateTokenUrl, generateUrl;
-  generateUrl = function(endpoint, params) {
-    var key, queries, url, value;
-    queries = [];
-    for (key in params) {
-      value = params[key];
-      if (value) {
-        queries.push(key + '=' + encodeURIComponent(value));
-      }
-    }
-    url = teamsnap.authUrl + '/oauth/' + endpoint + '?' + queries.join('&');
-    return url.replace(/%20/g, '+');
-  };
+  var generateAuthUrl, generatePasswordUrl, generateTokenUrl;
   generateAuthUrl = function(type, redirect, scopes) {
     scopes = Array.isArray(scopes) ? scopes.join(' ') : scopes;
     return generateUrl('authorize', {
@@ -6655,7 +6666,7 @@ ref = require('./model'), Collection = ref.Collection, Item = ref.Item;
 require('./errors');
 
 TeamSnap = (function() {
-  TeamSnap.prototype.version = '1.23.2';
+  TeamSnap.prototype.version = '1.24.0';
 
   TeamSnap.prototype.promises = promises;
 

lib/teamsnap.min.js

@@ -1,6 +1,6 @@
 {
   "name": "teamsnap.js",
-  "version": "1.23.2",
+  "version": "1.24.0",
   "engines": {
     "node": "^7.0.0",
     "npm": "^3.0.0"

package.json

@@ -19,6 +19,19 @@ sdkRequest = request.create().hook (xhr, data) ->
     xhr.setRequestHeader('Content-Type', collectionJSONMime)
   xhr.withCredentials = true
 
+# Generates urls
+generateUrl = (endpoint, params) ->
+  queries = []
+  for key, value of params
+    if value
+      queries.push key + '=' + encodeURIComponent value
+  url = teamsnap.authUrl + '/oauth/' + endpoint
+
+  if queries.length
+    url = url + '?' + queries.join('&')
+
+  url.replace /%20/g, '+'
+
 
 # Need 3 types of authentications
 # 1. server-side app
@@ -106,21 +119,15 @@ TeamSnap::isAuthed = ->
 TeamSnap::hasSession = ->
   !!browserStore()
 
+# Destroy session with auth server and removes request object (if authed)
+TeamSnap::browserLogout = ->
+  createAuthDialog(teamsnap.authUrl + '/logout')
+  if @isAuthed
+    @deleteAuth()
 
 # Initializes teamsnap with clientId (and optionally secret on the server) to
 # allow authorization flows
 TeamSnap::init = (clientId, secret) ->
-
-  # Generates urls
-  generateUrl = (endpoint, params) ->
-    queries = []
-    for key, value of params
-      if value
-        queries.push key + '=' + encodeURIComponent value
-    url = teamsnap.authUrl + '/oauth/' + endpoint + '?' + queries.join('&')
-    url.replace /%20/g, '+'
-
-
   # Generates the auth url for a resource owner to auth a client
   generateAuthUrl = (type, redirect, scopes) ->
     scopes = if Array.isArray(scopes) then scopes.join ' ' else scopes

src/auth.coffee

@@ -3,7 +3,7 @@ promises = require './promises'
 require './errors'
 
 class TeamSnap
-  version: '1.23.2'
+  version: '1.24.0'
   promises: promises
   when: promises.when
   TeamSnap: TeamSnap