RubyGems - batch_api - Versions diffs - 0.1.1 → 0.2.0 - Mend

batch_api 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (81) hide show

data/changelog.md +17 -0
data/lib/batch_api.rb +6 -1
data/lib/batch_api/batch_error.rb +41 -0
data/lib/batch_api/configuration.rb +31 -21
data/lib/batch_api/error_wrapper.rb +44 -0
data/lib/batch_api/internal_middleware.rb +87 -0
data/lib/batch_api/internal_middleware/decode_json_body.rb +24 -0
data/lib/batch_api/internal_middleware/response_filter.rb +27 -0
data/lib/batch_api/operation/rack.rb +4 -5
data/lib/batch_api/processor.rb +22 -20
data/lib/batch_api/processor/executor.rb +18 -0
data/lib/batch_api/processor/sequential.rb +29 -0
data/lib/batch_api/{middleware.rb → rack_middleware.rb} +2 -2
data/lib/batch_api/response.rb +10 -8
data/lib/batch_api/version.rb +1 -1
data/readme.md +179 -106
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +15 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/javascripts/endpoints.js +2 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/assets/stylesheets/endpoints.css +4 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/controllers/endpoints_controller.rb +36 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/helpers/endpoints_helper.rb +2 -0
data/spec/dummy/app/views/endpoints/get.html.erb +2 -0
data/spec/dummy/app/views/endpoints/post.html.erb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +63 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +64 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +1742 -0
data/spec/dummy/log/test.log +48237 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/dummy/test/functional/endpoints_controller_test.rb +14 -0
data/spec/dummy/test/unit/helpers/endpoints_helper_test.rb +4 -0
data/spec/integration/rails_spec.rb +10 -0
data/spec/integration/shared_examples.rb +256 -0
data/spec/integration/sinatra_integration_spec.rb +14 -0
data/spec/lib/batch_api_spec.rb +20 -0
data/spec/lib/batch_error_spec.rb +23 -0
data/spec/lib/configuration_spec.rb +30 -0
data/spec/lib/error_wrapper_spec.rb +68 -0
data/spec/lib/internal_middleware/decode_json_body_spec.rb +37 -0
data/spec/lib/internal_middleware/response_filter_spec.rb +61 -0
data/spec/lib/internal_middleware_spec.rb +91 -0
data/spec/lib/operation/rack_spec.rb +243 -0
data/spec/lib/operation/rails_spec.rb +100 -0
data/spec/lib/processor/executor_spec.rb +22 -0
data/spec/lib/processor/sequential_spec.rb +39 -0
data/spec/lib/processor_spec.rb +134 -0
data/spec/lib/rack_middleware_spec.rb +103 -0
data/spec/lib/response_spec.rb +53 -0
data/spec/spec_helper.rb +28 -0
data/spec/support/sinatra_app.rb +54 -0
metadata +148 -12
data/lib/batch_api/error.rb +0 -3
data/lib/batch_api/errors/base.rb +0 -45
data/lib/batch_api/errors/operation.rb +0 -7
data/lib/batch_api/errors/request.rb +0 -26
data/lib/batch_api/processor/strategies/sequential.rb +0 -18

data/spec/dummy/public/404.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED

File without changes

data/spec/dummy/script/rails ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/dummy/test/functional/endpoints_controller_test.rb ADDED

@@ -0,0 +1,14 @@
+require 'test_helper'
+class EndpointsControllerTest < ActionController::TestCase
+  test "should get get" do
+    get :get
+    assert_response :success
+  end
+  test "should get post" do
+    get :post
+    assert_response :success
+  end
+end

data/spec/dummy/test/unit/helpers/endpoints_helper_test.rb ADDED

@@ -0,0 +1,4 @@
+require 'test_helper'
+class EndpointsHelperTest < ActionView::TestCase
+end

data/spec/integration/rails_spec.rb ADDED

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

data/spec/integration/shared_examples.rb ADDED

@@ -0,0 +1,256 @@
+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
+    BatchApi::ErrorWrapper.stub(: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_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
+    xhr :post, "/batch", {
+      ops: [
+        get_request,
+        post_request,
+        error_request,
+        missing_request,
+        parameter_request,
+        silent_request,
+        failed_silent_request
+      ],
+      sequential: true
+    }.to_json, "CONTENT_TYPE" => "application/json"
+  end
+  it "returns a 200" do
+    response.status.should == 200
+  end
+  it "includes results" do
+    JSON.parse(response.body)["results"].should be_a(Array)
+  end
+  context "for a get request" do
+    describe "the response" do
+      before :each do
+        @result = JSON.parse(response.body)["results"][0]
+      end
+      it "returns the body as objects" do
+        @result = JSON.parse(response.body)["results"][0]
+        @result["body"].should == get_result[:body]
+      end
+      it "returns the expected status" do
+        @result["status"].should == get_result[:status]
+      end
+      it "returns the expected headers" do
+        @result["headers"].should include(get_result[:headers])
+      end
+      it "verifies that the right headers were received" do
+        @result["headers"]["REQUEST_HEADERS"].should include(
+          headerize(get_headers)
+        )
+      end
+    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
+        @result["body"].should == 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 raw if decode_json_responses = false" do
+        # BatchApi.config.decode_bodies = false
+        xhr :post, "/batch", {ops: [post_request], sequential: true}.to_json,
+          "CONTENT_TYPE" => "application/json"
+        @result = JSON.parse(response.body)["results"][0]
+        @result["body"].should == JSON.parse(post_result[:body].to_json)
+      end
+      it "returns the body as objects if decode_json_responses = true" do
+        @result["body"].should == post_result[:body]
+      end
+      it "returns the expected status" do
+        @result["status"].should == post_result[:status]
+      end
+      it "returns the expected headers" do
+        @result["headers"].should include(post_result[:headers])
+      end
+      it "verifies that the right headers were received" do
+        @result["headers"]["REQUEST_HEADERS"].should 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
+      @result["status"].should == 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
+      @result["body"]["error"].should 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
+      @result["status"].should == 404
+    end
+  end
+  context "for a silent request" do
+    before :each do
+      @result = JSON.parse(response.body)["results"][5]
+    end
+    it "returns nothing" do
+      @result.should == {}
+    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
+      @result.keys.should_not be_empty
+    end
+  end
+end

data/spec/integration/sinatra_integration_spec.rb ADDED

@@ -0,0 +1,14 @@
+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
+  it_should_behave_like "integrating with a server"
+end

data/spec/lib/batch_api_spec.rb ADDED

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'batch_api'
+describe BatchApi do
+  describe ".config" do
+    it "has a reader for config" do
+      BatchApi.config.should_not be_nil
+    end
+    it "provides a default config" do
+      BatchApi.config.should be_a(BatchApi::Configuration)
+    end
+  end
+  describe ".rails?" do
+    it "returns a value we can't test based on whether Rails is defined" do
+      BatchApi.rails?.should_not be_nil
+    end
+  end
+end

data/spec/lib/batch_error_spec.rb ADDED

@@ -0,0 +1,23 @@
+require 'spec_helper'
+describe BatchApi::Errors::BatchError do
+  [
+    BatchApi::Errors::OperationLimitExceeded,
+    BatchApi::Errors::BadOptionError,
+    BatchApi::Errors::NoOperationsError,
+    BatchApi::Errors::MalformedOperationError
+  ].each do |klass|
+    it "provides a #{klass} error based on ArgumentError" do
+      klass.superclass.should == ArgumentError
+    end
+    it "is is also a BatchError" do
+      klass.new.should be_a(BatchApi::Errors::BatchError)
+    end
+    it "has a status code of 422" do
+      klass.new.status_code.should == 422
+    end
+  end
+end

data/spec/lib/configuration_spec.rb ADDED

@@ -0,0 +1,30 @@
+require 'spec_helper'
+module BatchApi
+  describe Configuration do
+    let(:config) { Configuration.new }
+    describe "options" do
+      {
+        verb: :post,
+        endpoint: "/batch",
+        limit: 50,
+        batch_middleware: InternalMiddleware::DEFAULT_BATCH_MIDDLEWARE,
+        operation_middleware: InternalMiddleware::DEFAULT_OPERATION_MIDDLEWARE
+      }.each_pair do |option, default|
+        opt, defa = option, default
+        describe "##{opt}" do
+          it "has an accessor for #{opt}" do
+            stubby = stub
+            config.send("#{opt}=", stubby)
+            config.send(opt).should == stubby
+          end
+          it "defaults #{opt} to #{defa.inspect}" do
+            config.send(opt).should == defa
+          end
+        end
+      end
+    end
+  end
+end