rabbitmq_http_api_client 1.15.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f9e2a79489994cac18b3d82cbae44444ad8c9f8336918beac33b2027f9a252e
-  data.tar.gz: 6ecb5b243fa30f127992fdc1dda6c5b60e69612c2b2bfc0138f3dfb38856e05d
+  metadata.gz: b9fe9cd3da39f8ad9d88cab48895b67278e5df0e5df8f5a397660bc6c73af671
+  data.tar.gz: cd233d873f713a5ec50a751a8a58992920f3f03761c8f18b313207febf57acb3
 SHA512:
-  metadata.gz: 6f92d37c3b8aed5323318cb4a1977d23783576e9e0c2a4add3a3dbf56c47f26777b261a8f9b2a8c260c7a5ece1b2ed4a80d99f7eb03d3d2c6d1a423096b6480b
-  data.tar.gz: 2bf80f3b75c092791b1673823d877b1ce8bb49e118550a7da9931a2dea1b8419c4912b122516c0b95292065566bc3c5fd035702e0ca4a864faa6ab93e59f6365
+  metadata.gz: a72745520c25dfbc6f5133dc6978b2ff4739ec3f8f56c4e344497a75f9716f7930d1c17fbf93f07a4e544818567d987f5d795ec2ede94e191a030627b2cb835a
+  data.tar.gz: 53c18efe60eec7b84f3e0738e6d7e04b76a796cdf6a15746fb9574cbf7becb5a379891fff9a9a8d88475df3e2bf619aa7d227ec6de872e37a5acaa66ba00152a

data/ChangeLog.md

@@ -1,6 +1,89 @@
-## Changes Between 1.15.0 and 1.16.0 (unreleased)
+## Changes Between 2.2.0 and 3.0.0 (July 20, 2024)
 
-No changes yet.
+### 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.
+
+
+## Changes Between 2.0.0 and 2.1.0 (February 12, 2022)
+
+### Handle Responses that Do Not Contain a Body
+
+GitHub issue: [#52](https://github.com/ruby-amqp/rabbitmq_http_api_client/issues/52)
+
+### Support for Management of Topic Permissions
+
+Contributed by @bagedevimo.
+
+GitHub issue: [#57](https://github.com/ruby-amqp/rabbitmq_http_api_client/issues/57)
+
+### Upgraded Faraday Middleware
+
+Faraday (a dependency) has been upgraded to `1.2.x` to eliminate some deprecation warnings.
+
+
+## Changes Between 1.15.0 and 2.0.0 (May 21, 2021)
+
+### Health Check Endpoint Changes
+
+`RabbitMQ::HTTP::Client#aliveness_test` has been removed. The endpoint has been deprecated
+in favor of [more focussed health check endpoints](https://www.rabbitmq.com/monitoring.html#health-checks):
+
+``` ruby
+c = RabbitMQ::HTTP::Client.new("http://username:s3kRe7@localhost:15672")
+
+# Returns a pair of [success, details]. Details will be nil
+# if the check succeeds.
+#
+# Checks for any alarms across the cluster
+passed, details = c.health.check_alarms
+
+# alarms on the given node
+passed, details = c.health.check_local_alarms
+
+# is this node essential for an online quorum of any quorum queues?
+passed, details = c.health.check_if_node_is_quorum_critical
+
+# do any certificates used by this node's TLS listeners expire within
+# three months?
+passed, details = c.health.check_certificate_expiration(3, "months")
+```
+
+See the list of methods in `RabbitMQ::HTTP::HealthChecks` to find out what other
+health checks are available.
+
+### User Tags Type Change
+
+User tags returned by the `RabbitMQ::HTTP::Client#list_users` and `RabbitMQ::HTTP::Client#user_info`
+methods are now arrays of strings instead of comma-separated strings.
+
+Internally the method encodes both command-separated strings and JSON arrays in API responses
+to support response types from RabbitMQ 3.9 and earlier versions.
+
+See [rabbitmq/rabbitmq-server#2676](https://github.com/rabbitmq/rabbitmq-server/pull/2676) for details.
 
 ## Changes Between 1.14.0 and 1.15.0 (February 16th, 2021)
 ### Content Length Detection Changes
@@ -12,6 +95,7 @@ Contributed by Ryan @rquant Quant.
 
 GitHub issue: [#49](https://github.com/ruby-amqp/rabbitmq_http_api_client/pull/49)
 
+
 ## Changes Between 1.13.0 and 1.14.0 (July 8th, 2020)
 
 ### URI.escape is No Longer Used

data/README.md

@@ -18,12 +18,12 @@ and will support more HTTP API features in the future
 
 ## Supported Ruby Versions
 
- * CRuby 2.2 through 2.7.x
+ * CRuby 2.5 through 3.x
  * JRuby 9K
 
 ## Supported RabbitMQ Versions
 
- * RabbitMQ 3.x
+All [supported RabbitMQ release series](https://www.rabbitmq.com/versions.html).
 
 All versions require [RabbitMQ Management UI plugin](http://www.rabbitmq.com/management.html) to be installed and enabled.
 
@@ -32,7 +32,7 @@ All versions require [RabbitMQ Management UI plugin](http://www.rabbitmq.com/man
 Add this line to your application's Gemfile:
 
 ``` ruby
-gem 'rabbitmq_http_api_client', '>= 1.13.0'
+gem 'rabbitmq_http_api_client', '>= 2.2.0'
 ```
 
 And then execute:
@@ -116,7 +116,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,8 +346,21 @@ 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:
+
+``` shell
+export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQCTL="rabbitmqctl"
+export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQ_PLUGINS="rabbitmq-plugins"
+
+./bin/ci/before_build.sh
+```
+
+To run all specs:
+
+``` 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.

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

@@ -0,0 +1,70 @@
+require "hashie"
+require "faraday"
+require "faraday/follow_redirects"
+require "multi_json"
+require "uri"
+
+module RabbitMQ
+  module HTTP
+    class HealthChecks
+
+      def initialize(client)
+        @client = client
+        @request_helper  = @client.request_helper
+        @response_helper = @client.response_helper
+      end
+
+      def check_alarms
+        health_check_for("health/checks/alarms")
+      end
+
+      def check_local_alarms
+        health_check_for("health/checks/local-alarms")
+      end
+
+      def check_virtual_hosts
+        health_check_for("health/checks/virtual-hosts")
+      end
+
+      def check_if_node_is_quorum_critical
+        health_check_for("health/checks/node-is-quorum-critical")
+      end
+
+      def check_if_node_is_mirror_sync_critical
+        health_check_for("health/checks/node-is-mirror-sync-critical")
+      end
+
+      def check_port_listener(port)
+        health_check_for("health/checks/port-listener/#{encode_uri_path_segment(port)}")
+      end
+
+      def check_protocol_listener(proto)
+        health_check_for("health/checks/protocol-listener/#{encode_uri_path_segment(proto)}")
+      end
+
+      TIME_UNITS = %w(days weeks months years)
+
+      def check_certificate_expiration(within, unit)
+        raise ArgumentError.new("supported time units are #{TIME_UNITS.join(', ')}, given: #{unit}") if !TIME_UNITS.include?(unit)
+        raise ArgumentError.new("the number of time units must be a positive integer") if within <= 0
+
+        health_check_for("health/checks/certificate-expiration/#{@request_helper.encode_uri_path_segment(within)}/#{@request_helper.encode_uri_path_segment(unit)}")
+      end
+
+
+      def health_check_for(path)
+        begin
+            _ = @response_helper.decode_resource(@client.connection.get(path))
+            [true, nil]
+          rescue Faraday::ServerError => se
+            # health check endpoints respond with a 503 if the server fails
+            if se.response_status == 503
+              [false, @response_helper.decode_response_body(se.response[:body])]
+            else
+              raise se
+            end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "hashie"
+require "faraday"
+require "faraday/follow_redirects"
+require "multi_json"
+require "uri"
+
+module RabbitMQ
+  module HTTP
+    class RequestHelper
+      def encode_uri_path_segment(segment)
+        # Correctly escapes spaces, see ruby-amqp/rabbitmq_http_api_client#28.
+        #
+        # Note that slashes also must be escaped since this is a single URI path segment,
+        # not an entire path.
+        Addressable::URI.encode_component(segment, Addressable::URI::CharacterClasses::UNRESERVED)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require "hashie"
+require "faraday"
+require "faraday/follow_redirects"
+require "multi_json"
+require "uri"
+
+module RabbitMQ
+  module HTTP
+    class ResponseHelper
+
+      def initialize(client)
+        @client = client
+      end
+
+      def decode_resource(response)
+        if response.nil? || response.body.nil? || response.body.empty?
+          Hashie::Mash.new
+        else
+          decode_response_body(response.body)
+        end
+      end
+
+      def decode_response_body(body)
+        if body.empty?
+          Hashie::Mash.new
+        else
+          Hashie::Mash.new(body)
+        end
+      end
+
+      def decode_resource_collection(response)
+        collection = response.body.is_a?(Array) ? response.body : response.body.fetch('items')
+
+        collection.map do |i|
+          if i == []
+            Hashie::Mash.new()
+          else
+            Hashie::Mash.new(i)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module RabbitMQ
   module HTTP
     class Client
-      VERSION = "1.15.0"
+      VERSION = "3.0.0"
     end
   end
 end

data/lib/rabbitmq/http/client.rb

@@ -1,10 +1,14 @@
 require "addressable/uri"
 require "hashie"
 require "faraday"
-require "faraday_middleware"
+require "faraday/follow_redirects"
 require "multi_json"
 require "uri"
 
+require_relative "client/request_helper"
+require_relative "client/response_helper"
+require_relative "client/health_checks"
+
 module RabbitMQ
   module HTTP
     class Client
@@ -13,7 +17,8 @@ module RabbitMQ
       # API
       #
 
-      attr_reader :endpoint
+      attr_reader :endpoint, :health
+      attr_reader :connection, :request_helper, :response_helper
 
       def self.connect(endpoint, options = {})
         new(endpoint, options)
@@ -23,6 +28,10 @@ module RabbitMQ
         @endpoint = endpoint
         @options  = options
 
+        @request_helper = RequestHelper.new()
+        @response_helper = ResponseHelper.new(self)
+        @health = HealthChecks.new(self)
+
         initialize_connection(endpoint, options)
       end
 
@@ -114,10 +123,10 @@ module RabbitMQ
 
       def declare_exchange(vhost, name, attributes = {})
         opts = {
-          :type => "direct",
-          :auto_delete => false,
-          :durable => true,
-          :arguments => {}
+          type: "direct",
+          auto_delete: false,
+          durable: true,
+          arguments: {}
         }.merge(attributes)
 
         response = @connection.put("exchanges/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(name)}") do |req|
@@ -168,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 = {})
@@ -290,14 +303,51 @@ module RabbitMQ
         decode_resource(@connection.delete("permissions/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(user)}"))
       end
 
+      def list_topic_permissions(vhost = nil, query = {})
+        path = if vhost
+                 "vhosts/#{encode_uri_path_segment(vhost)}/topic-permissions"
+                else
+                  "topic-permissions"
+                end
+
+        decode_resource_collection(@connection.get(path, query))
+      end
+
+      def list_topic_permissions_of(vhost, user)
+        path = "topic-permissions/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(user)}"
+        decode_resource_collection(@connection.get(path))
+      end
+
+      def update_topic_permissions_of(vhost, user, attributes)
+        response = @connection.put("topic-permissions/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(user)}") do |req|
+          req.headers['Content-Type'] = "application/json"
+          req.body = MultiJson.dump(attributes)
+        end
+
+        nil
+      end
 
+      def delete_topic_permissions_of(vhost, user)
+        decode_resource(@connection.delete("topic-permissions/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(user)}"))
+      end
 
       def list_users(query = {})
-        decode_resource_collection(@connection.get("users", query))
+        results = decode_resource_collection(@connection.get("users", query))
+
+        # HTTP API will return tags as an array starting with RabbitMQ 3.9
+        results.map do |u|
+          u.tags = u.tags.split(",") if u.tags.is_a?(String)
+          u
+        end
       end
 
       def user_info(name)
-        decode_resource(@connection.get("users/#{encode_uri_path_segment(name)}"))
+        result = decode_resource(@connection.get("users/#{encode_uri_path_segment(name)}"))
+
+        # HTTP API will return tags as an array starting with RabbitMQ 3.9
+        result.tags = result.tags.split(",") if result.tags.is_a?(String)
+
+        result
       end
 
       def update_user(name, attributes)
@@ -389,14 +439,6 @@ module RabbitMQ
         decode_resource(@connection.delete("parameters/#{encode_uri_path_segment(component)}/#{encode_uri_path_segment(vhost)}/#{encode_uri_path_segment(name)}"))
       end
 
-
-
-      def aliveness_test(vhost)
-        r = @connection.get("aliveness-test/#{encode_uri_path_segment(vhost)}")
-        r.body["status"] == "ok"
-      end
-
-
       protected
 
       def initialize_connection(endpoint, options = {})
@@ -405,11 +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.basic_auth user, password
-          conn.use        FaradayMiddleware::FollowRedirects, :limit => 3
+          conn.request    :authorization, :basic, user, password
+
+          conn.use        Faraday::FollowRedirects::Middleware, :limit => 3
           conn.use        Faraday::Response::RaiseError
           conn.response   :json, :content_type => /\bjson$/
 
@@ -418,25 +461,19 @@ module RabbitMQ
       end
 
       def encode_uri_path_segment(segment)
-        # Correctly escapes spaces, see ruby-amqp/rabbitmq_http_api_client#28.
-        #
-        # Note that slashes also must be escaped since this is a single URI path segment,
-        # not an entire path.
-        Addressable::URI.encode_component(segment, Addressable::URI::CharacterClasses::UNRESERVED)
+        @request_helper.encode_uri_path_segment(segment)
       end
 
       def decode_resource(response)
-        if response.body.empty?
-          Hashie::Mash.new
-        else
-          Hashie::Mash.new(response.body)
-        end
+        @response_helper.decode_resource(response)
       end
 
-      def decode_resource_collection(response)
-        collection = response.body.is_a?(Array) ? response.body : response.body.fetch('items')
+      def decode_response_body(body)
+        @response_helper.decode_response_body(body)
+      end
 
-        collection.map { |i| Hashie::Mash.new(i) }
+      def decode_resource_collection(response)
+        @response_helper.decode_resource_collection(response)
       end
     end # Client
   end # HTTP

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbitmq_http_api_client
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Michael Klishin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
 description: RabbitMQ HTTP API client for Ruby
 email:
 - michael@clojurewerkz.org
@@ -91,6 +91,9 @@ files:
 - LICENSE.txt
 - README.md
 - lib/rabbitmq/http/client.rb
+- lib/rabbitmq/http/client/health_checks.rb
+- lib/rabbitmq/http/client/request_helper.rb
+- lib/rabbitmq/http/client/response_helper.rb
 - lib/rabbitmq/http/client/version.rb
 homepage: http://github.com/ruby-amqp/rabbitmq_http_api_client
 licenses:
@@ -112,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: RabbitMQ HTTP API client for Ruby