slack-reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a32ec694cb0e2467b3383cbbca9076a93cd4071
+  data.tar.gz: 53c731ca83868be64335b692790df3101017bc99
+SHA512:
+  metadata.gz: ebeeb0ceefb40f9ffbedd031c38f7c3d8490121c87600993c8e805e768b53f40f1faed4240a8cf0741928a36dfef5a5ede82441def367beddb0de0b49d422bb6
+  data.tar.gz: 6c82ef7b3f0df67ef0e5f62b24da80d0e018efa759b4b24c4b082165aef0d9f765996d7f9f5d26a9d28d6e09e039ec9af6aac441ad989c1b8fb417c196b31590

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### 2016/6/13
+
+Creation of gem version 0.1
+
+

data/README.md

@@ -0,0 +1,66 @@
+# Slack Reporter
+
+A very simple wrapper for a a simple wrapper for posting to slack channels.
+requires [slack-notifier](https://github.com/stevenosloan/slack-notifier)
+
+### Requirements
+A slack channel with webhooks intergration and your api key in the `SLACK_WEBHOOK_URI` environmental variable.
+
+Finnally this is your gemfile.
+`gem 'slack_reporter'`
+
+### Usage
+
+```
+SlackReporter.new('user reporter', { channel: '#awesome-feedback' }).call do
+  "#{current_user.name} said we are awesome!"
+end
+```
+
+This will report the following to the '#awesome-feedback` channnel
+```
+user_reporter BOT  10:04 PM
+Bob said we are awesome!
+```
+
+Ofcourse whats the use without defaults!! SlackReporter uses four defaults, one for the webhook, one for the channel and two for naming the reporter.
+They default to
+
+```
+{
+  webhook:  ENV["SLACK_WEBHOOK_URI"],
+  channel:  '#feedback',
+  name:     'user',
+  followup: '_announcer'
+}
+```
+You can set your own by `SlackReporter.defaults` by providing the values you want to change afterwards.
+
+
+With defauts set the reporter can be called simply by
+
+```
+SlackReporter.new.call do
+  "Important message!!"
+end
+```
+
+### Notes
+The reporter gets called *ONLY* on production enviroments if inside Rails or Hanami.
+To report regardless of environment call `#call` with `true` in arguments e.g.
+`SlackReporter.new.call(true)`
+
+
+You can create as many custom reporters as you want and the use them by calling `#call` and giving them a block of text. e.g.
+```
+@reporter1 = SlackReporter.new("Nelson said")
+@reporter1.call { 'Hahaa' }
+```
+
+
+The naming of a reporter matches the name if its 2 words or more, else its the `name` + `followup`
+Also you can put on object or class in the reporter and it will smart name that too!!
+
+There is an `attr_accessor` for name and channel in case you want to change them for an existing reporter.
+
+The code is less than 50 lines so for any questions you might want to check it out!

data/lib/slack-reporter.rb

@@ -0,0 +1,50 @@
+require 'slack-notifier'
+require_relative 'version'
+
+class SlackReporter
+  attr_accessor :name, :channel
+  DEFAULTS = {
+    webhook:  ENV["SLACK_WEBHOOK_URI"].freeze,
+    channel:  '#feedback',
+    name:     'user',
+    followup: '_announcer'
+  }
+
+  def self.defaults(opts={})
+    DEFAULTS.merge!(Hash[opts])
+  end
+
+  def initialize(item = nil, options={ channel: nil })
+    @name = create_name(item)
+    @channel  = options[:channel] || DEFAULTS[:channel]
+    @notifier = Slack::Notifier.new DEFAULTS[:webhook], channel: @channel, username: @name
+  end
+
+  def call(allow = false)
+    return unless allow || environmet_allows
+    @notifier.ping yield
+  end
+
+  private
+
+  def create_name(item)
+    item = item.class unless item.class == Class || String
+    string = (item || DEFAULTS[:name]).to_s.downcase
+    return string if string.split.count > 1
+    string + DEFAULTS[:followup]
+  end
+
+  def environmet_allows
+    environment == 'production'
+  end
+
+  def environment
+    if defined?(Rails)
+      Rails.env
+    elseif defined?(Hanami)
+      Hanami.env
+    else
+      'production'
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+ class SlackReporter
+   VERSION = '0.1.0'.freeze
+ end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: slack-reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vasilis Spilka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: A very simple wrapper for a a simple wrapper for posting to slack channels
+email: vasspilka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/slack-reporter.rb
+- lib/version.rb
+homepage: http://rubygems.org/gems/slack-reporter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.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: A slack webhooks wrapper
+test_files: []
+has_rdoc: