worker_tools 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b0794f3ef2c1157bf4254ec78087218ff50dcc4
-  data.tar.gz: 28cb0e939304f7d81becb39e6d223493b059c60e
+  metadata.gz: f8781038bd01108da06e6c7449cb29faaa45fdd8
+  data.tar.gz: eed78607ccda5d5b0ed7ad5030a42b8dc286fcea
 SHA512:
-  metadata.gz: 78e98bd9a94c25f990f809b72d60257121467875154c2bda55a1b7ef65e25b7ecaba0faffebd932f22c775a213eb554886d87aab8080aab3458f3aaf8bc71ae8
-  data.tar.gz: 2d910f18319f729d0b05ced99d6fc24886308439e12c01ea2a58a09ee1320e4ee83bd3d2e0f36aa1915fff11fab7d578d5134805de0da7cd3c7b7fefe2ebcd51
+  metadata.gz: cc5633debc66182adff1af028ae0034937be1d369abbaabdbc731da5e792480db6074b602e951efaf4ec1889d0586fd175b44df4945eff8819d637cdfec171c8
+  data.tar.gz: d6dcb02514729dcf459df1eaee5f40df1a792731336aea56a8b92541418163227b17144174285075e5365f98546c0a2607534c5b62845bee1e0982c94dd9bb39

data/README.md

@@ -126,7 +126,11 @@ If you only want the logger functions, without worrying about persisting a model
 
 ## Module RocketchatErrorNotifier
 
-[recorder](/lib/worker_tools/rocketchat_error_notifier.rb)
+[rocketchat_error_notifier](/lib/worker_tools/rocketchat_error_notifier.rb)
+
+## Module SlackErrorNotifier
+
+[slack_error_notifier](/lib/worker_tools/slack_error_notifier.rb)
 
 ## Module CSV Input
 

data/lib/worker_tools/slack_error_notifier.rb

@@ -0,0 +1,105 @@
+require 'slack-notifier'
+
+module WorkerTools
+  module SlackErrorNotifier
+    def with_wrapper_slack_error_notifier(&block)
+      block.yield
+    rescue StandardError => e
+      slack_error_notify(e) if slack_error_notifier_enabled
+      raise
+    end
+
+    def slack_error_notifier_enabled
+      Rails.env.production?
+    end
+
+    def slack_error_notifier_emoji
+      ':red_circle:'
+    end
+
+    def slack_error_notifier_channel
+      return SLACK_NOTIFIER_CHANNEL if defined?(SLACK_NOTIFIER_CHANNEL)
+
+      raise 'Define slack_error_notifier_channel or set SLACK_NOTIFIER_CHANNEL in an initializer'
+    end
+
+    def slack_error_notifier_webhook
+      return SLACK_NOTIFIER_WEBHOOK if defined?(SLACK_NOTIFIER_WEBHOOK)
+
+      raise 'Define slack_error_notifier_webhook or set SLACK_NOTIFIER_WEBHOOK in an initializer'
+    end
+
+    def slack_error_notifier_username
+      'Notifier'
+    end
+
+    def slack_error_notifier_receivers
+      # Ex: '@all'
+    end
+
+    def slack_error_notifier_attachments_color
+      # good, warning, danger, hex color
+      'danger'
+    end
+
+    def slack_error_notifier_title
+      # Example with a link:
+      #
+      # For urls a default_url_options[:host] might be necessary.
+      # In this example I just copy it from existing action_mailer defaults.
+      #
+      # import = slack_error_notifier_model
+      # host = Rails.application.config.action_mailer.default_url_options[:host]
+      # url = Rails.application.routes.url_helpers.import_url(import, host: host, protocol: :https)
+      # kind = I18n.t(import.kind, scope: 'import.kinds')
+      # text = "##{import.id} *#{kind}*"
+      # "[#{text}](#{url})"
+      klass = model.class.model_name.human
+      kind = I18n.t("activerecord.attributes.#{model.class.name.underscore}.kinds.#{model.kind}")
+      "#{klass} #{kind} ##{model.id}"
+    end
+
+    def slack_error_notifier_error_details(error)
+      error.backtrace[0..2].join("\n")
+    end
+
+    def slack_error_notifier_message
+      message = []
+      message << slack_error_notifier_receivers
+      message << slack_error_notifier_title
+      message.compact.join(' - ')
+    end
+
+    def slack_error_notifier_attachments(error)
+      [
+        { color: slack_error_notifier_attachments_color, fields: slack_error_notifier_attachments_fields },
+        {
+          title: [error.class, error.message].join(' : '),
+          color: slack_error_notifier_attachments_color,
+          text: slack_error_notifier_error_details(error)
+        }
+      ]
+    end
+
+    def slack_error_notifier_attachments_fields
+      [
+        { title: 'Application', value: Rails.application.class.parent_name, short: true },
+        { title: 'Environment', value: Rails.env, short: true }
+      ]
+    end
+
+    def slack_error_notifier
+      Slack::Notifier.new(slack_error_notifier_webhook)
+    end
+
+    def slack_error_notify(error)
+      slack_error_notifier.post(
+        username: slack_error_notifier_username,
+        channel: slack_error_notifier_channel,
+        icon_emoji: slack_error_notifier_emoji,
+        text: "*#{slack_error_notifier_message}*",
+        attachments: slack_error_notifier_attachments(error)
+      )
+    end
+  end
+end

data/lib/worker_tools/version.rb

@@ -1,3 +1,3 @@
 module WorkerTools
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/worker_tools/xlsx_output.rb

@@ -0,0 +1,124 @@
+require 'rubyXL'
+module WorkerTools
+  module XlsxOutput
+    # if defined, this file will be written to this destination (regardless
+    # of whether the model saves the file as well)
+    def xlsx_output_target
+      # Ex: Rails.root.join('shared', 'foo', 'bar.xlsx')
+      raise "xlsx_output_target has to be defined in #{self}"
+    end
+
+    def xlsx_output_content
+      {
+        sheet1: {
+          label: 'Sheet 1',
+          headers: xlsx_output_column_headers,
+          rows: xlsx_output_values,
+          column_style: xlsx_output_column_format
+        }
+      }
+    end
+
+    def xlsx_output_values
+      raise "xlsx_output_values has to be defined in #{self}"
+    end
+
+    def xlsx_output_column_headers
+      # These columns are used to set the headers, also
+      # to set the row values depending on your implementation.
+      #
+      # To ignore them set it to _false_
+      #
+      # Ex:
+      # @xlsx_output_column_headers ||= {
+      #   foo: 'Foo Header',
+      #   bar: 'Bar Header'
+      # }
+      raise "xlsx_output_column_headers has to be defined in #{self}"
+    end
+
+    def xlsx_output_column_format
+      # These columns are used to set the headers, also
+      # to set the row values depending on your implementation.
+      #
+      # To ignore them set it to _false_
+      #
+      # Ex:
+      # @xlsx_output_column_format ||= {
+      #   foo: { width: 10, text_wrap: true },
+      #   bar: { width: 20, text_wrap: false }
+      # }
+      {}
+    end
+
+    def xlsx_output_target_folder
+      @xlsx_output_target_folder ||= File.dirname(xlsx_output_target)
+    end
+
+    def xlsx_ensure_output_target_folder
+      FileUtils.mkdir_p(xlsx_output_target_folder) unless File.directory?(xlsx_output_target_folder)
+    end
+
+    def xlsx_insert_headers(spreadsheet, headers)
+      return unless headers
+      iterator =
+        if headers.is_a? Hash
+          headers.values
+        else
+          headers
+        end
+      iterator.each_with_index do |header, index|
+        spreadsheet.add_cell(0, index, header.to_s)
+      end
+    end
+
+    def xlsx_insert_rows(spreadsheet, rows, headers)
+      rows.each_with_index do |row, row_index|
+        xlsx_iterators(row, headers).each_with_index do |value, col_index|
+          spreadsheet.add_cell(row_index + 1, col_index, value.to_s)
+        end
+      end
+    end
+
+    def xlsx_iterators(iterable, compare_hash = nil)
+      if iterable.is_a? Hash
+        raise 'parameter compare_hash should be a hash, too.' if compare_hash.nil? || !compare_hash.is_a?(Hash)
+        iterable.values_at(*compare_hash.keys)
+      else
+        iterable
+      end
+    end
+
+    def xlsx_style_columns(spreadsheet, styles, headers)
+      return false unless headers
+
+      xlsx_iterators(styles, headers).each_with_index do |format, index|
+        next unless format
+        spreadsheet.change_column_width(index, format[:width])
+        spreadsheet.change_text_wrap(index, format[:text_wrap])
+      end
+      true
+    end
+
+    def xlsx_write_sheet(workbook, sheet_content, index)
+      sheet = workbook.worksheets[index]
+      sheet = workbook.add_worksheet(sheet_content[:label]) if sheet.nil?
+
+      sheet.sheet_name = sheet_content[:label]
+      xlsx_style_columns(sheet, sheet_content[:column_style], sheet_content[:headers])
+      xlsx_insert_headers(sheet, sheet_content[:headers])
+      xlsx_insert_rows(sheet, sheet_content[:rows], sheet_content[:headers])
+    end
+
+    def xlsx_write_output_target
+      xlsx_ensure_output_target_folder
+
+      book = RubyXL::Workbook.new
+      xlsx_output_content.each_with_index do |(_, object), index|
+        xlsx_write_sheet(book, object, index)
+      end
+
+      book.write xlsx_output_target
+    end
+  end
+end

data/worker_tools.gemspec

@@ -28,6 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'rocketchat-notifier', '>= 0.1.2'
   spec.add_dependency 'roo'
+  spec.add_dependency 'rubyXL'
+  spec.add_dependency 'slack-notifier'
 
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worker_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - fsainz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -228,8 +256,10 @@ files:
 - lib/worker_tools/csv_output.rb
 - lib/worker_tools/recorder.rb
 - lib/worker_tools/rocketchat_error_notifier.rb
+- lib/worker_tools/slack_error_notifier.rb
 - lib/worker_tools/version.rb
 - lib/worker_tools/xlsx_input.rb
+- lib/worker_tools/xlsx_output.rb
 - worker_tools.gemspec
 homepage: https://github.com/i22-digitalagentur/worker-tools
 licenses: