chili_logger 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 517d555f3acba9a85b81507c6f321a89c17c1d20fb80eaa6b8ab01290c55fc83
+  data.tar.gz: 68a9d265d5ea5df6b7869b912a091d7271e5fe75b8a1990f31cd1b05dcffd385
+SHA512:
+  metadata.gz: 58c4352a1f71b36ed91b07220391dcdbec09610a4645ed8202bf84fa288e78d976d56917dc999b4f7c548579bd82fe90b822cf04f391e04d0df4183b710fda89
+  data.tar.gz: 4bb3cbbc0f2dbac7e7ce8d26842e30ff282ccd2b35b908b01c1048d3b02fe2f5e7d0f34d7f49afe6a83634cb342a5335438224b65c3b84c054cf394ccacb5359

data/.byebug_history

@@ -0,0 +1,55 @@
+continue
+msg[type.to_sym]
+msg[type]
+pp msg
+p msg
+pp msg
+msg
+type
+continue
+mock_current_log.clear_log_info
+mock_current_log
+continue
+n
+item_name
+item_names
+new_desc
+continue
+desc_to_overwrite.keys.include?(:type)
+type
+desc_to_overwrite
+continue
+type
+desc_to_overwrite
+continue
+desc_to_overwrite
+continue
+desc_to_overwrite
+continue
+desc_to_overwrite
+continue
+desc_to_overwrite
+continue
+invalid_desc.merge(valid_desc_elements)
+new_desc
+continue
+desc_to_overwrite
+new_desc
+new-desc
+continue
+e
+e.class_variables
+e.variables
+e.instance_variables
+e.body
+e.inspect
+e
+continue
+config
+continue
+config[main_config_keys.first]
+config
+main_config_keys
+continue
+rabbit_publisher
+rabbit_publisher.instance_variable_get('@user')

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.3.3
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context', 'namespace']
+Metrics/ModuleLength:
+  Max: 180
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chili_logger.gemspec
+gemspec
+
+gem "activerecord", "~> 5.2"
+gem 'bunny'
+gem 'byebug'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 0.60.0', require: false
+
+gem "httparty", "~> 0.18.1"

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    chili_logger (0.1.0)
+      bunny
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.4.3)
+      activesupport (= 5.2.4.3)
+    activerecord (5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      arel (>= 9.0)
+    activesupport (5.2.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    amq-protocol (2.3.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    bunny (2.15.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
+    multi_xml (0.6.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  bunny
+  byebug
+  chili_logger!
+  httparty (~> 0.18.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.60.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 lucas sandeville
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# ChiliLogger
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chili_logger`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chili_logger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install chili_logger
+
+
+
+```ruby
+require 'chili_logger'
+
+is_deactivated = Rails.env.test?
+
+ChiliLogger.instance.config({
+  deactivated: is_deactivated,
+  log_env: 'development',
+  log_layer: 'creatives',
+  server_url: ENV['server_url'],
+  cloud_provider: :aws,
+  msg_broker_name: :rabbitmq,
+  msg_broker_config: {
+    user: 'agent',
+    password: 'Ag2Rbt$29211620',
+    ip: '54.164.142.164',
+    port: '5672',
+    exchange_name: 'platform-topic',
+    routing_key: 'logstash'
+  }
+})
+```
+
+
+
+
+
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chili_logger.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chili_logger"
+
+# 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(__FILE__)

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/chili_logger.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/chili_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chili_logger'
+  spec.version       = ChiliLogger::VERSION
+  spec.authors       = ['lucas sandeville']
+  spec.email         = ['lucas.sandeville@gmail.com']
+
+  spec.summary       = 'placeholder'
+  spec.description   = 'placeholder'
+  spec.homepage      = 'https://gitlab.com/chiligumdev/chili_logger'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.add_dependency 'bunny'
+  spec.add_dependency 'httparty'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/brokers/rabbit_broker.rb

@@ -0,0 +1,65 @@
+require 'bunny'
+require 'errors/rabbitmq_error'
+
+# class for centralizing Creative's logging logic
+class ChiliLogger
+  # class that configures and manages the RabbitMQ client
+  class RabbitBroker
+    def config(config)
+      validate_config(config)
+
+      @user = config[:user]
+      @password = config[:password]
+      @ip = config[:ip]
+      @port = config[:port]
+      @exchange_name = config[:exchange_name]
+      @routing_key = config[:routing_key]
+
+      connect
+    end
+
+    def connect
+      return if ChiliLogger.instance.deactivated
+
+      @connection = Bunny.new("amqp://#{@user}:#{@password}@#{@ip}:#{@port}")
+      @connection.start
+
+      @channel = @connection.create_channel
+      @exchange = @channel.topic(@exchange_name, durable: true)
+
+    # wraps errors in a ChiliLogger class, so it's easier for user to see that the problem happened in chili_logger gem
+    rescue Bunny::Exception => e
+      raise(ChiliLogger::RabbitMQError, e.message)
+    end
+
+    def disconnect
+      @connection.close
+    end
+
+    def publish(message, routing_key)
+      return if ChiliLogger.instance.deactivated
+
+      # if no routing_key was provided when configuring RabbitBroker, than use the one received by the method here
+      # temporary solution so we can test, while we don't implement correct routing_keys in logstash/elasticsearch
+      key = @routing_key || routing_key
+      @exchange.publish(message.to_json, routing_key: key)
+    end
+
+    private
+
+    def invalid_config_format_error
+      'The configuration object must include a Hash'
+    end
+
+    def config_attr_error(attr)
+      "The configuration object must include a ':#{attr}' attribute"
+    end
+
+    def validate_config(config)
+      raise(ChiliLogger::ConfigError, invalid_config_format_error) unless config.is_a?(Hash)
+
+      main_config_keys = %i[user password ip port exchange_name routing_key]
+      main_config_keys.each { |key| raise(ChiliLogger::ConfigError, config_attr_error(key)) unless config[key] }
+    end
+  end
+end

data/lib/chili_logger/version.rb

@@ -0,0 +1,3 @@
+class ChiliLogger
+  VERSION = '0.0.0'
+end

data/lib/chili_logger.rb

@@ -0,0 +1,76 @@
+require 'chili_logger/version'
+require 'errors/config_error'
+require 'brokers/rabbit_broker'
+require 'message_writer/message_writer'
+require 'singleton'
+
+# class for centralizing Creative's logging logic
+class ChiliLogger
+  attr_reader :msg_broker
+  attr_accessor :deactivated
+  # this class uses the singleton module, so instead of initializing it with ChiliLogger.new,
+  # initialize it with ChiliLogger.instance
+  include Singleton
+
+  def config(config)
+    @deactivated = config[:deactivated] || false # ChilLogger can be deactivated for test environents
+
+    config_msg_writer(config)
+    config_msg_broker(config)
+
+    @current_log_accessor = CurrentLogAccessor.new(@msg_broker, @msg_writer)
+  end
+
+  def current_log
+    @current_log_accessor
+  end
+
+  def start_new_log(new_desc = nil, new_agent = nil, new_main_content = nil)
+    current_log.clear_log_info
+
+    current_log.overwrite_desc(new_desc)
+    current_log.overwrite_agent(new_agent)
+    current_log.overwrite_main_content(new_main_content)
+
+    current_log
+  end
+
+  def publish_instant_log(desc, agent, main_content)
+    message = @msg_writer.write(desc, agent, main_content)
+    routing_key = @msg_writer.write_description_tag(desc)
+
+    @msg_broker.publish(message, routing_key)
+  end
+
+  private
+
+  def config_msg_writer(general_config)
+    msg_writer_config = {
+      env: general_config[:log_env],
+      layer: general_config[:log_layer],
+      server_url: general_config[:server_url],
+      cloud_provider: general_config[:cloud_provider]
+    }
+
+    @msg_writer = MessageWriter.new(msg_writer_config)
+  end
+
+  def config_msg_broker(config)
+    msg_broker_name = config[:msg_broker_name] || :rabbitmq
+    msg_broker_config = config[:msg_broker_config] || {}
+    @msg_broker = supported_msg_brokers[msg_broker_name.to_sym]
+    raise(ConfigError, broker_name_error(msg_broker_name)) unless @msg_broker
+
+    @msg_broker.config(msg_broker_config)
+  end
+
+  def broker_name_error(msg_broker_name)
+    "#{msg_broker_name} is not supported. Supported msg_broker_names: #{supported_msg_brokers}"
+  end
+
+  def supported_msg_brokers
+    {
+      rabbitmq: RabbitBroker.new
+    }
+  end
+end

data/lib/current_log_accessor.rb

@@ -0,0 +1,120 @@
+require 'message_writer/message_writer'
+require 'byebug'
+
+# class for centralizing Creative's logging logic
+class ChiliLogger
+  # class for manipulating current thread variables
+  class CurrentLogAccessor
+    def initialize(msg_broker, msg_writer)
+      @msg_broker = msg_broker
+      @msg_writer = msg_writer
+    end
+
+    def publish(new_desc = nil, new_agent = nil, new_main_content = nil)
+      overwrite_desc(new_desc) if new_desc
+      overwrite_agent(new_agent) if new_agent
+      overwrite_main_content(new_main_content) if new_main_content
+
+      message = @msg_writer.write(desc, agent, main_content)
+      routing_key = @msg_writer.write_description_tag(desc)
+
+      @msg_broker.publish(message, routing_key)
+      clear_log_info
+    end
+
+    # ACCESSOR METHODS BELOW
+    # all relevant infos for the current log are stored in thread variables,
+    # so they can be accessed anywhere (controllers, models, tasks, etc...)
+    def agent
+      Thread.current[:current_log_agent] ||= 'not_specified'
+    end
+
+    def overwrite_agent(agent)
+      Thread.current[:current_log_agent] = agent
+      agent
+    end
+
+    def desc
+      Thread.current[:current_log_desc] ||= { type: 'not_specified', service: 'not_specified', action: 'not_specified' }
+    end
+
+    def overwrite_type(new_type_name)
+      desc[:type] = new_type_name || 'not_specified'
+    end
+
+    def overwrite_service(new_service_name)
+      desc[:service] = new_service_name || 'not_specified'
+    end
+
+    def overwrite_action(new_action_name)
+      desc[:action] = new_action_name || 'not_specified'
+    end
+
+    def overwrite_desc(new_desc)
+      return Thread.current[:current_log_desc] = nil if new_desc.nil?
+      return unless new_desc.is_a?(Hash)
+
+      overwrite_desc_items(new_desc, valid_desc_items)
+      desc
+    end
+
+    def main_content
+      Thread.current[:current_log_main_content] ||= {}
+    end
+
+    def overwrite_main_content(new_main_content)
+      return Thread.current[:current_log_main_content] = nil if new_main_content.nil?
+      return unless new_main_content.is_a?(Hash)
+
+      Thread.current[:current_log_main_content] = new_main_content
+    end
+
+    def add_to_main_content(new_content)
+      return unless new_content.is_a?(Hash)
+
+      Thread.current[:current_log_main_content] = main_content.merge(new_content)
+    end
+
+    def modified_records
+      main_content[:modified_records] ||= {}
+    end
+
+    def overwrite_modified_records(modified_records)
+      return Thread.current[:current_log_main_content] = nil if modified_records.nil?
+      return unless modified_records.is_a?(Hash)
+
+      main_content[:modified_records] = modified_records
+    end
+
+    def add_modified_record(table_name, modified_record_hash)
+      return unless table_name
+      return unless table_name.is_a?(String)
+      return unless modified_record_hash
+      return unless modified_record_hash.is_a?(Hash)
+
+      modified_records[table_name] ||= []
+      modified_records[table_name] = modified_records[table_name].push(modified_record_hash)
+    end
+
+    def clear_log_info
+      overwrite_desc(nil)
+      overwrite_agent(nil)
+      overwrite_main_content(nil)
+    end
+
+    private
+
+    def valid_desc_items
+      %i[type service action]
+    end
+
+    def overwrite_desc_items(new_desc, item_names)
+      item_names.each do |item_name|
+        next unless new_desc.keys.include?(item_name)
+
+        item = new_desc[item_name]
+        desc[item_name] = item || 'not_specified'
+      end
+    end
+  end
+end

data/lib/errors/config_error.rb

@@ -0,0 +1,9 @@
+# class for wrapping all other gem's classes
+class ChiliLogger
+  # class for wrapping configuration errors
+  class ConfigError < StandardError
+    def initialize(msg = 'Found an error when configuring ChiliLogger')
+      super(msg)
+    end
+  end
+end

data/lib/errors/rabbitmq_error.rb

@@ -0,0 +1,9 @@
+# class for wrapping all other gem's classes
+class ChiliLogger
+  # class for wrapping RabbitMQ/Bunny errors
+  class RabbitMQError < StandardError
+    def initialize(msg = "The provided data couldn't be converted")
+      super(msg)
+    end
+  end
+end