grape-batch 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cde41da304a6addd17c9d57b4326bf16d394682
-  data.tar.gz: 5f59e3a4857f129f6f16c07924067721c132c27e
+  metadata.gz: fe13afdcafd4a0e284de0e38970eb61da36775a9
+  data.tar.gz: b982801271bb9f54f12e5a9d426c741bf1adea05
 SHA512:
-  metadata.gz: a74d5336ae59e801dede8e4e3297db10f60c3a4acc553f1dc0feced8256c3c0ca5c733fbfad24b2a0d705b02ab7bef176f703074a5eb4b8da352b006d300907a
-  data.tar.gz: 2c4fa0a3ead2bbe33f712883404cfcf3e2da961fb7da4c33d90e977512cf93dba5b5dcbdde14a8ffc534f3eb6f97649f7f378e1c9d20a839f49d97d425ccfa58
+  metadata.gz: cb0dacb5ff92a2f6586650f9d5e2749d4298b31ffb01314255f125481f613d0eef2112eb10097a733172c99a0edf64ea4d153ac2cd3a607b2c1e45b06d41b1d3
+  data.tar.gz: 3050df5407794bea99483173142d65f2c7eb997b81e1aad6b62ee28ccd807688eef675cb4711e12d3b5abc7c21e081a610836cc4ef9b1fed91cb30d95253c8a9

data/.rspec

@@ -1,3 +1,4 @@
 --color
 --require spec_helper
---format documentation
+--format documentation
+--order rand

data/README.md

@@ -40,13 +40,21 @@ use Grape::Batch::Base
 ```
 
 ### Settings
-You can customize the middleware with a hash.
+Override any of these defaults in config/initializers/grape_batch.rb:
+
+```ruby
+Grape::Batch.configure do |config|
+  config.limit = 10
+  config.path = '/batch'
+  config.formatter = Grape::Batch::Response
+end
+```
 
 | Argument | Type | Default | Description
 | :---: | :---: | :---: | :---:
-| :limit | integer | 10 | Maximum number of batched requests allowed by the middleware
-| :path | string | /batch | Route on which the middleware is mounted on
-| :formatter | class | Grape::Batch::Response | The response formatter to use
+| limit | integer | 10 | Maximum number of batched requests allowed by the middleware
+| path | string | /batch | Route on which the middleware is mounted on
+| formatter | class | Grape::Batch::Response | The response formatter to use
 
 #### Response formatter
 #####Default format (success)
@@ -95,4 +103,4 @@ POST http request on the default URL with a similar body:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request

data/lib/grape/batch/configuration.rb

@@ -0,0 +1,30 @@
+module Grape
+  module Batch
+    class Configuration
+      attr_accessor :path, :limit, :formatter
+
+      def initialize
+        @path  = '/batch'
+        @limit = 10
+        @formatter = Grape::Batch::Response
+      end
+    end
+
+    # Set default configuration for Grape::Batch middleware
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configuration=(config)
+      @configuration = config
+    end
+
+    def self.configure
+      yield configuration
+    end
+  end
+end

data/lib/grape/batch/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Batch
-    VERSION = '1.0.4'
+    VERSION = '1.1.0'
   end
 end

data/lib/grape/batch.rb

@@ -1,4 +1,5 @@
 require 'grape/batch/errors'
+require 'grape/batch/configuration'
 require 'grape/batch/parser'
 require 'grape/batch/response'
 require 'grape/batch/version'
@@ -7,11 +8,9 @@ require 'multi_json'
 module Grape
   module Batch
     class Base
-      def initialize(app, opt = {})
+      def initialize(app)
         @app = app
-        @limit = opt[:limit] || 10
-        @path = opt[:path] || '/batch'
-        @response_klass = opt[:formatter] || Grape::Batch::Response
+        @response_klass = Grape::Batch.configuration.formatter
       end
 
       def call(env)
@@ -24,7 +23,7 @@ module Grape
         headers = {'Content-Type' => 'application/json'}
 
         begin
-          batch_requests = Grape::Batch::Validator::parse(env, @limit)
+          batch_requests = Grape::Batch::Validator::parse(env, Grape::Batch.configuration.limit)
           result = dispatch(env, batch_requests)
           body = MultiJson.encode(result)
         rescue Grape::Batch::RequestBodyError, Grape::Batch::TooManyRequestsError => e
@@ -38,7 +37,7 @@ module Grape
       private
 
       def is_batch_request?(env)
-        env['PATH_INFO'].start_with?(@path) &&
+        env['PATH_INFO'].start_with?(Grape::Batch.configuration.path) &&
             env['REQUEST_METHOD'] == 'POST' &&
             env['CONTENT_TYPE'] == 'application/json'
       end

data/spec/requests_spec.rb

@@ -161,4 +161,30 @@ RSpec.describe Grape::Batch::Base do
       end
     end
   end
+
+  describe '#configure' do
+    it { expect(Grape::Batch.configuration).to_not be_nil }
+
+    describe 'default_value' do
+      it { expect(Grape::Batch.configuration.path).to eq('/batch') }
+      it { expect(Grape::Batch.configuration.formatter).to eq(Grape::Batch::Response) }
+      it { expect(Grape::Batch.configuration.limit).to eq(10) }
+    end
+
+    describe '.configure' do
+      before do
+        allow(  Grape::Batch).to receive(:configuration) do
+          config = Grape::Batch::Configuration.new
+          config.path = '/custom_path'
+          config.limit = 15
+          config
+        end
+      end
+
+      describe 'default_value' do
+        it { expect(Grape::Batch.configuration.path).to eq('/custom_path') }
+        it { expect(Grape::Batch.configuration.limit).to eq(15) }
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-batch
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Lionel Oto
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2014-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -130,6 +130,7 @@ files:
 - Rakefile
 - grape-batch.gemspec
 - lib/grape/batch.rb
+- lib/grape/batch/configuration.rb
 - lib/grape/batch/errors.rb
 - lib/grape/batch/parser.rb
 - lib/grape/batch/response.rb