Merge pull request #35 from Shopify/add_ability_to_use_csrf_tokens

Adding turbograft:remote:init Event
Shopify · Nov 11, 2014 · a9b1d94 · a9b1d94
2 parents 115ba88 + dddce45
commit a9b1d94
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/lib/assets/javascripts/turbograft/remote.coffee b/lib/assets/javascripts/turbograft/remote.coffee
@@ -14,6 +14,7 @@ class TurboGraft.Remote
     xhr = new XMLHttpRequest
     xhr.open(actualRequestType, @opts.httpUrl, true)
     xhr.setRequestHeader('Accept', 'text/html, application/xhtml+xml, application/xml')
+    triggerEvent('turbograft:remote:init', xhr: xhr)
 
     xhr.addEventListener 'loadstart', =>
       triggerEvent 'turbograft:remote:start',

diff --git a/test/example/app/views/pages/show.html.erb b/test/example/app/views/pages/show.html.erb
@@ -148,7 +148,8 @@
   </ul>
   <p>It emits a few events:</p>
   <ul>
-    <li><code>turbograft:remote:start</code>: before XHR is sent</li>
+    <li><code>turbograft:remote:init</code>: before XHR is sent</li>
+    <li><code>turbograft:remote:start</code>: when XHR is sent</li>
     <li><code>turbograft:remote:always</code>: always fires when XHR is done</li>
     <li><code>turbograft:remote:success</code>: always fires when XHR was successful</li>
     <li><code>turbograft:remote:fail</code>: always fires when XHR failed</li>
@@ -184,7 +185,8 @@
   </ul>
   <p>It emits a few events:</p>
   <ul>
-    <li><code>turbograft:remote:start</code>: before XHR is sent</li>
+    <li><code>turbograft:remote:init</code>: before XHR is sent</li>
+    <li><code>turbograft:remote:start</code>: when XHR is sent</li>
     <li><code>turbograft:remote:always</code>: always fires when XHR is done</li>
     <li><code>turbograft:remote:success</code>: always fires when XHR was successful</li>
     <li><code>turbograft:remote:fail</code>: always fires when XHR failed</li>

diff --git a/test/javascripts/remote_test.coffee b/test/javascripts/remote_test.coffee
@@ -55,6 +55,19 @@ describe 'Remote', ->
       assert.equal "POST", request.method
 
   describe 'TurboGraft events', ->
+
+    it 'allows turbograft:remote:init to set a header', ->
+      $(document).one "turbograft:remote:init", (event) ->
+        event.originalEvent.data.xhr.setRequestHeader("X-CSRF-Token", "anything")
+
+      server = sinon.fakeServer.create()
+      remote = new TurboGraft.Remote
+        httpRequestType: "POST"
+        httpUrl: "/foo/bar"
+
+      request = server.requests[0]
+      assert.equal "anything", request.requestHeaders["X-CSRF-Token"]
+
     it 'will trigger turbograft:remote:start on start with the XHR as the data', (done) ->
       $(document).one "turbograft:remote:start", (ev) ->
         assert.equal "/foo/bar", ev.originalEvent.data.xhr.url