attention 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b48770e4d6245a630343d966765eac85af863ea0
+  data.tar.gz: 2be0077411ce85b73a2cf2f4aac3438dad9b657d
+SHA512:
+  metadata.gz: 48bfb49370698125f8cddac048e6fb7416377c146e26ec17ade58dd2ec182ec1758459dd1a94432267c1734ccbe10df74ee000a9ea754645ca54ac3f88947977
+  data.tar.gz: 3707fda7d1a9d014db0f4314ff0c8dd02929d4dff7efb1662cc289a371496d4539b6bc0d4d951f643d1d9c782093822de906eb4f8679256e903069ba5fd296fc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.2.3
+  - jruby-19mode
+before_install: gem install bundler -v 1.11.2
+services:
+  - redis-server
+jruby_before_script:
+  - bundle exec jbundle install

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at michael@zooniverse.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}){ |m| "spec/#{ m[1] }_spec.rb" }
+  watch('spec/spec_helper.rb'){ 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}){ 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Parrish
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Attention
+
+Redis-based server awareness for distributed applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attention'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attention
+
+## Usage
+
+
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/parrish/attention. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+task :default => :spec

data/attention.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attention/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'attention'
+  spec.version       = Attention::VERSION
+  spec.authors       = ['Michael Parrish']
+  spec.email         = ['michael@zooniverse.org']
+
+  spec.summary       = 'Redis-based server awareness'
+  spec.description   = 'Redis-based server awareness for distributed applications'
+  spec.homepage      = 'https://github.com/parrish/attention'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'redis', '~> 3'
+  spec.add_runtime_dependency 'redis-namespace', '~> 1.5'
+  spec.add_runtime_dependency 'connection_pool', '~> 2'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'attention'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/attention/connection.rb

@@ -0,0 +1,14 @@
+require 'redis'
+require 'redis-namespace'
+
+module Attention
+  module Connection
+    def self.new
+      connection = Redis.new url: Attention.options[:redis_url],
+          connect_timeout: Attention.options[:timeout],
+          timeout: Attention.options[:timeout]
+
+      Redis::Namespace.new Attention.options[:namespace], redis: connection
+    end
+  end
+end

data/lib/attention/instance.rb

@@ -0,0 +1,55 @@
+require 'socket'
+require 'attention/publisher'
+require 'attention/timer'
+
+module Attention
+  class Instance
+    attr_reader :id, :publisher
+
+    def initialize(ip: nil, port: nil)
+      @id = Attention.redis.call.incr('instances').to_s
+      @ip = ip
+      @port = port
+      @publisher = Publisher.new 'instance'
+    end
+
+    def publish
+      redis = Attention.redis.call
+      redis.setex "instance_#{ @id }", Attention.options[:ttl], JSON.dump(info)
+      publisher.publish added: info
+      heartbeat
+    end
+
+    def unpublish
+      return unless @heartbeat
+      Attention.redis.call.del "instance_#{ @id }"
+      publisher.publish removed: info
+      @heartbeat.stop
+      @heartbeat = nil
+    end
+
+    def info
+      { id: @id, ip: ip }.tap do |h|
+        h[:port] = @port if @port
+      end
+    end
+
+    private
+
+    def heartbeat
+      @heartbeat ||= Timer.new(heartbeat_frequency) do
+        Attention.redis.call.expire "instance_#{ @id }", Attention.options[:ttl]
+      end
+    end
+
+    def heartbeat_frequency
+      [1, Attention.options[:ttl] - 5].max
+    end
+
+    def ip
+      return @ip if @ip
+      address = Socket.ip_address_list.find &:ipv4_private?
+      @ip = address && address.ip_address
+    end
+  end
+end

data/lib/attention/publisher.rb

@@ -0,0 +1,26 @@
+module Attention
+  class Publisher
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def publish(value)
+      redis = Attention.redis.call
+      redis.publish key, payload_for(value)
+      yield redis if block_given?
+    end
+
+    def payload_for(value)
+      case value
+      when Array, Hash
+        JSON.dump value
+      else
+        value
+      end
+    rescue
+      value
+    end
+  end
+end

data/lib/attention/redis_pool.rb

@@ -0,0 +1,25 @@
+require 'redis'
+require 'redis-namespace'
+require 'connection_pool'
+
+module Attention
+  class RedisPool
+    attr_reader :pool
+
+    def self.instance
+      @instance ||= new
+      @pool ||= ->{ @instance.pool.with{ |redis| redis } }
+    end
+
+    private
+
+    def initialize
+      pool_config = {
+        size: Attention.options[:pool_size],
+        timeout: Attention.options[:timeout]
+      }
+
+      @pool = ConnectionPool.new(pool_config){ Connection.new }
+    end
+  end
+end

data/lib/attention/subscriber.rb

@@ -0,0 +1,43 @@
+require 'thread'
+require 'json'
+require 'attention/connection'
+require 'attention/publisher'
+
+module Attention
+  class Subscriber
+    attr_reader :key, :redis
+
+    class AlreadySubscribedError < StandardError; end
+
+    def initialize(key, &callback)
+      @key = key
+      @redis = Connection.new
+      subscribe &callback
+    end
+
+    def subscribe(&callback)
+      raise AlreadySubscribedError.new if @thread
+      @thread = Thread.new do
+        redis.subscribe(key) do |on|
+          on.message do |channel, payload|
+            data = JSON.parse(payload) rescue payload
+            if data == 'unsubscribe'
+              redis.unsubscribe
+            else
+              callback.call key, data
+            end
+          end
+        end
+      end
+    end
+
+    def publisher
+      @publisher ||= Publisher.new(key)
+    end
+
+    def unsubscribe
+      publisher.publish 'unsubscribe'
+      @thread = nil
+    end
+  end
+end

data/lib/attention/timer.rb

@@ -0,0 +1,41 @@
+require 'thread'
+
+module Attention
+  class Timer
+    attr_reader :frequency, :callback, :lock, :thread
+
+    def initialize(frequency, &callback)
+      @frequency = frequency
+      @callback = callback
+      @lock = Mutex.new
+      start
+    end
+
+    def start
+      @thread ||= Thread.new do
+        loop do
+          sleep @frequency
+          lock.synchronize do
+            callback.call
+          end
+        end
+      end
+    end
+
+    def started?
+      !!thread
+    end
+
+    def stop
+      return if stopped?
+      lock.synchronize do
+        thread.kill
+        @thread = nil
+      end
+    end
+
+    def stopped?
+      !started?
+    end
+  end
+end

data/lib/attention/version.rb

@@ -0,0 +1,3 @@
+module Attention
+  VERSION = '0.0.1'
+end

data/lib/attention.rb

@@ -0,0 +1,67 @@
+require 'redis'
+require 'attention/version'
+require 'attention/redis_pool'
+require 'attention/subscriber'
+require 'attention/instance'
+require 'attention/timer'
+
+module Attention
+  class << self
+    attr_accessor :options
+    attr_reader :instance
+  end
+
+  self.options = {
+    namespace: 'attention',                # Redis key namespace
+    ttl: 60,                               # Heartbeat TTL in seconds
+    redis_url: 'redis://localhost:6379/0', # Redis connection string
+    pool_size: 5,                          # Size of the publishing Redis pool
+    timeout: 5                             # Redis connection timeout
+  }
+
+  def self.redis
+    RedisPool.instance
+  end
+
+  def self.activate(ip: nil, port: nil)
+    return if @instance
+    @instance = Instance.new ip: ip, port: port
+    instance.publish
+  end
+
+  def self.deactivate
+    @instance.unpublish if @instance
+  end
+
+  def self.on_change(&callback)
+    Subscriber.new('instance') do |channel, change|
+      callback.call change, instances
+    end
+  end
+
+  def self.instances
+    resolve info_for instance_keys
+  end
+
+  def self.instance_keys
+    redis.call.keys 'instance_*'
+  end
+
+  def self.info_for(keys)
+    [].tap do |list|
+      redis.call.multi do |multi|
+        keys.each do |key|
+          list << multi.get(key)
+        end
+      end
+    end
+  end
+
+  def self.resolve(list)
+    list.map do |future|
+      JSON.parse future.value
+    end
+  end
+
+  at_exit{ deactivate }
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: attention
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Parrish
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+description: Redis-based server awareness for distributed applications
+email:
+- michael@zooniverse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attention.gemspec
+- bin/console
+- bin/setup
+- lib/attention.rb
+- lib/attention/connection.rb
+- lib/attention/instance.rb
+- lib/attention/publisher.rb
+- lib/attention/redis_pool.rb
+- lib/attention/subscriber.rb
+- lib/attention/timer.rb
+- lib/attention/version.rb
+homepage: https://github.com/parrish/attention
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Redis-based server awareness
+test_files: []