hey_you 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0c018de345da36b48230e5112994e6a66ecb5989
4
+ data.tar.gz: 70d3e962be350ce484ecf3a72b4ce997c645a0c6
5
+ SHA512:
6
+ metadata.gz: 6b03ee0fa70c91c3b232149355e67ea56cc8088cee65592be75ed7016b242d56284a6d41dd1e4ffb97aac750b7c839dff0b796b890b0e1a386bbe7d2a44f284f
7
+ data.tar.gz: e23934a28526f206e72c0208342e3ad9d46db33058337663814519caaea8fd9a33cdbfe5941a590b9f7a27c4882c6f5f66f463a2d619de084bb919e3370cd514
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,7 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ before_install: gem install bundler -v 1.10.6
5
+
6
+ before_script:
7
+ - psql -c 'create database hey_you_test;' -U postgres
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in hey_you.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 schneems
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,105 @@
1
+ # HeyYou
2
+
3
+ [![Build Status](https://travis-ci.org/schneems/hey_you.svg?branch=master)](https://travis-ci.org/schneems/hey_you)
4
+
5
+ Use postgres to [LISTEN/NOTIFY](http://www.postgresql.org/docs/9.1/static/sql-notify.html) to trigger custom events.
6
+
7
+ ## Why?
8
+
9
+ Let's say you've got a fleet of machines running code, you only want to trigger a custom event on all of them or one of them. With `HeyYou` it is super easy. What kind of event? Maybe it is for debugging or maybe it is for housekeeping. For example you could take a heap dump off of a running server and upload it to S3 using this library.
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ ```ruby
16
+ gem 'hey_you'
17
+ ```
18
+
19
+ And then execute:
20
+
21
+ $ bundle
22
+
23
+ Or install it yourself as:
24
+
25
+ $ gem install hey_you
26
+
27
+ ## Usage
28
+
29
+ Somewhere in your code you can run:
30
+
31
+ ```ruby
32
+ HeyYou.new.listen do |payload|
33
+ puts "Hey I got a message: #{payload}"
34
+ end
35
+ ```
36
+
37
+ This will spin up a new thread and periodically check for a notification, this won't block execution by default.
38
+
39
+ Then in another console, you can run:
40
+
41
+ ```ruby
42
+ HeyYou.new.notify("sup")
43
+ ```
44
+
45
+ When your listening process gets the message it will print out
46
+
47
+ ```ruby
48
+ "Hey I got a message: sup"
49
+ ```
50
+
51
+ By default all listens and notifies happen on the same channel. If you want you can specify a different channel
52
+
53
+ ```ruby
54
+ HeyYou.new(channel: "new_channel_name").listen do |payload|
55
+ puts "Hey I got a message: #{payload}"
56
+ end
57
+ ```
58
+
59
+ It is important to note that you need to notify against the same name.
60
+
61
+ ```ruby
62
+ HeyYou.new(channel: "new_channel_name").notify("sup")
63
+ ```
64
+
65
+ By default the background thread wakes up every 60 seconds and waits 0.1 seconds to see if there is a message. You can customize this behavior using `sleep` and `ttl`. So to have it check every 10 seconds, and not wait at all you could run
66
+
67
+ ```ruby
68
+ HeyYou.new(ttl: 1, sleep: 10).listen do |payload|
69
+ puts "Hey I got a message: #{payload}"
70
+ end
71
+ ```
72
+
73
+ A lower sleep will decrease delay between sending and receiving messages but will decrease overall program performance.
74
+
75
+ ## Connection
76
+
77
+ By default HeyYou assumes you're using Active Record and already have a connection configured. If you want to use a different ORM, you'll need to provide HeyYou with an object that responds to `exec` that executes arbitrary SQL and a method `wait_for_notify` that accepts `ttl`, `sleep` and takes a block.
78
+
79
+ You can configure your connection manually
80
+
81
+ ```ruby
82
+ HeyYou.new(connection: my_custom_object)
83
+ ```
84
+
85
+ Or you can set it globally
86
+
87
+ ```ruby
88
+ HeyYou::DEFAULT_CONNECTION = my_custom_object
89
+ ```
90
+
91
+ ## Development
92
+
93
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
94
+
95
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
96
+
97
+ ## Contributing
98
+
99
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hey_you. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
100
+
101
+
102
+ ## License
103
+
104
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
105
+
@@ -0,0 +1,7 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
7
+ task :test => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "hey_you"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'hey_you/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "hey_you"
8
+ spec.version = HeyYou::VERSION
9
+ spec.authors = ["schneems"]
10
+ spec.email = ["richard.schneeman@gmail.com"]
11
+
12
+ spec.summary = %q{Use postgres to trigger custom events}
13
+ spec.description = %q{Trigger custom events with postgres}
14
+ spec.homepage = "https://github.com/schneems/hey_you"
15
+ spec.license = "MIT"
16
+
17
+
18
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "pg", ">= 0.15"
24
+ spec.add_development_dependency "activerecord", ">= 3"
25
+ spec.add_development_dependency "bundler", "~> 1.10"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rspec"
28
+ end
@@ -0,0 +1,44 @@
1
+ require "hey_you/version"
2
+
3
+ class HeyYou
4
+ DEFAULT_CHANNEL = "hey_you_default_channel"
5
+ DEFAULT_CONNECTION_CONNECTOR = Proc.new do
6
+ if defined?(DEFAULT_CONNECTION)
7
+ DEFAULT_CONNECTION
8
+ elsif defined?(ActiveRecord::Base)
9
+ ActiveRecord::Base.connection.raw_connection
10
+ else
11
+ false
12
+ end
13
+ end
14
+
15
+ attr_reader :channel
16
+ def initialize(ttl: 0.1, sleep: 60, channel: DEFAULT_CHANNEL, connection: DEFAULT_CONNECTION_CONNECTOR.call)
17
+ raise "The new method does not take a block, perhaps you meant to call the listen method?" if block_given?
18
+ @ttl = ttl
19
+ @sleep = sleep
20
+ @channel = channel
21
+ @raw_connection = connection
22
+ end
23
+
24
+ def listen(&block)
25
+ raise "No block given" unless block
26
+ @raw_connection.exec "LISTEN #{channel}"
27
+
28
+ @thread = Thread.new do
29
+ while true do
30
+ sleep @sleep
31
+
32
+ @raw_connection.wait_for_notify(@ttl) do |channel_sent, pid, payload|
33
+ block.call(payload) if channel_sent == self.channel
34
+ end
35
+ end
36
+ end
37
+ end
38
+
39
+ def notify(payload)
40
+ message = "NOTIFY #{channel}, '#{payload}'"
41
+ puts message
42
+ @raw_connection.exec(message)
43
+ end
44
+ end
@@ -0,0 +1,3 @@
1
+ class HeyYou
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,127 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: hey_you
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - schneems
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-11-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: pg
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0.15'
27
+ - !ruby/object:Gem::Dependency
28
+ name: activerecord
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '3'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.10'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.10'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: Trigger custom events with postgres
84
+ email:
85
+ - richard.schneeman@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - hey_you.gemspec
101
+ - lib/hey_you.rb
102
+ - lib/hey_you/version.rb
103
+ homepage: https://github.com/schneems/hey_you
104
+ licenses:
105
+ - MIT
106
+ metadata: {}
107
+ post_install_message:
108
+ rdoc_options: []
109
+ require_paths:
110
+ - lib
111
+ required_ruby_version: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: '0'
116
+ required_rubygems_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ requirements: []
122
+ rubyforge_project:
123
+ rubygems_version: 2.4.5.1
124
+ signing_key:
125
+ specification_version: 4
126
+ summary: Use postgres to trigger custom events
127
+ test_files: []