nifty_alert 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 971e9c9279cccb56bd52e2dfda694b5fdb950f12
4
+ data.tar.gz: ce87d5ad520730c069ee21a39eeeec0bf0fe8000
5
+ SHA512:
6
+ metadata.gz: b3c78ed8f220addc192f759e7659a770bb93f28bd16b4640b83f5d12cd799972f25357f30307440c71ada7c736bfce7144f06282f95b8c6cb0d4090798205410
7
+ data.tar.gz: 36fe513042a5835610fb9007ee997aeca8778e5b5caad4485eccc3f62c8a7dcbc45f12fa999323808b209396d6c4711a01379f5e9f5d2d4ea897923b84ab3ac6
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.bundle
11
+ *.so
12
+ *.o
13
+ *.a
14
+ mkmf.log
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in nifty_alert.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2015 Scott Albertson
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,51 @@
1
+ # NiftyAlert
2
+
3
+ The gem will let you report when something reaches a threshold, such as a job
4
+ queue, and will intelligently alert whoever or whatever is configured to
5
+ receive alerts.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'nifty_alert'
13
+ ```
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install nifty_alert
18
+
19
+ ## Usage
20
+
21
+ Set up recipients, maybe in a Rails initializer. Recipients can be email
22
+ addresses or Slack channels.
23
+
24
+ ```ruby
25
+ NiftyAlert.recipients = [
26
+ "dude@example.com",
27
+ "https://mycompany.slack.com/services/hooks/slackbot?token=123abc4567def&channel=%23dev"
28
+ ]
29
+ ```
30
+
31
+ Report whatever you would like to monitor, such as the number of jobs in your
32
+ queue, along with a threshold:
33
+
34
+ ```ruby
35
+ class EmailJob
36
+ def before(job)
37
+ nifty_alert = NiftyAlert.new(:email)
38
+ nifty_alert.report(Delayed::Job.count, 1_000)
39
+ end
40
+
41
+ ...
42
+ end
43
+ ```
44
+
45
+ ## Contributing
46
+
47
+ 1. Fork it ( https://github.com/[my-github-username]/nifty_alert/fork )
48
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
49
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
50
+ 4. Push to the branch (`git push origin my-new-feature`)
51
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,3 @@
1
+ module NiftyAlert
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,25 @@
1
+ require "faraday"
2
+
3
+ class NiftyAlert
4
+ SERVICE_URL = "https://nifty-alert-production.herokuapp.com/alerts"
5
+
6
+ def initialize(id)
7
+ @id = id
8
+ end
9
+
10
+ def report(number, threshold)
11
+ if number > threshold
12
+ Faraday.post(SERVICE_URL, id: @id, recipients: self.class.recipients)
13
+ end
14
+ rescue
15
+ nil
16
+ end
17
+
18
+ def self.recipients=(*recipients)
19
+ @recipients = recipients
20
+ end
21
+
22
+ def self.recipients
23
+ @recipients
24
+ end
25
+ end
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'nifty_alert/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "nifty_alert"
8
+ spec.version = NiftyAlert::VERSION
9
+ spec.authors = ["Scott Albertson"]
10
+ spec.email = ["hello@scottalbertson.com"]
11
+ spec.summary = %q{Keep an eye on anything with a threshold, especially queues.}
12
+ spec.homepage = "https://github.com/salbertson/nifty-alert"
13
+ spec.license = "MIT"
14
+
15
+ spec.files = `git ls-files -z`.split("\x0")
16
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
17
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
18
+ spec.require_paths = ["lib"]
19
+
20
+ spec.add_development_dependency "bundler", "~> 1.7"
21
+ spec.add_development_dependency "rake", "~> 10.0"
22
+
23
+ spec.add_dependency "faraday", "~> 0.9.0"
24
+ end
metadata ADDED
@@ -0,0 +1,94 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: nifty_alert
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Scott Albertson
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-02-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: faraday
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.9.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.9.0
55
+ description:
56
+ email:
57
+ - hello@scottalbertson.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - Gemfile
64
+ - LICENSE.txt
65
+ - README.md
66
+ - Rakefile
67
+ - lib/nifty_alert.rb
68
+ - lib/nifty_alert/version.rb
69
+ - nifty_alert.gemspec
70
+ homepage: https://github.com/salbertson/nifty-alert
71
+ licenses:
72
+ - MIT
73
+ metadata: {}
74
+ post_install_message:
75
+ rdoc_options: []
76
+ require_paths:
77
+ - lib
78
+ required_ruby_version: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ required_rubygems_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ requirements: []
89
+ rubyforge_project:
90
+ rubygems_version: 2.4.5
91
+ signing_key:
92
+ specification_version: 4
93
+ summary: Keep an eye on anything with a threshold, especially queues.
94
+ test_files: []