grape-batch 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7e676df65253b6b5420d637f37073653ee5a2a1
-  data.tar.gz: 85cbb4cef22a5825990bf6c7576b47cc42cb6fd9
+  metadata.gz: 8bbe03da7123e206a98f1665477f2903ccff61aa
+  data.tar.gz: 814d658a2f6300f0b99d966be482bf49adf02f41
 SHA512:
-  metadata.gz: b54b0663d8f320b563ad9efe6a23008a52105cde39054ea18ba85197bb14855ff61f365dda35d535d25c37c061008607a8313882b240507449d8e47bd51b645e
-  data.tar.gz: 351fe44caed2f2a49af357381960e443f69645c45b0ca18d4e06ce87bfd04b003fcd760be7fbcb1d3efb72b9c3e9f56f888f1c2a58238b425da45f913b2379d7
+  metadata.gz: 991c0e72406404557650cda1dbd0303fc0f0b85f701b0570ed8019960223fe64b306af997ce6cb21479932a42d54744bb148433708f458d1326ffa638fb94830
+  data.tar.gz: 0822eda7abe6aaa04bdcb6ee6797549d4a8f8e745a6cb097abdfe5d81059a3da70f92cb74c9d911d4e81032e1a751758edde913585b8d0d3107ad377abf4bef8

data/grape-batch.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rack', '>= 1.5'
   spec.add_runtime_dependency 'grape', '>= 0.7.0'
   spec.add_runtime_dependency 'multi_json', '>= 1.0'
+  spec.add_runtime_dependency 'activesupport', '>= 4.1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.3.2'

data/lib/grape/batch/configuration.rb

@@ -1,12 +1,13 @@
 module Grape
   module Batch
     class Configuration
-      attr_accessor :path, :limit, :formatter
+      attr_accessor :path, :limit, :formatter, :logger
 
       def initialize
         @path  = '/batch'
         @limit = 10
         @formatter = Grape::Batch::Response
+        @logger = nil
       end
     end
 

data/lib/grape/batch/log_subscriber.rb

@@ -0,0 +1,64 @@
+module Grape
+  module Batch
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      def dispatch(event)
+        requests = event.payload[:requests]
+
+        if logger.debug?
+          debug_log(requests)
+        else
+          info_log(requests)
+        end
+      end
+
+      private
+
+      def debug_log(requests)
+        logger.info 'grape/batch'
+
+        requests.map do |params|
+          request, response = params
+          logger.info " method=#{request['REQUEST_METHOD']} path=#{request['PATH_INFO']}"
+
+          if request['REQUEST_METHOD'] == 'GET'
+            unless request['QUERY_STRING'].empty?
+              logger.debug "  params: #{request['QUERY_STRING'].to_s}"
+            end
+          else
+            if request['rack.input'].respond_to? :string
+              logger.debug "  body: #{request['rack.input'].string}"
+            end
+          end
+          logger.debug "  response: #{response.to_s}"
+        end
+      end
+
+      def info_log(requests)
+        messages = []
+        requests.each do |params|
+          request, response = params
+          messages << "method=#{request['REQUEST_METHOD']} path=#{request['PATH_INFO']}"
+        end
+
+        logger.info 'grape/batch ' + messages.join(', ')
+      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
+end
+
+Grape::Batch::LogSubscriber.attach_to(:batch)

data/lib/grape/batch/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Batch
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
   end
 end

data/lib/grape/batch.rb

@@ -1,8 +1,11 @@
+require 'active_support'
+require 'grape/batch/log_subscriber'
+
+require 'grape/batch/version'
 require 'grape/batch/errors'
 require 'grape/batch/configuration'
 require 'grape/batch/parser'
 require 'grape/batch/response'
-require 'grape/batch/version'
 require 'multi_json'
 
 module Grape
@@ -20,7 +23,7 @@ module Grape
 
       def batch_call(env)
         status = 200
-        headers = {'Content-Type' => 'application/json'}
+        headers = { 'Content-Type' => 'application/json' }
 
         begin
           batch_requests = Grape::Batch::Validator::parse(env, Grape::Batch.configuration.limit)
@@ -38,30 +41,44 @@ module Grape
 
       def is_batch_request?(env)
         env['PATH_INFO'].start_with?(Grape::Batch.configuration.path) &&
-            env['REQUEST_METHOD'] == 'POST' &&
-            env['CONTENT_TYPE'] == 'application/json'
+          env['REQUEST_METHOD'] == 'POST' &&
+          env['CONTENT_TYPE'] == 'application/json'
       end
 
       def dispatch(env, batch_requests)
-        request_env = env.dup
+        ActiveSupport::Notifications.instrument 'dispatch.batch' do |event|
+          event[:requests] = []
 
-        batch_requests.map do |request|
-          method = request['method']
-          path = request['path']
-          body = request['body'].is_a?(Hash) ? request['body'] : {}
+          # iterate
+          batch_requests.map do |request|
+            # init env for Grape resource
+            tmp_env = prepare_tmp_env(env.dup, request)
+            status, headers, response = @app.call(tmp_env)
 
-          request_env['REQUEST_METHOD'] = method
-          request_env['PATH_INFO'] = path
-          if method == 'GET'
-            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))
+            # format response
+            @response_klass::format(status, headers, response).tap do |formatted_response|
+              # log call
+              event[:requests] << [tmp_env, formatted_response]
+            end
           end
+        end
+      end
+
+      def prepare_tmp_env(tmp_env, request)
+        method = request['method']
+        path = request['path']
+        body = request['body'].is_a?(Hash) ? request['body'] : {}
 
-          status, headers, response = @app.call(request_env)
+        tmp_env.tap do |env|
+          env['REQUEST_METHOD'] = method
+          env['PATH_INFO'] = path
 
-          @response_klass::format(status, headers, response)
+          if method == 'GET'
+            env['rack.input'] = StringIO.new('{}')
+            env['QUERY_STRING'] = URI.encode_www_form(body.to_a)
+          else
+            env['rack.input'] = StringIO.new(MultiJson.encode(body))
+          end
         end
       end
     end

data/spec/requests_spec.rb

@@ -5,6 +5,10 @@ require 'grape'
 require 'api'
 
 RSpec.describe Grape::Batch::Base do
+  before(:all) do
+    Grape::Batch.configuration.logger = Logger.new('/dev/null')
+  end
+
   before :context do
     @app = Twitter::API.new
   end
@@ -31,15 +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(:response) { request.post('/batch', { 'CONTENT_TYPE' => 'application/json', input: request_body }) }
 
     context 'with invalid body' do
       it { expect(response.status).to eq(400) }
@@ -74,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
@@ -115,47 +118,47 @@ 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'}])) }
+        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'}])) }
+        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(:request_body) { encode({ requests: [{ method: 'GET', path: '/api/v1/status', body: { id: 856 } }] }) }
         it { expect(response.status).to eq(200) }
-        it { expect(response.body).to eq(encode([{success: 'status 856'}])) }
+        it { expect(response.body).to eq(encode([{ success: 'status 856' }])) }
       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' }] }) }
         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([{ code: 404, error: '/api/v1/unknown not found' }])) }
       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'}])) }
+        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(:request_body) { encode({ requests: [{ method: 'POST', path: '/api/v1/status', body: { id: 856 } }] }) }
         it { expect(response.status).to eq(200) }
-        it { expect(response.body).to eq(encode([{success: 'status 856'}])) }
+        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'}]}) }
+        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
@@ -173,7 +176,7 @@ RSpec.describe Grape::Batch::Base do
 
     describe '.configure' do
       before do
-        allow(  Grape::Batch).to receive(:configuration) do
+        allow(Grape::Batch).to receive(:configuration) do
           config = Grape::Batch::Configuration.new
           config.path = '/custom_path'
           config.limit = 15

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-batch
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Lionel Oto
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-31 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -54,6 +54,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,7 @@ files:
 - lib/grape/batch.rb
 - lib/grape/batch/configuration.rb
 - lib/grape/batch/errors.rb
+- lib/grape/batch/log_subscriber.rb
 - lib/grape/batch/parser.rb
 - lib/grape/batch/response.rb
 - lib/grape/batch/version.rb