RubyGems - peastash - Versions diffs - 0.0.8 - Mend

peastash 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

checksums.yaml +7 -0
data/.gitignore +4 -0
data/.travis.yml +6 -0
data/Gemfile +3 -0
data/Gemfile.lock +129 -0
data/README.md +183 -0
data/Rakefile +17 -0
data/lib/peastash/middleware.rb +37 -0
data/lib/peastash/outputs/io.rb +21 -0
data/lib/peastash/rails_ext/railtie.rb +30 -0
data/lib/peastash/rails_ext/watch.rb +15 -0
data/lib/peastash/rails_ext.rb +2 -0
data/lib/peastash/version.rb +3 -0
data/lib/peastash.rb +120 -0
data/peastash.gemspec +31 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/images/.keep +0 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/controllers/concerns/.keep +0 -0
data/spec/dummy/app/controllers/welcome_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/mailers/.keep +0 -0
data/spec/dummy/app/models/.keep +0 -0
data/spec/dummy/app/models/concerns/.keep +0 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config/application.rb +28 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +34 -0
data/spec/dummy/config/environments/production.rb +80 -0
data/spec/dummy/config/environments/test.rb +40 -0
data/spec/dummy/config/environments/test_with_specific_position.rb +41 -0
data/spec/dummy/config/environments/test_without_buchestache.rb +39 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +9 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +56 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/lib/assets/.keep +0 -0
data/spec/dummy/log/.keep +0 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/peastash/middleware_spec.rb +144 -0
data/spec/peastash/rails_ext/railtie_spec.rb +92 -0
data/spec/peastash/rails_ext/watch_spec.rb +24 -0
data/spec/peastash_spec.rb +213 -0
data/spec/spec_helper.rb +31 -0
metadata +289 -0

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/peastash/middleware_spec.rb ADDED Viewed

@@ -0,0 +1,144 @@
+require 'spec_helper'
+require 'peastash/middleware'
+require 'pry'
+describe Peastash::Middleware do
+  before do
+    Peastash.any_instance.stub(:enabled?) { true }
+  end
+  let(:app) { ->(env) { [200, {}, "app"] } }
+  let(:before_block) { ->(env, response) {} }
+  let(:after_block) { ->(env, response) {} }
+  let(:middleware) do
+    Peastash::Middleware.new(app, before_block, after_block)
+  end
+  describe "Rack middleware" do
+    it "wraps the call to the next middleware in a Peastash block" do
+      expect(Peastash.with_instance).to receive(:log)
+      middleware.call env_for('/')
+    end
+    it "doesn't interrupt the middleware chain" do
+      expect(app).to receive(:call).and_call_original
+      middleware.call env_for('/')
+    end
+    it "calls whatever block is given to the middleware" do
+      before_block = ->(env, response) { Peastash.with_instance.store[:before_block] = true }
+      after_block = ->(env, response) { Peastash.with_instance.store[:after_block] = true }
+      middleware = Peastash::Middleware.new(app, before_block, after_block)
+      code, env = middleware.call env_for('/')
+      expect(Peastash.with_instance.store[:before_block]).to be true
+      expect(Peastash.with_instance.store[:after_block]).to be true
+    end
+    context 'storing data in the custom block' do
+      before :each do
+        block = ->(env, response) {
+          request = Rack::Request.new(env)
+          Peastash.with_instance.store[:path] = request.path
+        }
+        @middleware = Peastash::Middleware.new(app, block)
+      end
+      it "can store arbitrary data in the Peastash store" do
+        @middleware.call env_for('/')
+        expect(Peastash.with_instance.store[:path]).to eq('/')
+      end
+      it 'uses the stored data to build the event' do
+        expect(LogStash::Event).to receive(:new).with({
+          '@source' => Peastash::STORE_NAME,
+          '@fields' => { path: '/', duration: 0, status: 200, ip: nil },
+          '@tags' => []
+        })
+        Timecop.freeze { @middleware.call env_for('/') }
+      end
+    end
+    context 'storing data in the rack app' do
+      before :each do
+        app = ->(env) do
+          request = Rack::Request.new(env)
+          Peastash.with_instance.store[:scheme] = request.scheme
+          [200, {}, "app"]
+        end
+        @middleware = Peastash::Middleware.new(app, before_block)
+      end
+      it "can store arbitrary data in the Peastash store" do
+        @middleware.call env_for('/')
+        expect(Peastash.with_instance.store[:scheme]).to eq('http')
+      end
+      it 'uses the stored data to build the event' do
+        expect(LogStash::Event).to receive(:new).with({
+          '@source' => Peastash::STORE_NAME,
+          '@fields' => { scheme: 'http', duration: 0, status: 200, ip: nil },
+          '@tags' => []
+        })
+        Timecop.freeze { @middleware.call env_for('/') }
+      end
+    end
+    context 'without a custom block' do
+      it "doesn't try to call the block" do
+        @middleware = Peastash::Middleware.new(app)
+        expect {
+          @middleware.call env_for('/')
+        }.to_not raise_error
+      end
+    end
+    context 'persistence between before/after block' do
+      it "saves instance variables between before/after block" do
+        before_block = ->(env, request) { @foo = 'foo' }
+        after_block = ->(env, request) { Peastash.with_instance.store[:foo] = @foo }
+        @middleware = Peastash::Middleware.new(app, before_block, after_block)
+        expect(LogStash::Event).to receive(:new).with({
+          '@source' => Peastash::STORE_NAME,
+          '@fields' => { duration: 0, status: 200, foo: 'foo', ip: nil },
+          '@tags' => [],
+        })
+        Timecop.freeze { @middleware.call env_for('/') }
+      end
+    end
+    context "exception in before / after block" do
+      before :each do
+        Peastash.safe!
+        before_block = ->(env, request) { 1 / 0 }
+        after_block = ->(env, request) { unknown_method }
+        @middleware = Peastash::Middleware.new(app, before_block, after_block)
+        STDERR.stub(:puts)
+      end
+      after(:each) { STDERR.unstub(:puts) }
+      it "doesn't interrupt the middleware flow, logging should be transparent" do
+        expect {
+          @middleware.call env_for('/')
+        }.to_not raise_error
+      end
+      it "puts the error to STDERR for easy debugging" do
+        expect(STDERR).to receive(:puts).twice
+        @middleware.call env_for('/')
+      end
+    end
+    it "doesn't catch exception in the app" do
+      Peastash.safe!
+      app = ->(env) { raise }
+      @middleware = Peastash::Middleware.new(app)
+      expect {
+        @middleware.call env_for('/')
+      }.to raise_error
+    end
+  end
+end

data/spec/peastash/rails_ext/railtie_spec.rb ADDED Viewed

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'rails'
+require 'peastash/rails_ext'
+require 'simplecov'
+describe Peastash::Railtie do
+  context 'not configured' do
+    it "doesn't add the middleware by default" do
+      run_with_env 'test_without_peastash' do
+        expect(Rails.application.middleware).to_not include(Peastash::Middleware)
+      end
+    end
+    it "doesn't add the subscriber" do
+      run_with_env 'test_without_peastash' do
+        Peastash.with_instance.store.clear
+        ActiveSupport::Notifications.instrument('process_action.action_controller', db_runtime: 1)
+        expect(Peastash.with_instance.store).to_not include(db: 1)
+      end
+    end
+  end
+  context 'correctly configured' do
+    context 'with specific conf' do
+      it 'places the middleware before the configured middleware if specified' do
+        run_with_env 'test_with_specific_position' do
+          cookies_index = -1
+          Rails.application.middleware.each_with_index { |middleware, index| cookies_index = index if middleware == ActionDispatch::Cookies }
+          expect(Rails.application.middleware[cookies_index - 1]).to eq(Peastash::Middleware)
+        end
+      end
+    end
+    context 'with regular conf' do
+      before :all do
+        ENV['RAILS_ENV'] = 'test'
+        require 'dummy/config/environment'
+      end
+      before(:each) { Peastash.with_instance.store.clear }
+      context 'middleware' do
+        it "adds the middleware" do
+          expect(Rails.application.middleware).to include(Peastash::Middleware)
+        end
+        it 'adds the middleware before ActionDispatch::ShowExceptions by default' do
+          show_exceptions_index = -1
+          Rails.application.middleware.each_with_index { |middleware, index| show_exceptions_index = index if middleware == ActionDispatch::ShowExceptions }
+          expect(Rails.application.middleware[show_exceptions_index - 1]).to eq(Peastash::Middleware)
+        end
+      end
+      it "adds a subscriber on 'process_action.action_controller' to gather metrics about the request" do
+        ActiveSupport::Notifications.instrument('process_action.action_controller', db_runtime: 1)
+        expect(Peastash.with_instance.store).to include(db: 1)
+      end
+      context "params logging" do
+        it "doesn't log the parameters if log_parameters isn't true" do
+          Peastash.with_instance.configuration[:log_parameters] = false
+          Rails.application.call env_for('/')
+          expect(Peastash.with_instance.store.keys).to_not include(:params)
+        end
+        it "logs the parameters if log_parameters is true" do
+          Peastash.with_instance.configuration[:log_parameters] = true
+          Rails.application.call env_for('/')
+          expect(Peastash.with_instance.store.keys).to include(:params)
+        end
+        it "doesn't log filtered parameters in clear text" do
+          Peastash.with_instance.configuration[:log_parameters] = true
+          Rails.application.call env_for('/?password=foo')
+          expect(Peastash.with_instance.store[:params]["password"]).to eq("[FILTERED]")
+        end
+      end
+    end
+  end
+end
+def run_with_env(env = 'test')
+  # Can't run those tests on jruby... yet
+  return if RUBY_PLATFORM == 'java'
+  fork do
+    SimpleCov.running = false
+    ENV['RAILS_ENV'] = env
+    require 'dummy/config/environment'
+    yield
+  end
+end

data/spec/peastash/rails_ext/watch_spec.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'peastash/rails_ext/watch'
+describe "Peastash::Watch" do
+  it "adds the #watch method to Peastash" do
+    expect(Peastash.with_instance).to respond_to(:watch)
+  end
+  describe "#watch" do
+    it "can subscribe to any notification" do
+      @dummy = Object.new.stub(:foo)
+      @subscriber = Peastash.with_instance.watch('foo.bar') { @dummy.foo }
+      expect(@dummy).to receive(:foo)
+      ActiveSupport::Notifications.instrument('foo.bar')
+      ActiveSupport::Notifications.unsubscribe(@subscriber)
+    end
+    it "is provided with a handy named store" do
+      Peastash.with_instance.watch('foo.bar') { |*event, store| store[:foo] = 'bar' }
+      @subscriber = ActiveSupport::Notifications.instrument('foo.bar')
+      expect(Peastash.with_instance.store['foo.bar']).to eq(foo: 'bar')
+    end
+  end
+end

data/spec/peastash_spec.rb ADDED Viewed

@@ -0,0 +1,213 @@
+require 'spec_helper'
+describe Peastash do
+  after(:each) { unconfigure_foostash! }
+  describe 'enabled' do
+    before :each do
+      Peastash.any_instance.stub(:enabled?) { true }
+    end
+    describe "scoped instances" do
+      it 'always return the same instance for the same name' do
+        expect(Peastash.with_instance(:foo)).to be(Peastash.with_instance(:foo))
+      end
+      it 'returns different instances for different names' do
+        expect(Peastash.with_instance(:bar)).to_not be(Peastash.with_instance(:foo))
+      end
+      it 'uses `global` as the default instance name' do
+        expect(Peastash.with_instance(:global)).to be(Peastash.with_instance)
+      end
+      it 'inherits its configuration for the `global` conf' do
+        Peastash.with_instance(:global).configure!({source: :foo})
+        expect(Peastash.with_instance(:bar).configuration[:source]).to be(:foo)
+      end
+    end
+    describe "#configure!" do
+      it 'allows setting tags to be added to every event' do
+        tags = ['foo', 'bar']
+        Peastash.with_instance.configure!(tags: tags)
+        expect(LogStash::Event).to receive(:new).with({
+          '@source' => Peastash::STORE_NAME,
+          '@fields' => {},
+          '@tags' => tags
+        })
+        Peastash.with_instance.log {}
+      end
+      it "can customize the source" do
+        Peastash.with_instance.configure!(source: 'foo')
+        expect(LogStash::Event).to receive(:new).with({
+          '@source' => 'foo',
+          '@fields' => {},
+          '@tags' => []
+        })
+        Peastash.with_instance.log {}
+      end
+      it "can customize the store name" do
+        Peastash.with_instance.configure!(store_name: :foo)
+        Peastash.with_instance.store[:bar] = 'bar'
+        expect(Thread.current[:global].keys).to include(:foo)
+        expect(Thread.current[:global][:foo]).to eq(bar: 'bar')
+      end
+      context "dump if empty?" do
+        it "can prevent logging if nothing is stored" do
+          Peastash.with_instance.configure!(dump_if_empty: false)
+          expect(Peastash.with_instance.instance_variable_get(:@output)).to_not receive(:dump)
+          Peastash.with_instance.log {}
+        end
+        it "doesn't prevent logging if set to true" do
+          Peastash.with_instance.configure!(dump_if_empty: true)
+          expect(Peastash.with_instance.instance_variable_get(:@output)).to receive(:dump)
+          Peastash.with_instance.log {}
+        end
+      end
+    end
+    describe "#log" do
+      context "Peastash not configured" do
+        it "calls #configure! beforehand" do
+          expect(Peastash.with_instance).to receive(:configure!).once.and_call_original
+          Peastash.with_instance.log {}
+        end
+      end
+      context "Peastash already configured" do
+        before { Peastash.with_instance.configure! }
+        it "doesn't call #configure!" do
+          expect(Peastash).to_not receive(:configure!)
+          Peastash.with_instance.log {}
+        end
+      end
+      it "sends the event to the output" do
+        Peastash.with_instance.configure!
+        expect(Peastash.with_instance.instance_variable_get(:@output)).to receive(:dump)
+        Peastash.with_instance.log {}
+      end
+      it "clears the store beforehand" do
+        Peastash.with_instance.configure!
+        Peastash.with_instance.store[:foo] = 'bar'
+        Peastash.with_instance.log {}
+        expect(Peastash.with_instance.store.keys).to_not include(:foo)
+      end
+      it "aggregates everything in the store and dumps it" do
+        Peastash.with_instance.configure!
+        Peastash.with_instance.log do
+          Peastash.with_instance.store[:foo] = ['foo']
+          Peastash.with_instance.store[:foo] << 'bar'
+        end
+        expect(Peastash.with_instance.store[:foo]).to eq(['foo', 'bar'])
+      end
+      it "merges the tags from the parameters with the base tags" do
+        base_tags = %w(foo bar)
+        tags = %w(baz)
+        Peastash.with_instance.configure!(tags: base_tags)
+        expect(LogStash::Event).to receive(:new).with({
+          '@source' => Peastash::STORE_NAME,
+          '@fields' => {},
+          '@tags' => base_tags + tags
+        })
+        Peastash.with_instance.log(tags) {}
+      end
+    end
+    describe ".safely" do
+      context "when safe" do
+        before { Peastash.safe! }
+        it 'rescues errors silently' do
+          expect {
+            Peastash.safely { 1 / 0 }
+          }.not_to raise_error
+        end
+        it 'returns value returned from the block' do
+          expect(Peastash.safely { "test" }).to eq("test")
+        end
+        it "puts the error to STDERR for easy debugging" do
+          expect(STDERR).to receive(:puts)
+          Peastash.safely { 1 / 0 }
+        end
+      end
+      context "when unsafe" do
+        before { Peastash.unsafe! }
+        it 'doesn\'t rescue errors silently' do
+          expect {
+            Peastash.safely { 1 / 0 }
+          }.to raise_error(ZeroDivisionError)
+        end
+        it "puts the error to STDERR for easy debugging" do
+          expect(STDERR).to receive(:puts)
+          expect {
+            Peastash.safely { 1 / 0 }
+          }.to raise_error(ZeroDivisionError)
+        end
+      end
+    end
+    describe "#tags" do
+      it "calls configure beforehand if instance isn't configured" do
+        expect(Peastash.with_instance).to receive(:configure!).and_call_original
+        Peastash.with_instance.tags << 'foo'
+      end
+      it "makes it possible to add tags from within the #log block" do
+        base_tags = %w(foo bar)
+        tags = %w(baz)
+        additional_tags = %w(qux)
+        Peastash.with_instance.configure!(tags: base_tags)
+        expect(LogStash::Event).to receive(:new).with({
+          '@source' => Peastash::STORE_NAME,
+          '@fields' => {},
+          '@tags' => base_tags + tags + additional_tags
+        })
+        Peastash.with_instance.log(tags) { Peastash.with_instance.tags.concat(additional_tags) }
+      end
+    end
+  end
+  describe 'disabled' do
+    it "can process the called stuff in the #log block" do
+      expect {
+        Peastash.with_instance.log do
+          raise
+        end
+      }.to raise_error
+    end
+    it "can process the called stuff in the #log block" do
+      expect { |b|
+        Peastash.with_instance.log(&b)
+      }.to yield_with_args(Peastash.with_instance)
+    end
+    it "can process the called stuff for custom instance in the #log block" do
+      expect { |b|
+        Peastash.with_instance(:worker).log(&b)
+      }.to yield_with_args(Peastash.with_instance(:worker))
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,31 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+# ENV['RACK_ENV'] = 'test'
+# ENV['RAILS_ENV'] = 'test'
+require 'timecop'
+require 'simplecov'
+require 'rack/test'
+require 'peastash'
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.before(:all) do
+    # Muting the output from the logger
+    Peastash::Outputs::IO.class_variable_set(:@@default_io, File.open(File::NULL, File::WRONLY))
+  end
+  config.before(:each) do
+    # For the errors to be raised
+    Peastash.unsafe!
+  end
+end
+def unconfigure_foostash!
+  Peastash.class_variable_set(:@@instance_cache, ThreadSafe::Cache.new)
+end
+def env_for(url, opts={})
+  Rack::MockRequest.env_for(url, opts)
+end