context_logger 0.0.40 → 0.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6c022444accec283a9f4dced8de9ba46f36cfaf
-  data.tar.gz: 801e99264ddba77fd3f3072cefb76a74dc147cbf
+  metadata.gz: 9e008c70f4b8407833f42781545288f463f8548c
+  data.tar.gz: 5000f4aa5737e905897335d477c5be28c26a581b
 SHA512:
-  metadata.gz: 83a7532b211cf9176ba8414b1a24440cf05bc8ac7e34382327081df3d45ee2a35749966c4920593a67bb430d182e69a15efbd34055d97b2b786fdcea15dd3d33
-  data.tar.gz: f1d529126101a863e929902088d99c0c5dde185fb72c5ad6368ecac4069b3909f2a955207af533f42bfc11294db54e6caba098843206a732dc13afa55c1fbc29
+  metadata.gz: 154b8a1a7f637ab0de78dddf8849d5f486693c53fa28acc5bf0f28b9caf8bfeeffed8c3e2bc42a5a6fe411a02590021bdec43889d96f7786280b25df9a1f3b97
+  data.tar.gz: 9ea923cca2ed01ed09df2bf33655f23b35225f3967408cd738bd5cf39e62e04c8759c45f66fe90b5d6d9f8efdc8c8f94821f007dc4a4c2a864aac9f3ec1f31cb

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    context_logger (0.0.37)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  context_logger!

data/app/controllers/api/v1/resources/context_logger_controller.rb

@@ -13,4 +13,4 @@ module Api
       end
     end
   end
-end
+end

data/context_logger.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'context_logger'
+  s.version     = '0.0.41'
+  s.date        = '2015-11-11'
+  s.summary     = 'writes log to db and log file and exposes it via http'
+  s.description = 'writes log to db and log file and exposes it via http'
+  s.authors     = ['Alexander Libster']
+  s.email       = '012alex012@gmail.com'
+  s.files         = `git ls-files`.split($/)
+  # s.files       = %w(lib/context_logger.rb lib/context_logger/engine.rb db/migrate/20151112164817_create_context_logs.rb
+# app/models/context_log.rb app/controllers/api/v1/resources/context_logger_controller.rb config/routes.rb)
+  s.homepage    = ''
+  s.license       = 'MIT'
+
+
+  # s.add_development_dependency 'bundler'
+  # s.add_development_dependency 'rails'
+  # s.add_development_dependency 'rspec', '~> 3.0'
+  # s.add_development_dependency 'rspec-rails'
+  # s.add_development_dependency 'faker'
+end

data/spec/context_log_stub.rb

@@ -0,0 +1,10 @@
+class ContextLog
+  def self.columns
+    [
+        OpenStruct.new(name: :context),
+        OpenStruct.new(name: :severity),
+        OpenStruct.new(name: :action_id),
+        OpenStruct.new(name: :message)
+    ]
+  end
+end

data/spec/controllers/context_logger_spec.rb

@@ -0,0 +1,23 @@
+# require 'spec_helper'
+# require 'rails/all'
+#
+# require 'rspec/rails'
+#
+# require './app/controllers/api/v1/resources/context_logger_controller.rb'
+#
+# describe Api::V1::Resources::ContextLoggerController do
+#   let (:connection) { mock("connection") }
+#   before(:each) do
+#     ::ActiveRecord::Base.stub!(:connection).and_return(connection)
+#     ConnectionPool.any_instance.stub(:retrieve_connection).and_return({lala: 1})
+#   end
+#
+#   context 'index' do
+#     it 'ContextLoggerController' do
+#       response_body = 'response_body'
+#
+#       get :index
+#       expect(response.body).to eq(response_body)
+#     end
+#   end
+# end

data/spec/lib/context_logger_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+# require 'rails/all'
+# require 'rspec/rails'
+
+require './spec/rails_stub.rb'
+require './spec/logger_stub.rb'
+require './spec/context_log_stub.rb'
+
+
+require './lib/context_logger.rb'
+
+require 'active_support/core_ext/hash'
+require 'ostruct'
+
+describe ContextLogger do
+  context 'self.options' do
+    it 'expect options to be equal described_class::DEFAULTS' do
+      expect(described_class.options).to eq(described_class::DEFAULTS)
+    end
+  end
+
+  context 'self.setup' do
+    it 'expect modify options' do
+      described_class.setup(context: :publish)
+      expect(described_class.options).to eq(described_class::DEFAULTS.merge(context: :publish))
+
+      described_class.setup(context: :not_publish, another_key: :another_value)
+      expect(described_class.options).to eq(described_class::DEFAULTS.merge(context: :not_publish, another_key: :another_value))
+    end
+  end
+
+
+  context 'self.set_destinations' do
+    it 'ALL_DESTINATIONS' do
+      described_class.set_destinations(:all)
+      expect(described_class.destinations).to eq(described_class::ALL_DESTINATIONS)
+    end
+
+    it 'write_rails_log and write_context_log' do
+      described_class.set_destinations(write_rails_log: true, write_context_log: true)
+      expect(described_class.destinations).to eq(write_rails_log: true, write_context_log: true)
+    end
+
+    it 'write_db_log' do
+      described_class.set_destinations(write_db_log: true, write_context_log: false)
+      expect(described_class.destinations).to eq(write_db_log: true)
+    end
+
+    it 'with illegal destination - should be ignored' do
+      described_class.set_destinations(write_db_log: true, illegal_destination_should_be_ignored: true)
+      expect(described_class.destinations).to eq(write_db_log: true)
+    end
+  end
+
+  context 'self.logs_folder' do
+    it 'should build logs\' folder properly' do
+      expect(described_class.logs_folder).to eq('root_directory/log')
+    end
+  end
+
+  context 'self.log_file_path' do
+    it 'should build log_file_path properly with legal filename based on context' do
+      expect(described_class.log_file_path(:publish)).to eq('root_directory/log/publish.log')
+      expect(described_class.log_file_path('publish context')).to eq('root_directory/log/publish_context.log')
+      expect(described_class.log_file_path('@publish $context')).to eq('root_directory/log/publish_context.log')
+      expect(described_class.log_file_path('@publish $context123')).to eq('root_directory/log/publish_context123.log')
+    end
+  end
+
+  context 'self.log' do
+    it 'all destinations - should call methods to write to all destinations' do
+      params = {context: :publish, severity: :info}
+      params_with_defaults = described_class.options.merge(params.reject{|_, v| v.nil?})
+      described_class.set_destinations({
+                                           write_rails_log: true,
+                                           write_context_log: true,
+                                           write_db_log: true
+                                       })
+
+      expect(described_class).to receive(:write_rails_log).with(params_with_defaults)
+      expect(described_class).to receive(:write_context_log).with(params_with_defaults)
+      expect(described_class).to receive(:write_db_log).with(params_with_defaults)
+
+      described_class.log(params_with_defaults)
+    end
+
+    it 'partial destinations - should call methods to write to part of destinations' do
+      params = {context: :publish, severity: :info}
+      params_with_defaults = described_class.options.merge(params.reject{|_, v| v.nil?})
+      described_class.set_destinations({
+                                           write_context_log: true,
+                                           write_db_log: true
+                                       })
+
+      expect(described_class).to_not receive(:write_rails_log).with(params_with_defaults)
+      expect(described_class).to receive(:write_context_log).with(params_with_defaults)
+      expect(described_class).to receive(:write_db_log).with(params_with_defaults)
+
+      described_class.log(params_with_defaults)
+    end
+  end
+
+  context 'self.write_rails_log' do
+    it 'expects call the proper Rails.logger method with the proper params' do
+      params = {context: :publish, severity: :info}
+      params_with_defaults = described_class.options.merge(params.reject{|_, v| v.nil?})
+
+
+      expect(Rails.logger). to receive(:info).with(params_with_defaults.except(:severity))
+      described_class.write_rails_log(params_with_defaults)
+    end
+  end
+
+  context 'self.write_context_log' do
+    it 'expects call the proper Logger method with the proper params' do
+      params = {context: :publish, severity: :info, action_id: 123}
+      params_with_defaults = described_class.options.merge(params.reject{|_, v| v.nil?})
+
+      expect_any_instance_of(Logger).to receive(:info).with(params_with_defaults.except(:severity, :context))
+      described_class.write_context_log(params_with_defaults)
+    end
+  end
+
+  context 'self.write_db_log' do
+    it 'expects call the create method of ::ContextLog with the proper params' do
+
+      params = {context: :publish, severity: :info, action_id: 123}
+      params_with_defaults = described_class.options.merge(params.reject{|_, v| v.nil?})
+
+      column_names = ContextLog.columns.map(&:name)
+      expected_params = described_class.options.merge(params_with_defaults).select{|k, _| column_names.include?(k)}
+      expect(::ContextLog).to receive(:create).with(expected_params)
+      described_class.write_db_log(params_with_defaults)
+    end
+  end
+
+end

data/spec/logger_stub.rb

@@ -0,0 +1,4 @@
+class Logger
+  def initialize(file_name)
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,15 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'rails/all'
+
+require 'rspec/rails'
+#require "/Users/elia.gilad/work/boost_rules/spec/../lib/boost_rules/assets_provider.rb"
+
+require './app/controllers/api/v1/resources/context_logger_controller.rb'
+#Dir[File.dirname(__FILE__) + "/../**/*.rb"].each {|file| require file }
+
+require 'spec_helper'
+
+RSpec.configure do |config|
+
+end

data/spec/rails_stub.rb

@@ -0,0 +1,16 @@
+class Rails
+  class Engine
+    def self.isolate_namespace(arg)
+    end
+
+    def self.initializer(arg)
+    end
+  end
+
+  def self.root
+    'root_directory'
+  end
+
+  def self.logger
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# require 'rubygems'
+# require 'bundler'
+# Bundler.setup
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.40
+  version: 0.0.41
 platform: ruby
 authors:
 - Alexander Libster
@@ -16,12 +16,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
 - app/controllers/api/v1/resources/context_logger_controller.rb
 - app/models/context_log.rb
 - config/routes.rb
+- context_logger.gemspec
 - db/migrate/20151112164817_create_context_logs.rb
 - lib/context_logger.rb
 - lib/context_logger/engine.rb
+- spec/context_log_stub.rb
+- spec/controllers/context_logger_spec.rb
+- spec/lib/context_logger_spec.rb
+- spec/logger_stub.rb
+- spec/rails_helper.rb
+- spec/rails_stub.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT