asana_exception_notifier 0.0.1

data/Rakefile

@@ -0,0 +1,37 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+require 'yard'
+Coveralls::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  default_options = ['--colour']
+  default_options.concat(['--backtrace', '--fail-fast']) if ENV['DEBUG']
+  spec.rspec_opts = default_options
+end
+
+YARD::Config.options[:load_plugins] = true
+YARD::Config.load_plugins
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'spec/**/*_spec.rb'] # optional
+  t.options = ['--any', '--extra', '--opts', '--markup-provider=redcarpet', '--markup=markdown', '--debug'] # optional
+  t.stats_options = ['--list-undoc'] # optional
+end
+
+desc 'Default: run the unit tests.'
+task default: [:all]
+
+desc 'Test the plugin under all supported Rails versions.'
+task :all do |_t|
+  if ENV['TRAVIS']
+    exec('bundle exec rake  spec && bundle exec rake coveralls:push')
+  else
+    exec('bundle exec rake spec')
+  end
+end
+
+task :docs do
+  exec('bundle exec inch --pedantic && bundle exec yard --list-undoc')
+end

data/asana_exception_notifier.gemspec

@@ -0,0 +1,48 @@
+require File.expand_path('../lib/asana_exception_notifier/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'asana_exception_notifier'
+  s.version = AsanaExceptionNotifier.gem_version
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Simple ruby implementation to send notifications to Asana
+    when a exception happens in Rails or Rack-based apps by creating a task and uploading exception details to the task'
+  s.email = 'raoul_ice@yahoo.com'
+  s.homepage = 'http://github.com/bogdanRada/asana_exception_notifier'
+  s.description = 'Simple ruby implementation to send notifications to Asana
+      when a exception happens in Rails or Rack-based apps by creating a task and uploading exception details to the task using zip archives'
+  s.authors = ['bogdanRada']
+  s.date = Date.today
+
+  s.licenses = ['MIT']
+  s.files = `git ls-files`.split("\n")
+  s.test_files = s.files.grep(/^(spec)/)
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.0'
+  s.required_rubygems_version = '>= 2.5'
+  s.metadata = {
+    'source_code' => s.homepage,
+    'bug_tracker' => "#{s.homepage}/issues"
+  }
+
+  s.add_runtime_dependency 'activesupport', '>= 4.0', '< 5'
+  s.add_runtime_dependency 'em-http-request', '~> 1.1', '>= 1.1.2'
+  s.add_runtime_dependency 'eventmachine', '~> 1.0', '>= 1.0.7'
+  s.add_runtime_dependency 'exception_notification', '~> 4.1', '>= 4.1.4'
+  s.add_runtime_dependency 'multipart_body', '~> 0.2', '>= 0.2.1'
+  s.add_runtime_dependency 'tilt', '>= 1.4', '< 3'
+  s.add_runtime_dependency 'rack', '~> 1.6', '>= 1.6'
+  s.add_runtime_dependency 'rubyzip', '~> 1.0',  '>= 1.0.0' # will load new rubyzip version
+  s.add_runtime_dependency 'zip-zip', '~> 0.3', '>= 0.3' # will load compatibility for old rubyzip API
+  s.add_runtime_dependency 'sys-uname', '~> 1.0', '>= 1.0.2'
+
+  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4'
+  s.add_development_dependency 'simplecov', '~> 0.10', '>= 0.10'
+  s.add_development_dependency 'simplecov-summary', '~> 0.0.4', '>= 0.0.4'
+  s.add_development_dependency 'coveralls', '~> 0.7', '>= 0.7'
+  s.add_development_dependency 'rake', '~> 10.5', '>= 10.5'
+  s.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7'
+  s.add_development_dependency 'redcarpet', '~> 3.3', '>= 3.3'
+  s.add_development_dependency 'github-markup', '~> 1.3', '>= 1.3.3'
+  s.add_development_dependency 'inch', '~> 0.6', '>= 0.6'
+end

data/examples/sinatra/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "asana_exception_notifier", path: "../../"
+
+gem "thin", "~> 1.5.1"
+gem "sinatra", "~> 1.4"
+gem "foreman"

data/examples/sinatra/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: ../../
+  specs:
+    asana_exception_notifier (0.0.1)
+      activesupport (>= 4.0, < 5)
+      em-http-request (~> 1.1, >= 1.1.2)
+      eventmachine (~> 1.0, >= 1.0.7)
+      exception_notification (~> 4.1, >= 4.1.4)
+      multipart_body (~> 0.2, >= 0.2.1)
+      rack (~> 1.6, >= 1.6)
+      rubyzip (~> 1.0, >= 1.0.0)
+      sys-uname (~> 1.0, >= 1.0.2)
+      tilt (>= 1.4, < 3)
+      zip-zip (~> 0.3, >= 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5.1)
+      actionview (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      globalid (>= 0.3.0)
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    cookiejar (0.3.0)
+    daemons (1.2.3)
+    em-http-request (1.1.3)
+      addressable (>= 2.3.4)
+      cookiejar (<= 0.3.0)
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0)
+    em-socksify (0.3.1)
+      eventmachine (>= 1.0.0.beta.4)
+    erubis (2.7.0)
+    eventmachine (1.0.9.1)
+    exception_notification (4.1.4)
+      actionmailer (~> 4.0)
+      activesupport (~> 4.0)
+    ffi (1.9.10)
+    foreman (0.78.0)
+      thor (~> 0.19.1)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    http_parser.rb (0.6.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.99)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    multipart_body (0.2.1)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rubyzip (1.1.7)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sys-uname (1.0.2)
+      ffi (>= 1.0.0)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    zip-zip (0.3)
+      rubyzip (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  asana_exception_notifier!
+  foreman
+  sinatra (~> 1.4)
+  thin (~> 1.5.1)
+
+BUNDLED WITH
+   1.11.2

data/examples/sinatra/Procfile

@@ -0,0 +1 @@
+web: bundle exec thin start --port 3000

data/examples/sinatra/README.md

@@ -0,0 +1,14 @@
+Using Exception Notification with Sinatra
+=========================================
+
+Quick start
+-----------
+
+```
+git clone git@github.com:bogdanRada/asana_exception_notifier.git
+cd exception_notification/examples/sinatra
+bundle install
+bundle exec foreman start
+```
+
+The last command starts the sinatra app itself. Thus, visit [http://localhost:1080/](http://localhost:1080/) to check the asana notification is sent and, in a separated tab, visit [Asana.com](http://asana.com) and cause some errors. For more info, use the [source](https://github.com/bogdanRada/asana_exception_notifier/blob/master/examples/sinatra/sinatra_app.rb).

data/examples/sinatra/config.ru

@@ -0,0 +1,3 @@
+require ::File.expand_path('../sinatra_app',  __FILE__)
+
+run SinatraApp

data/examples/sinatra/sinatra_app.rb

@@ -0,0 +1,46 @@
+$stdout.sync = true
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+ENV['RACK_ENV'] ||= ENV['RAILS_ENV'].present? ? ENV['RAILS_ENV'] : 'development'
+Bundler.require :default, (ENV['RACK_ENV'] || 'development').to_sym
+
+
+class SinatraApp < Sinatra::Base
+  use Rack::Config do |env|
+    env["action_dispatch.parameter_filter"] = [:password] # This is highly recommended.  It will prevent the ExceptionNotification email from including your users' passwords
+  end
+
+  use ExceptionNotification::Rack,
+    :asana => {
+      asana_api_key: ENV['ASANA_API_KEY'],
+      workspace: ENV['ASANA_WORKSPACE_ID'],
+      assignee: 'me',
+      assignee_status: 'today', # 'today'
+      due_at:  Time.now.iso8601,
+      due_on: nil,
+      hearted: false,
+      hearts: [],
+      projects: [],
+      followers: [],
+      memberships: [],
+      tags: [],
+      name: nil,
+      notes: '',
+      template_path: nil
+    }
+
+  get '/' do
+    raise StandardError, "ERROR: #{params[:error]}" unless params[:error].blank?
+    'Everything is fine! Now, lets break things clicking <a href="/?error=ops"> here </a>. Dont forget to see the asana tasks at <a href="http://asana.com">Asana</a> !'
+  end
+
+  get '/background_notification' do
+    begin
+      1/0
+    rescue Exception => e
+      ExceptionNotifier.notify_exception(e, :data => {:msg => "Cannot divide by zero!"})
+    end
+    'Check notification at <a href="http://asana.com">Asana</a>.'
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'asana_exception_notifier'

data/lib/asana_exception_notifier/classes/asana.rb

@@ -0,0 +1,95 @@
+require_relative '../helpers/application_helper'
+require_relative '../request/client'
+require_relative '../request/middleware'
+# class used for connecting to github api and retrieves information about repository
+#
+# @!attribute callback
+#   @return [Proc] The callback that is executed after the info is fetched from Github API
+module ExceptionNotifier
+  # module that is used for formatting numbers using metrics
+  class AsanaNotifier < ExceptionNotifier::BaseNotifier
+    include AsanaExceptionNotifier::ApplicationHelper
+    # the base url to which the API will connect for fetching information about gems
+    attr_reader :initial_options, :default_options
+
+    def initialize(options)
+      execute_with_rescue do
+        super
+        @initial_options = options.symbolize_keys
+        options = @initial_options.reject { |_key, value| value.blank? }
+        parse_options(options)
+      end
+    end
+
+    def call(exception, options = {})
+      execute_with_rescue do
+        ensure_eventmachine_running do
+          EM::HttpRequest.use AsanaExceptionNotifier::Request::Middleware if ENV['DEBUG_ASANA_EXCEPTION_NOTIFIER']
+          error_page = AsanaExceptionNotifier::ErrorPage.new(template_path, exception, options)
+          create_asana_task(error_page) if active?
+        end
+      end
+    end
+
+    def active?
+      @default_options.fetch(:asana_api_key, nil).present? && @default_options.fetch(:workspace, nil).present?
+    end
+
+  private
+
+    def parse_options(options)
+      options = options.symbolize_keys.reject { |key, _value| !permitted_options.key?(key) }
+      @default_options = permitted_options.merge(options).reject { |_key, value| value.blank? }
+    end
+
+    def template_path
+      template_path = @default_options.fetch(:template_path, nil)
+      template_path.blank? ? default_template_path : template_path_exist(File.expand_path(template_path))
+    end
+
+    def build_request_options(error_page)
+      @default_options.except(:asana_api_key, :template_path).merge(
+        name: @default_options.fetch(:name, nil) || "[AsanaExceptionNotifier] #{error_page.exception_data[:message]}",
+        notes:  @default_options.fetch(:notes, nil) || error_page.render_template(File.join(template_dir, 'asana_exception_notifier.text.erb')),
+        workspace: @default_options.fetch(:workspace, nil).to_i
+      ).symbolize_keys!
+    end
+
+    # This method fetches data from Github api and returns the size in
+    #
+    # @return [void]
+    def create_asana_task(error_page)
+      AsanaExceptionNotifier::Request::Client.new(@default_options.fetch(:asana_api_key, nil),
+                                                  'https://app.asana.com/api/1.0/tasks',
+                                                  'http_method' => 'post',
+                                                  'em_request' => { body: build_request_options(error_page) },
+                                                  'action' => 'creation'
+                                                 ) do |http_response|
+        ensure_eventmachine_running do
+          upload_log_file_to_task(error_page, http_response.fetch('data', {}))
+        end
+      end
+    end
+
+    def upload_log_file_to_task(error_page, task_data)
+      archives = error_page.fetch_archives
+      archives.each do |zip|
+        upload_archive(zip, task_data)
+      end
+    end
+
+    def upload_archive(zip, task_data)
+      return if task_data.blank?
+      body = multipart_file_upload_details(zip)
+      AsanaExceptionNotifier::Request::Client.new(@default_options.fetch(:asana_api_key, nil),
+                                                  "https://app.asana.com/api/1.0/tasks/#{task_data['id']}/attachments",
+                                                  'http_method' => 'post',
+                                                  'em_request' => body,
+                                                  'request_name' => zip,
+                                                  'action' => 'upload'
+                                                 ) do |_http_response|
+        FileUtils.rm_rf([zip])
+      end
+    end
+  end
+end

data/lib/asana_exception_notifier/classes/error_page.rb

@@ -0,0 +1,134 @@
+require_relative '../helpers/application_helper'
+module AsanaExceptionNotifier
+  # class used for rendering the template for exception
+  class ErrorPage
+    include AsanaExceptionNotifier::ApplicationHelper
+
+    attr_reader :template_path, :exception, :options, :boundary, :template_details, :env, :request, :tempfile, :template_params, :content
+
+    def initialize(template_path, exception, options)
+      @template_path = template_path
+      @exception = exception
+      @options = options.symbolize_keys
+      @template_details = setup_template_details
+      @env = (@options[:env] || ENV.to_h).stringify_keys
+      @request = action_dispatch? ? ActionDispatch::Request.new(@env) : Rack::Request.new(@env)
+      @timestamp = Time.now
+      parse_exception_options
+    end
+
+    def action_dispatch?
+      defined?(ActionDispatch::Request)
+    end
+
+    def setup_template_details
+      template_extension = @template_path.scan(/\.(\w+)\.?(.*)?/)[0][0]
+      get_extension_and_name_from_file(@template_path).merge(
+        template_extension: template_extension
+      )
+    end
+
+    def parse_exception_options
+      @template_params ||= {
+        server:  Socket.gethostname,
+        exception: @exception,
+        request: @request,
+        environment: action_dispatch? ? @request.filtered_env : @env,
+        rails_root: defined?(Rails) ? Rails.root : nil,
+        process: $PROCESS_ID,
+        data: (@env.blank? ? {} : @env.fetch(:'exception_notifier.exception_data', {})).merge(@options[:data] || {}),
+        exception_data: exception_data,
+        request_data: setup_env_params,
+        uname: Sys::Uname.uname,
+        timestamp: @timestamp,
+        pwd:  File.expand_path($PROGRAM_NAME)
+      }.merge(@options).reject { |_key, value| value.blank? }
+    end
+
+    def exception_data
+      {
+        error_class: @exception.class.to_s,
+        message:  @exception.respond_to?(:message) ? @exception.message : exception.inspect,
+        backtrace: @exception.respond_to?(:backtrace) ? @exception.backtrace : '',
+        cause: @exception.respond_to?(:cause) ? @exception.cause : ''
+      }
+    end
+
+    def setup_env_params
+      {
+        url: action_dispatch? ? @request.original_url : @request.path_info,
+        referrer: @request.referer,
+        http_method: action_dispatch? ? @request.method : @request.request_method,
+        ip_address:  action_dispatch? ? @request.remote_ip : @request.ip,
+        parameters: action_dispatch? ? @request.filtered_parameters : request_params,
+        session: @request.session,
+        cookies: @request.cookies,
+        user_agent: @request.user_agent
+      }
+    end
+
+    def request_params
+      @request.params
+    rescue
+      {}
+    end
+
+    def fieldsets_links
+      fieldsets.map { |key, _value| link_helper(key.to_s) }.join(' | ')
+    end
+
+    def fetch_fieldsets(hash, links = {}, prefix = nil)
+      return unless hash.is_a?(Hash)
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          fetch_fieldsets(value, links, key)
+        else
+          add_to_links(links, prefix, key: key, value: value)
+        end
+      end
+      links
+    end
+
+    def add_to_links(links, prefix, options = {})
+      expected_value = parse_fieldset_value(options)
+      return unless expected_value.present?
+      prefix_name = set_fieldset_key(links, prefix || 'basic_info')
+      links[prefix_name][options[:key]] = expected_value
+    end
+
+    def fieldsets
+      @fieldsets ||= fetch_fieldsets(parse_exception_options).except(:env)
+    end
+
+    def render_template(template = nil)
+      execute_with_rescue do
+        current_template = template.present? ? template : @template_path
+        Tilt.new(current_template).render(self, @template_params.stringify_keys)
+      end
+    end
+
+    def create_tempfile(output = render_template)
+      tempfile = Tempfile.new([SecureRandom.uuid, ".#{@template_details[:template_extension]}"], encoding: 'utf-8')
+      tempfile.write(output)
+      tempfile.close
+      details = tempfile_details(tempfile)
+      [details[:filename], details[:path]]
+    end
+
+    def fetch_archives(output = render_template)
+      return [] if output.blank?
+      filename, path = create_tempfile(output)
+      archive = compress_files(File.dirname(path), filename, [path])
+      remove_tempfile(path)
+      split_archive(archive, "part_#{filename}", 1024 * 1024 * 100)
+    end
+
+    def remove_tempfile(path)
+      if ENV['DEBUG_ASANA_TEMPLATE']
+        logger.debug(path)
+      else
+        FileUtils.rm_rf([path])
+      end
+    end
+  end
+end