wave-box 0.3.1 → 0.3.2
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.
- data/README.md +51 -0
- data/lib/wave_box/version.rb +1 -1
- data/wave_box.gemspec +1 -0
- metadata +6 -4
data/README.md
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
# WaveBox
|
2
|
+
|
3
|
+
A redis-based notification system
|
4
|
+
|
5
|
+
## Example
|
6
|
+
|
7
|
+
require 'wave_box'
|
8
|
+
|
9
|
+
class User
|
10
|
+
include ::WaveBox::GenerateWave
|
11
|
+
include ::WaveBox::ReceiveWave
|
12
|
+
|
13
|
+
can_generate_wave :name => "message",
|
14
|
+
:redis => :wave_redis_instance,
|
15
|
+
:expire => 60 * 60 * 24 * 7, # One week
|
16
|
+
:max_size => 20,
|
17
|
+
:id => :wave_box_id
|
18
|
+
|
19
|
+
can_receive_wave :name => "message",
|
20
|
+
:redis => :wave_redis_instance,
|
21
|
+
:expire => 60 * 60 * 24 * 7, # One week
|
22
|
+
:max_size => 20,
|
23
|
+
:id => :wave_box_id
|
24
|
+
|
25
|
+
def wave_redis_instance
|
26
|
+
Redis.new # return a redis instance
|
27
|
+
end
|
28
|
+
|
29
|
+
def wave_box_id
|
30
|
+
object_id
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
sender = User.new
|
35
|
+
=> #<User:0x007f85631b9a50>
|
36
|
+
receiver = User.new
|
37
|
+
=> #<User:0x007f85631cf940>
|
38
|
+
|
39
|
+
# Send a wave from sender to receiver
|
40
|
+
sender.generate_message "hi", receiver
|
41
|
+
|
42
|
+
# Find all message waves in sender's outbox
|
43
|
+
sender.generated_message_after(0)
|
44
|
+
=> ["hi"]
|
45
|
+
# Find all message waves in receiver's inbox
|
46
|
+
receiver.received_message_after(0)
|
47
|
+
=> ["hi"]
|
48
|
+
|
49
|
+
## License
|
50
|
+
|
51
|
+
Ruby on Rails is released under the {MIT License}[http://www.opensource.org/licenses/MIT].
|
data/lib/wave_box/version.rb
CHANGED
data/wave_box.gemspec
CHANGED
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
|
|
17
17
|
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
18
18
|
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
19
19
|
s.require_paths = ["lib"]
|
20
|
+
s.licenses = "MIT"
|
20
21
|
|
21
22
|
# specify any dependencies here; for example:
|
22
23
|
# s.add_development_dependency "rspec"
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: wave-box
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3.
|
4
|
+
version: 0.3.2
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -13,7 +13,7 @@ date: 2012-11-26 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: redis
|
16
|
-
requirement: &
|
16
|
+
requirement: &70226620740240 !ruby/object:Gem::Requirement
|
17
17
|
none: false
|
18
18
|
requirements:
|
19
19
|
- - ! '>='
|
@@ -21,7 +21,7 @@ dependencies:
|
|
21
21
|
version: '0'
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
|
-
version_requirements: *
|
24
|
+
version_requirements: *70226620740240
|
25
25
|
description: A simple push style messaging based on redis
|
26
26
|
email:
|
27
27
|
- poga.bahamut@gmail.com
|
@@ -32,6 +32,7 @@ files:
|
|
32
32
|
- .gitignore
|
33
33
|
- Gemfile
|
34
34
|
- Guardfile
|
35
|
+
- README.md
|
35
36
|
- Rakefile
|
36
37
|
- lib/wave_box.rb
|
37
38
|
- lib/wave_box/box.rb
|
@@ -45,7 +46,8 @@ files:
|
|
45
46
|
- spec/wave_box/receive_wave_spec.rb
|
46
47
|
- wave_box.gemspec
|
47
48
|
homepage: ''
|
48
|
-
licenses:
|
49
|
+
licenses:
|
50
|
+
- MIT
|
49
51
|
post_install_message:
|
50
52
|
rdoc_options: []
|
51
53
|
require_paths:
|