grape-batch 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a41ffb8fd6505834517b904ba91f5af4ea891327
-  data.tar.gz: d1a99a6c05a9b2c4dc6291366d5469c5e05ceae1
+  metadata.gz: 483ecfa0b036413cd49c11f55a3c59529488e7a8
+  data.tar.gz: 32baccf14eaa0a23afff45f9d86802d42323defb
 SHA512:
-  metadata.gz: 6b9b9cb1822facd4f090cda89d973a91ba7ae4f9ead8427dd6efadeaa0d2912c36ed272b2fb57860a6230bbf269d21a105be90b13e8c69cd78a8135307288271
-  data.tar.gz: f50b49ed2fd3cf5589ba7c2f7803285c9b3fc349531baf730597d155a84267c0c9b18946d5a0fc4db3d86b7b343f5da723b79ecc398db3f412401774f52ca65b
+  metadata.gz: 1a78f087d10ac368f6fc7db6aec78c87bad58268da4fe374a19269eb199dc1d0d2cd4a3894b89cb3739b46a66b6606d01ed44e9b067113c8073706b79083d230
+  data.tar.gz: 678c766c786aba5a407851a28322bf3ec447f629a80086593cbe65242800f4ba2f1902a86ef3101a512cc275576730c14ebde618c7742d50a016be7e939d08b6

data/CHANGELOG.md

@@ -1,7 +1,10 @@
-# 1.1.3 (25th June 2014)
+# 1.1.4 (17th July 2015)
+* Added batch session
+
+# 1.1.3 (25th June 2015)
 * Fixed nested hash to url_encoded
 
-# 1.1.2 (17th February 2014)
+# 1.1.2 (17th February 2015)
 * Added logs
 
 # 1.1.1 (31st December 2014)

data/README.md

@@ -47,6 +47,9 @@ Grape::Batch.configure do |config|
   config.limit = 10
   config.path = '/batch'
   config.formatter = Grape::Batch::Response
+  config.logger = nil
+  config.session_header = 'HTTP_X_SESSION_TOKEN'
+  config.session_proc = Proc.new {}
 end
 ```
 
@@ -97,6 +100,28 @@ POST http request on the default URL with a similar body:
 
 'body' is optional.
 
+### Sessions
+It's possible ensure a single session during the execution of the batch. You have to specify your session/token/auth header and your session Proc. Before running the batch, the Proc is executed with the data extracted from the specified session header and stored in rack env 'api.session' key.
+```ruby
+# Example
+# Considering the config
+Grape::Batch.configure do |config|
+  config.session_header = 'HTTP_X_SESSION_TOKEN'
+  config.session_proc = Proc.new {|token| User.where(token: token).first }
+end
+
+# You can build a Grape helper like this
+module AuthHelpers
+  def current_user
+    if env['api.session']
+      env['api.session']
+    else
+      # do authentication stuff
+    end
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/c4mprod/grape-batch/fork )

data/lib/grape/batch/configuration.rb

@@ -1,13 +1,15 @@
 module Grape
   module Batch
     class Configuration
-      attr_accessor :path, :limit, :formatter, :logger
+      attr_accessor :path, :limit, :formatter, :logger, :session_proc, :session_header
 
       def initialize
-        @path  = '/batch'
+        @path = '/batch'
         @limit = 10
         @formatter = Grape::Batch::Response
         @logger = nil
+        @session_header = 'HTTP_X_SESSION_TOKEN'
+        @session_proc = Proc.new {}
       end
     end
 
@@ -28,4 +30,4 @@ module Grape
       yield configuration
     end
   end
-end
+end

data/lib/grape/batch/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Batch
-    VERSION = '1.1.3'
+    VERSION = '1.1.4'
   end
 end

data/lib/grape/batch.rb

@@ -1,6 +1,5 @@
 require 'active_support'
 require 'grape/batch/log_subscriber'
-
 require 'grape/batch/version'
 require 'grape/batch/errors'
 require 'grape/batch/configuration'
@@ -50,10 +49,14 @@ module Grape
         ActiveSupport::Notifications.instrument 'dispatch.batch' do |event|
           event[:requests] = []
 
+          session_data = env[Grape::Batch.configuration.session_header]
+          env['api.session'] = Grape::Batch.configuration.session_proc.call(session_data)
+
           # iterate
+          batch_env = env.dup
           batch_requests.map do |request|
             # init env for Grape resource
-            tmp_env = prepare_tmp_env(env.dup, request)
+            tmp_env = prepare_tmp_env(batch_env, request)
             status, headers, response = @app.call(tmp_env)
 
             # format response
@@ -69,18 +72,20 @@ module Grape
         method = request['method']
         path = request['path']
         body = request['body'].is_a?(Hash) ? request['body'] : {}
+        query_string = ''
+        rack_input = '{}'
 
-        tmp_env.tap do |env|
-          env['REQUEST_METHOD'] = method
-          env['PATH_INFO'] = path
-
-          if method == 'GET'
-            env['rack.input'] = StringIO.new('{}')
-            env['QUERY_STRING'] = URI.encode_www_form(HashConverter.encode(body).to_a)
-          else
-            env['rack.input'] = StringIO.new(MultiJson.encode(body))
-          end
+        if method == 'GET'
+          query_string = URI.encode_www_form(HashConverter.encode(body).to_a)
+        else
+          rack_input = StringIO.new(MultiJson.encode(body))
         end
+
+        tmp_env['REQUEST_METHOD'] = method
+        tmp_env['PATH_INFO'] = path
+        tmp_env['QUERY_STRING'] = query_string
+        tmp_env['rack.input'] = rack_input
+        tmp_env
       end
     end
   end

data/spec/requests_spec.rb

@@ -25,7 +25,6 @@ RSpec.describe Grape::Batch::Base do
   end
 
   describe '/api' do
-
     describe 'GET /hello' do
       let(:response) { request.get('/api/v1/hello') }
 
@@ -191,6 +190,7 @@ RSpec.describe Grape::Batch::Base do
           config = Grape::Batch::Configuration.new
           config.path = '/custom_path'
           config.limit = 15
+          config.session_proc = Proc.new { 3 + 2 }
           config
         end
       end
@@ -198,6 +198,7 @@ RSpec.describe Grape::Batch::Base do
       describe 'default_value' do
         it { expect(Grape::Batch.configuration.path).to eq('/custom_path') }
         it { expect(Grape::Batch.configuration.limit).to eq(15) }
+        it { expect(Grape::Batch.configuration.session_proc.call).to eq(5) }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-batch
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Lionel Oto
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack