rabbitmq_http_api_client 2.2.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a39be0a10b8f98fecdccfa407bf150811498cf8739ed6edef8cbf1b88b11bb2
-  data.tar.gz: d5898d4b21ceed5c53abffcd251277cfdfd72c90665e4a0ed5f3f72c57578ffd
+  metadata.gz: 112665308e0fdad4c85aac225f8cfb3628a87361eec6636fd66d228fd3f217b2
+  data.tar.gz: 85d90413b2a24161eab37b3c6a66024743f0e49965ae49d853705838df086f95
 SHA512:
-  metadata.gz: 2684a342bd54fc6fe432772e707f10562696b33b344eff100a2c3c1c0c017088e24eb59b31133e9020dd27698c22bb3f2c15619af411a95d5943eebc6946d9b1
-  data.tar.gz: afd8403234f005f8b6f133dcaf8cf203b8bf94fe9c94f6d66f020965a088eae05067f89cbb7c04f02ccaa607d95dc692e9bad82788b378366019e22a9240a389
+  metadata.gz: 91fc2fa48278d2e272a09b685ed158be459e10e5da145fb66cca7ce276ba7027481a8a123b37920d766de9bebe001eb7b3fa79d0c68cee0a7ca87a613e9db2f3
+  data.tar.gz: b98f7a71da163fea31407b4f8fef74966d782ec6faacdf4fc63eef9960177d9d04b5b87281d437246c94d3a30fb6d372fc4bf322e47843e0f48969de4b9a08b4

data/ChangeLog.md

@@ -1,8 +1,48 @@
-## Changes Between 2.2.0 and 2.3.0 (unreleased)
+## Changes Between 3.1.0 and 3.2.0 (in development)
 
 No changes yet.
 
 
+## Changes Between 3.0.0 and 3.1.0 (Nov 4, 2025)
+
+### Dependency Updates
+
+ * `addressable` to `2.8`
+ * `faraday` to `2.14`
+ * `faraday-follow_redirects` to `0.4`
+ * `hashie` to `5.0`
+ * `multi_json` to `1.17`
+
+Contributed by @fretb.
+
+GitHub issue: [#67](https://github.com/ruby-amqp/rabbitmq_http_api_client/pull/67)
+
+
+## Changes Between 2.2.0 and 3.0.0 (July 20, 2024)
+
+### Why the Major Version Bump?
+
+This release adopts a new major version of Faraday and targets
+only [community supported RabbitMQ versions](https://www.rabbitmq.com/release-information),
+which at this time means `3.13.x`.
+
+While there are no major breaking changes in the library itself,
+these two changes and more than two years that have passed since 2.0.0
+warrant a major version bump.
+
+### Support for Faraday 2.x
+
+Contributed by @shashankmehra.
+
+GitHub issue: [#63](https://github.com/ruby-amqp/rabbitmq_http_api_client/pull/63)
+
+### Queue Deletion: Support for if-unused and if-empty
+
+Contributed by @shashankmehra.
+
+GitHub issue: [#62](https://github.com/ruby-amqp/rabbitmq_http_api_client/pull/62)
+
+
 ## Changes Between 2.1.0 and 2.2.0 (May 19, 2022)
 
 Test suite and CI automation changes.

data/README.md

@@ -1,6 +1,6 @@
 # RabbitMQ HTTP API Client for Ruby
 
-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
+This gem is a [RabbitMQ HTTP API](https://www.rabbitmq.com/docs/http-api-reference) client for Ruby. It supports
 
  * Getting cluster overview information
  * Getting cluster nodes status (# file descriptors used, RAM consumption and so on)
@@ -18,30 +18,44 @@ and will support more HTTP API features in the future
 
 ## Supported Ruby Versions
 
- * CRuby 2.2 through 2.7.x
+ * CRuby 2.7 through 3.x
  * JRuby 9K
 
 ## Supported RabbitMQ Versions
 
-All [supported RabbitMQ release series](https://www.rabbitmq.com/versions.html).
+This library targets [RabbitMQ release series covered by community support](https://www.rabbitmq.com/release-information).
 
-All versions require [RabbitMQ Management UI plugin](http://www.rabbitmq.com/management.html) to be installed and enabled.
+All versions require the [Management UI plugin](https://www.rabbitmq.com/docs/management/) to be enabled.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile to
+use the latest version of this library:
 
 ``` ruby
-gem 'rabbitmq_http_api_client', '>= 2.0.0'
+# Depends on Faraday 2.x
+gem 'rabbitmq_http_api_client', '>= 3.1.0'
+```
+
+If you **absolutely must** use Faraday 1.x, use the 2.x series:
+
+``` ruby
+# Depends on Faraday 1.x.
+# Consider using 3.0.0 and later versions.
+gem 'rabbitmq_http_api_client', '~> 2.2.0'
 ```
 
 And then execute:
 
-    bundle install
+``` shell
+bundle install
+```
 
-Or install it yourself as:
+Or install it manually with:
 
-    gem install rabbitmq_http_api_client
+``` shell
+gem install rabbitmq_http_api_client
+```
 
 ## Usage
 
@@ -116,7 +130,6 @@ 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
 
@@ -347,15 +360,24 @@ ps = client.clear_permissions_of("/", "guest")
 
 ## Running Tests
 
-    bundle install
-    bundle exec rspec -cfd spec
+Before running the test suites, run a script that will set up the local node:
 
-The test suite assumes that RabbitMQ is running locally with stock settings
-and rabbitmq-management plugin enabled.
+``` shell
+export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQCTL="/path/to/sbin/rabbitmqctl"
+export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQ_PLUGINS="/path/to/sbin/rabbitmq-plugins"
+
+./bin/ci/before_build.sh
+```
 
-## Continuous Integration
+To run all specs:
 
-[![Build Status](https://travis-ci.org/ruby-amqp/rabbitmq_http_api_client.svg?branch=master)](https://travis-ci.org/ruby-amqp/rabbitmq_http_api_client)
+``` shell
+bundle install
+bundle exec rspec -cfd spec
+```
+
+The test suite assumes that RabbitMQ is running locally with stock settings
+and rabbitmq-management plugin enabled.
 
 
 ## Contributing
@@ -369,6 +391,6 @@ and rabbitmq-management plugin enabled.
 
 ## License & Copyright
 
-Double-licensed under the MIT and Mozilla Public License (same as RabbitMQ).
+Double-licensed under the MIT and the Mozilla Public License 2.0 ([same as RabbitMQ](https://github.com/rabbitmq/rabbitmq-server/blob/main/LICENSE)).
 
-(c) Michael S. Klishin, 2012-2020.
+(c) Michael S. Klishin, 2012-2024.

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

@@ -1,6 +1,6 @@
 require "hashie"
 require "faraday"
-require "faraday_middleware"
+require "faraday/follow_redirects"
 require "multi_json"
 require "uri"
 

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

@@ -1,6 +1,6 @@
 require "hashie"
 require "faraday"
-require "faraday_middleware"
+require "faraday/follow_redirects"
 require "multi_json"
 require "uri"
 

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

@@ -1,6 +1,6 @@
 require "hashie"
 require "faraday"
-require "faraday_middleware"
+require "faraday/follow_redirects"
 require "multi_json"
 require "uri"
 
@@ -13,7 +13,7 @@ module RabbitMQ
       end
 
       def decode_resource(response)
-        if response.nil? || response.body.empty?
+        if response.nil? || response.body.nil? || response.body.empty?
           Hashie::Mash.new
         else
           decode_response_body(response.body)
@@ -31,7 +31,13 @@ module RabbitMQ
       def decode_resource_collection(response)
         collection = response.body.is_a?(Array) ? response.body : response.body.fetch('items')
 
-        collection.map { |i| Hashie::Mash.new(i) }
+        collection.map do |i|
+          if i == []
+            Hashie::Mash.new()
+          else
+            Hashie::Mash.new(i)
+          end
+        end
       end
     end
   end

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

@@ -1,7 +1,7 @@
 module RabbitMQ
   module HTTP
     class Client
-      VERSION = "2.2.0"
+      VERSION = "3.1.0"
     end
   end
 end

data/lib/rabbitmq/http/client.rb

@@ -1,7 +1,7 @@
 require "addressable/uri"
 require "hashie"
 require "faraday"
-require "faraday_middleware"
+require "faraday/follow_redirects"
 require "multi_json"
 require "uri"
 
@@ -177,8 +177,12 @@ module RabbitMQ
         decode_resource(response)
       end
 
-      def delete_queue(vhost, name)
-        decode_resource(@connection.delete("queues/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(name)}"))
+      def delete_queue(vhost, name, if_unused = false, if_empty = false)
+        response = @connection.delete("queues/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(name)}") do |req|
+          req.params["if-unused"] = true if if_unused
+          req.params["if-empty"] = true if if_empty
+        end
+        decode_resource(response)
       end
 
       def list_queue_bindings(vhost, queue, query = {})
@@ -443,12 +447,12 @@ module RabbitMQ
         user     = uri.user     || options.delete(:username) || "guest"
         password = uri.password || options.delete(:password) || "guest"
         options = options.merge(:url => uri.to_s)
-        adapter = options.delete(:adapter) || Faraday.default_adapter
+        adapter = options.delete(:adapter) || Faraday.default_adapter || :httpclient
 
         @connection = Faraday.new(options) do |conn|
-          conn.request    :basic_auth, user, password
+          conn.request    :authorization, :basic, user, password
 
-          conn.use        FaradayMiddleware::FollowRedirects, :limit => 3
+          conn.use        Faraday::FollowRedirects::Middleware, :limit => 3
           conn.use        Faraday::Response::RaiseError
           conn.response   :json, :content_type => /\bjson$/
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rabbitmq_http_api_client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Michael Klishin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -16,70 +15,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.4'
 description: RabbitMQ HTTP API client for Ruby
 email:
 - michael@clojurewerkz.org
@@ -100,7 +99,6 @@ licenses:
 - MIT
 - MPL-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: RabbitMQ HTTP API client for Ruby
 test_files: []