rails_middleware_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f55dbcb8d941307c2bfea74da17ff9c3a2fdee91
+  data.tar.gz: c7e7a9173d82d27d29cbd32d55dfe49aa7d7fc91
+SHA512:
+  metadata.gz: 7c9fa90048f8869d87f0e6cde56e5ff22d7f71be264d65fbc9f59bbc7cf9ef20ec874ed7114580eb356b78272a838396ad7461493b5b1736da32a740a909c217
+  data.tar.gz: bbe26794cd09dea4a5a7cda9731a05f2a9f13bd3db8f11f46cdd74e492bcb2f91ea429d400eebe29ac0b4116bb94828ba94d2b2010a1aaa6e6eac30321dc17ca

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/*

data/.rubocop.yml

@@ -0,0 +1,19 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 1.9
+Documentation:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: when_needed
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+group :development, :test do
+  gem 'rubocop', require: false
+  gem 'rspec'
+  gem 'rails', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 fanxiaopeng
+
+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,86 @@
+# RailsMiddlewareLog
+
+Print Log for request when every middleware start in Rails. You can set which request to log, and the content you want to print.
+
+在Rails的每个middleware开始的时候打印日志，可以配置那些请求，以及自定义打印内容。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_middleware_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_middleware_log
+
+## log
+
+```ruby
+Started GET "/path/of/request" for ::1 at 2016-02-17 10:48:55 +0800
+-------ActionDispatch::ShowExceptions
+-------WebConsole::Middleware
+-------ActionDispatch::DebugExceptions
+-------ActionDispatch::RemoteIp
+-------ActionDispatch::Reloader
+-------ActionDispatch::Callbacks
+-------ActiveRecord::Migration::CheckPending
+  ActiveRecord::SchemaMigration Load (23.0ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+-------ActiveRecord::ConnectionAdapters::ConnectionManagement
+-------ActionDispatch::Cookies
+-------ActionDispatch::Session::CookieStore
+-------ActionDispatch::Flash
+-------ActionDispatch::ParamsParser
+-------Rack::Head
+-------Rack::ConditionalGet
+-------Rack::ETag
+-------Rack::Head
+
+```
+
+## Usage
+add the following example code to application.rb
+```ruby
+    RailsMiddlewareLog.configure do |config|
+      config.target_urls = ['/coupon/v1/coupon_batches']
+      config.before_middleware = ->(middleware_class, env) do
+        puts middleware_class
+      end
+    end
+```
+
+1. target_urls： select target request url to log. default: log nothing 
+    - Boolean
+    true will log every request
+    - String
+    equal to PATH_INFO
+    - Array
+    contains PATH_INFO
+    - Regexp
+    match PATH_INFO
+2. before_middleware：a lambda with two args, for user to custom.
+    - middleware_class
+    class of current middleware
+    - env
+    one arg of middleware call method
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails_middleware_log/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/rails_middleware_log.rb

@@ -0,0 +1,29 @@
+require 'rails_middleware_log/version'
+
+module RailsMiddlewareLog
+end
+
+# load Rails/Railtie
+begin
+  require 'rails'
+rescue LoadError
+  # do nothing
+end
+
+$stderr.puts <<-EOC if !defined?(Rails)
+warning: no framework detected.
+
+Your Gemfile might not be configured properly.
+---- e.g. ----
+Rails:
+    gem 'rails_middleware_log'
+
+EOC
+
+# load components
+require 'rails_middleware_log/config'
+require 'rails_middleware_log/hooks'
+require 'rails_middleware_log/log'
+
+# if not using Railtie, call `RailsMiddlewareLog::Hooks.init` directly
+require 'rails_middleware_log/railtie' if defined?(Rails)

data/lib/rails_middleware_log/config.rb

@@ -0,0 +1,23 @@
+require 'active_support/configurable'
+# config file
+module RailsMiddlewareLog
+  # Configures global settings
+  #   RailsMiddlewareLog.configure do |config|
+  #     config.logger = Logger.new
+  #   end
+  def self.configure(&_block)
+    yield @config ||= RailsMiddlewareLog::Configuration.new
+  end
+
+  # Global settings
+  def self.config
+    @config || configure { |config| config }
+  end
+
+  # need a Class for 3.0
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor(:target_urls)
+    config_accessor(:before_middleware)
+  end
+end

data/lib/rails_middleware_log/hooks.rb

@@ -0,0 +1,11 @@
+# Hook file for app
+module RailsMiddlewareLog
+  class Hooks
+    def self.init
+      return unless RailsMiddlewareLog.config.target_urls
+      ActiveSupport.on_load(:after_initialize) do
+        RailsMiddlewareLog::Log.init(Rails.configuration.middleware.middlewares)
+      end
+    end
+  end
+end

data/lib/rails_middleware_log/log.rb

@@ -0,0 +1,61 @@
+# log file when processing
+module RailsMiddlewareLog
+  class Log
+    class << self
+      def init(middlewares)
+        middlewares.each do |middleware|
+          klass = middleware_class(middleware)
+          if klass && klass.method_defined?(:call)
+            klass.class_eval do
+              alias_method :old_call, :call
+
+              def call(env)
+                RailsMiddlewareLog::Log.before_call(self.class, env)
+                old_call(env)
+              end
+            end
+          end
+        end
+      end
+
+      # get the current middleware class
+      def middleware_class(middleware)
+        case middleware.klass
+        when ActiveSupport::Cache::Strategy::LocalCache::Middleware
+          middleware.klass.class
+        when Class
+          middleware.klass
+        else
+          nil
+        end
+      end
+
+      def before_call(k_class, env)
+        if config_url_match?(env['PATH_INFO'])
+          if block = RailsMiddlewareLog.config.before_middleware
+            block.call(k_class, env)
+          else
+            Rails.logger.info "-------#{k_class.name}"
+          end
+        end
+      end
+
+      # check current request
+      def config_url_match?(url)
+        target_urls = RailsMiddlewareLog.config.target_urls
+        case target_urls
+        when true
+          true
+        when String
+          target_urls == url
+        when Array
+          target_urls.include? url
+        when Regexp
+          target_urls === url
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rails_middleware_log/railtie.rb

@@ -0,0 +1,7 @@
+module RailsMiddlewareLog
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'rails_middleware_log' do |_app|
+      RailsMiddlewareLog::Hooks.init
+    end
+  end
+end

data/lib/rails_middleware_log/version.rb

@@ -0,0 +1,3 @@
+module RailsMiddlewareLog
+  VERSION = '0.1.0'
+end

data/rails_middleware_log.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_middleware_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_middleware_log'
+  spec.version       = RailsMiddlewareLog::VERSION
+  spec.authors       = ['fanxiaopeng']
+  spec.email         = ['fanxiaopeng515@163.com']
+
+  spec.summary       = 'log every middleware of rails'
+  spec.description   = 'Print Log for request when every middleware start in Rails. You can set which request to log, and the content you want to print.'
+  spec.homepage      = 'https://github.com/fanxiaopeng/rails_middleware_log'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 0'
+end

data/spec/log_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require 'active_support'
+require 'rails'
+require 'rails_middleware_log/log'
+require 'rails_middleware_log/config'
+describe 'RailsMiddlewareLog::Log' do
+  before do
+
+    class MiddleClass1
+      def call
+      end
+    end
+    class Middle1
+      def klass
+        MiddleClass1
+      end
+    end
+    @middle1 = Middle1.new
+
+    class Middle2
+      def klass
+        ActiveSupport::Cache::Strategy::LocalCache::Middleware.new('', '')
+      end
+    end
+
+    @middle2 = Middle2.new
+  end
+  describe '.init' do
+    it 'add old_call method success' do
+      RailsMiddlewareLog::Log.init([@middle1, @middle2])
+      @middle1.klass.method_defined?(:old_call).equal? true
+      @middle2.klass.class.method_defined?(:old_call).equal? true
+    end
+  end
+
+  describe '.before_call' do
+    before do
+      @env = { 'PATH_INFO' => '/api/path' }
+
+      module Rails
+        def self.logger
+          Logger.new(STDOUT)
+        end
+      end
+    end
+    describe 'target_urls match null' do
+      it 'exec null log' do
+        RailsMiddlewareLog.configure do |config|
+          config.target_urls = '/error/path'
+        end
+        result = RailsMiddlewareLog::Log.before_call(MiddleClass1, @env)
+        expect(result).to be_nil
+      end
+    end
+
+    describe 'no config target_urls' do
+      it 'exec null log' do
+        result = RailsMiddlewareLog::Log.before_call(MiddleClass1, @env)
+        expect(result).to be_nil
+      end
+    end
+
+    describe 'config before_middleware' do
+      it 'exec before_middleware code' do
+        RailsMiddlewareLog.configure do |config|
+          config.target_urls = '/api/path'
+          config.before_middleware = ->(name, env){
+            env['PATH_INFO']
+          }
+        end
+        result = RailsMiddlewareLog::Log.before_call(MiddleClass1, @env)
+        expect(result).to eq @env['PATH_INFO']
+      end
+    end
+
+    describe 'exec default log' do
+      it 'request url match String url' do
+        RailsMiddlewareLog.configure do |config|
+          config.target_urls = '/api/path'
+        end
+        result = RailsMiddlewareLog::Log.before_call(MiddleClass1, @env)
+        expect(result).to be_truthy
+      end
+      it 'request url match Boolean url' do
+        RailsMiddlewareLog.configure do |config|
+          config.target_urls = true
+        end
+        result = RailsMiddlewareLog::Log.before_call(MiddleClass1, @env)
+        expect(result).to be_truthy
+      end
+      it 'request url match Array url' do
+        RailsMiddlewareLog.configure do |config|
+          config.target_urls = ['/api/path']
+        end
+        result = RailsMiddlewareLog::Log.before_call(MiddleClass1, @env)
+        expect(result).to be_truthy
+      end
+
+      it 'request url match Regexp url' do
+        RailsMiddlewareLog.configure do |config|
+          config.target_urls = /api/
+        end
+        result = RailsMiddlewareLog::Log.before_call(MiddleClass1, @env)
+        expect(result).to be_truthy
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rails_middleware_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fanxiaopeng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Print Log for request when every middleware start in Rails. You can set
+  which request to log, and the content you want to print.
+email:
+- fanxiaopeng515@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/.rakeTasks"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/rails_middleware_log.iml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_middleware_log.rb
+- lib/rails_middleware_log/config.rb
+- lib/rails_middleware_log/hooks.rb
+- lib/rails_middleware_log/log.rb
+- lib/rails_middleware_log/railtie.rb
+- lib/rails_middleware_log/version.rb
+- rails_middleware_log.gemspec
+- spec/log_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fanxiaopeng/rails_middleware_log
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: log every middleware of rails
+test_files: []
+has_rdoc: