bugloco 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5679112575fa2fbe7e3c7772015ea3d7da268de
-  data.tar.gz: 2c9c8eefbb3fdda13a5db613f61fce766d267299
+  metadata.gz: f77f2e45084fd90245873bae6177592eab5c0cfa
+  data.tar.gz: 26e56be260f658a023966e125490bcb71ccb1997
 SHA512:
-  metadata.gz: ce19403311ddd6a37dbbdd1d5ed8d93812333650de17a65ebbd93e51b2aae8ce4fb3d27ba7043c788ca88d83275d7e642a93c018079987138b81b017d2f8fbbd
-  data.tar.gz: 51fa242e0a98946f031924831c13cdd05c3fa5878b99229a15353ffbbc1fe8af1020a07ffed5db7f1639ce1d2a4c786a651951d16e82ba6ad7161567f0e281df
+  metadata.gz: 1275e34393868460335ff64794d38cf591118dab58645441448b16c9c38eac5f2c3c58e7b20f977e76171da5f5c52c34217bded77d15e442967b29b4cf9c5868
+  data.tar.gz: 41656a91b8b9f55dba3becea2e62ab8d9966249262d139e76290cc58d9d8b47712458afedb53297d5cec3271df41a24b3e919260cb3f265a3624cc2af0323e8d

data/lib/bugloco/cache.rb

@@ -0,0 +1,25 @@
+module Bugloco
+  class Cache
+    NAMESPACE = "bugloco"
+
+    class << self
+      def reset!
+        Thread.current[NAMESPACE] = {}
+      end
+
+      def get(key)
+        value = Thread.current[NAMESPACE][key] rescue nil
+
+        if block_given?
+          yield value
+        else
+          return value
+        end
+      end
+
+      def set(key, value)
+        Thread.current[NAMESPACE][key] = value
+      end
+    end
+  end
+end

data/lib/bugloco/notice.rb

@@ -1,3 +1,4 @@
+require "bugloco/cache"
 require "bugloco/protobuf/bugloco.pb"
 require "rack"
 require "socket"
@@ -46,12 +47,26 @@ module Bugloco
       load_server_info
       load_backtrace
       load_stack
+      load_custom
 
       @proto_message
     end
 
     private
 
+    def load_custom
+      return unless Bugloco.config.custom_keys
+
+      Bugloco.config.custom_keys.each do |custom_key|
+        value = Bugloco::Cache.get(custom_key) || ""
+
+        @proto_message.custom << Bugloco::Proto::Pair.new(
+          key: custom_key.to_s,
+          value: value.to_s,
+        )
+      end
+    end
+
     def load_stack
       @proto_message.stack = Bugloco.config.stack
     end

data/lib/bugloco/protobuf/bugloco.pb.rb

@@ -1,26 +1,26 @@
 ### Generated by rprotoc. DO NOT EDIT!
 ### <proto file: /home/wmn/code/bugloco/bugloco-rb/protobufs/bugloco.proto>
 # syntax = "proto2";
-# 
+#
 # package bugloco.proto;
-# 
+#
 # enum LocationType {
 #   UNKNOWN = 0;
 #   PROJECT = 1;
 #   GEM = 2;
 # }
-# 
+#
 # enum RunningMode {
 #   TEST = 0;
 #   STAGING = 1;
 #   PRODUCTION = 2;
 # }
-# 
+#
 # enum Status {
 #   SUCCESS = 0;
 #   FAILURE = 1;
 # }
-# 
+#
 # enum ErrorCode {
 #   UNKNOWN_ERROR = 0;
 #   API_KEY_INVALID = 1;
@@ -29,7 +29,7 @@
 #   INVALID_PROTO_MESSAGE = 4;
 #   PROBLEM_PERSISTING_NOTICE = 5;
 # }
-# 
+#
 # message BacktraceEntry {
 #   required bugloco.proto.LocationType location_type = 1;
 #   required string full_path = 2;
@@ -37,38 +37,38 @@
 #   required int32 line_number = 4;
 #   required string function_name = 5;
 # }
-# 
+#
 # message Company {
 #   required string api_key = 1;
 # }
-# 
+#
 # message Project {
 #   required string key = 1;
 #   optional string framework = 2;
 #   optional string version = 3;
 # }
-# 
+#
 # message Pair {
 #   required string key = 1;
 #   required string value = 2;
 # }
-# 
+#
 # message Server {
 #   required string hostname = 1;
 #   optional string os = 2;
 # }
-# 
+#
 # message Notifier {
 #   required string name = 1;
 #   required string version = 2;
 # }
-# 
+#
 # message User {
 #   optional string remote_ip = 1;
 #   optional string remote_host = 2;
 #   optional string user_agent = 3;
 # }
-# 
+#
 # message Request {
 #   repeated bugloco.proto.Pair environment_variables = 1;
 #   repeated bugloco.proto.Pair parameters = 2;
@@ -78,7 +78,7 @@
 #   optional string url = 6;
 #   optional string referer = 7;
 # }
-# 
+#
 # message Notice {
 #   required bugloco.proto.Company company = 1;
 #   required bugloco.proto.Project project = 2;
@@ -90,13 +90,14 @@
 #   optional string stack = 8;
 #   optional bugloco.proto.RunningMode running_mode = 9;
 #   optional bugloco.proto.Server server = 10;
+#   repeated bugloco.proto.Pair custom = 11;
 # }
-# 
+#
 # message ErrorMessage {
 #   required string field = 1;
 #   required string message = 2;
 # }
-# 
+#
 # message Response {
 #   required bugloco.proto.Status status = 1;
 #   optional string notice_key = 2;
@@ -198,6 +199,7 @@ module Bugloco
       optional :string, :stack, 8
       optional :'bugloco::proto::RunningMode', :running_mode, 9
       optional :'bugloco::proto::Server', :server, 10
+      repeated :'bugloco::proto::Pair', :custom, 11
     end
     class ErrorMessage < ::Protobuf::Message
       defined_in __FILE__
@@ -212,4 +214,4 @@ module Bugloco
       repeated :'bugloco::proto::ErrorMessage', :error_messages, 4
     end
   end
-end
+end

data/lib/bugloco/rails/middleware.rb

@@ -1,3 +1,5 @@
+require "bugloco/cache"
+
 module Bugloco
   module Rails
     class Middleware
@@ -6,6 +8,8 @@ module Bugloco
       end
 
       def call(env)
+        Bugloco::Cache.reset!
+
         response = @app.call(env)
 
         if framework_exception = env["action_dispatch.exception"]

data/lib/bugloco/version.rb

@@ -1,3 +1,3 @@
 module Bugloco
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/protobufs/bugloco.proto

@@ -88,6 +88,7 @@ message Notice {
   optional string stack = 8;
   optional bugloco.proto.RunningMode running_mode = 9;
   optional bugloco.proto.Server server = 10;
+  repeated bugloco.proto.Pair custom = 11;
 }
 
 message ErrorMessage {

data/spec/bugloco/cache_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+require "bugloco/cache"
+
+describe Bugloco::Cache do
+  context "#reset!" do
+    it "should set the namespace in the current thread to an empty Hash" do
+      Bugloco::Cache.reset!
+      expect(Thread.current[Bugloco::Cache::NAMESPACE]).to eq({})
+    end
+  end
+
+  context "#set" do
+    it "should set the key/value in the current thread" do
+      Bugloco::Cache.set(:key, "value")
+      expect(Thread.current[Bugloco::Cache::NAMESPACE][:key]).to eq("value")
+    end
+  end
+
+  context "#get" do
+    before do
+      @key = :key
+      @value = "value"
+      Bugloco::Cache.set(@key, @value)
+    end
+
+    it "should be able to get a key/value that was already set" do
+      expect(Bugloco::Cache.get(@key)).to eq(@value)
+    end
+
+    it "should yield the value if a block is given" do
+      Bugloco::Cache.get(@key) do |value|
+        expect(value).to eq(@value)
+      end
+    end
+  end
+end

data/spec/bugloco/notice_spec.rb

@@ -124,6 +124,34 @@ describe Bugloco::Notice do
     expect(@notice_proto_message.server).to eq(expected)
   end
 
+  context "custom pairs" do
+    before do
+      Bugloco.config do |config|
+        config.custom_keys = [:user_id]
+      end
+    end
+
+    it "should include the custom keys with empty value if value was not set" do
+      Bugloco::Cache.reset!
+      run_rack_app
+
+      expected = [Bugloco::Proto::Pair.new(key:"user_id", value: "")]
+
+      expect(@notice_proto_message.custom).to eq(expected)
+    end
+
+    it "should include the custom pairs" do
+      Bugloco::Cache.reset!
+      Bugloco::Cache.set(:user_id, "123")
+
+      run_rack_app
+
+      expected = [Bugloco::Proto::Pair.new(key:"user_id", value: "123")]
+
+      expect(@notice_proto_message.custom).to eq(expected)
+    end
+  end
+
   context "rack" do
     it "should extract the parameters from action dispatch" do
       run_rack_app :action_dispatch

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugloco
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Wael M. Nasreddine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,6 +124,7 @@ files:
 - Rakefile
 - bugloco.gemspec
 - lib/bugloco.rb
+- lib/bugloco/cache.rb
 - lib/bugloco/configuration.rb
 - lib/bugloco/notice.rb
 - lib/bugloco/protobuf/bugloco.pb.rb
@@ -132,6 +133,7 @@ files:
 - lib/bugloco/railtie.rb
 - lib/bugloco/version.rb
 - protobufs/bugloco.proto
+- spec/bugloco/cache_spec.rb
 - spec/bugloco/configuration_spec.rb
 - spec/bugloco/notice_spec.rb
 - spec/bugloco_spec.rb
@@ -161,6 +163,7 @@ signing_key:
 specification_version: 4
 summary: Bugloco ruby gem for sending exceptions to Bugloco
 test_files:
+- spec/bugloco/cache_spec.rb
 - spec/bugloco/configuration_spec.rb
 - spec/bugloco/notice_spec.rb
 - spec/bugloco_spec.rb