feat: Add a 'token' attribute for passing an authorization header wit…

…h the HTTP requests
grappendorf · Mar 17, 2015 · 86dd824 · 86dd824
1 parent 3ba72f1
commit 86dd824
Show file tree

Hide file tree

Showing 8 changed files with 68 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -82,6 +82,18 @@ Attributes
 
     Use this URL instead of the default one for "PUT /resources/:id/action" requests.
 
+  * **headers**
+
+    - *type:* object
+
+    Set additional headers on the request.
+
+  * ** token**
+
+    - *type:* string
+
+    Set an authorization header with the specified token text.
+
 
 Events
 ------

diff --git a/bower.json b/bower.json
@@ -38,6 +38,6 @@
   "devDependencies": {
     "coffee-script": "latest",
     "jquery": "latest",
-    "web-component-tester": "Polymer/web-component-tester#latest"
+    "web-component-tester": "Polymer/web-component-tester#2.2.6"
   }
 }
diff --git a/grapp-rest-resource.html b/grapp-rest-resource.html
@@ -12,7 +12,7 @@
 <link href="../core-ajax/core-xhr.html" rel="import">
 
 <polymer-element name="grapp-rest-resource"
-  attributes="url params resource indexUrl showUrl newUrl createUrl updateUrl deleteUrl memberUrl headers">
+  attributes="url params resource indexUrl showUrl newUrl createUrl updateUrl deleteUrl memberUrl headers token">
 
   <template>
 
@@ -199,6 +199,9 @@
         val = _ref[key];
         h[key] = val;
       }
+      if (this.token) {
+        h['Authorization'] = this.token;
+      }
       return h;
     }
   });

diff --git a/src/grapp-rest-resource.coffee b/src/grapp-rest-resource.coffee
@@ -111,4 +111,5 @@ Polymer 'grapp-rest-resource',
     h = {'Accept': 'application/json'}
     for key, val of @headers
       h[key] = val
+    h['Authorization'] = @token if @token
     h
diff --git a/src/grapp-rest-resource.html b/src/grapp-rest-resource.html
@@ -10,7 +10,7 @@
 <link href="../core-ajax/core-xhr.html" rel="import">
 
 <polymer-element name="grapp-rest-resource"
-  attributes="url params resource indexUrl showUrl newUrl createUrl updateUrl deleteUrl memberUrl headers">
+  attributes="url params resource indexUrl showUrl newUrl createUrl updateUrl deleteUrl memberUrl headers token">
 
   <template>
 

diff --git a/test/basic.html b/test/basic.html
@@ -13,7 +13,7 @@
 </head>
 <body>
 
-  <grapp-rest-resource id="element" url="data.json"></grapp-rest-resource>
+  <grapp-rest-resource id="element" url="data.json" headers='{"foo":123}'></grapp-rest-resource>
 
   <grapp-rest-resource id="element_with_special_url" url="data.json"
     indexUrl="special_data.json"></grapp-rest-resource>

diff --git a/test/headers.html b/test/headers.html
@@ -0,0 +1,46 @@
+<!doctype html>
+<html>
+
+<head>
+  <meta charset="UTF-8">
+  <title>grapp-rest-resource headers tests</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
+
+  <script src="../lib/web-component-tester/browser.js"></script>
+  <script src="../lib/coffee-script/extras/coffee-script.js"></script>
+
+  <link href="../grapp-rest-resource.html" rel="import">
+</head>
+<body>
+
+  <grapp-rest-resource id="element_with_headers" url="http://api.example.com"
+    headers='{"foo":123}'></grapp-rest-resource>
+
+  <grapp-rest-resource id="element_with_token" url="http://api.example.com"
+    token="JWT"></grapp-rest-resource>
+
+  <script type="text/coffeescript">
+
+    describe 'with defined hedaers attribute ', ->
+
+      it 'sends the custom headers', ->
+        element = document.querySelector '#element_with_headers'
+        xhr_request = sinon.stub element.$.xhr, 'request'
+        element.resource.index()
+        expect(xhr_request).to.have.been.calledWith sinon.match {headers: {foo: 123}}
+
+    describe 'with defined token attribute ', ->
+
+      it 'sends the an authorization header', ->
+        element = document.querySelector '#element_with_token'
+        xhr_request = sinon.stub element.$.xhr, 'request'
+        element.resource.index()
+        expect(xhr_request).to.have.been.calledWith sinon.match {headers: {Authorization: 'JWT'}}
+
+  </script>
+
+  <script>
+  </script>
+
+</body>
+</html>
diff --git a/test/index.html b/test/index.html
@@ -12,7 +12,8 @@
 
   <script>
     WCT.loadSuites([
-      'basic.html'
+      'basic.html',
+      'headers.html'
     ]);
   </script>