sentry-raven 2.5.1 → 2.5.2

data/docs/make.bat

@@ -0,0 +1,155 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Sentry.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Sentry.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end

data/docs/sentry-doc-config.json

@@ -0,0 +1,31 @@
+{
+  "support_level": "production",
+  "platforms": {
+    "ruby": {
+      "name": "Ruby",
+      "type": "language",
+      "doc_link": "",
+      "wizard": [
+        "index#installation",
+        "index#configuration",
+        "index#reporting-failures"
+      ]
+    },
+    "ruby.rack": {
+      "name": "Rack",
+      "type": "framework",
+      "doc_link": "integrations/rack/",
+      "wizard": [
+        "integrations/rack#rack-sinatra-etc"
+      ]
+    },
+    "ruby.rails": {
+      "name": "Rails",
+      "type": "framework",
+      "doc_link": "integrations/rails/",
+      "wizard": [
+        "integrations/rails#ruby-on-rails"
+      ]
+    }
+  }
+}

data/docs/usage.rst

@@ -0,0 +1,160 @@
+Usage
+=====
+
+To use Raven Ruby all you need is your DSN.  Like most Sentry libraries it
+will honor the ``SENTRY_DSN`` environment variable.  You can find it on
+the project settings page under API Keys.  You can either export it as
+environment variable or manually configure it with ``Raven.configure``:
+
+.. code-block:: ruby
+
+    Raven.configure do |config|
+      config.dsn = '___DSN___'
+    end
+
+If you only want to send events to Sentry in certain environments, you
+should set ``config.environments`` too:
+
+.. code-block:: ruby
+
+    Raven.configure do |config|
+      config.dsn = '___DSN___'
+      config.environments = ['staging', 'production']
+    end
+
+Reporting Failures
+------------------
+
+If you use Rails, Rake, Rack etc, you're already done - no more
+configuration required! Check :doc:`integrations/index` for more details on
+other gems Sentry integrates with automatically.
+
+Otherwise, Raven supports two methods of capturing exceptions:
+
+.. sourcecode:: ruby
+
+    Raven.capture do
+      # capture any exceptions which happen during execution of this block
+      1 / 0
+    end
+
+    begin
+      1 / 0
+    rescue ZeroDivisionError => exception
+      Raven.capture_exception(exception)
+    end
+
+Reporting Messages
+------------------
+
+If you want to report a message rather than an exception you can use the
+``capture_message`` method:
+
+.. code-block:: ruby
+
+    Raven.capture_message("Something went very wrong")
+
+Referencing Events
+------------------
+
+The client exposes a ``last_event_id`` accessor allowing you to easily
+reference the last captured event. This is useful, for example, if you wanted
+to show the user a reference on your error page:
+
+.. code-block:: ruby
+
+    # somewhere deep in the stack
+    Raven.capture do
+      1 / 0
+    end
+
+Now you can easily expose this to your error handler:
+
+.. code-block:: ruby
+
+    class ErrorsController < ApplicationController
+      def internal_server_error
+        render(:status => 500, :sentry_event_id => Raven.last_event_id)
+      end
+    end
+
+Optional Attributes
+-------------------
+
+With calls to ``capture_exception`` or ``capture_message`` additional data
+can be supplied:
+
+  .. code-block:: ruby
+
+      Raven.capture_message("...", :attr => 'value')
+
+.. describe:: extra
+
+    Additional context for this event. Must be a mapping. Children can be any native JSON type.
+
+    .. code-block:: ruby
+
+        {
+            :extra => {'key' => 'value'}
+        }
+
+.. describe:: fingerprint
+
+    The fingerprint for grouping this event.
+
+    .. code-block:: ruby
+
+        {
+            :fingerprint => ['{{ default }}', 'other value']
+        }
+
+.. describe:: level
+
+    The level of the event. Defaults to ``error``.
+
+    .. code-block:: ruby
+
+        {
+            :level => 'warning'
+        }
+
+    Sentry is aware of the following levels:
+
+    * debug (the least serious)
+    * info
+    * warning
+    * error
+    * fatal (the most serious)
+
+.. describe:: logger
+
+    The logger name for the event.
+
+    .. code-block:: ruby
+
+        {
+            :logger => 'default'
+        }
+
+.. describe:: tags
+
+    Tags to index with this event. Must be a mapping of strings.
+
+    .. code-block:: ruby
+
+        {
+            :tags => {'key' => 'value'}
+        }
+
+.. describe:: user
+
+    The acting user.
+
+    .. code-block:: ruby
+
+        {
+            :user => {
+                'id' => 42,
+                'email' => 'clever-girl'
+            }
+        }

data/exe/raven

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require "raven"
+require "raven/cli"
+require "optparse"
+
+parser = OptionParser.new do |opt|
+  opt.banner = "Usage: raven COMMAND [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Commands"
+  opt.separator  "     test: send a test event"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-h", "--help", "help") do
+    puts parser
+  end
+end
+
+parser.parse!
+
+case ARGV[0]
+when "test"
+  dsn = ARGV[1] if ARGV.length > 1
+  if !dsn
+    puts "Usage: raven test <dsn>"
+  else
+    Raven::CLI.test(dsn)
+  end
+else
+  puts parser
+end

data/lib/raven/backtrace.rb

@@ -110,7 +110,7 @@ module Raven
     end
 
     def inspect
-      "<Backtrace: " + lines.map(&inspect).join(", ") + ">"
+      "<Backtrace: " + lines.map(&:inspect).join(", ") + ">"
     end
 
     def to_s

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Raven
   # Freezing this constant breaks in 1.9.x
-  VERSION = "2.5.1" # rubocop:disable Style/MutableConstant
+  VERSION = "2.5.2" # rubocop:disable Style/MutableConstant
 end

data/sentry-raven.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'raven/version'
+
+Gem::Specification.new do |gem|
+  gem.name = "sentry-raven"
+  gem.authors = ["Sentry Team"]
+  gem.description = gem.summary = "A gem that provides a client interface for the Sentry error logger"
+  gem.email = "getsentry@googlegroups.com"
+  gem.license = 'Apache-2.0'
+  gem.homepage = "https://github.com/getsentry/raven-ruby"
+
+  gem.version = Raven::VERSION
+  gem.platform = Gem::Platform::RUBY
+  gem.required_ruby_version = '>= 1.9.0'
+  gem.has_rdoc = true
+  gem.extra_rdoc_files = ["README.md", "LICENSE"]
+  gem.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+  gem.bindir = "exe"
+  gem.executables = "raven"
+
+  gem.add_dependency "faraday", ">= 0.7.6", "< 1.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,100 +30,40 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.41.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.41.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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: rspec-rails
-  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: timecop
-  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: test-unit
-  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'
 description: A gem that provides a client interface for the Sentry error logger
 email: getsentry@googlegroups.com
-executables: []
+executables:
+- raven
 extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
+- changelog.md
+- docs/Makefile
+- docs/breadcrumbs.rst
+- docs/conf.py
+- docs/config.rst
+- docs/context.rst
+- docs/index.rst
+- docs/install.rst
+- docs/integrations/index.rst
+- docs/integrations/puma.rst
+- docs/integrations/rack.rst
+- docs/integrations/rails.rst
+- docs/make.bat
+- docs/sentry-doc-config.json
+- docs/usage.rst
+- exe/raven
 - lib/raven.rb
 - lib/raven/backtrace.rb
 - lib/raven/base.rb
@@ -173,6 +113,7 @@ files:
 - lib/raven/version.rb
 - lib/sentry-raven-without-integrations.rb
 - lib/sentry-raven.rb
+- sentry-raven.gemspec
 homepage: https://github.com/getsentry/raven-ruby
 licenses:
 - Apache-2.0