rabbitmq-definition 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a5b69f6d3566cbe892e1e312ec964d419dc54f4
+  data.tar.gz: 1ccdad0c6b305f9dcbf568f72309ee7017bf4963
+SHA512:
+  metadata.gz: 6d92e50075d452a393ec82ffe38fef987b530406217166c752dece0f8fc49ca25624d7aac83e0cbd4861a41987a49f201d89606ca5a16a7cb33da0c647fc9a9e
+  data.tar.gz: 1bd7fe5b7b6a88f865301c49301c6e792a93bf571ac8938cd1d8945b55e69f888c131c3c523748b420437eb4e1d01220146139f60af412f886e9fc92df3fc7d8

data/.gitignore

@@ -0,0 +1 @@
+coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,181 @@
+PATH
+  remote: .
+  specs:
+    rabbitmq-definition (0.1.0)
+      colorize (~> 0.7)
+      highline (~> 1.7)
+      json (~> 1.8)
+      rabbitmq_http_api_client (>= 1.6)
+      rails (~> 4.0)
+      rake (~> 10.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    codeclimate-test-reporter (0.3.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    colorize (0.7.5)
+    columnize (0.8.9)
+    coveralls (0.8.0)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.23)
+      unf (>= 0.0.5, < 1.0.0)
+    effin_utf8 (1.0)
+    erubis (2.7.0)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    hashie (3.4.1)
+    highline (1.7.1)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.6.11)
+    json (1.8.2)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    minitest (5.5.0)
+    multi_json (1.11.0)
+    multipart-post (2.0.0)
+    netrc (0.10.3)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-byebug (1.3.2)
+      byebug (~> 2.7)
+      pry (~> 0.9.12)
+    rabbitmq_http_api_client (1.6.0)
+      effin_utf8 (~> 1.0.0)
+      faraday (~> 0.9.0)
+      faraday_middleware (~> 0.9.0)
+      hashie (~> 3.2)
+      multi_json (~> 1.9)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.6)
+      actionmailer (= 4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      activemodel (= 4.1.6)
+      activerecord (= 4.1.6)
+      activesupport (= 4.1.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.6)
+      sprockets-rails (~> 2.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.1)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    sprockets (3.0.0)
+      rack (~> 1.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    timecop (0.5.0)
+    tins (1.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.6)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 0.3)
+  coveralls (~> 0.8)
+  pry-byebug (~> 1.3)
+  rabbitmq-definition!
+  rspec (~> 3.2)
+  rspec-rails (~> 3.2)
+  timecop (= 0.5)
+  webmock (~> 1.20)

data/README.md

@@ -0,0 +1,57 @@
+# Introduction
+
+Manage RabbitMQ structure of your virtual hosts. Similary to ActiveRecord schema.rb or structure.sql that dumps the current database schema, rabbitmq-schema will dump a ```db/rabbitmq_structure.json``` timestamped file with the representation of the virtual hosts, queues, exchanges, bindings, users and permissions.
+
+## Installation
+
+Include this to your development/test Gemfile:
+
+```ruby
+  gem 'rabbitmq-schema'
+```
+
+## Usage
+
+Make sure you set an environment variable for the rabbitmq api (you can add the /api path or leave it out):
+```
+RABBITMQ_MANAGEMENT_URL=http://guest:guest@localhost:15672
+```
+
+### Create definition
+
+Create a new vhost and definition for your application. It will create the vhosts of your choice and add permissions to the user in the environment variable to those vhosts.
+```ruby
+  bundle exec rake rabbitmq:create          # It will ask you what vhosts to create the definition with
+  # or
+  bundle exec rake rabbitmq:create[/hats] # It will directly create a vhost named '/hats' 
+```
+
+### Drop definition
+
+Drop the vhosts in from your RabbitMQ instance and remove the file:
+```ruby
+  bundle exec rake rabbitmq:drop
+```
+
+### Dump definition
+Dump the definition of the vhosts in your RabbitMQ instance into definition file:
+```ruby
+  bundle exec rake rabbitmq:dump           # To dump the vhosts specificed in the existing definition file
+  # or 
+  bundle exec rake rabbitmq:dump[/hats] # To dump the specified vhost in a new definition few
+```
+
+### Load definition
+Load the vhosts definition from your definition file into your RabbitMQ instance:
+```ruby
+  bundle exec rake rabbitmq:load
+```
+
+### TODO
+
+- [ ] Make it Rails independent
+      - [ ] There's a few uses of Hash#except.
+      - [ ] There's a few uses of Hash#with_indifferent_access.
+      - [ ] The Engine class should only be loaded when Rails is present.
+      - [ ] User should be able to indicate the file path for the structure.
+      - [ ] Rails dependency should be removed from gemspec.

data/lib/rabbitmq-definition.rb

@@ -0,0 +1,46 @@
+require 'json'
+require 'rake'
+require 'uri'
+require 'colorize'
+require 'highline/import'
+require 'rabbitmq/http/client'
+require 'rabbitmq_definition/logger'
+require 'rabbitmq_definition/file_definition'
+require 'rabbitmq_definition/command'
+require 'rabbitmq_definition/create'
+require 'rabbitmq_definition/drop'
+require 'rabbitmq_definition/load'
+require 'rabbitmq_definition/dump'
+require 'rabbitmq_definition/engine'
+
+module RabbitMQ::Definition
+  def self.create(vhosts)
+    RabbitMQ::Definition::Create.run(client, verbose, vhosts)
+  end
+
+  def self.drop
+    RabbitMQ::Definition::Drop.run(client, verbose)
+  end
+
+  def self.dump(vhosts = nil)
+    RabbitMQ::Definition::Dump.run(client, verbose, vhosts)
+  end
+
+  def self.load
+    RabbitMQ::Definition::Load.run(client, verbose)
+  end
+
+  private
+
+  def self.client
+    RabbitMQ::HTTP::Client.new(rabbitmq_management_url)
+  end
+
+  def self.rabbitmq_management_url
+    ENV['RABBITMQ_MANAGEMENT_URL']
+  end
+
+  def self.verbose
+    Rake.verbose == true
+  end
+end

data/lib/rabbitmq_definition/command.rb

@@ -0,0 +1,28 @@
+module RabbitMQ::Definition
+  class Command
+    attr_accessor :client, :verbose
+
+    def self.run(*args)
+      new(*args).execute
+    end
+
+    def initialize(client, verbose)
+      @client = client
+      @verbose = !!verbose
+    end
+
+    def execute
+      raise NotImplementedError
+    end
+
+    protected
+
+    def uri_endpoint
+      @uri_endpoint ||= URI.parse(client.endpoint)
+    end
+
+    def user
+      @uri ||= uri_endpoint.user
+    end
+  end
+end

data/lib/rabbitmq_definition/create.rb

@@ -0,0 +1,35 @@
+module RabbitMQ::Definition
+  class Create < Command
+    def initialize(client, verbose, vhosts)
+      super(client, verbose)
+      @vhosts = (vhosts || []).compact
+      if @vhosts.empty?
+        @vhosts = ask("-> What vhosts do you want to create? (comma separated list)".yellow, lambda { |str| str.split(/,\s*/) })
+      end
+    end
+
+    def execute
+      if FileDefinition.exists?
+        Logger.error "Definition file already exists in #{FileDefinition.file_path}"
+      else
+        @vhosts.each do |vhost|
+          Logger.progress "Creating vhost '#{vhost}'" if verbose
+          client.create_vhost(vhost)
+          Logger.progress "Adding permissions for '#{user}' to vhost '#{vhost}'" if verbose
+          client.update_permissions_of(vhost, user, all_permissions)
+        end
+        Dump.run(client, false, @vhosts)
+      end
+    end
+
+    private
+
+    def all_permissions
+      {
+        :configure => ".*",
+        :write     => ".*",
+        :read       => ".*"
+      }
+    end
+  end
+end

data/lib/rabbitmq_definition/drop.rb

@@ -0,0 +1,36 @@
+module RabbitMQ::Definition
+  class Drop < Command
+    def execute
+      if !FileDefinition.exists?
+        Logger.error "No definition with vhosts exists"
+      else
+        if !agree("This will delete vhosts (#{vhost_names.join(',')}), continue? y/n".yellow)
+          Logger.error "Aborted by user"
+        else
+          delete_vhosts
+          Logger.progress "Removing definition..."
+          definition.destroy
+          Logger.success "Done"
+        end
+      end
+    end
+
+    private
+
+    def definition
+      @definition ||= FileDefinition.read
+    end
+
+    def vhost_names
+      @vhost_names ||= definition.vhosts.map { |vhost| vhost['name'] }
+    end
+
+    def delete_vhosts
+      vhost_names.each do |vhost|
+        Logger.progress "Deleting vhost '#{vhost}'..." if verbose
+        client.delete_vhost(vhost)
+      end
+    end
+
+  end
+end

data/lib/rabbitmq_definition/dump.rb

@@ -0,0 +1,41 @@
+module RabbitMQ::Definition
+  class Dump < Command
+    def initialize(client, verbose, vhosts = nil)
+      super(client, verbose)
+      @vhosts = vhosts || FileDefinition.read.vhosts.map { |vhost| vhost['name'] }
+    end
+
+    def execute
+      FileDefinition.new(filtered_list_definition).tap do |definition|
+        Logger.info definition.to_json if verbose
+        Logger.progress "Saving definition..."
+        definition.save
+        Logger.success "Done"
+      end
+    end
+
+    private
+
+    def filtered_list_definition
+      client.list_definitions.reduce({}) do |result, (key, value)|
+        if key.to_s == "vhosts"
+          value = @vhosts.map {|name| {'name' => name} }
+        elsif value.is_a?(Array)
+          value = filter_vhost_items(value)
+        end
+        result[key] = value
+        result
+      end
+    end
+
+    def filter_vhost_items(items)
+      items.reduce([]) do |array, item|
+        if !item.has_key?("vhost") || @vhosts.include?(item["vhost"])
+          array.push(item)
+        end
+        array
+      end
+    end
+
+  end
+end