clustr 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWRlNjk2ZGY1YTM1OTA2YjI4MWJiMWM3YjI1Y2VlMzlhZmIxNjEzMw==
+  data.tar.gz: !binary |-
+    OWRhYzAwODI2ZGQxZjU1MjljZGEwYzEwMzlkNDI2YjUzNmY4YTE1Yg==
+SHA512:
+  metadata.gz: !binary |-
+    NzRiZDkzYjhhNzMwNWYxYzNlYjdiYWRiNTZlMGM5ZTFiMzhhYTU1M2FkNTdh
+    ZDQyMzc1NDA3ODFkOGMyZTc1YmM1MGIxZTVhZTZmYTI4YmM4YjY1OGQzN2Zj
+    Yzg4MTNlMTE4M2ZhZDYxNzMwNDVhN2ZmNmMxMDc1ZGMzZmZkZDE=
+  data.tar.gz: !binary |-
+    MjJmOGEzYWY5ZDQ3OTAwYjIyZDBkYTRiMDY4NTRhNWQwNWI1NDc4MDE2MzE4
+    OGY3NDllNTRiMjU3NTBhZjc0MjAxMjUxMDdlZDM5NTE5Yzc0ZTcwNGJmMTE0
+    ZWQwYjhlZWY4NDk1NDMwMDY1YzI5ZjFjM2YzZDc4ZTYyZGVhZTA=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+clustr

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.1.0
+- 2.0.0-p353
+- ruby-head
+notifications:
+  flowdock:
+    secure: TI1C6kvdJrMD7m4ImSvf9cU8+1UBrpzlcsfwu2Q+1MYyEz2eBP819eBVF6g/HQM1Z8KU/7ShCtDA2NJQZXn9HfSbT4pebaAcr7FnyEDuWB/38F6/kZdzG71G10SkaRi4kIp4CbaYovaYrO7simeVoYdtK5RWgxGWcnGML8ubL8Y=
+before_deploy:
+- yard doc
+deploy:
+- provider: s3
+  access_key_id: AKIAIQXC7KNC6CPV3RMA
+  bucket: clustr.koala.im
+  skip_cleanup: true
+  local-dir: doc
+  edge: true
+  region: eu-west-1
+  endpoint: s3-eu-west-1.amazonaws.com
+  on:
+    branch: master
+  secret_access_key:
+    secure: dNZcJd61mj56+nCkOHpmKt+hcwB3KLpvViRLYUKR4G5isgCfkPtoe8PeYx9y/BiNuP0dXGu/Ij7Wgl/BuPGdp6VeNecPZAjWhgsTSuHp7WFlax4WPBe3qdtYWkrws1Gy4vN5da4zN3sY8qWxnu+51t1Im5nibz/fxHnY9THV9q8=
+- provider: rubygems
+  on:
+    branch: master
+  api_key:
+    secure: Kkwrzg+2dJrrShwVceco8EEP8Kc9BsKvDWIK6pFrdalZRY4sDG7BC7phPOmQPW40Qvl9f3qaZFjpohN0/QLDlF48Zg2AUBGuKfWpQ7V+dTL7hd6ZewFEs/5vyoofEf7BkSE9NFrsuOymEtHH+MJjqY+aIFg4YrNRcoEvCFuEZRk=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 davidkelley
+
+MIT License
+
+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,31 @@
+# Clustr
+
+[![Coverage Status](https://coveralls.io/repos/davidkelley/clustr/badge.png)](https://coveralls.io/r/davidkelley/clustr) [![Build Status](https://travis-ci.org/davidkelley/clustr.svg?branch=master)](https://travis-ci.org/davidkelley/clustr) [![Code Climate](https://codeclimate.com/github/davidkelley/clustr.png)](https://codeclimate.com/github/davidkelley/clustr) [![Dependency Status](https://gemnasium.com/davidkelley/clustr.svg)](https://gemnasium.com/davidkelley/clustr)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clustr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clustr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/clustr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/clustr

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'clustr/cli'
+Clustr::CLI.start

data/clustr.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clustr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clustr"
+  spec.version       = Clustr::VERSION
+  spec.authors       = ["davidkelley"]
+  spec.email         = ["david.james.kelley@gmail.com"]
+  spec.summary       = %q{Ruby gem that enables EC2 instances to cluster together.}
+  spec.description   = %q{This gem uses Amazon SimpleDB and other adapters, to track namespaced attributes for instances that need to cluster together. It provides a simple CLI which can be used in conjunction with other shell commands. See examples/ for example Cloudformation Templates.}
+  spec.homepage      = "https://github.com/davidkelley/clustr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "aws-sdk"
+  spec.add_dependency "terminal-table"
+  spec.add_dependency "nokogiri", ">= 1.4.4"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'coveralls'
+end

data/lib/clustr/adapter/base.rb

@@ -0,0 +1,18 @@
+module Clustr
+  module Adapter
+    # Base class for all implemented Adapters.
+    class Base
+
+      attr_reader :key
+
+      # Initializes a new Adapter class and associates
+      # the unique key for this cluster to the @key
+      # variable. This key is required for all Adapters.
+      def initialize(options)
+        @key = options["key"]
+      end
+
+    end
+
+  end
+end

data/lib/clustr/adapter/simpledb.rb

@@ -0,0 +1,53 @@
+module Clustr
+  module Adapter
+    # Implements the SimpleDB adapter, which controls a cluster
+    # and its members through the usage of SimpleDB as a centralized,
+    # high-availability data store.
+    #
+    # SimpleDB is capable of storing unique node identifiers along
+    # with additional information that is to be associated with them.
+    class SimpleDB < Clustr::Adapter::Base
+
+      # Initializes a new SimpleDB Adapter class. If the domain
+      # that has been defined in the @key attribute does not exist,
+      # it will create it.
+      def initialize
+        super
+        sdb.domains.create(@key) unless domain.exists?
+      end
+
+      # Add a new node to the SimpleDB domain.
+      #
+      # @param [string] id Unique ID of the node to add.
+      # @param [integer] created timestamp of the node.
+      # @param [hash] properties additional properties to add for the node.
+      #
+      # @return [boolean] True if node was added successfully, false otherwise.
+      def add(id, created, properties = {})
+        item = domain.items[id]
+        properties.each { |k, v| item.attributes[k] = v }
+        item.attributes["joined"] = created
+        true
+      end
+
+      # Return an array of the unique identifiers for each node
+      # in the cluster.
+      #
+      # @return [array] an array containing the unique ids for each node.
+      def members
+        domain.items.collect(&:name)
+      end
+
+      private
+
+        def domain
+          sdb.domains[@key]
+        end
+
+        def sdb
+          @sdb ||= AWS::SimpleDB.new
+        end
+
+    end
+  end
+end

data/lib/clustr/adapter.rb

@@ -0,0 +1,53 @@
+require "clustr/adapter/base"
+
+require "clustr/adapter/simpledb"
+
+module Clustr
+  # Contains different adapters for controlling the
+  # underlying logic for determining current members
+  # and adding new members to a cluster through the
+  # usage of different technologies,
+  # such as {Clustr::Adapter::SimpleDB}.
+  module Adapter
+
+    # Instantiates and returns a new Adapter class
+    # which has been determined from the options hash
+    # that has been passed in.
+    #
+    # @example Initializing a new adapter
+    #   sdb = Clustr::Adapter.from_options({
+    #     "adapter" => "SimpleDB",
+    #     "key" => "foobar"
+    #   })
+    #
+    # @note The named adapter must equal the defined class name.
+    #
+    # @param [hash] options to use, must contain an "adapter" key.
+    #
+    # @return [object] An instantiated adapter object.
+    def self.from_options(options)
+      name = options["adapter"]
+      self[name].new(options)
+    end
+
+    # Return the constantized adapter class.
+    #
+    # @param [string] adapter to return.
+    #
+    # @return [class] The uninitialized Adapter, nil if undefined.
+    def self.[](adapter)
+      self.const_get adapter
+    end
+
+    # Determines if the named adapter that has been passed in
+    # is a defined and implemented Adapter.
+    #
+    # @param [string] adapter name
+    #
+    # @return [boolean] True if the Adapter is implemented, false otherwise.
+    def self.exists?(adapter)
+      self.const_defined? adapter
+    end
+
+  end
+end

data/lib/clustr/cli.rb

@@ -0,0 +1,94 @@
+require 'thor'
+require 'clustr'
+require 'terminal-table'
+
+require 'clustr/log'
+
+module Clustr
+  # Provides a Command Line Interface for the Launcher gem. See the method definitions
+  # for more information on its usage.
+  #
+  # @example Checking the version
+  #   launcher version
+  class CLI < Thor
+
+    package_name "Clustr"
+
+    class_option :access_key_id, :type => :string
+    class_option :secret_access_key, :type => :string
+    class_option :region, :type => :string, :default => "eu-west-1"
+
+    def initialize(*args)
+      super
+      # Commit command line options to general config
+      Clustr::Config(options)
+
+      # Set AWS Configuration if it has been passed in
+      config = ["access_key_id", "secret_access_key", "region"]
+      ::AWS.config(options.select { |k| config.include?(k) })
+      describe_aws_configuration
+    end
+
+    desc "version", "Displays the current version number of Clustr."
+    # Displays the current version of the installed Clustr gem on the command line.
+    # For more help on this command, use `clustr help version` from the command line.
+    def version
+      Log.info Clustr::VERSION
+    end
+
+    desc "join", "Insert this node into the cluster, along with any additional attributes."
+    method_option :clusters, :type => :array, :desc => "List of clusters this node should join."
+    method_option :id, :type => :string, :desc => "ID of the node joining the cluster.", :required => true
+    method_option :attributes, :type => :hash, :desc => "Additional attributes to store for this node", :default => {}
+    # Joins the node that this command is ran on, to a new, or previously existing cluster.
+    # For more help on this command, use `clustr help join` from the command line.
+    def join
+      node = Node.new Config[:id], Config[:attributes]
+      (Config[:clusters] || clusters.keys).each do |cluster|
+        if clusters.include?(cluster)
+          if clusters[cluster].add(node)
+            Log.ok "Joined cluster #{cluster}"
+          end
+        else
+          raise ArgumentError.new "Cluster #{cluster} not configured."
+        end
+      end
+    end
+
+    desc "list", "Output only the unique identifiers for each node in a list."
+    method_option :cluster, :type => :string, :desc => "The cluster to output nodes from.", :required => true
+    method_option :delimiter, :type => :string, :desc => "The delimiter to separate each node identifier with, defaults to space", :default => " "
+    def list
+      puts clusters[Config[:cluster]].members.join(Config[:delimiter])
+    end
+
+    private
+
+      def clusters
+        @clusters ||= ClusterCollection.new(Config::Clusters.configuration)
+      end
+
+      def aws_configuration
+        AWS.config.credentials
+      end
+
+      def aws_configured?
+        begin
+          aws_configuration
+        rescue
+          false
+        end
+      end
+
+      def describe_aws_configuration
+        if aws_configured?
+          config = aws_configuration
+          Log.info "AWS Region #{config[:region]}"
+          Log.info "AWS Access Key #{config[:access_key_id]}"
+        else
+          Log.warn "No AWS config detected."
+        end
+      end
+
+  end
+end

data/lib/clustr/cluster.rb

@@ -0,0 +1,57 @@
+module Clustr
+  # Represents a cluster that has been configured and initialized
+  # from the options passed into it. Each Cluster has an adapter,
+  # which is reponsible for determining the current members
+  # of a cluster, and adding new nodes.
+  class Cluster
+
+    attr_accessor :name
+
+    # Initializes a new Cluster from the options that
+    # are passed into it. Information about the adapter
+    # that this cluster should use is required.
+    #
+    # @example Instantiating a new Cluster
+    #   cluster = Clustr::Cluster.new "my_cluster", {
+    #     "adapter" => "SimpleDB",
+    #     "key" => "simpledb-domain-edfvw2031"
+    #   }
+    #
+    # @param [string] name of the cluster
+    # @param [hash] options to initialize the cluster with.
+    def initialize(name, options)
+      @name = name
+      @adapter = Clustr::Adapter.from_options(options)
+    end
+
+    # Return an array of the unique identifiers for each
+    # node within the cluster.
+    #
+    # @note This method only returns the ID's for each node,
+    #       not any accompanying attributes for the node.
+    #
+    # @return [array] Cluster members, node ID's
+    def members
+      @adapter.members
+    end
+
+    # Returns an array of {Node} objects. These nodes
+    # have been identified as members of this Cluster.
+    #
+    # @return [array] Array of {Node} objects.
+    def nodes
+      raise NotImplementedError.new
+    end
+
+    # Add a node to this cluster. Note that the node
+    # must have a compatible ID.
+    #
+    # @param [Node] node to add to this cluster.
+    #
+    # @return [boolean] True if successful, false otherwise
+    def add(node)
+      @adapter.add node.id, node.created, node.properties
+    end
+
+  end
+end

data/lib/clustr/cluster_collection.rb

@@ -0,0 +1,29 @@
+module Clustr
+  # Represents a collection of the current {Cluster}
+  # configurations. This class can handle initializing
+  # clusters that have been defined through
+  # {Clustr::Config::Clusters}.
+  #
+  # @note The key for each cluster is its name, ie. "rabbitmq"
+  class ClusterCollection < Hash
+
+    # Initializes a collection of {Cluster} instances,
+    # by looping through the configurations that have been
+    # passed in.
+    #
+    # @example Initializing a ClusterCollection
+    #   config = {
+    #     "rabbitmq" => {
+    #       "adapter" => "SimpleDB",
+    #       "key" => "my-simpledb-domain"
+    #     }
+    #   }
+    #   clusters = ClusterCollection.new(config)
+    def initialize(configurations = {})
+      configurations.each do |name, config|
+        self[name] = Clustr::Cluster.new(name, config)
+      end
+    end
+
+  end
+end

data/lib/clustr/config/clusters.rb

@@ -0,0 +1,56 @@
+module Clustr
+  module Config
+    # Handles determining the configuration for clusters that are
+    # present on the machine. Note that configurations should
+    # be defined in "~/.clustr".
+    class Clusters < Hash
+
+      # Determines if there are any configured clusters.
+      #
+      # @return [boolean] True if one or more configuration
+      #                   are present, false otherwise.
+      def self.configured?
+        !configuration.empty?
+      end
+
+      # Returns the configuration for the clusters that have been
+      # defined inside the "~/.clustr/" folder. Note that the
+      # filename for each configuration, becomes the determined
+      # name for that cluster.
+      #
+      # @return [hash] A hash of the clusters and their accompanying
+      #                configuration (including the adapter and key).
+      def self.configuration
+        clusters ||= self.new
+
+        config_files.each do |file|
+          cluster = Pathname.new(file).basename.to_s
+          clusters[cluster] = {}
+          File.open(file, 'r') do |fh|
+            fh.each_line do |line|
+              key, val = line.strip.split(%r(\s*=\s*))
+              clusters[cluster][key] = val if key && val
+            end
+          end
+        end
+
+        clusters
+      end
+
+      private
+
+        @@path = File.expand_path("~/.clustr")
+
+        def self.config_files
+          if Dir.exists?(@@path)
+            entries = Dir.entries(@@path)
+            entries = entries - [".", ".."]
+            entries.collect { |e| [@@path,e].join("/") }
+          else
+            []
+          end
+        end
+
+    end
+  end
+end

data/lib/clustr/config.rb

@@ -0,0 +1,71 @@
+require 'clustr/config/clusters'
+
+module Clustr
+
+  # Adds configuration values to the current static instance of Clustr.
+  #
+  # @overload self.Config(config={})
+  # @param [Hash] config of keys and values to add.
+  def self.Config(config={})
+    config.each do |key, value|
+      Clustr::Config[key] = value
+    end
+  end
+
+  # Controls all configuration settings for the Clustr gem.
+  # @note This module should be accessed from within a static context.
+  module Config
+
+    # Retrieves values for the provided keys.
+    # @note Keys not present within the configuration will be omitted from the returned hash.
+    #
+    # @example Guided Usage
+    #   Clustr::Config.select(:a, :b, :c, :d)
+    #
+    # @param [Splat] args of the key value pairs to retrieve.
+    # @return [Hash] a hash of the keys present within configuration.
+    def self.select(*args)
+      @@_.select { |key| args.include?(key) }
+    end
+
+    # Accesses {Clustr::Config} as an array of key-based values.
+    #
+    # @example Retrieve a singular key using a symbol
+    #   Clustr::Config[:a]
+    # @example Retrieve a singular key using a string
+    #   Clustr::Config["a"]
+    #
+    # @param [Symbol] key of the value to retrieve.
+    # @return [Mixed, Nil] Will return the value of the key or nil.
+    def self.[](key)
+      @@_[key.to_sym]
+    end
+
+    # Sets or modifies a key and value within the current configuration state.
+    #
+    # @example Usage
+    #   Clustr::Config[:a] = "hello world!"
+    #
+    # @param [Symbol] key of the value to set.
+    # @param [Mixed] value of the element.
+    # @return [Mixed] the new value of the element.
+    def self.[]=(key,value)
+      @@_[key.to_sym] = value
+    end
+
+    # Removes a key from the current configuration state.
+    #
+    # @example Usage
+    #   Clustr::Config.delete!(:one, :or, :more, :keys)
+    #
+    # @param [Symbol] keys of the values to delete.
+    # @return [Hash] the values that have been deleted
+    def self.delete!(*keys)
+      keys.each { |k| @@_.delete(k.to_sym) }
+    end
+
+    private
+      @@_ = {}
+
+  end
+end

data/lib/clustr/log.rb

@@ -0,0 +1,43 @@
+require "logger"
+
+module Clustr
+  # The Log class provides a static interface to output text to STDOUT.
+  # It provides helpful messages types such as debug, error and ok. On
+  # most command line interfaces, {Clustr::Log} will also output text
+  # from various messages types in an appropriate color.
+  #
+  # @example Sending a log message
+  #   Clustr::Log.fatal "My fatal error is", exception.class.name
+  class Log
+
+    %w(debug error info warn fatal ok).each do |type|
+      define_singleton_method(type) do |*msgs|
+        @@log.send(type, *msgs.join(' '))
+      end
+    end
+
+    # Print an OK log message using a concatenation of various strings
+    # that have been passed in.
+    #
+    # @example Sending an OK Message
+    #   Clustr::Log.ok "Hello", username # => "Hello David"
+    def self.ok(*msgs)
+      print format_msg("OK", *msgs.join(' ')), :ok
+    end
+
+    protected
+
+      def self.format_msg(severity, msg, datetime=Time.now)
+        "[#{datetime}] [#{severity}]: #{msg}\n"
+      end
+
+    private
+
+      @@log = Logger.new(STDOUT)
+
+      @@log.formatter = proc { |severity, datetime, progname, msg|
+        format_msg severity, msg, datetime
+      }
+
+  end
+end