teneo_grpc 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 175d8a54e092662e21400c371a32748bbb4ded241d7b5a879573626afcdd595a
-  data.tar.gz: d2dc821e57960d193864c1911e44ac7276fc49908e537ad5381f6edf618ea062
+  metadata.gz: d01a40c3bc2bcb7e3e0e15239d29e3105b208c40b8b7ed831d16c461d7a89604
+  data.tar.gz: 2970c61f8ca9b54210af598dcd5793e9f5e87894255ba68dd05df4286edec3ff
 SHA512:
-  metadata.gz: 9b2b5d31ce39eac6e53afbbcc727078865e3b25aba994370349a6a28a77766bb234b05636c1c3d7549cdf0e8a96479cc1780fd1c0154d1d4e8dc04e3ed80ad73
-  data.tar.gz: 4f970f30de576c6b6ed6e93a49e4b17da5b8105ca75931444d59e5a8ee721a25c21feae100af4ff882c99c2310352308a18ddc72985a3189b6f950bada55476e
+  metadata.gz: 99b0ccac0819bf4b72bd5c7d7283603a057b4d2189e2d6252d2fc4de9f4608e4fa8e5d3357dafd5a8df85d2335aa1d4d2ff0fbc16acbe6e17a2933997f51b55b
+  data.tar.gz: 7adeca1870b3ae0ac88f0ce9afda1c09d0e2c6022bb0737222ec295ed2999b44bae287bc55ec258715029c7db4e68b002c958dfdfb52e6c52c91d2d2b388c049

data/Gemfile

@@ -3,6 +3,7 @@
 source 'https://rubygems.org'
 
 gem 'debug', require: false # requires libyaml-dev to be installed on system (Ubuntu)
+gem 'dotenv', groups: %i[development test]
 gem 'grpc'
 gem 'grpc-tools'
 gem 'protobuf'

data/Gemfile.lock

@@ -25,6 +25,7 @@ GEM
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.5.1)
+    dotenv (3.1.7)
     drb (2.2.1)
     google-protobuf (4.29.3)
       bigdecimal
@@ -117,6 +118,7 @@ PLATFORMS
 
 DEPENDENCIES
   debug
+  dotenv
   grpc
   grpc-tools
   protobuf

data/Rakefile

@@ -10,16 +10,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 RuboCop::RakeTask.new
 
-task default: %w[spec rubocop run]
-
-task :setup do
-  sh 'bundle install'
-end
+task default: %w[spec rubocop]
 
 task :proto do
   sh 'grpc_tools_ruby_protoc -I proto --ruby_out=lib/teneo/proto --grpc_out=lib/teneo/proto proto/*.proto'
 end
-
-task :run do
-  ruby 'bin/app.rb'
-end

data/bin/dotenv

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby3.0
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'dotenv' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("dotenv", "dotenv")

data/lib/teneo_grpc/client.rb

@@ -1,80 +1,18 @@
 # frozen_string_literal: true
 
-require_relative 'cloud_event_helpers/cloud_event_helper'
+require_relative 'util/env'
+require_relative 'util/convert'
 require_relative 'grpc_services/cloud_event_enum'
 require_relative 'proto/cloud_event_services_pb'
 
 # Sends data to gRPC services
 class Client
-  attr_accessor :socket
+  attr_accessor :socket, :stub
 
   def initialize(socket:)
+    Env.valid_settings?
+
     @socket = socket
     @stub = CloudEvents::Stub.new(@socket, :this_channel_is_insecure)
   end
-
-  # Example function that sends 1 request and receives 1 response
-  def send_1req_1resp(data:)
-    puts "sending to socket #{@socket}"
-
-    begin
-      event = CloudEventHelper.convert(text_data: data)
-      response = @stub.get_cloud_event(event)
-    rescue GRPC::Unavailable
-      puts "ERROR: failed to connect to host '#{@socket}'"
-    rescue StandardError => e
-      p e
-    end
-
-    response
-  end
-
-  # Example function that sends 1 request and receives a stream of responses
-  def send_1req_streamresp(data:)
-    puts "sending to socket #{@socket}"
-
-    begin
-      event = CloudEventHelper.convert(text_data: data)
-      responses = @stub.send_cloud_events(event)
-    rescue GRPC::Unavailable
-      puts "ERROR: failed to connect to host '#{@socket}'"
-    rescue StandardError => e
-      p e
-    end
-
-    responses
-  end
-
-  # Example function that sends a stream of requests and receives 1 response
-  def send_streamreq_1resp(data:)
-    puts "sending to socket #{@socket}"
-
-    begin
-      requests = CloudEventEnum.new(data: data, amount: 3)
-      response = @stub.get_cloud_events(requests.each)
-    rescue GRPC::Unavailable
-      puts "ERROR: failed to connect to host '#{@socket}'"
-    rescue StandardError => e
-      p e
-    end
-
-    response
-  end
-
-  # Example function that sends a stream of requests
-  # and receives a stream of responses
-  def send_streamreq_streamresp(data:)
-    puts "sending to socket #{@socket}"
-
-    begin
-      requests = CloudEventEnum.new(data: data, amount: 3)
-      responses = @stub.chat(requests.each)
-    rescue GRPC::Unavailable
-      puts "ERROR: failed to connect to host '#{@socket}'"
-    rescue StandardError => e
-      p e
-    end
-
-    responses
-  end
 end

data/lib/teneo_grpc/error_classes/env_settings_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This error should get raised when the environment does not provide
+# the required attributes.
+class EnvSettingsError < StandardError
+  def initialize(msg = 'ERROR: invalid settings in .env file')
+    super(msg)
+  end
+end

data/lib/teneo_grpc/error_classes/socket_format_error.rb

@@ -2,7 +2,7 @@
 
 # This error should get raised when a socket string has an invalid format
 class SocketFormatError < StandardError
-  def initialize(msg = 'ERROR: invalid socket')
+  def initialize(msg = 'invalid socket')
     super(msg)
   end
 end

data/lib/teneo_grpc/grpc_services/cloud_event_enum.rb

@@ -2,24 +2,19 @@
 
 require 'securerandom'
 
+require_relative '../util/convert'
+
 # CloudEventEnum provides an Enumerator of cloud events
 class CloudEventEnum
-  def initialize(data:, amount:)
-    @data = data
-    @amount = amount
+  def initialize(array:)
+    @array = array
   end
 
   def each
     return enum_for(:each) unless block_given?
 
-    (1..@amount).each do
-      yield CloudEvent.new(
-        id: SecureRandom.uuid,
-        source: '/server-context',
-        spec_version: '1.0',
-        type: 'com.example.server-event',
-        text_data: @data
-      )
+    @array.each do |element|
+      yield Convert.text_to_cloudevent(data: element)
     end
   end
 end

data/lib/teneo_grpc/server.rb

@@ -2,15 +2,17 @@
 
 require_relative 'client'
 require_relative 'service_orchestrator'
-require_relative 'grpc_services/cloud_events_service'
+require_relative 'util/env'
 
 # Encapsulating class for all gRPC communication
 class Server
   attr_accessor :socket, :remote_hosts, :clients
 
-  def initialize(socket:, remote_hosts:)
-    @socket = socket
-    @remote_hosts = remote_hosts
+  def initialize
+    Env.valid_settings?
+
+    @socket = "#{ENV["LISTEN_ADDRESS"]}:#{ENV["PORT"]}"
+    @remote_hosts = ENV['REMOTE_HOSTS'].split('|')
 
     @clients = []
     @remote_hosts&.each do |remote|
@@ -20,7 +22,10 @@ class Server
 
     @orchestrator = ServiceOrchestrator.new(socket: @socket)
     @orchestrator.initialize_listener
-    @orchestrator.add(CloudEventsService.new(socket: @socket, clients: @clients))
+  end
+
+  def register_service(service:)
+    @orchestrator.add(service)
   end
 
   def start_listening_for_data

data/lib/teneo_grpc/util/convert.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require_relative '../proto/cloud_event_services_pb'
+require_relative '../grpc_services/cloud_event_enum'
+
+# The Convert module provides functionality on custom data conversion operations.
+module Convert
+  def self.text_to_cloudevent(data:)
+    source = ENV['CLOUDEVENTS_SOURCE']
+    source = "#{ENV["LISTEN_ADDRESS"]}:#{ENV["PORT"]}" if source.nil?
+
+    CloudEvent.new(
+      id: SecureRandom.uuid,
+      source: source,
+      spec_version: ENV['CLOUDEVENTS_SPEC_VERSION'],
+      type: ENV['CLOUDEVENTS_TYPE_PREFIX'],
+      text_data: data
+    )
+  end
+
+  def self.array_to_cloudevent_enum(array:)
+    CloudEventEnum.new(array: array)
+  end
+end

data/lib/teneo_grpc/util/env.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require_relative '../error_classes/env_settings_error'
+require_relative '../error_classes/socket_format_error'
+
+# The Env module provides functionality for env variable settings.
+module Env
+  def self.valid_settings?
+    mandatory_settings = %w[LISTEN_ADDRESS PORT CLOUDEVENTS_SPEC_VERSION CLOUDEVENTS_TYPE_PREFIX]
+    mandatory_settings.each do |setting|
+      raise EnvSettingsError, "environment variable '#{setting}' not found" if ENV[setting].nil?
+    end
+
+    socket = "#{ENV["LISTEN_ADDRESS"]}:#{ENV["PORT"]}"
+    raise SocketFormatError unless socket =~ /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}:\d{1,5}$/
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teneo_grpc
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Ruben Vanoverschelde
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -38,6 +38,7 @@ files:
 - Rakefile
 - bin/bundle
 - bin/console
+- bin/dotenv
 - bin/grpc_tools_ruby_protoc
 - bin/grpc_tools_ruby_protoc_plugin
 - bin/htmldiff
@@ -58,15 +59,15 @@ files:
 - bin/thor
 - lib/teneo_grpc.rb
 - lib/teneo_grpc/client.rb
-- lib/teneo_grpc/cloud_event_helpers/cloud_event_helper.rb
+- lib/teneo_grpc/error_classes/env_settings_error.rb
 - lib/teneo_grpc/error_classes/socket_format_error.rb
-- lib/teneo_grpc/grpc_services/cloud_event_chat_enum.rb
 - lib/teneo_grpc/grpc_services/cloud_event_enum.rb
-- lib/teneo_grpc/grpc_services/cloud_events_service.rb
 - lib/teneo_grpc/proto/cloud_event_pb.rb
 - lib/teneo_grpc/proto/cloud_event_services_pb.rb
 - lib/teneo_grpc/server.rb
 - lib/teneo_grpc/service_orchestrator.rb
+- lib/teneo_grpc/util/convert.rb
+- lib/teneo_grpc/util/env.rb
 homepage: https://github.com/libis/teneo-grpc_skeleton_ruby
 licenses:
 - MIT

data/lib/teneo_grpc/cloud_event_helpers/cloud_event_helper.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-
-require_relative '../proto/cloud_event_services_pb'
-
-# Helper module for all thing CloudEvent related
-module CloudEventHelper
-  def self.convert(text_data:)
-    CloudEvent.new(
-      id: SecureRandom.uuid,
-      source: '/context',
-      spec_version: '1.0',
-      type: 'com.example.event',
-      text_data: text_data
-    )
-  end
-end

data/lib/teneo_grpc/grpc_services/cloud_event_chat_enum.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../cloud_event_helpers/cloud_event_helper'
-
-# CloudEventChatEnum provides an Enumerator for bidirectional communication
-class CloudEventChatEnum
-  def initialize(requests:, default_response:)
-    @requests = requests
-    @default_response = default_response
-  end
-
-  def each
-    return enum_for(:each) unless block_given?
-
-    @requests.each do |request|
-      puts "Received request: '#{request}'"
-      yield CloudEventHelper.convert(text_data: @default_response)
-      # Pause 1 second between messages to show how the messages get exchanged
-      sleep 1
-    end
-  end
-end

data/lib/teneo_grpc/grpc_services/cloud_events_service.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../cloud_event_helpers/cloud_event_helper'
-require_relative '../proto/cloud_event_services_pb'
-require_relative 'cloud_event_chat_enum'
-require_relative 'cloud_event_enum'
-
-# Implements the CloudEvents service defined in proto/cloud_event.proto
-class CloudEventsService < CloudEvents::Service
-  def initialize(socket:, clients:) # rubocop:disable Lint/MissingSuper
-    @socket = socket
-    @message = "ping from #{@socket}"
-    @clients = clients
-  end
-
-  def get_cloud_event(request, _call)
-    puts "Received request: '#{request}'"
-
-    # Forward request to other services if message equals "forward"
-    if request.text_data == 'forward'
-      @clients.each do |client|
-        response = client.send_1req_1resp(data: @message)
-        puts "Reply from: '#{response}'"
-      end
-    end
-
-    CloudEventHelper.convert(text_data: @message)
-  end
-
-  def send_cloud_events(request, _call)
-    puts "Received request: '#{request}'"
-
-    # Forward request to other services if message equals "forward"
-    if request.text_data == 'forward'
-      @clients.each do |client|
-        responses = client.send_1req_streamresp(data: @message)
-
-        responses.each do |response|
-          puts "Reply from: '#{response}'"
-        end
-      end
-    end
-
-    CloudEventEnum.new(data: @message, amount: 3).each
-  end
-
-  def forward_to_services?(call)
-    forward = true
-    call.each_remote_read do |request|
-      puts "Received request: '#{request}'"
-      forward = false unless request.text_data == 'forward'
-    end
-
-    forward
-  end
-
-  def get_cloud_events(call)
-    forward = forward_to_services?(call)
-
-    # Forward request to other services if message equals "forward"
-    if forward
-      @clients.each do |client|
-        response = client.send_streamreq_1resp(data: @message)
-        puts "Reply from: '#{response}'"
-      end
-    end
-
-    CloudEventHelper.convert(text_data: @message)
-  end
-
-  def chat(call)
-    CloudEventChatEnum.new(requests: call, default_response: @message).each
-  end
-end