grape-batch 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba051e13b667b77094be62bf479aebf5452fc3e
-  data.tar.gz: f28bd7313a6376bd8a56792e1744dbadf63d19b3
+  metadata.gz: eb4dfcf0e90958b52990dfe1baae968e533b2ac8
+  data.tar.gz: ee69288ac014717af2465e68358007cb055be8a5
 SHA512:
-  metadata.gz: 7155185197a009f8a884a622d05cfb3f877f2990bffa0382c9424c3cf004b67f448e79a1b116a63d39979ad20dd5e2c550201fcf01a51d30f622a7ec7dafcfd5
-  data.tar.gz: 5d83dae879c57aa6ce723e4df16528b82fd04d6eb8d67bca4a53e4fa87fc5ba8de699cea6b2aaca4c1df12c8701e99a73e87449052a98d14b50f0c4b92f4709c
+  metadata.gz: ea924509379e820daf936ac90f5c030fbd72ebc7c66aa5119d6354d14070039762c0a8bf141b07bffcf12de32d14b699a6937c5ad7607ab0097b6d8ba76e7f74
+  data.tar.gz: a48b02990c38dadd8dd00ddc3ef6a861ecf904a1f8cc71caacc9a7247dae81616d4848afd0c0ded73713224285c7d8f0214eacdb61bcca0048723575b86a4fce

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.2.2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.2.0 (13th November 2015)
+* Added authentication during request batch
+
+# 2.1.1 (5th November 2015)
+* Code refactoring to prepare next features
+
 # 2.1.0 (4th November 2015)
 * Removed error response format because of unexpected side effects
 

data/README.md

@@ -100,6 +100,7 @@ POST http request on the default URL with a similar body:
 'body' is optional.
 
 ### Sessions
+#### Single authentication
 It's possible ensure a single session during the execution of the batch. You have to specify your session Proc. Before running the batch, the Proc is executed (with env as argument) and stored in rack env 'api.session' key.
 ```ruby
 # Example
@@ -120,6 +121,50 @@ module AuthHelpers
 end
 ```
 
+#### Authentication during request batch
+It is possible to either keep a token (or a session) generated by a request of the batch and pass it to the following ones.
+```ruby
+# Token example
+# Considering this API
+module Twitter
+  class API < Grape::API
+    version 'v1', using: :path
+    format :json
+    prefix 'api'
+    
+    resource :session do
+        get do
+            # route logic
+            header 'HTTP_X_API_TOKEN', 'my_fresh_token'
+            # some other logic
+        end
+    end
+end
+
+# This route will return a token header. The header will be kept and passed to the following requests by Grape::Batch. The header will not be added to the final batch response. 
+```
+
+```ruby
+# Session example
+# Considering this API
+module Twitter
+  class API < Grape::API
+    version 'v1', using: :path
+    format :json
+    prefix 'api'
+    
+    resource :session do
+        get do
+            # route logic
+            header 'api.session', OpenStruct(id: '123456')
+            # some other logic
+        end
+    end
+end
+
+# This route will return a session object. The header will be kept and passed to the following requests by Grape::Batch. The header will not be added to the final batch response. 
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/c4mprod/grape-batch/fork )

data/lib/grape/{batch.rb → base.rb}

@@ -11,6 +11,9 @@ module Grape
   module Batch
     # Gem main class
     class Base
+      SESSION_HEADER = 'api.session'.freeze
+      TOKEN_HEADER = 'HTTP_X_API_TOKEN'.freeze
+
       def initialize(app)
         @app = app
         @response_klass = Grape::Batch.configuration.formatter
@@ -49,19 +52,32 @@ module Grape
       end
 
       def dispatch(env, batch_requests)
-        # Call session proc
-        env['api.session'] = @session_proc.call(env)
-
         # Prepare batch request env
-        request_env = env.dup
+        @request_env = env.dup
+        # Call session proc
+        @request_env[SESSION_HEADER] = @session_proc.call(@request_env)
 
         # Call batch request
         batch_requests.map do |batch_request|
-          batch_env = Grape::Batch::Request.new(request_env, batch_request).build
+          batch_env = Grape::Batch::Request.new(@request_env, batch_request).build
           status, headers, response = @app.call(batch_env)
+
+          update_request_env_session_from_headers(headers)
+          update_request_env_token_from_headers(headers)
+
           @response_klass.format(status, headers, response)
         end
       end
+
+      def update_request_env_session_from_headers(headers)
+        return if !headers[SESSION_HEADER] || @request_env[SESSION_HEADER]
+        @request_env[SESSION_HEADER] = headers[SESSION_HEADER].dup
+      end
+
+      def update_request_env_token_from_headers(headers)
+        return if !headers[TOKEN_HEADER] || @request_env[TOKEN_HEADER]
+        @request_env[TOKEN_HEADER] = headers[TOKEN_HEADER].dup
+      end
     end
   end
 end

data/lib/grape/batch/version.rb

@@ -1,6 +1,6 @@
 module Grape
   # Gem main module
   module Batch
-    VERSION = '2.1.1'
+    VERSION = '2.2.0'
   end
 end

data/spec/api.rb

@@ -57,6 +57,38 @@ module Twitter
       end
     end
 
+    resource :login do
+      get do
+        header 'HTTP_X_API_TOKEN', 'user_token'
+
+        'login successful'
+      end
+
+      post do
+        if env['HTTP_X_API_TOKEN'] == 'user_token'
+          'token valid'
+        else
+          'token invalid'
+        end
+      end
+    end
+
+    resource :session do
+      get do
+        header 'api.session', OpenStruct.new(nick: 'Bob')
+
+        'session reloaded'
+      end
+
+      post do
+        if env['api.session'] && env['api.session'].nick == 'Bob'
+          'session valid'
+        else
+          'session invalid'
+        end
+      end
+    end
+
     # 404
     #
     route :any, '*path' do

data/spec/grape/batch/base_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'rack/test'
 require 'grape'
-require 'grape/batch'
+require 'grape/base'
 require 'api'
 
 RSpec.describe Grape::Batch::Base do
@@ -177,6 +177,44 @@ RSpec.describe Grape::Batch::Base do
         it { expect(decode(response.body).size).to eq(2) }
       end
     end
+
+    describe 'single session' do
+      describe 'without token' do
+        let(:request_1) { { method: 'POST', path: '/api/v1/login' } }
+        let(:request_body) { encode(requests: [request_1]) }
+        it { expect(response.status).to eq(200) }
+        it { expect(response.body).to eq(encode([{ success: 'token invalid' }])) }
+        it { expect(response.headers).to_not include('HTTP_X_API_TOKEN') }
+      end
+
+      describe 'with a token' do
+        let(:request_1) { { method: 'GET', path: '/api/v1/login' } }
+        let(:request_2) { { method: 'POST', path: '/api/v1/login' } }
+        let(:request_body) { encode(requests: [request_1, request_2]) }
+        let(:expected_response) { [{ success: 'login successful' }, { success: 'token valid' }] }
+        it { expect(response.status).to eq(200) }
+        it { expect(response.body).to eq(encode(expected_response)) }
+        it { expect(response.headers).to_not include('HTTP_X_API_TOKEN') }
+      end
+
+      describe 'without session' do
+        let(:request_1) { { method: 'POST', path: '/api/v1/session' } }
+        let(:request_body) { encode(requests: [request_1]) }
+        it { expect(response.status).to eq(200) }
+        it { expect(response.body).to eq(encode([{ success: 'session invalid' }])) }
+        it { expect(response.headers).to_not include('api.session') }
+      end
+
+      describe 'with a session' do
+        let(:request_1) { { method: 'GET', path: '/api/v1/session' } }
+        let(:request_2) { { method: 'POST', path: '/api/v1/session' } }
+        let(:request_body) { encode(requests: [request_1, request_2]) }
+        let(:expected_response) { [{ success: 'session reloaded' }, { success: 'session valid' }] }
+        it { expect(response.status).to eq(200) }
+        it { expect(response.body).to eq(encode(expected_response)) }
+        it { expect(response.headers).to_not include('api.session') }
+      end
+    end
   end
 
   describe '#configure' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-batch
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Lionel Oto
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -145,7 +145,7 @@ files:
 - README.md
 - Rakefile
 - grape-batch.gemspec
-- lib/grape/batch.rb
+- lib/grape/base.rb
 - lib/grape/batch/configuration.rb
 - lib/grape/batch/converter.rb
 - lib/grape/batch/errors.rb
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Extends Grape::API to support request batching