log2slack 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d9c1ea119a5689c4232dbf027427137bc94e324373a30deda89b84bbf3e2bd9
-  data.tar.gz: 983eb03bf04687559f7152d5549b36fee4fb036df2939ee46aa33c337bee3c6d
+  metadata.gz: 3c5bbeb34a831b9328fbee0e9f89b468a1d5c41255c73c483e7066b12c354c61
+  data.tar.gz: 5582f2449133a1cef9783d4ce5e4cab331358d311ebf081d7f32a42d1c7979d6
 SHA512:
-  metadata.gz: ff0d7c6a694ac03feb759bf812df6a8f7ad4d00bb05b784c668bd48b5d715438ae196870074c820fb62022858064b7bab6bc96ff2d10ad31a13a2cf818cf2ba9
-  data.tar.gz: 95a5260ec4743d9d1c517f1a6abb7845ae709df020c32fec54c29853b858d820da72210b19a8a721a181923f3dcca93e53b36e3fcb18df7cd371ec73a1abaf26
+  metadata.gz: bdde12fe8d4a34d5d25a140f5ca94e686c2a34a304f5ac9a07a55db0f46bea39a99068c5317a34c60bab6dbd4d6fa096b9c5f51f771ab30580153e7541cab938
+  data.tar.gz: 281c7bb1df8b27daa3b9db1059ae60befbf19d8eae24eaca82be5743a525b39fa3599c77f3bf14ce82043b951bb27258c5059ddb9f8e4aac9733d5e16e4725a1

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     log2slack (0.1.0)
+      slack-notifier (~> 2.3.2)
 
 GEM
   remote: https://rubygems.org/
@@ -44,6 +45,7 @@ GEM
     unicode-display_width (2.1.0)
 
 PLATFORMS
+  arm64-darwin-20
   x86_64-darwin-19
 
 DEPENDENCIES

data/README.md

@@ -1,8 +1,19 @@
 # Log2slack
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/log2slack`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/log2slack.svg)](https://badge.fury.io/rb/log2slack)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
 
-TODO: Delete this and the text above, and describe your gem
+Log2slack is a simple Ruby gem for recording application log messages and notifying them to Slack. It allows you to easily send logs generated from batch processes, web applications, and other systems to Slack channels.
+
+## Features
+
+- Support for standard log levels (INFO, WARN, ERROR)
+- Automatic appearance changes based on log level
+  - INFO: Green color
+  - WARN: Yellow color + channel notification
+  - ERROR: Red color + channel notification
+- Custom notification format support
+- Simple and easy-to-use API
 
 ## Installation
 
@@ -14,15 +25,74 @@ gem 'log2slack'
 
 And then execute:
 
-    $ bundle install
+```bash
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install log2slack
+```bash
+$ gem install log2slack
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+
+```ruby
+require 'log2slack'
+
+# Initialize the logger
+logger = Log2slack::Logger.new
+
+# Record logs
+# Normal logs (not notified to Slack)
+logger.info("Process started")
+logger.warn("Warning occurred")
+logger.error("Error occurred")
+
+# Record logs for Slack notification (specify notify: true)
+logger.info("Process started", notify: true)
+logger.warn("Warning occurred", notify: true)
+logger.error("Error occurred", notify: true)
+
+# Notify to Slack
+webhook_url = "https://hooks.slack.com/services/xxx/yyy/zzz"
+channel = "#general"
+user_name = "Log Notifier"
+title = "Batch Process Result"
+
+logger.notify_to_slack(webhook_url, channel, user_name, title)
+```
+
+### Custom Notification Format
+
+You can also notify Slack with a custom format using a block:
+
+```ruby
+logger.notify_to_slack(webhook_url, channel, user_name, title) do
+  {
+    text: "Custom text",
+    attachments: [
+      {
+        title: "Detailed Information",
+        text: "Detailed description here",
+        color: "#36a64f"
+      }
+    ]
+  }
+end
+```
+
+### Log Levels and Notification Appearance
+
+The appearance of Slack notifications automatically changes based on the log level:
+
+- **INFO**: Green attachment
+- **WARN**: Yellow attachment + channel notification (`<!channel>`)
+- **ERROR**: Red attachment + channel notification (`<!channel>`)
+
+Once an ERROR level log is recorded, the status will not be overwritten by subsequent INFO or WARN level logs. This prevents important error messages from being missed.
 
 ## Development
 
@@ -32,7 +102,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/log2slack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/log2slack/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/delightech/log2slack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +110,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Log2slack project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/log2slack/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Log2slack project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/lib/log2slack/logger.rb

@@ -4,54 +4,116 @@ require 'logger'
 require 'slack-notifier'
 module Log2slack
   class Logger
+    # Log level constants
+    LOG_LEVEL_INFO = 'INFO'
+    LOG_LEVEL_WARN = 'WARN'
+    LOG_LEVEL_ERROR = 'ERROR'
+    
     attr_reader :messages, :status
 
-    def initialize
+    # Initialize a new Logger instance
+    #
+    # @param output [IO, String] The log output destination (STDOUT, file path, etc.)
+    # @param max_files [Integer] Maximum number of log files to keep
+    # @param max_size [Integer] Maximum size of each log file in bytes
+    # @return [Logger] A new Logger instance
+    def initialize(output = STDOUT, max_files = 10, max_size = 1024 * 1024)
       # load logger module
-      @logger = ::Logger.new(STDOUT)
+      @logger = ::Logger.new(output, max_files, max_size)
       @messages = []
-      @status = 'INFO'
+      @status = LOG_LEVEL_INFO
     end
 
+    # Log a message with the specified level
+    #
+    # @param message [String] The message to log
+    # @param level [Symbol] The log level (:info, :warn, :error)
+    # @param notify [Boolean] Whether to store the message for Slack notification
+    # @return [void]
     def log(message, level: :info, notify: false)
       @logger.send(level, message)
       @messages.push("[#{level.to_s.upcase}]#{message}") if notify
       @status = level.to_s.upcase if level == :error
       # Do not overwrite with warn in case of error
-      @status = level.to_s.upcase if level == :warn && @status != 'ERROR'
+      @status = level.to_s.upcase if level == :warn && @status != LOG_LEVEL_ERROR
     end
 
+    # Log a message with INFO level
+    #
+    # @param message [String] The message to log
+    # @param notify [Boolean] Whether to store the message for Slack notification
+    # @return [void]
     def info(message, notify: false)
       log(message, level: :info, notify: notify)
     end
 
+    # Log a message with WARN level
+    #
+    # @param message [String] The message to log
+    # @param notify [Boolean] Whether to store the message for Slack notification
+    # @return [void]
     def warn(message, notify: false)
       log(message, level: :warn, notify: notify)
     end
 
+    # Log a message with ERROR level
+    #
+    # @param message [String] The message to log
+    # @param notify [Boolean] Whether to store the message for Slack notification
+    # @return [void]
     def error(message, notify: false)
       log(message, level: :error, notify: notify)
     end
 
+    # Create attachment payload for Slack notification
+    #
+    # @param title [String] The title for the Slack message
+    # @return [Hash] The attachment payload
     def make_attachments(title)
-      if @status == 'ERROR'
-        title = "<!channel> #{title}"
-        color = 'danger'
-      elsif @status == 'WARN'
-        title = "<!channel> #{title}"
-        color = 'warning'
-      else
-        color = 'good'
-      end
       { attachments: {
-          fallback: title,
-          title: title,
+          fallback: format_title(title),
+          title: format_title(title),
           text: @messages.join("\n"),
-          color: color
+          color: status_color
         }
       }
     end
 
+    # Format the title based on the current status
+    #
+    # @param title [String] The original title
+    # @return [String] The formatted title
+    def format_title(title)
+      if @status == LOG_LEVEL_ERROR || @status == LOG_LEVEL_WARN
+        "<!channel> #{title}"
+      else
+        title
+      end
+    end
+
+    # Determine the color based on the current status
+    #
+    # @return [String] The color code for Slack attachment
+    def status_color
+      case @status
+      when LOG_LEVEL_ERROR
+        'danger'
+      when LOG_LEVEL_WARN
+        'warning'
+      else
+        'good'
+      end
+    end
+
+    # Send notification to Slack
+    #
+    # @param webhook_url [String] The Slack webhook URL
+    # @param channel [String] The Slack channel to post to
+    # @param user_name [String] The username to display in Slack
+    # @param title [String] The title for the Slack message
+    # @yield [optional] Block to provide custom payload
+    # @return [void]
+    # @raise [Log2slack::Error] If the Slack notification fails
     def notify_to_slack(webhook_url, channel, user_name, title)
       args = if block_given?
                yield()
@@ -63,7 +125,13 @@ module Log2slack
         channel: channel,
         username: user_name
       ) if @notifier.nil?
-      @notifier.post(args)
+      
+      begin
+        @notifier.post(args)
+      rescue => e
+        @logger.error("Failed to send notification to Slack: #{e.message}")
+        raise Log2slack::Error, "Slack notification failed: #{e.message}"
+      end
     end
   end
 end

data/lib/log2slack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Log2slack
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: log2slack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - delightech
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-05 00:00:00.000000000 Z
-dependencies: []
+date: 2025-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 description: Send log summaries to slack webhook.
 email:
 - hisafumi.kikkawa@gmail.com
@@ -27,7 +41,6 @@ files:
 - lib/log2slack.rb
 - lib/log2slack/logger.rb
 - lib/log2slack/version.rb
-- log2slack.gemspec
 - sig/log2slack.rbs
 homepage: https://github.com/delightech/log2slack
 licenses:
@@ -51,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Send log summaries to slack webhook.

data/log2slack.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/log2slack/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "log2slack"
-  spec.version = Log2slack::VERSION
-  spec.authors = ["delightech"]
-  spec.email = ["hisafumi.kikkawa@gmail.com"]
-
-  spec.summary = "Send log summaries to slack webhook."
-  spec.description = "Send log summaries to slack webhook."
-  spec.homepage = "https://github.com/delightech/log2slack"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/delightech/log2slack"
-  spec.metadata["changelog_uri"] = "https://github.com/delightech/log2slack"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end