bugloco 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e01c60255d1c3940e8f6f58551df2d2df876c7d8
-  data.tar.gz: c9cdb69fa65eb6afaf910538aa82771bf868dc2f
+  metadata.gz: 47458d1e986e645aa899ce0f91d9285b36e9c88f
+  data.tar.gz: 27fc2e6fa0eb66513114f8aa4c23ab31f795adcf
 SHA512:
-  metadata.gz: 4ce74a4980b9e4578e4427a233d8cbf7662db256e06e9d3b6c2f7c1c347403e12da671a4f806d9df69f43a1e636fba59d48b72c2ad59c730ef387cbd2cec8052
-  data.tar.gz: c1ba7c04fd26475ac0c0e14a665ecbdb0b365ebdcc0890da37b7823a8e280eeb3f0bdc2dd8fb94b5a7798b11e0454ad93817f641ef8ac1f851326e6eccee9ecc
+  metadata.gz: ac1236859a8495ce7f27485fb7169bf585f25ac6eae524d1574b942499e71243645ea32e9f9f5b2e528ab9c943fd375ab15121381a2b2174be4dadf6618f2396
+  data.tar.gz: 7b18d5dbf10f446744fc6793504ec248e082e2e265959290474ac5e42799dc5e8394ac15d56f176d627d7c8e95ed92183c3324a7ea19e8508bb6e5b6fed2001f

data/.travis.yml

@@ -0,0 +1,6 @@
+script: rake
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - ruby-head

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bugloco.gemspec
 gemspec
+
+gem "pry"

data/README.md

@@ -1,4 +1,4 @@
-# Bugloco
+# Bugloco [![Build Status](https://travis-ci.org/bugloco/bugloco-rb.svg?branch=master)](https://travis-ci.org/bugloco/bugloco-rb) [![Coverage Status](https://coveralls.io/repos/bugloco/bugloco-rb/badge.png)](https://coveralls.io/r/bugloco/bugloco-rb)
 
 TODO: Write a gem description
 
@@ -6,15 +6,21 @@ TODO: Write a gem description
 
 Add this line to your application's Gemfile:
 
-    gem 'bugloco'
+```
+gem 'bugloco'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install bugloco
+```
+$ gem install bugloco
+```
 
 ## Usage
 

data/bugloco.gemspec

@@ -21,6 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "fakeweb"
 
-  spec.add_dependency "ruby_protobuf"
+  spec.add_dependency "ruby_protobuf", "~> 0.4.11"
 end

data/lib/bugloco/configuration.rb

@@ -0,0 +1,16 @@
+require "ostruct"
+
+module Bugloco
+  class Configuration < OpenStruct
+
+    def initialize(hash = {})
+      super
+
+      self.api_url = "https://bugloco.com/api/v1/notices"
+    end
+
+    def configured?
+      self.project_id && self.api_key
+    end
+  end
+end

data/lib/bugloco/notice.rb

@@ -0,0 +1,186 @@
+require "bugloco/protobuf/bugloco.pb"
+require "rack"
+require "socket"
+
+module Bugloco
+  class Notice
+
+    EXCEPTION_REGEX = /^(?<path>[^:]*):(?<line_number>[0-9]*):in `(?<function_name>[^']*)'$/
+
+    def initialize(exception, options = {})
+      @exception = exception
+      @options = options
+      @rack_env = @options[:rack_env] if @options[:rack_env]
+      @proto_message = nil
+    end
+
+    def to_pb
+      @pb ||= proto_message.serialize_to_string
+    end
+
+    def proto_message
+      return @proto_message unless @proto_message.nil?
+
+      @proto_message = Bugloco::Proto::Notice.new
+
+      load_company
+      load_project
+      load_exception_class_and_message
+      load_info_about_notifier
+      load_request
+      load_running_mode
+      load_server_info
+      load_backtrace
+      load_stack
+
+      @proto_message
+    end
+
+    private
+
+    def load_stack
+      @proto_message.stack = Bugloco.config.stack
+    end
+
+    def load_company
+      @proto_message.company = Bugloco::Proto::Company.new(
+        api_key: Bugloco.config.api_key)
+    end
+
+    def load_project
+      @proto_message.project = Bugloco::Proto::Project.new(
+        id: Bugloco.config.project_id)
+    end
+
+    def load_backtrace
+      return unless Bugloco.config.project_root
+
+      @exception.backtrace.each do |trace|
+        matches = trace.match(EXCEPTION_REGEX)
+        next unless matches
+        backtrace_entry = Bugloco::Proto::BacktraceEntry.new(
+          line_number: matches[:line_number].to_i,
+          function_name: matches[:function_name])
+
+        backtrace_entry.location_type = path_location_type(matches[:path])
+        backtrace_entry.full_path = matches[:path]
+        backtrace_entry.path = filter_path(matches[:path])
+
+        @proto_message.backtrace << backtrace_entry
+      end
+    end
+
+    def path_location_type(path)
+      type = nil
+
+      if path.start_with?(Bugloco.config.project_root.to_s)
+        type = Bugloco::Proto::LocationType::PROJECT
+      else
+        Gem.path.each do |gem_path|
+          if path.start_with?(gem_path)
+            type = Bugloco::Proto::LocationType::GEM
+          end
+        end
+
+        if type.nil?
+          type = Bugloco::Proto::LocationType::UNKNOWN
+        end
+      end
+
+      type
+    end
+
+    def filter_path(path)
+      if Bugloco.config.project_root
+        path.gsub!("#{Bugloco.config.project_root}/", "")
+      end
+
+      Gem.path.each do |gem_path|
+        path.gsub!("#{gem_path}/", "")
+      end
+
+      path
+    end
+
+
+    def load_server_info
+      @proto_message.server = Bugloco::Proto::Server.new(
+        hostname: Socket.gethostname,
+        os: RUBY_PLATFORM)
+    end
+
+    def load_running_mode
+      running_env = ENV["RAILS_ENV"] || ENV["RACK_ENV"]
+
+      running_mode = case running_env
+                     when "test"
+                       Bugloco::Proto::RunningMode::TEST
+                     when "staging"
+                       Bugloco::Proto::RunningMode::STAGING
+                     when "production"
+                       Bugloco::Proto::RunningMode::PRODUCTION
+                     end
+
+      @proto_message.running_mode = running_mode
+    end
+
+    def load_exception_class_and_message
+      @proto_message.error_class = @exception.class.to_s
+      @proto_message.error_message = @exception.message
+    end
+
+    def load_info_about_notifier
+      @proto_message.notifier = Bugloco::Proto::Notifier.new(
+        name: "bugloco-rb",
+        version: Bugloco::VERSION
+        )
+    end
+
+    def load_request
+      @request = Bugloco::Proto::Request.new
+      @proto_message.request = @request
+
+      load_environment
+      load_rack_env unless @options[:rack_env].nil?
+    end
+
+    def load_environment
+      ENV.each do |k, v|
+        @request.environment_variables <<
+          Bugloco::Proto::Pair.new(key: k.to_s, value: v)
+      end
+    end
+
+    def load_rack_env
+      @rack_request = ::Rack::Request.new(@rack_env)
+
+      # load the parameters
+      request_parameters.each do |k, v|
+        @request.parameters << Bugloco::Proto::Pair.new(key: k.to_s, value: v.to_s)
+      end
+
+      # load the controller/action
+      @request.controller = request_parameters["controller"]
+      @request.action = request_parameters["action"]
+
+      load_user_from_rack_env
+
+      # Load the URL/Referer
+      @request.url = @rack_env["REQUEST_URI"]
+      @request.referer = @rack_env["HTTP_REFERER"]
+    end
+
+    def request_parameters
+      @rack_env["action_dispatch.request.parameters"] ||
+        @rack_request.params
+    end
+
+    def load_user_from_rack_env
+      @request.user = Bugloco::Proto::User.new(
+        remote_ip: @rack_env["REMOTE_IP"],
+        remote_host: @rack_env["REMOTE_HOST"],
+        user_agent: @rack_env["HTTP_USER_AGENT"]
+        )
+    end
+  end
+end

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

@@ -1,13 +1,12 @@
 ### Generated by rprotoc. DO NOT EDIT!
 ### <proto file: /home/wmn/code/bug-loco/bugloco-rb/protobufs/bugloco.proto>
-# package bugloco.proto;
-# 
 # syntax = "proto2";
-# option bugloco_proto_version = 1;
 # 
-# enum FilelocationType {
-#   PROJECT = 0;
-#   LIBRARY = 1;
+# package bugloco.proto;
+# 
+# enum LocationType {
+#   UNKNOWN = 0;
+#   PROJECT = 1;
 #   GEM = 2;
 # }
 # 
@@ -17,21 +16,34 @@
 #   PRODUCTION = 2;
 # }
 # 
+# enum Status {
+#   SUCCESS = 0;
+#   FAILURE = 1;
+# }
+# 
+# enum ErrorCode {
+#   API_KEY_INVALID = 0;
+#   PROJECT_NOT_FOUND = 1;
+#   UNKNOWN_ERROR = 2;
+# }
+# 
 # message BacktraceEntry {
-#   required bugloco.proto.FilelocationType location = 1;
+#   required bugloco.proto.LocationType location_type = 1;
 #   required string full_path = 2;
 #   required string path = 3;
-#   required uint32 line_number = 4;
+#   required int32 line_number = 4;
 #   required string function_name = 5;
 # }
 # 
 # message Company {
-#   required int32 id = 1;
-#   required string key = 2;
+#   required string api_key = 1;
+#   optional int64 id = 2;
 # }
 # 
 # message Project {
-#   required int32 id = 1;
+#   required int64 id = 1;
+#   optional string framework = 2;
+#   optional string version = 3;
 # }
 # 
 # message Pair {
@@ -42,22 +54,47 @@
 # message Server {
 #   required string hostname = 1;
 #   optional string os = 2;
-#   optional string version = 3;
 # }
 # 
-# message Exception {
+# 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;
+#   optional string controller = 3;
+#   optional string action = 4;
+#   optional bugloco.proto.User user = 5;
+#   optional string url = 6;
+#   optional string referer = 7;
+# }
+# 
+# message Notice {
 #   required bugloco.proto.Company company = 1;
 #   required bugloco.proto.Project project = 2;
-#   required string error_type = 3;
+#   required string error_class = 3;
 #   required string error_message = 4;
-#   repeated bugloco.proto.BacktraceEntry backtrace_entries = 5;
-#   repeated bugloco.proto.Pair environment_variables = 6;
-#   repeated bugloco.proto.Pair params = 7;
+#   required bugloco.proto.Notifier notifier = 5;
+#   required bugloco.proto.Request request = 6;
+#   repeated bugloco.proto.BacktraceEntry backtrace = 7;
 #   optional string stack = 8;
 #   optional bugloco.proto.RunningMode running_mode = 9;
 #   optional bugloco.proto.Server server = 10;
-#   optional string controller = 11;
-#   optional string action = 12;
+# }
+# 
+# message Response {
+#   required bugloco.proto.Status status = 1;
+#   optional int64 notice_id = 2;
+#   optional bugloco.proto.ErrorCode error_code = 3;
+#   optional string error_message = 4;
 # }
 
 require 'protobuf/message/message'
@@ -67,11 +104,10 @@ require 'protobuf/message/extend'
 
 module Bugloco
   module Proto
-    ::Protobuf::OPTIONS[:"bugloco_proto_version"] = 1
-    class FilelocationType < ::Protobuf::Enum
+    class LocationType < ::Protobuf::Enum
       defined_in __FILE__
-      PROJECT = value(:PROJECT, 0)
-      LIBRARY = value(:LIBRARY, 1)
+      UNKNOWN = value(:UNKNOWN, 0)
+      PROJECT = value(:PROJECT, 1)
       GEM = value(:GEM, 2)
     end
     class RunningMode < ::Protobuf::Enum
@@ -80,22 +116,35 @@ module Bugloco
       STAGING = value(:STAGING, 1)
       PRODUCTION = value(:PRODUCTION, 2)
     end
+    class Status < ::Protobuf::Enum
+      defined_in __FILE__
+      SUCCESS = value(:SUCCESS, 0)
+      FAILURE = value(:FAILURE, 1)
+    end
+    class ErrorCode < ::Protobuf::Enum
+      defined_in __FILE__
+      API_KEY_INVALID = value(:API_KEY_INVALID, 0)
+      PROJECT_NOT_FOUND = value(:PROJECT_NOT_FOUND, 1)
+      UNKNOWN_ERROR = value(:UNKNOWN_ERROR, 2)
+    end
     class BacktraceEntry < ::Protobuf::Message
       defined_in __FILE__
-      required :'bugloco::proto::FilelocationType', :location, 1
+      required :'bugloco::proto::LocationType', :location_type, 1
       required :string, :full_path, 2
       required :string, :path, 3
-      required :uint32, :line_number, 4
+      required :int32, :line_number, 4
       required :string, :function_name, 5
     end
     class Company < ::Protobuf::Message
       defined_in __FILE__
-      required :int32, :id, 1
-      required :string, :key, 2
+      required :string, :api_key, 1
+      optional :int64, :id, 2
     end
     class Project < ::Protobuf::Message
       defined_in __FILE__
-      required :int32, :id, 1
+      required :int64, :id, 1
+      optional :string, :framework, 2
+      optional :string, :version, 3
     end
     class Pair < ::Protobuf::Message
       defined_in __FILE__
@@ -106,22 +155,47 @@ module Bugloco
       defined_in __FILE__
       required :string, :hostname, 1
       optional :string, :os, 2
-      optional :string, :version, 3
     end
-    class Exception < ::Protobuf::Message
+    class Notifier < ::Protobuf::Message
+      defined_in __FILE__
+      required :string, :name, 1
+      required :string, :version, 2
+    end
+    class User < ::Protobuf::Message
+      defined_in __FILE__
+      optional :string, :remote_ip, 1
+      optional :string, :remote_host, 2
+      optional :string, :user_agent, 3
+    end
+    class Request < ::Protobuf::Message
+      defined_in __FILE__
+      repeated :'bugloco::proto::Pair', :environment_variables, 1
+      repeated :'bugloco::proto::Pair', :parameters, 2
+      optional :string, :controller, 3
+      optional :string, :action, 4
+      optional :'bugloco::proto::User', :user, 5
+      optional :string, :url, 6
+      optional :string, :referer, 7
+    end
+    class Notice < ::Protobuf::Message
       defined_in __FILE__
       required :'bugloco::proto::Company', :company, 1
       required :'bugloco::proto::Project', :project, 2
-      required :string, :error_type, 3
+      required :string, :error_class, 3
       required :string, :error_message, 4
-      repeated :'bugloco::proto::BacktraceEntry', :backtrace_entries, 5
-      repeated :'bugloco::proto::Pair', :environment_variables, 6
-      repeated :'bugloco::proto::Pair', :params, 7
+      required :'bugloco::proto::Notifier', :notifier, 5
+      required :'bugloco::proto::Request', :request, 6
+      repeated :'bugloco::proto::BacktraceEntry', :backtrace, 7
       optional :string, :stack, 8
       optional :'bugloco::proto::RunningMode', :running_mode, 9
       optional :'bugloco::proto::Server', :server, 10
-      optional :string, :controller, 11
-      optional :string, :action, 12
+    end
+    class Response < ::Protobuf::Message
+      defined_in __FILE__
+      required :'bugloco::proto::Status', :status, 1
+      optional :int64, :notice_id, 2
+      optional :'bugloco::proto::ErrorCode', :error_code, 3
+      optional :string, :error_message, 4
     end
   end
 end

data/lib/bugloco/rack.rb

@@ -0,0 +1,17 @@
+module Bugloco
+  class Rack
+    def initialize(app)
+      @app = app
+      # TODO: Set the framework
+    end
+
+    def call(env)
+      response = @app.call(env)
+
+      response
+    rescue Exception => exception
+      env["bugloco.error_id"] = Bugloco.report_notice(exception, rack_env: env)
+      raise exception
+    end
+  end
+end

data/lib/bugloco/rails/middleware.rb

@@ -0,0 +1,22 @@
+module Bugloco
+  module Rails
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        response = @app.call(env)
+
+        if framework_exception = env["action_dispatch.exception"]
+          env["bugloco.error_id"] = Bugloco.report_notice(framework_exception, rack_env: env)
+        end
+
+        response
+      rescue Exception => exception
+        env["bugloco.error_id"] = Bugloco.report_notice(exception, rack_env: env)
+        raise exception
+      end
+    end
+  end
+end

data/lib/bugloco/railtie.rb

@@ -0,0 +1,21 @@
+require "bugloco"
+require "bugloco/rails/middleware"
+
+module Bugloco
+  class Railtie < ::Rails::Railtie
+    initializer "bugloco.middleware" do |app|
+      app.config.middleware.insert_after("ActionDispatch::DebugExceptions",
+        "Bugloco::Rails::Middleware")
+    end
+
+    config.after_initialize do
+      Bugloco.config do |config|
+        config.framework = "Rails"
+        config.framework_version = ::Rails::VERSION::STRING
+        config.project_root = ::Rails.root
+        config.environment = ::Rails.env
+        config.logger = ::Rails.logger
+      end
+    end
+  end
+end

data/lib/bugloco/version.rb

@@ -1,3 +1,3 @@
 module Bugloco
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/bugloco.rb

@@ -1,31 +1,74 @@
 require "bugloco/version"
-require "bugloco/protobuf/bugloco.pb"
+require "bugloco/rack"
+require "bugloco/notice"
+require "bugloco/configuration"
+require "net/http"
+require "net/https"
+
+require 'bugloco/railtie' if defined?(Rails::Railtie)
 
 module Bugloco
-  class Exception
-    def initialize(exception)
-      @exception = exception
-      @proto_message = nil
+  class << self
+    HTTP_ERRORS = [
+      Timeout::Error,
+      Errno::EINVAL,
+      Errno::ECONNRESET,
+      EOFError,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      Errno::ECONNREFUSED,
+      OpenSSL::SSL::SSLError].freeze
+
+    def report_notice(exception, options = {})
+      # TODO: We need to inform the user if api_key/project_id were not given
+      encoded_notice = Bugloco::Notice.new(exception, options).to_pb
+      encoded_response = send_notice(encoded_notice, options)
+
+      if encoded_response
+        response = Bugloco::Proto::Response.new.
+          parse_from_string(encoded_response)
+
+        response.notice_id if response.status == Bugloco::Proto::Status::SUCCESS
+      else
+        nil
+      end
+    end
+
+    def config
+      @configuration ||= Bugloco::Configuration.new
+      yield(@configuration) if block_given?
+      @configuration
     end
 
-    def prepare_proto_message
-      return @proto_message unless @proto_message.nil?
+    private
+
+    def send_notice(encoded_notice, options = {})
+      response = http_connection.post(api_url.path, encoded_notice, headers)
+      response.body
+    rescue *HTTP_ERRORS => e
+      # log e
+
+      nil
+    end
 
-      @proto_message = Bugloco::Proto::Exception.new
+    def http_connection
+      http = Net::HTTP.new(api_url.host, api_url.port)
 
-      load_environment
+      # do some SSL magic
 
-      @proto_message
+      http
     end
 
-    def load_environment
-      ENV.each do |k, v|
-        pair = Bugloco::Proto::Pair.new
-        pair.key = k
-        pair.value = v
+    def headers
+      {
+        "Content-type" => "application/octet-stream",
+        "Accept" => "application/octet-stream"
+      }.freeze
+    end
 
-        @proto_message.environment_variables << pair
-      end
+    def api_url
+      URI.parse(Bugloco.config.api_url)
     end
   end
 end

data/protobufs/bugloco.proto

@@ -1,11 +1,10 @@
-package bugloco.proto;
-
 syntax = "proto2";
-option bugloco_proto_version = 1;
 
-enum FilelocationType {
-  PROJECT = 0;
-  LIBRARY = 1;
+package bugloco.proto;
+
+enum LocationType {
+  UNKNOWN = 0;
+  PROJECT = 1;
   GEM = 2;
 }
 
@@ -15,21 +14,34 @@ enum RunningMode {
   PRODUCTION = 2;
 }
 
+enum Status {
+  SUCCESS = 0;
+  FAILURE = 1;
+}
+
+enum ErrorCode {
+  API_KEY_INVALID = 0;
+  PROJECT_NOT_FOUND = 1;
+  UNKNOWN_ERROR = 2;
+}
+
 message BacktraceEntry {
-  required bugloco.proto.FilelocationType location = 1;
+  required bugloco.proto.LocationType location_type = 1;
   required string full_path = 2;
   required string path = 3;
-  required uint32 line_number = 4;
+  required int32 line_number = 4;
   required string function_name = 5;
 }
 
 message Company {
-  required int32 id = 1;
-  required string key = 2;
+  required string api_key = 1;
+  optional int64 id = 2;
 }
 
 message Project {
-  required int32 id = 1;
+  required int64 id = 1;
+  optional string framework = 2;
+  optional string version = 3;
 }
 
 message Pair {
@@ -40,20 +52,45 @@ message Pair {
 message Server {
   required string hostname = 1;
   optional string os = 2;
-  optional string version = 3;
 }
 
-message Exception {
+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;
+  optional string controller = 3;
+  optional string action = 4;
+  optional bugloco.proto.User user = 5;
+  optional string url = 6;
+  optional string referer = 7;
+}
+
+message Notice {
   required bugloco.proto.Company company = 1;
   required bugloco.proto.Project project = 2;
-  required string error_type = 3;
+  required string error_class = 3;
   required string error_message = 4;
-  repeated bugloco.proto.BacktraceEntry backtrace_entries = 5;
-  repeated bugloco.proto.Pair environment_variables = 6;
-  repeated bugloco.proto.Pair params = 7;
+  required bugloco.proto.Notifier notifier = 5;
+  required bugloco.proto.Request request = 6;
+  repeated bugloco.proto.BacktraceEntry backtrace = 7;
   optional string stack = 8;
   optional bugloco.proto.RunningMode running_mode = 9;
   optional bugloco.proto.Server server = 10;
-  optional string controller = 11;
-  optional string action = 12;
+}
+
+message Response {
+  required bugloco.proto.Status status = 1;
+  optional int64 notice_id = 2;
+  optional bugloco.proto.ErrorCode error_code = 3;
+  optional string error_message = 4;
 }

data/spec/bugloco/configuration_spec.rb

@@ -0,0 +1,8 @@
+describe Bugloco::Configuration do
+  context "configured?" do
+    it "should return true if all required config are there" do
+      @configuration = Bugloco::Configuration.new
+      expect(@configuration.configured?).to be_falsey
+    end
+  end
+end

data/spec/bugloco/notice_spec.rb

@@ -0,0 +1,217 @@
+describe Bugloco::Notice do
+  def run_rack_app(params_type = :query_string)
+    @extra_env.each {|k, v| ENV[k] = v}
+
+    @request_options = {
+      "action_dispatch.request.parameters" => @params,
+    }
+
+    if params_type == :action_dispatch
+      @rack_env = Rack::MockRequest.env_for(@url, @request_options)
+    else
+      @rack_env = Rack::MockRequest.env_for(@url)
+    end
+
+    @rack_env.merge! @rack_env_extra
+
+    @app = lambda do |env|
+      raise CustomBacktraceException, @error_message
+    end
+
+    begin
+      @stack = Bugloco::Rack.new(@app)
+      @stack.call(@rack_env)
+    rescue CustomBacktraceException => exception
+      @exception = mock_backtrace(exception)
+      @notice = Bugloco::Notice.new(@exception, rack_env: @rack_env)
+      @notice_proto_message = @notice.proto_message
+    end
+  end
+
+  before do
+    allow(Bugloco).to receive(:report_notice)
+
+    @extra_env = {}
+
+    @error_message = "Fake error needed for the builder"
+    @url = "http://www.google.com?name=John%20Doe"
+
+    @params = {
+      "name" => "John Doe",
+      "controller" => "home",
+      "action" => "greet",
+    }
+
+    @rack_env_extra = {}
+
+
+
+  end
+
+  after do
+    @extra_env.each {|k, _| ENV[k] = nil}
+  end
+
+  it "should include the company" do
+    @api_key = "secret_key"
+    Bugloco.config do |config|
+      config.api_key = @api_key
+    end
+    expected = Bugloco::Proto::Company.new(api_key: @api_key)
+
+    run_rack_app
+    expect(@notice_proto_message.company).to eq(expected)
+  end
+
+  it "should include the project" do
+    @project_id = 123
+    Bugloco.config do |config|
+      config.project_id = @project_id
+    end
+    expected = Bugloco::Proto::Project.new(id: @project_id)
+
+    run_rack_app
+    expect(@notice_proto_message.project).to eq(expected)
+  end
+
+  it "should include the stack" do
+    @stack_name = "sysadmin"
+    Bugloco.config do |config|
+      config.stack = @stack_name
+    end
+
+    run_rack_app
+    expect(@notice_proto_message.stack).to eq(@stack_name)
+  end
+
+  it "should collect the environment" do
+    @extra_env["BUGLOCO_KEY"] = "VAR"
+
+    run_rack_app
+    expected = Bugloco::Proto::Pair.new(key: "BUGLOCO_KEY", value: "VAR")
+    env_vars = @notice_proto_message.request.environment_variables
+    expect(env_vars).to include(expected)
+  end
+
+  it "should collect the class/message of the notice" do
+    run_rack_app
+    expect(@notice_proto_message.error_class).to eq("CustomBacktraceException")
+    expect(@notice_proto_message.error_message).to eq(@error_message)
+  end
+
+  it "should include information about the notifier" do
+    run_rack_app
+
+    expected = Bugloco::Proto::Notifier.new(
+      name: "Bugloco",
+      version: Bugloco::VERSION
+      )
+
+    expect(@notice_proto_message.notifier).to eq(expected)
+  end
+
+  it "should include information about the current server" do
+    run_rack_app
+    expected = Bugloco::Proto::Server.new(
+      hostname: `hostname`.chomp,
+      os: RUBY_PLATFORM)
+
+    expect(@notice_proto_message.server).to eq(expected)
+  end
+
+  context "rack" do
+    it "should extract the parameters from action dispatch" do
+      run_rack_app :action_dispatch
+      expected = Bugloco::Proto::Pair.new(key: "name", value: "John Doe")
+      expect(@notice_proto_message.request.parameters).to include(expected)
+    end
+
+    it "should extract the parameters from the query string" do
+      run_rack_app
+      expected = Bugloco::Proto::Pair.new(key: "name", value: "John Doe")
+      expect(@notice_proto_message.request.parameters).to include(expected)
+    end
+
+    it "should extract the controller/action from the rack_env" do
+      run_rack_app :action_dispatch
+      expect(@notice_proto_message.request.controller).to eq("home")
+      expect(@notice_proto_message.request.action).to eq("greet")
+    end
+
+    it "should collect info about the user (IP/user_agent)" do
+      @rack_env_extra.merge!({
+          "REMOTE_IP" => "8.8.8.8",
+          "REMOTE_HOST" => "google-public-dns-a.google.com",
+          "HTTP_USER_AGENT" => "Mozilla something :)",
+        })
+
+      run_rack_app
+      expected = Bugloco::Proto::User.new(
+        remote_ip: @rack_env_extra["REMOTE_IP"],
+        remote_host: @rack_env_extra["REMOTE_HOST"],
+        user_agent: @rack_env_extra["HTTP_USER_AGENT"]
+        )
+
+      expect(@notice_proto_message.request.user).to eq(expected)
+    end
+
+    it "should collect the URL" do
+      @rack_env_extra["REQUEST_URI"] = @url
+      run_rack_app
+      expect(@notice_proto_message.request.url).to eq(@rack_env_extra["REQUEST_URI"])
+    end
+
+    it "should collect the REFERER" do
+      @rack_env_extra["HTTP_REFERER"] = "http://www.google.com"
+      run_rack_app
+      expect(@notice_proto_message.request.referer).to eq(@rack_env_extra["HTTP_REFERER"])
+    end
+
+    it "should include information about RACK_ENV" do
+      @extra_env["RACK_ENV"] = "production"
+      run_rack_app
+      expected = Bugloco::Proto::RunningMode::PRODUCTION
+      expect(@notice_proto_message.running_mode).to eq(expected)
+    end
+  end
+
+  context "rails" do
+    before do
+      Bugloco.config do |config|
+        config.project_root = File.expand_path("../../../", __FILE__)
+      end
+    end
+
+    it "should record the backtrace" do
+      project_root = Bugloco.config.project_root
+      first = Bugloco::Proto::BacktraceEntry.new(
+        location_type: Bugloco::Proto::LocationType::PROJECT,
+        full_path: File.join(project_root, "spec/bugloco/notice_spec.rb"),
+        path: "spec/bugloco/notice_spec.rb",
+        line_number: 18,
+        function_name: "block in run_rack_app")
+      second = Bugloco::Proto::BacktraceEntry.new(
+        location_type: Bugloco::Proto::LocationType::PROJECT,
+        full_path: File.join(project_root, "lib/bugloco/rack.rb"),
+        path: "lib/bugloco/rack.rb",
+        line_number: 9,
+        function_name: "call")
+      third = Bugloco::Proto::BacktraceEntry.new(
+        location_type: Bugloco::Proto::LocationType::GEM,
+        full_path: "#{Gem.path.last}/gems/rspec-core-3.0.2/lib/rspec/core/example.rb",
+        path: "gems/rspec-core-3.0.2/lib/rspec/core/example.rb",
+        line_number: 148,
+        function_name: "instance_exec")
+
+      run_rack_app
+      expect(@notice_proto_message.backtrace).to eq([first, second, third])
+    end
+
+    it "should include information about RAILS_ENV" do
+      @extra_env["RAILS_ENV"] = "staging"
+      run_rack_app
+      expected = Bugloco::Proto::RunningMode::STAGING
+      expect(@notice_proto_message.running_mode).to eq(expected)
+    end
+  end
+end

data/spec/bugloco_spec.rb

@@ -1,26 +1,41 @@
-describe Bugloco::Exception do
-  before do
-    ENV["BUGLOCO_KEY"] = "VAR"
+describe Bugloco do
+  context "#config" do
+    it "should be configurable" do
+      project_id = 123
+      api_key = "secret_key"
 
-    begin
-      raise RuntimeError, "Fake error needed for the builder"
-    rescue RuntimeError => exception
-      @exception = Bugloco::Exception.new(exception)
-      @exception_proto_message = @exception.prepare_proto_message
+      Bugloco.config do |config|
+        config.project_id = project_id
+        config.api_key = api_key
+      end
+
+      expect(Bugloco.config.project_id).to eq(project_id)
+      expect(Bugloco.config.api_key).to eq(api_key)
     end
-  end
 
-  after do
-    ENV["BUGLOCO_KEY"] = nil
+    it "should include the API url" do
+      expect(Bugloco.config.api_url).to eq("https://bugloco.com/api/v1/notices")
+    end
   end
 
-  context "message_builder" do
-    it "should collect the environment" do
-      expected = Bugloco::Proto::Pair.new
-      expected.key = "BUGLOCO_KEY"
-      expected.value = "VAR"
+  context "#report_notice" do
+    it "should return success when the proto gets built and sent" do
+      pending "FakeWeb cannot receive binary, how to test this?"
+
+      response = Bugloco::Proto::Response.new(
+        status: Bugloco::Proto::Status::SUCCESS,
+        notice_id: 123)
+      FakeWeb.register_uri(:post, Bugloco.config.api_url,
+        body: response.serialize_to_string)
+
+      begin
+        raise CustomBacktraceException, "Fake web"
+      rescue CustomBacktraceException => exception
+        exception = mock_backtrace(exception)
+        api_response = Bugloco.report_notice(exception)
+      end
 
-      expect(@exception_proto_message.environment_variables).to include(expected)
+      expect(api_response).to eq(response)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,32 @@
+if ENV["CI"]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+require "fakeweb"
 require "bugloco"
 
+def mock_backtrace(exception)
+  project_root = File.expand_path("../../", __FILE__)
+  backtrace = [
+    "#{project_root}/spec/bugloco/notice_spec.rb:18:in `block in run_rack_app'",
+    "#{project_root}/lib/bugloco/rack.rb:9:in `call'",
+    "#{Gem.path.last}/gems/rspec-core-3.0.2/lib/rspec/core/example.rb:148:in `instance_exec'"
+  ]
+
+  exception.backtrace = backtrace
+
+  exception
+end
+
+class CustomBacktraceException < Exception
+  attr_accessor :backtrace
+end
+
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  config.before(:each) do
+    ENV["RACK_ENV"] = nil
+    ENV["RAILS_ENV"] = nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugloco
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wael M. Nasreddine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: ruby_protobuf
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  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'
+- !ruby/object:Gem::Dependency
+  name: ruby_protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.11
 description: Bugloco ruby gem for sending exceptions to Bugloco
 email:
 - wael.nasreddine@gmail.com
@@ -75,15 +117,23 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bugloco.gemspec
 - lib/bugloco.rb
+- lib/bugloco/configuration.rb
+- lib/bugloco/notice.rb
 - lib/bugloco/protobuf/bugloco.pb.rb
+- lib/bugloco/rack.rb
+- lib/bugloco/rails/middleware.rb
+- lib/bugloco/railtie.rb
 - lib/bugloco/version.rb
 - protobufs/bugloco.proto
+- spec/bugloco/configuration_spec.rb
+- spec/bugloco/notice_spec.rb
 - spec/bugloco_spec.rb
 - spec/spec_helper.rb
 homepage: https://bugloco.com
@@ -111,5 +161,7 @@ signing_key:
 specification_version: 4
 summary: Bugloco ruby gem for sending exceptions to Bugloco
 test_files:
+- spec/bugloco/configuration_spec.rb
+- spec/bugloco/notice_spec.rb
 - spec/bugloco_spec.rb
 - spec/spec_helper.rb