grape-batch 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df308f71fe53aead3f537e40c78c90a6ae3a9a8a
-  data.tar.gz: c444a1b9cb617a0fb1a7463e8004a89ab2d5bb75
+  metadata.gz: 583bc57ae53b64c0cc53821e877304bb47cd9b35
+  data.tar.gz: 14017133fe2585ee354c727be4b5489ba9fae277
 SHA512:
-  metadata.gz: 8bc203bfe21a3166def35fada33e9b483a0c37098743a768be84362db63f717398907f2a7c93734e510d44fb25f13aeef37ad2641b443c131d3b36860e5d8728
-  data.tar.gz: e535cfcb31a6cf68b9c1fabbf426d3878c3dfc2d23196bb24b5812c1f319e6ddba9306dfec3c76acb878fc66294624d85f3009a56219e83e3d5e2cf811bff76f
+  metadata.gz: 77f43acc1c9b95c13254cdc4bc2b8f434a1ddf3988e6e3c1e824680a2ceb04bac86dbebdfc36ff0ade1dd9789a97636429cbb2d9c4b7477d0dc556a70ea38b90
+  data.tar.gz: 0dcb7894c03a989116613554104c6c4e091fe1602b97610ccd9add986a9f487fd39431936b79aaf784a9a31e0cf493af5f153b3c9cf24b5093eea04473516e5b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.3.0 (22nd March 2016)
+* Remove request session and token headers from response headers
+* Code refactor 
+
 # 2.2.2 (22nd March 2016)
 * SESSION_HEADER is no longer duplicated because when the header contains an ActiveRecord object or something similar, it changes the object id
 

data/README.md

@@ -136,13 +136,13 @@ module Twitter
     resource :session do
         get do
             # route logic
-            header 'HTTP_X_API_TOKEN', 'my_fresh_token'
+            request.env['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. 
+# This route will register a token. The header will be kept and passed to the following requests by Grape::Batch. 
 ```
 
 ```ruby
@@ -156,14 +156,14 @@ module Twitter
     
     resource :session do
         get do
-            # route logic
-            header 'api.session', OpenStruct(id: '123456')
+            # route logic            
+            request.env['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. 
+# This route will return a session object. The session object will be kept and passed to the following requests by Grape::Batch.  
 ```
 
 ## Contributing

data/lib/grape/batch.rb

@@ -5,79 +5,11 @@ require 'grape/batch/request'
 require 'grape/batch/response'
 require 'grape/batch/validator'
 require 'grape/batch/version'
+require 'grape/batch/base'
 require 'multi_json'
 
 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
-        @batch_size_limit = Grape::Batch.configuration.limit
-        @api_path = Grape::Batch.configuration.path
-        @session_proc = Grape::Batch.configuration.session_proc
-        @logger = Grape::Batch::Logger.new
-      end
-
-      def call(env)
-        return @app.call(env) unless batch_request?(env)
-        @logger.prepare(env).batch_begin
-        batch_call(env)
-      end
-
-      def batch_call(env)
-        begin
-          status = 200
-          batch_requests = Grape::Batch::Validator.parse(env, @batch_size_limit)
-          body = MultiJson.encode(dispatch(env, batch_requests))
-        rescue Grape::Batch::RequestBodyError, Grape::Batch::TooManyRequestsError => e
-          e.class == TooManyRequestsError ? status = 429 : status = 400
-          body = e.message
-        end
-
-        @logger.batch_end
-        Rack::Response.new(body, status, 'Content-Type' => 'application/json')
-      end
-
-      private
-
-      def batch_request?(env)
-        env['PATH_INFO'].start_with?(@api_path) &&
-          env['REQUEST_METHOD'] == 'POST' &&
-          env['CONTENT_TYPE'] == 'application/json'
-      end
-
-      def dispatch(env, batch_requests)
-        # Prepare batch request env
-        @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
-          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]
-      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/base.rb

@@ -0,0 +1,60 @@
+module Grape
+  module Batch
+    class Base
+      SESSION_HEADER = 'api.session'.freeze
+      TOKEN_HEADER = 'HTTP_X_API_TOKEN'.freeze
+
+      def initialize(app)
+        @app = app
+        @logger = Grape::Batch::Logger.new
+      end
+
+      def call(env)
+        return @app.call(env) unless batch_request?(env)
+
+        # Handle batch requests
+        @logger.prepare(env).batch_begin
+        body, status = batch_call(env)
+        @logger.batch_end
+
+        # Return Rack formatted response
+        Rack::Response.new(body, status, 'Content-Type' => 'application/json')
+      end
+
+      def batch_call(env)
+        batch_requests = Grape::Batch::Validator.parse(env, Grape::Batch.configuration.limit)
+        [MultiJson.encode(dispatch(env, batch_requests)), 200]
+
+      rescue Grape::Batch::RequestBodyError, Grape::Batch::TooManyRequestsError => e
+        [e.message, e.class == TooManyRequestsError ? 429 : 400]
+      end
+
+      def dispatch(env, batch_requests)
+        call_api_session_proc(env)
+
+        # Call batch request
+        batch_requests.map do |batch_request|
+          batch_env = Grape::Batch::Request.new(env, batch_request).build
+          call_batched_request(batch_env)
+        end
+      end
+
+      def call_batched_request(env)
+        status, headers, response = @app.call(env)
+        Grape::Batch.configuration.formatter.format(status, headers, response)
+      end
+
+      private
+
+      def batch_request?(env)
+        env['PATH_INFO'].start_with?(Grape::Batch.configuration.path) &&
+          env['REQUEST_METHOD'] == 'POST' && env['CONTENT_TYPE'] == 'application/json'
+      end
+
+      def call_api_session_proc(env)
+        return unless Grape::Batch.configuration.session_proc
+        env[SESSION_HEADER] = Grape::Batch.configuration.session_proc.call(env)
+      end
+    end
+  end
+end

data/lib/grape/batch/configuration.rb

@@ -10,7 +10,7 @@ module Grape
         @limit = 10
         @formatter = Grape::Batch::Response
         @logger = nil
-        @session_proc = proc {}
+        @session_proc = nil
       end
     end
 

data/lib/grape/batch/version.rb

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

data/spec/api.rb

@@ -59,7 +59,7 @@ module Twitter
 
     resource :login do
       get do
-        header 'HTTP_X_API_TOKEN', 'user_token'
+        request.env['HTTP_X_API_TOKEN'] = 'user_token'
 
         'login successful'
       end
@@ -75,7 +75,7 @@ module Twitter
 
     resource :session do
       get do
-        header 'api.session', OpenStruct.new(nick: 'Bob')
+        request.env['api.session'] = OpenStruct.new(nick: 'Bob')
 
         'session reloaded'
       end

metadata

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