faraday-xml 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777d8a0d7887223960c5ec14c5be37e7ceb50a8c7cd0abf33a070330f8c57a6d
-  data.tar.gz: de298ca9f99ff381b232996351d33bcbc72ff8343d3ee8f8ab24cfdaf0f15c32
+  metadata.gz: fd31db052ce943d7b8f60e8396449da83c134b70f3fe59f52e105edf1105f20d
+  data.tar.gz: 80348c82aa221ff79dbb488bf11b7df6adecbb877887165899a6d057197bc12d
 SHA512:
-  metadata.gz: 1933ead1a4cf3a3de25e773c2e3787df00962ae2039a0182051b2dea3fee6abe029901ca3129b66fdf23129f65b309731061a8f3cd2af860e6c134e24e3dfe69
-  data.tar.gz: 8dd8bcb901bbdcede8df0e077ffc20a1db75d2b9cb78cc973b9a5dbcb26ccd64b7721792c4ee91f2cda4753402a633e32fe16cd7706b15de584e697f0bdd0735
+  metadata.gz: 33acfe362ff340f1e39f40a1610c77b98ccd89d7b0e107625fd2d7fc4ef08ed52c34166a3903cdb64514f5861a7420d181495355572d772be0b697870fb5986f
+  data.tar.gz: 347b1ab466889029e44fb4cba75d5845bcf959544154d4fc8cb653a2988397f8a7edb19e4e7115d77594e83962ac07a017c0ab15f8fba76339fc3124b6676b23

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
-## Unreleased
+## [Unreleased](https://github.com/gemhome/faraday-xml/compare/v0.2.0...main)
 
-*   Initial release.
+## [0.2.0](https://github.com/gemhome/faraday-xml/compare/v0.1.0...v0.2.0)
+
+*   feat: simple Hash -> XML request encoder
+
+## [0.1.0](https://github.com/gemhome/faraday-xml/blob/v0.1.0) (2023-01-12)
+
+*   feat: Initial release.

data/README.md

@@ -29,9 +29,19 @@ gem install faraday-xml
 ## Usage
 
 ```ruby
+require 'faraday'
 require 'faraday/xml'
 
-# TODO
+conn = Faraday.new do |builder|
+  builder.headers.update(
+    "Accept" => "application/xml",
+    "Content-Type" => "application/xml;charset=UTF-8",
+  )
+  # or builder.use Faraday::XML::Request
+  builder.request :xml # encode Hash as XML
+  # or builder.use Faraday::XML::Response
+  builder.response :xml # decode response bodies from XML
+end
 ```
 
 ## Development

data/lib/faraday/xml/request.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Faraday
+  module XML
+    # Request middleware that encodes the body as XML.
+    #
+    # Processes only requests with matching Content-type or those without a type.
+    # If a request doesn't have a type but has a body, it sets the Content-type
+    # to XML MIME-type.
+    #
+    # Doesn't try to encode bodies that already are in string form.
+    class Request < Middleware # rubocop:disable Metrics/ClassLength
+      MIME_TYPE = 'application/xml'
+      MIME_TYPE_REGEX = %r{^application/(vnd\..+\+)?xml$}.freeze
+
+      def initialize(app = nil, options = {})
+        super(app)
+        @encoder_options = options.fetch(:encoder_options, {})
+      end
+
+      def on_request(env)
+        match_content_type(env) do |data|
+          env[:body] = encode(data)
+        end
+      end
+
+      def encoder
+        @encoder ||= nil
+        if @encoder.nil?
+          @encoder = set_encoder
+          @encoder && test_encoder
+        end
+        @encoder or raise 'Missing dependencies Builder'
+      end
+
+      private
+
+      def encode(data)
+        encoder.call(data)
+      end
+
+      def test_encoder
+        encode({ success: true })
+      end
+
+      def set_encoder
+        @encoder ||= # rubocop:disable Naming/MemoizedInstanceVariableName
+          begin
+            require 'builder'
+            lambda do |parameter_hash|
+              parameters_as_xml(parameter_hash)
+            end
+          rescue LoadError # rubocop:disable Lint/SuppressedException
+          end
+      end
+
+      def match_content_type(env)
+        return unless process_request?(env)
+
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        yield env[:body] unless env[:body].respond_to?(:to_str)
+      end
+
+      def process_request?(env)
+        type = request_type(env)
+        body?(env) && (type.empty? || type.match?(MIME_TYPE_REGEX))
+      end
+
+      def body?(env)
+        (body = env[:body]) && !(body.respond_to?(:to_str) && body.empty?)
+      end
+
+      def request_type(env)
+        type = env[:request_headers][CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+
+      def parameters_as_xml(parameter_hash) # rubocop:disable Metrics/MethodLength
+        xml_markup = build_xml_markup(skip_instruct: true)
+        parameter_hash.each_pair do |key, value|
+          key = key.to_s
+          if _parameter_as_xml?(value)
+            xml_markup.tag!(key) do
+              xml = _parameter_as_xml(value)
+              xml_markup << xml
+            end
+          else
+            xml_markup.tag!(key, _parameter_as_xml(value))
+          end
+        end
+        xml_markup.target!
+      end
+
+      def _parameter_as_xml?(value)
+        case value
+        when Hash, Array then true
+        else false
+        end
+      end
+
+      def _parameter_as_xml(value)
+        case value
+        when Hash
+          parameters_as_xml(value) # recursive case
+        when Array
+          _parameter_as_list_xml(value) # recursive case
+        else
+          value.to_s.encode(xml: :text) # end case
+        end
+      end
+
+      def _parameter_as_list_xml(array_of_hashes)
+        xml_markup = build_xml_markup(skip_instruct: true)
+        array_of_hashes.each do |value|
+          xml_markup << parameters_as_xml(value) # recursive case
+        end
+        xml_markup.target!
+      end
+
+      def build_xml_markup(**options)
+        # https://github.com/rails/rails/blob/86fd8d0143b1a0578b359f4b86fea94c718139ae/activesupport/lib/active_support/builder.rb
+        # https://github.com/rails/rails/blob/86fd8d0143b1a0578b359f4b86fea94c718139ae/activesupport/lib/active_support/core_ext/hash/conversions.rb
+        require 'builder'
+        options.merge!(@encoder_options)
+        options[:indent] = 2 unless options.key?(:indent)
+        xml_markup = ::Builder::XmlMarkup.new(**options)
+        if !options.delete(:skip_instruct) # rubocop:disable Style/NegatedIf
+          xml_markup.instruct! :xml, version: '1.0', encoding: 'UTF-8'
+        end
+        xml_markup
+      end
+    end
+  end
+end

data/lib/faraday/xml/response.rb

@@ -4,11 +4,11 @@ module Faraday
   module XML
     # Parse response bodies as XML
     class Response < Faraday::Middleware
-      def initialize(app = nil, parser_options: nil, content_type: /\bxml$/, preserve_raw: false)
+      def initialize(app = nil, options = {})
         super(app)
-        @parser_options = parser_options
-        @content_types = Array(content_type)
-        @preserve_raw = preserve_raw
+        @parser_options = options[:parser_options]
+        @content_types = Array(options.fetch(:content_type, /\bxml$/))
+        @preserve_raw = options.fetch(:preserve_raw, false)
       end
 
       # @param env [Faraday::Env] the environment of the response being processed.
@@ -16,6 +16,15 @@ module Faraday
         process_response(env) if parse_response?(env)
       end
 
+      def parser
+        @parser ||= nil
+        if @parser.nil?
+          @parser = set_parser
+          @parser && test_parser
+        end
+        @parser or raise 'Missing dependencies ActiveSupport::XmlMini or MultiXml'
+      end
+
       private
 
       def process_response(env)
@@ -32,19 +41,10 @@ module Faraday
       end
 
       def test_parser
-        parse("<success>true</success>")
+        parse('<success>true</success>')
       end
 
-      def parser # rubocop:disable Metrics/MethodLength
-        @parser ||= nil
-        if @parser.nil?
-          @parser = set_parser
-          @parser && test_parser
-        end
-        @parser or raise 'Missing dependencies ActiveSupport::XmlMini or MultiXml'
-      end
-
-      def set_parser
+      def set_parser # rubocop:disable Metrics/MethodLength
         @parser ||=
           begin
             require 'multi_xml'
@@ -53,10 +53,9 @@ module Faraday
             end
           rescue LoadError # rubocop:disable Lint/SuppressedException
           end
-        @parser ||=
+        @parser ||= # rubocop:disable Naming/MemoizedInstanceVariableName
           begin
             require 'active_support'
-            # require 'active_support/isolated_execution_state'
             require 'active_support/xml_mini'
             require 'active_support/core_ext/hash/conversions'
             require 'active_support/core_ext/array/conversions'

data/lib/faraday/xml/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module XML
-    VERSION = '0.0.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/faraday/xml.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'xml/request'
 require_relative 'xml/response'
 require_relative 'xml/version'
 
@@ -7,7 +8,12 @@ module Faraday
   # The Faraday::XML middleware main module
   module XML
     # Load middleware with
-    #   conn.response Faraday::XML::Response
+    #   conn.use Faraday::XML::Request
+    #   or
+    #   conn.request :xml
+    Faraday::Request.register_middleware(xml: Faraday::XML::Request)
+    # Load middleware with
+    #   conn.use Faraday::XML::Response
     #   or
     #   conn.response :xml
     Faraday::Response.register_middleware(xml: Faraday::XML::Response)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-xml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Benjamin Fleischer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -155,6 +155,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/faraday/xml.rb
+- lib/faraday/xml/request.rb
 - lib/faraday/xml/response.rb
 - lib/faraday/xml/version.rb
 homepage: https://github.com/gemhome/faraday-xml
@@ -162,8 +163,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/gemhome/faraday-xml/issues
-  changelog_uri: https://github.com/gemhome/faraday-xml/blob/v0.0.1/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-xml/0.0.1
+  changelog_uri: https://github.com/gemhome/faraday-xml/blob/v0.2.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-xml/0.2.0
   homepage_uri: https://github.com/gemhome/faraday-xml
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/gemhome/faraday-xml