gorg_service 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73ff949459f530d6de5e500a065a69082b633c13
-  data.tar.gz: f33f7599bf4a38afd2c3c3070757109c45e69f61
+  metadata.gz: 05925a6b430592a5e9c01f98423987239a0302d7
+  data.tar.gz: 55dd773958591108940af27364b2c5707f0d1209
 SHA512:
-  metadata.gz: 1d857d88511bd782177f455248b3ce26d9847916250b8f29658c7e678344fbbabc015570d54e4f5d54e8b461aa706c46578eebb42b696f7bfec9e3891d218255
-  data.tar.gz: bcfb9af25144da6982cabc973c5d1ffb9c70502987bc6faeb7263ce8ad7f9d04fb5e9f946285f98a0e2363d17e8e9876a1d0bcc972bd99aac988f276072676b2
+  metadata.gz: a06683f30182e6942c534c87d4fecea0203ba2e869e8fa1f94ce2d824c7ec6d5454e34b189488312505973d0a6c6c24ed1b5653a2fb73e10ed93569e2334a9c0
+  data.tar.gz: c315f15ab148e9309252d75d4867bd929aa76e7704cf54fb3dee7afb7abbc865283d941732579fbee7217bad23ac382f9369bd04e67164cb6f5ff37bea56d32d

data/README.md

@@ -139,11 +139,26 @@ It provides the following attributes :
 
  - `event` : this is the same as the routing key
  - `id`: message UUID
- - `errors`: `Hash` containing the message error log with previous errors
+ - `errors`: A list of `GorgService::Message::ErrorLog`
  - `data`: `Hash` containing the data to be processed
  - `creation_time`: message emission date as `DateTime`
  - `sender` : message producer id
 
+
+Error log structure :
+
+ - `id` : Error uuid
+ - `type` : Type of error (debug, info, warning, softerror, harderror)
+ - `sender` : Id of service emitting this error
+ - `message` : Error message
+ - `debug` : Hash containing debug infos
+
+## To Do
+
+ - Internal logs using Logger
+ - Allow disable JSON Schema Validation on incomming messages
+ - Message and ErrorLog attributes validation
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/gorg_service/message.rb

@@ -6,6 +6,7 @@ require 'json-schema'
 require 'securerandom'
 
 require "gorg_service/message/json_schema"
+require "gorg_service/message/error_log"
 
 class GorgService
   class Message
@@ -26,7 +27,7 @@ class GorgService
       @id=id
       @event=event
       @data=data
-      @errors=errors
+      @errors=errors&&errors.map{|e| e.is_a?(GorgService::Message::ErrorLog) ? e : GorgService::Message::ErrorLog.parse(e)}
       @creation_time=creation_time
       @sender= sender
     end
@@ -41,7 +42,7 @@ class GorgService
       }
       if errors.any?
         body[:errors_count]=@errors.count
-        body[:errors]=@errors
+        body[:errors]=@errors.map{|e| e.to_h}
       end
       body
     end
@@ -53,16 +54,12 @@ class GorgService
 
     # Log FailError in message body
     def log_error error
-      hsh={
-            error_type: error.type.downcase,
-            error_uuid: generate_id,
-            error_sender: application_id ,
-            error_message: error.message||"",
-            timestamp: DateTime.now.iso8601,
-            error_debug: {internal_error: error.error_raised.inspect},
-          }
-      hsh[:error_debug] = {internal_error: error.error_raised.inspect} if error.error_raised
-      errors<<hsh
+      e=GorgService::Message::ErrorLog.new(
+        type: error.type.downcase,
+        message: error.message||"",
+        debug: error.error_raised && {internal_error: error.error_raised.inspect}
+        )
+      errors<<e
     end
 
     ### Class methods
@@ -78,18 +75,16 @@ class GorgService
 
         JSON::Validator.validate!(GorgService::Message::JSON_SCHEMA,json_body)
 
+        puts json_body["errors"].inspect
+
         msg=self.new(
             id: json_body["event_uuid"],
             event: json_body["event_name"],
             data: convert_keys_to_sym(json_body["data"]),
             creation_time: json_body["event_creation_time"] && DateTime.parse(json_body["event_creation_time"]),
             sender: json_body["event_sender_id"],
-            errors: json_body["errors"]&&json_body["errors"].map{|e| convert_keys_to_sym(e)},
+            errors: json_body["errors"]&&json_body["errors"].map{|e| GorgService::Message::ErrorLog.parse(e)},
           )
-
-        msg.errors=msg.errors.each do |e|
-         e[:timestamp]=(e[:timestamp] ? DateTime.parse(e[:timestamp]) : nil)
-        end
         msg
       rescue JSON::ParserError => e
         raise GorgService::HardfailError.new(e), "Unprocessable message : Unable to parse JSON message body"

data/lib/gorg_service/message/error_log.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'json'
+require 'securerandom'
+
+class GorgService
+  class Message
+    class ErrorLog
+
+      attr_accessor :type, :id, :sender, :message, :timestamp, :debug
+
+      def initialize( type: "info",
+                      id: SecureRandom.uuid,
+                      sender: GorgService.configuration.application_id,
+                      message: "",
+                      timestamp: DateTime.now,
+                      debug: {})
+        @type=type
+        @id=id
+        @sender=sender
+        @message=message
+        @timestamp=timestamp
+        @debug=debug
+      end
+
+      def to_h
+        h={"error_type" => type,
+          "error_uuid" => id,
+          "error_sender" => sender,
+          "error_message" => message,
+          "timestamp" => timestamp.iso8601,
+          }
+        h["error_debug"]= debug if debug
+        h
+      end
+
+      def to_json
+        to_h.to_json
+      end
+
+      class << self
+        def parse(obj)
+          obj=JSON.parse(obj) unless obj.is_a? Hash
+
+          obj=convert_keys_to_sym(obj)
+
+          self.new( type: obj[:error_type],
+                    id: obj[:error_uuid],
+                    sender: obj[:error_sender],
+                    message: obj[:error_message],
+                    timestamp: DateTime.parse(obj[:timestamp]),
+                    debug: obj[:error_debug])
+
+        end
+
+        protected
+
+        def convert_keys_to_sym input_hash
+          s2s = 
+          lambda do |h| 
+            Hash === h ? 
+              Hash[
+                h.map do |k, v| 
+                  [k.respond_to?(:to_sym) ? k.to_sym : k, s2s[v]] 
+                end 
+              ] : h 
+          end
+          s2s[input_hash]
+        end
+
+      end
+
+    end
+  end
+end

data/lib/gorg_service/version.rb

@@ -2,5 +2,5 @@
 # encoding: utf-8
 
 class GorgService
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gorg_service
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexandre Narbonne
@@ -151,6 +151,7 @@ files:
 - lib/gorg_service/errors.rb
 - lib/gorg_service/listener.rb
 - lib/gorg_service/message.rb
+- lib/gorg_service/message/error_log.rb
 - lib/gorg_service/message/json_schema.rb
 - lib/gorg_service/message_handler.rb
 - lib/gorg_service/version.rb