faraday-encode_xml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7250a2322ac3dac1774e8514f5acad9db83fe76eedb4f84609cc6e883d79d215
+  data.tar.gz: b3c9dcaf39c8bff4a967a03367f62c740c682af8dd423821641dce66103df19a
+SHA512:
+  metadata.gz: cd9e89c7aa7c30c4c4dd5dbae1930f8c2c7fe5581960a79b0c9cd574e9c8f27321b8c559095b3dc8029aadedb5444a2ecbb3956fec437dd45c064f3531280e7e
+  data.tar.gz: e29bc25dc3425ef4db407ba3529fe1c353fb74a7d1a2c60c6099c1920fb907acb98e54c7dd5ca6b23de458179cc67990ca8f5d6c998b72709d87e157ea5685ea

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## Unreleased
+
+## 0.1.0 (2021-10-20)
+
+*   Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Popov
+
+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,51 @@
+# Faraday Encode XML
+
+This repo is a [Faraday][https://github.com/lostisland/faraday] middleware for encoding requests as XML.
+Faraday is an HTTP client library that provides a common interface for making requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-encode_xml'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-encode_xml
+```
+
+## Usage
+
+```ruby
+require 'faraday/encode_xml'
+
+# TODO
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `bundle exec rspec` to run the tests.
+
+To install this gem onto your local machine, run `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/faraday-encode_xml).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/encode_xml/version.rb

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

data/lib/faraday/encode_xml.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'faraday/middleware/encode_xml'
+require 'faraday/encode_xml/version'
+
+module Faraday
+  # This will be your middleware main module, though the actual middleware implementation will go
+  # into Faraday::Middleware::MyMiddleware for the correct namespacing.
+  module EncodeXML
+    # 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, `:my_middleware`), 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::Middleware::MyMiddleware
+    # * conn.use :my_middleware
+    # Without this line, only the former method is valid.
+    # Faraday::Middleware.register_middleware(encode_xml: Faraday::Middleware::EncodeXML)
+
+    # 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 :my_middleware
+    Faraday::Request.register_middleware(xml: Faraday::Middleware::EncodeXML)
+
+    # Load middleware with conn.response :my_middleware
+    # Faraday::Response.register_middleware(my_adapter: Faraday::Middleware::MyMiddleware)
+  end
+end

data/lib/faraday/middleware/encode_xml.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Faraday
+  class Middleware
+    # 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 EncodeXML < Faraday::Middleware
+      CONTENT_TYPE = 'Content-Type'
+      MIME_TYPE    = 'application/xml'
+
+      dependency do
+        require 'gyoku' unless defined?(::Gyoku)
+      end
+
+      # This method will be called when the request is being prepared.
+      # You can alter it as you like, accessing things like request_body, request_headers, and more.
+      # Refer to Faraday::Env for a list of accessible fields:
+      # https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+      #
+      # @param env [Faraday::Env] the environment of the request being processed
+      def on_request(env)
+        match_content_type(env) do |data|
+          env[:body] = encode data
+        end
+      end
+
+      private
+
+      def encode(data)
+        ::Gyoku.xml(data, key_converter: :none)
+      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)
+        has_body?(env) && (type.empty? or type == MIME_TYPE)
+      end
+
+      def has_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

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: faraday-encode_xml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Popov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !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: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !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 encoding requests as XML.
+
+  '
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/encode_xml.rb
+- lib/faraday/encode_xml/version.rb
+- lib/faraday/middleware/encode_xml.rb
+homepage: https://github.com/AlexWayfer/faraday-encode_xml
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/AlexWayfer/faraday-encode_xml/issues
+  changelog_uri: https://github.com/AlexWayfer/faraday-encode_xml/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-encode_xml/0.1.0
+  homepage_uri: https://github.com/AlexWayfer/faraday-encode_xml
+  source_code_uri: https://github.com/AlexWayfer/faraday-encode_xml
+  wiki_uri: https://github.com/AlexWayfer/faraday-encode_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.22
+signing_key:
+specification_version: 4
+summary: Faraday middleware for encoding requests as XML
+test_files: []