raygun4ruby 3.2.6 → 4.0.0.pre

data/Rakefile

@@ -1,27 +1,32 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-
-require "rake/testtask"
-
-namespace :test do
-
-  desc "Test the basics of the adapter"
-  Rake::TestTask.new(:units) do |t|
-    t.test_files = FileList["test/unit/*_test.rb"]
-  end
-
-  desc "Run a test against the live API"
-  Rake::TestTask.new(:integration) do |t|
-    t.test_files = FileList["test/integration/*_test.rb"]
-  end
-
-  begin
-    require 'rspec/core/rake_task'
-
-    RSpec::Core::RakeTask.new(:spec)
-
-  rescue LoadError
-  end
-end
-
-task default: ["test:units", "test:spec"]
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+require "appraisal"
+require "rake/testtask"
+
+namespace :test do
+
+  desc "Test the basics of the adapter"
+  Rake::TestTask.new(:units) do |t|
+    t.test_files = FileList["test/unit/*_test.rb"]
+  end
+
+  desc "Run a test against the live API"
+  Rake::TestTask.new(:integration) do |t|
+    t.test_files = FileList["test/integration/*_test.rb"]
+  end
+
+  begin
+    require 'rspec/core/rake_task'
+
+    RSpec::Core::RakeTask.new(:spec)
+
+  rescue LoadError
+  end
+end
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
+  task default: :appraisal
+else
+  task default: ["test:units", "test:spec"]
+end

data/examples/sinatras_raygun.rb

@@ -1,18 +1,18 @@
-# NB: You'll need to install the 'sinatra' gem for this to work :)
-# $ gem install sinatra
-# $ ruby sinatras_raygun.rb
-
-require 'sinatra'
-require_relative '../lib/raygun4ruby'
-
-Raygun.setup do |config|
-  config.api_key = YOUR_RAYGUN_API_KEY_HERE
-end
-
-use Raygun::RackExceptionInterceptor
-
-set :raise_errors, true
-
-get '/' do
-  raise "This is an exception that will be sent to Raygun!"
+# NB: You'll need to install the 'sinatra' gem for this to work :)
+# $ gem install sinatra
+# $ ruby sinatras_raygun.rb
+
+require 'sinatra'
+require_relative '../lib/raygun4ruby'
+
+Raygun.setup do |config|
+  config.api_key = YOUR_RAYGUN_API_KEY_HERE
+end
+
+use Raygun::RackExceptionInterceptor
+
+set :raise_errors, true
+
+get '/' do
+  raise "This is an exception that will be sent to Raygun!"
 end

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "6.1.4"
+gem "sqlite3", "~> 1.4"
+gem "sidekiq", ">= 7"
+
+gemspec path: "../"

data/gemfiles/rails_7.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "7.1.3"
+gem "sqlite3", "~> 1.4"
+gem "importmap-rails"
+gem "sidekiq", ">= 7"
+
+gemspec path: "../"

data/gemfiles/rails_7_sidekiq_6.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "7.1.3"
+gem "sqlite3", "~> 1.4"
+gem "importmap-rails"
+gem "sidekiq", "~> 6.5"
+
+gemspec path: "../"

data/lib/generators/raygun/install_generator.rb

@@ -1,26 +1,26 @@
-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
-      filter_parameters = if defined?(Rails)
-                            "config.filter_parameters = Rails.application.config.filter_parameters"
-                          else
-                            "config.filter_parameters = [ :password, :card_number, :cvv ] # don't forget to filter out sensitive parameters"
-                          end
-      initializer "raygun.rb" do
-        <<-EOS
-Raygun.setup do |config|
-  config.api_key = "#{api_key}"
-  #{filter_parameters}
-
-  # The default is Rails.env.production?
-  # config.enable_reporting = !Rails.env.development? && !Rails.env.test?
-end
-EOS
-      end
-    end
-  end
-end
+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
+      filter_parameters = if defined?(Rails)
+                            "config.filter_parameters = Rails.application.config.filter_parameters"
+                          else
+                            "config.filter_parameters = [ :password, :card_number, :cvv ] # don't forget to filter out sensitive parameters"
+                          end
+      initializer "raygun.rb" do
+        <<-EOS
+Raygun.setup do |config|
+  config.api_key = "#{api_key}"
+  #{filter_parameters}
+
+  # The default is Rails.env.production?
+  # config.enable_reporting = !Rails.env.development? && !Rails.env.test?
+end
+EOS
+      end
+    end
+  end
+end

data/lib/raygun/affected_user.rb

@@ -1,59 +1,59 @@
-module Raygun
-  class AffectedUser
-
-    DEFAULT_MAPPING = {
-      identifier: [ :id, :username ],
-      email:      :email,
-      full_name:  [ :full_name, :name ],
-      first_name: :first_name,
-      uuid:       :uuid
-    }.freeze
-    SUPPORTED_ATTRIBUTES = DEFAULT_MAPPING.keys.freeze
-    NAME_TO_RAYGUN_NAME_MAPPING = {
-      identifier: :identifier,
-      email: :email,
-      full_name: :fullName,
-      first_name: :firstName,
-      uuid: :uuid
-    }.freeze
-
-    class << self
-      def information_hash(user_object)
-        if user_object.nil? || user_object.is_a?(String)
-          handle_anonymous_user(user_object)
-        else
-          handle_known_user(user_object)
-        end
-      end
-
-      private
-
-      def handle_anonymous_user(user_object)
-        result = { isAnonymous: true }
-        result[:identifier] = user_object unless user_object.nil?
-        result
-      end
-
-      def handle_known_user(user_object)
-        SUPPORTED_ATTRIBUTES.reduce({ isAnonymous: false }) do |result, attribute|
-          mapping = Raygun.configuration.affected_user_mapping
-          method = mapping[attribute]
-
-          value = if method.is_a? Proc
-                    method.call(user_object)
-                  else
-                    attributes = Array(method)
-                    attribute_to_use = attributes.select do |attr|
-                      user_object.respond_to?(attr, true)
-                    end.first
-
-                    user_object.send(attribute_to_use) unless attribute_to_use == nil
-                  end
-
-          result[NAME_TO_RAYGUN_NAME_MAPPING[attribute]] = value unless value == nil
-          result
-        end
-      end
-    end
-  end
-end
+module Raygun
+  class AffectedUser
+
+    DEFAULT_MAPPING = {
+      identifier: [ :id, :username ],
+      email:      :email,
+      full_name:  [ :full_name, :name ],
+      first_name: :first_name,
+      uuid:       :uuid
+    }.freeze
+    SUPPORTED_ATTRIBUTES = DEFAULT_MAPPING.keys.freeze
+    NAME_TO_RAYGUN_NAME_MAPPING = {
+      identifier: :identifier,
+      email: :email,
+      full_name: :fullName,
+      first_name: :firstName,
+      uuid: :uuid
+    }.freeze
+
+    class << self
+      def information_hash(user_object)
+        if user_object.nil? || user_object.is_a?(String)
+          handle_anonymous_user(user_object)
+        else
+          handle_known_user(user_object)
+        end
+      end
+
+      private
+
+      def handle_anonymous_user(user_object)
+        result = { isAnonymous: true }
+        result[:identifier] = user_object unless user_object.nil?
+        result
+      end
+
+      def handle_known_user(user_object)
+        SUPPORTED_ATTRIBUTES.reduce({ isAnonymous: false }) do |result, attribute|
+          mapping = Raygun.configuration.affected_user_mapping
+          method = mapping[attribute]
+
+          value = if method.is_a? Proc
+                    method.call(user_object)
+                  else
+                    attributes = Array(method)
+                    attribute_to_use = attributes.select do |attr|
+                      user_object.respond_to?(attr, true)
+                    end.first
+
+                    user_object.send(attribute_to_use) unless attribute_to_use == nil
+                  end
+
+          result[NAME_TO_RAYGUN_NAME_MAPPING[attribute]] = value unless value == nil
+          result
+        end
+      end
+    end
+  end
+end

data/lib/raygun/breadcrumbs/breadcrumb.rb

@@ -1,34 +1,34 @@
-module Raygun
-  module Breadcrumbs
-    class Breadcrumb
-      ATTRIBUTES = [
-        :message, :category, :metadata, :class_name,
-        :method_name, :line_number, :timestamp, :level,
-        :type
-      ]
-      attr_accessor(*ATTRIBUTES)
-
-      def build_payload
-        payload = {
-          message: message,
-          category: category,
-          level: Breadcrumbs::BREADCRUMB_LEVELS.index(level),
-          CustomData: metadata,
-          timestamp: timestamp,
-          type: type
-        }
-
-        payload[:location] = "#{class_name}:#{method_name}" unless class_name == nil
-        payload[:location] += ":#{line_number}" if payload.has_key?(:location) && line_number != nil
-
-        Hash[payload.select do |k, v|
-          v != nil
-        end]
-      end
-
-      def size
-        return message.length + 100
-      end
-    end
-  end
-end
+module Raygun
+  module Breadcrumbs
+    class Breadcrumb
+      ATTRIBUTES = [
+        :message, :category, :metadata, :class_name,
+        :method_name, :line_number, :timestamp, :level,
+        :type
+      ]
+      attr_accessor(*ATTRIBUTES)
+
+      def build_payload
+        payload = {
+          message: message,
+          category: category,
+          level: Breadcrumbs::BREADCRUMB_LEVELS.index(level),
+          CustomData: metadata,
+          timestamp: timestamp,
+          type: type
+        }
+
+        payload[:location] = "#{class_name}:#{method_name}" unless class_name == nil
+        payload[:location] += ":#{line_number}" if payload.has_key?(:location) && line_number != nil
+
+        Hash[payload.select do |k, v|
+          v != nil
+        end]
+      end
+
+      def size
+        return message.length + 100
+      end
+    end
+  end
+end

data/lib/raygun/breadcrumbs/store.rb

@@ -1,86 +1,86 @@
-require_relative 'breadcrumb'
-
-module Raygun
-  module Breadcrumbs
-    class Store
-      def self.initialize
-        Thread.current[:breadcrumbs] ||= []
-      end
-
-      def self.clear
-        Thread.current[:breadcrumbs] = nil
-      end
-
-      def self.stored
-        Thread.current[:breadcrumbs]
-      end
-
-      def self.record(
-        message: nil,
-        category: '',
-        level: :info,
-        timestamp: Time.now.utc.to_i,
-        metadata: {},
-        class_name: nil,
-        method_name: nil,
-        line_number: nil
-      )
-        raise ArgumentError.new('missing keyword: message') if message == nil
-        crumb = Breadcrumb.new
-
-        crumb.message = message
-        crumb.category = category
-        crumb.level = level
-        crumb.metadata = metadata
-        crumb.timestamp = timestamp
-        crumb.type = 'manual'
-
-        caller = caller_locations[1]
-        crumb.class_name = class_name
-        crumb.method_name = method_name || caller.label
-        crumb.line_number = line_number || caller.lineno
-
-        Thread.current[:breadcrumbs] << crumb if should_record?(crumb)
-      end
-
-      def self.any?
-        stored != nil && stored.length > 0
-      end
-
-      def self.take_until_size(size)
-        breadcrumb_size = 0
-
-        stored.reverse.take_while do |crumb|
-          breadcrumb_size += crumb.size
-
-          breadcrumb_size < size
-        end.reverse
-      end
-
-      private
-
-      def self.should_record?(crumb)
-        if stored.nil?
-          if Raygun.configuration.debug
-            Raygun.log('[Raygun.breadcrumbs] store is uninitialized while breadcrumb is being recorded, discarding breadcrumb')
-          end
-
-          return false
-        end
-
-        levels = Raygun::Breadcrumbs::BREADCRUMB_LEVELS
-
-        active_level = levels.index(Raygun.configuration.breadcrumb_level)
-        crumb_level = levels.index(crumb.level) || -1
-
-        discard = crumb_level < active_level
-
-        if discard && Raygun.configuration.debug
-          Raygun.log("[Raygun.breadcrumbs] discarding breadcrumb because #{crumb.level} is below active breadcrumb level (#{Raygun.configuration.breadcrumb_level})")
-        end
-
-        !discard
-      end
-    end
-  end
-end
+require_relative 'breadcrumb'
+
+module Raygun
+  module Breadcrumbs
+    class Store
+      def self.initialize(with: [])
+        Thread.current[:breadcrumbs] ||= with
+      end
+
+      def self.clear
+        Thread.current[:breadcrumbs] = nil
+      end
+
+      def self.stored
+        Thread.current[:breadcrumbs]
+      end
+
+      def self.record(
+        message: nil,
+        category: '',
+        level: :info,
+        timestamp: Time.now.utc.to_i,
+        metadata: {},
+        class_name: nil,
+        method_name: nil,
+        line_number: nil
+      )
+        raise ArgumentError.new('missing keyword: message') if message == nil
+        crumb = Breadcrumb.new
+
+        crumb.message = message
+        crumb.category = category
+        crumb.level = level
+        crumb.metadata = metadata
+        crumb.timestamp = timestamp
+        crumb.type = 'manual'
+
+        caller = caller_locations[1]
+        crumb.class_name = class_name
+        crumb.method_name = method_name || caller.label
+        crumb.line_number = line_number || caller.lineno
+
+        Thread.current[:breadcrumbs] << crumb if should_record?(crumb)
+      end
+
+      def self.any?
+        stored != nil && stored.length > 0
+      end
+
+      def self.take_until_size(size)
+        breadcrumb_size = 0
+
+        stored.reverse.take_while do |crumb|
+          breadcrumb_size += crumb.size
+
+          breadcrumb_size < size
+        end.reverse
+      end
+
+      private
+
+      def self.should_record?(crumb)
+        if stored.nil?
+          if Raygun.configuration.debug
+            Raygun.log('[Raygun.breadcrumbs] store is uninitialized while breadcrumb is being recorded, discarding breadcrumb')
+          end
+
+          return false
+        end
+
+        levels = Raygun::Breadcrumbs::BREADCRUMB_LEVELS
+
+        active_level = levels.index(Raygun.configuration.breadcrumb_level)
+        crumb_level = levels.index(crumb.level) || -1
+
+        discard = crumb_level < active_level
+
+        if discard && Raygun.configuration.debug
+          Raygun.log("[Raygun.breadcrumbs] discarding breadcrumb because #{crumb.level} is below active breadcrumb level (#{Raygun.configuration.breadcrumb_level})")
+        end
+
+        !discard
+      end
+    end
+  end
+end

data/lib/raygun/breadcrumbs.rb

@@ -1,34 +1,34 @@
-module Raygun
-  module Breadcrumbs
-    BREADCRUMB_LEVELS = [
-      :debug,
-      :info,
-      :warning,
-      :error,
-      :fatal
-    ]
-
-    def record_breadcrumb(
-        message: nil,
-        category: '',
-        level: :info,
-        timestamp: Time.now.utc.to_i,
-        metadata: {},
-        class_name: nil,
-        method_name: nil,
-        line_number: nil
-    )
-      class_name = class_name || self.class.name
-      Raygun::Breadcrumbs::Store.record(
-        message: message,
-        category: category,
-        level: level,
-        timestamp: timestamp,
-        metadata: metadata,
-        class_name: class_name,
-        method_name: method_name,
-        line_number: line_number,
-      )
-    end
-  end
-end
+module Raygun
+  module Breadcrumbs
+    BREADCRUMB_LEVELS = [
+      :debug,
+      :info,
+      :warning,
+      :error,
+      :fatal
+    ]
+
+    def record_breadcrumb(
+        message: nil,
+        category: '',
+        level: :info,
+        timestamp: Time.now.utc.to_i,
+        metadata: {},
+        class_name: nil,
+        method_name: nil,
+        line_number: nil
+    )
+      class_name = class_name || self.class.name
+      Raygun::Breadcrumbs::Store.record(
+        message: message,
+        category: category,
+        level: level,
+        timestamp: timestamp,
+        metadata: metadata,
+        class_name: class_name,
+        method_name: method_name,
+        line_number: line_number,
+      )
+    end
+  end
+end