asana_exception_notifier 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26a4963df2fedaa47495a14337cbb79a4deb632a
-  data.tar.gz: 0a2839dd8fab800fb2fd33f365a1c0c910e8f519
+  metadata.gz: 3e9dd8cc08308fa3e912aa23314f1a5edd2d9f3e
+  data.tar.gz: 5b7599db7a424495bad6ceb7f32d78e577c86c78
 SHA512:
-  metadata.gz: d68837acda0f936813c94c873bbdcf16f4cd1c033aee92545daeddfc7617340e4232ccc6baea919d873f60902b7ae8057186dcc184074c775ba1a02fbfc80043
-  data.tar.gz: cc7f630304a094a868a35a9d06ccf0914b45487e226ea20bfc5c845b04f50d04eaeec85dc797abb3d607b0d7a394c976fe37166776371512672ce9d18d1597cc
+  metadata.gz: a1754feadb154011e8e833dee9456b8ba3beee6d7b5d41defb2ad6fed35ce4743926c0af8acd1e0757da652be07e46d98df61572711cf18be49187dd98666987
+  data.tar.gz: 66efa3e2561928c8de2b64a7a0ec77a407940f2e5634fb0864ea5dd6cc41ee23d76e08fe64d2a9fc28cee772e586971b6a6c291fdffa41aff060aba6d7880b40

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    asana_exception_notifier (0.0.1)
+    asana_exception_notifier (0.0.4)
       activesupport (>= 4.0, < 5)
       em-http-request (~> 1.1, >= 1.1.2)
       eventmachine (~> 1.0, >= 1.0.7)

data/README.md

@@ -8,7 +8,7 @@ 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
 
-The gem provides a notifier for sending notifications to Asana when errors occur in a Rack/Rails application [courtesy of exception_notifications gem](https://github.com/smartinez87/exception_notifications). Check out that gem for more details on setting up the rack middleware with additional options.
+The gem provides a notifier for sending notifications to Asana when errors occur in a Rack/Rails application [courtesy of exception_notification gem](https://github.com/smartinez87/exception_notification). Check out that gem for more details on setting up the rack middleware with additional options.
 
 Requirements
 ------------

data/lib/asana_exception_notifier/classes/asana.rb

@@ -15,15 +15,14 @@ module ExceptionNotifier
     def initialize(options)
       execute_with_rescue do
         super
-        @initial_options = options.symbolize_keys
-        options = @initial_options.reject { |_key, value| value.blank? }
-        parse_options(options)
+        @initial_options = options.symbolize_keys.reject { |_key, value| value.blank? }
+        parse_options(@initial_options)
       end
     end
 
     def call(exception, options = {})
-      execute_with_rescue do
-        ensure_eventmachine_running do
+      ensure_eventmachine_running do
+        execute_with_rescue 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?
@@ -31,27 +30,54 @@ module ExceptionNotifier
       end
     end
 
+    def asana_api_key
+      @default_options.fetch(:asana_api_key, nil)
+    end
+
+    def workspace
+      @default_options.fetch(:workspace, nil)
+    end
+
+    def notes
+      @default_options.fetch(:notes, nil)
+    end
+
+    def task_name
+      @default_options.fetch(:name, nil)
+    end
+
     def active?
-      @default_options.fetch(:asana_api_key, nil).present? && @default_options.fetch(:workspace, nil).present?
+      asana_api_key.present? && workspace.present?
+    end
+
+    def template_path
+      @default_options.fetch(:template_path, nil)
     end
 
   private
 
     def parse_options(options)
-      options = options.symbolize_keys.reject { |key, _value| !permitted_options.key?(key) }
+      options = options.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))
+    def note_content(error_page)
+      if path_is_a_template?(notes)
+        error_page.render_template(expanded_path(notes))
+      else
+        notes.present? ? notes : error_page.render_template(File.join(template_dir, 'notes.text.erb'))
+      end
+    end
+
+    def task_name_content(error_page)
+      task_name.present? ? task_name : "[AsanaExceptionNotifier] #{error_page.exception_data[:message]}"
     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
+        name: task_name_content(error_page),
+        notes:  note_content(error_page),
+        workspace: workspace.to_i
       ).symbolize_keys!
     end
 

data/lib/asana_exception_notifier/classes/error_page.rb

@@ -7,9 +7,9 @@ module AsanaExceptionNotifier
     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
+      html_template(template_path)
       @template_details = setup_template_details
       @env = (@options[:env] || ENV.to_h).stringify_keys
       @request = action_dispatch? ? ActionDispatch::Request.new(@env) : Rack::Request.new(@env)
@@ -17,6 +17,14 @@ module AsanaExceptionNotifier
       parse_exception_options
     end
 
+    def html_template(path)
+      @template_path = if path_is_a_template?(path)
+                         expanded_path(path)
+                       else
+                         File.join(template_dir, 'exception_details.html.erb')
+                       end
+    end
+
     def action_dispatch?
       defined?(ActionDispatch::Request)
     end
@@ -110,17 +118,19 @@ module AsanaExceptionNotifier
     def create_tempfile(output = render_template)
       tempfile = Tempfile.new([SecureRandom.uuid, ".#{@template_details[:template_extension]}"], encoding: 'utf-8')
       tempfile.write(output)
+      ObjectSpace.undefine_finalizer(tempfile) # force garbage collector not to remove automatically the file
       tempfile.close
-      details = tempfile_details(tempfile)
-      [details[:filename], details[:path]]
+      tempfile_details(tempfile).slice(:filename, :path).values
     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)
+      execute_with_rescue(value: []) do
+        return [] if output.blank?
+        filename, path = create_tempfile(output)
+        archive = compress_files(File.dirname(path), filename, [expanded_path(path)])
+        remove_tempfile(path)
+        split_archive(archive, "part_#{filename}", 1024 * 1024 * 100)
+      end
     end
 
     def remove_tempfile(path)

data/lib/asana_exception_notifier/helpers/application_helper.rb

@@ -1,6 +1,8 @@
+require_relative './heredoc_helper'
 module AsanaExceptionNotifier
   # module that is used for formatting numbers using metrics
   module ApplicationHelper
+    include AsanaExceptionNotifier::HeredocHelper
   # function that makes the methods incapsulated as utility functions
 
   module_function
@@ -21,25 +23,28 @@ module AsanaExceptionNotifier
         tags: [],
         notes: '',
         name: '',
-        template_path: default_template_path
+        template_path: nil
       }
     end
 
+    def expanded_path(path)
+      File.expand_path(path)
+    end
+
+    def path_is_a_template?(path)
+      path.present? && template_path_exist(expanded_path(path))
+    end
+
     def multi_request_manager
       @multi_manager ||= EventMachine::MultiRequest.new
     end
 
-    def extract_body(env)
-      return if env.blank? || !env.is_a?(Hash)
-      io = env['rack.input']
-      io.rewind if io.respond_to?(:rewind)
+    def extract_body(io)
+      return unless io.respond_to?(:rewind)
+      io.rewind
       io.read
-    end
-
-    def show_hash_content(hash)
-      hash.map do |key, value|
-        value.is_a?(Hash) ? show_hash_content(value) : ["#{key}:", value]
-      end.join("\n  ")
+    rescue
+      io.inspect
     end
 
     def tempfile_details(tempfile)
@@ -111,11 +116,7 @@ module AsanaExceptionNotifier
     end
 
     def template_dir
-      File.expand_path(File.join(root, 'note_templates'))
-    end
-
-    def default_template_path
-      File.join(template_dir, 'asana_exception_notifier.html.erb')
+      File.expand_path(File.join(root, 'templates'))
     end
 
     def template_path_exist(path)
@@ -123,26 +124,19 @@ module AsanaExceptionNotifier
       fail ArgumentError, "file #{path} doesn't exist"
     end
 
-    def max_length(rows, index)
-      value = rows.max_by { |array| array[index].to_s.size }
-      value.is_a?(Array) ? value[index] : value
-    end
-
     def get_hash_rows(hash, rows = [], prefix = '')
       hash.each do |key, value|
         if value.is_a?(Hash)
           get_hash_rows(value, rows, key)
         else
-          rows.push(["#{prefix}#{key}".inspect, escape(value.inspect)])
+          rows.push(["#{prefix}#{key}".inspect, escape(inspect_value(value).inspect)])
         end
       end
       rows
     end
 
-    def link_helper(link)
-      <<-LINK
-      <a href="javascript:void(0)" onclick="AjaxExceptionNotifier.hideAllAndToggle('#{link.downcase}')">#{link.camelize}</a>
-      LINK
+    def inspect_value(value)
+      value.is_a?(IO) ? extract_body(value) : value
     end
 
     def escape(text)
@@ -159,24 +153,6 @@ module AsanaExceptionNotifier
       value.is_a?(Hash) ? value.reject! { |_new_key, new_value| new_value.is_a?(Hash) } : value
     end
 
-    # Gets a bidimensional array and create a table.
-    # The first array is used as label.
-    #
-    def mount_table(array, options = {})
-      return '' if array.blank?
-      header = array.shift
-
-      header = header.map { |name| escape(name.to_s.humanize) }
-      rows = array.map { |name| "<tr><td>#{name.join('</td><td>')}</td></tr>" }
-
-      <<-TABLE
-       <table #{hash_to_html_attributes(options)}>
-         <thead><tr><th>#{header.join('</th><th>')}</th></tr></thead>
-         <tbody>#{rows.join}</tbody>
-       </table>
-      TABLE
-    end
-
     # Mount table for hash, using name and value and adding a name_value class
     # to the generated table.
     #

data/lib/asana_exception_notifier/helpers/heredoc_helper.rb

@@ -0,0 +1,30 @@
+module AsanaExceptionNotifier
+  # helper methods that use Heredoc syntax
+  module HeredocHelper
+  module_function
+
+    def link_helper(link)
+      <<-HTML
+      <a href="javascript:void(0)" onclick="AjaxExceptionNotifier.hideAllAndToggle('#{link.downcase}')">#{link.camelize}</a>
+      HTML
+    end
+
+    # Gets a bidimensional array and create a table.
+    # The first array is used as label.
+    #
+    def mount_table(array, options = {})
+      return '' if array.blank?
+      header = array.shift
+
+      header = header.map { |name| escape(name.to_s.humanize) }
+      rows = array.map { |name| "<tr><td>#{name.join('</td><td>')}</td></tr>" }
+
+      <<-HTML
+      <table #{hash_to_html_attributes(options)}>
+      <thead><tr><th>#{header.join('</th><th>')}</th></tr></thead>
+      <tbody>#{rows.join}</tbody>
+      </table>
+      HTML
+    end
+  end
+end

data/lib/asana_exception_notifier/version.rb

@@ -17,7 +17,7 @@ module AsanaExceptionNotifier
     # minor release version
     MINOR = 0
     # tiny release version
-    TINY = 3
+    TINY = 4
     # prelease version ( set this only if it is a prelease)
     PRE = nil
 

data/spec/lib/asana_exception_notifier/classes/asana_spec.rb

@@ -3,7 +3,6 @@
 require 'spec_helper'
 
 describe ExceptionNotifier::AsanaNotifier do
-
   let(:options) { double('options') }
 
   before(:each) do
@@ -18,6 +17,4 @@ describe ExceptionNotifier::AsanaNotifier do
       expect(@subject.initial_options).to eq options
     end
   end
-
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asana_exception_notifier
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -420,12 +420,13 @@ files:
 - lib/asana_exception_notifier/classes/asana.rb
 - lib/asana_exception_notifier/classes/error_page.rb
 - lib/asana_exception_notifier/helpers/application_helper.rb
+- lib/asana_exception_notifier/helpers/heredoc_helper.rb
 - lib/asana_exception_notifier/initializers/zip.rb
-- lib/asana_exception_notifier/note_templates/asana_exception_notifier.html.erb
-- lib/asana_exception_notifier/note_templates/asana_exception_notifier.text.erb
 - lib/asana_exception_notifier/request/client.rb
 - lib/asana_exception_notifier/request/core.rb
 - lib/asana_exception_notifier/request/middleware.rb
+- lib/asana_exception_notifier/templates/exception_details.html.erb
+- lib/asana_exception_notifier/templates/notes.text.erb
 - lib/asana_exception_notifier/version.rb
 - lib/generators/asana_exception_notifier/install_generator.rb
 - lib/generators/asana_exception_notifier/templates/asana_exception_notifier.rb