adavidev_batch_api 0.2.1.pre.2

data/spec/lib/processor_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe BatchApi::Processor do
+
+  let(:ops) { [ {"url" => "/endpoint", "method" => "get"} ] }
+  let(:options) { { "sequential" => true } }
+  let(:env) { {
+    "CONTENT_TYPE"=>"application/x-www-form-urlencoded",
+    "GATEWAY_INTERFACE"=>"CGI/1.1",
+    "PATH_INFO"=>"/foo",
+    "QUERY_STRING"=>"",
+    "REMOTE_ADDR"=>"127.0.0.1",
+    "REMOTE_HOST"=>"1035.spotilocal.com",
+    "REQUEST_METHOD"=>"REPORT",
+    "REQUEST_URI"=>"http://localhost:3000/batch",
+    "SCRIPT_NAME"=>"",
+    "rack.input" => StringIO.new,
+    "rack.errors" => StringIO.new,
+    "SERVER_NAME"=>"localhost",
+    "SERVER_PORT"=>"3000",
+    "SERVER_PROTOCOL"=>"HTTP/1.1",
+    "SERVER_SOFTWARE"=>"WEBrick/1.3.1 (Ruby/1.9.3/2012-02-16)",
+    "HTTP_USER_AGENT"=>"curl/7.21.4 (universal-apple-darwin11.0) libcurl/7.21",
+    "HTTP_HOST"=>"localhost:3000"
+  } }
+
+  let(:request) {
+    Rack::Request.new(env).tap do |r|
+      r.stub(:params).and_return({}.merge("ops" => ops).merge(options))
+    end
+  }
+  let(:app) { stub("application", call: [200, {}, ["foo"]]) }
+  let(:processor) { BatchApi::Processor.new(request, app) }
+
+  describe "#initialize" do
+    # this may be brittle...consider refactoring?
+    it "turns the ops params into processed operations at #ops" do
+      # simulate receiving several operations
+      klass = stub("op class")
+      BatchApi::Processor.stub(:operation_klass).and_return(klass)
+      operation_objects = 3.times.collect { stub("operation object") }
+      operation_params = 3.times.collect do |i|
+        stub("raw operation").tap do |o|
+          klass.should_receive(:new)
+            .with(o, env, app).and_return(operation_objects[i])
+        end
+      end
+
+      request.params["ops"] = operation_params
+      BatchApi::Processor.new(request, app).ops.should == operation_objects
+    end
+
+    it "makes the options available" do
+      BatchApi::Processor.new(request, app).options.should == options
+    end
+
+    it "makes the app available" do
+      BatchApi::Processor.new(request, app).app.should == app
+    end
+
+    context "error conditions" do
+      it "(currently) throws an error if sequential is not true" do
+        request.params.delete("sequential")
+        expect {
+          BatchApi::Processor.new(request, app)
+        }.to raise_exception(BatchApi::Errors::BadOptionError)
+      end
+
+      it "raise a OperationLimitExceeded error if too many ops provided" do
+        ops = (BatchApi.config.limit + 1).to_i.times.collect {|i| i}
+        request.params["ops"] = ops
+        expect {
+          BatchApi::Processor.new(request, app)
+        }.to raise_exception(BatchApi::Errors::OperationLimitExceeded)
+      end
+
+      it "raises a NoOperationError if operations.blank?" do
+        request.params["ops"] = nil
+        expect {
+          BatchApi::Processor.new(request, app)
+        }.to raise_exception(BatchApi::Errors::NoOperationsError)
+        request.params["ops"] = []
+        expect {
+          BatchApi::Processor.new(request, app)
+        }.to raise_exception(BatchApi::Errors::NoOperationsError)
+      end
+    end
+  end
+
+  describe "#strategy" do
+    it "returns BatchApi::Processor::Sequential" do
+      processor.strategy.should == BatchApi::Processor::Sequential
+    end
+  end
+
+  describe "#execute!" do
+    let(:result) { stub("result") }
+    let(:stack) { stub("stack", call: result) }
+    let(:middleware_env) { {
+      ops: processor.ops, # the processed Operation objects
+      rack_env: env,
+      rack_app: app,
+      options: options
+    } }
+
+    before :each do
+      BatchApi::InternalMiddleware.stub(:batch_stack).and_return(stack)
+    end
+
+    it "calls an internal middleware stacks with the appropriate data" do
+      stack.should_receive(:call).with(middleware_env)
+      processor.execute!
+    end
+
+    it "returns the formatted result of the strategy" do
+      stack.stub(:call).and_return(stubby = stub)
+      processor.execute!["results"].should == stubby
+    end
+  end
+
+  describe ".operation_klass" do
+    it "returns BatchApi::Operation::Rack if !Rails" do
+      BatchApi.stub(:rails?).and_return(false)
+      BatchApi::Processor.operation_klass.should ==
+        BatchApi::Operation::Rack
+    end
+
+    it "returns BatchApi::Operation::Rails if Rails" do
+      BatchApi.stub(:rails?).and_return(true)
+      BatchApi::Processor.operation_klass.should ==
+        BatchApi::Operation::Rails
+    end
+  end
+end

data/spec/lib/rack_middleware_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe BatchApi::RackMiddleware do
+  describe "#initialize" do
+    it "allows access to the BatchApi configuration" do
+      limit = rand * 100
+      middleware = BatchApi::RackMiddleware.new(stub("app")) do |conf|
+        conf.limit = limit
+      end
+      BatchApi.config.limit.should == limit
+    end
+  end
+
+  describe "#call" do
+    let(:endpoint) { "/foo/bar" }
+    let(:verb) { "run" }
+    let(:app) { stub("app") }
+
+    let(:middleware) {
+      BatchApi::RackMiddleware.new(app) do |conf|
+        conf.endpoint = endpoint
+        conf.verb = verb
+      end
+    }
+
+    context "if it's a batch call" do
+      let(:env) { {
+        "PATH_INFO" => endpoint,
+        "REQUEST_METHOD" => verb.upcase,
+        # other stuff
+        "CONTENT_TYPE"=>"application/x-www-form-urlencoded",
+        "GATEWAY_INTERFACE"=>"CGI/1.1",
+        "QUERY_STRING"=>"",
+        "REMOTE_ADDR"=>"127.0.0.1",
+        "REMOTE_HOST"=>"1035.spotilocal.com",
+        "REQUEST_URI"=>"http://localhost:3000/batch",
+        "SCRIPT_NAME"=>"",
+        "rack.input" => StringIO.new,
+        "rack.errors" => StringIO.new,
+        "SERVER_NAME"=>"localhost",
+        "SERVER_PORT"=>"3000",
+        "SERVER_PROTOCOL"=>"HTTP/1.1",
+        "SERVER_SOFTWARE"=>"WEBrick/1.3.1 (Ruby/1.9.3/2012-02-16)",
+        "HTTP_USER_AGENT"=>"curl/7.21.4 (universal-apple-darwin11.0) libcurl/7.21.4 OpenSSL/0.9.8r zlib/1.2.5",
+        "HTTP_HOST"=>"localhost:3000"
+      } }
+
+      let(:request) { Rack::Request.new(env) }
+      let(:result) { {a: 2, b: {c: 3}} }
+      let(:processor) { stub("processor", :execute! => result) }
+
+      before :each do
+        BatchApi::Processor.stub(:new).and_return(processor)
+      end
+
+      it "processes the batch request" do
+        Rack::Request.stub(:new).with(env).and_return(request)
+        BatchApi::Processor.should_receive(:new).with(request, app).and_return(processor)
+        middleware.call(env)
+      end
+
+      context "for a successful set of calls" do
+        it "returns the JSON-encoded result as the body" do
+          output = middleware.call(env)
+          output[2].should == [MultiJson.dump(result)]
+        end
+
+        it "returns a 200" do
+          middleware.call(env)[0].should == 200
+        end
+
+        it "sets the content type" do
+          middleware.call(env)[1].should include("Content-Type" => "application/json")
+        end
+      end
+
+      context "for BatchApi errors" do
+        it "returns a rendered ErrorWrapper" do
+          err, result = StandardError.new, stub
+          error = stub("error object", render: result)
+          BatchApi::Processor.stub(:new).and_raise(err)
+          BatchApi::ErrorWrapper.should_receive(:new).with(err).and_return(
+            error
+          )
+          middleware.call(env).should == result
+        end
+      end
+    end
+
+    context "if it's not a batch request" do
+      let(:env) { {
+        "PATH_INFO" => "/not/batch",
+        "REQUEST_METHOD" => verb.upcase
+      } }
+
+      it "just calls the app onward and returns the result" do
+        output = stub("output")
+        app.should_receive(:call).with(env).and_return(output)
+        middleware.call(env)
+      end
+    end
+  end
+end

data/spec/lib/response_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'batch_api/response'
+
+describe BatchApi::Response do
+
+  let(:raw_response) { [200, {}, ["ab", "cd", "ef"]] }
+  let(:response) { BatchApi::Response.new(raw_response) }
+
+  [:status, :body, :headers].each do |attr|
+    local_attr = attr
+    it "has an accessor for #{local_attr}" do
+      response.should respond_to(local_attr)
+    end
+  end
+
+  describe "#initialize" do
+    it "sets status to the HTTP status code" do
+      response.status.should == raw_response.first
+    end
+
+    it "sets body to the HTTP body turned into a string" do
+      response.body.should == raw_response[2].join
+    end
+
+    it "sets headers to the HTTP headers" do
+      response.headers.should == raw_response[1]
+    end
+  end
+
+  describe "#as_json" do
+    it "creates the expected hash" do
+      response.as_json.should == {
+        body: response.body,
+        status: response.status,
+        headers: response.headers
+      }
+    end
+
+    it "accepts options" do
+      response.as_json(foo: :bar).should_not be_nil
+    end
+
+    it "leaves out items that are blank" do
+      response.status = response.body = nil
+      response.as_json.should == {headers: raw_response[1]}
+    end
+
+    it "includes items that are false" do
+      response.body = false
+      response.as_json[:body].should == false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+require 'rspec/rails'
+require 'faker'
+require 'timecop'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end
+
+RSpec.configure do |config|
+  config.before :each do
+    BatchApi.config.limit = 20
+    BatchApi.config.endpoint = "/batch"
+    BatchApi.config.verb = :post
+
+    BatchApi.stub(:rails?).and_return(false)
+  end
+end

data/spec/support/sinatra_app.rb

@@ -0,0 +1,54 @@
+require 'sinatra/base'
+require 'rack/contrib'
+
+class SinatraApp < Sinatra::Base
+  use Rack::PostBodyContentTypeParser
+  use BatchApi::RackMiddleware
+
+  get "/endpoint" do
+    headers["GET"] = "hello"
+    # including this in the body would mess the body up
+    # due to the other headers inserted
+    headers["REQUEST_HEADERS"] = header_output
+    content_type :json
+
+    status 422
+    {
+      result: "GET OK",
+      params: params.except(:endpoint)
+    }.to_json
+  end
+
+  get "/endpoint/capture/:captured" do
+    content_type :json
+    {result: params[:captured]}.to_json
+  end
+
+  post "/endpoint" do
+    headers["POST"] = "guten tag"
+    headers["REQUEST_HEADERS"] = header_output
+    content_type :json
+    status 203
+    {
+      result: "POST OK",
+      params: params.except(:endpoint)
+    }.to_json
+  end
+
+  get "/endpoint/error" do
+    raise StandardError
+  end
+
+  private
+
+  def header_output
+    # we only want the headers that were sent by the client
+    # headers in sinatra are just read directly from env
+    # env has a ton of additional information we don't want
+    # and that reference the request itself, causing an infinite loop
+    env.inject({}) do |h, (k, v)|
+      h.tap {|hash| hash[k.to_s] = v.to_s if k =~ /HTTP_/}
+    end
+  end
+end
+

metadata

@@ -0,0 +1,264 @@
+--- !ruby/object:Gem::Specification
+name: adavidev_batch_api
+version: !ruby/object:Gem::Version
+  version: 0.2.1.pre.2
+platform: ruby
+authors:
+- Alex Koppel
+- Alan Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Batch API plugin that provides a RESTful syntax, allowing clients to
+  make any number of REST calls with a single HTTP request. This is a fork of arsduo/batch_api
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- changelog.md
+- lib/adavidev_batch_api.rb
+- lib/batch_api.rb
+- lib/batch_api/batch_error.rb
+- lib/batch_api/configuration.rb
+- lib/batch_api/error_wrapper.rb
+- lib/batch_api/internal_middleware.rb
+- lib/batch_api/internal_middleware/decode_json_body.rb
+- lib/batch_api/internal_middleware/response_filter.rb
+- lib/batch_api/operation.rb
+- lib/batch_api/operation/rack.rb
+- lib/batch_api/operation/rails.rb
+- lib/batch_api/processor.rb
+- lib/batch_api/processor/executor.rb
+- lib/batch_api/processor/sequential.rb
+- lib/batch_api/rack_middleware.rb
+- lib/batch_api/response.rb
+- lib/batch_api/utils.rb
+- lib/batch_api/version.rb
+- lib/tasks/batch_api_tasks.rake
+- readme.md
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/javascripts/endpoints.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/assets/stylesheets/endpoints.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/endpoints_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/helpers/endpoints_helper.rb
+- spec/dummy/app/views/endpoints/get.html.erb
+- spec/dummy/app/views/endpoints/post.html.erb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/dummy/test/functional/endpoints_controller_test.rb
+- spec/dummy/test/unit/helpers/endpoints_helper_test.rb
+- spec/integration/rails_spec.rb
+- spec/integration/shared_examples.rb
+- spec/integration/sinatra_integration_spec.rb
+- spec/lib/batch_api_spec.rb
+- spec/lib/batch_error_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/error_wrapper_spec.rb
+- spec/lib/internal_middleware/decode_json_body_spec.rb
+- spec/lib/internal_middleware/response_filter_spec.rb
+- spec/lib/internal_middleware_spec.rb
+- spec/lib/operation/rack_spec.rb
+- spec/lib/operation/rails_spec.rb
+- spec/lib/processor/executor_spec.rb
+- spec/lib/processor/sequential_spec.rb
+- spec/lib/processor_spec.rb
+- spec/lib/rack_middleware_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/sinatra_app.rb
+homepage: http://github.com/adavidev/batch_api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A RESTful Batch API for Rails
+test_files:
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/javascripts/endpoints.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/assets/stylesheets/endpoints.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/endpoints_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/helpers/endpoints_helper.rb
+- spec/dummy/app/views/endpoints/get.html.erb
+- spec/dummy/app/views/endpoints/post.html.erb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config.ru
+- spec/dummy/db/test.sqlite3
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/dummy/script/rails
+- spec/dummy/test/functional/endpoints_controller_test.rb
+- spec/dummy/test/unit/helpers/endpoints_helper_test.rb
+- spec/integration/rails_spec.rb
+- spec/integration/shared_examples.rb
+- spec/integration/sinatra_integration_spec.rb
+- spec/lib/batch_api_spec.rb
+- spec/lib/batch_error_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/error_wrapper_spec.rb
+- spec/lib/internal_middleware/decode_json_body_spec.rb
+- spec/lib/internal_middleware/response_filter_spec.rb
+- spec/lib/internal_middleware_spec.rb
+- spec/lib/operation/rack_spec.rb
+- spec/lib/operation/rails_spec.rb
+- spec/lib/processor/executor_spec.rb
+- spec/lib/processor/sequential_spec.rb
+- spec/lib/processor_spec.rb
+- spec/lib/rack_middleware_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/sinatra_app.rb
+has_rdoc: