batch_api 0.0.8 → 0.1.0

data/changelog.md

@@ -1,3 +1,7 @@
+v0.0.9
+* Add direct support for Rails for path params
+* Fix spec bugs
+
 v0.0.8
 * Return the results wrapped in a hash, rather than a raw array
 * Add process_start timestamp option

data/lib/batch_api.rb

@@ -5,7 +5,19 @@ require 'batch_api/processor'
 require 'batch_api/middleware'
 
 module BatchApi
+
+  # Public: access the main Batch API configuration object.
+  #
+  # Returns a BatchApi::Configuration instance
   def self.config
     @config ||= Configuration.new
   end
+
+  # Public: are we in Rails?  This partly exists just so that you
+  # can stub it in the tests.
+  #
+  # Returns true if Rails is a defined constant, false otherwise.
+  def rails?
+    defined?(Rails)
+  end
 end

data/lib/batch_api/errors/base.rb

@@ -12,7 +12,7 @@ module BatchApi
       # Public: the error details as a hash, which can be returned
       # to clients as JSON.
       def body
-        message = if expose_backtrace?
+        message = if self.class.expose_backtrace?
           {
             message: @error.message,
             backtrace: @error.backtrace
@@ -37,7 +37,7 @@ module BatchApi
 
       # Internal: whether the backtrace should be exposed in the response.
       # Currently Rails-specific, needs to be generalized (to ENV["RACK_ENV"])?
-      def expose_backtrace?
+      def self.expose_backtrace?
         !Rails.env.production?
       end
     end

data/lib/batch_api/operation.rb

@@ -1,74 +1,2 @@
-require 'batch_api/response'
-
-module BatchApi
-  # Public: an individual batch operation.
-  class Operation
-    class MalformedOperationError < ArgumentError; end
-
-    attr_accessor :method, :url, :params, :headers
-    attr_accessor :env, :app, :result
-
-    # Public: create a new Batch Operation given the specifications for a batch
-    # operation (as defined above) and the request environment for the main
-    # batch request.
-    def initialize(op, base_env, app)
-      @op = op
-
-      @method = op["method"]
-      @url = op["url"]
-      @params = op["params"] || {}
-      @headers = op["headers"] || {}
-
-      raise MalformedOperationError,
-        "BatchAPI operation must include method (received #{@method.inspect}) " +
-        "and url (received #{@url.inspect})" unless @method && @url
-
-      @app = app
-      # deep_dup to avoid unwanted changes across requests
-      @env = BatchApi::Utils.deep_dup(base_env)
-    end
-
-    # Execute a batch request, returning a BatchResponse object.  If an error
-    # occurs, it returns the same results as Rails would.
-    def execute
-      process_env
-      begin
-        response = @app.call(@env)
-      rescue => err
-        response = BatchApi::Errors::Operation.new(err).render
-      end
-      BatchApi::Response.new(response)
-    end
-
-    # Internal: customize the request environment.  This is currently done
-    # manually and feels clunky and brittle, but is mostly likely fine, though
-    # there are one or two environment parameters not yet adjusted.
-    def process_env
-      path, qs = @url.split("?")
-
-      # Headers
-      headrs = (@headers || {}).inject({}) do |heads, (k, v)|
-        heads.tap {|h| h["HTTP_" + k.gsub(/\-/, "_").upcase] = v}
-      end
-      # preserve original headers unless explicitly overridden
-      @env.merge!(headrs)
-
-      # method
-      @env["REQUEST_METHOD"] = @method.upcase
-
-      # path and query string
-      @env["REQUEST_URI"] = @env["REQUEST_URI"].gsub(/\/batch.*/, @url)
-      @env["REQUEST_PATH"] = path
-      @env["ORIGINAL_FULLPATH"] = @env["PATH_INFO"] = @url
-
-      @env["rack.request.query_string"] = qs
-      @env["QUERY_STRING"] = qs
-
-      # parameters
-      @env["rack.request.form_hash"] = @params
-      @env["action_dispatch.request.parameters"] = @params
-      @env["action_dispatch.request.request_parameters"] = @params
-      @env["rack.request.query_hash"] = @method == "get" ? @params : nil
-    end
-  end
-end
+require 'batch_api/operation/rack'
+require 'batch_api/operation/rails' if defined?(Rails)

data/lib/batch_api/operation/rack.rb

@@ -0,0 +1,74 @@
+require 'batch_api/response'
+
+module BatchApi
+  # Public: an individual batch operation.
+  module Operation
+    class MalformedOperationError < ArgumentError; end
+
+    class Rack
+      attr_accessor :method, :url, :params, :headers
+      attr_accessor :env, :app, :result
+
+      # Public: create a new Batch Operation given the specifications for a batch
+      # operation (as defined above) and the request environment for the main
+      # batch request.
+      def initialize(op, base_env, app)
+        @op = op
+
+        @method = op["method"]
+        @url = op["url"]
+        @params = op["params"] || {}
+        @headers = op["headers"] || {}
+
+        raise MalformedOperationError,
+          "BatchAPI operation must include method (received #{@method.inspect}) " +
+          "and url (received #{@url.inspect})" unless @method && @url
+
+        @app = app
+        # deep_dup to avoid unwanted changes across requests
+        @env = BatchApi::Utils.deep_dup(base_env)
+      end
+
+      # Execute a batch request, returning a BatchResponse object.  If an error
+      # occurs, it returns the same results as Rails would.
+      def execute
+        process_env
+        begin
+          response = @app.call(@env)
+        rescue => err
+          response = BatchApi::Errors::Operation.new(err).render
+        end
+        BatchApi::Response.new(response)
+      end
+
+      # Internal: customize the request environment.  This is currently done
+      # manually and feels clunky and brittle, but is mostly likely fine, though
+      # there are one or two environment parameters not yet adjusted.
+      def process_env
+        path, qs = @url.split("?")
+
+        # Headers
+        headrs = (@headers || {}).inject({}) do |heads, (k, v)|
+          heads.tap {|h| h["HTTP_" + k.gsub(/\-/, "_").upcase] = v}
+        end
+        # preserve original headers unless explicitly overridden
+        @env.merge!(headrs)
+
+        # method
+        @env["REQUEST_METHOD"] = @method.upcase
+
+        # path and query string
+        @env["REQUEST_URI"] = @env["REQUEST_URI"].gsub(/\/batch.*/, @url)
+        @env["REQUEST_PATH"] = path
+        @env["ORIGINAL_FULLPATH"] = @env["PATH_INFO"] = @url
+
+        @env["rack.request.query_string"] = qs
+        @env["QUERY_STRING"] = qs
+
+        # parameters
+        @env["rack.request.form_hash"] = @params
+        @env["rack.request.query_hash"] = @method == "get" ? @params : nil
+      end
+    end
+  end
+end

data/lib/batch_api/operation/rails.rb

@@ -0,0 +1,42 @@
+require 'batch_api/operation/rack'
+
+module BatchApi
+  # Public: an individual batch operation.
+  module Operation
+    class Rails < Operation::Rack
+      # Public: create a new Rails Operation.  It does all that Rack does
+      # and also some additional Rails-specific processing.
+      def initialize(op, base_env, app)
+        super
+        @params = params_with_path_components
+      end
+
+      # Internal: customize the request environment.  This is currently done
+      # manually and feels clunky and brittle, but is mostly likely fine, though
+      # there are one or two environment parameters not yet adjusted.
+      def process_env
+        # parameters
+        super
+        @env["action_dispatch.request.parameters"] = @params
+        @env["action_dispatch.request.request_parameters"] = @params
+      end
+
+      private
+
+      # Internal: process the params the Rails way, merging in the
+      # path_parameters.  If the route can't be recognized, it will
+      # leave the params unchanged.
+      #
+      # Returns the updated params.
+      def params_with_path_components
+        begin
+          path_params = ::Rails.application.routes.recognize_path(@url, @op)
+          @params.merge(path_params)
+        rescue
+          @params
+        end
+      end
+    end
+  end
+end
+

data/lib/batch_api/processor.rb

@@ -82,11 +82,18 @@ module BatchApi
           "#{ops.length} were provided"
       else
         ops.map do |op|
-          BatchApi::Operation.new(op, @env, @app)
+          self.class.operation_klass.new(op, @env, @app)
         end
       end
     end
 
+    # Internal: which operation class to used.
+    #
+    # Returns Batch::Operation::(Rack|Rails) depending on the environment
+    def self.operation_klass
+      BatchApi.rails? ? Operation::Rails : Operation::Rack
+    end
+
     # Internal: Processes any other provided options for validity.
     # Currently, the :sequential option is REQUIRED (until parallel
     # implementation is created).

data/lib/batch_api/version.rb

@@ -1,3 +1,3 @@
 module BatchApi
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batch_api
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2012-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -121,6 +121,8 @@ files:
 - lib/batch_api/errors/operation.rb
 - lib/batch_api/errors/request.rb
 - lib/batch_api/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.rb
@@ -147,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -456340693841676630
+      hash: 4154907758036208164
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -456340693841676630
+      hash: 4154907758036208164
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21