adavidev_batch_api 0.2.1.pre.2

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '62dfab0df1ef66ae95f30772dda6387acdb66116bfdae29d824033e2a5b7d713a9fe4fb7735d5e9931207e73774af200ec9008d12ab1d3df41e8c7744194a6c0'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,64 @@
+Dummy::Application.routes.draw do
+
+  post "/endpoint" => "endpoints#post"
+  get "/endpoint" => "endpoints#get"
+  get "/endpoint/error" => "endpoints#error"
+  get "/endpoint/capture/:captured" => "endpoints#capture"
+
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => 'welcome#index'
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id))(.:format)'
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/public/404.html

@@ -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

@@ -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

@@ -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/script/rails

@@ -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

@@ -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

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

data/spec/integration/rails_spec.rb

@@ -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

@@ -0,0 +1,267 @@
+shared_examples_for "a get request" do
+  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
+
+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_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
+    xhr :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"
+  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 "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
+        @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 as objects (since DecodeJsonBody is default)" 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

@@ -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

@@ -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

@@ -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

@@ -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

data/spec/lib/error_wrapper_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'batch_api/error_wrapper'
+
+describe BatchApi::ErrorWrapper do
+  let(:exception) {
+    StandardError.new(Faker::Lorem.words(3)).tap do |e|
+      e.set_backtrace(Kernel.caller)
+    end
+  }
+
+  let(:error) { BatchApi::ErrorWrapper.new(exception) }
+
+  describe "#body" do
+    it "includes the message in the body" do
+      error.body[:error][:message].should == exception.message
+    end
+
+    it "includes the backtrace if it should be there" do
+      error.stub(:expose_backtrace?).and_return(true)
+      error.body[:error][:backtrace].should == exception.backtrace
+    end
+
+    it "includes the backtrace if it should be there" do
+      error.stub(:expose_backtrace?).and_return(false)
+      error.body[:backtrace].should be_nil
+    end
+  end
+
+  describe "#render" do
+    it "returns the appropriate status" do
+      status = stub
+      error.stub(:status_code).and_return(status)
+      error.render[0].should == status
+    end
+
+    it "returns appropriate content type" do
+      ctype = stub
+      BatchApi::RackMiddleware.stub(:content_type).and_return(ctype)
+      error.render[1].should == ctype
+    end
+
+    it "returns the JSONified body as the 2nd" do
+      error.render[2].should == [MultiJson.dump(error.body)]
+    end
+  end
+
+  describe "#status_code" do
+    it "returns 500 by default" do
+      error.status_code.should == 500
+    end
+
+    it "returns another status code if the error supports that" do
+      err = StandardError.new
+      code = stub
+      err.stub(:status_code).and_return(code)
+      BatchApi::ErrorWrapper.new(err).status_code.should == code
+    end
+  end
+
+  describe ".expose_backtrace?" do
+    it "returns false if Rails.env.production?" do
+      Rails.env.stub(:production?).and_return(true)
+      BatchApi::ErrorWrapper.expose_backtrace?.should be_false
+      Rails.env.stub(:production?).and_return(false)
+      BatchApi::ErrorWrapper.expose_backtrace?.should be_true
+    end
+  end
+end