eventq_base 1.15.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e775e37e2b345a940c9c1c639661ed173a077b787dc28efb4245448a218083c
+  data.tar.gz: 5ee3ac3fb1810b18c8f4510cdaa17d98f4d01eac46cdbf960df1da0cd174d765
+SHA512:
+  metadata.gz: 879bccd09f01df061bd0e2ad3ba2e110f38da121358f9ab8ee05f9b41f101dc1df655676546a82dfd64c1abaabe8c7922811d173e539b1ecd22e90943728da3a
+  data.tar.gz: 85d1945fda553fe7d61a272eec97e3443ef247f4f69c7f567e1c1568b9fb79a449811da475f19d7d1aef7e2e5499ba67b75013db4843e2f34f35f383b662429e

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eventq_base"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/eventq_base/configuration.rb

@@ -0,0 +1,33 @@
+module EventQ
+  class Configuration
+
+    def self.serialization_provider=(value)
+      @serialization_provider = value
+    end
+
+    def self.serialization_provider
+      if RUBY_PLATFORM =~ /java/
+        @serialization_provider ||= EventQ::SerializationProviders::JSON_PROVIDER
+      else
+        @serialization_provider ||= EventQ::SerializationProviders::OJ_PROVIDER
+      end
+    end
+
+    def self.signature_provider=(value)
+      @signature_provider = value
+    end
+
+    def self.signature_provider
+      @signature_provider ||= EventQ::SignatureProviders::SHA256
+    end
+
+    def self.signature_secret=(value)
+      @signature_secret = value
+    end
+
+    def self.signature_secret
+      @signature_secret
+    end
+
+  end
+end

data/lib/eventq_base/event_raised_exchange.rb

@@ -0,0 +1,7 @@
+module EventQ
+  class EventRaisedExchange < Exchange
+    def initialize
+      @name = 'eventq.eventraised.ex'
+    end
+  end
+end

data/lib/eventq_base/event_raised_queue.rb

@@ -0,0 +1,7 @@
+module EventQ
+  class EventRaisedQueue < Queue
+    def initialize
+      @name = 'eventq.eventraised'
+    end
+  end
+end

data/lib/eventq_base/eventq_client_contract.rb

@@ -0,0 +1,9 @@
+module EventQ
+  class EventQClientContract
+
+    def raise_event(event_type, event)
+
+    end
+
+  end
+end

data/lib/eventq_base/eventq_logger.rb

@@ -0,0 +1,28 @@
+require 'logger'
+
+module EventQ
+
+  def self.logger
+    return @@logger
+  end
+
+  def self.set_logger(logger)
+    @@logger = logger
+  end
+
+  def self.log(type, message)
+    case type
+      when :info
+        logger.info(message)
+      when :debug
+        logger.debug(message)
+      when :error
+        logger.error(message)
+    end
+  rescue
+    #do nothing
+  end
+
+  EventQ.set_logger(Logger.new(STDOUT))
+
+end

data/lib/eventq_base/exceptions/invalid_signature_exception.rb

@@ -0,0 +1,9 @@
+module EventQ
+  module Exceptions
+    class InvalidSignatureException < StandardError
+      def initialize(message = "Invalid message signature.")
+        super(message)
+      end
+    end
+  end
+end

data/lib/eventq_base/exceptions.rb

@@ -0,0 +1 @@
+require_relative 'exceptions/invalid_signature_exception'

data/lib/eventq_base/exchange.rb

@@ -0,0 +1,5 @@
+module EventQ
+  class Exchange
+    attr_accessor :name
+  end
+end

data/lib/eventq_base/message_args.rb

@@ -0,0 +1,19 @@
+module EventQ
+  class MessageArgs
+    attr_reader :type
+    attr_reader :content_type
+    attr_reader :retry_attempts
+    attr_accessor :abort
+    attr_accessor :drop
+    attr_reader :context
+
+    def initialize(type:, retry_attempts:, context: {}, content_type:)
+      @type = type
+      @retry_attempts = retry_attempts
+      @abort = false
+      @drop = false
+      @context = context
+      @content_type = content_type
+    end
+  end
+end

data/lib/eventq_base/nonce_manager.rb

@@ -0,0 +1,57 @@
+module EventQ
+  class NonceManager
+
+    def self.configure(server:,timeout:10000,lifespan:3600000)
+      @server_url = server
+      @timeout = timeout
+      @lifespan = lifespan
+    end
+
+    def self.server_url
+      @server_url
+    end
+
+    def self.timeout
+      @timeout
+    end
+
+    def self.lifespan
+      @lifespan
+    end
+
+    def self.is_allowed?(nonce)
+      if @server_url == nil
+        return true
+      end
+
+      require 'redlock'
+      lock = Redlock::Client.new([ @server_url ]).lock(nonce, @timeout)
+      if lock == false
+        EventQ.log(:info, "[#{self.class}] - Message has already been processed: #{nonce}")
+        return false
+      end
+
+      return true
+    end
+
+    def self.complete(nonce)
+      if @server_url != nil
+        Redis.new(url: @server_url).expire(nonce, @lifespan)
+      end
+      return true
+    end
+
+    def self.failed(nonce)
+      if @server_url != nil
+        Redis.new(url: @server_url).del(nonce)
+      end
+      return true
+    end
+
+    def self.reset
+      @server_url = nil
+      @timeout = nil
+      @lifespan = nil
+    end
+  end
+end

data/lib/eventq_base/queue.rb

@@ -0,0 +1,23 @@
+module EventQ
+  class Queue
+    attr_accessor :name
+    attr_accessor :allow_retry
+    attr_accessor :retry_delay
+    attr_accessor :max_retry_attempts
+    attr_accessor :allow_retry_back_off
+    attr_accessor :max_retry_delay
+    attr_accessor :require_signature
+
+    def initialize
+      @allow_retry = false
+      #default retry delay is 30 seconds
+      @retry_delay = 30000
+      #default max retry attempts is 5
+      @max_retry_attempts = 5
+      #default retry back off settings
+      @allow_retry_back_off = false
+      #default require signature to false
+      @require_signature = false
+    end
+  end
+end

data/lib/eventq_base/queue_message.rb

@@ -0,0 +1,31 @@
+module EventQ
+  class QueueMessage
+    extend ClassKit
+
+    attr_accessor_type :id, type: String
+    attr_accessor_type :retry_attempts, type: Integer
+    attr_accessor_type :type, type: String
+    attr_accessor_type :content
+    attr_accessor_type :content_type, type: String
+    attr_accessor_type :created, type: Time
+    attr_accessor_type :signature, type: String
+    attr_accessor_type :context, type: Hash
+
+    def initialize
+      @retry_attempts = 0
+      @created = Time.now.to_i
+      @id = SecureRandom.uuid
+      @context = {}
+    end
+
+    # Creates a signature for the message
+    #
+    # @param provider [EventQ::SignatureProviders::Sha256SignatureProvider] Signature provider that implements
+    #   a write method
+    def sign(provider)
+      return unless EventQ::Configuration.signature_secret
+
+      self.signature = provider.write(message: self, secret: EventQ::Configuration.signature_secret)
+    end
+  end
+end

data/lib/eventq_base/queue_worker_contract.rb

@@ -0,0 +1,23 @@
+module EventQ
+  # Contract class for queue workers
+  class QueueWorkerContract
+
+    def start(queue, options = {}, &block)
+
+    end
+
+    def stop
+
+    end
+
+    def on_retry_exceeded(&block)
+
+    end
+
+    def running?
+
+    end
+
+  end
+end
+

data/lib/eventq_base/serialization_providers/binary_serialization_provider.rb

@@ -0,0 +1,15 @@
+module EventQ
+  module SerializationProviders
+    class BinarySerializationProvider
+
+      def serialize(object)
+        Marshal::dump(object)
+      end
+
+      def deserialize(msg)
+        Marshal::load(msg)
+      end
+
+    end
+  end
+end

data/lib/eventq_base/serialization_providers/json_serialization_provider.rb

@@ -0,0 +1,28 @@
+module EventQ
+  module SerializationProviders
+    class JsonSerializationProvider
+
+      def initialize
+        require 'class_kit'
+        require 'hash_kit'
+        @class_kit_helper = ClassKit::Helper.new
+        @hash_helper = HashKit::Helper.new
+      end
+
+      def serialize(object)
+        JSON.dump(object_to_hash(object))
+      end
+
+      def deserialize(json)
+        return @class_kit_helper.from_json(json: json, klass: EventQ::QueueMessage)
+      end
+
+      private
+
+      def object_to_hash(object)
+        return object if object.is_a?(Hash)
+        @hash_helper.to_hash(object)
+      end
+    end
+  end
+end

data/lib/eventq_base/serialization_providers/oj_serialization_provider.rb

@@ -0,0 +1,24 @@
+module EventQ
+  module SerializationProviders
+    class OjSerializationProvider
+
+      def initialize
+        require 'oj'
+        @json_serializer = EventQ::SerializationProviders::JsonSerializationProvider.new
+      end
+
+      def serialize(object)
+        return Oj.dump(object, mode: :object)
+      end
+
+      def deserialize(json)
+        begin
+          return Oj.load(json)
+        rescue Oj::ParseError
+          EventQ.log(:debug, "[#{self.class}] - Failed to deserialize using Oj, falling back to JsonSerializationProvider.")
+          return @json_serializer.deserialize(json)
+        end
+      end
+    end
+  end
+end

data/lib/eventq_base/serialization_providers.rb

@@ -0,0 +1,33 @@
+require_relative 'serialization_providers/json_serialization_provider'
+unless RUBY_PLATFORM =~ /java/
+  require_relative 'serialization_providers/oj_serialization_provider'
+end
+require_relative 'serialization_providers/binary_serialization_provider'
+
+module EventQ
+  module SerializationProviders
+
+    OJ_PROVIDER = 'oj'.freeze
+    JSON_PROVIDER = 'json'.freeze
+    BINARY_PROVIDER = 'binary'.freeze
+
+    class Manager
+      def initialize
+        @providers = {}
+        unless RUBY_PLATFORM =~ /java/
+          @providers[OJ_PROVIDER] = EventQ::SerializationProviders::OjSerializationProvider
+        end
+        @providers[JSON_PROVIDER] = EventQ::SerializationProviders::JsonSerializationProvider
+        @providers[BINARY_PROVIDER] = EventQ::SerializationProviders::BinarySerializationProvider
+      end
+
+      def get_provider(provider_type)
+        provider = @providers[provider_type]
+        if provider == nil
+          raise "Invalid provider type specified: #{provider_type}"
+        end
+        return provider.new
+      end
+    end
+  end
+end

data/lib/eventq_base/signature_providers/sha256_signature_provider.rb

@@ -0,0 +1,31 @@
+module EventQ
+  module SignatureProviders
+    class Sha256SignatureProvider
+
+      def initialize
+        require 'openssl'
+        require 'base64'
+        @serializer = serialization_provider_manager.get_provider(EventQ::Configuration.serialization_provider)
+      end
+
+      #This method is called to create a signature for a message
+      def write(message:, secret:)
+        json = @serializer.serialize(message.content)
+        hash = OpenSSL::HMAC.digest('sha256', secret, json)
+        Base64.encode64(hash)
+      end
+
+      #This method is called to validate a message signature
+      def valid?(message:, secret:)
+        signature = write(message: message, secret: secret)
+        message.signature == signature
+      end
+
+      private
+
+      def serialization_provider_manager
+        EventQ::SerializationProviders::Manager.new
+      end
+    end
+  end
+end

data/lib/eventq_base/signature_providers.rb

@@ -0,0 +1,44 @@
+require_relative 'signature_providers/sha256_signature_provider'
+
+module EventQ
+  module SignatureProviders
+
+    SHA256 = 'sha256'.freeze
+
+    class Manager
+      def initialize
+        @providers = {}
+        @providers[SHA256] = EventQ::SignatureProviders::Sha256SignatureProvider
+      end
+
+      #This method is called to get a signature provider
+      def get_provider(provider_type)
+        provider = @providers[provider_type]
+        if provider == nil
+          raise "Invalid provider type specified: #{provider_type}"
+        end
+        return provider.new
+      end
+
+      #This method is called to validate a queue message's signature
+      def validate_signature(message:, queue:)
+        valid = true
+
+        if queue.require_signature == true && message.signature == nil
+          valid = false
+        elsif message.signature != nil
+          provider = get_provider(EventQ::Configuration.signature_provider)
+          valid = provider.valid?(message: message, secret: EventQ::Configuration.signature_secret)
+        end
+
+        if !valid
+          raise EventQ::Exceptions::InvalidSignatureException.new
+        end
+
+        true
+
+      end
+
+    end
+  end
+end

data/lib/eventq_base/subscription_manager_contract.rb

@@ -0,0 +1,13 @@
+module EventQ
+  class SubscriptionManagerContract
+
+    def subscribe(event_type, queue)
+
+    end
+
+    def unsubscribe(queue)
+
+    end
+
+  end
+end

data/lib/eventq_base/version.rb

@@ -0,0 +1,3 @@
+module EventqBase
+  VERSION = "1.15.0"
+end

data/lib/eventq_base/worker_id.rb

@@ -0,0 +1,20 @@
+module EventQ
+  # Module to be used by concrete worker classes to tag each thread working on a message
+  # Allows to be used in custom logging to track group of log messages per queue message processing.
+  module WorkerId
+    def tag_processing_thread
+      Thread.current[key_name] = SecureRandom.uuid
+    end
+
+    def untag_processing_thread
+      Thread.current[key_name] = nil
+    end
+
+    private
+
+    def key_name
+      'worker_id'.freeze
+    end
+
+  end
+end

data/lib/eventq_base.rb

@@ -0,0 +1,26 @@
+require 'securerandom'
+require 'redlock'
+require 'class_kit'
+require 'hash_kit'
+
+
+require_relative 'eventq_base/version'
+require_relative 'eventq_base/eventq_logger'
+require_relative 'eventq_base/queue'
+require_relative 'eventq_base/exchange'
+require_relative 'eventq_base/queue_message'
+require_relative 'eventq_base/message_args'
+require_relative 'eventq_base/queue_worker_contract'
+require_relative 'eventq_base/event_raised_exchange'
+require_relative 'eventq_base/event_raised_queue'
+require_relative 'eventq_base/subscription_manager_contract'
+require_relative 'eventq_base/eventq_client_contract'
+require_relative 'eventq_base/configuration'
+require_relative 'eventq_base/serialization_providers'
+require_relative 'eventq_base/worker_id'
+require_relative 'eventq_base/nonce_manager'
+require_relative 'eventq_base/signature_providers'
+require_relative 'eventq_base/exceptions'
+
+
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: eventq_base
+version: !ruby/object:Gem::Version
+  version: 1.15.0
+platform: java
+authors:
+- vaughanbrittonsage
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2017-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: class_kit
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: redlock
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: jruby-openssl
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem contains the base classes and contracts required by any eventq
+  implementations.
+email:
+- vaughanbritton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/setup
+- lib/eventq_base.rb
+- lib/eventq_base/configuration.rb
+- lib/eventq_base/event_raised_exchange.rb
+- lib/eventq_base/event_raised_queue.rb
+- lib/eventq_base/eventq_client_contract.rb
+- lib/eventq_base/eventq_logger.rb
+- lib/eventq_base/exceptions.rb
+- lib/eventq_base/exceptions/invalid_signature_exception.rb
+- lib/eventq_base/exchange.rb
+- lib/eventq_base/message_args.rb
+- lib/eventq_base/nonce_manager.rb
+- lib/eventq_base/queue.rb
+- lib/eventq_base/queue_message.rb
+- lib/eventq_base/queue_worker_contract.rb
+- lib/eventq_base/serialization_providers.rb
+- lib/eventq_base/serialization_providers/binary_serialization_provider.rb
+- lib/eventq_base/serialization_providers/json_serialization_provider.rb
+- lib/eventq_base/serialization_providers/oj_serialization_provider.rb
+- lib/eventq_base/signature_providers.rb
+- lib/eventq_base/signature_providers/sha256_signature_provider.rb
+- lib/eventq_base/subscription_manager_contract.rb
+- lib/eventq_base/version.rb
+- lib/eventq_base/worker_id.rb
+homepage: https://github.com/vaughanbrittonsage/eventq
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
+specification_version: 4
+summary: This gem contains the base classes and contracts required by any eventq implementations.
+test_files: []