hawkular-client 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5ef004e3d7f65c23d6519f703d3fe8cec0f02da
-  data.tar.gz: 8e3c54a206009a3e4aa9028a5dcf763156883bc4
+  metadata.gz: 0deaaa015739eac52e9e7dee6baa5af63676ead7
+  data.tar.gz: 86167936dc2869bc8ae120649edf36d0078fba52
 SHA512:
-  metadata.gz: da305496d926efb03b970a52ce00f20109dfc08a1952bfe63fd8d0d5289c156ab0ae1a1f625ed2c1720a38e30c4d45b8992b397652bcb3f22bd0dea0f216f0db
-  data.tar.gz: 3b1674b21b0fc2d4defc566f5666dbbcf923fe8752ccaf97d64256a633a2ac5541b11d6037ee3a70583227d3a0bbdb8b6d2183cf4a81ca7d389ccbed7932413c
+  metadata.gz: c568daeb2e618ea436afc6af14ba5b98d6531e24ca6d7478b123ea868318e82700c1b4556eab69b4f9814aae57a4dc5dec029c9a6ef43c5b8828c410ff41de9e
+  data.tar.gz: 1e3595bf9e178c835d84bc17f5c0104a630e0c14e506f9e119807f39b2625c1e30f1428125b4df6d6a14ad141d085cb9c5c2d074a76e83c3af03893ad46fd144

data/CHANGES.rdoc

@@ -3,6 +3,13 @@
 This document describes the relevant changes between releases of the
 _hawkular-client_ project.
 
+=== V 2.0.0
+* This version is compatible with hawkular-services[https://github.com/hawkular/hawkular-services]
+* By default no Tenant-Header is send in the requests, which is compatible with the old versions of Hawkular. However,
+  if the option 'tenant' is passed when creating the client, it will be sent as the header. This is the only potentialy breaking change, because
+  in 1.0.0, if the tenant was not specified the 'hawkular' Tenant-Header was used.
+* Method for listing resources for a feed in the inventory sub-client has been fixed.
+
 === V 1.0.0
 * This major release contains changes that <b>may break the backward compatibility</b>, more info here: link:api_breaking_changes.rdoc
 * To use the client use the <code>require 'hawkular/hawkular_client'</code> instead of <code>require 'hawkular_all'</code>

data/api_breaking_changes.rdoc

@@ -1,5 +1,10 @@
 == Breaking changes in the major releases
 
+=== 2.0.0
+
+By default no Hawkular-Tenant HTTP header is being set. If you need it (for instance for hawkular-services), provide the tenant option when creating a client.
+e.g. <code>::Hawkular::Client.new(..., options: { tenant: 'hawkular' })</code>
+
 === 1.0.0
 
 To use the client use the <code>require 'hawkular/hawkular_client'</code> instead of <code>require 'hawkular_all'</code>

data/lib/hawkular/alerts/alerts_api.rb

@@ -12,11 +12,12 @@ module Hawkular::Alerts
   # @param entrypoint [String] base url of Hawkular-Alerts - e.g
   #   http://localhost:8080/hawkular/alerts
   # @param credentials [Hash{String=>String}] Hash of username, password, token(optional)
+  # @param options [Hash{String=>String}] Additional rest client options
   class AlertsClient < Hawkular::BaseClient
-    def initialize(entrypoint = 'http://localhost:8080/hawkular/alerts', credentials = {})
+    def initialize(entrypoint = 'http://localhost:8080/hawkular/alerts', credentials = {}, options = {})
       @entrypoint = entrypoint
 
-      super(entrypoint, credentials)
+      super(entrypoint, credentials, options)
     end
 
     # Lists defined triggers in the system

data/lib/hawkular/base_client.rb

@@ -146,8 +146,9 @@ module Hawkular
     end
 
     def tenant_header
-      @options[:tenant].nil? ? { 'Hawkular-Tenant' => 'hawkular' } : { :'Hawkular-Tenant' => @options[:tenant],
-                                                                       'tenantId'         => @options[:tenant] }
+      headers = {}
+      headers[:'Hawkular-Tenant'] = @options[:tenant] unless @options[:tenant].nil?
+      headers
     end
 
     def handle_fault(f)

data/lib/hawkular/hawkular_client.rb

@@ -16,15 +16,20 @@ module Hawkular
       @state = hash
 
       @inventory = Inventory::InventoryClient.create(entrypoint: "#{hash[:entrypoint]}/hawkular/inventory",
-                                                     credentials: hash[:credentials])
+                                                     credentials: hash[:credentials],
+                                                     options: hash[:options])
 
       @metrics = Metrics::Client.new("#{hash[:entrypoint]}/hawkular/metrics",
                                      hash[:credentials],
                                      hash[:options])
 
-      @alerts = Alerts::AlertsClient.new("#{hash[:entrypoint]}/hawkular/alerts", hash[:credentials])
+      @alerts = Alerts::AlertsClient.new("#{hash[:entrypoint]}/hawkular/alerts",
+                                         hash[:credentials],
+                                         hash[:options])
 
-      @tokens = Token::TokenClient.new(hash[:entrypoint], hash[:credentials])
+      @tokens = Token::TokenClient.new(hash[:entrypoint],
+                                       hash[:credentials],
+                                       hash[:options])
     end
 
     def method_missing(name, *args, &block)
@@ -54,7 +59,8 @@ module Hawkular
     # this is in a dedicated method, because constructor opens the websocket connection to make the handshake
     def init_operations_client
       Operations::OperationsClient.new(entrypoint: @state[:entrypoint].gsub(/^https?/, 'ws'),
-                                       credentials: @state[:credentials])
+                                       credentials: @state[:credentials],
+                                       options: @state[:options])
     end
   end
 end

data/lib/hawkular/inventory/inventory_api.rb

@@ -14,9 +14,10 @@ module Hawkular::Inventory
     # @param entrypoint [String] base url of Hawkular-inventory - e.g
     #   http://localhost:8080/hawkular/inventory
     # @param credentials [Hash{String=>String}] Hash of username, password, token(optional)
-    def initialize(entrypoint = nil, credentials = {})
+    # @param options [Hash{String=>String}] Additional rest client options
+    def initialize(entrypoint = nil, credentials = {}, options = {})
       @entrypoint = entrypoint
-      super(entrypoint, credentials)
+      super(entrypoint, credentials, options)
     end
 
     # Creates a new Inventory Client
@@ -26,7 +27,8 @@ module Hawkular::Inventory
     def self.create(hash)
       hash[:entrypoint] ||= 'http://localhost:8080/hawkular/inventory'
       hash[:credentials] ||= {}
-      InventoryClient.new(hash[:entrypoint], hash[:credentials])
+      hash[:options] ||= {}
+      InventoryClient.new(hash[:entrypoint], hash[:credentials], hash[:options])
     end
 
     # Retrieve the tenant id for the passed credentials.
@@ -74,7 +76,7 @@ module Hawkular::Inventory
     # @return [Array<Resource>] List of resources, which can be empty.
     def list_resources_for_feed(feed_id, fetch_properties = false, filter = {})
       fail 'Feed id must be given' unless feed_id
-      the_feed = hawk_escape_id feed
+      the_feed = hawk_escape_id feed_id
       ret = http_get("/feeds/#{the_feed}/resources")
       to_filter = ret.map do |r|
         if fetch_properties

data/lib/hawkular/operations/operations_api.rb

@@ -47,6 +47,7 @@ module Hawkular::Operations
     #
     # @option args [String]  :host base url of Hawkular - e.g http://localhost:8080
     # @option args [Hash{String=>String}]  :credentials Hash of (username password) or token
+    # @option args [Hash{String=>String}] :options Additional rest client options
     # @option args [Fixnum]  :wait_time Time in seconds describing how long the constructor should block - handshake
     #
     # @example
@@ -54,8 +55,9 @@ module Hawkular::Operations
     def initialize(args)
       args[:host] ||= 'localhost:8080'
       args[:credentials] ||= {}
+      args[:options] ||= {}
       args[:wait_time] ||= 0.5
-      super(args[:host], args[:credentials])
+      super(args[:host], args[:credentials], args[:options])
       # note: if we start using the secured WS, change the protocol to wss://
       url = "ws://#{entrypoint}/hawkular/command-gateway/ui/ws"
       @ws = Simple.connect url do |client|

data/lib/hawkular/tokens/tokens_api.rb

@@ -7,8 +7,9 @@ module Hawkular::Token
     # Create a new Secret Store client
     # @param entrypoint [String] base url of Hawkular - e.g http://localhost:8080
     # @param credentials [Hash{String=>String}] Hash of username, password
-    def initialize(entrypoint = 'http://localhost:8080', credentials = {})
-      super(entrypoint, credentials)
+    # @param options [Hash{String=>String}] Additional rest client options
+    def initialize(entrypoint = 'http://localhost:8080', credentials = {}, options = {})
+      super(entrypoint, credentials, options)
     end
 
     # Retrieve the tenant id for the passed credentials.

data/lib/hawkular/version.rb

@@ -4,5 +4,5 @@
 # @see https://github.com/hawkular
 module Hawkular
   # Version of the Hawkular Ruby Gem
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/spec/integration/inventory_spec.rb

@@ -93,6 +93,27 @@ module Hawkular::Inventory::RSpec
       expect(feeds.size).to be(1)
     end
 
+    it 'Should list resources for feed' do
+      resources = @client.list_resources_for_feed feed_id
+
+      expect(resources.size).to be(2)
+    end
+
+    it 'Should list feeds when using SSL without certificate' do
+      # change this to the real credentials when updating the VCR
+      @state[:super_secret_username] = 'username'
+      @state[:super_secret_password] = 'password'
+      creds = { username: @state[:super_secret_username],
+                password: @state[:super_secret_password] }
+      tori_url = 'https://hawkular.torii.gva.redhat.com/hawkular/inventory'
+      client = Hawkular::Inventory::InventoryClient.create(entrypoint: tori_url,
+                                                           credentials: creds,
+                                                           options: { verify_ssl: OpenSSL::SSL::VERIFY_NONE })
+      feeds = client.list_feeds
+
+      expect(feeds.size).to be(1)
+    end
+
     it 'Should list all the resource types' do
       types = @client.list_resource_types
       expect(types.size).to be(19)

data/spec/vcr_cassettes/Inventory/Templates/Should_list_feeds_when_using_SSL_without_certificate.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<%= super_secret_username %>:<%= super_secret_password %>@hawkular.torii.gva.redhat.com/hawkular/inventory/feeds
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Hawkular-Tenant:
+      - hawkular
+      Content-Type:
+      - application/json
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.6.3
+      Date:
+      - Fri, 27 May 2016 17:17:09 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '148'
+      Connection:
+      - keep-alive
+      Expires:
+      - '0'
+      Cache-Control:
+      - no-cache, no-store, must-revalidate
+      X-Powered-By:
+      - Undertow/1
+      Pragma:
+      - no-cache
+      X-Total-Count:
+      - '1'
+      Link:
+      - <http://hawkular.torii.gva.redhat.com/hawkular/inventory/feeds>; rel="current"
+      Strict-Transport-Security:
+      - max-age=31536000
+    body:
+      encoding: ASCII-8BIT
+      string: |-
+        [ {
+          "path" : "/t;0b6bda15-0d73-4375-b7a0-6318d53d7ac5/f;7ee8f677-9489-4da6-abb4-46b7e4bc228c",
+          "id" : "7ee8f677-9489-4da6-abb4-46b7e4bc228c"
+        } ]
+    http_version: 
+  recorded_at: Fri, 27 May 2016 17:15:26 GMT
+recorded_with: VCR 3.0.1

data/spec/vcr_cassettes/Inventory/Templates/Should_list_resources_for_feed.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://jdoe:password@localhost:8080/hawkular/inventory/feeds/<%= feed_uuid %>/resources
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Hawkular-Tenant:
+      - hawkular
+      Content-Type:
+      - application/json
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - '0'
+      Cache-Control:
+      - no-cache, no-store, must-revalidate
+      X-Powered-By:
+      - Undertow/1
+      Server:
+      - WildFly/10
+      Pragma:
+      - no-cache
+      Date:
+      - Mon, 13 Jun 2016 16:29:56 GMT
+      X-Total-Count:
+      - '2'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '786'
+      Link:
+      - <http://localhost:8080/hawkular/inventory/feeds/<%= feed_uuid %>/resources>;
+        rel="current"
+    body:
+      encoding: ASCII-8BIT
+      string: |-
+        [ {
+          "path" : "/t;hawkular/f;<%= feed_uuid %>/r;platform~%2FOPERATING_SYSTEM%3D<%= feed_uuid %>_OperatingSystem",
+          "name" : "<%= feed_uuid %>_OperatingSystem",
+          "type" : {
+            "path" : "/t;hawkular/f;<%= feed_uuid %>/rt;Operating%20System",
+            "name" : "Operating System",
+            "id" : "Operating System"
+          },
+          "id" : "platform~/OPERATING_SYSTEM=<%= feed_uuid %>_OperatingSystem"
+        }, {
+          "path" : "/t;hawkular/f;<%= feed_uuid %>/r;Local~~",
+          "name" : "WildFly Server [Local]",
+          "type" : {
+            "path" : "/t;hawkular/f;<%= feed_uuid %>/rt;WildFly%20Server",
+            "name" : "WildFly Server",
+            "id" : "WildFly Server"
+          },
+          "id" : "Local~~"
+        } ]
+    http_version: 
+  recorded_at: Mon, 13 Jun 2016 16:29:56 GMT
+recorded_with: VCR 3.0.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hawkular-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Libor Zoubek
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -181,7 +181,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "    A Ruby client for Hawkular\n"
+description: |2
+      A Ruby client for Hawkular
 email:
 - lzoubek@redhat.com
 - hrupp@redhat.com
@@ -309,6 +310,7 @@ files:
 - spec/vcr_cassettes/Inventory/Templates/Should_list_children_of_WildFly.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_children_of_nested_resource.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_feeds.yml
+- spec/vcr_cassettes/Inventory/Templates/Should_list_feeds_when_using_SSL_without_certificate.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_heap_metrics_for_WildFlys.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_metrics_for_WildFlys.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_metrics_of_given_metric_type.yml
@@ -317,6 +319,7 @@ files:
 - spec/vcr_cassettes/Inventory/Templates/Should_list_operation_definitions_of_given_resource_type.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_recursive_children_of_WildFly.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_relationships_of_WildFly.yml
+- spec/vcr_cassettes/Inventory/Templates/Should_list_resources_for_feed.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_types_with_bad_feed.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_types_with_feed.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_not_find_an_unknown_resource.yml
@@ -474,6 +477,7 @@ test_files:
 - spec/vcr_cassettes/Inventory/Templates/Should_list_children_of_WildFly.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_children_of_nested_resource.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_feeds.yml
+- spec/vcr_cassettes/Inventory/Templates/Should_list_feeds_when_using_SSL_without_certificate.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_heap_metrics_for_WildFlys.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_metrics_for_WildFlys.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_metrics_of_given_metric_type.yml
@@ -482,6 +486,7 @@ test_files:
 - spec/vcr_cassettes/Inventory/Templates/Should_list_operation_definitions_of_given_resource_type.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_recursive_children_of_WildFly.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_relationships_of_WildFly.yml
+- spec/vcr_cassettes/Inventory/Templates/Should_list_resources_for_feed.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_types_with_bad_feed.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_list_types_with_feed.yml
 - spec/vcr_cassettes/Inventory/Templates/Should_not_find_an_unknown_resource.yml