soap_client 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dac54722a44857206aebfbf763b504a8836592a
-  data.tar.gz: 6b85d4ec4fc05ed41e94cafad39578867902b2ee
+  metadata.gz: 6921d4eddc29acca3c63b76090ddc4f5aec4ef39
+  data.tar.gz: 1c37d3d7cfe85008dcf9aaa9682a3381674c829c
 SHA512:
-  metadata.gz: 01b9f4db9cb19eb5e2111b62a37136de857288b259fca3f2a71b911016c652d15ce0410d34b03228c9f6b4bca57004f33629a6e37d51fe70a6370b75e0086c42
-  data.tar.gz: e7db22f841d7bcbc3257f2cdde12edbe2f5210fc6fe27dd246090d5e65124fbde839d8fac2e33cbbe004b0ef651a829ede055aba2f16e047738a5314ed1f8e53
+  metadata.gz: 6104261d88536b56da7f9180182ace404a9129ad9de01b1d77790b381dfcd0eab1cb5fc17a21eb323909d19ac77a5258ed989f7657f150d2d2ec2b3038bbab5e
+  data.tar.gz: 6d14e1eb08c29f11d685132a1398f19790a438a67dd94302b6c2032456e5a0a34bb6ca823f5eb06f4792d6756fda54c7ae965e6e90a97e181458ad5bc1e456af

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.1
-before_install: gem install bundler -v 1.11.2
+  - 2.3.1
+before_install: gem install bundler

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0]
+### Changed
+- Pass scrub directives (of [XMLScrubber](https://github.com/imacchiato/xml_scrubber)) and `log: true` to log request and response XML
+
+### Fixed
+- Logging sensitive information. Remove old way of relying on passing a logger that knew how to scrub
+
 ## [0.3.0] - 2017-02-13
 ### Added
 - Log in the info level, the request and response XMLs if logging is enabled

data/lib/soap_client.rb

@@ -1,10 +1,12 @@
 require "virtus"
 require "savon"
+require "xml_scrubber"
 require "active_support/core_ext/hash/slice"
 require "active_support/core_ext/object/blank"
 require "soap_client/version"
 require "soap_client/client"
 require "soap_client/services/build_savon_attrs"
+require "soap_client/services/log_xml"
 
 module SOAPClient
 

data/lib/soap_client/client.rb

@@ -11,6 +11,7 @@ module SOAPClient
     attribute :proxy, String
     attribute :open_timeout, Integer
     attribute :read_timeout, Integer
+    attribute :scrub, Array[Hash]
 
     def self.call(*args)
       self.new(*args).()
@@ -18,21 +19,24 @@ module SOAPClient
 
     def call
       if log
-        savon_request = savon_client.build_request(action, message: message)
-        logger.info "Request XML: #{savon_request.body}"
+        LogXML.(logger, soap_request.body, soap_response.xml, scrub)
       end
 
-      savon_response = savon_client.call(action, message: message)
+      soap_response
+    end
 
-      logger.info("Response XML: #{savon_response.xml}") if log
+    private
 
-      savon_response
+    def soap_request
+      @soap_request ||= soap_client.build_request(action, message: message)
     end
 
-    private
+    def soap_response
+      @soap_response ||= soap_client.(action, message: message)
+    end
 
-    def savon_client
-      @savon_client ||= Savon.client(savon_attrs)
+    def soap_client
+      @soap_client ||= Savon.client(savon_attrs)
     end
 
     def savon_attrs

data/lib/soap_client/services/build_savon_attrs.rb

@@ -2,12 +2,9 @@ module SOAPClient
   class BuildSavonAttrs
 
     def self.call(raw_attrs)
-      attrs = raw_attrs.slice(
-        :wsdl,
-        :log,
-        :logger,
-      )
+      attrs = raw_attrs.slice(:wsdl)
       attrs[:proxy] = raw_attrs[:proxy] if raw_attrs[:proxy].present?
+      attrs[:log] = false
       attrs
     end
 

data/lib/soap_client/services/log_xml.rb

@@ -0,0 +1,37 @@
+module SOAPClient
+  class LogXML
+
+    def self.call(*args)
+      self.new(*args).()
+    end
+
+    def initialize(logger, request_xml, response_xml, scrub_directives)
+      @logger = logger
+      @request_xml = request_xml
+      @response_xml = response_xml
+      @scrub_directives = scrub_directives
+    end
+
+    def call
+      @logger.info(log_text)
+    end
+
+    private
+
+    def log_text
+      [
+        "Request XML: #{scrubbed_request_xml}",
+        "Response XML: #{scrubbed_response_xml}",
+      ].join("\n")
+    end
+
+    def scrubbed_request_xml
+      @scrubbed_request_xml ||= XMLScrubber.(@request_xml, @scrub_directives)
+    end
+
+    def scrubbed_response_xml
+      @scrubbed_response_xml ||= XMLScrubber.(@response_xml, @scrub_directives)
+    end
+
+  end
+end

data/lib/soap_client/version.rb

@@ -1,3 +1,3 @@
 module SOAPClient
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/soap_client.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "virtus", "~> 1.0"
   spec.add_dependency "savon", "~> 2.0"
   spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "xml_scrubber", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soap_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: xml_scrubber
+  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
@@ -115,6 +129,7 @@ files:
 - lib/soap_client.rb
 - lib/soap_client/client.rb
 - lib/soap_client/services/build_savon_attrs.rb
+- lib/soap_client/services/log_xml.rb
 - lib/soap_client/version.rb
 - soap_client.gemspec
 homepage: https://github.com/imacchiato/soap_client