slack-logger 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c955e77aba2b4fe3ac9f7cc757b1abf72f58893
+  data.tar.gz: 4efe7641a02fb280e55316695cb516af64510337
+SHA512:
+  metadata.gz: 317b18b39e03a0dae340796b2a205b0e20fdce06fb892f3d3e839dc0807595c4e9ee55907a4abfb8465367e0d658631032382546aa961746362e44d4505cbded
+  data.tar.gz: ec355a698e89edee17fd120988eff0d5a5adac1fcbc8f3a6799cbdfc72597e884e37c0a8acea6166f92769db610cda0fb8a270b8e0e57eaad6b5b554219f6b46

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 josephverbeck
+
+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,50 @@
+# slack-logger
+[![Build Status](https://travis-ci.org/josephverbeck/slack-logger.svg?branch=master)](https://travis-ci.org/josephverbeck/slack-logger)
+[![Code Climate](https://codeclimate.com/github/josephverbeck/slack-logger/badges/gpa.svg)](https://codeclimate.com/github/josephverbeck/slack-logger)
+[![Test Coverage](https://codeclimate.com/github/josephverbeck/slack-logger/badges/coverage.svg)](https://codeclimate.com/github/josephverbeck/slack-logger/coverage)
+
+
+Simple Slack logger using ActiveSupport broadcast and slack-ruby-client
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack-logger'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Finally, run the install generator:
+```bash
+$ rails generate slack_logger:install
+```
+
+it will create the following initializer `config/initializers/slack_logger.rb`. 
+This file contains all the information about the existing configuration options.
+
+##Configuration
+The gem makes use of the rails log and slack-ruby-client to force logs to be sent to both your normal log
+file and a slack channel.
+
+To configure your rails application simple add the below code to where you setup your rails log
+
+```ruby
+config.after_initialize do
+  config.logger.extend ActiveSupport::Logger.broadcast(SlackLogger.logger)
+end
+```
+
+
+## Contributing
+1. Fork it ( https://github.com/josephverbeck/slack-logger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Slack::Logger'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/slack_logger/install_generator.rb

@@ -0,0 +1,12 @@
+module SlackLogger
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Create a SlackLogger initializer"
+
+    def copy_initializer
+      template 'slack_logger.rb', 'config/initializers/slack_logger.rb'
+    end
+
+  end
+end

data/lib/generators/templates/slack_logger.rb

@@ -0,0 +1,38 @@
+SlackLogger.setup do |config|
+
+  ## Logger
+  #  ------
+  #
+  # The slack logger
+  #
+  ## Default:
+  # config.logger ||= SlackLogger::Logger.new(SlackLogger::SlackIO)
+
+  ## Log Level
+  #  ---------
+  #
+  #  The error level you would like to see in slack
+  #  Note: We support all log levels, but you shouldn't do anything less then :ERROR as Slack only allows one message
+  #  per minute.
+  #
+  ## Default:
+  # config.logger.level = :ERROR
+
+  ## Slack Client
+  # -------------
+  #
+  # The client in which you would like to use to communicate with slack
+  # Note: slack-ruby-client is imported with this gem and is recommended
+  #
+  ## Default:
+  # config.client = Slack::Web::Client.new(:token => Rails.application.secrets.slack_api_token)
+
+
+  ## Slack Channel
+  #  -------------
+  #
+  #  The channel for which you want the error message to appear on
+  #
+  ## Default:
+  # config.channel = nil
+end

data/lib/slack-logger.rb

@@ -0,0 +1,22 @@
+require 'slack_logger/engine'
+require 'slack-ruby-client'
+
+module SlackLogger
+
+  mattr_accessor :channel
+  self.channel = nil
+
+  mattr_accessor :token
+  self.token = nil
+
+  mattr_accessor :client
+  self.token = nil
+
+  mattr_accessor :logger
+  self.logger = nil
+
+  def self.setup
+    yield self
+  end
+
+end

data/lib/slack_logger/engine.rb

@@ -0,0 +1,6 @@
+module SlackLogger
+  class Engine < ::Rails::Engine
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+    isolate_namespace SlackLogger
+  end
+end

data/lib/slack_logger/logger.rb

@@ -0,0 +1,13 @@
+module SlackLogger
+  class Logger < ::Logger
+
+    def initialize(logdev)
+      super(logdev)
+    end
+
+    class << self
+      delegate :error, :debug, :fatal, :info, :warn, :add, :log, :to => :instance
+    end
+
+  end
+end

data/lib/slack_logger/slack_io.rb

@@ -0,0 +1,37 @@
+module SlackLogger
+  class SlackIO
+
+    def self.close
+      true
+    end
+
+    def self.write(message)
+      unless message.blank?
+        client = SlackLogger.client
+        client.auth_test
+        client.chat_postMessage({
+                                    channel: SlackLogger.channel,
+                                    attachments: [{
+                                                      pretext: message.to_s,
+                                                      ts: "#{Time.now.utc.to_i}",
+                                                      fields: [
+                                                          {
+                                                              title: "Project",
+                                                              value: "#{Rails.application.class.parent_name}",
+                                                              short: true
+                                                          },
+                                                          {
+                                                              title: "Environment",
+                                                              value: "#{Rails.env}",
+                                                              short: true
+                                                          }
+                                                      ],
+                                                      color: "#F35A00"
+                                                  }].to_json,
+                                    as_user: true})
+      end
+    end
+
+  end
+
+end

data/lib/slack_logger/version.rb

@@ -0,0 +1,3 @@
+module SlackLogger
+  VERSION = '0.4.1'
+end

data/lib/tasks/slack_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :slack_logger do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: slack-logger
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- josephverbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.9
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- joseph.verbeck@nih.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/slack_logger/install_generator.rb
+- lib/generators/templates/slack_logger.rb
+- lib/slack-logger.rb
+- lib/slack_logger/engine.rb
+- lib/slack_logger/logger.rb
+- lib/slack_logger/slack_io.rb
+- lib/slack_logger/version.rb
+- lib/tasks/slack_logger_tasks.rake
+homepage: https://github.com/josephverbeck/slack-logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple rails plugin that sends error messages to slack
+test_files: []