elected 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09c82b9bd8412effb3d88ad09894e6c5d7739868
+  data.tar.gz: 44a5123b80fad1ca635b655855ee040855075565
+SHA512:
+  metadata.gz: 30fa980526ecc9f8d6280c7c22cd4143a317cb271622f613946a79ff1a71ad00897d013a90712742ec0b67bf7beba1699693ea8e12500333ff1de681bd3588a6
+  data.tar.gz: 3e72ef5c02f94b9269bd32f96f320689c565dc81cda4bd51b29b60fd1967f6c01b6429295eab57223e6653aad2560557f93d5bd1b897c45c27bb7cce820be9e1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+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.
+
+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.
+
+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.
+
+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.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+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

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elected.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Adrian Madrid
+
+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,80 @@
+# Elected - A ruby distributed leader election through Redis locks. 
+
+> Elect a leader out of many processes and run code only in one of your servers at a time.
+>
+> This library depends heavily on the [redlock](https://github.com/leandromoreira/redlock-rb) ruby gem to obtain distributed locks through Redis.
+
+Elected is a Spanglish-fluent gem so expect Spanish and English names all over. Pardon my French!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elected'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elected
+
+## Documentation
+
+[RubyDoc](http://www.rubydoc.info/gems/elected/frames)
+
+## Usage example
+
+```ruby
+  # Config your redis urls or use the default REDIS_URL environment variable by default.
+  Elected.redis_urls = ['redis://localhost:6379', 'redis://someotherhost:6379']
+  # Create a leader manager with a key and timeout (in milliseconds)
+  mgr = Elected::Senado.new 'my_app_name:stage', 30_000
+  # Are we the leaders?
+  mgr.leader?
+  => true
+  
+  # Then in some other app/shell
+  mgr = Elected::Senado.new 'my_app_name:stage', 30_000
+  mgr.leader?
+  => false
+  # But if we wait over 30 seconds
+  mgr.leader?
+  => true
+```
+
+Elected, like Redlock, works seamlessly with [redis sentinel](http://redis.io/topics/sentinel), which is supported in redis 3.2+. It also allows clients to set any other arbitrary options on the Redis connection, e.g. password, driver, and more.
+
+```ruby
+Elected.redis_urls= [ 'redis://localhost:6379', Redis.new(:url => 'redis://someotherhost:6379') ]
+Elected.electorado
+```
+
+## Run tests
+
+Make sure you have at least 1 redis instances up.
+
+    $ rake rspec
+
+## Disclaimer
+
+This code, like Redlock in which is based, implements an algorithm which is currently a proposal, it was not formally analyzed. Make sure to understand how it works before using it in your production environments. You can see discussion about this approach at [reddit](http://www.reddit.com/r/programming/comments/2nt0nq/distributed_lock_using_redis_implemented_in_ruby/).
+
+## 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/simple-finance/elected. 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.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'elected'
+
+E = Elected
+S = Elected::Senado
+
+require 'pry'
+ARGV.clear
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elected.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elected/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elected"
+  spec.version       = Elected::VERSION
+  spec.authors       = ['Adrian Madrid']
+  spec.email         = ['aemadrid@gmail.com']
+
+  spec.summary       = %q{Select and keep a leader through Redis locks.}
+  spec.description   = %q{Select a leader through a Redis lock and keep it for a time.}
+  spec.homepage      = "https://github.com/simple-finance/elected"
+  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_dependency 'redlock', '0.1.3'
+  spec.add_dependency 'pry'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'timecop'
+end

data/lib/elected/lider.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+module Elected
+  class Lider
+
+    attr_reader :info, :validity, :resource, :value, :created, :deadline, :diff
+
+    def initialize(info, timeout)
+      @info     = info
+      @validity = info[:validity]
+      @resource = info[:resource]
+      @value    = info[:value]
+      @created  = Time.now
+      @deadline = created + (timeout / 1000.0).to_i
+      @diff     = @deadline - @created
+    end
+
+    def current?
+      @deadline > Time.now
+    end
+
+    def to_s(type = :short)
+      case type
+        when :full
+          "#<#{self.class.name} " +
+            "resource=#{resource.inspect} " +
+            "value=#{value.inspect} " +
+            "validity=#{validity.inspect} " +
+            "deadline=#{deadline}" +
+            ">"
+        when :yaml
+          to_yaml
+        else
+          %{#<Elected::Lider|#{resource}:#{value[0, 8]}:#{validity}>}
+      end
+    end
+
+    alias :inspect :to_s
+
+  end
+end

data/lib/elected/senado.rb

@@ -0,0 +1,72 @@
+require 'thread'
+
+module Elected
+  class Senado
+
+    attr_accessor :key, :timeout
+
+    def initialize(key = nil, timeout = nil)
+      @key, @timeout = key, timeout
+    end
+
+    def key
+      @key || Elected.key
+    end
+
+    # In ms (milliseconds), defaults to 5 seconds
+    def timeout
+      @timeout || Elected.timeout
+    end
+
+    def leader
+      mutex.synchronize { get_leader || set_leader }
+    end
+
+    def leader?
+      !!leader
+    end
+
+    def release
+      return false unless @leader
+
+      Elected.electorado.unlock @leader.info if @leader.current?
+      @leader = false
+    end
+
+    def to_s
+      %{#<#{self.class.name} key=#{key.inspect} timeout=#{timeout} leader?=#{leader?}>}
+    end
+
+    alias :inspect :to_s
+
+    private
+
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+    def get_leader
+      return false unless @leader
+      return @leader if @leader.current?
+
+      release
+    end
+
+    def set_leader
+      found = Elected.electorado.lock key, timeout
+      return false unless found
+
+      @leader = Lider.new found, timeout
+    end
+
+  end
+
+  extend self
+
+  def senado
+    @senate ||= Senado.new
+  end
+
+  senado
+
+end

data/lib/elected/version.rb

@@ -0,0 +1,3 @@
+module Elected
+  VERSION = "0.1.0"
+end

data/lib/elected.rb

@@ -0,0 +1,37 @@
+require 'elected/version'
+require 'redlock'
+
+module Elected
+
+  extend self
+
+  def redis_urls
+    @redis_urls || ENV['REDIS_URL'].split('|')
+  end
+
+  # Split strings by pipes to allow for one ENV['REDIS_URL'] to hold many urls
+  def redis_urls=(urls)
+    @redis_urls = Array(urls).flatten.
+      map { |x| x.is_a?(String) ? x.split('|') : x }.
+      flatten
+  end
+
+  def electorado
+    @electorado ||= ::Redlock::Client.new redis_urls
+  end
+
+  attr_writer :key, :timeout
+
+  def key
+    @key || 'elected'
+  end
+
+  # In ms (milliseconds), defaults to 5 seconds
+  def timeout
+    @timeout || 5_000
+  end
+
+end
+
+require 'elected/lider'
+require 'elected/senado'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: elected
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Madrid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Select a leader through a Redis lock and keep it for a time.
+email:
+- aemadrid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elected.gemspec
+- lib/elected.rb
+- lib/elected/lider.rb
+- lib/elected/senado.rb
+- lib/elected/version.rb
+homepage: https://github.com/simple-finance/elected
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Select and keep a leader through Redis locks.
+test_files: []