soapy_cake 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1a10b55da67455d7850300f6b1da3a3b4321a008df2986bf2de8dc53d05b5e2
-  data.tar.gz: f74e861ce703df28b9ac771fa6fcaac96b8d6f2c1be2a725c0425f2fe9d240c9
+  metadata.gz: 067f6e7655ca70f82bdb56092d19dcfbb0f41879077ede785b6490ee40ba0192
+  data.tar.gz: 945cce14ca15a79590bef7b1bef2a636288da4cfb0ba93b6d9f50482ecdc533b
 SHA512:
-  metadata.gz: 9fc9818fcecb399918332e5624b753cd7bf74030d4f460b1939f7e8c7859ed2fdd55c2d4d0e18448153f4b284e0c770f22a94feb73def6ab0c8afd487f319afb
-  data.tar.gz: b6e3e18834d04dfd7548aa86837a2e322d519237635998077aa12f699454d0a0db5e5bf1deb2fbff6fe50246d57eb0c47b53c018e65a9275574b1e510cb79ee3
+  metadata.gz: bc1c8bbba8cf6b41ca72aeebe6c516b7a915a8a3fb1bead22794e87c600aba8b4e6d8b7c590e0e6c700e3a327f8eb0264b3f0142d837c6b3e13be7dbbffce967
+  data.tar.gz: 9ecf1e1d0d996917d3b079b8e74f0bd3db0f5ea67d27d276c78cb8387572045893b01555877aaab17c09e20ce5e7ba0df6a0b8ebfea7152416597160f917b791

data/lib/soapy_cake/client.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'net/http'
+require 'active_support/tagged_logging'
 
+# rubocop:disable Metrics/ClassLength
 module SoapyCake
   class Client
     HEADERS = { 'Content-Type' => 'application/soap+xml;charset=UTF-8' }.freeze
@@ -62,46 +64,58 @@ module SoapyCake
       Retryable.retryable(opts, &block)
     end
 
-    def logger
-      @logger ||= opts[:logger] || (defined?(::Rails) && ::Rails.logger)
+    def response_body(request)
+      request.opts[:response].presence || http_response(request)
     end
 
-    def log_curl_command(request)
-      curl_headers = HEADERS.map { |k, v| "-H \"#{k}: #{v}\"" }.join(' ')
-      curl_body = request.xml
-        .tr("\n", '')
-        .gsub(/>\s*</, '><')
-        .sub(request.api_key, '{{{ INSERT API KEY }}}')
+    def http_response(request)
+      response = nil
+      logger.tagged('soapy_cake', unique_id) do
+        log_request(request)
+        response = perform_http_request(http_request(request))
+        log_response(response)
+      end
 
-      logger&.info("curl --data '#{curl_body}' #{curl_headers} https://#{domain}/#{request.path}")
+      raise_if_unsuccessful(response)
+      response.body
     end
 
-    def response_body(request)
-      request.opts[:response].presence || http_response(request)
+    def http_request(request)
+      http_req = Net::HTTP::Post.new(request.path, HEADERS)
+      http_req.body = request.xml
+      http_req
     end
 
-    def http_response(request)
-      log_curl_command(request) if fetch_opt(:log_curl)
-
-      http_request = Net::HTTP::Post.new(request.path, HEADERS)
-      http_request.body = request.xml
-      t0 = Time.now
-      response = perform_http_request(http_request)
-      response_time = Time.now - t0
-      logger&.info("soapy_cake:request #{request} took: #{response_time.round(2)} s")
+    def unique_id
+      SecureRandom.hex(4)
+    end
 
-      unless response.is_a?(Net::HTTPSuccess)
-        raise RequestFailed.new(
-          "Request failed with HTTP #{response.code}",
-          response_body: response.body
+    def log_request(request)
+      logger.tagged('request') do
+        logger.info(
+          request
+            .xml
+            .gsub(/>[\n\s]+</, '><')
+            .sub(request.api_key, '[REDACTED]')
         )
       end
+    end
 
-      response.body
+    def log_response(response)
+      logger.tagged('response', response.code) do
+        logger.info(response.body)
+      end
+    end
+
+    def logger
+      @logger ||= ActiveSupport::TaggedLogging.new(
+        opts[:logger] || (defined?(::Rails) && ::Rails.logger) || Logger.new('/dev/null')
+      )
     end
 
     def perform_http_request(http_request)
-      Net::HTTP.start(
+      t0 = Time.now
+      response = Net::HTTP.start(
         domain,
         use_ssl: true,
         open_timeout: NET_TIMEOUT,
@@ -109,6 +123,18 @@ module SoapyCake
       ) do |http|
         http.request(http_request)
       end
+      logger.info("took: #{(Time.now - t0).round(2)} s")
+      response
+    end
+
+    def raise_if_unsuccessful(response)
+      return if response.is_a?(Net::HTTPSuccess)
+
+      raise RequestFailed.new(
+        "Request failed with HTTP #{response.code}",
+        response_body: response.body
+      )
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/soapy_cake/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SoapyCake
-  VERSION = '2.3.0'
+  VERSION = '2.3.1'
 end

data/spec/integration/soapy_cake/admin_spec.rb

@@ -3,18 +3,21 @@
 RSpec.describe SoapyCake::Admin do
   around { |example| Timecop.freeze(Time.utc(2015, 6, 15, 12), &example) }
 
-  let(:logger) { instance_spy(Logger) }
+  let(:logger) { Logger.new('/dev/null') }
 
   subject(:admin) { described_class.new(logger: logger) }
 
   it 'returns an affiliate with correct data types', :vcr do
-    result = admin.affiliates(affiliate_id: 16027)
-
-    expect(logger).to have_received(:info).with(
-      a_string_matching(
-        /soapy_cake:request admin:export:affiliates:5 {"affiliate_id":16027} took: \d+.\d+ s/
-      )
+    # rubocop:disable RSpec/AnyInstance
+    expect_any_instance_of(Logger).to receive(:info).twice.with(
+      a_string_matching(/^<\?xml/)
     )
+    expect_any_instance_of(Logger).to receive(:info).with(
+      a_string_matching(/took: \d+.\d+ s/)
+    )
+    # rubocop:enable RSpec/AnyInstance
+
+    result = admin.affiliates(affiliate_id: 16027)
 
     expect(result.count).to eq(1)
     expect(result.first).to include(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soapy_cake
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - ad2games GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -272,7 +272,7 @@ homepage: http://ad2games.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -287,9 +287,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Simple client for the CAKE API
 test_files: