batch_api2 0.3.0

data/spec/rack-integration/rails_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require_relative './shared_examples'
+
+describe "Rails integration specs", type: :request do
+  before :each do
+    allow(BatchApi).to receive(:rails?).and_return(true)
+  end
+
+  it_should_behave_like "integrating with a server"
+end

data/spec/rack-integration/shared_examples.rb

@@ -0,0 +1,273 @@
+shared_examples_for "a get request" do
+  it "returns the body as objects" do
+    @result = JSON.parse(response.body)["results"][0]
+    expect(@result["body"]).to eq(get_result[:body])
+  end
+
+  it "returns the expected status" do
+    expect(@result["status"]).to eq(get_result[:status])
+  end
+
+  it "returns the expected headers" do
+    expect(@result["headers"]).to include(get_result[:headers])
+  end
+
+  it "verifies that the right headers were received" do
+    expect(@result["headers"]["REQUEST_HEADERS"]).to include(
+      headerize(get_headers)
+    )
+  end
+end
+
+shared_examples_for "integrating with a server" do
+  def headerize(hash)
+    Hash[hash.map do |k, v|
+      ["HTTP_#{k.to_s.upcase}", v.to_s]
+    end]
+  end
+
+  before :all do
+    BatchApi.config.endpoint = "/batch"
+    BatchApi.config.verb = :post
+  end
+
+  before :each do
+    allow(BatchApi::ErrorWrapper).to receive(:expose_backtrace?).and_return(false)
+  end
+
+  # these are defined in the dummy app's endpoints controller
+  let(:get_headers) { {"foo" => "bar"} }
+  let(:get_params) { {"other" => "value" } }
+
+  let(:get_request) { {
+    url: "/endpoint",
+    method: "get",
+    headers: get_headers,
+    params: get_params
+  } }
+
+  let(:get_by_default_request) { {
+    url: "/endpoint",
+    headers: get_headers,
+    params: get_params
+  } }
+
+  let(:get_result) { {
+    status: 422,
+    body: {
+      "result" => "GET OK",
+      "params" => get_params.merge(
+        BatchApi.rails? ? {
+          "controller" => "endpoints",
+          "action" => "get"
+        } : {}
+      )
+    },
+    headers: { "GET" => "hello" }
+  } }
+
+  # these are defined in the dummy app's endpoints controller
+  let(:post_headers) { {"foo" => "bar"} }
+  let(:post_params) { {"other" => "value"} }
+
+  let(:post_request) { {
+    url: "/endpoint",
+    method: "post",
+    headers: post_headers,
+    params: post_params
+  } }
+
+  let(:post_result) { {
+    status: 203,
+    body: {
+      "result" => "POST OK",
+      "params" => post_params.merge(
+        BatchApi.rails? ? {
+          "controller" => "endpoints",
+          "action" => "post"
+        } : {}
+      )
+    },
+    headers: { "POST" => "guten tag" }
+  } }
+
+  let(:error_request) { {
+    url: "/endpoint/error",
+    method: "get"
+  } }
+
+  let(:error_response) { {
+    status: 500,
+    body: { "error" => { "message" => "StandardError" } }
+  } }
+
+  let(:missing_request) { {
+    url: "/dont/work",
+    method: "delete"
+  } }
+
+  let(:missing_response) { {
+    status: 404,
+    body: {}
+  } }
+
+  let(:parameter) {
+    (rand * 10000).to_i
+  }
+
+  let(:parameter_request) { {
+    url: "/endpoint/capture/#{parameter}",
+    method: "get"
+  } }
+
+  let(:parameter_result) { {
+    body: {
+      "result" => parameter.to_s
+    }
+  } }
+
+  let(:silent_request) { {
+    url: "/endpoint",
+    method: "post",
+    silent: true
+  } }
+
+  let(:failed_silent_request) {
+    error_request.merge(silent: true)
+  }
+
+  let(:failed_silent_result) {
+    error_response
+  }
+
+  before :each do
+    @t = Time.now
+    begin
+    post "/batch", {
+      ops: [
+        get_request,
+        post_request,
+        error_request,
+        missing_request,
+        parameter_request,
+        silent_request,
+        failed_silent_request,
+        get_by_default_request
+      ],
+      sequential: true
+    }.to_json, "CONTENT_TYPE" => "application/json"
+    rescue => err
+      puts err.message
+      puts err.backtrace.join("\n")
+      raise
+    end
+  end
+
+  it "returns a 200" do
+    expect(response.status).to eq(200)
+  end
+
+  it "includes results" do
+    expect(JSON.parse(response.body)["results"]).to be_a(Array)
+  end
+
+  context "for a get request" do
+    describe "with an explicit get" do
+      before :each do
+        @result = JSON.parse(response.body)["results"][0]
+      end
+
+      it_should_behave_like "a get request"
+    end
+
+    describe "with no method" do
+      before :each do
+        @result = JSON.parse(response.body)["results"][7]
+      end
+
+      it_should_behave_like "a get request"
+    end
+  end
+
+  context "for a request with parameters" do
+    describe "the response" do
+      before :each do
+        @result = JSON.parse(response.body)["results"][4]
+      end
+
+      it "properly parses the URL segment as a paramer" do
+        expect(@result["body"]).to eq(parameter_result[:body])
+      end
+    end
+  end
+
+  context "for a post request" do
+    describe "the response" do
+      before :each do
+        @result = JSON.parse(response.body)["results"][1]
+      end
+
+      it "returns the body as objects (since DecodeJsonBody is default)" do
+        expect(@result["body"]).to eq(post_result[:body])
+      end
+
+      it "returns the expected status" do
+        expect(@result["status"]).to eq(post_result[:status])
+      end
+
+      it "returns the expected headers" do
+        expect(@result["headers"]).to include(post_result[:headers])
+      end
+
+      it "verifies that the right headers were received" do
+        expect(@result["headers"]["REQUEST_HEADERS"]).to include(headerize(post_headers))
+      end
+    end
+  end
+
+  context "for a request that returns an error" do
+    before :each do
+      @result = JSON.parse(response.body)["results"][2]
+    end
+
+    it "returns the right status" do
+      expect(@result["status"]).to eq(error_response[:status])
+    end
+
+    it "returns the right error information" do
+      # we don't care about the backtrace,
+      # the main thing is that the messsage arrives
+      expect(@result["body"]["error"]).to include(error_response[:body]["error"])
+    end
+  end
+
+  context "for a request that returns error" do
+    before :each do
+      @result = JSON.parse(response.body)["results"][3]
+    end
+
+    it "returns the right status" do
+      expect(@result["status"]).to eq(404)
+    end
+  end
+
+  context "for a silent request" do
+    before :each do
+      @result = JSON.parse(response.body)["results"][5]
+    end
+
+    it "returns nothing" do
+      expect(@result).to eq({})
+    end
+  end
+
+  context "for a silent request that causes an error" do
+    before :each do
+      @result = JSON.parse(response.body)["results"][6]
+    end
+
+    it "returns a regular result" do
+      expect(@result.keys).not_to be_empty
+    end
+  end
+end

data/spec/rack-integration/sinatra_integration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'support/sinatra_app'
+require 'rack/test'
+require_relative './shared_examples'
+
+describe "Sinatra integration" do
+  include Rack::Test::Methods
+
+  def app
+    SinatraApp
+  end
+
+  # for compatibility with the Rails specs, which expect response
+  def response
+    last_response
+  end
+
+  it_should_behave_like "integrating with a server"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec'
+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.color = true
+
+  config.before :each do
+    BatchApi.config.limit = 20
+    BatchApi.config.endpoint = "/batch"
+    BatchApi.config.verb = :post
+
+    allow(BatchApi).to receive(:rails?).and_return(false)
+  end
+
+  # rspec-rails 3 will no longer automatically infer an example group's spec type
+  # from the file location. You can explicitly opt-in to the feature using this
+  # config option.
+  # To explicitly tag specs without using automatic inference, set the `:type`
+  # metadata manually:
+  #
+  #     describe ThingsController, :type => :controller do
+  #       # Equivalent to being in spec/controllers
+  #     end
+  config.infer_spec_type_from_file_location!
+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
+

data/spec/support/sinatra_xhr.rb

@@ -0,0 +1,13 @@
+module SinatraXhr
+  # add xhr method to specs for the Sinatra app
+  # modeled on Rails
+  # see
+  def xhr(request_method, action, parameters = nil, session = nil, flash = nil)
+    @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+    @request.env['HTTP_ACCEPT'] ||=  [Mime::JS, Mime::HTML, Mime::XML, 'text/xml', Mime::ALL].join(', ')
+    __send__(request_method, action, parameters, session, flash).tap do
+      @request.env.delete 'HTTP_X_REQUESTED_WITH'
+      @request.env.delete 'HTTP_ACCEPT'
+    end
+  end
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: batch_api2
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Alex Koppel, Arvind, Sandhiya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-07 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'
+description: A Batch API plugin that provides a RESTful syntax, allowing clients to
+  make any number of REST calls with a single HTTP request. Removing use for MultiJson
+email:
+- dnivra26@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- changelog.md
+- 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/Gemfile
+- spec/dummy/Gemfile.lock
+- 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/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- 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/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.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/secrets.yml
+- 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/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/rack-integration/rails_spec.rb
+- spec/rack-integration/shared_examples.rb
+- spec/rack-integration/sinatra_integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/sinatra_app.rb
+- spec/support/sinatra_xhr.rb
+homepage: http://github.com/dnivra26/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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.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/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- 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/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.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/secrets.yml
+- spec/dummy/config.ru
+- spec/dummy/db/test.sqlite3
+- spec/dummy/Gemfile
+- spec/dummy/Gemfile.lock
+- 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/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/rack-integration/rails_spec.rb
+- spec/rack-integration/shared_examples.rb
+- spec/rack-integration/sinatra_integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/sinatra_app.rb
+- spec/support/sinatra_xhr.rb