rack-action_logger 0.1.0

data/example/rails5/spec/rails_helper.rb

@@ -0,0 +1,57 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'spec_helper'
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# Checks for pending migration and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/example/rails5/spec/spec_helper.rb

@@ -0,0 +1,99 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/lib/rack/action_logger/configuration.rb

@@ -0,0 +1,25 @@
+require 'rack/action_logger/emit_adapter/logger_adapter'
+require 'rack/action_logger/emit_adapter/fluent_adapter'
+require 'rack/action_logger/emit_adapter/null_adapter'
+require 'logger'
+
+module Rack::ActionLogger
+  class Configuration
+    attr_accessor :emit_adapter
+    attr_accessor :wrap_key
+    attr_accessor :default_tag
+    attr_accessor :tag_prefix
+    attr_accessor :logger
+
+    def initialize
+      @emit_adapter = EmitAdapter::LoggerAdapter
+      @tag_prefix = 'action'
+      @logger = Logger.new(STDOUT)
+      @logger.progname = 'rack_action_logger'
+    end
+
+    def default_tag
+      "#{@tag_prefix}.log"
+    end
+  end
+end

data/lib/rack/action_logger/container.rb

@@ -0,0 +1,95 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+module Rack::ActionLogger
+  module Container
+    THREAD_KEY = :rack_action_logger
+    EXPORT_KEYS = [:rack_action_logger_attributes]
+
+    class << self
+      def store
+        Thread.current[THREAD_KEY] ||= {}
+      end
+
+      def clear
+        Thread.current[THREAD_KEY] = nil
+      end
+
+      def set_is_emit_started
+        store[:rack_action_logger_emit_started] = true
+      end
+
+      def get_is_emit_started
+        store[:rack_action_logger_emit_started] ||= false
+      end
+
+      def set_append_log(hash, tag)
+        return unless is_valid_hash hash
+        return unless is_valid_tag tag
+        hash[:tag] = tag
+        get_append_logs.push(hash)
+      end
+
+      def get_append_logs
+        store[:rack_action_logger_append_logs] ||= []
+      end
+
+      def merge_attributes(attributes)
+        return unless is_valid_hash attributes
+        get_attributes.merge! attributes
+      end
+
+      def get_attributes
+        store[:rack_action_logger_attributes] ||= {}
+      end
+
+      def set_request_log(hash, tag)
+        return unless is_valid_hash hash
+        return unless is_valid_tag tag
+        hash[:tag] = tag
+        get_request_log.merge! hash
+      end
+
+      def get_request_log
+        store[:rack_action_logger_request_log] ||= {}
+      end
+
+      def export
+        # ここenumerableで置き換える
+        hash = {}
+        EXPORT_KEYS.each do |key|
+          hash[key] = store[key] if store[key]
+        end
+        hash
+      end
+
+      def import(hash)
+        hash.symbolize_keys.each do |key, value|
+          next unless EXPORT_KEYS.include? key
+          store[key] = value
+        end
+      end
+
+      private
+
+      def is_valid_hash(hash)
+        if hash.is_a? Hash
+          true
+        else
+          Rack::ActionLogger.logger.error("invalid hash: #{hash}")
+          false
+        end
+      end
+
+      def is_valid_tag(tag)
+        if tag.is_a? String
+          true
+        else
+          Rack::ActionLogger.logger.error("invalid tag: #{tag}")
+          false
+        end
+      end
+    end
+
+  end
+end

data/lib/rack/action_logger/context.rb

@@ -0,0 +1,15 @@
+module Rack::ActionLogger
+  class Context
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Emitter.new.emit do
+        @app.call(env)
+      end
+    end
+
+  end
+end

data/lib/rack/action_logger/controller_concerns/request_log.rb

@@ -0,0 +1,18 @@
+require 'rack/action_logger/container'
+
+module Rack::ActionLogger::ControllerConcerns
+  module RequestLog
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_request_log
+    end
+
+    def set_request_log
+      Rack::ActionLogger::Container.set_request_log({ path_info: request.path_info, request_method: request.request_method }, 'action.request')
+
+      request_id = Rails::VERSION::MAJOR >= 5 ? request.request_id : request.uuid
+      Rack::ActionLogger::Container.merge_attributes({ request_id: request_id })
+    end
+  end
+end

data/lib/rack/action_logger/controller_concerns.rb

@@ -0,0 +1,8 @@
+module Rack::ActionLogger
+  module ControllerConcerns
+    extend ActiveSupport::Autoload
+
+    autoload :RequestLog
+  end
+end
+

data/lib/rack/action_logger/emit_adapter/base.rb

@@ -0,0 +1,18 @@
+require 'rack/action_logger'
+
+module Rack::ActionLogger::EmitAdapter
+  class Base
+    def self.emit(hash); end
+
+    def self.wrap(hash)
+      result = {}
+      wrap_key = Rack::ActionLogger.configuration.wrap_key
+      if wrap_key
+        result[wrap_key] = hash
+      else
+        result = hash
+      end
+      result
+    end
+  end
+end

data/lib/rack/action_logger/emit_adapter/fluent_adapter.rb

@@ -0,0 +1,11 @@
+require 'rack/action_logger/emit_adapter/base'
+
+module Rack::ActionLogger::EmitAdapter
+  class FluentAdapter < Base
+    def self.emit(hash)
+      tag = hash[:tag] ? hash[:tag] : Rack::ActionLogger.configuration.default_tag
+      hash = wrap(hash)
+      Fluent::Logger.post(tag, hash)
+    end
+  end
+end

data/lib/rack/action_logger/emit_adapter/logger_adapter.rb

@@ -0,0 +1,10 @@
+require 'rack/action_logger/emit_adapter/base'
+
+module Rack::ActionLogger::EmitAdapter
+  class LoggerAdapter < Base
+    def self.emit(hash)
+      hash = wrap(hash)
+      Rack::ActionLogger.logger.info(hash)
+    end
+  end
+end

data/lib/rack/action_logger/emit_adapter/null_adapter.rb

@@ -0,0 +1,7 @@
+require 'rack/action_logger/emit_adapter/base'
+
+module Rack::ActionLogger::EmitAdapter
+  class NullAdapter < Base
+    # Emit nothing
+  end
+end

data/lib/rack/action_logger/emitter.rb

@@ -0,0 +1,44 @@
+module Rack::ActionLogger
+  class Emitter
+
+    def initialize
+      @can_emit = !Container.get_is_emit_started
+      unless @can_emit
+        Rack::ActionLogger.logger.error("#{self.class} is already defined.")
+        Rack::ActionLogger.logger.error("#{Thread.current.backtrace.join("\n")}")
+      end
+      @emit_adapter = Rack::ActionLogger.configuration.emit_adapter
+      @container = Container
+    end
+
+    def emit(context=nil)
+      @container.set_is_emit_started
+      @container.import(context) if context
+      result = yield
+      emit_all_logs  # emit log unless exception raised
+      result
+    ensure
+      @container.clear if @can_emit
+    end
+
+    private
+
+    def emit_all_logs
+      return unless @can_emit
+      emit_request_log
+      emit_append_logs
+    end
+
+    def emit_request_log
+      return unless (@container.get_request_log.is_a?(Hash) && @container.get_request_log != {})
+      hash = @container.get_request_log.merge @container.get_attributes
+      @emit_adapter.emit(hash)
+    end
+
+    def emit_append_logs
+      @container.get_append_logs.each do |hash|
+        @emit_adapter.emit(@container.get_attributes.merge!(hash))
+      end
+    end
+  end
+end

data/lib/rack/action_logger/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module ActionLogger
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/action_logger.rb

@@ -0,0 +1,30 @@
+require 'rack/action_logger/configuration'
+
+module Rack::ActionLogger
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.new(app)
+    Context.new(app)
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.logger
+    configuration.logger
+  end
+
+  autoload :Configuration, 'rack/action_logger/configuration'
+  autoload :Container, 'rack/action_logger/container'
+  autoload :Context, 'rack/action_logger/context'
+  autoload :Emitter, 'rack/action_logger/emitter'
+  autoload :ControllerConcerns, 'rack/action_logger/controller_concerns'
+  autoload :EmitAdapter, 'rack/action_logger/emit_adapter'
+end

data/rack-action_logger.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/action_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-action_logger'
+  spec.version       = Rack::ActionLogger::VERSION
+  spec.authors       = ['Koichi Ishida']
+  spec.email         = ['wapa5pow@gmail.com']
+
+  spec.summary       = 'Rack::ActionLogger is a tool to log user activity'
+  spec.description   = 'Rack::ActionLogger is a tool to log user activity'
+  spec.homepage      = 'https://github.com/wapa5pow/rack-action_logger'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'fluent-logger', '~> 0.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end