faraday-encode_xml 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7250a2322ac3dac1774e8514f5acad9db83fe76eedb4f84609cc6e883d79d215
-  data.tar.gz: b3c9dcaf39c8bff4a967a03367f62c740c682af8dd423821641dce66103df19a
+  metadata.gz: 4e6ddc26f83af475e9849f33d88623343dbbfd15c9442aee2cdf4966d9423d39
+  data.tar.gz: 6567bfdf42e8d0b8db251c624d83e2a809e5c8dd9964d778195172b8bd16680d
 SHA512:
-  metadata.gz: cd9e89c7aa7c30c4c4dd5dbae1930f8c2c7fe5581960a79b0c9cd574e9c8f27321b8c559095b3dc8029aadedb5444a2ecbb3956fec437dd45c064f3531280e7e
-  data.tar.gz: e29bc25dc3425ef4db407ba3529fe1c353fb74a7d1a2c60c6099c1920fb907acb98e54c7dd5ca6b23de458179cc67990ca8f5d6c998b72709d87e157ea5685ea
+  metadata.gz: 93b0ce16941734bc55315b5a0add5a50af1016067ee3d6922a07ca267e308842242ee88d2846fe5f4c24408f1b1305a576d71a661f6c7997d4c8c345159eb149
+  data.tar.gz: 1669103508589fb19c6e22994c3d9673c422d91596ea527cd5b2a9c1360462542a1ed2ced695defa565937b0ad12d13040e26cf7bf5c19b2634c4f7953f2dbaa

data/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## 1.0.0 (2022-11-19)
+
+*   Update Faraday to version 2.
+*   Update development dependencies.
+*   Drop Ruby 2.5 support.
+*   Add Ruby 3.1 for CI.
+*   Add code coverage gems, scripts and CI tasks.
+*   Improve CI config.
+
+## 0.2.0 (2021-10-20)
+
+*   Rework classes hierarchy to something more correct.
+*   Add usage example in README.
+
 ## 0.1.0 (2021-10-20)
 
 *   Initial release.

data/README.md

@@ -1,6 +1,13 @@
 # Faraday Encode XML
 
-This repo is a [Faraday][https://github.com/lostisland/faraday] middleware for encoding requests as XML.
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/faraday-encode_xml?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/faraday-encode_xml)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/faraday-encode_xml/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/faraday-encode_xml)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/faraday-encode_xml.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/faraday-encode_xml)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/faraday-encode_xml?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/faraday-encode_xml)
+[![Gem](https://img.shields.io/gem/v/faraday-encode_xml.svg?style=flat-square)](https://rubygems.org/gems/faraday-encode_xml)
+[![License](https://img.shields.io/github/license/AlexWayfer/faraday-encode_xml.svg?style=flat-square)](LICENSE.txt)
+
+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
@@ -28,7 +35,22 @@ gem install faraday-encode_xml
 ```ruby
 require 'faraday/encode_xml'
 
-# TODO
+connection = Faraday.new do |faraday|
+  ## This gem only encodes requests
+  faraday.request :xml
+
+  ## For responses deconding use `faraday_middleware` gem and such code:
+  # require 'faraday_middleware'
+  # faraday.response :xml
+
+  ## For example `httpbingo` responses as JSON, so let's enable it:
+  require 'faraday_middleware'
+  faraday.response :json
+end
+
+response = connection.post('https://httpbingo.org/post', { a: 1, b: 'foo', c: true })
+
+puts response.body['data'] ## => <a>1</a><b>foo</b><c>true</c>
 ```
 
 ## Development

data/lib/faraday/{middleware/encode_xml.rb → encode_xml/middleware.rb}

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'faraday'
+require 'gyoku' unless defined?(::Gyoku)
+
 module Faraday
-  class Middleware
+  module EncodeXML
     # Request middleware that encodes the body as XML.
     #
     # Processes only requests with matching Content-type or those without a type.
@@ -9,14 +12,10 @@ module Faraday
     # to XML MIME-type.
     #
     # Doesn't try to encode bodies that already are in string form.
-    class EncodeXML < Faraday::Middleware
+    class Middleware < 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:
@@ -44,10 +43,10 @@ module Faraday
 
       def process_request?(env)
         type = request_type(env)
-        has_body?(env) && (type.empty? or type == MIME_TYPE)
+        body?(env) && (type.empty? or type == MIME_TYPE)
       end
 
-      def has_body?(env)
+      def body?(env)
         (body = env[:body]) && !(body.respond_to?(:to_str) && body.empty?)
       end
 

data/lib/faraday/encode_xml/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module EncodeXML
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/faraday/encode_xml.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-encode_xml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexander Popov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: gyoku
   requirement: !ruby/object:Gem::Requirement
@@ -109,21 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.21.0
 - !ruby/object:Gem::Dependency
-  name: gem_toys
+  name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: toys
+  name: gem_toys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -136,20 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.39.0
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
@@ -205,15 +219,16 @@ files:
 - LICENSE.md
 - README.md
 - lib/faraday/encode_xml.rb
+- lib/faraday/encode_xml/middleware.rb
 - lib/faraday/encode_xml/version.rb
-- lib/faraday/middleware/encode_xml.rb
 homepage: https://github.com/AlexWayfer/faraday-encode_xml
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   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
+  changelog_uri: https://github.com/AlexWayfer/faraday-encode_xml/blob/v1.0.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-encode_xml/1.0.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
@@ -225,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'
@@ -235,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Faraday middleware for encoding requests as XML