consul_do 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a1c3d214b88585c7c81c78fd7c2259bb3649f90
+  data.tar.gz: 90c3338c79704716ff7846f3d82c410645ce4d10
+SHA512:
+  metadata.gz: b98f75d271bfb21af5d4bef9eb855c5573c31b41d058e8acd91684adc88e300fb38baf5652764a793d22ab2b4f6588100be56bd98eb7945dfcfebbcae3025413
+  data.tar.gz: a7b9091b66e273b8b8fc8d1aa743df4f6538fd53b0e712dff2eda242100eef54a7e23ba9bd1822f1ce7ffa95a2386786974800cea8f938f0c7fca3998d091f15

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Goldstar Events, Inc.
+
+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,55 @@
+# ConsulDo
+
+Consul key-based leader election and task coordinator.
+
+consul-do is a simple command-line tool that will return a 0 or 1 exit status
+depending on wether or not the host it's running on holds the lock for the consul
+key in question.  See https://www.consul.io/docs/guides/leader-election.html for a
+general overview of the consul leader election process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'consul_do'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install consul_do
+
+## Usage
+
+    $ consul-do --help
+    Usage: consul-do OPTIONS
+        -k, --key KEY                    Coordination key
+        -h, --consul-host HOST           Consul hostname
+        -p, --consul-port PORT           Consul port
+            --http_proxy http://HOST:PORT
+                                         Use supplied proxy instead of ENV
+
+    $ consul-do -k my_key && echo "do stuff"
+    do stuff
+
+    $ consul-do -k not_my_key && echo "don't do stuff"
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/[USERNAME]/consul_do.
+
+
+## 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,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "consul_do"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+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/consul_do.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'consul_do/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "consul_do"
+  spec.version       = ConsulDo::VERSION
+  spec.authors       = ["Jason Scholl"]
+  spec.email         = ["jscholl@goldstar.com"]
+
+  spec.summary       = %q{Consul key-based leader elections.}
+  spec.description   = %q{Consul key-based leader elections and task coordination.}
+  spec.homepage      = "https://github.com/goldstar/consul_do"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+end

data/exe/consul-do

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'consul_do'
+
+ConsulDo.elect.get_lock
+exit_code = (ConsulDo.elect.is_leader?) ? 0 : 1
+ConsulDo.elect.cleanup
+
+exit exit_code

data/lib/consul_do.rb

@@ -0,0 +1,35 @@
+require "consul_do/version"
+require "consul_do/elect"
+require "consul_do/config"
+require 'net/http'
+require 'json'
+
+module ConsulDo
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure!
+    @config = Config.new
+    yield config
+  end
+
+  def self.elect
+    @elect ||= Elect.new
+  end
+
+  def self.http_put(dest_url, data = nil)
+    uri = URI.parse(dest_url)
+    request = config.http_client.new(uri.host, uri.port)
+    log "http_put", request.send_request('PUT', "#{ [uri.path, uri.query].compact.join('?') }", data.to_json, {'Content-type' => 'application/json'})
+  end
+
+  def self.http_get(dest_url)
+    log "http_get", config.http_client.get_response(URI(dest_url))
+  end
+
+  def self.log(msg, retval)
+    puts [msg,retval.to_s].join(":\n  ") if config.verbose
+    retval
+  end
+end

data/lib/consul_do/config.rb

@@ -0,0 +1,48 @@
+require 'optparse'
+
+module ConsulDo
+  class Config
+
+    attr_accessor :key, :host, :port, :http_proxy, :verbose
+
+    def initialize
+      @host = 'localhost'
+      @port = '8500'
+      @key = 'consul_do'
+      @http_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
+      parse
+    end
+
+    def parse
+      OptionParser.new do |opts|
+        opts.banner = "Usage: consul-do OPTIONS"
+        opts.on("-k", "--key KEY=consul_do", "Coordination key"){ |v| self.key = v }
+        opts.on("-h", "--consul-host HOST=localhost", "Consul hostname"){ |v| self.host = v }
+        opts.on("-p", "--consul-port PORT=8500", "Consul port"){ |v| self.port = v }
+        opts.on("--http_proxy http://HOST:PORT", "Use supplied proxy instead of ENV "){ |v| self.http_proxy = v }
+        opts.on("-v", "--verbose", "Consul port"){ |v| self.verbose = v }
+      end.parse!
+    end
+
+    def proxy
+      begin
+        URI.parse(http_proxy)
+      rescue URI::InvalidURIError
+        URI::Generic.new(nil,nil,nil,nil,nil,nil,nil,nil,nil)
+      end
+    end
+
+    def session_name
+      "consul-do_#{key}_session"
+    end
+
+    def http_client
+      if ConsulDo.config.proxy.host && ConsulDo.config.proxy.port
+        ConsulDo.log "http_client", Net::HTTP.Proxy(ConsulDo.config.proxy.host, ConsulDo.config.proxy.port, ConsulDo.config.proxy.user, ConsulDo.config.proxy.password)
+      else
+        ConsulDo.log "http_client", Net::HTTP
+      end
+    end
+
+  end
+end

data/lib/consul_do/elect.rb

@@ -0,0 +1,100 @@
+require 'json'
+
+module ConsulDo
+  class Elect
+
+    def initialize()
+      yield ConsulDo.configure! if block_given?
+    end
+
+    def base_url
+      "http://#{ConsulDo.config.host}:#{ConsulDo.config.port}"
+    end
+
+    def get_key
+      url = "#{base_url}/v1/kv/service/#{ConsulDo.config.key}/leader"
+      response = ConsulDo.http_get(url)
+      case response
+      when Net::HTTPSuccess
+        ConsulDo.log "get_key", JSON.parse(response.body).first
+      else
+        ConsulDo.log "get_key", {}
+      end
+    end
+
+    def get_session_info(session_id)
+      url = "#{base_url}/v1/session/info/#{session_id}"
+      response = ConsulDo.http_get(url)
+      if response.body == "null"
+        raise "Invalid Session"
+      else
+        ConsulDo.log "get_session_info", JSON.parse(response.body).first
+      end
+    end
+
+    def create_session
+      url = "#{base_url}/v1/session/create"
+      response = ConsulDo.http_put(url, {"name" => ConsulDo.config.session_name})
+      case response
+      when Net::HTTPSuccess
+        ConsulDo.log "create_session", JSON.parse(response.body)['ID']
+      else
+        raise "Could not create session: #{response.code} - #{response.message} (#{response.body})"
+      end
+    end
+
+    def session
+      ConsulDo.log "session", @session ||= create_session
+    end
+
+    def delete_session(session_id = session)
+      url = "#{base_url}/v1/session/destroy/#{session_id}"
+      response = ConsulDo.http_put(url)
+      case response
+      when Net::HTTPSuccess
+        @session = nil 
+      else 
+        raise "Could not delete session: #{response.code} - #{response.message} (#{response.body})"
+      end
+
+      response
+    end
+
+    def delete_sessions
+      url = "#{base_url}/v1/session/node/#{get_session_info(session)['Node']}"
+      response = ConsulDo.http_get(url)
+      JSON.parse(response.body).each do |session_hash|
+        if block_given?
+          delete_session(session_hash['ID']) if yield session_hash['Name']
+        else
+          delete_session(session_hash['ID']) if session_hash['Name'] == ConsulDo.config.session_name
+        end
+      end
+    end
+
+    def get_lock
+      url = "#{base_url}/v1/kv/service/#{ConsulDo.config.key}/leader?acquire=#{session}"
+      response = ConsulDo.http_put(url, {'updated' => Time.now})
+      @session_has_lock = true if response.body == "true"
+    end
+
+    def session_has_lock?
+      @session_has_lock
+    end
+
+    def is_leader?
+      leader_session = get_key['Session']
+      if (leader_session &&
+          (session_has_lock? || get_session_info(leader_session)['Node'] == get_session_info(session)['Node']))
+        ConsulDo.log "is_leader?", true
+      else 
+        ConsulDo.log "is_leader?", false
+      end
+    end
+
+    def cleanup
+      delete_session unless session_has_lock?
+    end
+
+  end
+end

data/lib/consul_do/version.rb

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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: consul_do
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Scholl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-09 00:00:00.000000000 Z
+dependencies:
+- !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: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: Consul key-based leader elections and task coordination.
+email:
+- jscholl@goldstar.com
+executables:
+- consul-do
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- consul_do.gemspec
+- exe/consul-do
+- lib/consul_do.rb
+- lib/consul_do/config.rb
+- lib/consul_do/elect.rb
+- lib/consul_do/version.rb
+homepage: https://github.com/goldstar/consul_do
+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.5
+signing_key: 
+specification_version: 4
+summary: Consul key-based leader elections.
+test_files: []