gorg_service 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c367d16bc5790468c190d509d84e89effef69fbb
-  data.tar.gz: 1951f35a70ffacddb8f1f141df9febeadc890420
+  metadata.gz: 4202710bccd62ba26cc53da5903a84e570bc3ca6
+  data.tar.gz: 7b7a517db9b978955a768471aad1e3685b8a89bd
 SHA512:
-  metadata.gz: 912bc14211df2c260d360023f3e6ee378bb228db615408d46615197bb0db4f0acaa4957aeb10bb1d3ba1c1a2b6e7593fbbb12b99a50467583fce7326b22028b4
-  data.tar.gz: 7c1bc8ac7f5f3268d35b5d481efe7fb2821b5d2abb6fdbfb3389a47c2de453f1b6660bfdd1e267ba4cbbba90318953b4c2e9bf313e8b3a0ef51c8dc430680d2e
+  metadata.gz: 36684953d4b5825695b0b2f5e970c69ea2ba9dc05158180f4db95d6d22bde0369938aa2c448157e4ac4d297eea3a3e843ff7c16487448eda9a14759031135e4b
+  data.tar.gz: bca143a3e2bbbaa1154e92e5f2f1d26f32db5fc5044eac750038e8bdfd2e4d33db3cc4bc42513f902c73c9011322dda24c4b544afbe0ba880b2bbffc77d3ccd3

data/gorg_service.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bogus', '~> 0.1.6'
   spec.add_development_dependency 'bunny-mock', '~> 1.4'
   spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'json-schema'
 end

data/lib/gorg_service/errors.rb

@@ -24,14 +24,14 @@ class GorgService
   #Softfail error : This message should be processed again later
   class SoftfailError < FailError
     def type
-      "softfail"
+      "softerror"
     end
   end
 
   #Hardfail error : This message is not processable and will never be
   class HardfailError < FailError
     def type
-      "hardfail"
+      "harderror"
     end
   end
 end

data/lib/gorg_service/message.rb

@@ -3,6 +3,8 @@
 require 'json'
 require 'time'
 
+require "gorg_service/message/json_schema"
+
 class GorgService
   class Message
 
@@ -10,24 +12,30 @@ class GorgService
     attr_accessor :id
     attr_accessor :data
     attr_accessor :errors
+    attr_accessor :creation_time
+    attr_accessor :sender
 
     def errors
       @errors||=[]
     end
 
 
-    def initialize(id: nil, data: nil, event: nil, errors: [])
-      @id=id || generate_id
+    def initialize(id: generate_id, data: nil, event: nil, creation_time: DateTime.now.iso8601, sender: application_id ,  errors: [])
+      @id=id
       @event=event
       @data=data
       @errors=errors
+      @creation_time=creation_time
+      @sender= sender
     end
 
     # Generate RabbitMQ message body
     def to_json
       body={
-        id: @id,
-        event: @event,
+        event_uuid: @id,
+        event_name: @event,
+        event_sender_id: @sender,
+        event_creation_time: @creation_time,
         data: @data,
       }
       if errors.any?
@@ -39,12 +47,16 @@ class GorgService
 
     # Log FailError in message body
     def log_error error
-      errors<<{
-            type: error.type.downcase,
-            message: error.message,
-            timestamp: Time.now.utc.iso8601,
-            extra: error.error_raised.inspect,
+      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
     end
 
     ### Class methods
@@ -58,10 +70,14 @@ class GorgService
       begin
         json_body=JSON.parse(body)
 
+        JSON::Validator.validate!(GorgService::Message::JSON_SCHEMA,json_body)
+
         msg=self.new(
-            id: json_body["id"],
-            event: json_body["event"],
+            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)},
           )
 
@@ -92,7 +108,11 @@ class GorgService
 
     # Generate new id
     def generate_id 
-      "#{GorgService.configuration.application_id}_#{Time.now.to_i}"
+      SecureRandom.uuid()
+    end
+
+    def application_id
+      GorgService.configuration.application_id
     end
 
    

data/lib/gorg_service/message/json_schema.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'json'
+
+class GorgService
+  class Message
+
+    JSON_SCHEMA = JSON.parse('{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "event_name": {
+      "type": "string",
+      "pattern": "^[_a-z]+((\\.)?[_a-z]+)*$",
+      "description": "Event type. Must match the routing key"
+    },
+    "event_uuid": {
+      "type": "string",
+      "description": "The unique identifier of this message as UUID",
+      "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
+    },
+    "event_creation_time": {
+      "type": "string",
+      "description": "Creation time in UTC ISO 8601 format",
+      "pattern": "^([\\\+-]?\\\d{4}(?!\\\d{2}\\\b))((-?)((0[1-9]|1[0-2])(\\\3([12]\\\d|0[1-9]|3[01]))?|W([0-4]\\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\\d|[12]\\\d{2}|3([0-5]\\\d|6[1-6])))([T\\\s]((([01]\\\d|2[0-3])((:?)[0-5]\\\d)?|24\\\:?00)([\\\.,]\\\d+(?!:))?)?(\\\17[0-5]\\\d([\\\.,]\\\d+)?)?([zZ]|([\\\+-])([01]\\\d|2[0-3]):?([0-5]\\\d)?)?)?)?$"
+    },
+    "event_sender_id": {
+      "type": "string",
+      "description": "Producer that sent the original message"
+    }, 
+    "data": {
+      "type": "object",
+      "description": "Data used to process this message"
+    },
+    "errors_count": {
+      "type": "integer",
+      "description": "Helper for counting errors"
+    },
+    "errors": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "error_type": {
+            "enum": [  "debug", "info", "warning", "softerror", "harderror" ],
+            "description": "Type of error."
+          },
+          "error_sender": {
+            "type": "string",
+            "description": "Consummer that sent this error"
+          },
+          "error_code":{
+            "type":"string",
+            "description": "Optionnal error code from the consummer"
+          },
+          "error_uuid":{
+            "type":"string",
+            "description": "The unique identifier of this error as UUID",
+            "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
+          },
+          "error_message":{
+            "type":"string",
+            "description": "Error explanation"
+          },          
+          "timestamp": {
+            "type": "string",
+            "description": "Time of occuring error in UTC ISO 8601",
+            "pattern": "^([\\\+-]?\\\d{4}(?!\\\d{2}\\\b))((-?)((0[1-9]|1[0-2])(\\\3([12]\\\d|0[1-9]|3[01]))?|W([0-4]\\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\\d|[12]\\\d{2}|3([0-5]\\\d|6[1-6])))([T\\\s]((([01]\\\d|2[0-3])((:?)[0-5]\\\d)?|24\\\:?00)([\\\.,]\\\d+(?!:))?)?(\\\17[0-5]\\\d([\\\.,]\\\d+)?)?([zZ]|([\\\+-])([01]\\\d|2[0-3]):?([0-5]\\\d)?)?)?)?$"
+          },
+          "error_debug": {
+            "type": "object",
+            "description": "Complementary informations for debugging"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "error_type",
+          "error_sender",
+          "timestamp",
+          "error_uuid",
+          "error_message"
+        ]
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "event_name",
+    "event_uuid",
+    "event_creation_time",
+    "event_sender_id",
+    "data"
+  ]
+}')
+
+end
+end

data/lib/gorg_service/message_handler.rb

@@ -9,11 +9,11 @@ class GorgService
     end
 
     def raise_hardfail(message, error:nil)
-      raise HardfailError.new(error), message
+      raise HardfailError.new(message, error)
     end
 
     def raise_softfail(message, error:nil)
-      raise SoftfailError.new(error), message
+      raise SoftfailError.new(message, error)
     end
 
   end

data/lib/gorg_service/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gorg_service
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexandre Narbonne
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - alexandre.narbonne@gadz.org
@@ -151,6 +165,7 @@ files:
 - lib/gorg_service/errors.rb
 - lib/gorg_service/listener.rb
 - lib/gorg_service/message.rb
+- lib/gorg_service/message/json_schema.rb
 - lib/gorg_service/message_handler.rb
 - lib/gorg_service/version.rb
 homepage: https://github.com/Zooip/gorg_service