faraday-xml 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d4bf34c7cdf9c459325cce7cc6c4571057eafa9d9d0f3937badf593a7edf4e0
-  data.tar.gz: 905237976614eba95b0a5ff2a5089c537ecc2d6f27c18e23a622e81d30ab7dba
+  metadata.gz: '04786b19e7983cba95b256a974cc0624c69e693ddb64b40e7d7a40753691d779'
+  data.tar.gz: 0207e10a74a4130183379db1c99470c63b332b7c489103fb4d0efb47685dc0f7
 SHA512:
-  metadata.gz: a15dc8568124039c2297460033ab55447197358977523a2245d1e1470f44d0ce1f9602ff0998c8cb3f63a77c64bebf70ad3b20d5c8f956b0ffb32e270d175e15
-  data.tar.gz: 5805e36c1f2418ad1428eae2c1129feb54734fa321b0f5cbcc2e8cd34c2327f9a4189ec7888e6de3b031bbac353023f7749525a5772e5f265f3ed94d71d7f555
+  metadata.gz: ee0a896484ea4884d05f192df27800017fe255dfe19357dcaf1d5799e36e8e436eeeacf4a7c9a7bc734b4208e7a93e57572fc2913f91703ba93846f1d590456c
+  data.tar.gz: fe11c2aacb78691b099b295424e749572ebdb67881cec6abbf0546dbdaf598eb8fd1397a83e83ce029cac880b3e20001005a8044f84fd1243e279acaf1ed9f70

data/CHANGELOG.md

@@ -1,7 +1,16 @@
 # Changelog
 
-## [Unreleased](https://github.com/gemhome/faraday-xml/compare/v0.1.0...main)
+## [Unreleased](https://github.com/gemhome/faraday-xml/compare/v0.2.1...main)
+
+## [0.2.1](https://github.com/gemhome/faraday-xml/compare/v0.2.0...v0.2.1)
+
+*   feat: extract Faraday::XML::Encoder
+*   feat: extract Faraday::XML::Parser
+
+## [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)
 
-*   Initial release.
+*   feat: Initial release.

data/README.md

@@ -37,12 +37,28 @@ conn = Faraday.new do |builder|
     "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
 ```
 
+There is also basic support for first class XML encoding/parsing
+
+```ruby
+require 'faraday'
+require 'faraday/xml'
+hash = { 'user' => { 'name' => 'Erik Michaels-Ober', 'screen_name' => 'sferik' } }
+xml = '<user><name>Erik Michaels-Ober</name><screen_name>sferik</screen_name></user>'
+
+encoder = Faraday::XML::Encoder.build!(indent: 0)
+encoder.encode(hash) == xml
+
+parser = Faraday::XML::Parser.build!
+parser.parse(xml) == hash
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/faraday/xml/encoder.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Faraday
+  module XML
+    # Utility fucntion that encodes input as XML.
+    #
+    # Doesn't try to encode input which already are in string form.
+    class Encoder
+      def self.build!(encoder_options = {})
+        encoder = new(encoder_options)
+        encoder.encoder!
+        encoder
+      end
+
+      def initialize(encoder_options = {})
+        @encoder_options = encoder_options || {}
+      end
+
+      def encode(data)
+        encoder.call(data)
+      end
+
+      def encoder
+        @encoder ||= nil
+        if @encoder.nil?
+          @encoder = set_encoder
+          @encoder && test_encoder
+        end
+        @encoder or raise 'Missing dependencies Builder'
+      end
+      alias encoder! encoder
+
+      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 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/parser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Faraday
+  module XML
+    # Utility fucntion that parses XML input.
+    class Parser
+      def self.build!
+        parser = new
+        parser.parser!
+        parser
+      end
+
+      def parse(xml, parser_options = {})
+        parser.call(xml, parser_options)
+      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
+      alias parser! parser
+
+      def test_parser
+        parse('<success>true</success>')
+      end
+
+      def set_parser # rubocop:disable Metrics/MethodLength
+        @parser ||=
+          begin
+            require 'multi_xml'
+            lambda do |xml, options|
+              ::MultiXml.parse(xml, options)
+            end
+          rescue LoadError # rubocop:disable Lint/SuppressedException
+          end
+        @parser ||= # rubocop:disable Naming/MemoizedInstanceVariableName
+          begin
+            require 'active_support'
+            require 'active_support/xml_mini'
+            require 'active_support/core_ext/hash/conversions'
+            require 'active_support/core_ext/array/conversions'
+            lambda do |xml, options|
+              disallowed_types = options[:disallowed_types]
+              Hash.from_xml(xml, disallowed_types)
+            end
+          rescue LoadError # rubocop:disable Lint/SuppressedException
+          end
+      end
+    end
+  end
+end

data/lib/faraday/xml/request.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'encoder'
+
+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
+      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] = encoder.encode(data)
+        end
+      end
+
+      def encoder
+        @encoder ||= Encoder.build!(@encoder_options)
+      end
+
+      private
+
+      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
+    end
+  end
+end

data/lib/faraday/xml/response.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'parser'
+
 module Faraday
   module XML
     # Parse response bodies as XML
@@ -10,7 +12,6 @@ module Faraday
         @content_types = Array(options.fetch(:content_type, /\bxml$/))
         @preserve_raw = options.fetch(:preserve_raw, false)
       end
-      ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
 
       # @param env [Faraday::Env] the environment of the response being processed.
       def on_complete(env)
@@ -18,12 +19,7 @@ module Faraday
       end
 
       def parser
-        @parser ||= nil
-        if @parser.nil?
-          @parser = set_parser
-          @parser && test_parser
-        end
-        @parser or raise 'Missing dependencies ActiveSupport::XmlMini or MultiXml'
+        @parser ||= Parser.build!
       end
 
       private
@@ -38,34 +34,7 @@ module Faraday
       def parse(body)
         return nil if body.strip.empty?
 
-        parser.call(body, @parser_options || {})
-      end
-
-      def test_parser
-        parse('<success>true</success>')
-      end
-
-      def set_parser # rubocop:disable Metrics/MethodLength
-        @parser ||=
-          begin
-            require 'multi_xml'
-            lambda do |xml, options|
-              ::MultiXml.parse(xml, options)
-            end
-          rescue LoadError # rubocop:disable Lint/SuppressedException
-          end
-        @parser ||= # rubocop:disable Naming/MemoizedInstanceVariableName
-          begin
-            require 'active_support'
-            require 'active_support/xml_mini'
-            require 'active_support/core_ext/hash/conversions'
-            require 'active_support/core_ext/array/conversions'
-            lambda do |xml, options|
-              disallowed_types = options[:disallowed_types]
-              Hash.from_xml(xml, disallowed_types)
-            end
-          rescue LoadError # rubocop:disable Lint/SuppressedException
-          end
+        parser.parse(body, @parser_options || {})
       end
 
       def parse_response?(env)

data/lib/faraday/xml/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module XML
-    VERSION = '0.1.0'
+    VERSION = '0.2.1'
   end
 end

data/lib/faraday/xml.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'xml/request'
 require_relative 'xml/response'
 require_relative 'xml/version'
 
 module Faraday
   # The Faraday::XML middleware main module
   module XML
+    # Load middleware with
+    #   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-xml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Benjamin Fleischer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -155,6 +155,9 @@ files:
 - LICENSE.md
 - README.md
 - lib/faraday/xml.rb
+- lib/faraday/xml/encoder.rb
+- lib/faraday/xml/parser.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 +165,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/gemhome/faraday-xml/issues
-  changelog_uri: https://github.com/gemhome/faraday-xml/blob/v0.1.0/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-xml/0.1.0
+  changelog_uri: https://github.com/gemhome/faraday-xml/blob/v0.2.1/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-xml/0.2.1
   homepage_uri: https://github.com/gemhome/faraday-xml
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/gemhome/faraday-xml