huginn_http_request_agent 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa4b89cbaf5fef82663f2845a176ff324843eb74
-  data.tar.gz: 45bf7be76d8549e519571e0a4da22101e2167868
+SHA256:
+  metadata.gz: efc2ffa3f090b8c268492b91a79a0914ee18bbbdd431b714160d65856f34be24
+  data.tar.gz: 276b80b72c60689cedb18d2f1e6e9fed117bbfe97229d06aa138e04a3cca8c0e
 SHA512:
-  metadata.gz: 4c8cbcb0ef880d72ac64ac14ce67a1b2f611976b9ee9eef7a09f0ad94a13667806cf4cd6a21692d0b551d1286ac777018d155300dc01e60f53400c5e0daec184
-  data.tar.gz: bec6693f64867873839b1b22be72faf25dfe754f810b79958fd294bb494dfadd0bf008666e67387353eb22a31f24c17ae620e9a86ddb880903bf2e5e1f8158f1
+  metadata.gz: 64f2207730c600ce39d38267057377af946164c50dbf15fe6b0a9108384fb16685511cef5105bffbee462ed59c493f60b78dd5bd2969061318be0cfd0eac169e
+  data.tar.gz: c2204699225a8867b3a4b5955724935e49964b6d1e65158413c8af42035a9dd4506c0e090977a96c216784b2fd93855e94b186967344aa4e2860d2e23e251ba5

data/lib/huginn_http_request_agent/http_request_agent.rb

@@ -34,6 +34,7 @@ module Agents
           - `no_merge` - Setting this value to `true` will result in the incoming event, but still send the interpolated payload
           - `output_mode` - Setting this value to `merge` will result in the emitted Event being merged into the original contents of the received Event. Setting it to `clean` will result in no merge.
           - `emit_events` - Setting this to `true` will result in the server response being emitted as an Event which can be subsequently consumed by another agent (ex. to a WebsiteAgent for parsing of the response body)
+          - `log_requests` - Setting this to `true` will log the contents of the interpolated request object sent by this event.
 
         ### Content Type's:
 
@@ -41,11 +42,18 @@ module Agents
 
           - `json` to send JSON instead
           - `xml` to send XML, where the name of the root element may be specified using `xml_root`
+          - All other `content_type`'s will be serialized as a string
 
         By default, non-GETs will be sent with form encoding (`application/json`).
 
-        When `content_type` contains a [MIME](https://en.wikipedia.org/wiki/Media_type) type, and `payload` is a string, its interpolated value will be sent as a string in the HTTP request's body and the request's `Content-Type` HTTP header will be set to `content_type`.
+        The `content_type` field will default the `Content-Type` header if it is not explicitly set in the following manner:
 
+          - if `Content-Type` is set use value
+          - else if `content_type==json` then `Content-Type=application/json`
+          - else if `content_type==xml` then `Content-Type=application/xml`
+          - else `Content-Type=content_type`
+
+        This allows you fine grained control over the mime type being used.
 
         ### Response
 
@@ -93,7 +101,8 @@ module Agents
         'headers' => {},
         'emit_events' => 'true',
         'no_merge' => 'false',
-        'output_mode' => 'clean'
+        'output_mode' => 'clean',
+        'log_requests' => 'false'
       }
     end
 
@@ -138,6 +147,10 @@ module Agents
         errors.add(:base, "if provided, emit_events must be true or false")
       end
 
+      if options.has_key?('log_requests') && boolify(options['log_requests']).nil?
+        errors.add(:base, "If provided, log_requests must be true or false")
+      end
+
       validate_event_headers_options!
 
       unless %w[post get put delete patch].include?(method)
@@ -163,6 +176,7 @@ module Agents
       incoming_events.each do |event|
         interpolate_with(event) do
           outgoing = interpolated['payload'].presence || {}
+
           if boolify(interpolated['no_merge'])
             handle outgoing, event, headers(interpolated[:headers])
           else
@@ -187,7 +201,7 @@ module Agents
 
         case content_type
         when 'json'
-          headers['Content-Type'] = 'application/json; charset=utf-8'
+          headers['Content-Type'] ||= 'application/json; charset=utf-8'
           url = faraday.build_url(url, data.compact)
         else
           params = data
@@ -209,13 +223,13 @@ module Agents
 
         case content_type
         when 'json'
-          headers['Content-Type'] = 'application/json; charset=utf-8'
+          headers['Content-Type'] ||= 'application/json; charset=utf-8'
           body = data.to_json
         when 'xml'
-          headers['Content-Type'] = 'text/xml; charset=utf-8'
+          headers['Content-Type'] ||= 'text/xml; charset=utf-8'
           body = data.to_xml(root: (interpolated(event.payload)[:xml_root] || 'post'))
         when MIME_RE
-          headers['Content-Type'] = content_type
+          headers['Content-Type'] ||= content_type
           body = data.to_s
         else
           body = data
@@ -224,34 +238,72 @@ module Agents
         error "Invalid method '#{method}'"
       end
 
-      response = faraday.run_request(method.to_sym, url, body, headers) { |request|
+      if boolify(interpolated['log_requests'])
+        log({ method: method, url: url, body: body, headers: headers })
+      end
 
-        # open/read timeout in seconds
-        if interpolated['timeout'].to_i
-            request.options.timeout = interpolated['timeout'].to_i
-        end
+      output_event = interpolated['output_mode'].to_s == 'merge' ? event.payload.dup : {}
 
-        # connection open timeout in seconds
-        if interpolated['open_timeout'].to_i
-            request.options.open_timeout = interpolated['open_timeout'].to_i
-        end
+      begin
 
-        request.params.update(params) if params
-      }
+        response = faraday.run_request(method.to_sym, url, body, headers) { |request|
 
-      if boolify(interpolated['emit_events'])
-        new_event = interpolated['output_mode'].to_s == 'merge' ? event.payload.dup : {}
-        create_event payload: new_event.merge(
-          body: response.body,
-          status: response.status
-        ).merge(
-          event_headers_payload(response.headers)
-        )
+          # open/read timeout in seconds
+          if interpolated['timeout'].to_i
+              request.options.timeout = interpolated['timeout'].to_i
+          end
+
+          # connection open timeout in seconds
+          if interpolated['open_timeout'].to_i
+              request.options.open_timeout = interpolated['open_timeout'].to_i
+          end
+
+          request.params.update(params) if params
+        }
+
+        if boolify(interpolated['emit_events'])
+          create_event payload: output_event.merge(
+            body: response.body,
+            status: response.status
+          ).merge(
+            event_headers_payload(response.headers)
+          )
+        end
+      rescue => e
+        handle_req_error(e, output_event, url)
       end
     end
 
     def event_headers_key
       super || 'headers'
     end
-  end
+
+    def handle_req_error( error, output_payload, endpoint )
+
+      error_status = defined?(error.response_status)  && !error.response_status.nil? ? error.response_status : 500
+
+      #  NOTE:  `options['payload']`` below is intentionally _NOT_ interpolated.
+      #  The primary reason for this is that it may contain sensitive values
+      #  By passing the raw option, we will see liquid placeholders instead.
+      #  This wiill assist with debugging while also not exposing secrets.
+
+      log({
+        error_message: error.message,
+        status_code: error_status,
+        endpoint: endpoint,
+        payload_options: options['payload'],
+      })
+
+      if boolify(interpolated['emit_events'])
+        create_event payload: output_payload.merge(
+          status: error_status,
+          error_message: error.message,
+          endpoint: endpoint,
+          payload_options: options['payload'],
+        )
+      end
+
+    end
+
+  end # <-- End of class
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_http_request_agent
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a longer description or delete this line.
+description: The Http Request Agent is intended to be an abstract agent that allows
+  for the interaction of any http service.
 email:
 - jspizziri@weare5stones.com
 executables: []
@@ -63,7 +64,7 @@ files:
 - lib/huginn_http_request_agent.rb
 - lib/huginn_http_request_agent/http_request_agent.rb
 - spec/http_request_agent_spec.rb
-homepage: https://github.com/[my-github-username]/huginn_http_request_agent
+homepage: https://github.com/5-stones/huginn_http_request_agent
 licenses:
 - MIT
 metadata: {}
@@ -82,10 +83,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because Rubygems requires one.
+summary: The Http Request Agent is intended to be an abstract agent that allows for
+  the interaction of any http service.
 test_files:
 - spec/http_request_agent_spec.rb