pliny 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56651d8e3b670e7954a475c9d8cb04cc0124099f
-  data.tar.gz: ad7701bdf942d068994be11da8b3ceb7bc231082
+  metadata.gz: 50ee2327594f7a24b91de1931315b9d56857a6db
+  data.tar.gz: 19764f159ec7799e68d4d704ff679b2101eddf43
 SHA512:
-  metadata.gz: d73cbdd0b3dcde8423dc2743af931738bc41a5d608281a031f29a160ac9cee73d8e40a7dac34274e0b619e9b695487c464286efcd412c20e79f8e61f4b03d09d
-  data.tar.gz: cf7bc5313022abc17ebee414f53ad004d66cd3177bee895daf8b7ba755451ee93602f41a0b128c9b1f9658cdeda1bebbf291a67a8ed2f424f8867246421978e0
+  metadata.gz: 9c20a3261666622c51f92614f2c4c49bd3d169b34fed20f8359ba6647a45ed4fc5bdbde260127ea9f4d6dae66a909a80bf2cc756d28845900afed16449bc5838
+  data.tar.gz: d29a0d1bf16fd8cc623b7ee302113cf61b131bab0d171fc41e96cef1703d6bc4c3b097b352b3b4c4b6ddb6f0a3ea88ba2fcb8fb5c4946da23f0d4e4fd4db3a4c

data/lib/pliny.rb

@@ -2,12 +2,13 @@ require "multi_json"
 require "sinatra/base"
 
 require_relative "pliny/version"
-require_relative "pliny/error_reporter"
+require_relative "pliny/error_reporters"
 require_relative "pliny/errors"
 require_relative "pliny/helpers/encode"
 require_relative "pliny/helpers/params"
 require_relative "pliny/helpers/serialize"
 require_relative "pliny/log"
+require_relative "pliny/metrics"
 require_relative "pliny/request_store"
 require_relative "pliny/rollbar_logger"
 require_relative "pliny/router"

data/lib/pliny/error_reporters.rb

@@ -0,0 +1,19 @@
+module Pliny::ErrorReporters
+  extend self
+
+  @error_reporters = []
+
+  attr_accessor :error_reporters
+
+  def notify(exception, context: {}, rack_env: {})
+    Pliny.log_exception(exception)
+
+    error_reporters.each do |reporter|
+      begin
+        reporter.new.notify(exception, context: context, rack_env: rack_env)
+      rescue
+        Pliny.log_exception($!)
+      end
+    end
+  end
+end

data/lib/pliny/error_reporters/rollbar.rb

@@ -0,0 +1,30 @@
+require 'rollbar/exception_reporter'
+require 'rollbar/request_data_extractor'
+
+module Pliny
+  module ErrorReporters
+    class Rollbar
+      include ::Rollbar::ExceptionReporter
+      include ::Rollbar::RequestDataExtractor
+
+      def notify(exception, context:, rack_env:)
+        ::Rollbar.reset_notifier!
+        scope = fetch_scope(context: context, rack_env: rack_env)
+        ::Rollbar.scoped(scope) do
+          report_exception_to_rollbar(rack_env, exception)
+        end
+      end
+
+      private
+
+      def fetch_scope(context:, rack_env:)
+        {
+          request: proc { extract_request_data_from_rack(rack_env) }
+        }
+      rescue Exception => e
+        report_exception_to_rollbar(rack_env, e)
+        raise
+      end
+    end
+  end
+end

data/lib/pliny/metrics.rb

@@ -0,0 +1,29 @@
+module Pliny
+  module Metrics
+    def self.count(*names, value: 1)
+      counts = Hash[names.map { |n| [metric_prefix(:count, n), value] }]
+      Pliny.log(counts)
+    end
+
+    def self.measure(*names, &block)
+      elapsed, return_value = time_elapsed(&block)
+      measures = Hash[names.map { |n| [metric_prefix(:measure, n), elapsed] }]
+      Pliny.log(measures)
+
+      return_value
+    end
+
+    private
+
+    def self.metric_prefix(type, name)
+      "#{type.to_s}##{Config.app_name}.#{name}"
+    end
+
+    def self.time_elapsed(&block)
+      start = Time.now
+      return_value = block.call
+      [Time.now - start, return_value]
+    end
+  end
+end
+

data/lib/pliny/middleware/rescue_errors.rb

@@ -12,7 +12,7 @@ module Pliny::Middleware
     rescue => e
       raise if @raise
 
-      Pliny::ErrorReporter.notify(e, rack_env: env)
+      Pliny::ErrorReporters.notify(e, rack_env: env)
       Pliny::Errors::Error.render(Pliny::Errors::InternalServerError.new)
     end
   end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.17.1"
+  VERSION = "0.18.0"
 end

data/lib/template/Gemfile

@@ -4,13 +4,13 @@ ruby "2.3.1"
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.17"
+gem "pliny", "~> 0.18"
 gem "pry"
 gem "puma", "~> 2.16"
 gem "rack-ssl"
 gem "rack-timeout", "~> 0.4"
 gem "rake"
-gem "rollbar", require: "rollbar/middleware/sinatra"
+gem "rollbar"
 gem "sequel", "~> 4.34"
 gem "sequel-paranoid"
 gem "sequel_pg", "~> 1.6", require: "sequel"

data/lib/template/config/initializers/rollbar.rb

@@ -1,3 +1,7 @@
+require 'pliny/error_reporters/rollbar'
+
+Pliny::ErrorReporters.error_reporters << Pliny::ErrorReporters::Rollbar
+
 Rollbar.configure do |config|
   config.enabled = ENV.has_key?('ROLLBAR_ACCESS_TOKEN')
   config.disable_rack_monkey_patch = true

data/spec/{error_reporter_spec.rb → error_reporters_spec.rb}

@@ -1,9 +1,10 @@
-
 require "spec_helper"
 
-describe Pliny::ErrorReporter do
+describe Pliny::ErrorReporters do
   subject(:reporter) { described_class }
 
+  let(:reporter_double) { double("reporter").as_null_object }
+
   describe ".notify" do
     let(:exception) { RuntimeError.new }
     let(:context)   { { context: "foo" } }
@@ -13,12 +14,18 @@ describe Pliny::ErrorReporter do
       reporter.notify(exception, context: context, rack_env: rack_env)
     end
 
-    it "notifies rollbar" do
-      expect_any_instance_of(Pliny::ErrorReporter::RollbarReporter).
-        to receive(:notify).
-        with(exception, context: context, rack_env: rack_env)
+    before do
+      Pliny::ErrorReporters.error_reporters << reporter_double
 
+      allow(reporter_double).to receive(:notify)
+    end
+
+    it "notifies rollbar" do
       notify_reporter
+
+      expect(reporter_double).to have_received(:notify)
+        .once
+        .with(exception, context: context, rack_env: rack_env)
     end
   end
 end

data/spec/metrics_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Pliny::Metrics do
+  let(:io) { double }
+
+  subject(:metrics) { Pliny::Metrics }
+
+  before do
+    Pliny.stdout = io
+
+    allow(io).to receive(:print)
+    allow(Config).to receive(:app_name).and_return('pliny')
+  end
+
+  context "#count" do
+    it "counts a single key with a default value" do
+      metrics.count(:foo)
+      expect(io).to have_received(:print).with("count#pliny.foo=1\n")
+    end
+
+    it "counts a single key with a provided value" do
+      metrics.count(:foo, value: 2)
+      expect(io).to have_received(:print).with("count#pliny.foo=2\n")
+    end
+
+    it "counts multiple keys" do
+      metrics.count(:foo, :bar)
+      expect(io).to have_received(:print).with(
+        "count#pliny.foo=1 count#pliny.bar=1\n")
+    end
+  end
+
+  context "#measure" do
+    before do
+      Timecop.freeze(Time.now)
+    end
+
+    it "measures a single key" do
+      metrics.measure(:foo) { }
+      expect(io).to have_received(:print).with("measure#pliny.foo=0.000\n")
+    end
+
+    it "measures a single key over a minute" do
+      metrics.measure(:foo) do
+        Timecop.travel(60)
+      end
+      expect(io).to have_received(:print).with("measure#pliny.foo=60.000\n")
+    end
+
+    it "measures multiple keys" do
+      metrics.measure(:foo, :bar) { }
+      expect(io).to have_received(:print).with(
+        "measure#pliny.foo=0.000 measure#pliny.bar=0.000\n")
+    end
+  end
+end

data/spec/middleware/rescue_errors_spec.rb

@@ -28,7 +28,7 @@ describe Pliny::Middleware::RescueErrors do
 
   it "intercepts exceptions and renders" do
     @app = new_rack_app
-    expect(Pliny::ErrorReporter).to receive(:notify)
+    expect(Pliny::ErrorReporters).to receive(:notify)
     get "/"
     assert_equal 500, last_response.status
     error_json = MultiJson.decode(last_response.body)

data/spec/router_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Pliny::Router do
-
   describe "specifying a version" do
     def app
       Rack::Builder.new do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -354,12 +354,14 @@ files:
 - lib/pliny/commands/updater.rb
 - lib/pliny/config_helpers.rb
 - lib/pliny/db_support.rb
-- lib/pliny/error_reporter.rb
+- lib/pliny/error_reporters.rb
+- lib/pliny/error_reporters/rollbar.rb
 - lib/pliny/errors.rb
 - lib/pliny/helpers/encode.rb
 - lib/pliny/helpers/params.rb
 - lib/pliny/helpers/serialize.rb
 - lib/pliny/log.rb
+- lib/pliny/metrics.rb
 - lib/pliny/middleware/cors.rb
 - lib/pliny/middleware/instruments.rb
 - lib/pliny/middleware/request_id.rb
@@ -439,12 +441,13 @@ files:
 - spec/commands/updater_spec.rb
 - spec/config_helpers_spec.rb
 - spec/db_support_spec.rb
-- spec/error_reporter_spec.rb
+- spec/error_reporters_spec.rb
 - spec/errors_spec.rb
 - spec/helpers/encode_spec.rb
 - spec/helpers/serialize_spec.rb
 - spec/integration_spec.rb
 - spec/log_spec.rb
+- spec/metrics_spec.rb
 - spec/middleware/cors_spec.rb
 - spec/middleware/instruments_spec.rb
 - spec/middleware/request_id_spec.rb

data/lib/pliny/error_reporter.rb

@@ -1,42 +0,0 @@
-require 'rollbar/exception_reporter'
-require 'rollbar/request_data_extractor'
-
-class Pliny::ErrorReporter
-  def self.notify(exception, context: {}, rack_env: {})
-    Pliny.log_exception(exception)
-
-    REPORTERS.each do |reporter|
-      begin
-        reporter.new.notify(exception, context: context, rack_env: rack_env)
-      rescue
-        Pliny.log_exception($!)
-      end
-    end
-  end
-
-  class RollbarReporter
-    include ::Rollbar::ExceptionReporter
-    include ::Rollbar::RequestDataExtractor
-
-    def notify(exception, context:, rack_env:)
-      Rollbar.reset_notifier!
-      scope = fetch_scope(context: context, rack_env: rack_env)
-      Rollbar.scoped(scope) do
-        report_exception_to_rollbar(rack_env, exception)
-      end
-    end
-
-    private
-
-    def fetch_scope(context:, rack_env:)
-      {
-        request: proc { extract_request_data_from_rack(rack_env) }
-      }
-    rescue Exception => e
-      report_exception_to_rollbar(rack_env, e)
-      raise
-    end
-  end
-
-  REPORTERS = [RollbarReporter]
-end