slackbot-rails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3fba1ecbb7c38a3b512bf42959614ecdeb97410
+  data.tar.gz: d1b11fd26d339fb62660af866ead49d48475db49
+SHA512:
+  metadata.gz: 48ee3548c593fb39d23a71935612e4e212d5782d9efda6316a4e39690705d0b96310748d266edfe30e00a10b08fb1f03d6f8ad09ea904d749fdbd83d274c8230
+  data.tar.gz: 95b05efcd7d22f9fa1b776b2b19d293c38005d73da3e092375ba518e6d85a202eebe6ce45c62f9b65b1093bbe46508f1918c4556ced2f4e920dfe1c4da9a6724

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slackbot-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Björn Wolf
+
+MIT License
+
+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,65 @@
+# Slackbot::Rails
+
+An activerecord hook to send notifications to slack on updations and creation of resources.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'slackbot-rails', :git => 'git://github.com/bitsapien/slackbot-rails.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Just put the `notify_bot` method in your model
+
+```ruby
+class Model < ActiveRecord::Base
+  notify_bot bot:     {
+               webhook: '<WEBHOOK URL>',
+               name: '<BOT NAME>',
+               channel: '#channel-name'
+             }, 
+             message: {
+              create: 'A new resource in *{class.model_name.human}* was created. '}
+
+end
+```
+
+This would send a notification on Slack:
+
+![Slack Preview](https://raw.githubusercontent.com/bitsapien/slackbot-rails/master/images/slack-preview.png)
+
+Attributes inside '{}' will be evaluated on the present object of the model, for example : 
+`It is {valid?} that the present object passed validations` would output ->
+`It is true that the present object passed validations`
+
+
+#### Setting Defaults
+
+You may enable/disable notifications using a flag, for example in `application.rb`
+
+```ruby
+config.slackbot_rails_enable = Rails.env.production?
+```
+
+
+## TODO
+
+1. Specs!
+2. Background job option.
+3. Add I18n support.
+4. Add fallbacks for configurations.
+5. Add more support for emojis.
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/slackbot/rails.rb

@@ -0,0 +1,89 @@
+require 'slackbot/rails/engine'
+require 'slackbot/rails/version'
+require 'slackbot/railtie' if defined? ::Rails::Railtie
+require 'slack-notifier'
+
+module Slackbot
+  module Rails
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def bot
+        @bot ||= Slack::Notifier.new slackbot_rails_options[:bot][:webhook], 
+                                     http_options: { open_timeout: 5 }  do 
+          defaults channel: '#general',
+                   username: 'Untitled'
+        end
+      end
+
+
+      def push_to_bot(message)
+        begin
+          bot.ping(text: message, channel: slackbot_rails_options[:bot][:channel], username: slackbot_rails_options[:bot][:name], icon_emoji: slackbot_rails_options[:bot][:icon])
+        rescue Exception => e
+          logger.fatal "[Slackbot::Rails] Something went wrong with pushing to the bot:"
+          logger.fatal "[Slackbot::Rails] #{e}"
+        end
+      end
+
+      def notify_bot(options = {})
+        begin
+        cattr_accessor :slackbot_rails_options
+        self.slackbot_rails_options = options
+        if Slackbot::Railtie.enable_notifications && slackbot_rails_options[:message][:create].present?
+          after_commit :push_create_notification_to_bot, on: :create
+        end
+        if Slackbot::Railtie.enable_notifications && slackbot_rails_options[:message][:update].present?
+          after_commit :push_update_notification_to_bot, on: :update
+        end
+        rescue Exception => e
+          logger.fatal "[Slackbot::Rails] Something went wrong with pushing to the bot:"
+          logger.fatal "[Slackbot::Rails] #{e}"
+        end          
+      end
+    end
+
+    private
+
+    def push_create_notification_to_bot
+      begin
+        Thread.new do
+          self.class.push_to_bot build_message('create')
+        end
+      rescue Exception => e
+          logger.fatal "[Slackbot::Rails] Something went wrong with pushing to the bot:"
+          logger.fatal "[Slackbot::Rails] #{e}"
+        end
+    end
+
+    def push_update_notification_to_bot
+      begin
+        Thread.new do
+          self.class.push_to_bot build_message('update')
+        end
+      rescue Exception => e
+          logger.fatal "[Slackbot::Rails] Something went wrong with pushing to the bot:"
+          logger.fatal "[Slackbot::Rails] #{e}"
+        end
+    end
+
+    def build_message(action)
+      begin
+      message = slackbot_rails_options[:message][action.to_sym]
+
+      evaluate = message.scan(/{(.*?)}/).flatten
+      values = evaluate.inject({}) {|h,e| h.merge!(e => e.to_s.split('.').inject(self) {|o, a| o.try(a)})}
+      ready = message
+      values.each do |k,v|
+        ready = ready.gsub!("{#{k}}", v.to_s)
+      end
+      
+      rescue Exception => e
+      logger.fatal e.message
+      end
+      ready
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Slackbot::Rails

data/lib/slackbot/rails/engine.rb

@@ -0,0 +1,6 @@
+module Slackbot
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/slackbot/rails/version.rb

@@ -0,0 +1,5 @@
+module Slackbot
+  module Rails
+    VERSION = "0.0.2"
+  end
+end

data/lib/slackbot/railtie.rb

@@ -0,0 +1,7 @@
+require 'rails'
+ 
+class Slackbot::Railtie < Rails::Railtie
+	def self.enable_notifications
+		config.try(:slackbot_rails_enable)
+	end
+end

data/slackbot-rails.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slackbot/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slackbot-rails"
+  spec.version       = Slackbot::Rails::VERSION
+  spec.authors       = ["bitsapien"]
+  spec.email         = ["bitsapien@gmail.com"]
+  spec.description   = "Gem for notifying slack about the creation and updation of ActiveRecord models."
+  spec.summary       = "Notify slack of model creates and updates"
+  spec.homepage      = "http://github.com/bitsapien/slackbot-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "slack-notifier"
+  spec.add_dependency "activerecord", "> 3.0"
+  spec.add_dependency "activesupport", "> 3.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: slackbot-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- bitsapien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Gem for notifying slack about the creation and updation of ActiveRecord
+  models.
+email:
+- bitsapien@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- images/slack-preview.png
+- lib/slackbot/rails.rb
+- lib/slackbot/rails/engine.rb
+- lib/slackbot/rails/version.rb
+- lib/slackbot/railtie.rb
+- slackbot-rails.gemspec
+homepage: http://github.com/bitsapien/slackbot-rails
+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: Notify slack of model creates and updates
+test_files: []