strum-esb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 100cac09566f7c972a3ea3cb7005fc3c57ecc20cc7cb4e159b43dcf4b5d9bc24
-  data.tar.gz: dd290413c6ae5f8cc50659a487bc656500c04cd27d289cf13f10eaea14e90343
+  metadata.gz: 115db6eaed48ee3c437b15fbf8103815214a5cdcc4d0d040960fc6ad73708190
+  data.tar.gz: dd0f567ec63c61781272ea0931a7348be7df38de6661b5d9da77ccf55e17855d
 SHA512:
-  metadata.gz: c1a9a87ba8f0207f0de46d08f19229835e29ab844f2053f38a0eb484efc191460d83a6d5e87421d1d4df09152138e753f93705035b4866c6f0ff502b2cffdadf
-  data.tar.gz: b3f3d16931dd745a09a7cfbe938b9170c8e4efb4bf511f7de796595ad43ec683cf72c4865cbfe838ee91005b5df1431b32fa12a09fa5426a176a2f99ede62bc3
+  metadata.gz: 3275b5108de6e8f5ac0bf8413d8fb53e0939855c9621fb1ac054b5ae9ecc693ff368a5d55d5e794956f75f038ba106eb4c3452c377b273eda7e064f713b6b605
+  data.tar.gz: 679fc2e04636143bbfcceb7fba20cb79972475313ed2731977035b1ceb21ca981d77247b03fc668c92d3e809894edeae16e5b74f92afbde55b2d21a77f287c4d

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2022-03-14
+### Added
+- `content_type` option to send message by [@valeriia.kolisnyk]
+- serialization/deserialization for protobuf by [@valeriia.kolisnyk]
+- `json` and `protobuf_service` switchers for handler by [@valeriia.kolisnyk]
+
 ## [0.1.1] - 2021-06-01
 ### Added
 - `pre_publish_hooks` to configuration by [@Samuron]

data/Gemfile

@@ -13,3 +13,4 @@ gem "rubocop-rspec", "~> 2.3.0"
 gem "debase", "~> 0.2.4"
 gem "ruby-debug-ide", "~> 0.7.2"
 
+gem "dry-inflector", "~> 0.2.1"

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    strum-esb (0.2.0)
+    strum-esb (0.3.0)
       bunny (~> 2.15)
       connection_pool (~> 2.2.2)
       dry-configurable (~> 0.12.1)
+      dry-inflector (~> 0.2.1)
       json (~> 2.3)
       sneakers (~> 2.12)
 
@@ -27,13 +28,14 @@ GEM
       dry-core (~> 0.5, >= 0.5.0)
     dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    json (2.5.1)
+    dry-inflector (0.2.1)
+    json (2.6.1)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (12.3.3)
-    rbtree (0.4.4)
+    rbtree (0.4.5)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -68,7 +70,7 @@ GEM
     ruby-progressbar (1.11.0)
     serverengine (2.1.1)
       sigdump (~> 0.2.2)
-    set (1.0.1)
+    set (1.0.2)
     sigdump (0.2.4)
     sneakers (2.12.0)
       bunny (~> 2.14)
@@ -79,7 +81,7 @@ GEM
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
-    thor (1.1.0)
+    thor (1.2.1)
     unicode-display_width (2.0.0)
 
 PLATFORMS
@@ -88,6 +90,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.1.4)
   debase (~> 0.2.4)
+  dry-inflector (~> 0.2.1)
   rspec (~> 3)
   rubocop (~> 1.15)
   rubocop-rspec (~> 2.3.0)

data/README.md

@@ -94,6 +94,45 @@ module Queues
 end
 ```
 
+### Sending protobuf via strum-esb
+1. Encode your protobuf message using `encode` method to send it.
+2. Define `protobuf_service` in your handler, and disable `json`:
+
+```ruby
+require "strum/esb"
+require "contracts/test_pb"
+
+module Queues
+  class Resource
+    include Strum::Esb::Handler
+
+    json false
+    protobuf_service Test::Router::Service
+    from_queue "resource-queue",
+               bindings: {
+                 events: %w[user/create user/update],
+                 
+               }
+
+    def handler(payload)
+      # code here ...
+    end
+  end
+end
+```
+
+Your rpc action must have the same name as your method in queue class, for example: if method is `action_get_user`, rpc action needs to be `ActionGetUser`.
+
+3. Pass content type as additional param when you send Strum::Esb message:
+```ruby
+Strum::Esb::Action.call("payload", "action", "resource", content_type: "application/x-protobuf")
+```
+or add it as before_publish_hook:
+```ruby
+Strum::Esb.config.before_publish_hooks << lambda { |_body, properties|
+  properties[:content_type] = "application/x-protobuf"
+}
+```
 
 ## Development
 

data/lib/strum/esb/handler.rb

@@ -30,12 +30,19 @@ module Strum
         def handlers
           @handlers || {}
         end
+
+        def protobuf_service(service)
+          Strum::Esb.config.protobuf_service = service
+        end
+
+        def json(switcher)
+          Strum::Esb.config.json = switcher
+        end
       end
 
       def work_with_params(deserialized_msg, delivery_info, metadata)
         Strum::Esb.config.before_handler_hooks.each { |hook| hook.call(deserialized_msg, delivery_info, metadata) }
 
-        payload = JSON.parse(deserialized_msg)
         snake_case_modify = ->(string) { string.nil? ? nil : string&.to_s.gsub(/[^a-zA-Z0-9]/, "_")&.downcase }
         parse_header = ->(string) { metadata[:headers] && metadata[:headers][string] }
         header = parse_header >> snake_case_modify
@@ -64,6 +71,18 @@ module Strum
 
         method_name = ([*methods_names] << "handler").find { |n| respond_to?(n, include_all: true) }
 
+        unless Strum::Esb.config.serializer.enabled?(metadata[:content_type])
+          logger.error "Content type #{metadata[:content_type]} is disabled by handler. Message rejected #{metadata[:headers]} with payload #{deserialized_msg}"
+          return reject!
+        end
+
+        payload, valid_payload = Strum::Esb.config.serializer.deserialize(deserialized_msg, metadata[:content_type], method_name)
+
+        unless valid_payload
+          logger.error "Content type is invalid. Message rejected #{metadata[:headers]} with payload #{payload}"
+          return reject!
+        end
+
         unless method_name
           logger.error "Handler not found. Message rejected #{metadata[:headers]} with payload #{payload}"
           return reject!
@@ -83,7 +102,7 @@ module Strum
         error = e
         logger.error e
         reject!
-      ensure 
+      ensure
         Strum::Esb.config.after_handler_hooks.each { |hook| hook.call(deserialized_msg, delivery_info, metadata, payload, error) }
       end
 

data/lib/strum/esb/message.rb

@@ -5,11 +5,11 @@ module Strum
     # Strum Message
     class Message
       class << self
-        def publish(exchange:, headers:, payload:)
+        def publish(exchange:, headers:, payload:, content_type: "application/json")
           rabbit_exchange ||= Strum::Esb.config.rabbit_channel_pool.with { |rabbit_channel| rabbit_channel.headers(exchange, durable: true) }
           properties = {
             headers: headers,
-            content_type: "application/json"
+            content_type: content_type
           }
 
           Strum::Esb.config.before_publish_hooks.each { |hook| hook.call(payload, properties) }
@@ -21,8 +21,14 @@ module Strum
             payload["chain"] ||= chain
             headers["chain"] ||= chain
           end
-          
-          rabbit_exchange.publish(payload.to_json, **properties)
+
+          payload, valid_payload = Strum::Esb.config.serializer.serialize(payload, properties[:content_type])
+          unless valid_payload
+            Sneakers.logger.error "Content type is invalid. Message rejected #{properties[:headers]} with payload #{payload}"
+            return
+          end
+
+          rabbit_exchange.publish(payload, **properties)
         end
       end
     end

data/lib/strum/esb/serializer.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Strum
+  module Esb
+    # Payload serializer/deserializer
+    class Serializer
+      CONTENT_TYPES = %w[application/json application/x-protobuf].freeze
+
+      %i[serialize deserialize].each do |base_method|
+        define_method base_method do |payload, content_type, queue_method_name = nil|
+          return [payload, false] unless valid_content_type?(content_type)
+
+          perform_method_name = content_type_method_name(base_method, content_type)
+          payload = send(*[perform_method_name, payload, queue_method_name].compact)
+          [payload, true]
+        rescue StandardError
+          [payload, false]
+        end
+      end
+
+      def enabled?(content_type)
+        case data_type(content_type)
+        when "json"
+          Strum::Esb.config.json
+        when "protobuf"
+          Strum::Esb.config.protobuf_service
+        else
+          false
+        end
+      end
+
+      private
+
+        def valid_content_type?(content_type)
+          CONTENT_TYPES.include?(content_type)
+        end
+
+        def content_type_method_name(action, content_type)
+          "#{action}_#{data_type(content_type)}"
+        end
+
+        def data_type(content_type)
+          content_type.gsub("-", "/").split("/").last
+        end
+
+        def deserialize_json(payload, _queue_method_name)
+          JSON.parse(payload)
+        end
+
+        def deserialize_protobuf(payload, queue_method_name)
+          action_name = inflector.camelize(queue_method_name)
+          rpc_struct = Strum::Esb.config.protobuf_service.rpc_descs[action_name.to_sym]
+          rpc_struct.input.decode(payload)
+        end
+
+        def serialize_json(payload)
+          payload.to_json
+        end
+
+        def serialize_protobuf(payload)
+          payload
+        end
+
+        def inflector
+          Dry::Inflector.new
+        end
+    end
+  end
+end

data/lib/strum/esb/version.rb

@@ -2,6 +2,6 @@
 
 module Strum
   module Esb
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/strum/esb.rb

@@ -15,6 +15,8 @@ require "strum/esb/event"
 require "strum/esb/notice"
 require "strum/esb/info"
 require "dry/configurable"
+require "dry/inflector"
+require "strum/esb/serializer"
 
 module Strum
   module Esb
@@ -38,6 +40,9 @@ module Strum
     setting :before_publish_hooks, []
     setting :before_handler_hooks, []
     setting :after_handler_hooks, []
+    setting :serializer, Serializer.new
+    setting :protobuf_service, false
+    setting :json, true
 
     Strum::Esb.config.before_fork_hooks << proc { DB.disconnect } if defined?(DB)
 

data/strum-esb.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bunny", "~> 2.15"
   spec.add_dependency "connection_pool", "~> 2.2.2"
   spec.add_dependency "dry-configurable", "~> 0.12.1"
+  spec.add_dependency "dry-inflector", "~> 0.2.1"
   spec.add_dependency "json", "~> 2.3"
   spec.add_dependency "sneakers", "~> 2.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strum-esb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Serhiy Nazarov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +121,7 @@ files:
 - lib/strum/esb/info.rb
 - lib/strum/esb/message.rb
 - lib/strum/esb/notice.rb
+- lib/strum/esb/serializer.rb
 - lib/strum/esb/version.rb
 - lib/strum/patch/sneakers/queue_patch.rb
 - strum-esb.gemspec