grape-batch 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e44f52d84088c227271799372c1dc9cdd570b65
-  data.tar.gz: bb3eebf865d2d329e81ad97e85655b1035faf4fd
+  metadata.gz: 2ba051e13b667b77094be62bf479aebf5452fc3e
+  data.tar.gz: f28bd7313a6376bd8a56792e1744dbadf63d19b3
 SHA512:
-  metadata.gz: 784cc47d4012ce202e0c089d50dd85fde29388a44758c01f7066ed9ef46c651c5eade41d4089d4753075f5a6722c95486685bcf3511e41bd0d146724c70ca16b
-  data.tar.gz: 133f5ba1ed2ca8efe5252acb652fb6dc15f6f07cf72b38d6ac32ee641d388b0ac7ac7030956b0bfab8d5bc4255a5393eca2646544e6e82191b7c165d51e6cd35
+  metadata.gz: 7155185197a009f8a884a622d05cfb3f877f2990bffa0382c9424c3cf004b67f448e79a1b116a63d39979ad20dd5e2c550201fcf01a51d30f622a7ec7dafcfd5
+  data.tar.gz: 5d83dae879c57aa6ce723e4df16528b82fd04d6eb8d67bca4a53e4fa87fc5ba8de699cea6b2aaca4c1df12c8701e99a73e87449052a98d14b50f0c4b92f4709c

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require: rubocop-rspec
+
+Metrics/LineLength:
+  Max: 99
+
+# Indentation of `when`.
+Style/CaseIndentation:
+  IndentWhenRelativeTo: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/grape-batch.gemspec

@@ -4,24 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape/batch/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'grape-batch'
-  spec.version       = Grape::Batch::VERSION
-  spec.authors       = ['Lionel Oto', 'Vincent Falduto', 'Cédric Darné']
-  spec.email         = ['lionel.oto@c4mprod.com', 'vincent.falduto@c4mprod.com', 'cedric.darne@c4mprod.com']
-  spec.summary       = %q{Extends Grape::API to support request batching }
-  spec.homepage      = 'https://github.com/c4mprod/grape-batch'
-  spec.license       = 'MIT'
+  spec.name = 'grape-batch'
+  spec.version = Grape::Batch::VERSION
+  spec.authors = ['Lionel Oto', 'Vincent Falduto', 'Cédric Darné']
+  spec.email = %w(lionel.oto@c4mprod.com
+                  vincent.falduto@c4mprod.com
+                  cedric.darne@c4mprod.com)
+  spec.summary = 'Extends Grape::API to support request batching'
+  spec.homepage = 'https://github.com/c4mprod/grape-batch'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'grape', '>= 0.7.0'
   spec.add_runtime_dependency 'multi_json', '>= 1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'grape', '>= 0.7.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6.2'
   spec.add_development_dependency 'rake', '~> 10.3.2'
   spec.add_development_dependency 'rspec', '~> 3.1.0'
-  spec.add_development_dependency 'rack-test', '~> 0.6.2'
+  spec.add_development_dependency 'rubocop', '~> 0.34.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.3.1'
 end

data/lib/grape/batch/configuration.rb

@@ -1,5 +1,7 @@
 module Grape
+  # Main gem module
   module Batch
+    # Gem configuration
     class Configuration
       attr_accessor :path, :limit, :formatter, :logger, :session_proc
 
@@ -8,7 +10,7 @@ module Grape
         @limit = 10
         @formatter = Grape::Batch::Response
         @logger = nil
-        @session_proc = Proc.new {}
+        @session_proc = proc {}
       end
     end
 

data/lib/grape/batch/converter.rb

@@ -0,0 +1,25 @@
+module Grape
+  module Batch
+    # Convert hash to www form url params
+    class Converter
+      class << self
+        def encode(value, key = nil, out_hash = {})
+          case value
+            when Hash
+              value.each { |k, v| encode(v, append_key(key, k), out_hash) }
+            when Array
+              value.each { |v| encode(v, "#{key}[]", out_hash) }
+            else
+              out_hash[key] = value
+          end
+
+          value ? out_hash : ''
+        end
+
+        def append_key(root_key, key)
+          root_key ? :"#{root_key}[#{key.to_s}]" : :"#{key}"
+        end
+      end
+    end
+  end
+end

data/lib/grape/batch/errors.rb

@@ -1,6 +1,89 @@
 module Grape
   module Batch
-    class RequestBodyError < ArgumentError; end
-    class TooManyRequestsError < StandardError; end
+    class RequestBodyError < ArgumentError
+      # Request body is blank
+      class Blank < RequestBodyError
+        def initialize
+          super('Request body is blank')
+        end
+      end
+
+      # Request body is not properly formatted JSON
+      class JsonFormat < RequestBodyError
+        def initialize
+          super('Request body is not valid JSON')
+        end
+      end
+
+      # Batch body is nil
+      class Nil < RequestBodyError
+        def initialize
+          super('Request body is nil')
+        end
+      end
+
+      # Batch body isn't properly formatted as a Hash
+      class Format < RequestBodyError
+        def initialize
+          super('Request body is not well formatted')
+        end
+      end
+
+      # Some requests attributes are missing in the batch body
+      class MissingRequests < RequestBodyError
+        def initialize
+          super("'requests' object is missing in request body")
+        end
+      end
+
+      # Some requests attributes aren't properly formatted as an Array
+      class RequestFormat < RequestBodyError
+        def initialize
+          super("'requests' is not well formatted")
+        end
+      end
+
+      # Batch request method is missing
+      class MissingMethod < RequestBodyError
+        def initialize
+          super("'method' is missing in one of request objects")
+        end
+      end
+
+      # Batch request method isn't properly formatted as a String
+      class MethodFormat < RequestBodyError
+        def initialize
+          super("'method' is invalid in one of request objects")
+        end
+      end
+
+      # Batch request method aren't allowed
+      class InvalidMethod < RequestBodyError
+        def initialize
+          super("'method' is invalid in one of request objects")
+        end
+      end
+
+      # Batch request path is missing
+      class MissingPath < RequestBodyError
+        def initialize
+          super("'path' is missing in one of request objects")
+        end
+      end
+
+      # Batch request path isn't properly formatted as a String
+      class InvalidPath < RequestBodyError
+        def initialize
+          super("'path' is invalid in one of request objects")
+        end
+      end
+    end
+
+    # Batch exceeds request limit
+    class TooManyRequestsError < StandardError
+      def initialize
+        super('Batch requests limit exceeded')
+      end
+    end
   end
 end

data/lib/grape/batch/logger.rb

@@ -0,0 +1,33 @@
+module Grape
+  module Batch
+    # Main class logger
+    class Logger
+      def prepare(env)
+        rack_timeout_info = env['rack-timeout.info'][:id] if env['rack-timeout.info']
+        @request_id = env['HTTP_X_REQUEST_ID'] || rack_timeout_info || SecureRandom.hex
+        @logger = Grape::Batch.configuration.logger || rails_logger || default_logger
+        self
+      end
+
+      def default_logger
+        logger = Logger.new($stdout)
+        logger.level = Logger::INFO
+        logger
+      end
+
+      def rails_logger
+        defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+      end
+
+      def batch_begin
+        @logger.info("--- Grape::Batch #{@request_id} BEGIN")
+        self
+      end
+
+      def batch_end
+        @logger.info("--- Grape::Batch #{@request_id} END")
+        self
+      end
+    end
+  end
+end

data/lib/grape/batch/request.rb

@@ -0,0 +1,41 @@
+require 'grape/batch/converter'
+
+module Grape
+  module Batch
+    # Prepare batch request
+    class Request
+      def initialize(env, batch_request)
+        @env = env
+        @batch_request = batch_request
+      end
+
+      def method
+        @batch_request['method']
+      end
+
+      def path
+        @batch_request['path']
+      end
+
+      def body
+        @body ||= @batch_request['body'].is_a?(Hash) ? @batch_request['body'] : {}
+      end
+
+      def query_string
+        @query_string ||= method == 'GET' ? URI.encode_www_form(Converter.encode(body).to_a) : ''
+      end
+
+      def rack_input
+        @rack_input ||= method == 'GET' ? '{}' : StringIO.new(MultiJson.encode(body))
+      end
+
+      def build
+        @env['REQUEST_METHOD'] = method
+        @env['PATH_INFO'] = path
+        @env['QUERY_STRING'] = query_string
+        @env['rack.input'] = rack_input
+        @env
+      end
+    end
+  end
+end

data/lib/grape/batch/response.rb

@@ -1,10 +1,19 @@
-class Grape::Batch::Response
-  def self.format(status, headers, response)
-    if response
-      body = response.respond_to?(:body) ? response.body.join : response.join
-      result = MultiJson.decode(body)
-    end
+module Grape
+  module Batch
+    # Format batch request response
+    class Response
+      def self.format(status, _headers, response)
+        if response
+          body = response.respond_to?(:body) ? response.body.join : response.join
+          result = MultiJson.decode(body)
+        end
 
-    (200..299).include?(status) ? {success: result} : {code: status, error: result['error']}
+        if (200..299).include?(status)
+          { success: result }
+        else
+          { code: status, error: result['error'] }
+        end
+      end
+    end
   end
 end

data/lib/grape/batch/validator.rb

@@ -0,0 +1,51 @@
+module Grape
+  module Batch
+    # Parse and validate request params and ensure it is a valid batch request
+    class Validator
+      ALLOWED_METHODS = %w(GET DELETE PATCH POST PUT)
+
+      class << self
+        def parse(env, limit)
+          batch_body = decode_body(env['rack.input'].read)
+
+          requests = batch_body['requests']
+          validate_batch(requests, limit)
+          requests.each { |request| validate_request(request) }
+
+          requests
+        end
+
+        private
+
+        def decode_body(body)
+          fail RequestBodyError::Blank unless body.length > 0
+
+          begin
+            batch_body = MultiJson.decode(body)
+          rescue MultiJson::ParseError
+            raise RequestBodyError::JsonFormat
+          end
+
+          fail RequestBodyError::Nil unless batch_body
+          fail RequestBodyError::Format unless batch_body.is_a?(Hash)
+
+          batch_body
+        end
+
+        def validate_batch(batch_requests, limit)
+          fail RequestBodyError::MissingRequests unless batch_requests
+          fail RequestBodyError::RequestFormat unless batch_requests.is_a?(Array)
+          fail TooManyRequestsError if batch_requests.count > limit
+        end
+
+        def validate_request(request)
+          fail RequestBodyError::MissingMethod unless request['method']
+          fail RequestBodyError::MethodFormat unless request['method'].is_a?(String)
+          fail RequestBodyError::InvalidMethod unless ALLOWED_METHODS.include?(request['method'])
+          fail RequestBodyError::MissingPath unless request['path']
+          fail RequestBodyError::InvalidPath unless request['path'].is_a?(String)
+        end
+      end
+    end
+  end
+end

data/lib/grape/batch/version.rb

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

data/lib/grape/batch.rb

@@ -1,99 +1,66 @@
-require 'active_support'
-require 'grape/batch/version'
-require 'grape/batch/errors'
 require 'grape/batch/configuration'
-require 'grape/batch/hash_converter'
-require 'grape/batch/parser'
+require 'grape/batch/errors'
+require 'grape/batch/logger'
+require 'grape/batch/request'
 require 'grape/batch/response'
+require 'grape/batch/validator'
+require 'grape/batch/version'
 require 'multi_json'
 
 module Grape
   module Batch
+    # Gem main class
     class Base
       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 is_batch_request?(env)
+        return @app.call(env) unless batch_request?(env)
+        @logger.prepare(env).batch_begin
         batch_call(env)
       end
 
       def batch_call(env)
-        status = 200
-        headers = { 'Content-Type' => 'application/json' }
-        rack_timeout_info = env['rack-timeout.info'][:id] if env['rack-timeout.info']
-        request_id = env['HTTP_X_REQUEST_ID'] || rack_timeout_info || SecureRandom.hex
-        logger.info("--- Grape::Batch #{request_id} BEGIN")
         begin
-          batch_requests = Grape::Batch::Validator::parse(env, Grape::Batch.configuration.limit)
-          result = dispatch(env, batch_requests)
-          body = MultiJson.encode(result)
+          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.info("--- Grape::Batch #{request_id} END")
-        [status, headers, [body]]
+
+        @logger.batch_end
+        Rack::Response.new(body, status, 'Content-Type' => 'application/json')
       end
 
       private
 
-      def is_batch_request?(env)
-        env['PATH_INFO'].start_with?(Grape::Batch.configuration.path) &&
+      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)
-        env['api.session'] = Grape::Batch.configuration.session_proc.call(env)
-
-        # iterate
-        batch_env = env.dup
-        batch_requests.map do |request|
-          # init env for Grape resource
-          tmp_env = prepare_tmp_env(batch_env, request)
-          status, headers, response = @app.call(tmp_env)
-
-          # format response
-          @response_klass::format(status, headers, response)
-        end
-      end
+        # Call session proc
+        env['api.session'] = @session_proc.call(env)
 
-      def prepare_tmp_env(tmp_env, request)
-        method = request['method']
-        path = request['path']
-        body = request['body'].is_a?(Hash) ? request['body'] : {}
-        query_string = ''
-        rack_input = '{}'
+        # Prepare batch request env
+        request_env = env.dup
 
-        if method == 'GET'
-          query_string = URI.encode_www_form(HashConverter.encode(body).to_a)
-        else
-          rack_input = StringIO.new(MultiJson.encode(body))
+        # 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)
+          @response_klass.format(status, headers, response)
         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
-
-      def logger
-        @logger ||= Grape::Batch.configuration.logger || rails_logger || default_logger
-      end
-
-      def default_logger
-        logger = Logger.new($stdout)
-        logger.level = Logger::INFO
-        logger
-      end
-
-      # Get the Rails logger if it's defined.
-      def rails_logger
-        defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
       end
     end
   end

data/spec/api.rb

@@ -23,7 +23,7 @@ module Twitter
 
     resource :user do
       params do
-        requires :id, type: Integer, desc: "User id."
+        requires :id, type: Integer, desc: 'User id.'
       end
       route_param :id do
         get do
@@ -43,14 +43,14 @@ module Twitter
 
     resource :status do
       params do
-        requires :id, type: Integer, desc: "User id."
+        requires :id, type: Integer, desc: 'User id.'
       end
       get do
         "status #{params[:id]}"
       end
 
       params do
-        requires :id, type: Integer, desc: "User id."
+        requires :id, type: Integer, desc: 'User id.'
       end
       post do
         "status #{params[:id]}"

data/spec/{requests_spec.rb → grape/batch/base_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'rack/test'
-require 'grape/batch'
 require 'grape'
+require 'grape/batch'
 require 'api'
 
 RSpec.describe Grape::Batch::Base do
@@ -13,7 +13,7 @@ RSpec.describe Grape::Batch::Base do
     @app = Twitter::API.new
   end
 
-  let(:stack) { Grape::Batch::Base.new(@app) }
+  let(:stack) { described_class.new(@app) }
   let(:request) { Rack::MockRequest.new(stack) }
 
   def encode(message)
@@ -35,13 +35,14 @@ RSpec.describe Grape::Batch::Base do
     describe 'GET /failure' do
       let(:response) { request.get('/api/v1/failure') }
       it { expect(response.status).to eq(503) }
-      it { expect(response.body).to eq(encode({ error: 'Failed as expected' })) }
+      it { expect(response.body).to eq(encode(error: 'Failed as expected')) }
     end
   end
 
   describe '/batch' do
     let(:request_body) { nil }
-    let(:response) { request.post('/batch', { 'CONTENT_TYPE' => 'application/json', input: request_body }) }
+    let(:options) { { 'CONTENT_TYPE' => 'application/json', input: request_body } }
+    let(:response) { request.post('/batch', options) }
 
     context 'with invalid body' do
       it { expect(response.status).to eq(400) }
@@ -76,40 +77,40 @@ RSpec.describe Grape::Batch::Base do
       end
 
       context "when body['requests'] is not an array" do
-        let(:request_body) { encode({ requests: 'request' }) }
+        let(:request_body) { encode(requests: 'request') }
         it { expect(response.body).to eq("'requests' is not well formatted") }
       end
 
       context 'when request limit is exceeded' do
-        let(:request_body) { encode({ requests: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11] }) }
+        let(:request_body) { encode(requests: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]) }
         it { expect(response.body).to eq('Batch requests limit exceeded') }
       end
 
       describe 'method attribute in request object' do
         context 'method is missing' do
-          let(:request_body) { encode({ requests: [{}] }) }
+          let(:request_body) { encode(requests: [{}]) }
           it { expect(response.body).to eq("'method' is missing in one of request objects") }
         end
 
         context 'method is not a String' do
-          let(:request_body) { encode({ requests: [{ method: true }] }) }
+          let(:request_body) { encode(requests: [{ method: true }]) }
           it { expect(response.body).to eq("'method' is invalid in one of request objects") }
         end
 
         context 'method is invalid' do
-          let(:request_body) { encode({ requests: [{ method: 'TRACE' }] }) }
+          let(:request_body) { encode(requests: [{ method: 'TRACE' }]) }
           it { expect(response.body).to eq("'method' is invalid in one of request objects") }
         end
       end
 
       describe 'path attribute in request object' do
         context 'path is missing' do
-          let(:request_body) { encode({ requests: [{ method: 'GET' }] }) }
+          let(:request_body) { encode(requests: [{ method: 'GET' }]) }
           it { expect(response.body).to eq("'path' is missing in one of request objects") }
         end
 
         context 'path is not a String' do
-          let(:request_body) { encode({ requests: [{ method: 'GET', path: 123 }] }) }
+          let(:request_body) { encode(requests: [{ method: 'GET', path: 123 }]) }
           it { expect(response.body).to eq("'path' is invalid in one of request objects") }
         end
       end
@@ -117,50 +118,51 @@ RSpec.describe Grape::Batch::Base do
 
     describe 'GET' do
       context 'with no parameters' do
-        let(:request_body) { encode({ requests: [{ method: 'GET', path: '/api/v1/hello' }] }) }
+        let(:request_body) { encode(requests: [{ method: 'GET', path: '/api/v1/hello' }]) }
         it { expect(response.status).to eq(200) }
         it { expect(response.body).to eq(encode([{ success: 'world' }])) }
       end
 
       context 'with parameters' do
-        let(:request_body) { encode({ requests: [{ method: 'GET', path: '/api/v1/user/856' }] }) }
+        let(:request_body) { encode(requests: [{ method: 'GET', path: '/api/v1/user/856' }]) }
         it { expect(response.status).to eq(200) }
         it { expect(response.body).to eq(encode([{ success: 'user 856' }])) }
       end
 
       context 'with a body' do
-        let(:request_body) { encode({ requests: [{ method: 'GET', path: '/api/v1/status', body: { id: 856 } }] }) }
+        let(:path) { '/api/v1/status' }
+        let(:request_body) { encode(requests: [{ method: 'GET', path: path, body: { id: 856 } }]) }
         it { expect(response.status).to eq(200) }
         it { expect(response.body).to eq(encode([{ success: 'status 856' }])) }
       end
 
       context 'with a body and nested hash' do
-        let(:complex) do
-          { a: { b: { c: 1 } } }
-        end
-        let(:request_body) do
-          encode({ requests: [{ method: 'GET', path: '/api/v1/complex', body: complex}] })
-        end
+        let(:path) { '/api/v1/complex' }
+        let(:complex) { { a: { b: { c: 1 } } } }
+        let(:request_body) { encode(requests: [{ method: 'GET', path: path, body: complex }]) }
         it { expect(response.status).to eq(200) }
-        it { expect(response.body).to eq(encode([{ success: "hash 1" }])) }
+        it { expect(response.body).to eq(encode([{ success: 'hash 1' }])) }
       end
 
       describe '404 errors' do
-        let(:request_body) { encode({ requests: [{ method: 'GET', path: '/api/v1/unknown' }] }) }
+        let(:request_body) { encode(requests: [{ method: 'GET', path: '/api/v1/unknown' }]) }
+        let(:expected_error) { { code: 404, error: '/api/v1/unknown not found' } }
         it { expect(response.status).to eq(200) }
-        it { expect(response.body).to eq(encode([{ code: 404, error: '/api/v1/unknown not found' }])) }
+        it { expect(response.body).to eq(encode([expected_error])) }
       end
     end
 
     describe 'POST' do
       context 'with no parameters' do
-        let(:request_body) { encode({ requests: [{ method: 'POST', path: '/api/v1/hello' }] }) }
+        let(:request_body) { encode(requests: [{ method: 'POST', path: '/api/v1/hello' }]) }
         it { expect(response.status).to eq(200) }
         it { expect(response.body).to eq(encode([{ success: 'world' }])) }
       end
 
       context 'with a body' do
-        let(:request_body) { encode({ requests: [{ method: 'POST', path: '/api/v1/status', body: { id: 856 } }] }) }
+        let(:path) { '/api/v1/status' }
+        let(:body) { { id: 856 } }
+        let(:request_body) { encode(requests: [{ method: 'POST', path: path, body: body }]) }
         it { expect(response.status).to eq(200) }
         it { expect(response.body).to eq(encode([{ success: 'status 856' }])) }
       end
@@ -168,7 +170,9 @@ RSpec.describe Grape::Batch::Base do
 
     describe 'POST' do
       context 'with multiple requests' do
-        let(:request_body) { encode({ requests: [{ method: 'POST', path: '/api/v1/hello' }, { method: 'GET', path: '/api/v1/user/856' }] }) }
+        let(:request_1) { { method: 'POST', path: '/api/v1/hello' } }
+        let(:request_2) { { method: 'GET', path: '/api/v1/user/856' } }
+        let(:request_body) { encode(requests: [request_1, request_2]) }
         it { expect(response.status).to eq(200) }
         it { expect(decode(response.body).size).to eq(2) }
       end
@@ -190,7 +194,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.session_proc = proc { 3 + 2 }
           config
         end
       end

data/spec/spec_helper.rb

@@ -38,37 +38,36 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
   # These two settings work together to allow you to limit a spec run
   # to individual examples or groups you care about by tagging them with
   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
   # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
 
   # Limits the available syntax to the non-monkey patched syntax that is recommended.
   # For more details, see:
   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
+  # config.disable_monkey_patching!
 
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
   # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
+  # if config.files_to_run.one?
+  # Use the documentation formatter for detailed output,
+  # unless a formatter has already been configured
+  # (e.g. via a command-line flag).
+  # config.default_formatter = 'doc'
+  # end
 
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
@@ -80,6 +79,5 @@ RSpec.configure do |config|
   # Setting this allows you to use `--seed` to deterministically reproduce
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
+  # Kernel.srand config.seed
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-batch
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Lionel Oto
@@ -10,50 +10,64 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: grape
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: 0.7.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -83,19 +97,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.34.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.34.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 description: 
 email:
 - lionel.oto@c4mprod.com
@@ -107,6 +135,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -118,13 +147,15 @@ files:
 - grape-batch.gemspec
 - lib/grape/batch.rb
 - lib/grape/batch/configuration.rb
+- lib/grape/batch/converter.rb
 - lib/grape/batch/errors.rb
-- lib/grape/batch/hash_converter.rb
-- lib/grape/batch/parser.rb
+- lib/grape/batch/logger.rb
+- lib/grape/batch/request.rb
 - lib/grape/batch/response.rb
+- lib/grape/batch/validator.rb
 - lib/grape/batch/version.rb
 - spec/api.rb
-- spec/requests_spec.rb
+- spec/grape/batch/base_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/c4mprod/grape-batch
 licenses:
@@ -152,5 +183,5 @@ specification_version: 4
 summary: Extends Grape::API to support request batching
 test_files:
 - spec/api.rb
-- spec/requests_spec.rb
+- spec/grape/batch/base_spec.rb
 - spec/spec_helper.rb

data/lib/grape/batch/hash_converter.rb

@@ -1,26 +0,0 @@
-module Grape
-  module Batch
-    class HashConverter
-      def self.encode(value, key = nil, out_hash = {})
-        case value
-          when Hash  then
-            value.each { |k,v| encode(v, append_key(key,k), out_hash) }
-            out_hash
-          when Array then
-            value.each { |v| encode(v, "#{key}[]", out_hash) }
-            out_hash
-          when nil   then ''
-          else
-            out_hash[key] = value
-            out_hash
-        end
-      end
-
-      private
-
-      def self.append_key(root_key, key)
-        root_key.nil? ? :"#{key}" : :"#{root_key}[#{key.to_s}]"
-      end
-    end
-  end
-end

data/lib/grape/batch/parser.rb

@@ -1,55 +0,0 @@
-module Grape
-  module Batch
-    class Validator
-      class << self
-        def parse(env, limit)
-          batch_body = decode_body(env['rack.input'].read)
-
-          requests = batch_body['requests']
-          validate_requests(requests, limit)
-
-          requests.each do |request|
-            validate_request(request)
-          end
-
-          requests
-        end
-
-        private
-
-        def decode_body(body)
-          raise RequestBodyError.new('Request body is blank') unless body.length > 0
-
-          begin
-            batch_body = MultiJson.decode(body)
-          rescue MultiJson::ParseError
-            raise RequestBodyError.new('Request body is not valid JSON')
-          end
-
-          raise RequestBodyError.new('Request body is nil') unless batch_body
-          raise RequestBodyError.new('Request body is not well formatted') unless batch_body.is_a?(Hash)
-
-          batch_body
-        end
-
-        def validate_requests(batch_requests, limit)
-          raise RequestBodyError.new("'requests' object is missing in request body") unless batch_requests
-          raise RequestBodyError.new("'requests' is not well formatted") unless batch_requests.is_a?(Array)
-          raise TooManyRequestsError.new('Batch requests limit exceeded') if batch_requests.count > limit
-        end
-
-        def validate_request(request)
-          raise RequestBodyError.new("'method' is missing in one of request objects") unless request['method']
-          raise RequestBodyError.new("'method' is invalid in one of request objects") unless request['method'].is_a?(String)
-
-          unless %w(GET POST PUT DELETE).include?(request['method'])
-            raise RequestBodyError.new("'method' is invalid in one of request objects")
-          end
-
-          raise RequestBodyError.new("'path' is missing in one of request objects") unless request['path']
-          raise RequestBodyError.new("'path' is invalid in one of request objects") unless request['path'].is_a?(String)
-        end
-      end
-    end
-  end
-end