grape-batch 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a517a0d3926d273000e7259b84423dd40a45944
-  data.tar.gz: 789334e06c793af86de50fd4acc500077e08eef9
+  metadata.gz: 629341058e79eb9e77d5f194253924d5e750ad33
+  data.tar.gz: a55650fa2bb33ffcbd6687550b8626e1c387fa83
 SHA512:
-  metadata.gz: 9995c121e9d6a16727d441437c8c529d9a4e1617d3b7a1ef33f2257f5f632a872e43f751cc2f72c4d621cd31ef966a32e5f37d54905d458c5ab513b4d16371d6
-  data.tar.gz: 06d85f22c110749398f9058485e7e44c45c260fbccdb542bc8f2022aedfa22c247e54660da6198269edd8b1106f0d2c04a3e968e1f9ce9705e93f48c244adc4e
+  metadata.gz: 5c845fcaacb2343e51583e9e076192a5cfcadcaf2fe81aafeb1427beceebadd5bcf31fe3e3c1b0a5a696508fd77976040efc14f82e3beee632f8187096941987
+  data.tar.gz: d9332fce70ee22c5994155c1e0dbc2fb1c07873ef90c17772f7598208da4c9895d8a3439eed7b70e58bb7bf534cfcb506a4b31a20678d16d137b70d4d6f5f101

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+script: bundle exec rspec spec

data/README.md

@@ -2,6 +2,8 @@
 
 Rack middleware which extends Grape::API to support request batching.
 
+![Build status](https://travis-ci.org/c4mprod/grape-batch.svg?branch=master)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +28,7 @@ This middleware is intended to be used with JSON Grape::API only.
 ```ruby
 # grape-batch.rb
 Rails.application.configure do
- config.middleware.insert_before Rack::Sendfile, Grape::Batch::Base
+ config.middleware.use Grape::Batch::Base
 end
 ```
 

data/grape-batch.gemspec

@@ -6,8 +6,8 @@ require 'grape/batch/version'
 Gem::Specification.new do |spec|
   spec.name          = 'grape-batch'
   spec.version       = Grape::Batch::VERSION
-  spec.authors       = ['Lionel Oto', 'Cédric Darné']
-  spec.email         = ['lionel.oto@c4mprod.com', 'cedric.darne@c4mprod.com']
+  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'

data/lib/grape/batch.rb

@@ -1,3 +1,4 @@
+require 'grape/batch/errors'
 require 'grape/batch/parser'
 require 'grape/batch/response'
 require 'grape/batch/version'
@@ -53,7 +54,7 @@ module Grape
           request_env['REQUEST_METHOD'] = method
           request_env['PATH_INFO'] = path
           if method == 'GET'
-            request_env['rack.input'] = StringIO.new(MultiJson.encode({}))
+            request_env['rack.input'] = StringIO.new('{}')
             request_env['QUERY_STRING'] = URI.encode_www_form(body.to_a)
           else
             request_env['rack.input'] = StringIO.new(MultiJson.encode(body))

data/lib/grape/batch/errors.rb

@@ -0,0 +1,6 @@
+module Grape
+  module Batch
+    class RequestBodyError < ArgumentError; end
+    class TooManyRequestsError < StandardError; end
+  end
+end

data/lib/grape/batch/parser.rb

@@ -1,39 +1,54 @@
 module Grape
   module Batch
-    class RequestBodyError < ArgumentError; end
-    class TooManyRequestsError < StandardError; end
-
     class Validator
-      def self.parse(env, limit)
-        rack_input = env['rack.input'].read
-        raise RequestBodyError.new('Request body is blank') unless rack_input.length > 0
-
-        begin
-          batch_body = MultiJson.decode(rack_input)
-        rescue MultiJson::ParseError
-          raise RequestBodyError.new('Request body is not valid JSON')
+      class << self
+        def parse(env, limit)
+          batch_body = decode_body(env['rack.input'])
+
+          requests = batch_body['requests']
+          validate_requests(requests, limit)
+
+          requests.each do |request|
+            validate_request(request)
+          end
+
+          requests
         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)
+        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_requests = batch_body['requests']
-        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
+          batch_body
+        end
 
-        batch_requests.each do |request|
+        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 ['GET', 'POST', 'PUT', 'DELETE'].include?(request['method'])
+
+          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
-
-        batch_requests
       end
     end
   end

data/lib/grape/batch/response.rb

@@ -1,14 +1,10 @@
-module Grape
-  module Batch
-    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']}
-      end
+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
+
+    (200..299).include?(status) ? {success: result} : {code: status, error: result['error']}
   end
 end

data/lib/grape/batch/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Batch
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

data/spec/requests_spec.rb

@@ -5,8 +5,11 @@ require 'grape'
 require 'api'
 
 RSpec.describe Grape::Batch::Base do
-  let(:app) { Twitter::API.new }
-  let(:stack) { Grape::Batch::Base.new(app) }
+  before :context do
+    @app = Twitter::API.new
+  end
+
+  let(:stack) { Grape::Batch::Base.new(@app) }
   let(:request) { Rack::MockRequest.new(stack) }
 
   def encode(message)
@@ -18,6 +21,7 @@ RSpec.describe Grape::Batch::Base do
   end
 
   describe '/api' do
+
     describe 'GET /hello' do
       let(:response) { request.get('/api/v1/hello') }
 
@@ -148,5 +152,13 @@ RSpec.describe Grape::Batch::Base do
         it { expect(response.body).to eq(encode([{success: 'status 856'}])) }
       end
     end
+
+    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'}]}) }
+        it { expect(response.status).to eq(200) }
+        it { expect(decode(response.body).size).to eq(2) }
+      end
+    end
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: grape-batch
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Lionel Oto
+- Vincent Falduto
 - Cédric Darné
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -112,6 +113,7 @@ dependencies:
 description: 
 email:
 - lionel.oto@c4mprod.com
+- vincent.falduto@c4mprod.com
 - cedric.darne@c4mprod.com
 executables: []
 extensions: []
@@ -121,12 +123,14 @@ files:
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - grape-batch.gemspec
 - lib/grape/batch.rb
+- lib/grape/batch/errors.rb
 - lib/grape/batch/parser.rb
 - lib/grape/batch/response.rb
 - lib/grape/batch/version.rb