appflux_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77e511ab164ad3a86581d6b09b68bd0b5fe75620
-  data.tar.gz: 676a514a12cd9900f0ce5d2670befc3add1c1edf
+  metadata.gz: e2e783505b000e326a643061f4ca5ed87711a811
+  data.tar.gz: 784bbf15113d2dc88b0f9478df27972249631132
 SHA512:
-  metadata.gz: f547aa1849c5b58d8482742e63e17961a0256046d61121ec9cf39469ffe3f2c56b68563a28271c20d7d7d240c33ac5b24f6c79d054096b4863936f7d76a196c2
-  data.tar.gz: c99e9f750edea4f1d2ca43decb77bd2fa76698d040124cd05a48d5887173eee4970360b77ffb1ed08fedf929d9c68b7a69e3aa220f70a4c4cf2d30020d38cb80
+  metadata.gz: 841bce7a30416c02449da7a1da4404fa24eeeead44bf1d0dc44ea7f1ad24af002a9c222e06a241569d29f9d91dbac3b40c19085bfb9db5d6a8714c6b2d5fcf2b
+  data.tar.gz: 8e2a8f9cc34257eeb7b208b41ecf769d5df6cc300dcd4ed6ebb7efc77fe157ed9c4a85090dcda08302327ab72f0f2d09720ddb24290ce29fab102ee0521330c8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in appflux_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Appflux Ruby
+
+---
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/64eff633689a54b902cf/maintainability)](https://codeclimate.com/github/appflux/appflux-ruby/maintainability)
+
+
+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.
+
+## 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.
+5. Send custom diagnostic information.
+6. Nicely integrates with your 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.
+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.
+
+## 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)
+3. [@appfluxhq](https://www.twitter.com/appfluxhq)
+
+## License
+
+The Appflux ruby gem is a free software released under the MIT License. See [LICENSE.txt](https://github.com/appflux/appflux-ruby/blob/master/LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/appflux_ruby.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'appflux_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'appflux_ruby'
+  spec.version       = AppfluxRuby::VERSION
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.authors       = ['Shubham Gupta']
+  spec.email         = ['sgupta.89cse@gmail.com']
+
+  spec.summary       = 'Ruby library for integration with http://appflux.io'
+  spec.description   = <<DESC
+AppfluxRuby is a ruby library for integrating your rack based applications with
+https://appflux.io/bugflux. This gem provides a basic API for automatically and 
+manually sending exceptions metadata from your Rack based application. The
+processed exceptions data can be viewed at the error dashboard for the project
+on Appflux. For Rails applications, you can also send custom data to the error
+dashboard. It also integrates nicely with Delayed Job. Raise an issue on GitHub
+for any feature requests or bugs. For reporting security vulnerablities, please 
+send an email at sgupta.89cse@gmail.com
+DESC
+
+  spec.homepage      = 'http://appflux.io'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_dependency             'typhoeus', '>= 0.7'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  # spec.add_development_dependency 'rake'
+  # spec.add_development_dependency 'minitest', '~> 5.0'
+  # spec.add_development_dependency 'byebug', '~> 8.2'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "appflux_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/appflux_ruby/bugflux_config.rb

@@ -0,0 +1,43 @@
+##
+# This class hold all configurations related to Bugflux. Our aim is to make this
+# a generalized class that collects metrics for all the apps like: bugflux,
+# perflux etc based on the host application configuration.
+#
+# Also, it would be better to extract the notice sending logic to its own gem.
+# This is because all hook applications might not be on the same address.
+module AppfluxRuby
+  class BugfluxConfig
+    ##
+    # @return [ID] Identify the application where to send the notification.
+    # This value *must* be set.
+    attr_accessor :app_id
+
+    ##
+    # @return [Logger] the default logger used for debug output
+    # attr_accessor :logger
+
+    ##
+    # @return [String] the host, which provides the API endpoint to which
+    #   exceptions should be sent
+    attr_reader :host
+
+    def initialize config = Hash.new
+      @host = host_name
+    end
+
+    ##
+    # @return [Boolean], Whether we are using secure connection or not.
+    def use_ssl
+      false
+    end
+
+    private
+
+      # This is the URL to API that accepts notifications generated by this gem.
+      # Should be something like: /applications/<app_id>/notifications [POST]
+      def host_name
+        'http://appflux.io/exceptions'
+      end
+
+  end
+end

data/lib/appflux_ruby/bugflux_notifier.rb

@@ -0,0 +1,38 @@
+##
+# This class is specific only to sending bugflux notifications. It calls
+#  +MessageBuilder+ class for building the payload message and uses SSL to send
+#  the messages. It also implements a basic queue to send messages in batches.
+#  This is the default behaviour.
+
+require 'typhoeus'
+
+module AppfluxRuby
+  class BugfluxNotifier
+
+    class << self
+
+      def notify exception, environment = Hash.new
+        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 }"
+          end
+        end
+      end
+
+      def build_request exception, environment
+        notice = ::AppfluxRuby::MessageBuilders::Bugflux.new(exception, environment).build
+        request = ::Typhoeus::Request.new(
+          ::AppfluxRuby::Bugflux.config.host,
+          method: :post,
+          body: notice,
+          headers: { Accept: "application/json" }
+          )
+      end
+    end
+  end
+end

data/lib/appflux_ruby/delayed/plugin.rb

@@ -0,0 +1,29 @@
+module AppfluxRuby
+  module Delayed
+    class Plugin < ::Delayed::Plugin
+      callbacks do |lifecycle|
+        lifecycle.around(:invoke_job) do |job, *args, &block|
+          begin
+            block.call(job, *args)
+          rescue Exception => exception
+            ::AppfluxRuby::Bugflux.initialize_additional_data
+            params = job.as_json.merge(
+              component: 'delayed_job',
+              action: job.payload_object.class.name
+            )
+
+            # If DelayedJob is used through ActiveJob, it contains extra info.
+            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
+        end
+      end
+    end
+  end
+end
+
+# Delayed::Worker.plugins << Delayed::Plugins::AppfluxRuby

data/lib/appflux_ruby/helpers/util.rb

@@ -0,0 +1,11 @@
+module AppfluxRuby
+  module Helpers
+    class Util
+
+      def self.requires! *attr
+        
+      end
+
+    end
+  end
+end

data/lib/appflux_ruby/message_builders/base.rb

@@ -0,0 +1,23 @@
+module AppfluxRuby
+  module MessageBuilders
+    class Base
+      def initialize exception, rack_env
+        @exception = exception
+        @rack_env  = rack_env
+        @request   = ::Rack::Request.new(rack_env)
+        @session   = @request.session
+        ## TODO: Probably extract this hash into a dedicated class?
+        @notice    = Hash.new
+      end
+
+      def build
+        @notice
+      end
+
+      def self.build exception, rack_env
+        new(exception, rack_env).build
+      end
+
+    end
+  end
+end

data/lib/appflux_ruby/message_builders/bugflux.rb

@@ -0,0 +1,154 @@
+## TODO: Add Rack Env. Current User.
+##
+# This class builds payload message to send to the backyard application.
+# custom_tabs appear as individual tabs on Bugflux UI and are only set per
+#  exception occurrence.
+# TODO: This might be Rails specific. Need to check for other Rack based
+#  frameworks.
+# {
+#   bugflux: {
+#     app_id: '',
+#     env: {
+#       app_env: 'staging'
+
+#       request: {
+
+#       },
+#       params: {
+
+#       },
+#       headers: {
+
+#       },
+#       session: {
+
+#       }
+#     },
+#     exception: {
+
+#     }
+#   },
+#   custom_tabs: {
+#     tab_1: {},
+#     tab_2: {}
+#   }
+# }
+
+module AppfluxRuby
+  module MessageBuilders
+    class Bugflux < AppfluxRuby::MessageBuilders::Base
+
+      ENV_REQUEST_METHODS = %i( path host scheme user_agent port url ip
+                                content_type request_method referrer )
+      ENV_REQUEST_KEYS    = %i( SERVER_PROTOCOL SERVER_SOFTWARE )
+
+      ENV_EXCEPTION_METHODS = %i( backtrace message cause class )
+
+      SUPPORTED_BACKGROUND_JOB_PROCESSORS = %w(delayed_job)
+
+      def initialize exception, rack_env
+        super(exception, rack_env)
+
+        @notice[:bugflux] = Hash.new { |hsh, key| hsh[key] = Hash.new }
+        @bugflux_notice = @notice[:bugflux]
+      end
+
+      def build
+        super
+        add_app_id
+        add_request_data
+        add_params
+        add_exception_data
+        add_env
+        add_headers
+        add_session_data
+        add_background_job_info
+        add_custom_tabs
+
+        @notice
+      end
+
+      def self.build exception, rack_env
+        new(exception, rack_env).build
+      end
+
+      private
+
+        def add_request_data
+          @bugflux_notice[:env][:request] = Hash.new
+          _req_hash = @bugflux_notice[:env][:request]
+
+          ENV_REQUEST_METHODS.each do |_method|
+            _req_hash[_method.to_sym] = @request.public_send(_method)
+          end
+
+          ENV_REQUEST_KEYS.each do |_key|
+            _req_hash[_key.to_sym] = @request.env[_key.to_s]
+          end
+        end
+
+        def add_exception_data
+          ENV_EXCEPTION_METHODS.each do |_method|
+            @bugflux_notice[:exception][_method.to_sym] = @exception.public_send(_method)
+          end
+        end
+
+        def add_session_data
+          load_session
+          return unless session_loaded?
+
+          @bugflux_notice[:env][:session]= @request.env['rack.request.cookie_hash']
+        end
+
+        def add_headers
+          @bugflux_notice[:env][:headers] = Hash.new
+
+          @rack_env.keys.grep(/^HTTP_/).each do |_key|
+            @bugflux_notice[:env][:headers][_key] = @rack_env[_key]
+          end
+
+          @bugflux_notice[:env][:headers].delete('HTTP_COOKIE')
+        end
+
+        def add_params
+          @bugflux_notice[:env][:params] = @request.env['action_dispatch.request.parameters']
+        end
+
+        def add_app_id
+          @bugflux_notice[:app_id] = ::AppfluxRuby::Bugflux.config.app_id
+        end
+
+        def add_env
+          @bugflux_notice[:env][:app_env] = ::Rails.env if defined?(::Rails)
+        end
+
+        def add_custom_tabs
+          @bugflux_notice[:custom_tabs] ||= Hash.new
+          @bugflux_notice[:custom_tabs].merge!(::AppfluxRuby::Bugflux.additional_data)
+        end
+
+        ## 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 = "::AppfluxRuby::MessageBuilders::#{ builder_klass_string }".constantize
+
+            @bugflux_notice[:custom_tabs] ||= Hash.new
+            @bugflux_notice[:custom_tabs]["#{@rack_env[:component]}".to_sym] = builder_klass.to_hash(@rack_env)
+          end
+        end
+
+        private
+
+          def load_session
+            unless session_loaded?
+              @session['___bugflux_dummy_key___'] ||= 'bugflux'
+            end
+          end
+
+          def session_loaded?
+            @session.respond_to?(:loaded?) ? @session.loaded? : true
+          end
+    end
+  end
+end

data/lib/appflux_ruby/message_builders/custom_message.rb

@@ -0,0 +1,24 @@
+# {
+#   custom_tabs:{
+#     tab_1: {
+
+#     },
+#     tab_2: {
+
+#     }
+#   }
+# }
+module AppfluxRuby
+  module MessageBuilders
+    class CustomMessage
+      def initialize
+        @custom_tabs = Array.new
+      end
+
+      def add_tab(tab_name, options_data = {})
+        # @custom_tabs << { "#{ tab_name }": options_data }
+        ::AppfluxRuby::Bugflux.additional_data[tab_name] = options_data
+      end
+    end
+  end
+end

data/lib/appflux_ruby/message_builders/delayed_job.rb

@@ -0,0 +1,26 @@
+module AppfluxRuby
+  module MessageBuilders
+    class DelayedJob
+
+      def initialize options
+        @options = options
+      end
+
+      def to_hash
+        _handler_object = YAML.load(@options['handler'])
+        @options[:dj_handler] = _handler_object.inspect
+        @options[:object] = _handler_object.object.inspect
+
+        @options[:method_name] = _handler_object.method_name
+        @options[:method_arguments] = _handler_object.args
+        @options[:display_name] = _handler_object.display_name
+
+        @options
+      end
+
+      def self.to_hash options
+        new(options).to_hash
+      end
+    end
+  end
+end

data/lib/appflux_ruby/rack/middleware.rb

@@ -0,0 +1,23 @@
+module AppfluxRuby
+  module Rack
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      ##
+      # Intercepts exception and sends notification to API.
+      def call(env)
+        begin
+          AppfluxRuby::Bugflux.initialize_additional_data
+          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
+      end
+    end
+  end
+end

data/lib/appflux_ruby/rails/active_record.rb

@@ -0,0 +1,37 @@
+module AppfluxRuby
+  module Rails
+    ##
+    # ActiveRecord < 4.2 has a bug with regard to swallowing exceptions in the
+    # +after_commit+ and the +after_rollback+ hooks: it doesn't bubble up
+    # exceptions from there.
+    #
+    # This module makes it possible to report exceptions occurring there.
+    #
+    # @see https://github.com/rails/rails/pull/14488 Detailed description of the
+    #   bug and the fix
+    module ActiveRecord
+      ##
+      # @return [Array<Symbol>] the hooks that needs fixing
+      KINDS = [:commit, :rollback].freeze
+
+      ##
+      # Patches default +run_callbacks+, which is capable of notifying about
+      #  exceptions.
+      def run_callbacks(kind, *args, &block)
+        # Let the post process handle the exception if it's not a bugged hook.
+        return super unless KINDS.include?(kind)
+
+        # Handle the exception ourselves. The 'ex' exception won't be
+        # propagated, therefore we must notify it here.
+        begin
+          super
+        rescue Exception => ex
+          # TODO: Need to replace with Logger.
+          puts 'Sending exception notification to bugflux.'
+          ::AppfluxRuby::BugfluxNotifier.notify(ex)
+          raise ex
+        end
+      end
+    end
+  end
+end

data/lib/appflux_ruby/rails/controller_methods.rb

@@ -0,0 +1,56 @@
+module AppfluxRuby
+  module Rails
+    module ControllerMethods
+      def self.included(base)
+        base.extend ClassMethods
+        base.include InstanceMethods
+        base.before_bugflux_notify :__send_user_info_to_bugflux__
+      end
+
+      module ClassMethods
+        def before_bugflux_notify(*methods)
+          run_bugflux_callbacks(methods) do
+
+          end
+        end
+
+        private
+
+          def run_bugflux_callbacks(__methods)
+            filtered_methods = __methods.last.is_a?(::Hash) ? __methods.pop : {}
+
+            @@custom_message = AppfluxRuby::MessageBuilders::CustomMessage.new
+
+            if respond_to?(:before_action)
+              before_action filtered_methods do |controller|
+                __methods.each do |_method|
+                  controller.send(_method, @@custom_message)
+                end
+              end
+            else
+              before_filter filtered_methods do |controller|
+                __methods.each do |_method|
+                  controller.send(_method, @@custom_message)
+                end
+              end
+            end
+            
+          end
+
+      end
+
+      module InstanceMethods
+        private
+          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
+                }
+              )
+            end
+          end
+      end
+    end
+  end
+end

data/lib/appflux_ruby/rails/railtie.rb

@@ -0,0 +1,25 @@
+module AppfluxRuby
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer('appflux_ruby.middleware') do |app|
+        if ::Rails.version =~ /\A5\./
+          app.config.middleware.insert_after(
+            ActionDispatch::DebugExceptions, AppfluxRuby::Rack::Middleware
+          )
+        else
+          app.config.middleware.insert_after(
+            ActionDispatch::DebugExceptions, 'AppfluxRuby::Rack::Middleware'
+          )
+        end
+      end
+
+      initializer('appflux_ruby.active_record') do
+        ActiveSupport.on_load(:active_record) do
+          require 'appflux_ruby/rails/active_record'
+          include AppfluxRuby::Rails::ActiveRecord
+        end
+      end
+
+    end
+  end
+end

data/lib/appflux_ruby/version.rb

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

data/lib/appflux_ruby.rb

@@ -0,0 +1,39 @@
+require_relative 'appflux_ruby/version'
+require_relative 'appflux_ruby/bugflux_config'
+require_relative 'appflux_ruby/bugflux_notifier'
+require_relative 'appflux_ruby/message_builders/base'
+require_relative 'appflux_ruby/message_builders/bugflux'
+require_relative 'appflux_ruby/message_builders/custom_message'
+require_relative 'appflux_ruby/helpers/util'
+
+if defined?(::Rack)
+  require_relative 'appflux_ruby/rack/middleware'
+
+  if defined?(::Rails)
+    require_relative 'appflux_ruby/rails/railtie'
+    require_relative 'appflux_ruby/rails/controller_methods'
+  end
+end
+
+## Requires library specific files in generators. See: generators/appflux_ruby/install_generator.
+## This is important to handle if appflux_ruby is present in Gemfile before Delayed Job.
+
+module AppfluxRuby
+  class Bugflux
+    class << self
+      attr_accessor :config
+      attr_accessor :additional_data
+    end
+
+    def self.configure &blk
+      self.config = AppfluxRuby::BugfluxConfig.new
+      yield self.config
+    end
+
+    ## These methods are used to set per-request custom data.
+    def self.initialize_additional_data
+      @additional_data = Hash.new
+    end
+
+  end
+end

data/lib/generators/appflux_ruby/bugflux.rb

@@ -0,0 +1,10 @@
+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

data/lib/generators/appflux_ruby/install_generator.rb

@@ -0,0 +1,10 @@
+module AppfluxRuby
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../", __FILE__)
+
+    def create_bugflux_initializer
+      copy_file 'bugflux.rb', 'config/initializers/bugflux.rb'
+    end
+
+  end
+end

data/test/appflux-ruby_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class AppfluxRubyTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::AppfluxRuby::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'appflux_ruby'
+
+require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appflux_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shubham Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2018-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -51,7 +51,35 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appflux_ruby.gemspec
+- bin/console
+- bin/setup
+- lib/appflux_ruby.rb
+- lib/appflux_ruby/bugflux_config.rb
+- lib/appflux_ruby/bugflux_notifier.rb
+- lib/appflux_ruby/delayed/plugin.rb
+- lib/appflux_ruby/helpers/util.rb
+- lib/appflux_ruby/message_builders/base.rb
+- 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/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/version.rb
+- lib/generators/appflux_ruby/bugflux.rb
+- lib/generators/appflux_ruby/install_generator.rb
+- test/appflux-ruby_test.rb
+- test/test_helper.rb
 homepage: http://appflux.io
 licenses:
 - MIT
@@ -76,4 +104,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby library for integration with http://appflux.io
-test_files: []
+test_files:
+- test/appflux-ruby_test.rb
+- test/test_helper.rb