merge with upstream

CHANGES → CHANGELOG.md

@@ -1,195 +1,170 @@
-1.7.0
------
+# CHANGELOG
+
+## 1.7.0
 
 - Changes for compatibility with php5.2
 - Corrected some issues with argument serialization in stacktraces (#399).
-- The default exception handler will now re-raise exceptions when
- ``call_existing`` is true and no exception handler is registered (#421).
-- Collect User.ip_address automatically (#419).
-- Added a processor to remove web cookies and another to remove HTTP body data for POST, PUT, PATCH and DELETE requests. They will be enabled by default in ``2.0`` (#405).
+- The default exception handler will now re-raise exceptions when `call_existing` is true and no exception handler is registered (#421).
+- Collect `User.ip_address` automatically (#419).
+- Added a processor to remove web cookies. It will be enabled by default in `2.0` (#405).
+- Added a processor to remove HTTP body data for POST, PUT, PATCH and DELETE requests. It will be enabled by default in `2.0` (#405).
+- Added a processor to sanitize HTTP headers (e.g. the Authorization header) (#428).
+- Added a processor to remove `pre_context`, `context_line` and `post_context` informations from reported exceptions (#429).
 
-1.6.2
------
+## 1.6.2 (2017-02-03)
 
 - Fixed behavior where fatal errors weren't correctly being reported in most situations.
 
-1.6.1
------
+## 1.6.1 (2016-12-14)
 
-- Correct handling of null in ``user_context``.
+- Correct handling of null in `user_context`.
 
-1.6.0
------
+## 1.6.0 (2016-12-09)
 
 - Improved serialization of certain types to be more restrictive.
-- ``error_types`` can now be configured via ``RavenClient``.
+- `error_types` can now be configured via `RavenClient`.
 - Class serialization has been expanded to include attributes.
 - The session extension is no longer required.
 - Monolog is no longer a required dependency.
-- ``user_context`` now merges by default.
+- `user_context` now merges by default.
 
-1.5.0
------
+## 1.5.0 (2016-09-29)
 
 - Added named transaction support.
 
-1.4.0
------
+## 1.4.0 (2016-09-20)
 
 This version primarily overhauls the exception/stacktrace generation to fix
 a few bugs and improve the quality of data (#359).
 
-- Added ``excluded_app_paths`` config.
-- Removed ``shift_vars`` config.
-- Correct fatal error handling to only operate on expected types. This also
- fixes some behavior with the error suppression operator.
+- Added `excluded_app_paths` config.
+- Removed `shift_vars` config.
+- Correct fatal error handling to only operate on expected types. This also fixes some behavior with the error suppression operator.
 - Expose anonymous and similar frames in the stacktrace.
-- Default ``prefixes`` to PHP's include paths.
-- Remove ``module`` usage.
+- Default `prefixes` to PHP's include paths.
+- Remove `module` usage.
 - Better handle empty argument context.
 - Correct alignment of filename (current frame) and function (caller frame)
 
-1.3.0
------
+## 1.3.0 (2016-12-19)
 
 - Fixed an issue causing the error suppression operator to not be respected (#335)
 - Fixed some serialization behavior (#352)
 - Fixed an issue with app paths and trailing slashes (#350)
 - Handle non-latin encoding with source code context line (#345)
 
-1.2.0
------
+## 1.2.0 (2016-12-08)
 
 - Handle non-latin encoding in source code and exception values (#342)
 - Ensure pending events are sent on shutdown by default (#338)
-- Add ``captureLastError`` helper (#334)
+- Add `captureLastError` helper (#334)
 - Dont report duplicate errors with fatal error handler (#334)
 - Enforce maximum length for string serialization (#329)
 
-1.1.0
------
+## 1.1.0 (2016-07-30)
 
 - Uncoercable values should no longer prevent exceptions from sending
  to the Sentry server.
-- ``install()`` can no longer be called multiple times.
+- `install()` can no longer be called multiple times.
 
-1.0.0
------
+## 1.0.0 (2016-07-28)
 
 - Removed deprecated error codes configuration from ErrorHandler.
 - Removed env data from HTTP interface.
-- Removed 'message' attribute from exceptions'.
+- Removed `message` attribute from exceptions.
 - appPath and prefixes are now resolved fully.
 - Fixed various getter methods requiring invalid args.
-- Fixed data mutation with 'send_callback'.
+- Fixed data mutation with `send_callback`.
 
-0.22.0
-------
+## 0.22.0 (2016-06-23)
 
 - Improve handling of encodings.
 - Improve resiliency of variable serialization.
 - Add 'formatted' attribute to Message interface.
 
-0.21.0
-------
+## 0.21.0 (2016-06-10)
 
-- Added ``transport`` option.
-- Added ``install()`` shortcut.
+- Added `transport` option.
+- Added `install()` shortcut.
 
-0.20.0
-------
+## 0.20.0 (2016-06-02)
 
 - Handle missing function names on frames.
 - Remove suppression operator usage in breadcrumbs buffer.
 - Force serialization of context values.
 
-0.19.0
-------
+## 0.19.0 (2016-05-27)
 
-- Add error_reporting breadcrumb handler.
+- Add `error_reporting` breadcrumb handler.
 
-0.18.0
-------
+## 0.18.0 (2016-05-17)
 
 - Remove session from serialized data.
-- send_callback return value must now be false to prevent capture.
+- `send_callback` return value must now be false to prevent capture.
 - Add various getter/setter methods for configuration.
 
-0.17.0
-------
+## 0.17.0 (2016-05-11)
 
 - Don't attempt to serialize fixed SDK inputs.
 - Improvements to breadcrumbs support in Monolog.
 
-0.16.0
-------
+## 0.16.0 (2016-05-03)
 
 - Initial breadcrumbs support with Monolog handler.
 
-0.15.0
-------
+## 0.15.0 (2016-04-29)
 
 - Fixed some cases where serialization wouldn't happen.
 - Added sdk attribute.
 
-0.14.0
-------
+## 0.14.0 (2016-04-27)
 
-- Added ``prefixes`` option for stripping absolute paths.
-- Removed ``abs_path`` from stacktraces.
-- Added ``app_path`` to specify application root for resolving ``in_app` on frames.
-- Moved Laravel support to ``sentry-laravel`` project.
+- Added `prefixes` option for stripping absolute paths.
+- Removed `abs_path` from stacktraces.
+- Added `app_path` to specify application root for resolving `in_app` on frames.
+- Moved Laravel support to `sentry-laravel` project.
 - Fixed duplicate stack computation.
-- Added ``dsn`` option to ease configuration.
+- Added `dsn` option to ease configuration.
 - Fixed an issue with the curl async transport.
 - Improved serialization of values.
 
-0.13.0
-------
+## 0.13.0 (2015-09-09)
 
 - Updated API to use new style interfaces.
 - Remove session cookie in default processor.
 - Expand docs for Laravel, Symfony2, and Monolog.
 - Default error types can now be set as part of ErrorHandler configuration.
 
-0.12.1
-------
+## 0.12.1 (2015-07-26)
 
 - Dont send empty values for various context.
 
-0.12.0
-------
+## 0.12.0 (2015-05-19)
 
 - Bumped protocol version to 6.
 - Fixed an issue with the async curl handler (GH-216).
 - Removed UDP transport.
 
-0.11.0
-------
+## 0.11.0 (2015-03-25)
 
-- New configuration parameter: 'release'
-- New configuration parameter: 'message_limit'
-- New configuration parameter: 'curl_ssl_version'
-- New configuration parameter: 'curl_ipv4'
-- New configuration parameter: 'verify_ssl'
+- New configuration parameter: `release`
+- New configuration parameter: `message_limit`
+- New configuration parameter: `curl_ssl_version`
+- New configuration parameter: `curl_ipv4`
+- New configuration parameter: `verify_ssl`
 - Updated remote endpoint to use modern project-based path.
-- Expanded default sanitizer support to include 'auth_pw' attribute.
+- Expanded default sanitizer support to include `auth_pw` attribute.
 
-0.10.0
-------
+## 0.10.0 (2014-09-03)
 
-- Added a default certificate bundle which includes common root CA's
- as well as getsentry.com's CA.
+- Added a default certificate bundle which includes common root CA's as well as getsentry.com's CA.
 
-0.9.1
------
+## 0.9.1 (2014-08-26)
 
-- Change default curl connection to 'sync'
+- Change default curl connection to `sync`
 - Improve CLI reporting
 
-
-0.9.0
------
+## 0.9.0 (2014-06-04)
 
 - Protocol version 5
 - Default to asynchronous HTTP handler using curl_multi.

README.md

@@ -0,0 +1,83 @@
+# immobiliare/sentry-php
+
+[![Build Status](https://travis-ci.org/immobiliare/sentry-php.svg?branch=master)](https://travis-ci.org/immobiliare/sentry-php)
+[![Latest Stable Version](https://poser.pugx.org/immobiliare/sentry-php/v/stable?style=flat-square)](https://packagist.org/packages/immobiliare/sentry-php)
+[![Total Downloads](https://poser.pugx.org/immobiliare/sentry-php/downloads?style=flat-square)](https://packagist.org/packages/immobiliare/sentry-php)
+[![Latest Unstable Version](https://poser.pugx.org/immobiliare/sentry-php/v/unstable?style=flat-square)](https://packagist.org/packages/immobiliare/sentry-php)
+[![License](https://poser.pugx.org/immobiliare/sentry-php/license?style=flat-square)](https://packagist.org/packages/immobiliare/sentry-php)
+[![Monthly Downloads](https://poser.pugx.org/immobiliare/sentry-php/d/monthly?style=flat-square)](https://packagist.org/packages/immobiliare/sentry-php)
+[![Daily Downloads](https://poser.pugx.org/immobiliare/sentry-php/d/daily?style=flat-square)](https://packagist.org/packages/immobiliare/sentry-php)
+
+This project is a fork of official [PHP SDK v1.7](https://github.com/getsentry/sentry-php) for [Sentry](https://getsentry.com) to work even with php5.2.
+
+## Features
+
+- Automatically report (un)handled exceptions and errors
+- Send customized diagnostic data
+- Process and sanitize data before sending it over the network
+
+## Installation
+
+There are various ways to install the PHP integration for Sentry. The
+recommended way is to use [Composer](https://getcomposer.org).
+
+ $ composer require immobiliare/sentry-php:1.7.x-dev
+
+Alternatively you can manually install it:
+
+1. Download and extract the latest [sentry-php](https://github.com/immobiliare/sentry-php/archive/master.zip>) archive to your PHP project.
+2. Require the autoloader in your application:
+
+```php
+require_once '/path/to/Raven/library/Raven/Autoloader.php';
+Raven_Autoloader::register();
+```
+
+## Usage
+
+```php
+// Instantiate a new client with a compatible DSN and install built-in
+// handlers
+$sentryClient = new Raven_Client('https://e9ebbd88548a441288393c457ec90441:[email protected]/3235');
+$sentryClient->install();
+
+// Capture an exception
+$event_id = $sentryClient->captureException($ex);
+
+// Give the user feedback
+echo "Sorry, there was an error!";
+echo "Your reference ID is " . $event_id;
+```
+
+For more information, see the [documentation](https://docs.getsentry.com/hosted/clients/php/).
+
+
+## Integration with frameworks
+
+Other packages exists to integrate this SDK into the most common frameworks.
+
+- [Symfony](https://github.com/getsentry/sentry-symfony)
+- [Laravel](https://github.com/getsentry/sentry-laravel)
+
+
+## Community
+
+- [Documentation](https://docs.getsentry.com/hosted/clients/php/)
+- [Bug Tracker](https://github.com/immobiliare/sentry-php/issues)
+- [Code](https://github.com/immobiliare/sentry-php)
+
+
+Contributing
+------------
+
+Dependencies are managed through composer:
+
+```
+$ composer install
+```
+
+Tests can then be run via phpunit:
+
+```
+$ vendor/bin/phpunit
+```