quandl-slack 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8e13cac7c471291386cec287cca6bd1e94c8061
-  data.tar.gz: 43d5ed72665773c57bf020ae4261f94cbc991b4e
+  metadata.gz: 356d7eace5bf48dcb2cda29b4c0ef8d8e222643e
+  data.tar.gz: 066f85286302129f33e9194027e90557deb63d03
 SHA512:
-  metadata.gz: 9033e037fe8e64d14772687fb843193a1281243781ce41fc03dd3923d3e49041dfe07b4b2ab691dd8969b4848eee41a86f001eed77a25389f8942cbb2dbd565d
-  data.tar.gz: f61b277416d232de41f7f20db7b4a695ba6d56840b6c8b2b324ba903a8a91a1d2eeb4f5faf283e3feda0522d51b3ec1f376caaff994023814d7c667251a7ace4
+  metadata.gz: 5ec958b672dfc8a2d10c539f9985e7e4e03e16762e33e28c76b9d8010822b6311924cab58dbe1d5cd21353b924930079d36ce4643a54b4f11a1f4c7ce21ea147
+  data.tar.gz: 9ecd92f54ab700b2422c7905c42946092dee8b7bff3b528d7d13e499fa58a7ccbd4ccf3be2df32bdc19617d0f4985f6a5045ef5850087f0a3ce14c055f39a2ab

data/README.md

@@ -1,6 +1,6 @@
-# QuandlSlack
+# Quandl::Slack
 
-TODO: Write a gem description
+Use this gem to automatically generate Slack notifiers for you, or to quickly generate them on the fly.
 
 ## Installation
 
@@ -16,9 +16,103 @@ Or install it yourself as:
 
     $ gem install quandl_slack
 
-## Usage
+## Generating your notifiers
 
-TODO: Write usage instructions here
+### Automatically
+
+First, create a `slack.yml` file and place it in `config/quandl` in your project's root folder:
+```YAML
+defaults: &defaults
+  webhook_url: https://hooks.slack.com/services/fake/fake/fake
+  notifiers: &default_notifiers
+    asset_management:
+      channel: '#releases'
+      username: Next Asset Deployer
+      icon_emoji: ':airplane:'
+    stripe:
+      channel: '#stripe-testing'
+      username: stripe
+      icon_url: 'http://lorempixel.com/48/48'
+    ci:
+      channel: <%= ENV.fetch('SLACK_CHANNEL', "'#development'") %>
+
+development:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+vagrant:
+  <<: *defaults
+
+vagrant_test:
+  <<: *defaults
+
+vagrant_staging:
+  <<: *defaults
+
+production:
+  <<: *defaults
+  subclasses:
+    <<: *default_notifiers
+    stripe:
+      channel: '#stripe-events'
+      username: stripe
+```
+
+Then call `Quandl::Slack.autogenerate_notifiers` in an initializer. In the example above, you will get three notifiers:
+- `Quandl::Slack::AssetManagement`
+- `Quandl::Slack::Stripe`
+- `Quandl::Slack::Ci`
+
+### Manually and individually
+
+#### Provide the webhook
+
+Every Slack notifier needs a webook. Normally, you would use the same one throughout the project, and customize the channel, username and icon on a per-notifier basis.
+
+To provide the webhook, either set the `ENV['SLACK_WEBHOOK']` environment variable:
+```Ruby
+ENV['SLACK_WEBHOOK'] = 'https://hooks.slack.com/services/XXX/YYYY/ZZZ'
+```
+OR
+
+Create a `config/quandl/slack.yml` file with a `webhook_url` node and call:
+```Ruby
+Quandl::Slack.extend(Quandl::Configurable)
+```
+
+#### Provide the environment
+
+If your project is a Rails app or you're using `ENV['SLACK_WEBHOOK']` to set the webhook URL, you don't need to do anything.
+
+If your project is NOT a Rails app and you're using a config file to set the webhook URL, you will also need to let `Quandl::Slack` know what the environment is, so it knows which node in the `config` file to use. You can provide the environment using the `ENV['RAILS_ENV']` or `ENV['RAKE_ENV']` environment variable. If you do not, the `default` environment will be assumed.
+
+#### Generate the notifier!
+
+```Ruby
+Quandl::Slack.generate_notifier('your_notifier', customizations_hash)
+```
+
+## Available customizations:
+These can be placed in the yml file when autogenerating notifiers, or passed to `generate_notifier` when manually generating an individual notifier:
+
+key | example value | notes
+------- | ----------- | ----
+`channel` | `'#development'` | remember the hash
+`icon_url` | `http://lorempixel.com/200/200/people/` |
+`icon_emoji` | `':alien:'` | see [emoji cheat sheet](http://www.emoji-cheat-sheet.com/)
+`username` |`The Bot` |
+
+## Pinging your notifiers
+
+Simply call:
+```ruby
+Quandl::Slack::YourNotifier.ping('your message', additional_customizations_hash)
+```
 
 ## Contributing
 

data/lib/quandl/slack/base.rb

@@ -1,12 +1,14 @@
 module Quandl
   module Slack
-    extend Quandl::Configurable
-
     class Base
       attr_reader :client
 
       def self.client
-        @client = ::Slack::Notifier.new Quandl::Slack.configuration.webhook_url, customizations
+        @client = ::Slack::Notifier.new webhook_url, customizations
+      end
+
+      def self.webhook_url
+        ENV['SLACK_WEBHOOK'] || Quandl::Slack.configuration.webhook_url
       end
 
       def self.customizations; end
@@ -15,17 +17,5 @@ module Quandl
         client.ping(*args)
       end
     end
-
-    def self.generate_notifiers
-      configuration.notifiers.each do |subclass_name, subclass_customizations|
-        name = subclass_name.camelize
-        klass = Class.new(Quandl::Slack::Base) do
-          define_singleton_method :customizations do
-            subclass_customizations
-          end
-        end
-        const_set name, klass
-      end
-    end
   end
 end

data/lib/quandl/slack/generate.rb

@@ -1,17 +1,20 @@
 module Quandl
   module Slack
-    def self.generate_notifiers
+    def self.autogenerate_notifiers
+      self.extend(Quandl::Configurable)
       configuration.notifiers.each do |subclass_name, subclass_customizations|
-        name = subclass_name.camelize
-        klass = Class.new(Quandl::Slack::Base) do
-          define_singleton_method :customizations do
-            subclass_customizations
-          end
+        generate_notifier(subclass_name, subclass_customizations)
+      end
+    end
+
+    def self.generate_notifier(subclass_name, subclass_customizations={})
+      name = subclass_name.camelize
+      klass = Class.new(Quandl::Slack::Base) do
+        define_singleton_method :customizations do
+          subclass_customizations
         end
-        const_set name, klass
       end
+      const_set name, klass
     end
   end
 end
-
-Quandl::Slack.generate_notifiers

data/lib/quandl/slack/version.rb

@@ -1,5 +1,5 @@
 module Quandl
   module Slack
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/spec/fixtures/{config → dummy_rails_app/config}/quandl/slack.yml

@@ -1,6 +1,6 @@
 defaults: &defaults
   webhook_url: https://hooks.slack.com/services/fake/fake/fake
-  notifiers: &default_subclasses
+  notifiers: &default_notifiers
     asset_management:
       channel: '#releases'
       username: Next Asset Deployer
@@ -33,7 +33,7 @@ vagrant_staging:
 production:
   <<: *defaults
   subclasses:
-    <<: *default_subclasses
+    <<: *default_notifiers
     stripe:
       channel: '#stripe-events'
       username: stripe

data/spec/quandl-slack_spec.rb

@@ -1,8 +1,21 @@
+require 'fixtures/dummy_rails_app/application'
 require 'spec_helper'
 
 describe Quandl::Slack do
-  it 'automatically creates Slack::Notifier instances' do
-    expect(Quandl::Slack::AssetManagement.client).to be_kind_of(Slack::Notifier)
-    expect(Quandl::Slack::Ci.client.default_payload['channel']).to eq('#development')
+  describe '.autogenerate_notifiers' do
+    it 'autogenerates Slack::Notifier instances' do
+      Quandl::Slack.autogenerate_notifiers
+      expect(Quandl::Slack::AssetManagement.client).to be_kind_of(Slack::Notifier)
+      expect(Quandl::Slack::Ci.client.default_payload['channel']).to eq('#development')
+    end
+  end
+
+  describe '.generate_notifier' do
+    it 'generates Slack::Notifier instance' do
+      ENV['SLACK_WEBHOOK'] = 'https://hooks.slack.com/services/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'
+      Quandl::Slack.generate_notifier('my_notifier', channel: '#stripe-testing', icon_emoji: ':christmas_tree:')
+      expect(Quandl::Slack::MyNotifier.client).to be_kind_of(Slack::Notifier)
+      expect(Quandl::Slack::MyNotifier.client.default_payload[:icon_emoji]).to eq(':christmas_tree:')
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-require 'fixtures/dummy_app'
-
 require 'bundler/setup'
 Bundler.require(:default, :development)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl-slack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Najwa Azer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,8 +183,8 @@ files:
 - lib/quandl/slack/generate.rb
 - lib/quandl/slack/version.rb
 - quandl-slack.gemspec
-- spec/fixtures/config/quandl/slack.yml
-- spec/fixtures/dummy_app.rb
+- spec/fixtures/dummy_rails_app/application.rb
+- spec/fixtures/dummy_rails_app/config/quandl/slack.yml
 - spec/quandl-slack_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -212,7 +212,7 @@ signing_key:
 specification_version: 4
 summary: Builds custom Slack notifiers from a quandl/slack.yml file.
 test_files:
-- spec/fixtures/config/quandl/slack.yml
-- spec/fixtures/dummy_app.rb
+- spec/fixtures/dummy_rails_app/application.rb
+- spec/fixtures/dummy_rails_app/config/quandl/slack.yml
 - spec/quandl-slack_spec.rb
 - spec/spec_helper.rb