rabbitmq_http_api_client 0.2.0.pre1 → 0.2.0

data/ChangeLog.md

@@ -1,6 +1,12 @@
 ## Changes Between 0.1.0 and 0.2.0
 
-No changes yet.
+### Support for more HTTP API operations
+
+ * Operations on queues
+ * Operations on users
+ * Operations on permissions
+ * Operations on parameters
+ * Operations on policies
 
 
 ## Original Release: 0.1.0

data/README.md

@@ -33,7 +33,7 @@ All versions require [RabbitMQ Management UI plugin](http://www.rabbitmq.com/man
 
 Add this line to your application's Gemfile:
 
-    gem 'veterinarian'
+    gem 'rabbitmq_http_api_client'
 
 And then execute:
 
@@ -41,7 +41,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install veterinarian
+    $ gem install rabbitmq_http_api_client
 
 ## Usage
 

data/lib/rabbitmq/http/client/version.rb

@@ -1,7 +1,7 @@
 module RabbitMQ
   module HTTP
     class Client
-      VERSION = "0.2.0.pre1"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/rabbitmq/http/client.rb

@@ -42,7 +42,7 @@ module RabbitMQ
       end
 
       def list_definitions
-        decode_resource_collection(@connection.get("/api/definitions"))
+        decode_resource(@connection.get("/api/definitions"))
       end
 
       def upload_definitions(defs)
@@ -106,15 +106,31 @@ module RabbitMQ
       end
 
       def declare_queue(vhost, name, attributes)
-        raise NotImplementedError.new
+        response = @connection.put("/api/queues/#{uri_encode(vhost)}/#{uri_encode(name)}") do |req|
+          req.headers['Content-Type'] = "application/json"
+          req.body = MultiJson.dump(attributes)
+        end
+        decode_resource(response)
       end
 
       def delete_queue(vhost, name)
-        raise NotImplementedError.new
+        decode_resource(@connection.delete("/api/queues/#{uri_encode(vhost)}/#{uri_encode(name)}"))
+      end
+
+      def list_queue_bindings(vhost, queue)
+        decode_resource_collection(@connection.get("/api/queues/#{uri_encode(vhost)}/#{uri_encode(queue)}/bindings"))
       end
 
       def purge_queue(vhost, name)
-        raise NotImplementedError.new
+        decode_resource(@connection.delete("/api/queues/#{uri_encode(vhost)}/#{uri_encode(name)}/contents"))
+      end
+
+      def get_messages(vhost, name, options)
+        response = @connection.post("/api/queues/#{uri_encode(vhost)}/#{uri_encode(name)}/get") do |req|
+          req.headers['Content-Type'] = "application/json"
+          req.body = MultiJson.dump(options)
+        end
+        decode_resource_collection(response)
       end
 
 
@@ -128,6 +144,13 @@ module RabbitMQ
         decode_resource_collection(@connection.get(path))
       end
 
+      def list_bindings_between_queue_and_exchange(vhost, queue, exchange)
+        decode_resource_collection(@connection.get("/api/bindings/#{uri_encode(vhost)}/e/#{uri_encode(exchange)}/q/#{uri_encode(queue)}"))
+      end
+
+
+
+
       def list_vhosts
         decode_resource_collection(@connection.get("/api/vhosts"))
       end
@@ -136,21 +159,140 @@ module RabbitMQ
         decode_resource(@connection.get("/api/vhosts/#{uri_encode(name)}"))
       end
 
+      def create_vhost(name)
+        response = @connection.put("/api/vhosts/#{uri_encode(name)}") do |req|
+          req.headers['Content-Type'] = "application/json"
+        end
+        decode_resource(response)
+      end
+
+      def delete_vhost(name)
+        decode_resource(@connection.delete("/api/vhosts/#{uri_encode(name)}"))
+      end
+
+
+
+      def list_permissions(vhost = nil)
+        path = if vhost
+                 "/api/vhosts/#{uri_encode(vhost)}/permissions"
+               else
+                 "/api/permissions"
+               end
+
+        decode_resource_collection(@connection.get(path))
+      end
+
+      def list_permissions_of(vhost, user)
+        decode_resource(@connection.get("/api/permissions/#{uri_encode(vhost)}/#{uri_encode(user)}"))
+      end
+
+      def update_permissions_of(vhost, user, attributes)
+        response = @connection.put("/api/permissions/#{uri_encode(vhost)}/#{uri_encode(user)}") do |req|
+          req.headers['Content-Type'] = "application/json"
+          req.body = MultiJson.dump(attributes)
+        end
+        decode_resource(response)
+      end
+
+      def clear_permissions_of(vhost, user)
+        decode_resource(@connection.delete("/api/permissions/#{uri_encode(vhost)}/#{uri_encode(user)}"))
+      end
+
 
 
       def list_users
         decode_resource_collection(@connection.get("/api/users"))
       end
 
+      def user_info(name)
+        decode_resource(@connection.get("/api/users/#{uri_encode(name)}"))
+      end
+
+      def update_user(name, attributes)
+        response = @connection.put("/api/users/#{uri_encode(name)}") do |req|
+          req.headers['Content-Type'] = "application/json"
+          req.body = MultiJson.dump(attributes)
+        end
+        decode_resource(response)
+      end
+      alias create_user update_user
+
+      def delete_user(name)
+        decode_resource(@connection.delete("/api/users/#{uri_encode(name)}"))
+      end
 
+      def user_permissions(name)
+        decode_resource_collection(@connection.get("/api/users/#{uri_encode(name)}/permissions"))
+      end
 
-      def list_policies
-        decode_resource_collection(@connection.get("/api/policies"))
+      def whoami
+        decode_resource(@connection.get("/api/whoami"))
       end
 
 
-      def list_parameters
-        decode_resource_collection(@connection.get("/api/parameters"))
+
+      def list_policies(vhost = nil)
+        path = if vhost
+                 "/api/policies/#{uri_encode(vhost)}"
+               else
+                 "/api/policies"
+               end
+
+        decode_resource_collection(@connection.get(path))
+      end
+
+      def list_policies_of(vhost, name = nil)
+        path = if name
+                 "/api/policies/#{uri_encode(vhost)}/#{uri_encode(name)}"
+               else
+                 "/api/policies/#{uri_encode(vhost)}"
+               end
+        decode_resource_collection(@connection.get(path))
+      end
+
+      def update_policies_of(vhost, name, attributes)
+        response = @connection.put("/api/policies/#{uri_encode(vhost)}/#{uri_encode(name)}") do |req|
+          req.headers['Content-Type'] = "application/json"
+          req.body = MultiJson.dump(attributes)
+        end
+        decode_resource(response)
+      end
+
+      def clear_policies_of(vhost, name)
+        decode_resource(@connection.delete("/api/policies/#{uri_encode(vhost)}/#{uri_encode(name)}"))
+      end
+
+
+
+
+      def list_parameters(component = nil)
+        path = if component
+                 "/api/parameters/#{uri_encode(component)}"
+               else
+                 "/api/parameters"
+               end
+        decode_resource_collection(@connection.get(path))
+      end
+
+      def list_parameters_of(component, vhost, name = nil)
+        path = if name
+                 "/api/parameters/#{uri_encode(component)}/#{uri_encode(vhost)}/#{uri_encode(name)}"
+               else
+                 "/api/parameters/#{uri_encode(component)}/#{uri_encode(vhost)}"
+               end
+        decode_resource_collection(@connection.get(path))
+      end
+
+      def update_parameters_of(component, vhost, name, attributes)
+        response = @connection.put("/api/parameters/#{uri_encode(component)}/#{uri_encode(vhost)}/#{uri_encode(name)}") do |req|
+          req.headers['Content-Type'] = "application/json"
+          req.body = MultiJson.dump(attributes)
+        end
+        decode_resource(response)
+      end
+
+      def clear_parameters_of(component, vhost, name)
+        decode_resource(@connection.delete("/api/parameters/#{uri_encode(component)}/#{uri_encode(vhost)}/#{uri_encode(name)}"))
       end
 
 

data/spec/integration/client_spec.rb

@@ -1,12 +1,21 @@
 require "spec_helper"
 
 describe RabbitMQ::HTTP::Client do
-  let(:endpoint) { "http://127.0.0.1:55672" }
+  let(:endpoint) { "http://127.0.0.1:15672" }
 
   subject do
     described_class.connect(endpoint, :username => "guest", :password => "guest")
   end
 
+  before :all do
+    @connection = Bunny.new
+    @connection.start
+  end
+
+  after :all do
+    @connection.close
+  end
+
 
   #
   # Overview
@@ -94,11 +103,19 @@ describe RabbitMQ::HTTP::Client do
   #
 
   describe "GET /api/definitions" do
+    it "returns a list of all resources/definitions (vhosts, users, permissions, queues, exchanges, bindings, etc)" do
+      xs = subject.list_definitions
 
+      xs.bindings.should be_instance_of(Array)
+      xs.queues.should be_instance_of(Array)
+      xs.exchanges.should be_instance_of(Array)
+      xs.users.should be_instance_of(Array)
+      xs.vhosts.should be_instance_of(Array)
+    end
   end
 
   describe "POST /api/definitions" do
-
+    it "uploads definitions to RabbitMQ"
   end
 
   #
@@ -110,9 +127,6 @@ describe RabbitMQ::HTTP::Client do
       @connection = Bunny.new
       @connection.start
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns a list of all active connections" do
       xs = subject.list_connections
@@ -124,14 +138,6 @@ describe RabbitMQ::HTTP::Client do
   end
 
   describe "GET /api/connections/:name" do
-    before :all do
-      @connection = Bunny.new
-      @connection.start
-    end
-    after :all do
-      @connection.close
-    end
-
     it "returns information about the connection" do
       xs = subject.list_connections
       c  = subject.connection_info(xs.first.name)
@@ -142,15 +148,6 @@ describe RabbitMQ::HTTP::Client do
   end
 
   describe "DELETE /api/connections/:name" do
-    before :all do
-      @connection = Bunny.new
-      @connection.start
-    end
-    after :all do
-      @connection.close if @connection.open?
-    end
-
-
     it "closes the connection" do
       pending "Needs investigation, DELETE does not seem to close the connection"
       xs = subject.list_connections
@@ -170,13 +167,8 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/channels" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns a list of all active channels" do
       xs = subject.list_channels
@@ -189,13 +181,8 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/channels/:name" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns information about the channel" do
       xs = subject.list_channels
@@ -247,13 +234,8 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/exchanges/:vhost/:name/bindings/source" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns a list of all bindings in which the given exchange is the source" do
       e  = @channel.fanout("http.api.tests.fanout", :durable => true)
@@ -277,13 +259,8 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/exchanges/:vhost/:name/bindings/destination" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns a list of all bindings in which the given exchange is the source" do
       e1  = @channel.fanout("http.api.tests.fanout1", :durable => true)
@@ -312,13 +289,8 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/queues" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns a list of all queues" do
       q  = @channel.queue("", :exclusive => true)
@@ -330,13 +302,8 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/queues/:vhost" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns a list of all queues" do
       q  = @channel.queue("", :exclusive => true)
@@ -348,13 +315,8 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/queues/:vhost/:name" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
     it "returns information about a queue" do
       q  = @channel.queue("", :exclusive => true, :durable => false)
@@ -372,31 +334,98 @@ describe RabbitMQ::HTTP::Client do
 
   describe "PUT /api/queues/:vhost/:name" do
     before :all do
-      @connection = Bunny.new
-      @connection.start
       @channel    = @connection.create_channel
     end
-    after :all do
-      @connection.close
-    end
 
-    it "declares a queue"
+    let(:queue_name) { "httpdeclared" }
+
+    it "declares a queue" do
+      subject.declare_queue("/", queue_name, :durable => false, :auto_delete => true)
+
+      q = @channel.queue(queue_name, :durable => false, :auto_delete => true)
+      q.delete
+    end
   end
 
   describe "DELETE /api/queues/:vhost/:name" do
-    it "deletes a queue"
+    before :all do
+      @channel    = @connection.create_channel
+    end
+
+    let(:queue_name) { "httpdeclared" }
+
+    it "deletes a queue" do
+      q = @channel.queue(queue_name, :durable => false)
+      subject.delete_queue("/", queue_name)
+    end
   end
 
   describe "GET /api/queues/:vhost/:name/bindings" do
-    it "returns a list of bindings for a queue"
+    before :all do
+      @channel    = @connection.create_channel
+    end
+
+    it "returns a list of bindings for a queue" do
+      q  = @channel.queue("")
+      q.bind("amq.fanout")
+
+      xs = subject.list_queue_bindings("/", q.name)
+      x  = xs.first
+
+      x.destination.should == q.name
+      x.destination_type.should == "queue"
+    end
   end
 
   describe "DELETE /api/queues/:vhost/:name/contents" do
-    it "purges a queue"
+    before :all do
+      @channel    = @connection.create_channel
+    end
+
+    it "purges a queue" do
+      q   = @channel.queue("")
+      x   = @channel.fanout("amq.fanout", :durable => true, :auto_delete => false)
+      q.bind(x)
+
+      10.times do
+        x.publish("", :routing_key => q.name)
+      end
+      sleep 0.7
+
+      q.message_count.should == 10
+      subject.purge_queue("/", q.name)
+      sleep 0.5
+      q.message_count.should == 0
+      q.delete
+    end
   end
 
-  describe "GET /api/queues/:vhost/:name/get" do
-    it "fetches a message from a queue, a la basic.get"
+  # yes, POST, because it potentially modifies the state (ordering) of the queue
+  describe "POST /api/queues/:vhost/:name/get" do
+    before :all do
+      @channel    = @connection.create_channel
+    end
+
+    it "fetches a message from a queue, a la basic.get" do
+      q   = @channel.queue("")
+      x   = @channel.fanout("amq.fanout", :durable => true, :auto_delete => false)
+      q.bind(x)
+
+      10.times do |i|
+        x.publish("msg #{i}", :routing_key => q.name, :content_type => "application/xyz")
+      end
+      sleep 0.7
+
+      q.message_count.should == 10
+      xs = subject.get_messages("/", q.name, :count => 10, :requeue => false, :encoding => "auto")
+      m  = xs.first
+
+      m.properties.content_type.should == "application/xyz"
+      m.payload.should == "msg 0"
+      m.payload_encoding.should == "string"
+
+      q.delete
+    end
   end
 
   describe "GET /api/bindings" do
@@ -426,7 +455,26 @@ describe RabbitMQ::HTTP::Client do
   end
 
   describe "GET /api/bindings/:vhost/e/:exchange/q/:queue" do
-    it "returns a list of all bindings between an exchange and a queue"
+    before :all do
+      @channel    = @connection.create_channel
+    end
+
+    it "returns a list of all bindings between an exchange and a queue" do
+      q = @channel.queue("")
+      x = @channel.fanout("http.client.fanout")
+      q.bind(x)
+
+      xs = subject.list_bindings_between_queue_and_exchange("/", q.name, x.name)
+      b  = xs.first
+      b.destination.should == q.name
+      b.destination_type.should == "queue"
+      b.source.should == x.name
+      b.routing_key.should_not be_nil
+      b.vhost.should == "/"
+
+      q.delete
+      x.delete
+    end
   end
 
   describe "POST /api/bindings/:vhost/e/:exchange/q/:queue" do
@@ -460,16 +508,34 @@ describe RabbitMQ::HTTP::Client do
     end
   end
 
-  describe "POST /api/vhosts/:name" do
-    it "creates a vhost"
+  describe "PUT /api/vhosts/:name" do
+    let(:vhost) { "http-created" }
+
+    it "creates a vhost" do
+      subject.create_vhost(vhost)
+      subject.create_vhost(vhost)
+
+      v = subject.vhost_info(vhost)
+      v.name.should == vhost
+    end
   end
 
-  describe "PUT /api/vhosts/:name" do
-    it "updates a vhost"
+  describe "DELETE /api/vhosts/:name" do
+    let(:vhost) { "http-created2" }
+
+    it "deletes a vhost" do
+      subject.create_vhost(vhost)
+      subject.delete_vhost(vhost)
+    end
   end
 
   describe "GET /api/vhosts/:name/permissions" do
-    it "returns a list of permissions in a vhost"
+    it "returns a list of permissions in a vhost" do
+      xs = subject.list_permissions("/")
+      p  = xs.detect { |x| x.user == "guest" }
+
+      p.read.should == ".*"
+    end
   end
 
   describe "GET /api/users" do
@@ -484,39 +550,85 @@ describe RabbitMQ::HTTP::Client do
   end
 
   describe "GET /api/users/:name" do
-    it "returns information about a user"
+    it "returns information about a user" do
+      u = subject.user_info("guest")
+      u.name.should == "guest"
+      u.tags.should == "administrator"
+    end
   end
 
   describe "PUT /api/users/:name" do
-    it "updates information about a user"
+    it "updates information about a user" do
+      subject.update_user("alt", :tags => "http", :password => "alt")
+
+      u = subject.user_info("alt")
+      u.tags.should == "http"
+    end
   end
 
-  describe "POST /api/users/:name" do
-    it "creates a user"
+  describe "DELETE /api/users/:name" do
+    it "deletes a user" do
+      subject.update_user("alt2", :tags => "http", :password => "alt")
+      subject.delete_user("alt2")
+    end
   end
 
   describe "GET /api/users/:name/permissions" do
-    it "returns a list of permissions for a user"
+    it "returns a list of permissions for a user" do
+      xs = subject.user_permissions("guest")
+      p  = xs.first
+
+      p.read.should == ".*"
+    end
   end
 
   describe "GET /api/whoami" do
-    it "returns information about the current user"
+    it "returns information about the current user" do
+      u = subject.whoami
+      u.name.should == "guest"
+    end
   end
 
   describe "GET /api/permissions" do
-    it "lists all permissions"
+    it "lists all permissions" do
+      xs = subject.list_permissions
+      xs.first.read.should_not be_nil
+    end
   end
 
   describe "GET /api/permissions/:vhost/:user" do
-    it "returns a list of permissions of a user in a vhost"
+    it "returns a list of permissions of a user in a vhost" do
+      p = subject.list_permissions_of("/", "guest")
+
+      p.read.should == ".*"
+      p.write.should == ".*"
+      p.configure.should == ".*"
+    end
   end
 
   describe "PUT /api/permissions/:vhost/:user" do
-    it "updates permissions of a user in a vhost"
+    it "updates permissions of a user in a vhost" do
+      subject.update_permissions_of("/", "guest", :write => ".*", :read => ".*", :configure => ".*")
+
+      p = subject.list_permissions_of("/", "guest")
+
+      p.read.should == ".*"
+      p.write.should == ".*"
+      p.configure.should == ".*"
+    end
   end
 
   describe "DELETE /api/permissions/:vhost/:user" do
-    it "clears permissions of a user in a vhost"
+    it "clears permissions of a user in a vhost" do
+      pending
+      subject.create_user("/", "alt3")
+      subject.update_permissions_of("/", "alt3", :write => ".*", :read => ".*", :configure => ".*")
+      subject.clear_permissions_of("/", "alt3")
+
+      p = subject.list_permissions_of("/", "alt3")
+
+      puts p.inspect
+    end
   end
 
   #
@@ -530,26 +642,6 @@ describe RabbitMQ::HTTP::Client do
     end
   end
 
-  describe "GET /api/parameters/:component" do
-    it "returns a list of all parameters for a component"
-  end
-
-  describe "GET /api/parameters/:component/:vhost" do
-    it "returns a list of all parameters for a component in a vhost"
-  end
-
-  describe "GET /api/parameters/:component/:vhost/:name" do
-    it "returns information about a specific parameter"
-  end
-
-  describe "PUT /api/parameters/:component/:vhost/:name" do
-    it "updates information about a specific parameter"
-  end
-
-  describe "DELETE /api/parameters/:component/:vhost/:name" do
-    it "clears information about a specific parameter"
-  end
-
 
   #
   # Policies
@@ -563,19 +655,10 @@ describe RabbitMQ::HTTP::Client do
   end
 
   describe "GET /api/policies/:vhost" do
-    it "returns a list of all policies in a vhost"
-  end
-
-  describe "GET /api/policies/:vhost/:name" do
-    it "returns information about a policy in a vhost"
-  end
-
-  describe "PUT /api/policies/:vhost/:name" do
-    it "updates information about a policy in a vhost"
-  end
-
-  describe "DELETE /api/policies/:vhost/:name" do
-    it "clears information about a policy in a vhost"
+    it "returns a list of all policies in a vhost" do
+      xs = subject.list_policies("/")
+      xs.should be_kind_of(Array)
+    end
   end
 
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rabbitmq_http_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre1
-  prerelease: 6
+  version: 0.2.0
+  prerelease:
 platform: ruby
 authors:
 - Michael Klishin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -126,10 +126,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - !binary |-
-      Pg==
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: !binary |-
+        MA==
   none: false
 requirements: []
 rubyforge_project: