actionpack-xml_parser 1.0.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97a34add867fdd86962702b26a409d5b174d1c11
-  data.tar.gz: 76ea8609436ceb7b00c7930cfcd0021bfa3be8de
+  metadata.gz: f0609262844b2c3b025b9c737cab49d66b268ed4
+  data.tar.gz: ac3e2d8f0856f975f39ff2ed1287dede5797157d
 SHA512:
-  metadata.gz: 5875755a817de09d059f5dcb3dfa8230161393575d803f89a13f994b1fb17a8a45020286b675901c97d02924cb133da8b7c6d48867836a2f0a5378c8ab622145
-  data.tar.gz: 40ab47784a747175029be1fc3d9f3048cea205b36fa7025067f3bc3e0c8f120303f5f21ecda0dd1608864f26f3c14c594172abb9ac28c1b83d84c153a4ded522
+  metadata.gz: 4c108c4a80675162b37bf5a8e7a9181821a7e9f345b9dc5213ce24bf5ae7c4d4c90e2c047fa3e4046a585e068b964514cf1955d6c2e839607756eae2a6dbe6cd
+  data.tar.gz: 6dc94ce3159e2076171de35b6d5fee3fbe515d51126f1f28dba472ddaeb10bdcfeb4a36b5d93e2e000746fe6cc930d3937101cfc25e4f7c9eca942891cc8033e

data/README.md

@@ -12,16 +12,74 @@ Include this gem into your Gemfile:
 gem 'actionpack-xml_parser'
 ```
 
-Then, add `ActionDispatch::XmlParamsParser` middleware after `ActionDispatch::ParamsParser`
-in `config/application.rb`:
+Parameters parsing rules
+------------------------
+
+The parameters parsing is handled by `ActiveSupport::XMLConverter` so there may
+be specific features and subtle differences depending on the chosen XML backend.
+
+### Hashes
+
+Basically, each node represents a key. With the following XML:
+
+```xml
+<person><name>David</name></person>
+```
+
+The resulting parameters will be:
 
 ```ruby
-config.middleware.insert_after ActionDispatch::ParamsParser, ActionDispatch::XmlParamsParser
+{"person" => {"name" => "David"}}
+```
+
+### File attachment
+
+You can specify the `type` attribute of a node to attach files:
+
+```xml
+<person>
+  <avatar type="file" name="me.jpg" content_type="image/jpg"><!-- File content --></avatar>
+</person>
+```
+
+The resulting parameters will include a `StringIO` object with the given content,
+name and content type set accordingly:
+
+```ruby
+{"person" => {"avatar" => #<StringIO:...>}}
+```
+
+### Arrays
+
+There are several ways to pass an array. You can either specify multiple nodes
+with the same name:
+
+```xml
+<person>
+  <address city="Chicago"/>
+  <address city="Ottawa"/>
+</person>
+```
+
+The resulting parameters will be:
+
+```ruby
+{"person" => {"address" => [{"city" => "Chicago"}, {"city" => "Ottawa"}]}}
+```
+
+You can also specify the `type` attribute of a node and nest child nodes inside:
+
+```xml
+<person>
+  <addresses type="array">
+    <address city="Melbourne"/>
+    <address city="Paris"/>
+  </addresses>
+</person>
 ```
 
-You may need to require the `ActionDispatch::XmlParamsParser` manually. Add the following 
-in your `config/application.rb`:
+will result in:
 
 ```ruby
-require 'action_dispatch/xml_params_parser'
+{"person" => {"addresses" => [{"city" => "Melbourne"}, {"city" => "Paris"}]}}
 ```

data/lib/action_pack/xml_parser.rb

@@ -0,0 +1,18 @@
+require 'active_support'
+require 'active_support/core_ext/hash/conversions'
+require 'action_dispatch'
+require 'action_dispatch/http/request'
+require 'action_pack/xml_parser/version'
+
+module ActionPack
+  class XmlParser
+    def self.register
+      original_parsers = ActionDispatch::Request.parameter_parsers
+      ActionDispatch::Request.parameter_parsers = original_parsers.merge(Mime[:xml].symbol => self)
+    end
+
+    def self.call(raw_post)
+      Hash.from_xml(raw_post) || {}
+    end
+  end
+end

data/lib/action_pack/xml_parser/railtie.rb

@@ -0,0 +1,11 @@
+require 'action_pack/xml_parser'
+
+module ActionPack
+  class XmlParser
+    class Railtie < ::Rails::Railtie
+      initializer "actionpack-xml_parser.configure" do
+        ActionPack::XmlParser.register
+      end
+    end
+  end
+end

data/lib/action_pack/xml_parser/version.rb

@@ -0,0 +1,5 @@
+module ActionPack
+  class XmlParser
+    VERSION = "2.0.1"
+  end
+end

data/lib/actionpack-xml_parser.rb

@@ -0,0 +1 @@
+require 'action_pack/xml_parser/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionpack-xml_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.1
 platform: ruby
 authors:
 - Prem Sichanugrist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,20 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,8 +61,10 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
-- lib/action_dispatch/xml_params_parser.rb
-- lib/actionpack/xml_parser.rb
+- lib/action_pack/xml_parser.rb
+- lib/action_pack/xml_parser/railtie.rb
+- lib/action_pack/xml_parser/version.rb
+- lib/actionpack-xml_parser.rb
 homepage: http://www.rubyonrails.org
 licenses:
 - MIT
@@ -69,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -77,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: XML parameters parser for Action Pack (removed from core in Rails 4.0)

data/lib/action_dispatch/xml_params_parser.rb

@@ -1,54 +0,0 @@
-require 'active_support/core_ext/hash/conversions'
-require 'action_dispatch/http/request'
-require 'active_support/core_ext/hash/indifferent_access'
-
-module ActionDispatch
-  class XmlParamsParser
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      if params = parse_formatted_parameters(env)
-        env["action_dispatch.request.request_parameters"] = params
-      end
-
-      @app.call(env)
-    end
-
-    private
-      def parse_formatted_parameters(env)
-        request = Request.new(env)
-
-        return false if request.content_length.zero?
-
-        mime_type = content_type_from_legacy_post_data_format_header(env) ||
-          request.content_mime_type
-
-        if mime_type == Mime::XML
-          # Rails 4.1 moved #deep_munge out of the request and into ActionDispatch::Request::Utils
-          munger = defined?(Request::Utils) ? Request::Utils : request
-
-          data = munger.deep_munge(Hash.from_xml(request.body.read) || {})
-          request.body.rewind if request.body.respond_to?(:rewind)
-          data.with_indifferent_access
-        else
-          false
-        end
-      rescue Exception => e # XML code block errors
-        logger(env).debug "Error occurred while parsing request parameters.\nContents:\n\n#{request.raw_post}"
-
-        raise ActionDispatch::ParamsParser::ParseError.new(e.message, e)
-      end
-
-      def content_type_from_legacy_post_data_format_header(env)
-        if env['HTTP_X_POST_DATA_FORMAT'].to_s.downcase == 'xml'
-          Mime::XML
-        end
-      end
-
-      def logger(env)
-        env['action_dispatch.logger'] || ActiveSupport::Logger.new($stderr)
-      end
-  end
-end

data/lib/actionpack/xml_parser.rb

@@ -1 +0,0 @@
-require 'action_dispatch/xml_params_parser'