mongo_request_logger 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1a7c2d660f9091c18bab904f5c7adf9c7481dfd
-  data.tar.gz: 756f66c113e76c516016dc068de35e6c81bf3f0e
+  metadata.gz: 10ab543ab4fed5e432099b38ce6c32bc3e745aa0
+  data.tar.gz: b202b63d0c93bd20baea08a806f3325bdd1114c6
 SHA512:
-  metadata.gz: 7248658d11b915dd320dc65104c20b238b4f64f1f496925f9e9ed7abe2aeaba2a2efc504d82380a98289e4d44cd6209ee7b3899730a4526d967167719b7257ee
-  data.tar.gz: a66e533c523a2c78ba07f2faac8442fa7e6e82940f6597d8d56da426fa1b8246148c8cc7ac28a4c95bb7342fc2ea28b399c844004cf57171f8be2cc9ce1eee3e
+  metadata.gz: a7a24b97466f0803cd2ff95a180ff122fbc82bd646e39c381f65e7ecf15bfdac68a328b2f9ac029bb496c415d4d3ae0a391674a0c4a0de1c501aada5529bdeeb
+  data.tar.gz: 1f591f39c0926808a0f1308fda972968e54798a24226bc6b1a7901e33eba9dc13f90a5725d7fcf34d4da29562744a1abadfdb5f110e115e911b82282d8efb497

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.2.2

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+before_install:
+  - gem install bundler
 script: "bundle exec rspec"
 branches:
   except:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.0
+
+*Backwards incompatible!*
+
+* Replace Moped with the official Mongo Ruby Driver, while retaining support for the mongoid configuration file.
+
 ## 0.5.0
 
 *Backwards incompatible!*

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'moped', '~> 2.0'
+gem 'mongo', '~> 2.0'
 gem 'mongoid', '~> 4.0'
 gem 'rspec'
 gem 'sinatra', '~> 1.4.0'

data/README.md

@@ -18,7 +18,7 @@ Example:
 
     development:
       sessions:
-        loggger:
+        logger:
           database: your_log_db
           hosts:
             - host1:27017
@@ -44,7 +44,7 @@ In config.ru:
     require './yourapp'
 
     # Configure database details
-    session = Moped::Session.new(%w(127.0.0.1:27017))
+    session = Mongo::Client.new(%w(127.0.0.1:27017))
     session.use 'your_log_db'
     session.options[:capsize] = 10 # MB
 

data/config.ru

@@ -1,12 +1,11 @@
 # Sinatra app for viewing logs
-require 'moped'
+require 'mongo'
 require 'mongo_request_logger/viewer'
 
-session = Moped::Session.new(%w(127.0.0.1:27017))
-session.use ENV['DB'] || 'request_logger_test'
-session.options[:capsize] = 10 # MB
+client = Mongo::Client.new(%w(127.0.0.1:27017))
+client.use ENV['DB'] || 'request_logger_test'
 
-MongoRequestLogger::Viewer.adapter = MongoRequestLogger::Adapters::Moped.new(session)
+MongoRequestLogger::Viewer.adapter = MongoRequestLogger::Adapters::Moped.new(client)
 
 MongoRequestLogger::Viewer.run!
 

data/gemfiles/rails4.2.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'mongo', '~> 2.0'
 gem 'moped', '~> 2.0'
 gem 'mongoid', '~> 4.0'
 gem 'rspec'

data/gemfiles/sinatra1.4.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'mongo', '~> 2.0'
 gem 'moped', '~> 2.0'
 gem 'mongoid', '~> 4.0'
 gem 'rspec'

data/lib/mongo_request_logger/adapters/base.rb

@@ -3,6 +3,7 @@
 module MongoRequestLogger
   module Adapters
     class Base
+      DEFAULT_CAP_SIZE = 100
 
       attr_reader :configuration, :connection, :connection_type, :collection, :authenticated
 
@@ -12,7 +13,8 @@ module MongoRequestLogger
 
       # Capsize in bytes
       def capsize
-        options[:capsize] * 1024 * 1024
+        cap = options[:capsize] || DEFAULT_CAP_SIZE
+        cap * 1024 * 1024
       end
 
       def authenticated?

data/lib/mongo_request_logger/adapters/mongo.rb

@@ -0,0 +1,62 @@
+require 'mongo'
+require 'mongo_request_logger/adapters/base'
+
+module MongoRequestLogger
+  module Adapters
+    class Mongo < Base
+      def initialize client, opts = {}
+        @connection = client.database
+
+        @options = {
+          read: {
+            mode: :secondary_preferred
+          },
+          write: {
+            w: 0
+          }
+        }
+        @options.merge!(@connection.options.deep_dup)
+        @options.merge!(opts)
+
+        check_for_collection
+      end
+
+      def options
+        @options.with_indifferent_access
+      end
+
+      def create_collection
+        @collection = @connection[collection_name, capped: true, size: capsize]
+        @collection.create
+      end
+
+      def create_index field
+        @collection.indexes.create_one({ field: 1 }, background: true)
+      end
+
+      def insert_log_record(record)
+        @collection.insert_one(record)
+      end
+
+      def collection_stats
+        collection_stats_hash(@connection.command(collStats: collection_name).first)
+      end
+
+      def query(criteria, options={})
+        q = @collection.find(criteria).sort({'timestamp' => -1})
+        if options[:limit]
+          q = q.limit(options[:limit])
+        end
+        q
+      end
+
+      def find_by_id(id)
+        @collection.find("_id" => ::BSON::ObjectId.from_string(id)).first
+      end
+
+      def clear!
+        @collection.drop
+      end
+    end
+  end
+end

data/lib/mongo_request_logger/mongoid_config.rb

@@ -0,0 +1,95 @@
+module MongoRequestLogger
+  # Directly parse the mongoig.yml config and present accessors similar to Mongoid 5.
+  # TODO: to be replaced by the Mongoid 5 default behaviour
+  module MongoidConfig
+    def self.clients
+      @clients ||= ClientMap.new
+    end
+
+    class ClientMap
+      attr_reader :config
+
+      def initialize
+        @clients = HashWithIndifferentAccess.new
+        config_file = Rails.root.join("config", "mongoid.yml")
+        @config = Environment.load_yaml(config_file).with_indifferent_access
+        @config = @config[:sessions]
+        @config = @config.with_indifferent_access
+      end
+
+      def [] key
+        config = @config[key]
+        raise Mongoid::Errors::NoSessionConfig.new(key) unless config
+        @clients[key] ||= ClientFactory.create(config)
+      end
+    end
+
+    class ClientFactory
+      def self.create configuration
+        raise unless configuration
+        if configuration[:uri]
+          Mongo::Client.new(configuration[:uri], options(configuration))
+        else
+          opts = options(configuration).merge(database: configuration[:database])
+          opts = opts.merge(credentials(configuration))
+          Mongo::Client.new(configuration[:hosts], opts)
+        end
+      end
+
+      private
+
+      def self.options(configuration)
+        config = configuration.dup
+        options = config.delete(:options) || {}
+        options.reject{ |k, v| k == :hosts }.to_hash.symbolize_keys!
+      end
+
+      def self.credentials(configuration)
+        details = {}
+        details[:user] = configuration[:username] unless configuration[:username].nil?
+        details[:password] = configuration[:password] unless configuration[:password].nil?
+        details
+      end
+    end
+    
+    class NoEnvironment < RuntimeError; end
+    # Encapsulates logic for getting environment information.
+    module Environment
+      extend self
+
+      # Get the name of the environment that we are running under. This first
+      # looks for Rails, then Sinatra, then a RACK_ENV environment variable,
+      # and if none of those are found raises an error.
+      #
+      # @example Get the env name.
+      #   Environment.env_name
+      #
+      # @raise [ Errors::NoEnvironment ] If no environment was set.
+      #
+      # @return [ String ] The name of the current environment.
+      #
+      # @since 2.3.0
+      def env_name
+        return Rails.env if defined?(Rails) && Rails.respond_to?(:env)
+        return Sinatra::Base.environment.to_s if defined?(Sinatra)
+        ENV["RACK_ENV"] || ENV["MONGOID_ENV"] || raise(NoEnvironment.new)
+      end
+
+      # Load the yaml from the provided path and return the settings for the
+      # current environment.
+      #
+      # @example Load the yaml.
+      #   Environment.load_yaml("/work/mongoid.yml")
+      #
+      # @param [ String ] path The location of the file.
+      #
+      # @return [ Hash ] The settings.
+      #
+      # @since 2.3.0
+      def load_yaml(path, environment = nil)
+        env = environment ? environment.to_s : env_name
+        YAML.load(ERB.new(File.new(path).read).result)[env]
+      end
+    end
+  end
+end

data/lib/mongo_request_logger/railtie.rb

@@ -7,6 +7,7 @@ if defined? Rails
     class Railtie < ::Rails::Railtie
       class << self
         def setup(app)
+          Mongo::Logger.logger.level = Logger::INFO # Because spammy.
           logger = MongoRequestLogger.configure(fallback_log: Rails.root.join("log/#{Rails.env}.log"))
 
           app.config.logger = logger
@@ -24,20 +25,22 @@ if defined? Rails
 
           app.config.middleware.insert_after ActionDispatch::DebugExceptions, MongoRequestLogger::Rack
 
-          app.config.after_initialize do
-            # Unicorn clears the START_CTX when a worker is forked, so if we have
-            # data in START_CTX then we know we're being preloaded. Unicorn does
-            # not provide application-level hooks for executing code after the
-            # process has forked, so we reconnect lazily.
-            if defined?(Unicorn) && !Unicorn::HttpServer::START_CTX.empty?
-              ::MongoRequestLogger.session.disconnect
-            end
+          unless logger.adapter.is_a?(MongoRequestLogger::Adapters::Mongo)
+            app.config.after_initialize do
+              # Unicorn clears the START_CTX when a worker is forked, so if we have
+              # data in START_CTX then we know we're being preloaded. Unicorn does
+              # not provide application-level hooks for executing code after the
+              # process has forked, so we reconnect lazily.
+              if defined?(Unicorn) && !Unicorn::HttpServer::START_CTX.empty?
+                ::MongoRequestLogger.session.disconnect
+              end
 
-            # Passenger provides the :starting_worker_process event for executing
-            # code after it has forked, so we use that and reconnect immediately.
-            if ::Mongoid::Config.running_with_passenger?
-              PhusionPassenger.on_event(:starting_worker_process) do |forked|
-                ::MongoRequestLogger.session.disconnect if forked
+              # Passenger provides the :starting_worker_process event for executing
+              # code after it has forked, so we use that and reconnect immediately.
+              if ::Mongoid::Config.running_with_passenger?
+                PhusionPassenger.on_event(:starting_worker_process) do |forked|
+                  ::MongoRequestLogger.session.disconnect if forked
+                end
               end
             end
           end

data/lib/mongo_request_logger/version.rb

@@ -1,3 +1,3 @@
 module MongoRequestLogger
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/mongo_request_logger.rb

@@ -9,8 +9,10 @@ if defined?(Rails)
 end
 
 require 'mongoid'
-require 'moped'
-require 'mongo_request_logger/adapters/moped'
+
+require 'mongo'
+require_relative './mongo_request_logger/adapters/mongo.rb'
+require_relative './mongo_request_logger/mongoid_config.rb'
 
 
 module MongoRequestLogger
@@ -24,13 +26,14 @@ module MongoRequestLogger
     require 'mongo_request_logger/viewer'
 
     environment = ENV['RACK_ENV'] || ENV['RAILS_ENV']
-    session = options[:session] || Mongoid::Sessions.with_name(:logger)
+
+    session = MongoidConfig.clients[:logger]
     if session
-      log_config = session.options
+      log_config = MongoidConfig.clients.config[:logger][:options].with_indifferent_access
 
       fallback_log = options[:fallback_log] || log_config['fallback_log'] || "log/#{environment}.log"
 
-      adapter = MongoRequestLogger::Adapters::Moped.new(session)
+      adapter = MongoRequestLogger::Adapters::Mongo.new(session, log_config)
 
       @session = session
 

data/spec/mongodriver_logger_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'mongo_request_logger'
+require 'mongo'
+require 'shared_examples'
+
+include MongoRequestLogger
+
+describe 'MongoRequestLogger::Logger with mongo-ruby-driver' do
+  before do
+    Mongo::Logger.logger.level = Logger::INFO
+    client = Mongo::Client.new(%w(127.0.0.1:27017), database: "request_logger_test")
+    begin
+      client = client.with(user: "request_logger_test", password: "test_password")
+      client.command(ping: 1)
+    rescue Mongo::Auth::Unauthorized => e
+      # Try without authentication
+      client.command(ping: 1)
+    end
+    
+    client['server_log'].drop rescue nil
+
+    @adapter = MongoRequestLogger::Adapters::Mongo.new(client, capsize: 10)
+
+    @file = 'test-log.txt'
+    FileUtils.remove @file, :force => true
+  end
+
+  after do
+    FileUtils.remove @file, :force => true
+  end
+
+  include_examples "log"
+
+end

data/spec/rails_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-
 begin
   require 'rails'
 
@@ -8,7 +7,6 @@ begin
   require 'dummy/application'
 
 
-
   describe "Rails Integration" do
     let(:app) do
       Rails.application

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongo_request_logger
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Embark Mobile
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -376,15 +376,15 @@ files:
 - gemfiles/sinatra1.4.gemfile
 - lib/mongo_request_logger.rb
 - lib/mongo_request_logger/adapters/base.rb
-- lib/mongo_request_logger/adapters/moped.rb
+- lib/mongo_request_logger/adapters/mongo.rb
 - lib/mongo_request_logger/backtrace_cleaner.rb
 - lib/mongo_request_logger/ext/activesupport_logger.rb
 - lib/mongo_request_logger/ext/logger.rb
-- lib/mongo_request_logger/ext/moped_session.rb
 - lib/mongo_request_logger/log_message.rb
 - lib/mongo_request_logger/logged_job.rb
 - lib/mongo_request_logger/logger.rb
 - lib/mongo_request_logger/logger_extensions.rb
+- lib/mongo_request_logger/mongoid_config.rb
 - lib/mongo_request_logger/rack.rb
 - lib/mongo_request_logger/railtie.rb
 - lib/mongo_request_logger/search_terms.rb
@@ -394,7 +394,7 @@ files:
 - spec/dummy/application.rb
 - spec/dummy/config/mongoid.yml
 - spec/dummy/log/.gitkeep
-- spec/moped_logger_spec.rb
+- spec/mongodriver_logger_spec.rb
 - spec/query_spec.rb
 - spec/rails_spec.rb
 - spec/shared_examples.rb
@@ -424,7 +424,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Structured logger and log viewer for Rack (including Rails) requests
@@ -432,7 +432,7 @@ test_files:
 - spec/dummy/application.rb
 - spec/dummy/config/mongoid.yml
 - spec/dummy/log/.gitkeep
-- spec/moped_logger_spec.rb
+- spec/mongodriver_logger_spec.rb
 - spec/query_spec.rb
 - spec/rails_spec.rb
 - spec/shared_examples.rb

data/lib/mongo_request_logger/adapters/moped.rb

@@ -1,64 +0,0 @@
-# Adapted from https://github.com/le0pard/mongodb_logger/
-require 'moped'
-
-require 'mongo_request_logger/adapters/base'
-require 'mongo_request_logger/ext/moped_session'
-
-module MongoRequestLogger
-  module Adapters
-    class Moped < Base
-      class << self
-        attr_accessor :connection
-      end
-
-
-      def initialize(session)
-        @connection = session
-        MongoRequestLogger::Adapters::Moped.connection = @connection
-
-        @connection_type = @connection.class
-
-        check_for_collection
-      end
-
-      def options
-        @connection.options
-      end
-
-      def create_collection
-        @connection.cluster.with_primary do |node|
-          node.command(@connection.send(:current_database).name, {create: collection_name, capped: true, size:  capsize})
-        end
-      end
-
-      def create_index field
-        @collection.indexes.create({field => 1})
-      end
-
-      def insert_log_record(record)
-        record[:_id] = ::BSON::ObjectId.new
-        @connection.with(safe: false)[collection_name].insert(record)
-      end
-
-      def collection_stats
-        collection_stats_hash(@connection.command(collStats: collection_name))
-      end
-
-      def query(criteria, options={})
-        q = @collection.find(criteria).sort({'timestamp' => -1})
-        if options[:limit]
-          q = q.limit(options[:limit])
-        end
-        q
-      end
-
-      def find_by_id(id)
-        @collection.find("_id" => ::BSON::ObjectId.from_string(id)).first
-      end
-
-      def clear!
-        @collection.drop
-      end
-    end
-  end
-end

data/lib/mongo_request_logger/ext/moped_session.rb

@@ -1,5 +0,0 @@
-require 'moped'
-require 'moped/session'
-
-# We use an additional :capsize option in the config.
-Moped::Session.send(:option, :capsize).allow(Optionable.any(Integer))

data/spec/moped_logger_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-require 'mongo_request_logger'
-require 'moped'
-require 'shared_examples'
-
-include MongoRequestLogger
-
-describe 'MongoRequestLogger::Logger with moped' do
-  before do
-    session = Moped::Session.new(%w(127.0.0.1:27017))
-    session.use "request_logger_test"
-    begin
-      session.login("request_logger_test", "test_password")
-      session.command(ping: 1)
-    rescue Moped::Errors::AuthenticationFailure => e
-      session.logout
-      session.command(ping: 1)
-    end
-    
-    session['server_log'].drop rescue nil
-
-    session.options[:capsize] = 10
-    @adapter = MongoRequestLogger::Adapters::Moped.new(session)
-
-    @file = 'test-log.txt'
-    FileUtils.remove @file, :force => true
-  end
-
-  after do
-    FileUtils.remove @file, :force => true
-  end
-
-  include_examples "log"
-
-end