rabbitmq_http_api_client 1.15.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f9e2a79489994cac18b3d82cbae44444ad8c9f8336918beac33b2027f9a252e
-  data.tar.gz: 6ecb5b243fa30f127992fdc1dda6c5b60e69612c2b2bfc0138f3dfb38856e05d
+  metadata.gz: d150e442727e74f41f77d8683053124770d6f5aff55962d6a7a50ae27cfae5ab
+  data.tar.gz: 79b440a0f074cb4a30802a4f7b92473b49aa90bc94a1abe530b04395f86fdd0a
 SHA512:
-  metadata.gz: 6f92d37c3b8aed5323318cb4a1977d23783576e9e0c2a4add3a3dbf56c47f26777b261a8f9b2a8c260c7a5ece1b2ed4a80d99f7eb03d3d2c6d1a423096b6480b
-  data.tar.gz: 2bf80f3b75c092791b1673823d877b1ce8bb49e118550a7da9931a2dea1b8419c4912b122516c0b95292065566bc3c5fd035702e0ca4a864faa6ab93e59f6365
+  metadata.gz: b992aa3b4b3a6d24f6008d165235358cdc2141e9f1fd710d8d76a03064ec553c948d38d7cfa76d22b31ffd740a4696cd85fd411514123fa4157fbf7f1d4c41cf
+  data.tar.gz: ac715cfaac81c870b7898e5025253773bb7e8e51ceab96b35d50d2d3e43d0c2155297809907c18e0939a39aa9cd6c928b7901665b57b165002dc1f3bc375783f

data/ChangeLog.md

@@ -1,6 +1,42 @@
-## Changes Between 1.15.0 and 1.16.0 (unreleased)
+## Changes Between 1.15.0 and 2.0.0 (May 21, 2021)
 
-No changes yet.
+### 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 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

data/README.md

@@ -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', '>= 1.15.0'
 ```
 
 And then execute:

data/lib/rabbitmq/http/client.rb

@@ -5,6 +5,10 @@ require "faraday_middleware"
 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|
@@ -293,11 +302,22 @@ module RabbitMQ
 
 
       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 +409,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 = {})
@@ -418,25 +430,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

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

@@ -0,0 +1,70 @@
+require "hashie"
+require "faraday"
+require "faraday_middleware"
+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_middleware"
+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,38 @@
+require "hashie"
+require "faraday"
+require "faraday_middleware"
+require "multi_json"
+require "uri"
+
+module RabbitMQ
+  module HTTP
+    class ResponseHelper
+
+      def initialize(client)
+        @client = client
+      end
+
+      def decode_resource(response)
+        if 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 { |i| Hashie::Mash.new(i) }
+      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 = "2.0.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbitmq_http_api_client
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Michael Klishin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -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.1.4
 signing_key:
 specification_version: 4
 summary: RabbitMQ HTTP API client for Ruby