slacked 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43c93f797ec347cc95898adf7ff3db9878d5a6c5
-  data.tar.gz: 7b6f2fb2794724e639549f6f625fa3c930d93734
+  metadata.gz: 027523f726fd684d6909a412d61902470dbb92d7
+  data.tar.gz: 4a232e9ac8a3309edbd697df6c3eac4cfa71db7b
 SHA512:
-  metadata.gz: 7a8914973c57b03e2e6248bae9a5d45639cc9b4b81fc6133a33aa1923ae887da828c2ce4f687b7d44503f8cbaa008c14b4d218d37ff41e5ad0ee4356511531b2
-  data.tar.gz: 9992d5d1ae2a1cde5c32e8849cc86a4297d720a54ce185d88dc4cdced1c24f4558875bbb1e4b9918022f4c9466d5640fad2fe5bbc62e101581698949be2222f5
+  metadata.gz: d589ec0319595fa27d317422f7e55da02635cc22d0a28ce8d5b72348cc08b573f8a478b5740e242c8a13b801662c3a487b5bc9a2c90237609e460d2a2a2fa490
+  data.tar.gz: b99fdac4d6fe27a5f5e3dc8250f2a8cc768ad86f7fb1444b324c07d0fe579b10dbeec79b2c28c7cdb970d3ee6b729259d5e35f097f2b83f9489c31ffa37cfb1b

data/.gitignore

@@ -10,3 +10,4 @@
 
 # Ignore application configuration
 /config/application.yml
+.idea*

data/Gemfile

@@ -3,8 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in slacked.gemspec
 gemspec
 
-gem "rails"
+gem 'rails'
 
 group :test do
-  gem "aruba", "~> 0.6.2"
+  gem 'aruba', '~> 0.6.2'
+  gem 'pry'
 end

data/README.md

@@ -1,6 +1,8 @@
 # Slacked
 
-A simple and easy way to send notifications to Slack from your Rails application. A use case for this would be to post a notification in Slack when a new User is created or a certain action has been taken in your application.
+This is a super simple Slack integration for Rails. A use case for this would be to post a notification in Slack when a new User is created or a certain action has been taken in your application.
+
+Are there other gems that provide similar functionality? Yes. Do some of them provide more flexibility? Yes. The point of this was to make installing and integrating a 30 second process.
 
 ## Getting Started
 
@@ -22,17 +24,40 @@ This will create a .env file in the root of the rails appication. Specify the We
 
 ```ruby
 SLACK_WEBHOOK= "WEBHOOK_URL"
-SLACK_MESSAGE= "TEST"
+SLACK_DEFAULT_MESSAGE= "TEST"
 ```
 
 
 ## Usage
+Set the SLACK_WEBOOK env variable with the value of the webhook which you want to send the messages.
+If you want to send a unique message in your application like 'Application is running' you can set the SLACK_DEFAULT_MESSAGE and call the message methods without sending an argument.
+
 
-To send the message to slack use the method:
+### To send a sync message to slack use the method:
+
+```ruby
+Slacked.post "This is a test post"
+```
+
+or
 
 ```ruby
 Slacked.post
 ```
+The last example will use the SLACK_DEFAULT_MESSAGE value
+
+### To send an async message to slack use the method:
+
+```ruby
+Slacked.post_async "This is a test post"
+```
+
+or
+
+```ruby
+Slacked.post_async
+```
+The last example will use the SLACK_DEFAULT_MESSAGE value
 
 ## Example
 
@@ -43,7 +68,7 @@ class Post < ActiveRecord::Base
   private
   
   def slacked
-    Slacked.post
+    Slacked.post 'post created!'
   end
 end
 ```
@@ -51,6 +76,7 @@ end
 ## Contributors
 
 - [Sean H.](https://github.com/seathony)
+- [Kaio Magalhães](https://github.com/kaiomagalhaes)
 
 ## License
 

data/lib/generators/slacked/install/templates/.env

@@ -1,2 +1,2 @@
 SLACK_WEBHOOK= "WEBHOOK_URL"
-SLACK_MESSAGE= "TEST"
+SLACK_DEFAULT_MESSAGE= "TEST"

data/lib/slacked/slack_post.rb

@@ -1,9 +1,29 @@
 module Slacked
+  SLACK_PROFILE_IMAGE=':robot_face:'
+  SLACK_WEBHOOK_URL_KEY='SLACK_WEBHOOK'
+  SLACK_DEFAULT_MESSAGE_KEY='SLACK_DEFAULT_MESSAGE'
+  SLACK_CONFIG= {
+      icon_emoji: SLACK_PROFILE_IMAGE
+  }
+
   class << self
+    def post message = ENV[SLACK_DEFAULT_MESSAGE_KEY]
+      return false if message.nil? || message.empty?
+      notifier = slack_notifier
+      notifier.ping message, SLACK_CONFIG
+    end
+
+    def post_async message
+      Thread.start do
+        result = post(message)
+        defined?(ActiveRecord) ? ActiveRecord::Base.connection.close : nil
+        result
+      end
+    end
 
-    def post message = ENV["SLACK_MESSAGE"]
-      send = Slack::Notifier.new ENV["SLACK_WEBHOOK"]
-      send.ping message, icon_emoji: ":ghost:"
-     end
+    private
+    def slack_notifier webhook_url = ENV[SLACK_WEBHOOK_URL_KEY]
+      Slack::Notifier.new webhook_url
+    end
   end
 end

data/lib/slacked/version.rb

@@ -1,3 +1,3 @@
 module Slacked
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/slacked.gemspec

@@ -9,8 +9,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ["sean"]
   spec.email         = ["seathony@gmail.com"]
 
-  spec.summary       = %q{Notify slack when an action has been completed.}
-  spec.description   = %q{Notify slack when an action has been completed.}
+  spec.summary       = %q{A super simple and easy way to send notifications to Slack from your Rails application.}
+  spec.description   = %q{This is a super simple Slack integration for Rails. A use case for this would be to post
+                          a notification in Slack when a new User is created or a certain action has been taken in
+                          your application.
+                          Are there other gems that provide similar functionality? Yes. Do some of them provide more
+                          flexibility? Yes. The point of this was to make installing and integrating a 30 second process.}
+
   spec.homepage      = "https://github.com/codelittinc/slacked"
   spec.license       = "MIT"
 
@@ -23,16 +28,17 @@ Gem::Specification.new do |spec|
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
 
-  spec.add_dependency "slack-notifier"
-  spec.add_dependency "dotenv"
+  spec.add_dependency 'slack-notifier'
+  spec.add_dependency 'dotenv'
   spec.add_dependency 'thor'
   spec.add_dependency 'httparty'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slacked
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - sean
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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
@@ -108,7 +122,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Notify slack when an action has been completed.
+description: |-
+  This is a super simple Slack integration for Rails. A use case for this would be to post
+                            a notification in Slack when a new User is created or a certain action has been taken in
+                            your application.
+                            Are there other gems that provide similar functionality? Yes. Do some of them provide more
+                            flexibility? Yes. The point of this was to make installing and integrating a 30 second process.
 email:
 - seathony@gmail.com
 executables: []
@@ -155,5 +174,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Notify slack when an action has been completed.
+summary: A super simple and easy way to send notifications to Slack from your Rails
+  application.
 test_files: []