raygun4ruby 0.0.3

data/lib/generators/raygun/install_generator.rb

@@ -0,0 +1,17 @@
+module Raygun
+  class InstallGenerator < Rails::Generators::Base
+
+    argument :api_key
+
+    desc "This generator creates a configuration file for the Raygun ruby adapter inside config/initializers"
+    def create_configuration_file
+      initializer "raygun.rb" do
+        <<-EOS
+Raygun.setup do |config|
+  config.api_key = "#{api_key}"
+end
+EOS
+      end
+    end
+  end
+end

data/lib/raygun.rb

@@ -0,0 +1,75 @@
+require "bundler"
+Bundler.setup(:default)
+
+require "httparty"
+require "logger"
+require "json"
+require "socket"
+require "rack"
+require "active_support/core_ext"
+
+require "raygun/version"
+require "raygun/configuration"
+require "raygun/client"
+require "raygun/rack_exception_interceptor"
+require "raygun/testable"
+require "raygun/railtie" if defined?(Rails)
+
+module Raygun
+
+  # used to identify ourselves to Raygun
+  CLIENT_URL  = "https://github.com/MindscapeHQ/raygun4ruby"
+  CLIENT_NAME = "Raygun4Ruby Gem"
+
+  class << self
+
+    include Testable
+
+    # Configuration Object (instance of Raygun::Configuration)
+    attr_writer :configuration
+
+    def setup
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def track_exception(exception_instance, env = {})
+      if should_report?(exception_instance)
+        log("[Raygun] Tracking Exception...")
+        Client.new.track_exception(exception_instance, env)
+      end
+    rescue Exception => e
+      if configuration.failsafe_logger
+        failsafe_log("Problem reporting exception to Raygun: #{e.class}: #{e.message}\n\n#{e.backrace.join("\n")}")
+      else
+        raise e
+      end
+    end
+
+    def track_exceptions
+      yield
+    rescue => e
+      track_exception(e)
+    end
+
+    def log(message)
+      configuration.logger.info(message) if configuration.logger
+    end
+
+    def failsafe_log(message)
+      configuration.failsafe_logger.info(message)
+    end
+
+    private
+
+      def should_report?(exception)
+        return false if configuration.silence_reporting
+        return false if configuration.ignore.include?(exception.class.to_s)
+        true
+      end
+
+  end
+end

data/lib/raygun/client.rb

@@ -0,0 +1,104 @@
+module Raygun
+  # client for the Raygun REST APIv1
+  # as per http://raygun.io/raygun-providers/rest-json-api?v=1
+  class Client
+    include HTTParty
+
+    base_uri "https://api.raygun.io/"
+
+    def initialize
+      @headers = {
+        "X-ApiKey" => Raygun.configuration.api_key
+      }
+    end
+
+    def track_exception(exception_instance, env = {})
+      create_entry(build_payload_hash(exception_instance, env))
+    end
+
+    private
+
+      def client_details
+        {
+          name:      Raygun::CLIENT_NAME,
+          version:   Raygun::VERSION,
+          clientUrl: Raygun::CLIENT_URL
+        }
+      end
+
+      def error_details(exception)
+        {
+          className:  exception.class.to_s,
+          message:    exception.message,
+          stackTrace: exception.backtrace.map { |line| stack_trace_for(line) }
+        }
+      end
+
+      def stack_trace_for(line)
+        # see http://www.ruby-doc.org/core-2.0/Exception.html#method-i-backtrace
+        file_name, line_number, method = line.split(":")
+        {
+          lineNumber: line_number,
+          fileName:   file_name,
+          methodName: method.gsub(/^in `(.*?)'$/, "\\1")
+        }
+      end
+
+      def hostname
+        Socket.gethostname
+      end
+
+      def version
+        Raygun.configuration.version
+      end
+
+      def request_information(env)
+        return {} if env.blank?
+
+        {
+          hostName:    env["SERVER_NAME"],
+          url:         env["PATH_INFO"],
+          httpMethod:  env["REQUEST_METHOD"],
+          ipAddress:   env["REMOTE_ADDR"],
+          queryString: Rack::Utils.parse_nested_query(env["QUERY_STRING"]),
+          form:        form_data(env),
+          headers:     headers(env),
+          rawData:     []
+        }
+      end
+
+      def headers(rack_env)
+        rack_env.select do |k, v|
+          k.starts_with?("HTTP_")
+        end
+      end
+
+      def form_data(rack_env)
+        request = Rack::Request.new(rack_env)
+
+        if request.form_data?
+          request.body
+        end
+      end
+
+      # see http://raygun.io/raygun-providers/rest-json-api?v=1
+      def build_payload_hash(exception_instance, env)
+        {
+          occurredOn: Time.now.utc.iso8601,
+          details: {
+            machineName:    hostname,
+            version:        version,
+            client:         client_details,
+            error:          error_details(exception_instance),
+            userCustomData: Raygun.configuration.custom_data,
+            request:        request_information(env)
+          }
+        }
+      end
+
+      def create_entry(payload_hash)
+        self.class.post("/entries", headers: @headers, body: JSON.generate(payload_hash))
+      end
+
+  end
+end

data/lib/raygun/configuration.rb

@@ -0,0 +1,45 @@
+module Raygun
+  class Configuration
+
+    # Your Raygun API Key - this can be found on your dashboard at Raygun.io
+    attr_accessor :api_key
+
+    # Array of exception classes to ignore
+    attr_accessor :ignore
+
+    # Version to use
+    attr_accessor :version
+
+    # Custom Data to send with each exception
+    attr_accessor :custom_data
+
+    # Logger to use when if we find an exception :)
+    attr_accessor :logger
+
+    # Should we silence exception reporting (e.g in Development environments)
+    attr_accessor :silence_reporting
+
+    # Failsafe logger (for exceptions that happen when we're attempting to report exceptions)
+    attr_accessor :failsafe_logger
+
+    # Exception classes to ignore by default
+    IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
+                      'ActionController::RoutingError',
+                      'ActionController::InvalidAuthenticityToken',
+                      'CGI::Session::CookieStore::TamperedWithCookie',
+                      'ActionController::UnknownAction',
+                      'AbstractController::ActionNotFound',
+                      'Mongoid::Errors::DocumentNotFound']
+
+    def initialize
+      # set default attribute values
+      @ignore      = IGNORE_DEFAULT
+      @custom_data = {}
+    end
+
+    def [](key)
+      send(key)
+    end
+
+  end
+end

data/lib/raygun/rack_exception_interceptor.rb

@@ -0,0 +1,16 @@
+module Raygun
+  class RackExceptionInterceptor
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      response = @app.call(env)
+    rescue Exception => exception
+      Raygun.track_exception(exception, env)
+      raise exception
+    end
+
+  end
+end

data/lib/raygun/railtie.rb

@@ -0,0 +1,26 @@
+class Raygun::Railtie < Rails::Railtie
+
+  initializer "raygun.configure_rails_initialization" do |app|
+
+    # Thanks Airbrake: See https://github.com/rails/rails/pull/8624
+    middleware = if defined?(ActionDispatch::DebugExceptions)
+      # Rails >= 3.2.0
+      "ActionDispatch::DebugExceptions"
+    else
+      # Rails < 3.2.0
+      "ActionDispatch::ShowExceptions"
+    end
+
+    app.config.middleware.insert_after middleware, "Raygun::RackExceptionInterceptor"
+  end
+
+  config.to_prepare do
+    Raygun.configuration.logger            ||= Rails.logger
+    Raygun.configuration.silence_reporting ||= Rails.env.development?
+  end
+
+  rake_tasks do
+    load "tasks/raygun.tasks"
+  end
+
+end

data/lib/raygun/testable.rb

@@ -0,0 +1,19 @@
+module Raygun
+
+  class ItWorksException < StandardError; end
+
+  module Testable
+
+    def track_test_exception
+      Raygun.configuration.silence_reporting = false
+      raise ItWorksException.new("Woohoo! Your Raygun<->Ruby connection is set up correctly")
+    rescue ItWorksException => e
+      if Raygun.track_exception(e).success?
+        puts "Success! Now go check your Raygun.io Dashboard"
+      else
+        puts "Oh-oh, something went wrong - double check your API key"
+      end
+    end
+
+  end
+end

data/lib/raygun/version.rb

@@ -0,0 +1,3 @@
+module Raygun
+  VERSION = "0.0.3"
+end

data/lib/raygun4ruby.rb

@@ -0,0 +1 @@
+require "raygun"

data/lib/tasks/raygun.tasks

@@ -0,0 +1,8 @@
+namespace :raygun do
+
+  desc "Test Raygun integration"
+  task :test => :environment do
+    Raygun.track_test_exception
+  end
+
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification 
+name: raygun4ruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Mindscape
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-31 00:00:00 +12:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        version: "0.11"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 2
+        version: "4.2"
+  type: :development
+  version_requirements: *id009
+description: Ruby Adapter for Raygun.io
+email: 
+- hello@raygun.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/raygun.rb
+- lib/raygun/client.rb
+- lib/raygun/configuration.rb
+- lib/raygun/rack_exception_interceptor.rb
+- lib/raygun/railtie.rb
+- lib/raygun/version.rb
+- lib/raygun4ruby.rb
+- lib/generators/raygun/install_generator.rb
+- lib/raygun/testable.rb
+- lib/tasks/raygun.tasks
+has_rdoc: true
+homepage: http://raygun.io
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: This gem provides support for Ruby and Ruby on Rails for the Raygun.io error reporter
+test_files: []
+