vayacondios-server 0.2.6 → 0.2.7

data/app/http_shim.rb

@@ -4,22 +4,41 @@ require 'gorillib/logger/log'
 require 'vayacondios-server'
 
 class HttpShim < Goliath::API
+  use Goliath::Rack::Heartbeat                                           # respond to /status with 200, OK (monitoring, etc)
+  use Vayacondios::Rack::JSONize
   use Goliath::Rack::Tracer, 'X-Tracer'                                  # log trace statistics
-  use Goliath::Rack::Params                                              # parse query string and message body into params hash
+  use Vayacondios::Rack::Params                                          # parse query string and message body into params hash
+#  use Goliath::Rack::Params                                              # parse query string and message body into params hash
   use Goliath::Rack::Validation::RequestMethod, %w[GET PUT PATCH DELETE] # only allow these methods
   use Vayacondios::Rack::ExtractMethods                                  # interpolate GET, PUT into :create, :update, etc
   use Vayacondios::Rack::Path                                            # parse path into parameterized pieces
   use Vayacondios::Rack::PathValidation                                  # validate the existence of env[:vayacondios_path]
   use Goliath::Rack::Formatters::JSON                                    # JSON output formatter
   use Goliath::Rack::Render                                              # auto-negotiate response format
-  use Goliath::Rack::Heartbeat                                           # respond to /status with 200, OK (monitoring, etc)
+
+  # The document part of the request, e.g. - params that came
+  # directly from its body.
+  #
+  # Something somewhere in Rack is unhappy when receiving
+  # non-Hash-like records via a JSON-formatted request body. So that
+  # Vayacondios::Rack::Params takes a non-Hash-like request body and
+  # turns it into a Hash with a single key: _document.
+  #
+  # This hack does **not** affect the client-side: clients can still
+  # send non-Hash-like JSON documents and they will be interpreted
+  # as intended.
+  #
+  # @return [Hash,Array,String,Fixnum,nil] any native JSON datatype
+  def document
+    params['_document'] || params
+  end
 
   def response(env)
     path_params = env[:vayacondios_path]
     klass = ('vayacondios/' + path_params[:type] + '_handler').camelize.constantize
 
     Log.info("received request #{env['REQUEST_METHOD']} #{env['REQUEST_URI']}")
-    Log.info("params: #{env['params']}")
+    Log.info("params: #{document}")
 
     begin
       case env[:vayacondios_method]
@@ -29,15 +48,15 @@ class HttpShim < Goliath::API
         [200, {}, MultiJson.dump(record.body)]
 
       when :update
-        record = klass.new(mongo).update(env['params'], path_params)
+        record = klass.new(mongo).update(document, path_params)
         [200, {}, nil]
         
       when :patch
-        record = klass.new(mongo).patch(env['params'], path_params)
+        record = klass.new(mongo).patch(document, path_params)
         [200, {}, nil]
 
       when :delete
-        record = klass.find(mongo, path_params).destroy(env['params'])
+        record = klass.find(mongo, path_params).destroy(document)
         [200, {}, MultiJson.dump(record.body)]
       end
     rescue Vayacondios::Error::NotFound => ex

data/config/vayacondios.example.yaml

@@ -4,4 +4,4 @@ mongo:
   database:     vayacondios_dev
 
 vayacondios:
-  legacy: true
+  legacy: false

data/config/vayacondios.yaml

@@ -4,4 +4,4 @@ mongo:
   database:     vayacondios_dev
 
 vayacondios:
-  legacy: true
+  legacy: false

data/lib/vayacondios-server.rb

@@ -22,7 +22,8 @@ require 'vayacondios/server/handlers/config_handler'
 require 'vayacondios/server/handlers/event_handler'
 require 'vayacondios/server/handlers/itemset_handler'
 
-require 'vayacondios/server/rack/assume_json'
 require 'vayacondios/server/rack/extract_methods'
+require 'vayacondios/server/rack/params'
+require 'vayacondios/server/rack/jsonize'
 require 'vayacondios/server/rack/path'
 require 'vayacondios/server/rack/path_validation'

data/lib/vayacondios/client/legacy_switch.rb

@@ -8,18 +8,14 @@ class Vayacondios
     def wrap_contents(contents) {contents: contents} end
     def extract_contents(document) document['contents'] end
     def extract_response(document) document['contents'] end
-    def proper_request(document)
-      document.is_a? Hash and document.fetch('_json', {}).is_a? Hash
-    end
+    def proper_request(document) true end
   end
 
   class LegacyContentsHandler
     def wrap_contents(contents) contents end
-    def extract_contents(document) document.fetch('_json', {}) end
+    def extract_contents(document) document end
     def extract_response(document) document end
-    def proper_request(document)
-      document.is_a? Array or document.fetch('_json', {}).is_a? Array
-    end
+    def proper_request(document) true end
   end
 
   @@legacy_switch = nil

data/lib/vayacondios/legacy_switch.rb

@@ -8,18 +8,14 @@ class Vayacondios
     def wrap_contents(contents) {contents: contents} end
     def extract_contents(document) document['contents'] end
     def extract_response(document) document['contents'] end
-    def proper_request(document)
-      document.is_a? Hash and document.fetch('_json', {}).is_a? Hash
-    end
+    def proper_request(document) true end
   end
 
   class LegacyContentsHandler
     def wrap_contents(contents) contents end
-    def extract_contents(document) document.fetch('_json', {}) end
+    def extract_contents(document) document end
     def extract_response(document) document end
-    def proper_request(document)
-      document.is_a? Array or document.fetch('_json', {}).is_a? Array
-    end
+    def proper_request(document) true end
   end
 
   @@legacy_switch = nil

data/lib/vayacondios/server/legacy_switch.rb

@@ -8,18 +8,14 @@ class Vayacondios
     def wrap_contents(contents) {contents: contents} end
     def extract_contents(document) document['contents'] end
     def extract_response(document) document['contents'] end
-    def proper_request(document)
-      document.is_a? Hash and document.fetch('_json', {}).is_a? Hash
-    end
+    def proper_request(document) true end
   end
 
   class LegacyContentsHandler
     def wrap_contents(contents) contents end
-    def extract_contents(document) document.fetch('_json', {}) end
+    def extract_contents(document) document end
     def extract_response(document) document end
-    def proper_request(document)
-      document.is_a? Array or document.fetch('_json', {}).is_a? Array
-    end
+    def proper_request(document) true end
   end
 
   @@legacy_switch = nil

data/lib/vayacondios/server/rack/jsonize.rb

@@ -0,0 +1,39 @@
+class Vayacondios
+  module Rack
+
+    # Sets the `Content-Type` of the request and response to
+    # `application/json`.
+    class JSONize
+      include Goliath::Rack::AsyncMiddleware
+
+      # Sets the `Content-Type` header to `application/json` so
+      # downstream parameter parsing will work correctly.
+      #
+      # @param [Hash] env the request environment
+      def call(env)
+        env.logger.debug("Started #{env[Goliath::Request::REQUEST_METHOD]} \"#{env[Goliath::Request::REQUEST_PATH]}\" for #{env[Goliath::Request::REMOTE_ADDR]} as JSON")
+        env['CONTENT_TYPE'] = 'application/json'
+        super(env)
+      end
+
+      # Sets the `Content-Type` header to `application/json` and
+      # serializes the response body to a JSON string.
+      #
+      # Will *not* do this if the request was sent to `/status` which
+      # is expected to just return the string `OK`.
+      #
+      # @param [Hash] env the request environment
+      # @param [Integer] status the HTTP status code of the response
+      # @param [Hash] headers the HTTP headers of the response
+      # @param [Object] body the upstream response body
+      # @return [Array] the response
+      def post_process(env, status, headers, body)
+        return [status, headers, body] if env["REQUEST_PATH"] == '/status'
+        headers['Content-Type'] = 'application/json'
+        body                    = [MultiJson.encode(body) + "\n"]
+        [status, headers, body]
+      end
+      
+    end
+  end
+end

data/lib/vayacondios/server/rack/params.rb

@@ -0,0 +1,50 @@
+class Vayacondios
+  module Rack
+
+    # Parses parameters in the request.
+    #
+    # Will parse parameters from the query string as well as from the
+    # request body.
+    #
+    # Rack gets unhappy when the parameters are anything other than a
+    # Hash but we want clients to be able to send non-Hash-like
+    # request bodies.  To support this case, the request's params are
+    # stored into the `_document` key of the params, to be fetched
+    # later by Vayacondios::HttpServer#document.
+    class Params < Goliath::Rack::Params
+
+      # Parses the parameters of the request.
+      #
+      # @param [Hash] env the request environment
+      def retrieve_params(env)
+        params = {}
+        params.merge!(::Rack::Utils.parse_nested_query(env['QUERY_STRING']))
+
+        if env['rack.input']
+          post_params = ::Rack::Utils::Multipart.parse_multipart(env)
+          unless post_params
+            body = env['rack.input'].read
+            return params if body.empty?
+            env['rack.input'].rewind
+
+            post_params = case(env['CONTENT_TYPE'])
+                          when Goliath::Rack::URL_ENCODED then
+                            ::Rack::Utils.parse_nested_query(body)
+                          when Goliath::Rack::JSON_ENCODED then
+                            MultiJson.decode(body)
+                          else
+                            {}
+                          end
+            if post_params.is_a?(Hash)
+              params.merge!(post_params)
+            else
+              params['_document'] = post_params
+            end
+          end
+        end
+        params
+      end
+      
+    end
+  end
+end

data/lib/vayacondios/version.rb

@@ -1,3 +1,3 @@
 class Vayacondios
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

data/pom.xml

@@ -4,14 +4,14 @@
   <groupId>com.infochimps</groupId>
   <artifactId>vayacondios</artifactId>
   <packaging>jar</packaging>
-<!-- ICSVERS --><version>1.6.2-SNAPSHOT</version>
+<!-- ICSVERS --><version>1.7.0-SNAPSHOT</version>
   <name>java-common</name>
   <url>http://maven.apache.org</url>
 
   <parent>
     <groupId>com.infochimps</groupId>
     <artifactId>parent-pom</artifactId>
-<!-- ICSVERS --><version>1.6.2-SNAPSHOT</version>
+<!-- ICSVERS --><version>1.7.0-SNAPSHOT</version>
     <relativePath></relativePath>
   </parent>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vayacondios-server
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configliere
@@ -222,8 +222,9 @@ files:
 - lib/vayacondios/server/model/document.rb
 - lib/vayacondios/server/model/event_document.rb
 - lib/vayacondios/server/model/itemset_document.rb
-- lib/vayacondios/server/rack/assume_json.rb
 - lib/vayacondios/server/rack/extract_methods.rb
+- lib/vayacondios/server/rack/jsonize.rb
+- lib/vayacondios/server/rack/params.rb
 - lib/vayacondios/server/rack/path.rb
 - lib/vayacondios/server/rack/path_validation.rb
 - lib/vayacondios/version.rb
@@ -279,7 +280,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2406222611066502190
+      hash: 1685170955492084086
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -288,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2406222611066502190
+      hash: 1685170955492084086
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/lib/vayacondios/server/rack/assume_json.rb

@@ -1,13 +0,0 @@
-class Vayacondios
-  module Rack
-    class AssumeJSON
-      include Goliath::Rack::AsyncMiddleware
-      
-      def call(env)
-        env['CONTENT_TYPE'] =
-          'application/json' unless env.has_key? 'CONTENT_TYPE'
-        super env
-      end
-    end
-  end
-end