slack_notifier_wrapper 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cee7fec8842e42b01a23019cd389fa0751d078b6
-  data.tar.gz: a2d8fa9464e6b25406145c19007ac858edd04c69
+  metadata.gz: 227ce10f0481221683c970ddf96e9a516620e58d
+  data.tar.gz: fc30a39bbf6029491d730cdc75b5cde4a79dfbdb
 SHA512:
-  metadata.gz: b8c4780829b49bd34bf1884918579d0e874ba690ec8611255b9eef74e7d33b7390ae94ea2fb41e83c680881432684ef9c34ba93eb713385fc2f07575c2df0fd9
-  data.tar.gz: 4d64040b704474121e54f888de54393ee8bf7f7d44a9676a66f34d3a645e0723dea2090d998f52edaf33945a4f3967d0c802fda053e4c1cf93c7eb7b584c9fce
+  metadata.gz: 4102a5d0c31a8079c1bb4a5861b4c133fcfbc650f0a82f5f10fc76a468fb6331982820271efdddd17a5acf4c54b20adf696d55b406f578b96a72ad98ecd83179
+  data.tar.gz: 7ceaaee631f59844ed9be242375860598f08334293501c7177faa8e54d964179c06b49f4031e57863188f5af4e4c521e30b291c240d4980f17445ccb04eaf06b

data/README.md

@@ -1,10 +1,9 @@
 # SlackNotifierWrapper
 
-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/slack_notifier_wrapper`. To experiment with that code, run `bin/console` for an interactive prompt.
+[slack-notifier](https://github.com/stevenosloan/slack-notifier) is an awesome gem for sending notifications to Slack with Ruby and this wrapper gem lets you push Slack notifications with a different syntax.
 
-TODO: Delete this and the text above, and describe your gem
 
-## Installation
+## Installation & Setup
 
 Add this line to your application's Gemfile:
 
@@ -12,27 +11,33 @@ Add this line to your application's Gemfile:
 gem 'slack_notifier_wrapper'
 ```
 
-And then execute:
+Configure the gem with default settings:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install slack_notifier_wrapper
-
-## Usage
+```ruby
+SlackNotifierWrapper.config do
+  slack_webhook_url "webhook url"
+  default_channel "#some-channel"
+  username "Bob"
+  icon_emoji ":bob:"
+end
+```
 
-TODO: Write usage instructions here
+Use the gem to speak messages to the default Slack channel:
 
-## Development
+```ruby
+SlackNotifierWrapper.speak("This is some message")
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Access the notifier object directly and specify overrides if you'd like to override the defaults:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+notifier = SlackNotifierWrapper.notifier
+notifier.ping "Whatever", channel: "#devnull"
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slack_notifier_wrapper.
+Bug reports and pull requests are welcome on GitHub at https://github.com/MrPowers/slack_notifier_wrapper.
 
 
 ## License

data/lib/slack_notifier_wrapper/helpers.rb

@@ -5,7 +5,7 @@ module SlackNotifierWrapper
       begin
         send(method_name)
       rescue Exception => e
-        attachment_message = "#{self.class}##{method_name} failed to execute"
+        attachment_message = "#{self.class}##{method_name} failed to execute: #{e.message}"
         SlackNotifierWrapper.speak_attachments({ color: "danger", attachment_message: attachment_message })
         raise e
       end

data/lib/slack_notifier_wrapper/version.rb

@@ -1,3 +1,3 @@
 module SlackNotifierWrapper
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_notifier_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - MrPowers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler