faraday-decode_xml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f3cdd8b85bd65538e376adc19b33cc4bc050d06e8433a5591db529ca7400031
+  data.tar.gz: d6103409bf9c1c364529cd4e9eb9c52e9e9328433f78b5f343c4d642043ed94a
+SHA512:
+  metadata.gz: 97cf6349802faa8f89bf2d305efc396bf0be3778e3b02fd75f70404d536d59bc5ed7f9a0b0c7eb448d3a6c0ccab5e7e1def944ec1004ffd2c25d17d1f7febb68
+  data.tar.gz: bcef664a14c72703d4c6c0dd6207193069b8a5adb9b90f25b310545e5fe86d25b7199f486d6adf0aad9aa252397fc692287b2f9b473e63c0d6a6e3feec90100f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+*   Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Spencer Oberstadt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Faraday Decode XML
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/soberstadt/faraday-decode_xml/ci)](https://github.com/soberstadt/faraday-decode_xml/actions?query=branch%3Amain)
+[![Gem](https://img.shields.io/gem/v/faraday-decode_xml.svg?style=flat-square)](https://rubygems.org/gems/faraday-decode_xml)
+[![License](https://img.shields.io/github/license/soberstadt/faraday-decode_xml.svg?style=flat-square)](LICENSE.md)
+
+Faraday middleware for decoding XML requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-decode_xml'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-decode_xml
+```
+
+## Usage
+
+```ruby
+require 'faraday/decode_xml'
+
+Faraday.new do |faraday|
+  faraday.response :xml
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bin/test` to run the tests.
+
+To install this gem onto your local machine, run `rake build`.
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
+See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/soberstadt/faraday-decode_xml).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/decode_xml/middleware.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'multi_xml'
+
+module Faraday
+  module DecodeXML
+    # Faraday middleware for decoding XML requests.
+    class Middleware < Faraday::Middleware
+      # @param env [Faraday::Env] the environment of the response being processed.
+      def on_complete(env)
+        process_response(env) if process_response_type?(response_type(env)) && parse_response?(env)
+      end
+
+      private
+
+      def process_response(env)
+        env.body = parse(env.body)
+      rescue Faraday::ParsingError => e
+        raise Faraday::ParsingError.new(e.wrapped_exception, env[:response])
+      end
+
+      def parse(body)
+        ::MultiXml.parse(body, {})
+      rescue StandardError, SyntaxError => e
+        raise e if e.is_a?(SyntaxError)
+
+        raise Faraday::ParsingError, e
+      end
+
+      def response_type(env)
+        env.response_headers['Content-Type'].to_s.split(';', 2).first
+      end
+
+      def process_response_type?(type)
+        type == 'application/xml'
+      end
+
+      def parse_response?(env)
+        env.body.respond_to? :to_str
+      end
+    end
+  end
+end

data/lib/faraday/decode_xml/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module DecodeXML
+    VERSION = '0.1.0'
+  end
+end

data/lib/faraday/decode_xml.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'decode_xml/middleware'
+require_relative 'decode_xml/version'
+
+module Faraday
+  # This will be your middleware main module, though the actual middleware implementation will go
+  # into Faraday::DecodeXML::Middleware for the correct namespacing.
+  module DecodeXML
+    # Faraday allows you to register your middleware for easier configuration.
+    # This step is totally optional, but it basically allows users to use a
+    # custom symbol (in this case, `:decode_xml`), to use your middleware in their connections.
+    # After calling this line, the following are both valid ways to set the middleware in a connection:
+    # * conn.use Faraday::DecodeXML::Middleware
+    # * conn.use :decode_xml
+    # Without this line, only the former method is valid.
+    Faraday::Response.register_middleware(xml: Faraday::DecodeXML::Middleware)
+
+    # Alternatively, you can register your middleware under Faraday::Request or Faraday::Response.
+    # This will allow to load your middleware using the `request` or `response` methods respectively.
+    #
+    # Load middleware with conn.request :decode_xml
+    # Faraday::Request.register_middleware(decode_xml: Faraday::DecodeXML::Middleware)
+    #
+    # Load middleware with conn.response :decode_xml
+    # Faraday::Response.register_middleware(decode_xml: Faraday::DecodeXML::Middleware)
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: faraday-decode_xml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spencer Oberstadt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 'Faraday middleware for decoding XML requests.
+
+  '
+email:
+- spencer.oberstadt@anedot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/decode_xml.rb
+- lib/faraday/decode_xml/middleware.rb
+- lib/faraday/decode_xml/version.rb
+homepage: https://github.com/soberstadt/faraday-decode_xml
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/soberstadt/faraday-decode_xml/issues
+  changelog_uri: https://github.com/soberstadt/faraday-decode_xml/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-decode_xml/0.1.0
+  homepage_uri: https://github.com/soberstadt/faraday-decode_xml
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/soberstadt/faraday-decode_xml
+  wiki_uri: https://github.com/soberstadt/faraday-decode_xml/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.30
+signing_key:
+specification_version: 4
+summary: Faraday middleware for decoding XML requests
+test_files: []