faraday-xml 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777d8a0d7887223960c5ec14c5be37e7ceb50a8c7cd0abf33a070330f8c57a6d
-  data.tar.gz: de298ca9f99ff381b232996351d33bcbc72ff8343d3ee8f8ab24cfdaf0f15c32
+  metadata.gz: 6d4bf34c7cdf9c459325cce7cc6c4571057eafa9d9d0f3937badf593a7edf4e0
+  data.tar.gz: 905237976614eba95b0a5ff2a5089c537ecc2d6f27c18e23a622e81d30ab7dba
 SHA512:
-  metadata.gz: 1933ead1a4cf3a3de25e773c2e3787df00962ae2039a0182051b2dea3fee6abe029901ca3129b66fdf23129f65b309731061a8f3cd2af860e6c134e24e3dfe69
-  data.tar.gz: 8dd8bcb901bbdcede8df0e077ffc20a1db75d2b9cb78cc973b9a5dbcb26ccd64b7721792c4ee91f2cda4753402a633e32fe16cd7706b15de584e697f0bdd0735
+  metadata.gz: a15dc8568124039c2297460033ab55447197358977523a2245d1e1470f44d0ce1f9602ff0998c8cb3f63a77c64bebf70ad3b20d5c8f956b0ffb32e270d175e15
+  data.tar.gz: 5805e36c1f2418ad1428eae2c1129feb54734fa321b0f5cbcc2e8cd34c2327f9a4189ec7888e6de3b031bbac353023f7749525a5772e5f265f3ed94d71d7f555

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
-## Unreleased
+## [Unreleased](https://github.com/gemhome/faraday-xml/compare/v0.1.0...main)
+
+## [0.1.0](https://github.com/gemhome/faraday-xml/blob/v0.1.0) (2023-01-12)
 
 *   Initial release.

data/README.md

@@ -29,9 +29,18 @@ 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::Response
+  builder.response :xml # decode response bodies from XML
+end
 ```
 
 ## Development

data/lib/faraday/xml/response.rb

@@ -4,18 +4,28 @@ 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
+      ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
 
       # @param env [Faraday::Env] the environment of the response being processed.
       def on_complete(env)
         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 +42,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 +54,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.1.0'
   end
 end

data/lib/faraday/xml.rb

@@ -7,7 +7,7 @@ module Faraday
   # The Faraday::XML middleware main module
   module XML
     # Load middleware with
-    #   conn.response Faraday::XML::Response
+    #   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.1.0
 platform: ruby
 authors:
 - Benjamin Fleischer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -162,8 +162,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.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-xml/0.1.0
   homepage_uri: https://github.com/gemhome/faraday-xml
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/gemhome/faraday-xml