rabbitmq_http_api_client 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed47214540d24f2baaea45ea02e7acdfa82dbaa4
+  data.tar.gz: 4d24a9b4fc6e28d5d1650a9e087c3214083bfa4b
+SHA512:
+  metadata.gz: f19d37c7a1e9a8440e97aa499c5ed9d3228928849ba0a9f4c13f0db7e8371f82e9857ae49c4f2729cfc2d2e3991fcbf39b26f3bc0e9fe3130d7ae76960cf7a4e
+  data.tar.gz: 906477027358a4bf5e51fb23abde12e46f106bcfa5e348966097a45c0561103e6b31ff64bf0f21657cf0da6d3a81be6919bfc60ca23bf452688b13f1a77792cb

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/*

data/.travis.yml

@@ -0,0 +1,19 @@
+bundler_args: --without development
+script: "bundle exec rspec -cfs spec"
+rvm:
+  - "2.0"
+  - "1.9.3"
+  - "jruby-19mode"
+  - "1.9.2"
+  - "rbx-19mode"
+  - "1.8.7"
+notifications:
+  email: michael@rabbitmq.com
+services:
+  - rabbitmq
+branches:
+  only:
+    - master
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode

data/ChangeLog.md

@@ -1,3 +1,10 @@
+## Changes Between 0.2.0 and 0.3.0
+
+### MultiJSON Upgrade
+
+The library now depends on `multi_json ~> 1.7.0`.
+
+
 ## Changes Between 0.1.0 and 0.2.0
 
 ### Support for more HTTP API operations

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 group :development, :test do
   gem "rspec"
   gem "json"
-  gem "bunny", ">= 0.9.0.pre3"
+  gem "bunny", ">= 0.10.2"
 end
 
 # Specify your gem's dependencies in superintendent.gemspec

data/README.md

@@ -1,6 +1,6 @@
 # RabbitMQ HTTP API Client for Ruby
 
-This gem is a RabbitMQ HTTP API Client for Ruby. It supports
+This gem is a [RabbitMQ HTTP API](http://hg.rabbitmq.com/rabbitmq-management/raw-file/450b7ea22cfd/priv/www/api/index.html) client for Ruby. It supports
 
  * Getting cluster overview information
  * Getting cluster nodes status (# file descriptors used, RAM consumption and so on)
@@ -16,6 +16,7 @@ and will support more HTTP API features in the future
 
 ## Supported Ruby Versions
 
+ * MRI 2.0
  * MRI 1.9.3
  * JRuby 1.7+
  * Rubinius 2.0+
@@ -45,7 +46,271 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To require the client:
+
+``` ruby
+require "rabbitmq/http/client"
+```
+
+### Specifying Endpoint and Credentials
+
+Use `RabbitMQ::HTTP::Client#connect` to specify RabbitMQ HTTP API endpoint (e.g. `http://127.0.0.1:15672`) and credentials:
+
+``` ruby
+require "rabbitmq/http/client"
+
+endpoint = "http://127.0.0.1:55672"
+client = RabbitMQ::HTTP::Client.new(endpoint, :username => "guest", :password => "guest")
+```
+
+### Client API Design Overview
+
+All client methods return arrays or hash-like structures that can be used
+like JSON, via `Hash#[]` or regular method access:
+
+``` ruby
+r = client.overview
+
+puts r[:rabbitmq_version]
+puts r.erlang_version
+```
+
+
+
+### Node and Cluster Status
+
+``` ruby
+# Get cluster information overview
+h     = client.overview
+
+# List cluster nodes with detailed status info for each one of them
+nodes = client.list_nodes
+n     = nodes.first
+puts n.sockets_used
+puts n.mem_used
+puts n.run_queue
+
+# Get detailed status of a node
+n     = client.node_info("rabbit@localhost")
+puts n.disk_free
+puts n.proc_used
+puts n.fd_total
+
+# Get Management Plugin extension list
+xs    = client.list_extensions 
+
+# List all the entities (vhosts, queues, exchanges, bindings, users, etc)
+defs  = client.list_definitions
+```
+
+### Operations on Connections
+
+``` ruby
+# List all connections to a node
+conns = client.list_connections
+conn  = conns.first
+puts conn.name
+puts conn.client_properties.product
+
+# Get a connection information by name
+conns = client.list_connections
+conn  = client.connection_info(conns.first.name)
+puts conn.name
+puts conn.client_properties.product
+
+# Forcefully close a connection
+conns = client.list_connections
+client.close_connection(conns.first.name)
+```
+
+### Operations on Channels
+
+``` ruby
+# List all channels
+channs = client.list_channels
+ch     = channs.first
+puts ch.number
+puts ch.prefetch_count
+puts ch.name
+
+
+# Get a channel information by name
+conns = client.list_channels
+conn  = client.channel_info(conns.first.name)
+puts conn.name
+```
+
+### Operations on Exchanges
+
+``` ruby
+# List all exchanges in the cluster
+xs = client.list_exchanges
+x  = xs.first
+
+puts x.type
+puts x.name
+puts x.vhost
+puts x.durable
+puts x.auto_delete
+
+# List all exchanges in a vhost
+xs = client.list_exchanges("myapp.production")
+x  = xs.first
+
+puts x.type
+puts x.name
+puts x.vhost
+
+# Get information about an exchange in a vhost
+x  = client.exchange_info("/", "log.events")
+
+puts x.type
+puts x.name
+puts x.vhost
+
+# List all exchanges in a vhost for which an exchange is the source
+client.list_bindings_by_source("/", "log.events")
+
+# List all exchanges in a vhost for which an exchange is the destination
+client.list_bindings_by_destination("/", "command.handlers.email")
+```
+
+### Operations on Queues
+
+``` ruby
+# List all queues in a node
+qs = client.list_queues
+q  = qs.first
+
+puts q.name
+puts q.auto_delete
+puts q.durable
+puts q.backing_queue_status
+puts q.active_consumers
+
+
+# Declare a queue
+client.declare_queue("/", "collector1.megacorp.local", :durable => false, :auto_delete => true)
+
+# Delete a queue
+client.delete_queue("/", "collector1.megacorp.local")
+
+# List bindings for a queue
+bs = client.list_queue_bindings("/", "collector1.megacorp.local")
+
+# Purge a queue
+client.purge_queue("/", "collector1.megacorp.local")
+
+# Fetch messages from a queue
+ms = client.get_messages("/", "collector1.megacorp.local", :count => 10, :requeue => false, :encoding => "auto")
+m  = ms.first
+
+puts m.properties.content_type
+puts m.payload
+puts m.payload_encoding
+```
+
+### Operations on Bindings
+
+``` ruby
+# List all bindings
+bs = client.list_bindings
+b  = bs.first
+
+puts b.destination
+puts b.destination_type
+puts b.source
+puts b.routing_key
+puts b.vhost
+
+# List all bindings in a vhost
+bs = client.list_bindings("/")
+
+# List all binsings between an exchange and a queue
+bs = client.list_bindings_between_queue_and_exchange("/", "collector1.megacorp.local", "log.events")
+```
+
+### Operations on Vhosts
+
+``` ruby
+# List all vhosts
+vs = client.list_vhosts
+v  = vs.first
+
+puts v.name
+puts v.tracing
+
+# Get information about a vhost
+v  = client.vhost_info("/")
+
+puts v.name
+puts v.tracing
+
+# Create a vhost
+client.create_vhost("myapp.staging")
+
+# Delete a vhost
+client.delete_vhost("myapp.staging")
+```
+
+### Operations on Users
+
+``` ruby
+# List all users
+us = client.list_users
+u  = us.first
+
+puts u.name
+puts u.password_hash
+puts u.tags
+
+# Get information about a user
+u  = client.user_info("guest")
+
+puts u.name
+puts u.password_hash
+puts u.tags
+
+# Update information about a user
+client.update_user("myapp", :tags => "services", :password => "t0ps3krEt")
+
+# Delete a user
+client.delete_user("myapp")
+```
+
+### Operations on Permissions
+
+``` ruby
+# List all permissions
+ps = client.list_permissions
+
+puts p.user
+puts p.read
+puts p.write
+puts p.configure
+puts p.vhost
+
+# List all permissions in a vhost
+ps = client.list_permissions("/")
+
+puts p.user
+puts p.read
+puts p.write
+puts p.configure
+puts p.vhost
+
+# List permissions of a user
+ps = client.user_permissions("guest")
+
+# List permissions of a user in a vhost
+ps = client.list_permissions_of("/", "guest")
+
+# Update permissions of a user in a vhost
+ps = client.update_permissions_of("/", "guest", :write => ".*", :read => ".*", :configure => ".*")
+
+# Clear permissions of a user in a vhost
+ps = client.clear_permissions_of("/", "guest")
+```
 
 ## Contributing
 

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

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

data/rabbitmq_http_client.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency    "hashie",             "~> 1.2.0"
-  gem.add_dependency    "multi_json",         "~> 1.4.0"
+  gem.add_dependency    "multi_json",         "~> 1.7.0"
   gem.add_dependency    "faraday",            "~> 0.8.4"
   gem.add_dependency    "faraday_middleware", "~> 0.9.0"
   gem.add_dependency    "effin_utf8",         "~> 1.0.0"

data/spec/integration/client_spec.rb

@@ -25,8 +25,11 @@ describe RabbitMQ::HTTP::Client do
     it "returns an overview" do
       r = subject.overview
 
-      r.exchange_types.map { |h| h.name }.
-        sort.should == ["direct", "fanout", "headers", "topic"]
+      ts = r.exchange_types.map { |h| h.name }.
+        sort
+      ["direct", "fanout", "headers", "topic"].each do |t|
+        ts.should include(t)
+      end
 
       r.rabbitmq_version.should_not be_nil
       r.erlang_version.should_not be_nil
@@ -45,7 +48,7 @@ describe RabbitMQ::HTTP::Client do
       rabbit = n.applications.detect { |app| app.name == "rabbit" }
       rabbit.description.should == "RabbitMQ"
 
-      n.name.should == "rabbit@localhost"
+      n.name.should =~ /^rabbit/
       n.partitions.should == []
       n.fd_used.should_not be_nil
       n.fd_total.should_not be_nil
@@ -63,12 +66,13 @@ describe RabbitMQ::HTTP::Client do
 
   describe "GET /api/node/:name" do
     it "returns status information for a single cluster node" do
-      n = subject.node_info("rabbit@localhost")
+      ns = subject.list_nodes
+      n  = subject.node_info(ns.first.name)
 
       rabbit = n.applications.detect { |app| app.name == "rabbit" }
       rabbit.description.should == "RabbitMQ"
 
-      n.name.should == "rabbit@localhost"
+      n.name.should =~ /^rabbit/
       n.partitions.should == []
       n.fd_used.should_not be_nil
       n.fd_total.should_not be_nil
@@ -94,7 +98,7 @@ describe RabbitMQ::HTTP::Client do
       xs = subject.list_extensions
       f  = xs.first
 
-      f.javascript.should == "dispatcher.js"
+      ["dispatcher.js", "shovel.js"].should include(f.javascript)
     end
   end
 
@@ -287,6 +291,11 @@ describe RabbitMQ::HTTP::Client do
     it "publishes a messages to the exchange"
   end
 
+
+  #
+  # Queues
+  #
+
   describe "GET /api/queues" do
     before :all do
       @channel    = @connection.create_channel
@@ -327,7 +336,7 @@ describe RabbitMQ::HTTP::Client do
 
       i.name.should == q.name
       i.auto_delete.should == q.auto_delete?
-      i.active_consumers.should == 0
+      i.active_consumers.should be_nil
       i.backing_queue_status.avg_ack_egress_rate.should == 0.0
     end
   end

metadata

@@ -1,96 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rabbitmq_http_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease:
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Klishin
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-09 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: multi_json
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    none: false
-  prerelease: false
-  type: :runtime
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: faraday
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.4
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.4
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: effin_utf8
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
-    none: false
-  prerelease: false
-  type: :runtime
 description: RabbitMQ HTTP API client for Ruby
 email:
 - michael@defprotocol.org
@@ -99,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - ChangeLog.md
 - Gemfile
 - LICENSE.txt
@@ -113,29 +103,26 @@ homepage: http://github.com/ruby-amqp/rabbitmq_http_api_client
 licenses:
 - MIT
 - Mozilla Public License
-post_install_message:
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
 summary: RabbitMQ HTTP API client for Ruby
 test_files:
 - spec/integration/client_spec.rb