oh_my_log 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ad89d588fc30b289b18a1dc6c25a83b8d3cc0be5d25a97322107a92c3a940c
-  data.tar.gz: d2989764451af11771bc75d854ab9124b4e27205048eb1642fedcd4162f244fe
+  metadata.gz: 9c4268bb618f37425f9cd4b005699fc75d43902b54a612b9bd49f26ae32e9997
+  data.tar.gz: 8f81f6d1c522e22db26ef46e4f04476dba1af2f3cedf63ec4256bc56dbbd2c16
 SHA512:
-  metadata.gz: 80b18c3a433380f7a9624f93c2e1404ca6656a97064f8c39e754bac567aba13eead98a36a151074d4d5229b5a0681c55c91cc248e47cb1186b6e6abd5be14752
-  data.tar.gz: d14628e11566426de6fc07bb61474b17ffb5655a12f864701d7557f8952a9451d410729edc37bdae8dae191a8585225a85e3ab5f07ab970c40066f44c76408da
+  metadata.gz: 2d8ab1ac0d258c0938eedc7ec31320e179c27e920d579c7bd3a1e4d4548a2290fa18fc24bab063378a8d919415eaf497ebe12904a1ec8ef9bcd29d6eed3ca190
+  data.tar.gz: 7a49e9f1fc303ed1ed39e21a0d45a9674c453f603aed0864f33306c4d71b8d16d7e6b956f5d213c7aab5ff1f7502b87f873aeba99e016bac192df77b3afea8ab

data/.ruby-version

@@ -1 +1 @@
-2.3
+2.3.0

data/.travis.yml

@@ -2,12 +2,18 @@ language: ruby
 before_install: gem install bundler -v '1.17.3'
 install: bundle _1.17.3_ install --jobs=3 --retry=3
 script: bundle exec rspec
+services:
+  - mongodb
 rvm:
   - 2.3.0
   - 2.4.0
   - 2.5.0
   - 2.6.0
   - ruby-head
+env:
+  matrix:
+    - OHMYLOG_ORM=active_record
+    - OHMYLOG_ORM=mongoid
 matrix:
   exclude:
     # Skip these combinations because they have incompatible dependencies
@@ -16,10 +22,10 @@ matrix:
       gemfile: gemfiles/rails_4.2_stable.gemfile
     - rvm: ruby-head
       gemfile: gemfiles/rails_4.2_stable.gemfile
-#    - rvm: 2.3
-#      gemfile: gemfiles/rails_6.0_beta.gemfile
-#    - rvm: 2.4
-#      gemfile: gemfiles/rails_6.0_beta.gemfile
+  #    - rvm: 2.3
+  #      gemfile: gemfiles/rails_6.0_beta.gemfile
+  #    - rvm: 2.4
+  #      gemfile: gemfiles/rails_6.0_beta.gemfile
   allow_failures:
 #    - gemfile: gemfiles/rails_6.0_beta.gemfile
 #    - rvm: ruby-head

data/Appraisals

@@ -1,25 +1,27 @@
 appraise 'rails-4.2-stable' do
   gem 'rails', '~> 4.2.0'
-  gem 'rails-observers'
+  gem 'bundler', '< 2'
+  gem "mongoid", "~> 4.0"
 end
 
 appraise 'rails-5.0-stable' do
   gem 'rails', '~> 5.0.0'
-  gem 'rails-observers'
+  gem "mongoid", "~> 6.0"
 end
 
 appraise 'rails-5.1-stable' do
   gem 'rails', '~> 5.1.0'
-  gem 'rails-observers'
+  gem "mongoid", "~> 6.0"
 end
 
-
 appraise 'rails-5.2-stable' do
   gem 'rails', '~> 5.2.0'
-  gem 'rails-observers'
+  gem "mongoid", "~> 6.0"
 end
 
 # appraise 'rails-6.0-beta' do
-#   gem 'rails', '~> 6.0.0.beta1'
-#   gem 'rails-observers'
+#   gem 'rails', '~> 6.0.0.beta3'
+#   group :mongoid do
+#     gem "mongoid", "~> 6.0"
+#   end
 # end

data/README.md

@@ -85,6 +85,8 @@ When using multiple selectors remember that if any of the conditions among all s
 
 >[read only] status_codes Hash(the key is the rule: ONLY/EXCEPT/ALL the value is an array of status codes)
 
+>[read only] methods Hash(the key is the rule: ONLY/EXCEPT/ALL the value is an array of methods)
+
 ###### Instance methods:
 
 >set_controllers (controller ->Hash{string =>string[]})
@@ -95,10 +97,11 @@ When using multiple selectors remember that if any of the conditions among all s
 
 >set_status_codes (status_codes ->Hash{string =>Range[]})
 
+>set_methods (methods ->Hash{string =>string[]})
+
 ###### Class methods:
 
->universal_for(action: {"ALL" =>[]}, controllers: {"ALL" =>[]}) (inside the hash only or
-except you can put an array of actions)
+>universal_for(action: {"ALL" =>[]}, controllers: {"ALL" =>[]}, methods: {"ALL" =>[]}) 
 
 Complex initializer example:
 
@@ -109,6 +112,7 @@ OhMyLog::Log.configure do |config|
   selector.set_controllers("EXCEPT" =>["ApplicationController"])
   selector.set_actions("ONLY" =>["index","create","destroy"])
   selector.set_status_codes("ONLY" =>[(0..200)])
+  selector.set_methods("EXCEPT" =>["GET"])
   selector.set_ips("EXCEPT"=>["192.168.0.1"])
   config.add_selector(selector)
   #put your configs here
@@ -174,6 +178,30 @@ end
 >changes string (changes that this model had before and after the action)
 
 ---
+
+#### OhMyLog::SyslogConfiguration
+
+###### Class methods:
+
+>[read only] processor_name string (the name of the processor in use) 
+
+>[read only] operation string/symbol (the operation to execute when the message is bigger that 1024 byte)
+
+>use (processor_name, operation)  (the name of the processor and the operation to apply) 
+
+>change_processor(processor_name)
+
+>change_operation(operation) (supported operations are: split and trim)
+---
+ 
+ ### How to configure a syslog ready log:
+ * Include this in the config proc of the initializer:
+ 
+ ```sh
+ OhMyLog::SyslogConfiguration.use("RFC3164")
+ syslog = OhMyLog::SyslogImplementor.new(hostname: "Staging", priority: 101, tag: "HELLO", program_name: "WORLD")
+ config.syslog = syslog
+ ```
  
 ### Development 
 

data/blue_print/oh_my_log_initializer.rb

@@ -1,8 +1,6 @@
 OhMyLog::Log.configure do |config|
   config.print_log = true
   selector = OhMyLog::Log::Selector.universal_for(actions: {"EXCEPT" => ["index"]})
-  #selector.set_status_codes("ONLY" => [(0..200)])
   config.add_selector(selector)
-  OhMyLog.start if File.directory?(Rails.root + "app/models/observers/oh_my_log")
-  #put your configs here
-end
+end
+OhMyLog.start

data/gemfiles/rails_4.2_stable.gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.2.0"
-gem "rails-observers"
+gem "bundler", "< 2"
+gem "mongoid", "~> 4.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.0_stable.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
-gem "rails-observers"
+gem "mongoid", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.1_stable.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.1.0"
-gem "rails-observers"
+gem "mongoid", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.2_stable.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.2.0"
-gem "rails-observers"
+gem "mongoid", "~> 6.0"
 
 gemspec path: "../"

data/lib/oh_my_log/configuration.rb

@@ -1,16 +1,17 @@
 module OhMyLog
   module Log
     class Configuration
-      attr_accessor :models, :print_log, :record_history, :log_instance, :log_path
-      attr_reader :selectors
+      attr_accessor :models, :print_log, :record_history, :log_instance, :syslog
+      attr_reader :selectors, :log_path
 
       def initialize(*args)
         @selectors = []
         #models not to track
         @models = {"ALL" => []}
         @print_log = true
-        @log_instance = Logger.new(File.join(Rails.root, 'log/oh_my_log.log'))
+        @log_instance = Logger.new(File.join(Rails.root, 'log/oh_my_log.log')) unless @log_path
         @log_path = nil
+        @syslog = nil
         #do we wanna keep track of all the actions?
         @record_history = false
       end
@@ -23,6 +24,11 @@ module OhMyLog
         @selectors = []
       end
 
+      def log_path=(path)
+        @log_path = path
+        process_path
+      end
+
       def get_actions(controller)
         @selectors.each do |selector|
           return selector.actions if selector.controller == controller

data/lib/oh_my_log/log.rb

@@ -26,7 +26,6 @@ module OhMyLog
       self.history = []
       yield(configuration)
       self.configuration.add_selector(Selector.universal_for) if self.configuration.selectors.empty?
-      self.configuration.process_path
     end
 
     def self.clear
@@ -113,19 +112,38 @@ module OhMyLog
       return permitted_action
     end
 
+    def self.permitted_method?(selector, ctrl_method)
+      permitted_method = true
+      case selector.methods.keys[0]
+      when "EXCEPT"
+        selector.methods.values[0].each {|method| permitted_method = false if method.upcase.to_sym == ctrl_method}
+      when "ONLY"
+        selector.methods.values[0].each {|method| permitted_method = true if method.upcase.to_sym == ctrl_method}
+      when "ALL"
+        permitted_method = true
+      else
+        raise "UNDEFINED RULE: please us any of [ONLY/EXCEPT/ALL]"
+      end
+      return permitted_method
+    end
+
     #TODO: implement filtering by method
     def self.loggable?(params, status, method)
       ctrl_name = params["controller"]
       ctrl_action = params["action"].to_sym
+      ctrl_method = method.to_sym
       final_response = false
       self.configuration.selectors.each do |selector|
         final_response = permitted_range?(selector, status)
         return false unless final_response
 
-        final_response = final_response && permitted_controller?(selector, ctrl_name)
+        final_response &= permitted_method?(selector, ctrl_method)
+        return false unless final_response
+
+        final_response &= permitted_controller?(selector, ctrl_name)
         return false unless final_response
 
-        final_response = final_response && permitted_ip?(selector, Thread.current[:remote_ip])
+        final_response &= permitted_ip?(selector, Thread.current[:remote_ip])
         return false unless final_response
 
         return false unless permitted_action?(selector, ctrl_action)

data/lib/oh_my_log/observer_factory.rb

@@ -19,8 +19,7 @@ module OhMyLog
       #rebuild folder if it's already there
       FileUtils.rm_rf(Rails.root + "app/models/observers/oh_my_log") if File.directory?(Rails.root + "app/models/observers/oh_my_log")
       FileUtils.mkdir_p(Rails.root + "app/models/observers/oh_my_log")
-      generate_collection_for(ActiveRecord) if defined?(ActiveRecord)
-      generate_collection_for(Mongoid) if defined?(Mongoid)
+      generate_collection_for(OHMYLOG_ORM.to_s.classify.constantize)
     end
 
     def self.remove_collection
@@ -69,10 +68,10 @@ module OhMyLog
       config_rule = Log.configuration_rule
       config_models = Log.configuration_models
       models = []
-      if klass == ActiveRecord
+      if klass.to_s == 'ActiveRecord'
         models = ActiveRecord::Base.subclasses.collect {|type| type.name}
         models = models + ApplicationRecord.subclasses.collect {|type| type.name} if defined?(ApplicationRecord)
-      elsif klass == Mongoid
+      elsif klass.to_s == 'Mongoid'
         models = Mongoid.models.collect {|type| type.name}
       end
       #reject modules

data/lib/oh_my_log/orm/active_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'rails-observers'
+require 'rails/observers/activerecord/base'
+module ActiveRecord
+  autoload :Observer, 'rails/observers/activerecord/observer'
+end
+require_relative "../active_record_observer"
+

data/lib/oh_my_log/orm/mongoid.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'mongoid'
+require 'mongoid-observers'
+require_relative "../mongoid_observer"

data/lib/oh_my_log/request.rb

@@ -2,7 +2,7 @@ module OhMyLog
   module Log
     #the request is what the user is trying to do
     class Request
-      attr_reader :sender, :date, :params, :method, :status
+      attr_reader :sender, :date, :params, :method, :status, :path
 
       def initialize(args)
         @sender = args[:sender]
@@ -10,11 +10,12 @@ module OhMyLog
         @params = args[:params]
         @method = args[:method]
         @status = args[:status]
+        @path = args[:path]
       end
 
       def to_s
-        user_info = @sender.try(:email)
-        sender = !user_info.blank? ? user_info : Thread.current["remote_ip"]
+        user_info = @sender.email rescue nil
+        sender = user_info || Thread.current["remote_ip"]
         "#{@date}, #{sender}, #{@method}, #{@params}, #{@status}"
       end
     end

data/lib/oh_my_log/result.rb

@@ -33,10 +33,17 @@ module OhMyLog
       private
 
       def print_into_log
-        OhMyLog::Log.configuration.log_instance.info('REQUEST')
-        OhMyLog::Log.configuration.log_instance.info(@request.to_s)
-        OhMyLog::Log.configuration.log_instance.info('RESPONSE') unless @effects.empty?
-        @effects.each {|effect| OhMyLog::Log.configuration.log_instance.info(effect.to_s)}
+        if OhMyLog::Log.configuration.syslog
+          data = OhMyLog::Log.configuration.syslog.print(ip: OhMyLog::Log.configuration.syslog.public_ip, user: @request.sender, url: @request.path, m: @request.method, s: @request.status, p: @request.params, request_time: @request.date)
+          data.each do |data_info|
+            OhMyLog::Log.configuration.log_instance.info(data_info)
+          end
+        else
+          OhMyLog::Log.configuration.log_instance.info('REQUEST')
+          OhMyLog::Log.configuration.log_instance.info(@request.to_s)
+          OhMyLog::Log.configuration.log_instance.info('RESPONSE') unless @effects.empty?
+          @effects.each {|effect| OhMyLog::Log.configuration.log_instance.info(effect.to_s)}
+        end
       end
 
       def calculate_effects

data/lib/oh_my_log/selector.rb

@@ -2,17 +2,18 @@ module OhMyLog
   module Log
     #Selector is a set of rule that Log.loggable? will have to respect
     class Selector
-      attr_reader :controllers, :actions, :status_codes, :ips
+      attr_reader :controllers, :actions, :status_codes, :ips, :methods
       METHODS = ["GET", "HEAD", "POST", "PATCH", "PUT", "DELETE"].freeze
       ACTIONS = ["ONLY", "EXCEPT", "ALL"].freeze
       # TODO: add methods in the same style as anything else
       # and it will affect the parameter method in the loggable function in LOG.rb
       # EXCEPT O ONLY
-      def initialize(controllers: default_hash_setting, actions: default_hash_setting, ips: default_hash_setting, status_codes: default_hash_setting)
+      def initialize(controllers: default_hash_setting, actions: default_hash_setting, ips: default_hash_setting, status_codes: default_hash_setting, methods: default_hash_setting)
         @controllers = controllers
         @actions = actions
         @ips = ips
         @status_codes = status_codes
+        @methods = methods
         build_attr_setters
       end
 
@@ -36,8 +37,8 @@ module OhMyLog
         end
       end
 
-      def self.universal_for(actions: default_hash_setting, controllers: default_hash_setting)
-        return Selector.new(controllers: controllers, actions: actions)
+      def self.universal_for(actions: default_hash_setting, controllers: default_hash_setting, methods: default_hash_setting)
+        return Selector.new(controllers: controllers, actions: actions, methods: methods)
       end
     end
   end

data/lib/oh_my_log/syslog_configuration.rb

@@ -0,0 +1,30 @@
+module OhMyLog
+  class SyslogConfiguration
+    @@processor_name = "RFC3164"
+    @@split_operation = "split"
+
+    def self.use(processor_name = nil, operation = nil)
+      change_processor(processor_name) if processor_name
+      change_operation(operation) if operation
+    end
+
+    def self.processor_name
+      return @@processor_name
+    end
+
+    def self.split_operation
+      return @@split_operation
+    end
+
+    def self.change_processor(processor_name)
+      raise "We don't support the #{processor_name} format" unless (("SyslogProcessors::#{processor_name.upcase}".constantize) rescue false)
+      @@processor_name = processor_name
+    end
+
+    def self.change_operation(operation)
+      operation = operation.to_s.downcase.to_sym
+      raise ArgumentError "Supported mode are: 'split' or 'trim'" unless [:split, :trim].include? operation
+      @@split_operation = operation
+    end
+  end
+end

data/lib/oh_my_log/syslog_implementor.rb

@@ -0,0 +1,71 @@
+require_relative 'syslog_configuration'
+require 'net/http'
+require 'syslog/logger'
+require 'securerandom'
+
+module OhMyLog
+  class SyslogImplementor
+    include "::SyslogProcessors::#{OhMyLog::SyslogConfiguration.processor_name.upcase}".constantize
+    attr_accessor :facility, :severity
+    attr_reader :public_ip, :tag
+
+    def initialize(hostname: nil, priority: nil, facility: nil, severity: nil, tag: nil, program_name: "NA", syslog_facility: "Syslog::LOG_LOCAL1")
+      @hostname = retrive_hostname
+      @public_ip = retrive_public_ip
+      @priority = priority
+      @facility = facility
+      @severity = severity
+      @tag = tag
+      @program_name = program_name
+      @syslog_facility = syslog_facility
+      OhMyLog::Log.configuration.log_instance = Syslog::Logger.new program_name, syslog_facility.constantize
+      # override_log_formatter
+    end
+
+    def new_using(processor_name)
+      OhMyLog::SyslogConfiguration.use(processor_name)
+      SyslogImplementor.new(hostname: @hostname, priority: @priority, facility: @facility, severity: @severity, tag: @tag, program_name: @program_name, syslog_facility: @syslog_facility)
+    end
+
+    #TODO no need to pass :ip we can retrieve it from this class
+    def print(params)
+      data = [super(params)]
+      if data[0].bytesize >= 1024
+        if OhMyLog::SyslogConfiguration.split_operation == :split
+          id = SecureRandom.hex(8)
+          message = message_text(ip: params[:ip], user: params[:sender], url: params[:url], m: params[:m], s: params[:s], p: params[:p])
+          data = []
+          priority = priority_text
+          header = header_text(params[:request_time])
+          base_msg = priority + header + "#{@tag}[ID=#{id}]:"
+          remaining_byte = 1023 - base_msg.bytesize
+          message_chunks = get_binary_chunks(message, remaining_byte)
+          message_chunks.each {|chunk_data| data << base_msg + chunk_data + ";"}
+        else
+          data[0] = get_binary_chunks(data[0], 1021)[0] + "..."
+        end
+      end
+      data
+    end
+
+    private
+
+    def get_binary_chunks(string, size)
+      Array.new(((string.length + size - 1) / size)) {|i| string.byteslice(i * size, size)}
+    end
+
+    # def override_log_formatter
+    #   OhMyLog::Log.configuration.log_instance.formatter = proc do |severity, datetime, progname, msg|
+    #     "#{msg}\n"
+    #   end
+    # end
+
+    def retrive_public_ip
+      Net::HTTP.get(URI("http://checkip.amazonaws.com")).gsub("\n", "") rescue nil
+    end
+
+    def retrive_hostname
+      Socket.gethostname rescue nil
+    end
+  end
+end

data/lib/oh_my_log/syslog_processors/r_f_c_3164.rb

@@ -0,0 +1,36 @@
+module SyslogProcessors
+  module RFC3164
+    def calculate_priority
+      self.class.calculate_priority(facility: @facility, severity: @severity)
+    end
+
+    def priority_text
+      return "<#{@priority || calculate_priority}>"
+    end
+
+    def message_text(ip:, user:, url:, m:, s:, p:)
+      text = "#{@tag.upcase}:"
+      text += "ip=#{ip};"
+      text += "u=#{user};"
+      text += "url=#{url};"
+      text += "m=#{m};"
+      text += "s=#{s};"
+      text += "p=#{p};"
+      text
+    end
+
+    def header_text(request_time)
+      #request_time.to_time. + " #{@hostname}"
+      request_time.strftime("%b %-d %H:%M:%S") + " #{@public_ip || @hostname || "FAK"}"
+    end
+
+    def print(params)
+      priority_text + header_text(params[:request_time]) + " " + message_text(params.reject {|k| k == :request_time})
+    end
+
+    def self.calculate_priority(facility: nil, severity: nil)
+      raise "You  need facility and severity to calculate the priority" unless facility && severity
+      facility * 8 + severity
+    end
+  end
+end

data/lib/oh_my_log/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OhMyLog
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/oh_my_log.rb

@@ -1,26 +1,28 @@
-require 'rails/observers/activerecord/base'
-#force LOAD the gem "rails-observers"
-module ActiveRecord
-  autoload :Observer, 'rails/observers/activerecord/observer'
-end
-
+require 'rails'
+OHMYLOG_ORM rescue OHMYLOG_ORM = :active_record
+#creare una classe depency loader e usare il preload e l'after load
+require_relative "oh_my_log/orm/#{OHMYLOG_ORM.to_s}"
 #load the gem's lib folder
-Dir[File.dirname(__FILE__) + '/oh_my_log/*.rb'].each do |file|
-  name = File.basename(file, File.extname(file))
-  #we are gonna skip this file FOR NOW since it depends of gem loaded after the rails initializer
-  next if name == "mongoid_observer"
-  require_relative "oh_my_log/" + name
+sources = ["oh_my_log/syslog_processors/", "oh_my_log/"]
+sources.each do |base_path|
+  Dir[File.dirname(__FILE__) + "/#{base_path}*.rb"].each do |file|
+    name = File.basename(file, File.extname(file))
+    next if (["mongoid_observer", "active_record_observer"]).include? name
+    require_relative base_path + name
+  end
 end
 
+
 module OhMyLog
   #call this after you configured the Log Module
   def self.start
+    return unless File.directory?(Rails.root + "app/models/observers/oh_my_log")
     activate
     #the main loop to get callbacks from controllers
     ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
       data = args[-1]
       if Log::loggable?(data[:params], data[:status], data[:method])
-        request = Log::Request.new(sender: Thread.current[:user], date: Time.now.utc, params: data[:params], method: data[:method], status: data[:status])
+        request = Log::Request.new(sender: Thread.current[:user], date: Time.now.utc, params: data[:params], method: data[:method], status: data[:status], path: data[:path])
         result = Log::Result.new(request)
         result.record!
       end
@@ -29,12 +31,7 @@ module OhMyLog
   end
 
   def self.activate
-    if defined?(Mongoid)
-      require 'mongoid-observers'
-      require_relative "oh_my_log/mongoid_observer"
-    end
     begin
-      require Rails.root + "config/initializers/oh_my_log_initializer.rb"
       ::OhMyLog::ObserverFactory.activate_observers
     rescue
       return "could not start the gem, did you run oh_my_log:install ?"
@@ -52,8 +49,11 @@ module OhMyLog
     p "Successfully destroyed the initializer!"
   end
 
+  def self.test_message(msg)
+    OhMyLog::Log.configuration.log_instance.info(msg)
+  end
+
 end
 
 #load the script to inject code to rails source and create rake task
-require_relative "railtie"
-
+require_relative "railtie"

data/lib/tasks/oh_my_log.rake

@@ -15,6 +15,12 @@ namespace :oh_my_log do
     OhMyLog.generate_initializer
   end
 
+  desc 'Write a test message int the logger'
+  # in futuro puoi passare direttamente qui alcune impostazioni dell' initialize
+  task test: :environment do
+    OhMyLog.test_message(ENV.fetch('MSG', 'Hello World!'))
+  end
+
   desc 'Install the gem by building initializer and observers'
   task install: :environment do
     Rake::Task['oh_my_log:generate_initializer'].invoke

data/oh_my_log.gemspec

@@ -23,12 +23,14 @@ Gem::Specification.new do |s|
   else
     s.add_runtime_dependency 'railties', '>= 4.2.0', '< 6.0'
   end
-  s.add_runtime_dependency("rails-observers", "~> 0.1.5")
+  s.add_runtime_dependency 'sqlite3', '~> 1.3.0'
+  s.add_runtime_dependency "rails-observers", "~> 0.1.5"
+  s.add_runtime_dependency 'mongoid', ">= 3.0"
+  s.add_runtime_dependency "mongoid-observers"
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'rubocop', '~> 0.59.2'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'appraisal'
-  s.add_development_dependency 'sqlite3', '~> 1.3.10'
   s.add_development_dependency 'wwtd'
   s.add_development_dependency 'rspec-rails'
 end

data/spec/controllers/foos_controller_spec.rb

@@ -17,6 +17,9 @@ RSpec.describe FoosController, type: :controller do
         config.print_log = true
         selector = oml::Selector.universal_for(actions: {"EXCEPT" => ["index"]})
         config.add_selector(selector)
+        OhMyLog::SyslogConfiguration.use("RFC3164")
+        syslog = OhMyLog::SyslogImplementor.new(hostname: "Staging", priority: 101, tag: "BRAINT", program_name: "audit", syslog_facility: "Syslog::LOG_LOCAL3")
+        config.syslog = syslog
       end
     end
 
@@ -60,6 +63,22 @@ RSpec.describe FoosController, type: :controller do
       put :create, params: {name: 'foo name'}
       expect(oml.last_recorded).to eq(nil)
     end
+    it "Should not log a get action if it's blacklisted" do
+      selector = OhMyLog::Log::Selector.new
+      selector.set_methods("EXCEPT" => ["GET"])
+      oml.configuration.reset_selectors
+      oml.configuration.add_selector(selector)
+      get :index
+      expect(oml.last_recorded).to eq(nil)
+    end
+    it "Should log a get action if it's whitelisted" do
+      selector = OhMyLog::Log::Selector.new
+      selector.set_methods("ONLY" => ["GET"])
+      oml.configuration.reset_selectors
+      oml.configuration.add_selector(selector)
+      get :index
+      expect(oml.last_recorded).not_to eq(nil)
+    end
     it "Should be able to correctly use multiple selector" do
       selector = OhMyLog::Log::Selector.new
       selector.set_controllers({"EXCEPT" => ["Foo"]})
@@ -81,6 +100,9 @@ RSpec.describe FoosController, type: :controller do
         config.print_log = true
         selector = oml::Selector.universal_for(actions: {"EXCEPT" => ["index"]})
         config.add_selector(selector)
+        OhMyLog::SyslogConfiguration.use("RFC3164")
+        syslog = OhMyLog::SyslogImplementor.new(hostname: "Staging", priority: 101, tag: "BRAINT", program_name: "audit", syslog_facility: "Syslog::LOG_LOCAL3")
+        config.syslog = syslog
       end
     end
     it "Should create a log in the path specified in teh configuration" do
@@ -99,6 +121,15 @@ RSpec.describe FoosController, type: :controller do
       expect(oml.last_recorded).not_to eq(nil)
     end
 
+    it "Should split the message bigger than 1024 char when using a syslog" do
+      if Rails::VERSION::MAJOR >= 5
+        put :update, params: {name: "dummy name" * 200, value: 1, id: @dummy.id}
+      else
+        put :update, {name: "dummy name" * 200, value: 1, id: @dummy.id}
+      end
+      expect(oml.last_recorded).not_to eq(nil)
+    end
+
     it "The log created should have a receiver if the action made any changes to the model" do
       if Rails::VERSION::MAJOR >= 5
         put :update, params: {name: "not dummy name", value: 99, id: @dummy.id}

data/spec/dummy/app/models/application_record.rb

@@ -1,3 +1,10 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end
+# frozen_string_literal: true
+if OHMYLOG_ORM == :active_record
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+else
+  class ApplicationRecord
+    include Mongoid::Document
+  end
+end

data/spec/dummy/app/models/doo.rb

@@ -1,2 +1,8 @@
 class Doo < ApplicationRecord
+  if OHMYLOG_ORM == :mongoid
+    include Mongoid::Document
+    field :name, type: String
+    field :value, type: Integer
+    include ::Mongoid::Timestamps
+  end
 end

data/spec/dummy/app/models/foo.rb

@@ -1,2 +1,8 @@
 class Foo < ApplicationRecord
+  if OHMYLOG_ORM == :mongoid
+    include Mongoid::Document
+    field :name, type: String
+    field :value, type: Integer
+    include ::Mongoid::Timestamps
+  end
 end

data/spec/dummy/config/application.rb

@@ -4,6 +4,7 @@ require 'oh_my_log'
 
 if defined?(Bundler)
   Bundler.require(*Rails.groups(assets: %w[development test]))
+  require "#{OHMYLOG_ORM}/railtie"
 end
 
 module RailsApp
@@ -12,9 +13,9 @@ module RailsApp
 
     config.filter_parameters += [:password]
 
-    config.assets.enabled = true
+    config.autoload_paths += ["#{config.root}/app/#{OHMYLOG_ORM}"]
+    config.autoload_paths += ["#{config.root}/lib"]
 
-    config.assets.version = '1.0'
     config.secret_key_base = 'fuuuuuuuuuuu'
   end
 end

data/spec/dummy/config/environments/test.rb

@@ -6,32 +6,31 @@ RailsApp::Application.configure do
 
   if Rails.version > '5'
     config.public_file_server.enabled = true
-    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+    config.public_file_server.headers = {'Cache-Control' => 'public, max-age=3600'}
   else
     config.serve_static_files = true
     config.static_cache_control = 'public, max-age=3600'
   end
 
-  config.consider_all_requests_local       = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   config.action_dispatch.show_exceptions = false
 
   config.action_controller.allow_forgery_protection = false
 
-  config.action_mailer.delivery_method = :test
-  config.action_mailer.default_url_options = { host: 'test.host' }
-
   config.active_support.deprecation = :stderr
   I18n.enforce_available_locales = false
 
   config.active_support.test_order = :sorted
   config.log_level = :debug
-  if Rails.gem_version >= Gem::Version.new('4.2') && Rails.gem_version < Gem::Version.new('5.0')
-    config.active_record.raise_in_transactional_callbacks = true
-  end
-  if Rails.gem_version.release >= Gem::Version.new('5.2')
-    config.active_record.sqlite3.represent_boolean_as_integer = true
+  if (OHMYLOG_ORM == "active_record")
+    if Rails.gem_version >= Gem::Version.new('4.2') && Rails.gem_version.release < Gem::Version.new('5.0')
+      config.active_record.raise_in_transactional_callbacks = true
+    end
+    if Rails.gem_version.release >= Gem::Version.new('5.2') && Rails.gem_version.release < Gem::Version.new('6.0')
+      config.active_record.sqlite3.represent_boolean_as_integer = true
+    end
   end
 end
-ActiveSupport::Deprecation.debug = true
+ActiveSupport::Deprecation.debug = true

data/spec/dummy/config/initializers/migration_class.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-MIGRATION_CLASS =
-  if ActiveRecord::VERSION::MAJOR >= 5
-    ActiveRecord::Migration[4.2]
-  else
-    ActiveRecord::Migration
-  end
+require "oh_my_log/orm/#{OHMYLOG_ORM}"
+
+if OHMYLOG_ORM == :active_record
+  MIGRATION_CLASS =
+      if Rails.gem_version >= Gem::Version.new('5.0')
+        ActiveRecord::Migration[Rails.version.to_f]
+      else
+        ActiveRecord::Migration
+      end
+end

data/spec/dummy/config/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  <%= Mongoid::VERSION.to_i > 4 ? 'clients' : 'sessions' %>:
+                                                default:
+                                                  database: devise_security_test
+                                                  hosts:
+                                                  - localhost:<%= ENV.fetch('MONGODB_PORT', '27017') %>

data/spec/orm/active_record.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'active_record'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new(nil)
+if Rails.gem_version >= Gem::Version.new('5.2.0')
+  ActiveRecord::MigrationContext.new(File.expand_path('../../dummy/db/migrate', __FILE__)).migrate
+else
+  ActiveRecord::Migrator.migrate(File.expand_path('../../dummy/db/migrate', __FILE__))
+end
+
+ORMInvalidRecordException = ActiveRecord::RecordInvalid

data/spec/orm/mongoid.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'mongoid/version'
+require 'mongoid'
+Mongoid.configure do |config|
+  config.load!('spec/support/mongoid.yml', Rails.env)
+  config.use_utc = true
+  config.include_root_in_json = true
+end
+
+ORMInvalidRecordException = Mongoid::Errors::Validations

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
 ENV['RAILS_ENV'] ||= 'test'
+OHMYLOG_ORM = ENV.fetch('OHMYLOG_ORM', 'active_record').to_sym
 require 'simplecov'
 SimpleCov.start do
   add_filter 'gemfiles'
   add_filter 'lib/railtie.rb'
   add_filter 'lib/tasks/oh_my_log.rake'
+  add_filter 'lib/oh_my_log/orm'
+  add_filter 'lib/oh_my_log/syslog_processors'
   add_filter 'spec'
   add_filter 'blue_print'
   add_group 'Tests', 'test'
@@ -15,7 +18,9 @@ if ENV['CI']
   Coveralls.wear!
 end
 require 'active_support/all'
+require 'rails'
 require 'dummy/config/environment'
+require_relative "../spec/orm/#{OHMYLOG_ORM}"
 # note that require 'rspec-rails' does not work
 # https://stackoverflow.com/questions/14458122/framework-integration-testing-within-a-gem-how-to-set-up-rspec-controller-test
 require 'rspec/rails'
@@ -24,13 +29,4 @@ require 'rake'
 
 load File.expand_path("../../lib/tasks/oh_my_log.rake", __FILE__)
 # make sure you set correct relative path
-Rake::Task.define_task(:environment)
-
-ActiveRecord::Migration.verbose = false
-ActiveRecord::Base.logger = Logger.new(nil)
-
-if Rails.gem_version >= Gem::Version.new('5.2.0')
-  ActiveRecord::MigrationContext.new(File.expand_path('../dummy/db/migrate', __FILE__)).migrate
-else
-  ActiveRecord::Migrator.migrate(File.expand_path('../dummy/db/migrate', __FILE__))
-end
+Rake::Task.define_task(:environment)

data/spec/support/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  <%= Mongoid::VERSION.to_i > 4 ? 'clients' : 'sessions' %>:
+                                                default:
+                                                  database: devise_security_test
+                                                  hosts:
+                                                  - localhost:<%= ENV.fetch('MONGODB_PORT', '27017') %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oh_my_log
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Fabrizio Spadaro
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rails-observers
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid-observers
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -100,20 +142,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.10
 - !ruby/object:Gem::Dependency
   name: wwtd
   requirement: !ruby/object:Gem::Requirement
@@ -172,9 +200,14 @@ files:
 - lib/oh_my_log/log.rb
 - lib/oh_my_log/mongoid_observer.rb
 - lib/oh_my_log/observer_factory.rb
+- lib/oh_my_log/orm/active_record.rb
+- lib/oh_my_log/orm/mongoid.rb
 - lib/oh_my_log/request.rb
 - lib/oh_my_log/result.rb
 - lib/oh_my_log/selector.rb
+- lib/oh_my_log/syslog_configuration.rb
+- lib/oh_my_log/syslog_implementor.rb
+- lib/oh_my_log/syslog_processors/r_f_c_3164.rb
 - lib/oh_my_log/version.rb
 - lib/railtie.rb
 - lib/tasks/oh_my_log.rake
@@ -198,11 +231,15 @@ files:
 - spec/dummy/config/environment.rb
 - spec/dummy/config/environments/test.rb
 - spec/dummy/config/initializers/migration_class.rb
+- spec/dummy/config/mongoid.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
 - spec/dummy/db/migrate/20120508165529_create_tables.rb
+- spec/orm/active_record.rb
+- spec/orm/mongoid.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
+- spec/support/mongoid.yml
 homepage: https://github.com/fabriziospadaro/oh_my_log
 licenses:
 - MIT