crashbreak 1.0.19 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 971975eddcb1b2a1a941794b53992da1d716e7b5
-  data.tar.gz: e49b7db2329340b13d4bdc998b9b22b0c97e69ca
+  metadata.gz: 48536ecac8f93671f2dfd485c9bf3f9ec2f861f5
+  data.tar.gz: 06fb15138866c07a1dbf18ebc4dade65307f22bf
 SHA512:
-  metadata.gz: d11c63982a8658a1e43af247cde68b448dac35a78ee291e60c85156326e2c482bfa71bf41915616e1dbec5db47620b37f352ccd9b29c4eebec4cee674865c4ca
-  data.tar.gz: 9a830cb9aab90537e8dee44b2aa6fb78b0c7105324cbda658b6db4f6178874af84f2e95d5f9b68a789bcba130e05429a0ac2f63894c1fcc888f790e88803dbff
+  metadata.gz: bd437a3eb1cd4fa80ab822e7dff89ffa0a989a51ae168d13e8fbfcb392ecb6802626f69a3f8719dd60b9151d0972a888d02c5fb69396b38ab0000a5f2f260fc8
+  data.tar.gz: 50af0658221b4bb536037fd1398b4eb2168918b155c28a0888e44c6d33fd3daeb02524ac36caa16686278bad59d1c09f1f428b4fee195fc29d521499c3efcc70

data/README.md

@@ -1,6 +1,6 @@
-# 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)
+# 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)
 
-Crashbreak gem is a exception notifier for integration with [crashbreak.com](http://crashbreak.com) for ruby apllications.
+CrashBreak gem is the exception notifier for integration with [crashbreak.com](http://crashbreak.com) for ruby applications.
 
 ## Rails Installation
 
@@ -12,17 +12,17 @@ And then execute from your rails root:
 
     $ bundle
 
-Generate crashbreak initializer:
+Generate CrashBreak initializer:
 
     rails generate crashbreak:install your_api_key
 
-If you want to use database dumper add this lines to datbase.yml file:
+If you want to use database dumper add those lines to datbase.yml file:
 
     crashbreak_test:
       <<: *default
       database: crashbreak-test
 
-## Example crashbreak.rb (initializer)
+## Example of crashbreak.rb (initializer)
 [Rails example](https://github.com/crashbreak/heroku-rails-example/blob/master/config/initializers/crashbreak.rb)
 
 [Grape example](https://github.com/crashbreak/grape_example/blob/master/crashbreak.rb)
@@ -33,10 +33,10 @@ If you want to use database dumper add this lines to datbase.yml file:
 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:
+Summary serializer specifies the first tab on the exception show view and data included in email. This is an example of default summary serializer:
 
 ```ruby
-class DefaultSummaryFormatter < SummaryFormatter
+class DefaultSummarySerializer < SummarySerializer
   def summary
     {
       action: request.env['PATH_INFO'],
@@ -50,10 +50,10 @@ 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```:
+By using hash serializer you can serialize your custom data into hash and display it in a new tab on our web page. For example this is the ```EnvironmentVariablesSerializer```:
 
 ```ruby
-class EnvironmentVariablesFormatter < HashFormatter
+class EnvironmentVariablesSerializer < HashSerializer
   hash_name :environment
 
   def hash_value
@@ -61,10 +61,10 @@ class EnvironmentVariablesFormatter < HashFormatter
   end
 end
 ```
-It adds new tab called "Environment" with all ENV variables displayed in "key: value" format.
+It adds a 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:
+Dumpers are responsible for dumping your system and preparing for restoration by a request test. There are two very important dumpers - request dumper and database dumper. Each dumper is connected to specific restorer (eg ```RequestDumper``` to ```RequestRestorer```) to dump some part of the system and restore it in the CrashBreak test env. This is a part of the database dumper:
 
 ```ruby
 # Crashbreak::DatabaseDumper
@@ -74,7 +74,7 @@ def dump
   upload_dump
   remove_locally_dump
     
-  { file_name: aws_file_name } # only this hash is stored by crashbreak
+  { file_name: aws_file_name } # only this hash is stored by CrashBreak
 end
 
 # Crashbreak::DatabaseRestorer
@@ -88,10 +88,10 @@ end
 ```
 
 ### Predefined settings
-Dumping your database or any other part of the system requires config for dumpers, for example DatabaseDumper needs a command for dump db (e.g pg_dump for postgresql). There is a file with all predefined settings that you can use if you have standard setup. Please check [this file](https://github.com/crashbreak/crashbreak/blob/master/lib/crashbreak/predefined_settings.rb). For be sure that all commands run corretcly on your staging server please run it manually first and see the result.
+Dumping your database or any other part of the system requires configuration for dumpers, for example DatabaseDumper needs a command for dump db (e.g pg_dump for postgresql). There is a file with all predefined settings that you can use if you have standard setup. Please check [this file](https://github.com/crashbreak/crashbreak/blob/master/lib/crashbreak/predefined_settings.rb). To be sure that all commands run correctly on your staging server please run it manually first and see the result.
 
 ### Exception notifier
-Dumping your system can take some time, in order to improve request response you can use different 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)
@@ -100,23 +100,24 @@ config.exception_notifier = Crashbreak::ForkExceptionNotifier.new  # creates for
 
 ## 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!
+### GitHub
+CrashBreak can automatically create a branch with a failing request for an exception that occurs on your staging / production server. Your part of the job is just to pull, run the test and fix the bug!
 ```ruby
+config.github_integration = true
 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.
+With the CI server you can automatically test your fix on an external server. If tests succeed, just run the 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 a branch with error to a master branch.
 ```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.
+Do not send any private / sensitive data to CrashBreak. Instead of this use your AWS to store it and send us only url or a file name. AWS is required for database dumper and restorer.
 ```ruby
 config.dumper_options = {
   aws_bucket_name: 'cb-test-app',
@@ -126,15 +127,32 @@ config.dumper_options = {
 }
 ```
 
-## Adapt crashbreak to your system and flow!
+### Deploy tracking 
+#### Capistrano 3
+```ruby
+# Capfile
+require 'crashbreak/capistrano3'
+
+# deploy.rb
+set :crashbreak_token, ENV['CRASHBREAK_TOKEN']
+after 'deploy:finished', 'crashbreak:deploy'
+```
+
+#### Heroku
+You can track deploys by enabling free heroku addon:
+```
+heroku addons:add deployhooks:http --url="http://www.crashbreak.com/api/projects/YOU_API_KEY/deploys/?environment=production"
+```
+
+## 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.
+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).
+#### All CrashBreak options can be found [here](https://github.com/crashbreak/crashbreak/blob/master/lib/crashbreak/config/configurator.rb).
 
 ## Contributing
 

data/lib/crashbreak.rb

@@ -5,18 +5,7 @@ require 'aws-sdk'
 
 require 'crashbreak/version'
 require 'crashbreak/exception_notifier'
-require 'crashbreak/formatters/basic_formatter'
-require 'crashbreak/formatters/summary_formatter'
-require 'crashbreak/formatters/hash_formatter'
-require 'crashbreak/formatters/basic_information_formatter'
-require 'crashbreak/formatters/environment_variables_formatter'
-require 'crashbreak/formatters/default_summary_formatter'
-require 'crashbreak/config/configurator'
-require 'crashbreak/config/configurable'
 require 'crashbreak/exception_catcher_middleware'
-require 'crashbreak/exceptions_repository'
-require 'crashbreak/deploys_repository'
-require 'crashbreak/dumpers_data_repository'
 require 'crashbreak/request_parser'
 require 'crashbreak/github_integration_service'
 require 'crashbreak/AWS'
@@ -24,12 +13,27 @@ require 'crashbreak/tiny_exception_notifier'
 require 'crashbreak/fork_exception_notifier'
 require 'crashbreak/predefined_settings'
 
-require 'dumpers/database_dumper'
-require 'dumpers/request_dumper'
+require 'crashbreak/serializers/basic_serializer'
+require 'crashbreak/serializers/summary_serializer'
+require 'crashbreak/serializers/hash_serializer'
+require 'crashbreak/serializers/basic_information_serializer'
+require 'crashbreak/serializers/environment_variables_serializer'
+require 'crashbreak/serializers/default_summary_serializer'
+
+require 'crashbreak/config/configurator'
+require 'crashbreak/config/configurable'
+
+require 'crashbreak/repositories/base_repository'
+require 'crashbreak/repositories/exceptions_repository'
+require 'crashbreak/repositories/deploys_repository'
+require 'crashbreak/repositories/dumpers_data_repository'
+
+require 'crashbreak/dumpers/database_dumper'
+require 'crashbreak/dumpers/request_dumper'
 
-require 'restorers/database_restorer'
-require 'restorers/state_restorer'
-require 'restorers/request_restorer'
+require 'crashbreak/restorers/database_restorer'
+require 'crashbreak/restorers/state_restorer'
+require 'crashbreak/restorers/request_restorer'
 
 require 'crashbreak/railtie' if defined?(Rails::Railtie)
 

data/lib/crashbreak/config/configurator.rb

@@ -12,6 +12,7 @@ module Crashbreak
     attr_accessor :request_spec_run_command
     attr_accessor :project_root
 
+    attr_accessor :github_integration
     attr_accessor :github_login
     attr_accessor :github_password
     attr_accessor :github_repo_name
@@ -42,6 +43,10 @@ module Crashbreak
       @request_spec_template_path ||= "#{Crashbreak.root}/lib/generators/crashbreak/templates/rspec_test.rb"
     end
 
+    def github_integration
+      @github_integration ||= false
+    end
+
     def github_development_branch
       @github_development_branch ||= 'master'
     end

data/lib/{dumpers → crashbreak/dumpers}/database_dumper.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
 
 module Crashbreak
-  class DatabaseDumper < BasicFormatter
+  class DatabaseDumper < BasicSerializer
     include Crashbreak::AWS
 
     def dump
@@ -21,7 +21,7 @@ module Crashbreak
     end
 
     def dump_database
-      system(gsub_error_id(dump_command))
+      system(dump_command)
     end
 
     def upload_dump
@@ -37,14 +37,14 @@ module Crashbreak
     end
 
     def dump_location
-      gsub_error_id(Crashbreak.configure.dumper_options[:dump_location])
+      inject_error_id(Crashbreak.configure.dumper_options[:dump_location])
     end
 
     def dump_command
-      Crashbreak.configure.dumper_options[:dump_command]
+      inject_error_id(Crashbreak.configure.dumper_options[:dump_command])
     end
 
-    def gsub_error_id(text)
+    def inject_error_id(text)
       text.gsub(':error_id:', error_id)
     end
 

data/lib/{dumpers → crashbreak/dumpers}/request_dumper.rb

@@ -1,12 +1,12 @@
 module Crashbreak
-  class RequestDumper < Crashbreak::BasicFormatter
+  class RequestDumper < Crashbreak::BasicSerializer
     def dump
-      sanitized_request_hash
+      sanitize_request_hash
     end
 
     private
 
-    def sanitized_request_hash
+    def sanitize_request_hash
       {}.tap do |sanitized_request_hash|
         request_hash.each{|key, value| sanitized_request_hash[key] = value.to_s }
       end

data/lib/crashbreak/exception_notifier.rb

@@ -6,7 +6,7 @@ module Crashbreak
       if created_error_is_unique?
         dump_system_and_update_report
 
-        GithubIntegrationService.new(server_response).push_test if Crashbreak.configure.github_repo_name.present?
+        GithubIntegrationService.new(server_response).push_test if Crashbreak.configure.github_integration
       end
     end
 
@@ -35,7 +35,7 @@ module Crashbreak
     end
 
     def serializers
-      [BasicInformationFormatter.new] + Crashbreak.configure.error_serializers
+      [BasicInformationSerializer.new] + Crashbreak.configure.error_serializers
     end
 
     def exceptions_repository

data/lib/crashbreak/repositories/base_repository.rb

@@ -0,0 +1,9 @@
+module Crashbreak
+  class BaseRepository
+    BASE_URL = 'https://crashbreak.herokuapp.com/api'
+
+    def project_token
+      Crashbreak.configure.api_key
+    end
+  end
+end

data/lib/crashbreak/{deploys_repository.rb → repositories/deploys_repository.rb}

@@ -1,9 +1,7 @@
 require 'json'
 
 module Crashbreak
-  class DeploysRepository
-    BASE_URL = 'http://crashbreak.herokuapp.com/api'
-
+  class DeploysRepository < BaseRepository
     def initialize(project_token, deploy_hash)
       @project_token = project_token
       @deploy_hash = deploy_hash

data/lib/crashbreak/{dumpers_data_repository.rb → repositories/dumpers_data_repository.rb}

@@ -1,7 +1,5 @@
 module Crashbreak
-  class DumpersDataRepository
-    BASE_URL = 'http://crashbreak.herokuapp.com/api'
-
+  class DumpersDataRepository < BaseRepository
     def initialize(error_id)
       @error_id = error_id
     end
@@ -26,9 +24,5 @@ module Crashbreak
     def request_url
       "#{BASE_URL}/projects/#{project_token}/errors/#{@error_id}/dumpers_data"
     end
-
-    def project_token
-      Crashbreak.configure.api_key
-    end
   end
 end

data/lib/crashbreak/{exceptions_repository.rb → repositories/exceptions_repository.rb}

@@ -1,7 +1,5 @@
 module Crashbreak
-  class ExceptionsRepository
-    BASE_URL = 'http://crashbreak.herokuapp.com/api'
-
+  class ExceptionsRepository < BaseRepository
     def create(error_report_hash)
       JSON.parse(post_request(error_report_hash).body)
     end
@@ -47,9 +45,5 @@ module Crashbreak
     def resolve_request_url(error_id)
       "#{BASE_URL}/projects/#{project_token}/errors/#{error_id}"
     end
-
-    def project_token
-      Crashbreak.configure.api_key
-    end
   end
 end

data/lib/{restorers → crashbreak/restorers}/database_restorer.rb

@@ -46,7 +46,7 @@ module Crashbreak
     end
 
     def restore_command
-      gsub_error_id(Crashbreak.configure.restorer_options[:restore_command])
+      inject_error_id(Crashbreak.configure.restorer_options[:restore_command])
     end
 
     def drop_test_database_command
@@ -58,10 +58,10 @@ module Crashbreak
     end
 
     def restore_location
-      gsub_error_id(Crashbreak.configure.dumper_options[:dump_location])
+      inject_error_id(Crashbreak.configure.dumper_options[:dump_location])
     end
 
-    def gsub_error_id(text)
+    def inject_error_id(text)
       text.gsub(':error_id:', @error_id)
     end
   end

data/lib/{restorers → crashbreak/restorers}/state_restorer.rb

@@ -35,5 +35,4 @@ module Crashbreak
       restorer.to_s.gsub('Crashbreak::', '').gsub('Restorer', '').underscore.to_sym
     end
   end
-
 end

data/lib/crashbreak/{formatters/basic_information_formatter.rb → serializers/basic_information_serializer.rb}

@@ -1,5 +1,5 @@
 module Crashbreak
-  class BasicInformationFormatter < BasicFormatter
+  class BasicInformationSerializer < BasicSerializer
     def serialize
       { name: exception.class.to_s, message: exception.message, backtrace: exception.backtrace, environment: ENV['RACK_ENV'] }
     end

data/lib/crashbreak/{formatters/basic_formatter.rb → serializers/basic_serializer.rb}

@@ -1,5 +1,5 @@
 module Crashbreak
-  class BasicFormatter
+  class BasicSerializer
 
     protected
 

data/lib/crashbreak/{formatters/default_summary_formatter.rb → serializers/default_summary_serializer.rb}

@@ -1,5 +1,5 @@
 module Crashbreak
-  class DefaultSummaryFormatter < SummaryFormatter
+  class DefaultSummarySerializer < SummarySerializer
     def summary
       {
           action: request.env['PATH_INFO'],

data/lib/crashbreak/{formatters/environment_variables_formatter.rb → serializers/environment_variables_serializer.rb}

@@ -1,5 +1,5 @@
 module Crashbreak
-  class EnvironmentVariablesFormatter < HashFormatter
+  class EnvironmentVariablesSerializer < HashSerializer
     hash_name :environment
 
     def hash_value

data/lib/crashbreak/{formatters/hash_formatter.rb → serializers/hash_serializer.rb}

@@ -1,5 +1,5 @@
 module Crashbreak
-  class HashFormatter < BasicFormatter
+  class HashSerializer < BasicSerializer
     class << self
       def hash_name(value)
         @hash_name = value

data/lib/crashbreak/{formatters/summary_formatter.rb → serializers/summary_serializer.rb}

@@ -1,5 +1,5 @@
 module Crashbreak
-  class SummaryFormatter < BasicFormatter
+  class SummarySerializer < BasicSerializer
     def serialize
       { summary: summary }
     end

data/lib/crashbreak/tiny_exception_notifier.rb

@@ -8,7 +8,7 @@ module Crashbreak
     private
 
     def serializers
-      [BasicInformationFormatter.new]
+      [BasicInformationSerializer.new]
     end
 
     def dumpers

data/lib/crashbreak/version.rb

@@ -1,3 +1,3 @@
 module Crashbreak
-  VERSION = '1.0.19'
+  VERSION = '1.1.0'
 end

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

@@ -1,6 +1,26 @@
 Crashbreak.configure do |config|
   config.api_key = '<%= token %>'
 
-  # Specify what will be sent to the server by attaching own formatters.
-  config.error_serializers = [Crashbreak::DefaultSummaryFormatter.new, Crashbreak::EnvironmentVariablesFormatter.new]
-end
+  # Use Crashbreak::ForkExceptionNotifier if you want to use fork for sending exception data.
+  config.exception_notifier = Crashbreak::ExceptionNotifier.new
+
+  # Serialize an exception in the best way for your project, add custom tabs, change default summary.
+  config.error_serializers = [Crashbreak::DefaultSummarySerializer.new, Crashbreak::EnvironmentVariablesSerializer.new]
+
+  # Specify dumpers list for future restoring process.
+  config.dumpers = [Crashbreak::RequestDumper.new, Crashbreak::DatabaseDumper.new]
+
+  # Config for all dumpers (aws is required for DatabaseDumper)
+  config.dumper_options = {
+      aws_bucket_name: 'bucket-name-here',
+      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']
+  }
+
+  # Config for GitHub integration
+  config.github_integration = true
+  config.github_login = ENV['GITHUB_USER']
+  config.github_password = ENV['GITHUB_PASSWORD']
+  config.github_repo_name = ENV['GITHUB_REPO_NAME']
+end

data/spec/features/sending_error_report_spec.rb

@@ -5,18 +5,18 @@ describe 'Sending error report to server' do
   let(:project_token) { 'example_project_token' }
   let(:example_error) { TestError.new }
   let(:example_request) { double(:example_request, env: { 'PATH_INFO' => 'example_action_name', 'REQUEST_URI' => 'url', 'HTTP_USER_AGENT' => 'agent' } )}
-  let(:summary_formatter) { Crashbreak::DefaultSummaryFormatter.new }
+  let(:summary_serializer) { Crashbreak::DefaultSummarySerializer.new }
   let(:example_controller) { double(:example_controller) }
   let(:env) { Hash['action_controller.instance' => example_controller ]}
 
   before(:each) do
     Crashbreak.configure.api_key = project_token
-    Crashbreak.configure.error_serializers = [summary_formatter, Crashbreak::EnvironmentVariablesFormatter.new, TestErrorFormatter.new]
+    Crashbreak.configure.error_serializers = [summary_serializer, Crashbreak::EnvironmentVariablesSerializer.new, Crashbreak::TestErrorSerializer.new]
     Crashbreak.configure.dumpers = [Crashbreak::RequestDumper.new]
 
     allow(crashing_app).to receive(:call).and_raise(example_error)
     allow(example_error).to receive(:backtrace).and_return(%w(example backtrace))
-    allow_any_instance_of(Crashbreak::BasicFormatter).to receive(:request).and_return(example_request)
+    allow_any_instance_of(Crashbreak::BasicSerializer).to receive(:request).and_return(example_request)
     allow(Crashbreak.configurator).to receive(:ignored_environments).and_return([])
   end
 
@@ -30,7 +30,7 @@ describe 'Sending error report to server' do
         name: example_error.to_s, message: example_error.message, backtrace: example_error.backtrace, environment: 'test',
         summary: { action: example_request.env['PATH_INFO'], controller_name: example_controller.class.to_s,
                    file: example_error.backtrace[0], url: example_request.env['REQUEST_URI'], user_agent: example_request.env['HTTP_USER_AGENT'] },
-        additional_data: { environment: ENV.to_hash, test: { formatter: true } }
+        additional_data: { environment: ENV.to_hash, test: { example_key: true } }
     }
   end
 

data/spec/lib/exception_notifier_spec.rb

@@ -81,10 +81,22 @@ describe Crashbreak::ExceptionNotifier do
     context 'github integration' do
       let(:error_hash) { Hash['id' => 1, 'deploy_revision' => 'test', 'similar' => false] }
 
-      it 'passes error hash from request to github integration service' do
+      before(:each) do
+        Crashbreak.configure.github_integration = true
         Crashbreak.configure.github_repo_name = 'user/repo'
 
         allow_any_instance_of(Crashbreak::ExceptionsRepository).to receive(:create).and_return(error_hash)
+      end
+
+      it 'integrates with github only if user enabled integration' do
+        Crashbreak.configure.github_integration = false
+
+        expect_any_instance_of(Crashbreak::GithubIntegrationService).to_not receive(:initialize)
+
+        subject.notify
+      end
+
+      it 'passes error hash from request to github integration service' do
         expect_any_instance_of(Crashbreak::GithubIntegrationService).to receive(:initialize).with(error_hash)
 
         subject.notify

data/spec/lib/{formatters/basic_formatter_spec.rb → serializers/basic_serializer_spec.rb}

@@ -1,4 +1,4 @@
-describe Crashbreak::BasicFormatter do
+describe Crashbreak::BasicSerializer do
   subject { described_class.new }
 
   let(:example_request) { double(:request) }

data/spec/lib/{formatters/default_summary_formatter_spec.rb → serializers/default_summary_serializer_spec.rb}

@@ -1,4 +1,4 @@
-describe Crashbreak::DefaultSummaryFormatter do
+describe Crashbreak::DefaultSummarySerializer do
   subject { described_class.new }
 
   let(:example_request) { double(:request, env: request_env) }

data/spec/lib/{formatters/group_formatter_spec.rb → serializers/group_serializer_spec.rb}

@@ -1,5 +1,5 @@
-describe Crashbreak::HashFormatter do
-  class TestHashFormatter < Crashbreak::HashFormatter
+describe Crashbreak::HashSerializer do
+  class Crashbreak::TestHashSerialzier < Crashbreak::HashSerializer
     hash_name :example_group
 
     def hash_value
@@ -7,7 +7,7 @@ describe Crashbreak::HashFormatter do
     end
   end
 
-  subject { TestHashFormatter.new }
+  subject { Crashbreak::TestHashSerialzier.new }
 
   it 'wraps hash in additional_data and group_name key' do
     expect(subject.serialize).to eq(additional_data: { example_group:  subject.hash_value })

data/spec/lib/serializers/summary_serializer_spec.rb

@@ -0,0 +1,13 @@
+describe Crashbreak::SummarySerializer do
+  class Crashbreak::SummaryTestSerializer < Crashbreak::SummarySerializer
+    def summary
+      { example: 'true' }
+    end
+  end
+
+  subject { Crashbreak::SummaryTestSerializer.new }
+
+  it 'wraps summary hash' do
+    expect(subject.serialize).to eq(summary: subject.summary)
+  end
+end

data/spec/support/test_error_serializer.rb

@@ -0,0 +1,9 @@
+module Crashbreak
+  class TestErrorSerializer < Crashbreak::HashSerializer
+    hash_name :test
+
+    def hash_value
+      { example_key: true }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crashbreak
 version: !ruby/object:Gem::Version
-  version: 1.0.19
+  version: 1.1.0
 platform: ruby
 authors:
 - Michal Janeczek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,59 +199,60 @@ files:
 - lib/crashbreak/capistrano3.rb
 - lib/crashbreak/config/configurable.rb
 - lib/crashbreak/config/configurator.rb
-- lib/crashbreak/deploys_repository.rb
-- lib/crashbreak/dumpers_data_repository.rb
+- lib/crashbreak/dumpers/database_dumper.rb
+- lib/crashbreak/dumpers/request_dumper.rb
 - lib/crashbreak/exception_catcher_middleware.rb
 - lib/crashbreak/exception_notifier.rb
-- lib/crashbreak/exceptions_repository.rb
 - lib/crashbreak/fork_exception_notifier.rb
-- lib/crashbreak/formatters/basic_formatter.rb
-- lib/crashbreak/formatters/basic_information_formatter.rb
-- lib/crashbreak/formatters/default_summary_formatter.rb
-- lib/crashbreak/formatters/environment_variables_formatter.rb
-- lib/crashbreak/formatters/hash_formatter.rb
-- lib/crashbreak/formatters/summary_formatter.rb
 - lib/crashbreak/github_integration_service.rb
 - lib/crashbreak/predefined_settings.rb
 - lib/crashbreak/railtie.rb
+- lib/crashbreak/repositories/base_repository.rb
+- lib/crashbreak/repositories/deploys_repository.rb
+- lib/crashbreak/repositories/dumpers_data_repository.rb
+- lib/crashbreak/repositories/exceptions_repository.rb
 - lib/crashbreak/request_parser.rb
+- lib/crashbreak/restorers/database_restorer.rb
+- lib/crashbreak/restorers/request_restorer.rb
+- lib/crashbreak/restorers/state_restorer.rb
+- lib/crashbreak/serializers/basic_information_serializer.rb
+- lib/crashbreak/serializers/basic_serializer.rb
+- lib/crashbreak/serializers/default_summary_serializer.rb
+- lib/crashbreak/serializers/environment_variables_serializer.rb
+- lib/crashbreak/serializers/hash_serializer.rb
+- lib/crashbreak/serializers/summary_serializer.rb
 - lib/crashbreak/tiny_exception_notifier.rb
 - lib/crashbreak/version.rb
-- lib/dumpers/database_dumper.rb
-- lib/dumpers/request_dumper.rb
 - lib/generators/crashbreak/install_generator.rb
 - lib/generators/crashbreak/templates/crashbreak.rb
 - lib/generators/crashbreak/templates/minitest_test.rb
 - lib/generators/crashbreak/templates/rspec_test.rb
 - lib/generators/crashbreak/test_generator.rb
-- lib/restorers/database_restorer.rb
-- lib/restorers/request_restorer.rb
-- lib/restorers/state_restorer.rb
 - lib/tasks/crashbreak.cap
 - lib/tasks/crashbreak.rake
-- spec/dumpers/request_dumper_spec.rb
 - spec/features/sending_error_report_spec.rb
 - spec/lib/config/configurable_spec.rb
 - spec/lib/config/configurator_spec.rb
 - spec/lib/deploys_repository_spec.rb
+- spec/lib/dumpers/request_dumper_spec.rb
 - spec/lib/dumpers_data_repository_spec.rb
 - spec/lib/exception_catcher_middleware_spec.rb
 - spec/lib/exception_notifier_spec.rb
 - spec/lib/exceptions_repository_spec.rb
-- spec/lib/formatters/basic_formatter_spec.rb
-- spec/lib/formatters/default_summary_formatter_spec.rb
-- spec/lib/formatters/group_formatter_spec.rb
-- spec/lib/formatters/summary_formatter_spec.rb
 - spec/lib/generators/install_generator_spec.rb
 - spec/lib/generators/test_generator_spec.rb
 - spec/lib/github_integration_service_spec.rb
 - spec/lib/request_parser_spec.rb
-- spec/restorers/state_restorer_spec.rb
+- spec/lib/restorers/state_restorer_spec.rb
+- spec/lib/serializers/basic_serializer_spec.rb
+- spec/lib/serializers/default_summary_serializer_spec.rb
+- spec/lib/serializers/group_serializer_spec.rb
+- spec/lib/serializers/summary_serializer_spec.rb
 - spec/spec_helper.rb
 - spec/support/crashbreak_config.rb
 - spec/support/rspec_config.rb
 - spec/support/test_error.rb
-- spec/support/test_error_formatter.rb
+- spec/support/test_error_serializer.rb
 homepage: http://crashbreak.com
 licenses:
 - MIT
@@ -277,27 +278,27 @@ signing_key:
 specification_version: 4
 summary: Take a break from crashes!
 test_files:
-- spec/dumpers/request_dumper_spec.rb
 - spec/features/sending_error_report_spec.rb
 - spec/lib/config/configurable_spec.rb
 - spec/lib/config/configurator_spec.rb
 - spec/lib/deploys_repository_spec.rb
+- spec/lib/dumpers/request_dumper_spec.rb
 - spec/lib/dumpers_data_repository_spec.rb
 - spec/lib/exception_catcher_middleware_spec.rb
 - spec/lib/exception_notifier_spec.rb
 - spec/lib/exceptions_repository_spec.rb
-- spec/lib/formatters/basic_formatter_spec.rb
-- spec/lib/formatters/default_summary_formatter_spec.rb
-- spec/lib/formatters/group_formatter_spec.rb
-- spec/lib/formatters/summary_formatter_spec.rb
 - spec/lib/generators/install_generator_spec.rb
 - spec/lib/generators/test_generator_spec.rb
 - spec/lib/github_integration_service_spec.rb
 - spec/lib/request_parser_spec.rb
-- spec/restorers/state_restorer_spec.rb
+- spec/lib/restorers/state_restorer_spec.rb
+- spec/lib/serializers/basic_serializer_spec.rb
+- spec/lib/serializers/default_summary_serializer_spec.rb
+- spec/lib/serializers/group_serializer_spec.rb
+- spec/lib/serializers/summary_serializer_spec.rb
 - spec/spec_helper.rb
 - spec/support/crashbreak_config.rb
 - spec/support/rspec_config.rb
 - spec/support/test_error.rb
-- spec/support/test_error_formatter.rb
+- spec/support/test_error_serializer.rb
 has_rdoc: 

data/spec/lib/formatters/summary_formatter_spec.rb

@@ -1,13 +0,0 @@
-describe Crashbreak::SummaryFormatter do
-  class SummaryTestFormatter < Crashbreak::SummaryFormatter
-    def summary
-      { example: 'true' }
-    end
-  end
-
-  subject { SummaryTestFormatter.new }
-
-  it 'wraps summary hash' do
-    expect(subject.serialize).to eq(summary: subject.summary)
-  end
-end

data/spec/support/test_error_formatter.rb

@@ -1,7 +0,0 @@
-class TestErrorFormatter < Crashbreak::HashFormatter
-  hash_name :test
-
-  def hash_value
-    { formatter: true }
-  end
-end