faraday-encode_xml 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7250a2322ac3dac1774e8514f5acad9db83fe76eedb4f84609cc6e883d79d215
-  data.tar.gz: b3c9dcaf39c8bff4a967a03367f62c740c682af8dd423821641dce66103df19a
+  metadata.gz: 31319300f2f2caadd574c957834b36822d699e9cfbe86d58bd5ab973d7af1e6a
+  data.tar.gz: 3d12939f46f9a0e990836e45f63b01e1ead88697e69f4cefba636083fc7e723f
 SHA512:
-  metadata.gz: cd9e89c7aa7c30c4c4dd5dbae1930f8c2c7fe5581960a79b0c9cd574e9c8f27321b8c559095b3dc8029aadedb5444a2ecbb3956fec437dd45c064f3531280e7e
-  data.tar.gz: e29bc25dc3425ef4db407ba3529fe1c353fb74a7d1a2c60c6099c1920fb907acb98e54c7dd5ca6b23de458179cc67990ca8f5d6c998b72709d87e157ea5685ea
+  metadata.gz: e17e4dfa0f180f6084a15af76829c4369d6505c936a0f9ac8d79aec1e17bfaa2f407799938e69d0d63d9542b08a6fcf8ad12bd69a1b0b258e9157a466c308eab
+  data.tar.gz: 889e4e528252ac6b0a39ca54c26929cf9a85a1868e7e849794ad9cda00ccf8a015bae9502f16921e147e11416bbb17719ee09aa6a4e317b1c3aa308b260dc7ff

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## 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

@@ -28,7 +28,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,9 @@
 # frozen_string_literal: true
 
+require 'faraday'
+
 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,7 +11,7 @@ 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'
 
@@ -44,10 +46,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 = '0.2.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-encode_xml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Popov
@@ -205,15 +205,15 @@ 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:
   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/v0.2.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-encode_xml/0.2.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