mangopay 3.24.0 → 3.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7321bd891306f53afcbd49ecb871a872f7899d2ee039688392b076ee64c45142
-  data.tar.gz: c93e03ce101e31b67def7784e6a1d9490ca4cf5d4254f312f6cda02d32f528ec
+  metadata.gz: dfbda16f8ea316a00735545fa9c670f5ecbbe7dadc389ebecc37909a24c29be6
+  data.tar.gz: 774766d50d6351820e1b33dd6cc43beaba2b137756318ed4a22c0b079cd4fdac
 SHA512:
-  metadata.gz: 889df791bf8d890fedbaca69373b91f7f14bb332b9bd2bda09524bfe8d5438c04c0189aea216627c097ccfb1453c1b8f5f4fcb53f6c90d328c04b143e47b75bb
-  data.tar.gz: 91c75bf32947a0eb9023d309164a5e416fb80744ca9516da1843b51dff4fdf01b7136c3c3489a3d50aecfa868c735c7f65330eebfe8f1e9ee37cbbaf79ad98de
+  metadata.gz: e003221ba09f9358431c661d5bc85be4b6c0893ef7369b8e770a2d98a5a5a30ec73994037509519dcda0ee859af674610481c3dee5ec01109d97abc1000364cd
+  data.tar.gz: 3c42d1785055f226161c6aa728db75e40016fb9f08cf947b63f25862268c52b124ad076920cdc6faddfbf679c26ef80a67e7c70fc1f575780804c09b0cfcb611

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [3.25.0] - 2024-04-16
+### Added
+
+- Add trace header logging : Introduced the `log_trace_headers` boolean configuration key. Set it to true to enable logging of `x_mangopay_trace-id` and `IdempotencyKey` in the log of the http requests.
+
+## [3.24.1] - 2024-04-10
+### Fixed
+
+- #249 Improve error handling when logging is enabled
+- #226 MultiJson::ParseError is thrown on HTTP error 5XX
+
 ## [3.24.0] - 2024-04-02
 ### Added
 

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.24.0'
+  VERSION = '3.25.0'
 end

data/lib/mangopay.rb

@@ -5,6 +5,7 @@ require 'multi_json'
 require 'benchmark'
 require 'logger'
 require 'time'
+require 'securerandom'
 
 # helpers
 require 'mangopay/version'
@@ -55,7 +56,7 @@ module MangoPay
   class Configuration
     attr_accessor :preproduction, :root_url,
                   :client_id, :client_apiKey,
-                  :temp_dir, :log_file, :http_timeout,
+                  :temp_dir, :log_file, :log_trace_headers, :http_timeout,
                   :http_max_retries, :http_open_timeout,
                   :logger, :use_ssl, :uk_header_flag
 
@@ -65,6 +66,7 @@ module MangoPay
         config.client_id = @client_id
         config.client_apiKey = @client_apiKey
         config.log_file = @log_file
+        config.log_trace_headers = @log_trace_headers
         config.http_timeout = @http_timeout
         config.http_max_retries = @http_max_retries
         config.http_open_timeout = @http_open_timeout
@@ -101,6 +103,10 @@ module MangoPay
 
       true
     end
+    
+    def log_trace_headers
+      @log_trace_headers || false
+    end
 
     def uk_header_flag
       @uk_header_flag || false
@@ -214,7 +220,13 @@ module MangoPay
       raise MangoPay::ResponseError.new(uri, '408', {'Message' => 'Request Timeout'}) if res.nil?
 
       # decode json data
-      data = res.body.to_s.empty? ? {} : JSON.load(res.body.to_s)
+      begin
+        data = res.body.to_s.empty? ? {} : JSON.load(res.body.to_s)
+      rescue MultiJson::ParseError
+        details = {}
+        details['Message'] = res.body
+        raise MangoPay::ResponseError.new(uri, res.code, details)
+      end
 
       unless res.is_a?(Net::HTTPOK)
         raise MangoPay::ResponseError.new(uri, res.code, data)
@@ -268,6 +280,9 @@ module MangoPay
           'Authorization' => "#{auth_token['token_type']} #{auth_token['access_token']}",
           'Content-Type' => 'application/json'
       }
+      if configuration.log_trace_headers
+        headers.update('x_mangopay_trace-id' => SecureRandom.uuid)
+      end
       begin
         headers.update('x_mangopay_client_user_agent' => JSON.dump(user_agent))
       rescue => e
@@ -286,7 +301,12 @@ module MangoPay
     def do_request_with_log(http, req, uri)
       res, time = nil, nil
       params = FilterParameters.request(req.body)
-      line = "[#{Time.now.iso8601}] #{req.method.upcase} \"#{uri.to_s}\" #{params}"
+      if configuration.log_trace_headers
+        trace_headers = JSON.dump({ 'Idempotency-Key' => req['Idempotency-Key'] , 'x_mangopay_trace-id' =>  req['x_mangopay_trace-id'] })
+        line = "[#{Time.now.iso8601}] #{req.method.upcase} \"#{uri.to_s}\" #{params} #{trace_headers}"
+      else
+        line = "[#{Time.now.iso8601}] #{req.method.upcase} \"#{uri.to_s}\" #{params}"
+      end
       begin
         time = Benchmark.realtime {
           begin
@@ -298,12 +318,17 @@ module MangoPay
         res
       ensure
         line = "#{log_severity(res)} #{line}"
+        if time.nil?
+          time_log = "[Unknown ms]"
+        else
+          time_log = "[#{(time * 1000).round(1)}ms]"
+        end
         if res.nil?
           params = ''
-          line += "\n  [#{(time * 1000).round(1)}ms] 408 Request Timeout #{params}\n"
+          line += "\n  #{time_log} 408 Request Timeout #{params}\n"
         else
           params = FilterParameters.response(res.body)
-          line += "\n  [#{(time * 1000).round(1)}ms] #{res.code} #{params}\n"
+          line += "\n  #{time_log} #{res.code} #{params}\n"
         end
         logger.info { line }
       end

data/spec/mangopay/card_registration_spec.rb

@@ -6,7 +6,6 @@ describe MangoPay::CardRegistration do
     it 'creates a new card registration' do
       created = new_card_registration
       expect(created['Id']).not_to be_nil
-      expect(created['Id'].to_i).to be > 0
       expect(created['AccessKey']).not_to be_nil
       expect(created['PreregistrationData']).not_to be_nil
       expect(created['CardRegistrationURL']).not_to be_nil
@@ -51,7 +50,6 @@ describe MangoPay::CardRegistration do
 
       # card id filled-in...
       expect(card_id).not_to be_nil
-      expect(card_id.to_i).to be > 0
 
       # ...and points to existing (newly created) card
       card = MangoPay::Card.fetch(card_id)

data/spec/mangopay/preauthorization_spec.rb

@@ -7,7 +7,6 @@ describe MangoPay::PreAuthorization do
       cardreg = new_card_registration_completed
       created = new_card_preauthorization
       expect(created['Id']).not_to be_nil
-      expect(created['Id'].to_i).to be > 0
       expect(created['CardId']).to eq(cardreg['CardId'])
       expect(created['AuthorId']).to eq(new_natural_user["Id"])
       expect(created['PayInId']).to be_nil

data/spec/mangopay/user_spec.rb

@@ -144,7 +144,6 @@ describe MangoPay::User do
         fetched = MangoPay::Card.fetch(card['CardId'])
 
         expect(fetched['Id']).not_to be_nil
-        expect(fetched['Id'].to_i).to be > 0
         expect(fetched['UserId']).to eq(new_natural_user["Id"])
         expect(fetched['Currency']).to eq('EUR')
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.24.0
+  version: 3.25.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json