naranya_ecm-sdk 0.0.50 → 0.0.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8170ec1a6a5f1827bed0f85ca6916888f19c0ec9
-  data.tar.gz: 2e29be22a0f517996581db3e168e5ab0b7fcfd0e
+  metadata.gz: c55ea1f4ccd068045f3c56d2acc2bac64a280b25
+  data.tar.gz: 77f6be226eea9535161ce14616c042f0f967d65b
 SHA512:
-  metadata.gz: d566ec2b336d5d10438c7a228d1101ce2b9cbcaec62d490367d3b70f4d205a9fb11c359d3e5d41ad06c9acb098d75b88e93ad0728c927e585f7d9288318a3157
-  data.tar.gz: fe81eeaed663214bd0409408d3b25a44849fb63088720412c93c8c8d851bd6e8f6b96e8a96af50fa8825d7f71abef529042726ebc977af3899d1475239c25c92
+  metadata.gz: 1a50a5884274b367d8211a088e53061c9312a27814cc475529c6bde3b7a2d7f1ec1f1769649758a0f8e150dc3fafe1f4ec474fed2b05bbb0df62f79ac8312622
+  data.tar.gz: bb4073ba62463c9dfea69a5f204ddb334acc28a53920745fa65fcfc4848839147e1224b6660a684dc8f00ffeadba94c033a4ca07b05e201387787cead05156fc

data/Gemfile

@@ -15,3 +15,6 @@ gem 'em-synchrony'
 gem 'em-http-request'
 gem 'excon'
 gem 'httpclient'
+
+# New Relic RPM:
+gem 'newrelic_rpm'

data/lib/naranya_ecm-sdk/version.rb

@@ -1,3 +1,3 @@
 module NaranyaEcm
-  VERSION = "0.0.50"
+  VERSION = "0.0.51"
 end

data/lib/naranya_ecm/rest/errors.rb

@@ -12,8 +12,8 @@ module NaranyaEcm::Rest
     end
 
     ##
-    # Captura un response y genera + avienta una excepción.
-    def self.raise_by_failed_response(response, message = "")
+    # Captura un response y genera una excepción.
+    def self.build_from_failed_response(response, message = "")
       klass = case response.status
       when 401 then AuthorizationRequired
       when 403 then Forbidden
@@ -21,7 +21,14 @@ module NaranyaEcm::Rest
       when 422 then UnprocessableEntity
       else RemoteFailed
       end
-      raise klass.new response, "Server responded with code #{response.status}. Message: #{message}"
+
+      klass.new response, "Server responded with code #{response.status}. Message: '#{message}'"
+    end
+
+    ##
+    # Captura un response y avienta una excepción.
+    def self.raise_by_failed_response(response, message = "")
+      raise build_from_failed_response(response, message)
     end
 
   end
@@ -95,6 +102,15 @@ module NaranyaEcm::Rest
   end
 
   class RemoteFailed < RestError
+    def initialize(given_response, msg = "")
+      response_env = given_response.env
+
+      # Override the message:
+      msg = "Request '#{response_env.method.upcase} #{response_env.url.path}' failed with HTTP status #{response_env.status}."
+      msg += " Request-Body: #{response_env[:request_body]}" if response_env[:request_body].present?
+      msg += " Response-Body: #{given_response.body.inspect}" if given_response.respond_to?(:body) && given_response.body.present?
+      super(given_response, msg)
+    end
   end
 
 end

data/lib/ncontent/sdk/config.rb

@@ -66,6 +66,10 @@ module NContent
 
       config_accessor(:notification_processing_modules) { [] }
 
+      def new_relic_agent_available?
+        defined?(::NewRelic) && defined?(::NewRelic::Agent)
+      end
+
       def self.parse_yaml(yaml_path)
         YAML.load(ERB.new(File.read(yaml_path)).result) if File.exist?(yaml_path)
       end

data/lib/ncontent/sdk/faraday_middleware.rb

@@ -1,4 +1,4 @@
-
+require "ncontent/sdk/faraday_middleware/request_body_on_environment"
 require "ncontent/sdk/faraday_middleware/required_response_format"
 require "ncontent/sdk/faraday_middleware/response_parser"
 require "ncontent/sdk/faraday_middleware/rest_api_call_benchmark"

data/lib/ncontent/sdk/faraday_middleware/request_body_on_environment.rb

@@ -0,0 +1,25 @@
+module NContent
+  module SDK
+    module FaradayMiddleware
+
+      # Adds the required response format to the request parameters, in order for
+      # the SDK to work:
+      class RequestBodyOnEnvironment < Faraday::Middleware
+
+        def call(request_env)
+
+          # Evitar en peticiones a '/oauth/token' y cuando no exista body.
+          # Típicamente las peticiones GET no tienen body:
+          if request_env.url.path != '/oauth/token' && request_env.respond_to?(:body) && request_env.body.present?
+            request_body = request_env.body
+          end
+
+          @app.call(request_env).on_complete do |response_env|
+            response_env[:request_body] = request_body if request_body.present?
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ncontent/sdk/rest_client.rb

@@ -1,6 +1,7 @@
 require 'oauth2'
 require 'ncontent/sdk/faraday_middleware'
 require 'singleton'
+require 'cgi'
 
 module NContent
 
@@ -43,7 +44,36 @@ module NContent
             retry
           else
             logger.warn "Not retrying response #{verb.upcase} #{path}."
-            NaranyaEcm::Rest::RestError.raise_by_failed_response(error.response)
+
+            # Extract from the OAuth::Error the base Faraday response:
+            error_response = error.response.response
+
+            # Build the error that will be raised:
+            error_to_raise = NaranyaEcm::Rest::RestError.build_from_failed_response(error_response)
+
+            # Send unhandled errors to NewRelic:
+            if error_to_raise.is_a?(NaranyaEcm::Rest::RemoteFailed) && config.new_relic_agent_available?
+
+              ncontent_url = error_response.env.url
+
+              # Parsear el query string a hash:
+              ncontent_request_params = CGI.parse ncontent_url.query.to_s
+
+              # Agregar al hash de ncontent_request_params el request_body como hash:
+              if error_response.env.request_headers['Content-Type'] == 'application/json' && error_response.env[:request_body].present?
+                ncontent_request_params.merge! ActiveSupport::JSON.decode(error_response.env[:request_body])
+              end
+
+              ::NewRelic::Agent.notice_error(
+                error_to_raise,
+                uri: ncontent_url.to_s.split('?').first, # The URL without query string
+                metric: "Custom/NContent::SDK::RESTClient/#{verb}",
+                request_params: ncontent_request_params
+              )
+            end
+
+            raise error_to_raise
+
           end
         end
       end
@@ -80,6 +110,8 @@ module NContent
 
             faraday.response :logger, logger
 
+            faraday.use NContent::SDK::FaradayMiddleware::RequestBodyOnEnvironment
+
             faraday.use NContent::SDK::FaradayMiddleware::RESTAPICallBenchmark
 
             faraday.use NContent::SDK::FaradayMiddleware::ResponseParser

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: naranya_ecm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.50
+  version: 0.0.51
 platform: ruby
 authors:
 - Roberto Quintanilla
@@ -264,6 +264,7 @@ files:
 - lib/ncontent-sdk.rb
 - lib/ncontent/sdk/config.rb
 - lib/ncontent/sdk/faraday_middleware.rb
+- lib/ncontent/sdk/faraday_middleware/request_body_on_environment.rb
 - lib/ncontent/sdk/faraday_middleware/required_response_format.rb
 - lib/ncontent/sdk/faraday_middleware/response_parser.rb
 - lib/ncontent/sdk/faraday_middleware/rest_api_call_benchmark.rb