conrad 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb4af3e930e6793ecb9a869e52c0150ea2aa87753b3f062713c872b5042ea754
-  data.tar.gz: 73c9bdc8e25b35527cf7064c934ef4a5762c2705c2b6c1c22bcc56c102fab547
+  metadata.gz: fd153974202827badd3ab0b1e74ac823ac9ad67d7ac17ae627afcd0c9c9c5f93
+  data.tar.gz: b549b8ac875f6b0654f693c751946192158538ba3d56fc29b3e4bb896e665467
 SHA512:
-  metadata.gz: e16f4db32806aa47a4411a6b9dbc5964eb522f477f48d2e97995839636b0b66e73bbc6392f02756d12e4a9f8244d1f17d6693a17082c08a5ac623de2408495dd
-  data.tar.gz: a866c01f282c5cfa5b1b71c83d9653dd697f25252f448d3df1b772d05bcc838bf127f4fb92a36f3848372ded0aac1473ca68761620a1309a0ce00456a9a18d99
+  metadata.gz: e304189667f80f0e6e7e8a206881d9cfa17d4289d1737ce0c7f96b655a97da5c266f8e3435586bfe9e2b3d3e8b88a112485d27bc53bf3ee5c29a72525a69d896
+  data.tar.gz: 3c95e0f400d386782d8dd00f1ff8203e67f46799b8fa93a538c4419ca5b58fe326d1fcbb6672939a6c12b1fc7e9358e42ddb737247dfa2cb60c725770fc4b9d8

data/lib/conrad/emitters/sqs.rb

@@ -0,0 +1,28 @@
+module Conrad
+  # A module containing all of conrad's built in event emitters for outputting events
+  module Emitters
+    # Basic emitter for sending events to AWS's sqs.
+    class Sqs
+      attr_reader :queue_url, :region, :access_key_id, :secret_access_key
+
+      # Takes in and stores SQS region, url and creds for accessing a queue.
+      def initialize(queue_url:, region:, access_key_id:, secret_access_key:)
+        @queue_url = queue_url
+        @region = region
+        @access_key_id = access_key_id
+        @secret_access_key = secret_access_key
+
+        @client ||= Aws::SQS::Client.new(
+          region: region,
+          access_key_id: access_key_id,
+          secret_access_key: secret_access_key
+        )
+      end
+
+      # Sends an event up to SQS
+      def call(event)
+        @client.send_message(queue_url: queue_url, message_body: event)
+      end
+    end
+  end
+end

data/lib/conrad/emitters/stdout.rb

@@ -0,0 +1,11 @@
+module Conrad
+  module Emitters
+    # Basic emitter for sending events to $stdout.
+    class Stdout
+      # Puts an event to $stdout.
+      def call(event)
+        puts event
+      end
+    end
+  end
+end

data/lib/conrad/formatters/json.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Conrad
+  # A module containing all of conrad's event formatters.
+  module Formatters
+    # Formats a given Hash into a presentable JSON format.
+    class JSON
+      # Formats a given Hash into a presentable JSON format.
+      #
+      # @param event [Hash] event to be formatted
+      #
+      # @return [String] JSON formatted string
+      def call(event)
+        event.to_json
+      end
+    end
+  end
+end

data/lib/conrad/processors/add_timestamp.rb

@@ -0,0 +1,54 @@
+require 'conrad/errors'
+
+module Conrad
+  module Processors
+    # Used to add timestamps to an audit event in seconds or milliseconds.
+    #
+    # @!attribute [r] generator
+    #    object used to generate the timestamp
+    class AddTimestamp
+      # :nodoc:
+      class Error < Conrad::Error; end
+
+      # Types of units supported for generation.
+      ALLOWED_TIME_UNITS = %i[milliseconds seconds].freeze
+
+      attr_reader :generator, :timestamp_key
+
+      # Creates a new instance of AddTimestmap processor
+      #
+      # @param units [Symbol] type of time units for the timestamp generated.
+      #   Allows :seconds or :milliseconds.
+      # @param timestamp_key [Symbol] key to add to the event hash.
+      # @raise [ArgumentError] if the given units value is not one of
+      #   ALLOWED_TIME_UNITS
+      def initialize(units: :milliseconds, timestamp_key: :timestamp)
+        unless ALLOWED_TIME_UNITS.include? units
+          raise ArgumentError, "Provided units of `#{units}` must be one of #{ALLOWED_TIME_UNITS}"
+        end
+
+        @generator = generator_from_units(units)
+        @timestamp_key = timestamp_key
+      end
+
+      # Generates and adds a timestamp to the provided Hash.
+      #
+      # @param event [Hash]
+      # @return [Hash]
+      def call(event)
+        event.merge(timestamp_key => generator.call)
+      end
+
+      private
+
+      def generator_from_units(units)
+        case units
+        when :milliseconds then -> { (Time.now.to_f * 1000).to_i }
+        when :seconds then -> { Time.now.to_i }
+        else
+          raise UnrecognizedTimeUnit, units
+        end
+      end
+    end
+  end
+end

data/lib/conrad/processors/add_uuid.rb

@@ -0,0 +1,27 @@
+require 'securerandom'
+
+module Conrad
+  # A module containing conrad's processors. They're used to modify events or add metadata before being output.
+  module Processors
+    # Generalized processor for inserting a UUID into the event. Allows
+    # configuring the key used for insertion.
+    #
+    # @!attribute [r] uuid_key
+    #    The key inserted into the event hash for the generated UUID.
+    class AddUUID
+      attr_reader :uuid_key
+
+      # @param uuid_key [Symbol] key to use for the generated UUID
+      def initialize(uuid_key = :event_uuid)
+        @uuid_key = uuid_key
+      end
+
+      # @param event [Hash] the current event
+      #
+      # @return [Hash] the hash with the UUID inserted
+      def call(event)
+        event.merge(uuid_key => SecureRandom.uuid)
+      end
+    end
+  end
+end

data/lib/conrad/processors/envelope.rb

@@ -0,0 +1,45 @@
+module Conrad
+  module Processors
+    # Processor class used to take a given event, extract a set of attributes from
+    # it, then wrap the remaining attributes into a payload attribute. This allows
+    # downstream consumers to know about the outermost structure (the envelope)
+    # without needing to account for all possible permutations of the event. This
+    # also allows routing through various systems on a small number of values. If
+    # a given envelope key does not exist in the original event, then it will be
+    # set to nil in the resulting event.
+    #
+    # When using this processor, it is highly recommended that this be the last
+    # processor unless you need to act on the wrapped event.
+    #
+    # @attribute envelope_keys [r]
+    # @attribute payload_key [r]
+    class Envelope
+      attr_reader :envelope_keys, :payload_key
+
+      # @param envelope_keys [Array<Symbol>] the keys to extract from the event.
+      #   NOTE: These must be exact matches of both value and type (i.e. Strings
+      #   and Symbols should not be considered interchangeable, and the event
+      #   must be created with the attribute keys matching the types given here)
+      # @param payload_key [Symbol] key to wrap the remainder of the event inside
+      #
+      # @raise [TypeError] if the envelope_keys argument is not an Array
+      def initialize(envelope_keys, payload_key: :payload)
+        raise TypeError, 'envelope_keys must be an Array' unless envelope_keys.is_a? Array
+
+        @envelope_keys = envelope_keys
+        @payload_key = payload_key
+      end
+
+      # @param event [Hash] event to be wrapped in the configured envelope
+      #
+      # @return [Hash] the wrapped event
+      def call(event)
+        envelope = envelope_keys.each_with_object({}) do |key, obj|
+          obj[key] = event.delete(key)
+        end
+
+        envelope.merge(payload_key => event)
+      end
+    end
+  end
+end

data/lib/conrad/processors.rb

@@ -0,0 +1 @@
+Dir['conrad/processors/*.rb'].each { |file| require file }

data/lib/conrad/recorder.rb

@@ -1,6 +1,6 @@
 require 'conrad/errors'
-require 'conrad/stdout_emitter'
-require 'conrad/json_formatter'
+require 'conrad/emitters/stdout'
+require 'conrad/formatters/json'
 
 module Conrad
   # Provides the ability to record an event took place.
@@ -10,12 +10,12 @@ module Conrad
   #
   # @!attribute [r] formatter
   #    Configured formatter for creating the final event. Defaults to
-  #    JSONFormatter.
-  #    @see Conrad::JSONFormatter
+  #    JSON.
+  #    @see Conrad::JSON
   # @!attribute [r] emitter
   #    Configured emitter for sending the final event. Defaults to
-  #    StdoutEmitter.
-  #    @see Conrad::StdoutEmitter
+  #    Stdout.
+  #    @see Conrad::Stdout
   # @!attribute [r] processors
   #    Configured processors for processing the event pre-formatting and
   #    emission. Defaults to an empty array.
@@ -31,7 +31,11 @@ module Conrad
     #
     # @raise [ArgumentError] if the formatter, emitter, or any of the
     #   processors do not respond_to? `call` with a truthy value.
-    def initialize(formatter: JSONFormatter.new, emitter: StdoutEmitter.new, processors: [])
+    def initialize(
+      formatter: Conrad::Formatters::JSON.new,
+      emitter: Conrad::Emitters::Stdout.new,
+      processors: []
+    )
       check_callability(formatter: formatter, emitter: emitter, processors: processors)
 
       @formatter = formatter

data/lib/conrad/version.rb

@@ -1,5 +1,5 @@
 # :nodoc:
 module Conrad
   # :nodoc:
-  VERSION = '1.0.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/conrad.rb

@@ -1,4 +1,7 @@
-require 'conrad/recorder'
+Gem.find_files('conrad/processors/*.rb').each { |file| require file }
+Gem.find_files('conrad/formatters/*.rb').each { |file| require file }
+Gem.find_files('conrad/emitters/*.rb').each { |file| require file }
+Gem.find_files('conrad/*.rb').each { |file| require file }
 
 # :nodoc:
 module Conrad

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: conrad
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonathon Anderson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -60,12 +74,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/conrad.rb
-- lib/conrad/add_timestamp.rb
-- lib/conrad/add_uuid.rb
+- lib/conrad/emitters/sqs.rb
+- lib/conrad/emitters/stdout.rb
 - lib/conrad/errors.rb
-- lib/conrad/json_formatter.rb
+- lib/conrad/formatters/json.rb
+- lib/conrad/processors.rb
+- lib/conrad/processors/add_timestamp.rb
+- lib/conrad/processors/add_uuid.rb
+- lib/conrad/processors/envelope.rb
 - lib/conrad/recorder.rb
-- lib/conrad/stdout_emitter.rb
 - lib/conrad/version.rb
 homepage: https://github.com/getoutreach/conrad
 licenses:

data/lib/conrad/add_timestamp.rb

@@ -1,52 +0,0 @@
-require 'conrad/errors'
-
-module Conrad
-  # Used to add timestamps to an audit event in seconds or milliseconds.
-  #
-  # @!attribute [r] generator
-  #    object used to generate the timestamp
-  class AddTimestamp
-    # :nodoc:
-    class Error < Conrad::Error; end
-
-    # Types of units supported for generation.
-    ALLOWED_TIME_UNITS = %i[milliseconds seconds].freeze
-
-    attr_reader :generator, :timestamp_key
-
-    # Creates a new instance of AddTimestmap processor
-    #
-    # @param units [Symbol] type of time units for the timestamp generated.
-    #   Allows :seconds or :milliseconds.
-    # @param timestamp_key [Symbol] key to add to the event hash.
-    # @raise [ArgumentError] if the given units value is not one of
-    #   ALLOWED_TIME_UNITS
-    def initialize(units: :milliseconds, timestamp_key: :timestamp)
-      unless ALLOWED_TIME_UNITS.include? units
-        raise ArgumentError, "Provided units of `#{units}` must be one of #{ALLOWED_TIME_UNITS}"
-      end
-
-      @generator = generator_from_units(units)
-      @timestamp_key = timestamp_key
-    end
-
-    # Generates and adds a timestamp to the provided Hash.
-    #
-    # @param event [Hash]
-    # @return [Hash]
-    def call(event)
-      event.merge(timestamp_key => generator.call)
-    end
-
-    private
-
-    def generator_from_units(units)
-      case units
-      when :milliseconds then -> { (Time.now.to_f * 1000).to_i }
-      when :seconds then -> { Time.now.to_i }
-      else
-        raise UnrecognizedTimeUnit, units
-      end
-    end
-  end
-end

data/lib/conrad/add_uuid.rb

@@ -1,24 +0,0 @@
-require 'securerandom'
-
-module Conrad
-  # Generalized processor for inserting a UUID into the event. Allows
-  # configuring the key used for insertion.
-  #
-  # @!attribute [r] uuid_key
-  #    The key inserted into the event hash for the generated UUID.
-  class AddUUID
-    attr_reader :uuid_key
-
-    # @param uuid_key [Symbol] key to use for the generated UUID
-    def initialize(uuid_key = :event_uuid)
-      @uuid_key = uuid_key
-    end
-
-    # @param event [Hash] the current event
-    #
-    # @return [Hash] the hash with the UUID inserted
-    def call(event)
-      event.merge(uuid_key => SecureRandom.uuid)
-    end
-  end
-end

data/lib/conrad/json_formatter.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Conrad
-  # Formats a given Hash into a presentable JSON format.
-  class JSONFormatter
-    # Formats a given Hash into a presentable JSON format.
-    #
-    # @param event [Hash] event to be formatted
-    #
-    # @return [String] JSON formatted string
-    def call(event)
-      event.to_json
-    end
-  end
-end

data/lib/conrad/stdout_emitter.rb

@@ -1,9 +0,0 @@
-module Conrad
-  # Basic emitter for sending events to $stdout.
-  class StdoutEmitter
-    # Puts an event to $stdout.
-    def call(event)
-      puts event
-    end
-  end
-end