holy_cow 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +15 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +49 -0
- data/Rakefile +1 -0
- data/holy_cow.gemspec +25 -0
- data/lib/holy_cow/kernel.rb +5 -0
- data/lib/holy_cow/mailer.rb +11 -0
- data/lib/holy_cow/version.rb +3 -0
- data/lib/holy_cow.rb +27 -0
- data/template/notification.html.erb +9 -0
- metadata +98 -0
checksums.yaml
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
!binary "U0hBMQ==":
|
3
|
+
metadata.gz: !binary |-
|
4
|
+
M2RhODkxNTY5NjlkYzdhOTZkMTczYmQyODlmMzI0Njg0NjhjYTVjYQ==
|
5
|
+
data.tar.gz: !binary |-
|
6
|
+
ODMwMmIyN2RhYTIxZDUzYjhhOTZlNWIyZGFlMzdmZTY0NmE3ZTVkMA==
|
7
|
+
SHA512:
|
8
|
+
metadata.gz: !binary |-
|
9
|
+
ODdiYjVkZGJkZDA2YzczZGVlODkxODcxMzUzMjQzNjFlOTc2ZTVjNDViN2E3
|
10
|
+
ZjE0MTQyMDViMmQ0NTY5MTNlMDQ1YWNiZDUyNWI0Yzk0NWQ5NTIzNDBhMjM3
|
11
|
+
ZGEwYTA4NTg0NmFkYTQ2NDJiNDZlY2RlOTE3ZGE5YzI1MWUzMmM=
|
12
|
+
data.tar.gz: !binary |-
|
13
|
+
ZDUxYTQxMDNlMmNhY2QxODk1ZDY1YTBmNDUzNzkzNDI2ZmY3MjA2ZjYyY2E3
|
14
|
+
NDExZmYxNzk4NDQyZmJkMzk4MmI5YjhlMzBlY2NiMzJjNTQzZmViOGZhNzhm
|
15
|
+
ZGYxMTE3ZGM1N2E2MThmMzBhMjc4OWJjZmIxZjE2ZWEwMDQ2N2I=
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Brian Samson
|
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,49 @@
|
|
1
|
+
# HolyCow
|
2
|
+
|
3
|
+
Dead simple notification when people do things on your site
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'holy_cow'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install holy_cow
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
### Recipients
|
22
|
+
|
23
|
+
HolyCow.recipient "my@emailaddress.com"
|
24
|
+
HolyCow.recipients "me@email.com", "you@email.com"
|
25
|
+
|
26
|
+
### From Address
|
27
|
+
|
28
|
+
HolyCow.from_address "me@example.com"
|
29
|
+
|
30
|
+
### Sending notifications
|
31
|
+
|
32
|
+
Just call holy_cow with a subject line and you'll get an e-mail. You can pass extra parameters and they'll be included as well. Go nuts!
|
33
|
+
|
34
|
+
holy_cow "somebody actually clicked that button!"
|
35
|
+
holy_cow "a user changed their avatar", current_user
|
36
|
+
holy_cow "the database is down", ex.message
|
37
|
+
|
38
|
+
### SMTP configuration
|
39
|
+
|
40
|
+
HolyCow uses action_mailer, so it will use whatever e-mail sending you have configured or try and use sendmail/local delivery if you don't have anything set up.
|
41
|
+
|
42
|
+
|
43
|
+
## Contributing
|
44
|
+
|
45
|
+
1. Fork it ( http://github.com/<my-github-username>/holy_cow/fork )
|
46
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
47
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
48
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
49
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/holy_cow.gemspec
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'holy_cow/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "holy_cow"
|
8
|
+
spec.version = HolyCow::VERSION
|
9
|
+
spec.authors = ["Brian Samson"]
|
10
|
+
spec.email = ["brian@briansamson.com"]
|
11
|
+
spec.summary = "Dead Simple e-mail notification for developers"
|
12
|
+
spec.description = %q{holy_cow "I can't believe it's this easy to get notification about what's happening in my app."}
|
13
|
+
spec.homepage = "http://github.com/tenforwardconsulting/holy_cow"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "actionmailer"
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.5"
|
24
|
+
spec.add_development_dependency "rake"
|
25
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
require 'action_mailer'
|
2
|
+
require 'pp'
|
3
|
+
class HolyCow::Mailer < ActionMailer::Base
|
4
|
+
def notification(*args)
|
5
|
+
@subject = args.shift || "Somebody did something!"
|
6
|
+
template = File.join(File.dirname(__FILE__), "..", "..", "template", "notification.html.erb")
|
7
|
+
body = ERB.new(File.read(template))
|
8
|
+
@things = args || []
|
9
|
+
mail(from: HolyCow::from_address, to: HolyCow::recipients, subject: "[Holy Cow] #{@subject}", body: body.result(binding))
|
10
|
+
end
|
11
|
+
end
|
data/lib/holy_cow.rb
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
require "holy_cow/version"
|
2
|
+
require "holy_cow/kernel"
|
3
|
+
require "holy_cow/mailer"
|
4
|
+
|
5
|
+
module HolyCow
|
6
|
+
@@recipient_list = []
|
7
|
+
@@from_address = "noreply@example.com"
|
8
|
+
# Your code goes here...
|
9
|
+
def self.recipient(addr)
|
10
|
+
@@recipient_list << addr
|
11
|
+
end
|
12
|
+
|
13
|
+
def self.recipients(*args)
|
14
|
+
if (args)
|
15
|
+
@@recipient_list += args.flatten
|
16
|
+
end
|
17
|
+
@@recipient_list
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.from_address
|
21
|
+
@@from_address
|
22
|
+
end
|
23
|
+
|
24
|
+
def self.from_address=(addr)
|
25
|
+
@@from_address = addr
|
26
|
+
end
|
27
|
+
end
|
metadata
ADDED
@@ -0,0 +1,98 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: holy_cow
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Brian Samson
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-05-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: actionmailer
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ! '>='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ! '>='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ~>
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.5'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ~>
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.5'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ! '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ! '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: holy_cow "I can't believe it's this easy to get notification about what's
|
56
|
+
happening in my app."
|
57
|
+
email:
|
58
|
+
- brian@briansamson.com
|
59
|
+
executables: []
|
60
|
+
extensions: []
|
61
|
+
extra_rdoc_files: []
|
62
|
+
files:
|
63
|
+
- .gitignore
|
64
|
+
- Gemfile
|
65
|
+
- LICENSE.txt
|
66
|
+
- README.md
|
67
|
+
- Rakefile
|
68
|
+
- holy_cow.gemspec
|
69
|
+
- lib/holy_cow.rb
|
70
|
+
- lib/holy_cow/kernel.rb
|
71
|
+
- lib/holy_cow/mailer.rb
|
72
|
+
- lib/holy_cow/version.rb
|
73
|
+
- template/notification.html.erb
|
74
|
+
homepage: http://github.com/tenforwardconsulting/holy_cow
|
75
|
+
licenses:
|
76
|
+
- MIT
|
77
|
+
metadata: {}
|
78
|
+
post_install_message:
|
79
|
+
rdoc_options: []
|
80
|
+
require_paths:
|
81
|
+
- lib
|
82
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - ! '>='
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - ! '>='
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
requirements: []
|
93
|
+
rubyforge_project:
|
94
|
+
rubygems_version: 2.2.2
|
95
|
+
signing_key:
|
96
|
+
specification_version: 4
|
97
|
+
summary: Dead Simple e-mail notification for developers
|
98
|
+
test_files: []
|