appflux_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e2e783505b000e326a643061f4ca5ed87711a811
-  data.tar.gz: 784bbf15113d2dc88b0f9478df27972249631132
+SHA256:
+  metadata.gz: 364f9ef0534d86572819348b1df7161b73bfa30f78f0e5e6dde105cf1e33f6b8
+  data.tar.gz: 8e12d5ab4484b714d3734efd8a8877466679dc48d3d975016aaec20afc5849ab
 SHA512:
-  metadata.gz: 841bce7a30416c02449da7a1da4404fa24eeeead44bf1d0dc44ea7f1ad24af002a9c222e06a241569d29f9d91dbac3b40c19085bfb9db5d6a8714c6b2d5fcf2b
-  data.tar.gz: 8e2a8f9cc34257eeb7b208b41ecf769d5df6cc300dcd4ed6ebb7efc77fe157ed9c4a85090dcda08302327ab72f0f2d09720ddb24290ce29fab102ee0521330c8
+  metadata.gz: da9f36f9cba80d190ba7c36f00fd1c68eddd8df1cd21c8b01ca4837e16ec59e87f0d33357928a89d92d950260ff58aa0fe3a85ecd939aaff9fc8cbc17b6aa7e0
+  data.tar.gz: 10c9f6eb057f2559aa2ccd2873dcbc42342a524c49ed3d3b7fb882505558b9c171dda22b9cd2d3382e62851dc59c620e046352d9a7a917120bbe473c4a41eace

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Shubham Gupta
+Copyright (c) 2019 Shubham Gupta
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,43 +1,41 @@
 # Appflux Ruby
-
 ---
+[![Maintainability](https://api.codeclimate.com/v1/badges/64eff633689a54b902cf/maintainability)](https://codeclimate.com/github/appflux/appflux-ruby/maintainability) [![Gem Version](https://badge.fury.io/rb/appflux_ruby.svg)](https://badge.fury.io/rb/appflux_ruby)
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/64eff633689a54b902cf/maintainability)](https://codeclimate.com/github/appflux/appflux-ruby/maintainability)
-
+Appflux is an exception notification library for Rack/Rails application. It is extremely lightweight, easy to setup and always free. Signup on appflux.io, create a project and find your keys to setup your application. The exceptions are delivered to your email as well as can be seen on the dashboard. Appflux also offers a simple and classic messaging platform.
 
-The appflux-ruby gem sends notifications when an exception occurs in your Rack/Rails application. The community edition integrates nicely with your appflux.io dashboard. We also offer an enterprise version that also offers a project communication platform.
+## Why do we need another exception notification library?
+1. While [exception_notification](https://github.com/smartinez87/exception_notification) is a good open source library, it is really painful to setup. The notification messages are very verbose and often spam the inbox. And... it does not come with a GUI. Appflux offers a decent simplistic dashboard that most open source solutions lack.
+2. There are a lot of very good commercial exception notification softwares out there. But they are more focussed on managers, not developers.
 
-## Features
+## Some Features
 1. Automatically reports unhandled exceptions.
 2. Reports handled exceptions.
 3. Automagically supports Delayed Job and Sidekiq.
-4. Figures out common information used to debug a Rails application.
+4. Figures out common information (from commonly used gems) used to debug a Rails application.
 5. Send custom diagnostic information.
-6. Nicely integrates with your Appflux.io dashboard.
-
+6. Nicely integrates with Appflux.io dashboard.
 
 ## Requirements
 1. Ruby 1.9.3 or greater
 2. Rails 3.0 or greater, Grape, Sinatra or any other Rack application.
 
-
 ## Setup
-> Appflux is free. Basic error monitoring will always remain free.
+> If you have more than one project, you should first create an organization.
 1. Sign up on appflux.io.
 2. Confirm your account and create a project.
 3. Follow the instructions on the setup page.
 
 ## What's more ?
 Appflux offers an integrated platform to monitor, analyze and discuss your ruby application. You can:
-1. Get notified of exceptions in real-time.
-2. Post messages and discuss issues with other collaborators.
-3. Maintain all project related files in one location.
+1. Get notified of exceptions.
+2. Post messages and discuss issues with other collaborators and clients.
+3. Keeps all project related files.
 
 ## What's cookin' ?
 1. Support for out-of-the-box user behavior analysis for Rails applications.
 2. Cohort analysis for Rails applications.
 
-
 ## Help
 1. hi@appflux.io
 2. [@_guptashubham](https://twitter.com/_guptashubham)

data/lib/appflux_ruby/bugflux_config.rb

@@ -10,7 +10,7 @@ module AppfluxRuby
     ##
     # @return [ID] Identify the application where to send the notification.
     # This value *must* be set.
-    attr_accessor :app_id
+    attr_accessor :app_id, :ignored_environments
 
     ##
     # @return [Logger] the default logger used for debug output

data/lib/appflux_ruby/bugflux_notifier.rb

@@ -12,19 +12,24 @@ module AppfluxRuby
     class << self
 
       def notify exception, environment = Hash.new
-        request = build_request(exception, environment)
-        response = request.run
+        if should_report_exception?
+          ::Rails.logger.info('Notifying Appflux of this exception.')
+          request = build_request(exception, environment)
+          response = request.run
 
-        unless response.code == 200
-          if defined?(::Rails)
-            ::Rails.logger.fatal("[Bugflux-Failed] Failed to notify Bugflux, please check with your configuration in config/initializers/bugflux.rb. Error Code: #{ response.code }")
-          else
-            puts "[Bugflux-Failed] Failed to notify Bugflux, please check with your configuration in config/initializers/bugflux.rb. Error Code: #{ response.code }"
+          unless response.code == 200
+            if defined?(::Rails)
+              ::Rails.logger.fatal("[Appflux-Failed] Failed to notify Appflux, please check with your configuration in config/initializers/appflux.rb. Error Code: #{ response.code }")
+            else
+              puts "[Appflux-Failed] Failed to notify Appflux, please check with your configuration in config/initializers/appflux.rb. Error Code: #{ response.code }"
+            end
           end
+        else
+          ::Rails.logger.info("[Appflux] Skipping to notify Appflux for #{ ::Rails.env } environment.")
         end
       end
 
-      def build_request exception, environment
+      private def build_request exception, environment
         notice = ::AppfluxRuby::MessageBuilders::Bugflux.new(exception, environment).build
         request = ::Typhoeus::Request.new(
           ::AppfluxRuby::Bugflux.config.host,
@@ -33,6 +38,10 @@ module AppfluxRuby
           headers: { Accept: "application/json" }
           )
       end
+
+      private def should_report_exception?
+        !AppfluxRuby::Bugflux.config.ignored_environments.include?(::Rails.env)
+      end
     end
   end
 end

data/lib/appflux_ruby/delayed/plugin.rb

@@ -16,7 +16,6 @@ module AppfluxRuby
             if job.payload_object.respond_to?(:job_data)
               params[:active_job] = job.payload_object.job_data
             end
-            puts 'Sending exception notification to bugflux.'
             ::AppfluxRuby::BugfluxNotifier.notify(exception, params)
             raise exception
           end

data/lib/appflux_ruby/message_builders/bugflux.rb

@@ -44,7 +44,7 @@ module AppfluxRuby
 
       ENV_EXCEPTION_METHODS = %i( backtrace message cause class )
 
-      SUPPORTED_BACKGROUND_JOB_PROCESSORS = %w(delayed_job)
+      SUPPORTED_BACKGROUND_JOB_PROCESSORS = %w(delayed_job sidekiq)
 
       def initialize exception, rack_env
         super(exception, rack_env)
@@ -130,7 +130,7 @@ module AppfluxRuby
         ## Adds background processor information as a dedicated tab on the UI.
         def add_background_job_info
           if @rack_env[:component].in?(SUPPORTED_BACKGROUND_JOB_PROCESSORS)
-            builder_klass_string = @rack_env[:component].classify#.constantize
+            builder_klass_string = @rack_env[:component].classify
             builder_klass = "::AppfluxRuby::MessageBuilders::#{ builder_klass_string }".constantize
 
             @bugflux_notice[:custom_tabs] ||= Hash.new

data/lib/appflux_ruby/message_builders/sidekiq.rb

@@ -0,0 +1,18 @@
+module AppfluxRuby
+  module MessageBuilders
+    class Sidekiq
+
+      def initialize options
+        @options = options
+      end
+
+      def to_hash
+        @options
+      end
+
+      def self.to_hash options
+        new(options).to_hash
+      end
+    end
+  end
+end

data/lib/appflux_ruby/rack/middleware.rb

@@ -13,7 +13,6 @@ module AppfluxRuby
           response = @app.call(env)
         rescue Exception => ex
           # TODO: Need to figure out a logger implementation.
-          puts 'Sending exception notification to bugflux.'
           ::AppfluxRuby::BugfluxNotifier.notify(ex, env)
           raise ex
         end

data/lib/appflux_ruby/rails/active_record.rb

@@ -27,7 +27,6 @@ module AppfluxRuby
           super
         rescue Exception => ex
           # TODO: Need to replace with Logger.
-          puts 'Sending exception notification to bugflux.'
           ::AppfluxRuby::BugfluxNotifier.notify(ex)
           raise ex
         end

data/lib/appflux_ruby/rails/controller_methods.rb

@@ -10,7 +10,6 @@ module AppfluxRuby
       module ClassMethods
         def before_bugflux_notify(*methods)
           run_bugflux_callbacks(methods) do
-
           end
         end
 
@@ -34,9 +33,7 @@ module AppfluxRuby
                 end
               end
             end
-            
           end
-
       end
 
       module InstanceMethods
@@ -44,8 +41,11 @@ module AppfluxRuby
           def __send_user_info_to_bugflux__ notifier_object
             if respond_to?(:current_user) && current_user
               notifier_object.add_tab('User',
-                { 'Current User Id': current_user.id,
-                  'User Attributes': current_user.inspect
+                {
+                  id: current_user.id,
+                  type: current_user.class.name,
+                  name: current_user.try(:name),
+                  email: current_user.try(:email)
                 }
               )
             end

data/lib/appflux_ruby/sidekiq/error_handler.rb

@@ -0,0 +1,21 @@
+module AppfluxRuby
+  module Sidekiq
+    class ErrorHandler
+      def call(_worker, context, _queue)
+        yield
+      rescue Exception => exception
+        ::AppfluxRuby::Bugflux.initialize_additional_data
+          params = {
+            component: 'sidekiq',
+            args: context['args'],
+            queue: context['queue'],
+            message: context['error_message'],
+            options: context.except('args', 'queue', 'error_message')
+          }
+
+          ::AppfluxRuby::BugfluxNotifier.notify(exception, params)
+          raise exception
+      end
+    end
+  end
+end

data/lib/appflux_ruby/version.rb

@@ -1,3 +1,3 @@
 module AppfluxRuby
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/generators/appflux_ruby/appflux.rb

@@ -0,0 +1,23 @@
+AppfluxRuby::Bugflux.configure do |config|
+  config.app_id = '<your-app-id>'
+  config.ignored_environments = %w( test development )
+end
+
+if defined?(::Delayed)
+  require 'appflux_ruby/delayed/plugin'
+  require 'appflux_ruby/message_builders/delayed_job'
+
+  Delayed::Worker.plugins << ::AppfluxRuby::Delayed::Plugin
+end
+
+if defined?(::Sidekiq)
+  require 'appflux_ruby/sidekiq/error_handler'
+  require 'appflux_ruby/message_builders/sidekiq'
+
+  Sidekiq.configure_server do |config|
+    config.server_middleware do |chain|
+      chain.add(AppfluxRuby::Sidekiq::ErrorHandler)
+    end
+  end
+
+end

data/lib/generators/appflux_ruby/install_generator.rb

@@ -3,7 +3,7 @@ module AppfluxRuby
     source_root File.expand_path("../", __FILE__)
 
     def create_bugflux_initializer
-      copy_file 'bugflux.rb', 'config/initializers/bugflux.rb'
+      copy_file 'appflux.rb', 'config/initializers/appflux.rb'
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appflux_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Shubham Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -71,12 +71,14 @@ files:
 - lib/appflux_ruby/message_builders/bugflux.rb
 - lib/appflux_ruby/message_builders/custom_message.rb
 - lib/appflux_ruby/message_builders/delayed_job.rb
+- lib/appflux_ruby/message_builders/sidekiq.rb
 - lib/appflux_ruby/rack/middleware.rb
 - lib/appflux_ruby/rails/active_record.rb
 - lib/appflux_ruby/rails/controller_methods.rb
 - lib/appflux_ruby/rails/railtie.rb
+- lib/appflux_ruby/sidekiq/error_handler.rb
 - lib/appflux_ruby/version.rb
-- lib/generators/appflux_ruby/bugflux.rb
+- lib/generators/appflux_ruby/appflux.rb
 - lib/generators/appflux_ruby/install_generator.rb
 - test/appflux-ruby_test.rb
 - test/test_helper.rb
@@ -99,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby library for integration with http://appflux.io

data/lib/generators/appflux_ruby/bugflux.rb

@@ -1,10 +0,0 @@
-AppfluxRuby::Bugflux.configure do |config|
-  config.app_id = '<your-app-id>'
-end
-
-if defined?(::Delayed)
-  require 'appflux_ruby/delayed/plugin'
-  require 'appflux_ruby/message_builders/delayed_job'
-
-  Delayed::Worker.plugins << ::AppfluxRuby::Delayed::Plugin
-end