rabbitmq_manager 0.1.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ff53ef51f95271af116e41fb5130d7f4843d825
+  data.tar.gz: d78078c29a5162f3a8b3a5786364b7950924509c
+SHA512:
+  metadata.gz: 98aced92ae24e542932c21bcb419a6d467467af63615d3c9bff6b5d8e4de9d5a3f8b1e2b067d32a96664177239edef15c0638c42a517ead3ca7191789d3b7d0c
+  data.tar.gz: a88cb6aae684c57bbbcc5ce789a911629152cfc49f2cf12774299d36f2171a181f30d155f3871673cfa2b66d48b4775fd8c476c28f369e5a1a82810293bbffe9

data/README.md

@@ -1,8 +1,8 @@
 # RabbitMQ Manager
 
-A wrapper for RabbitMQs management HTTP API. 
+A wrapper for RabbitMQs management HTTP API.
 
-[More information on the API](http://hg.rabbitmq.com/rabbitmq-management/raw-file/rabbitmq_v2_7_1/priv/www/api/index.html)
+[More information on the API](http://hg.rabbitmq.com/rabbitmq-management/raw-file/rabbitmq_v3_2_4/priv/www/api/index.html)
 
 ## Installation
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-    rmq = RabbitMQManager.new 'http://guest:guest@localhost:55672' 
+    rmq = RabbitMQManager.new 'http://guest:guest@localhost:15672'
     rmq.overview #=> cluster overview
 
     rmq.nodes #=> array of nodes

data/lib/rabbitmq_manager.rb

@@ -6,7 +6,7 @@ require 'uri'
 class RabbitMQManager
   def initialize(url, ssl_options = nil)
     opts = {
-      :headers => { 
+      :headers => {
         'accept' => 'application/json',
         'Content-Type' => 'application/json'
       },
@@ -25,6 +25,41 @@ class RabbitMQManager
     @conn.get(url :overview).body
   end
 
+  def connections
+    @conn.get(url :connections).body
+  end
+
+  def channels
+    @conn.get(url :channels).body
+  end
+
+  def policies(vhost = '')
+    @conn.get(url :policies, vhost).body
+  end
+
+  def policy_get(vhost, name)
+    @conn.get(url :policies, vhost, name).body
+  end
+
+  def policy_create(vhost, name, pattern, definition, opts = nil)
+    valid = ["ha-mode", "ha-params", "ha-sync-mode", "alternate-exchange", "dead-letter-exchange","dead-letter-routing-key", "message-ttl", "expires", "max-length", "federation-upstream-set"]
+    definition.keys.each { | key |
+      if !valid.include?(key)
+        raise "The definition key '#{key}' is not valid, try these #{valid}"
+      end
+    }
+    policy = {
+      pattern: pattern,
+      definition: definition
+    }.merge(opts || {})
+
+    @conn.put(url(:policies, vhost, name), policy).body
+  end
+
+  def policy_delete(vhost, name)
+    @conn.delete(url :policies, vhost, name).body
+  end
+
   def queues(vhost = '')
     @conn.get(url :queues, vhost).body
   end
@@ -76,8 +111,8 @@ class RabbitMQManager
 
   def user_create(name, password, tags = '')
     @conn.put(url(:users, name), {
-      :password => password, 
-      :tags => tags 
+      :password => password,
+      :tags => tags
     }).body
   end
 
@@ -88,7 +123,7 @@ class RabbitMQManager
   def user_set_permissions(name, vhost, configure, write, read)
     @conn.put(url(:permissions, vhost, name), {
       :configure => configure,
-      :write => write, 
+      :write => write,
       :read => read
     }).body
   end

data/lib/rabbitmq_manager/version.rb

@@ -1,3 +1,3 @@
 class RabbitMQManager
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/rabbitmq_manager.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'faraday'
   gem.add_runtime_dependency 'faraday_middleware'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'simple_cov'
+  gem.add_development_dependency 'simplecov'
 end

data/spec/rabbitmq_manager_spec.rb

@@ -1,93 +1,184 @@
 require './spec/spec_helper'
 require './lib/rabbitmq_manager'
 
-describe RabbitMQManager do
-  let(:manager) { 
-    RabbitMQManager.new 'http://guest:guest@localhost:55672' 
-  }
-
-  context '#overview' do
-    subject { manager.overview }
-    it { should be_instance_of Hash }
+def make_name(name_prefix)
+  name_prefix + '-' + rand(1000).to_s
+end
+
+RSpec.describe RabbitMQManager do
+  before(:all) do
+    @rspec_user = 'guest'
+    rspec_password = 'guest'
+    @manager = RabbitMQManager.new "http://#{@rspec_user}:#{rspec_password}@localhost:15672"
+  end
+
+  it 'the overview method provides a Hash' do
+    expect(@manager.overview()).to be_a Hash
   end
 
-  context '#nodes' do 
-    subject { manager.nodes }
-    it { should have(1).things }
+  it 'there will be at least one connection' do
+    items = @manager.connections()
+    expect(items.length).to be >= 1
   end
 
-  context '#queues' do
-    subject { manager.queues }
-    it { should be_instance_of Array }
+  it 'there will be at least one channel' do
+    items = @manager.channels()
+    expect(items.length).to be >= 1
   end
 
-  context '#queues(vhost)' do
-    subject { manager.queues('/') }
-    it { should be_instance_of Array }
+  describe 'node discovery' do
+    it 'there will be at least one node' do
+      items = @manager.nodes()
+      expect(items.length).to be >= 1
+    end
+    it 'the list of nodes is a Hash' do
+        hostname = `hostname`.chop
+        item = @manager.node("rabbit@#{hostname}")
+        expect(item).to be_a Hash
+    end
   end
 
-  context '#queue' do
-    let(:queue) { 'q1' }
-    before { manager.queue_create('/', queue) }
-    subject { manager.queue('/', queue) }
-    it { should be_instance_of Hash }
-    it { subject['name'].should == queue }
-    after { manager.queue_delete('/', queue) }
+  it 'all queues can be listed as an Array' do
+    items = @manager.queues()
+    expect(items).to be_an Array
   end
 
-  context '#node' do
-    let(:hostname) { `hostname -s`.chop }
-    subject { manager.node("rabbit@#{hostname}") }
-    it { should be_instance_of Hash }
+  it 'queues can be listed per vhost as an Array' do
+    items = @manager.queues('/')
+    expect(items).to be_an Array
   end
 
-  context 'when administering users and vhosts' do
-    let(:user)  { 'user1' }
-    let(:passwd)  { 'rand123' }
-    let(:vhost) { 'vh1' }
+  describe 'queue manipulation' do
+    queue = make_name 'rspec-q1'
+    vhost = '/'
 
-    before do
-      manager.user_create user, passwd
-      manager.vhost_create vhost
+    after(:all) do
+      @manager.queue_delete(vhost, queue)
     end
 
-    after do
-      manager.user_delete user
-      manager.vhost_delete vhost
+    it 'queues can be created and removed' do
+      @manager.queue_create(vhost, queue)
+      items = @manager.queue(vhost, queue)
+      expect(items).to be_a Hash
+      expect(items['name']).to eq(queue)
     end
-    
-    it 'can list vhosts' do
-      manager.vhosts.should have_at_least(2).things
+  end
+
+  describe 'when administering users and vhosts' do
+    user = make_name 'rspec-user'
+    passwd = make_name ''
+    vhost = 'rspec-vh'
+
+    before(:all) do
+      @manager.user_create user, passwd
+      @manager.vhost_create vhost
+    end
+
+    after(:all) do
+      @manager.user_delete user
+      @manager.vhost_delete vhost
+    end
+
+    it 'list vhosts' do
+      expect(@manager.vhosts.length).to be >= 2
     end
 
     it 'can view one vhost' do 
-      manager.vhost(vhost)['name'].should == vhost
+      expect(@manager.vhost(vhost)['name']).to eq(vhost)
     end
 
     it 'can list users' do 
-      manager.users.should have_at_least(2).things
+      expect(@manager.users.length).to be >= 2
     end
 
     it 'can view one user' do 
-      manager.user(user)['name'].should == user
+      expect(@manager.user(user)['name']).to eq(user)
     end
 
     it 'cannot view an non existing user' do
-      lambda {
-        manager.user('foo')
-      }.should raise_error Faraday::Error::ResourceNotFound
-    end
-
-    context 'permissions' do
-      before  { manager.user_set_permissions(user, vhost, '.*', '.*', '.*') }
-      subject { manager.user_permissions(user) }
-      it { subject.should be_instance_of Array }
-      context 'for first element' do
-        subject { manager.user_permissions(user).first }
-        it('has name') { subject['user'] == user }
-        it('has read permissions') { subject['read'] == '.*' }
-        it('has write permissions') { subject['write'] == '.*' }
+      expect {
+        @manager.user('foo')
+      }.to raise_error Faraday::Error::ResourceNotFound
+    end
+
+    describe 'when administering users and vhosts' do
+      users = []
+      first = nil
+
+      before(:all) do
+        @manager.user_set_permissions(user, vhost, '.*', '.*', '.*')
+        users = @manager.user_permissions(user)
+        first = users.first
+      end
+      
+      it 'user permissions is an Array' do
+        expect(users).to be_an Array
+      end
+
+      it 'can read first users name' do
+        expect(first['user']).to eq(user)
+      end
+
+      it 'first users has read permissions' do
+        expect(first['read']).to eq('.*')
+      end
+
+      it 'first users has write permissions' do
+        expect(first['write']).to eq('.*')
       end
+
     end
+
   end
-end
+
+  describe 'high availability policies can be administered' do
+    vhost = make_name 'rspec-vh'
+
+    before(:each) do
+      @manager.vhost_create(vhost)
+      @manager.user_set_permissions(@rspec_user, vhost, '.*', '.*', '.*')
+    end
+
+    after(:each) do
+      @manager.vhost_delete(vhost)
+    end
+
+    it 'initially a specific vhost has no policies, the Array is empty' do
+      policies = @manager.policies(vhost)
+      expect(policies).to be_an Array
+      expect(policies.length).to eq(0)
+    end
+
+    it 'Creating a basic policy requires a name, pattern and a definition' do
+      name = make_name 'rspec-policy'
+      @manager.policy_create(vhost, name, '^None', {'ha-mode'=>'all'})
+      policies = @manager.policies(vhost)
+      expect(policies.length).to eq(1)
+    end
+
+    it 'individual policies can be queried' do
+      name = make_name 'rspec-policy'
+      @manager.policy_create(vhost, name, '^None', {'ha-mode'=>'all'})
+      policy = @manager.policy_get(vhost, name)
+      
+      expect(policy['name']).to eq(name)
+    end
+
+    it 'individual policies can be deleted' do
+      name = make_name 'rspec-policy'
+
+      @manager.policy_create(vhost, name, '^None', {'ha-mode'=>'all'})
+      @manager.policy_delete(vhost, name)
+
+      expect(@manager.policies(vhost).length).to eq(0)
+    end
+
+    it 'queries on a non-existent policy throws and error' do
+      name = make_name 'rspec-policy'
+      expect {
+        @manager.policy_get(vhost, name)
+      }.to raise_error Faraday::Error::ResourceNotFound
+    end
+
+  end
+end

metadata

@@ -1,60 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rabbitmq_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Carl Hörberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70099315206060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70099315206060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70099315205400 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70099315205400
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70099315204860 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099315204860
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_cov
-  requirement: &70099315204260 !ruby/object:Gem::Requirement
-    none: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099315204260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for RabbitMQ management HTTP API
 email:
 - carl.hoerberg@gmail.com
@@ -62,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -74,27 +85,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/carlhoerberg/rabbitmq_manager
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrapper for RabbitMQ management HTTP API
 test_files:
 - spec/rabbitmq_manager_spec.rb