batch_api 0.1.1 → 0.2.0

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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batch_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -115,17 +131,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/batch_api/batch_error.rb
 - lib/batch_api/configuration.rb
-- lib/batch_api/error.rb
-- lib/batch_api/errors/base.rb
-- lib/batch_api/errors/operation.rb
-- lib/batch_api/errors/request.rb
-- lib/batch_api/middleware.rb
+- lib/batch_api/error_wrapper.rb
+- lib/batch_api/internal_middleware/decode_json_body.rb
+- lib/batch_api/internal_middleware/response_filter.rb
+- lib/batch_api/internal_middleware.rb
 - lib/batch_api/operation/rack.rb
 - lib/batch_api/operation/rails.rb
 - lib/batch_api/operation.rb
-- lib/batch_api/processor/strategies/sequential.rb
+- lib/batch_api/processor/executor.rb
+- lib/batch_api/processor/sequential.rb
 - lib/batch_api/processor.rb
+- lib/batch_api/rack_middleware.rb
 - lib/batch_api/response.rb
 - lib/batch_api/utils.rb
 - lib/batch_api/version.rb
@@ -135,6 +153,65 @@ files:
 - Rakefile
 - changelog.md
 - readme.md
+- 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/development.sqlite3
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- 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
 homepage: http://github.com/arsduo/batch_api
 licenses: []
 post_install_message: 
@@ -149,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3100964664303252178
+      hash: 1297509053132292607
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -158,11 +235,70 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3100964664303252178
+      hash: 1297509053132292607
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A RESTful Batch API for Rails
-test_files: []
+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/development.sqlite3
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- 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

data/lib/batch_api/error.rb

@@ -1,3 +0,0 @@
-require 'batch_api/errors/request'
-require 'batch_api/errors/operation'
-

data/lib/batch_api/errors/base.rb

@@ -1,45 +0,0 @@
-module BatchApi
-  # Public: an error thrown during a batch operation.
-  # This has a body class and a cookies accessor and can
-  # function in place of a regular BatchResponse object.
-  module Errors
-    class Base
-      # Public: create a new BatchError from a Rails error.
-      def initialize(error)
-        @error = error
-      end
-
-      # Public: the error details as a hash, which can be returned
-      # to clients as JSON.
-      def body
-        message = if self.class.expose_backtrace?
-          {
-            message: @error.message,
-            backtrace: @error.backtrace
-          }
-        else
-          { message: @error.message }
-        end
-        { error: message }
-      end
-
-      # Public: turn the error body into a Rack-compatible body component.
-      #
-      # Returns: an Array with the error body represented as JSON.
-      def render
-        [status_code, Middleware.content_type, [MultiJson.dump(body)]]
-      end
-
-      # Public: the status code to return for the given error.
-      def status_code
-        500
-      end
-
-      # Internal: whether the backtrace should be exposed in the response.
-      # Currently Rails-specific, needs to be generalized (to ENV["RACK_ENV"])?
-      def self.expose_backtrace?
-        !Rails.env.production?
-      end
-    end
-  end
-end

data/lib/batch_api/errors/operation.rb

@@ -1,7 +0,0 @@
-require 'batch_api/errors/base'
-
-module BatchApi
-  module Errors
-    class Operation < Base; end
-  end
-end

data/lib/batch_api/errors/request.rb

@@ -1,26 +0,0 @@
-require 'batch_api/errors/base'
-
-module BatchApi
-  module Errors
-    # Public: This class encapsulates errors that occur at a request level.
-    # For instance, it returns proper error codes for BadOptionErrors or other
-    # identifiable problems.  (For actual code errors, it returns a 500
-    # response.)
-    class Request < BatchApi::Errors::Base
-      # Public: return the appropriate status code for the error.  For
-      # errors from bad Batch API input, raise a 422, otherwise, a 500.
-      def status_code
-        case @error
-        when BatchApi::Processor::BadOptionError,
-             BatchApi::Processor::OperationLimitExceeded,
-             BatchApi::Processor::NoOperationsError,
-             BatchApi::Operation::MalformedOperationError
-          422
-        else
-          500
-        end
-      end
-    end
-  end
-end
-

data/lib/batch_api/processor/strategies/sequential.rb

@@ -1,18 +0,0 @@
-module BatchApi
-  class Processor
-    module Strategies
-      module Sequential
-        # Public: execute all operations sequentially.
-        #
-        # ops - a set of BatchApi::Operations
-        # options - a set of options
-        #
-        # Returns an array of BatchApi::Response objects.
-        def self.execute!(ops, options = {})
-          ops.map(&:execute)
-        end
-      end
-    end
-  end
-end
-