crashbreak 1.0.16 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 090bcc725aec72a06594ff7adc7c3020c8e012bb
-  data.tar.gz: a08df3d75839a074aa6010089b8f10fc5136a385
+  metadata.gz: 6f81541b60fa10233bdb23fb8ca9cecfb9153663
+  data.tar.gz: 1381e17f9d594f74445b60c382900a9ba9adfb6b
 SHA512:
-  metadata.gz: 1a83cafd9c89d262e5d2ddfad9df7df6d0a49012cb985d07bffdadcfc0ede6d2837027a32ebef0ffc548e3e1a94444792aafeb9f37e3048bd833d72769a67e8a
-  data.tar.gz: f28fdeebfd0d8f5bed1a5c79a3d8c824c34b2f4b7804dc9dd13a394744cc1bb1258597f31cc254da8b34081be5fc81f8b6d223d8756009004f3701fe0c0f4c2f
+  metadata.gz: 71eda490487fe43bbd242a0212bf8b3e9aea8f00ae33927b0b1419b857aa4abb57f1702d6a3233ef947e3ace25f0a2ec1370d72311fc06feb3362fe6ca934f2d
+  data.tar.gz: 9b24c12fbf2fe0403e82dbbc07fe7d2d3ea9257f11746767ed46588c65944fd78d9728a6f3f11e309dd68fbec6d7eee208781cd551e53429274a90d62a1ab89f

data/README.md

@@ -1,28 +1,135 @@
 # Crashbreak [![Version](http://img.shields.io/gem/v/crashbreak.svg)                               ](https://rubygems.org/gems/crashbreak) [![Build Status](https://travis-ci.org/crashbreak/crashbreak.svg?branch=master)](https://travis-ci.org/crashbreak/crashbreak) [![Code Climate](https://codeclimate.com/github/crashbreak/crashbreak/badges/gpa.svg)](https://codeclimate.com/github/crashbreak/crashbreak)
 
-TODO: Write a gem description
+Crashbreak gem is a exception notifier for integration with [crashbreak.com](http://crashbreak.com) for ruby apllications.
 
-## Installation
+## Rails Installation
 
 Add this line to your application's Gemfile:
 
     gem 'crashbreak'
 
-And then execute:
+And then execute from your rails root:
 
     $ bundle
 
-Or install it yourself as:
+Generate crashbreak initializer:
 
-    $ gem install crashbreak
+    rails generate crashbreak:install your_api_key
 
-## Usage
+## Example crashbreak.rb (initializer)
+[Rails example](https://github.com/crashbreak/heroku-rails-example/blob/master/config/initializers/crashbreak.rb)
 
-TODO: Write usage instructions here
+[Grape example](https://github.com/crashbreak/grape_example/blob/master/crashbreak.rb)
+
+## Initializer options
+
+### Error Serializers
+Each serializer converts an exception to JSON request, by customizing this you can create your own exception page in crashbreak.com. There are two types of serializers - summary serializer and hash serializer. 
+
+#### Summary serializer
+Summary serializer specify the first tab on exception show view and data included in email. This is an example of default summary formatter:
+
+```ruby
+class DefaultSummaryFormatter < SummaryFormatter
+  def summary
+    {
+      action: request.env['PATH_INFO'],
+      controller_name: controller.class.to_s,
+      file: exception.backtrace[0],
+      url: request.env['REQUEST_URI'],
+      user_agent: request.env['HTTP_USER_AGENT']
+    }
+  end
+end
+```
+
+#### Hash serializer
+By using hash serializer you can serialize your custom data into hash and display it in new tab on our web page. For example this is a ```EnvironmentVariablesSerializer```:
+
+```ruby
+class EnvironmentVariablesFormatter < HashFormatter
+  hash_name :environment
+
+  def hash_value
+    ENV.to_hash
+  end
+end
+```
+It adds new tab called "Environment" with all ENV variables displayed in "key: value" format.
+
+### Dumpers (and restorers)
+Dumpers are responsible for dump your system and prepare for restore by simulate request test. There are two very important dumpers - request dumper and database dumper. Each dumper is connected to specify restorer (eg ```RequestDumper``` to ```RequestRestorer```) to dump some part of system and restore it in crashbreak test env. This is a part of database dumper:
+
+```ruby
+# Crashbreak::DatabaseDumper
+def dump
+  prepare_aws # you need your custom aws bucket
+  dump_database
+  upload_dump
+  remove_locally_dump
+    
+  { file_name: aws_file_name } # only this hash is stored by crashbreak
+end
+
+# Crashbreak::DatabaseRestorer
+def restore
+  recreate_test_database
+  prepare_aws
+  download_dump unless dump_already_downloaded
+  restore_database
+  setup_connection_to_restored_database
+end
+```
+
+### Exception notifier
+Dumping your system can take some time, in order to improve request response you can use different exception notifier.
+
+```ruby
+config.exception_notifier = Crashbreak::ExceptionNotifier.new      # default notifier (one thread)
+config.exception_notifier = Crashbreak::ForkExceptionNotifier.new  # creates fork
+```
+
+## Integrations
+
+### Github
+Crashbreak can automaticaly creates branch with failing request for exception that occurs on your staging / production server. Your part of the job is just pull, run the test and fix the bug!
+```ruby
+config.github_login = ENV['GITHUB_USER']
+config.github_password = ENV['GITHUB_PASSWORD']
+config.github_repo_name = 'crashbreak/heroku-rails-example'
+```
+
+### CI sever
+With CI server you can automatically test your fix on external server. If tests succeed just run crashbreak rake task to resolve the error in our system. If you are using the github integration, the rake task can also create a pull request from branch with error to master.
+```ruby
+after_success:
+  - bundle exec rake crashbreak:resolve_error
+```
+
+### AWS
+Do not send any private / sensitive data to crashbreak, instead of this use your AWS to store it and send us only url or file name. AWS is required for database dumper and restorer.
+```ruby
+config.dumper_options = {
+  aws_bucket_name: 'cb-test-app',
+  aws_region: 'us-east-1',      # default: ENV['AWS_REGION']
+  aws_access_key_id: 'xxx',     # default: ENV['AWS_ACCESS_KEY_ID']
+  aws_secret_access_key: 'xxx', # default: ENV['AWS_SECRET_ACCESS_KEY']
+}
+```
+
+## Adapt crashbreak to your system and flow!
+Read more about flow and extensions [here](http://www.crashbreak.com/how_we_use_crashbreak/).
+
+Create your own plugin and improve current functionality - [become a collaborator!](http://www.crashbreak.com/extensions#contributing)
+
+### Request store
+Crashbreak uses [request store gem](https://github.com/steveklabnik/request_store) to store data and pass it to serializers and dumpers. By default it stores controller and exception instance and request object but you can add more.
+
+#### All crashbreak options can be found [here](https://github.com/crashbreak/crashbreak/blob/master/lib/crashbreak/config/configurator.rb).
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/crashbreak/fork )
+1. Fork it ( https://github.com/crashbreak/crashbreak/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/crashbreak.gemspec

@@ -29,6 +29,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'request_store', '>= 0'
   spec.add_runtime_dependency 'octokit', '>= 0'
   spec.add_runtime_dependency 'aws-sdk', '~> 2'
-  spec.add_runtime_dependency 'sidekiq', '>= 0'
-  spec.add_runtime_dependency 'oj', '>= 0'
 end

data/lib/crashbreak.rb

@@ -2,8 +2,6 @@ require 'faraday'
 require 'request_store'
 require 'octokit'
 require 'aws-sdk'
-require 'sidekiq'
-require 'oj'
 
 require 'crashbreak/version'
 require 'crashbreak/exception_notifier'
@@ -22,7 +20,6 @@ require 'crashbreak/dumpers_data_repository'
 require 'crashbreak/request_parser'
 require 'crashbreak/github_integration_service'
 require 'crashbreak/AWS'
-require 'crashbreak/async_exception_notifier'
 require 'crashbreak/tiny_exception_notifier'
 require 'crashbreak/fork_exception_notifier'
 require 'crashbreak/predefined_settings'

data/lib/crashbreak/exception_catcher_middleware.rb

@@ -11,7 +11,7 @@ module Crashbreak
         unless skip_exception?
           RequestStore.store[:exception] = exception
           store_variables_from_env env
-          notify_about_exception
+          exception_notifier.notify
         end
 
         raise
@@ -20,33 +20,6 @@ module Crashbreak
 
     private
 
-    def notify_about_exception
-      if exception_notifier.respond_to?(:perform_async)
-        prepare_request_store_for_serialization
-        exception_notifier.perform_async Oj.dump(RequestStore.store)
-      else
-        exception_notifier.notify
-      end
-    end
-
-    def prepare_request_store_for_serialization
-      request_hash = {}
-
-      RequestStore.store[:request].env.each do |key, value|
-        request_hash[key] = value.to_s
-      end
-
-      RequestStore.store[:request] = request(request_hash)
-
-      controller = RequestStore.store[:controller].dup
-
-      [:@_env, :@_request, :@_response, :@_lookup_context].each do |variable_symbol|
-        controller.instance_variable_set(variable_symbol, nil)
-      end
-
-      RequestStore.store[:controller] = controller
-    end
-
     def exception_notifier
       Crashbreak.configure.exception_notifier
     end

data/lib/crashbreak/version.rb

@@ -1,3 +1,3 @@
 module Crashbreak
-  VERSION = '1.0.16'
+  VERSION = '1.0.17'
 end

data/lib/generators/crashbreak/templates/rspec_test.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+
 describe 'error id: <%= error_id %>', type: :request do
 
   let(:restorers_data) { Crashbreak::StateRestorer.new('<%= error_id %>').restore }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crashbreak
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.0.17
 platform: ruby
 authors:
 - Michal Janeczek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-22 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,34 +178,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Maybe later... :)
 email:
 - michal.janeczek@ymail.com
@@ -224,7 +196,6 @@ files:
 - crashbreak.gemspec
 - lib/crashbreak.rb
 - lib/crashbreak/AWS.rb
-- lib/crashbreak/async_exception_notifier.rb
 - lib/crashbreak/config/configurable.rb
 - lib/crashbreak/config/configurator.rb
 - lib/crashbreak/deploys_repository.rb
@@ -259,7 +230,6 @@ files:
 - lib/tasks/crashbreak.rake
 - spec/dumpers/request_dumper_spec.rb
 - spec/features/sending_error_report_spec.rb
-- spec/lib/async_exception_notifier_spec.rb
 - spec/lib/config/configurable_spec.rb
 - spec/lib/config/configurator_spec.rb
 - spec/lib/deploys_repository_spec.rb
@@ -308,7 +278,6 @@ summary: Take a break from crashes!
 test_files:
 - spec/dumpers/request_dumper_spec.rb
 - spec/features/sending_error_report_spec.rb
-- spec/lib/async_exception_notifier_spec.rb
 - spec/lib/config/configurable_spec.rb
 - spec/lib/config/configurator_spec.rb
 - spec/lib/deploys_repository_spec.rb

data/lib/crashbreak/async_exception_notifier.rb

@@ -1,16 +0,0 @@
-module Crashbreak
-  class AsyncExceptionNotifier
-    include Sidekiq::Worker
-
-    def perform(request_store_data)
-      RequestStore.store.merge!(Oj.load(request_store_data))
-      exception_notifier.notify
-    end
-
-    private
-
-    def exception_notifier
-      @exception_notifier ||= ExceptionNotifier.new
-    end
-  end
-end

data/spec/lib/async_exception_notifier_spec.rb

@@ -1,19 +0,0 @@
-describe Crashbreak::AsyncExceptionNotifier do
-  subject { described_class.new }
-  let(:request_data) { Oj.dump(Hash[request: 'request_info', current_user: 'current_user_data']) }
-
-  before(:each) do
-    expect_any_instance_of(Crashbreak::ExceptionNotifier).to receive(:notify).and_return(true)
-  end
-
-  it 'calls notify on exception notifier' do
-    subject.perform(request_data)
-  end
-
-  it 'sets request_data in RequestStore' do
-    expect(RequestStore.store[:request]).to eq('request_info')
-    expect(RequestStore.store[:current_user]).to eq('current_user_data')
-
-    subject.perform(request_data)
-  end
-end