clowder-common-ruby 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b7e3334605263bb65b51caeee7801018273553660aa9079afa7dbcc9cc1334
-  data.tar.gz: b750dacf95ee93a1e055a30df375eddf9cebcb53905c3b06eaeb098b0d094166
+  metadata.gz: 892ebe1bfde6f2e84b314886d6b0b66fcf110cc01f1dd6ce554de39c09d9a9b3
+  data.tar.gz: ac45411ee564e2d6bd9d4b56f40dbfa972f559626878082ae53cdc388dd12947
 SHA512:
-  metadata.gz: d63024ea9077c527a4db8b658efb2badc03e5e3d7d1096dc8e609773112a246b08a0409c3fad8d808763911f51b8e2d2c82b25878fc6708bf831449907dd3f1a
-  data.tar.gz: 3ddc4be800c46e72b19abf6c679c8b0ffc805bda918c3a6a678a97d17cb9ee7bdf3332f9ad09dbc0dc1c465221e6dd1ef4a800a8c2e829e1848c4a306a9086ba
+  metadata.gz: 708a51e009bfdc3ae4d018a8df7933e5b7e06cfa2c0869389cde71f2449c3f735c71aa8828ecf7e9564d84f1da30ab6a06f844b79e02fe7fa5a2a5ca995e2a4d
+  data.tar.gz: 2879a909f197ca8153d0db2f60de26bf16717a43c2076f966606bb1921c92ded3d4865d93f9d2e65015664881c273f34feb4ad758ced8b84bee327a3f1dfc9fe

data/README.md

@@ -18,14 +18,14 @@ require 'clowder-common-ruby'
 
 @config ||= {}.tap do |options|
     # uses ENV['ACG_CONFIG'] or you can provide the path as a method param
-    
-  if ClowderCommonRuby::Config.clowder_enabled?     
-    config = ClowderCommonRuby::Config.load 
+
+  if ClowderCommonRuby::Config.clowder_enabled?
+    config = ClowderCommonRuby::Config.load
     options["webPorts"]         = config.webPort
     options["databaseHostname"] = config.database.hostname
     options["kafkaTopics"]      = config.kafka_topics
     # ...
-  else 
+  else
     options["webPorts"] = 3000
     options["databaseHostname"] = ENV['DATABASE_HOST']
   end
@@ -49,8 +49,8 @@ See [test.json](test.json) for all available values
 
 ### Kafka Topics
 
-Topics are structured as a hash `<requested_name> => <name>` 
-where requested_name is equal to the key topicName in your ClowdApp Custom Resource Definition(CRD)'s yaml
+Topics are structured as a hash `<requested_name> => <name>`
+where `requested_name` is equal to the key topicName in your ClowdApp Custom Resource Definition(CRD)'s yaml
 
 If your kafka is deployed in `local` or `app-interface` mode (see [doc](https://clowder-operator.readthedocs.io/en/latest/providers/kafka.html))
 the `name` is equal to the `requested_name`.
@@ -58,6 +58,6 @@ the `name` is equal to the `requested_name`.
 Testing
 -------
 
-export `ACG_CONFIG="test.json"; ruby lib/clowder-common-ruby/test.rb
+`ACG_CONFIG="test.json" ruby lib/clowder-common-ruby/test.rb`
 
-It inspects and prints the config file with loaded values or shows an error it the env. variable not configured correctly  
+It inspects and prints the config file with loaded values or shows an error it the env. variable not configured correctly

data/bin/output

@@ -0,0 +1,134 @@
+# This file is automatically generated by bin/json_schema_ruby
+require 'ostruct'
+
+module ClowderCommonRuby
+  class AppConfig < OpenStruct
+    attr_accessor :logging
+    attr_accessor :kafka
+    attr_accessor :database
+    attr_accessor :objectStore
+    attr_accessor :inMemoryDb
+    attr_accessor :featureFlags
+    attr_accessor :endpoints
+    attr_accessor :privateEndpoints
+
+    def initialize(attributes)
+      super
+      raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
+
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        h[k.to_sym] = v
+      end
+
+      @logging = LoggingConfig.new(attributes.fetch(:logging, {}))
+      @kafka = KafkaConfig.new(attributes.fetch(:kafka, {}))
+      @database = DatabaseConfig.new(attributes.fetch(:database, {}))
+      @objectStore = ObjectStoreConfig.new(attributes.fetch(:objectStore, {}))
+      @inMemoryDb = InMemoryDBConfig.new(attributes.fetch(:inMemoryDb, {}))
+      @featureFlags = FeatureFlagsConfig.new(attributes.fetch(:featureFlags, {}))
+      @endpoints = []
+      attributes.fetch(:endpoints, []).each do |attr|
+        @endpoints << DependencyEndpoint.new(attr)
+      end
+      @privateEndpoints = []
+      attributes.fetch(:privateEndpoints, []).each do |attr|
+        @privateEndpoints << PrivateDependencyEndpoint.new(attr)
+      end
+    end
+
+    def valid_keys
+      [].tap do |keys|
+        keys << :privatePort
+        keys << :publicPort
+        keys << :webPort
+        keys << :metricsPort
+        keys << :metricsPath
+        keys << :logging
+        keys << :kafka
+        keys << :database
+        keys << :objectStore
+        keys << :inMemoryDb
+        keys << :featureFlags
+        keys << :endpoints
+        keys << :privateEndpoints
+      end
+    end
+  end
+
+  class LoggingConfig < OpenStruct
+    attr_accessor :cloudwatch
+
+    def initialize(attributes)
+      super
+      raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
+
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        h[k.to_sym] = v
+      end
+
+      @cloudwatch = CloudWatchConfig.new(attributes.fetch(:cloudwatch, {}))
+    end
+
+    def valid_keys
+      [].tap do |keys|
+        keys << :type
+        keys << :cloudwatch
+      end
+    end
+  end
+
+  class CloudWatchConfig < OpenStruct
+
+    def initialize(attributes)
+      super
+      raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
+
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        h[k.to_sym] = v
+      end
+
+    end
+
+    def valid_keys
+      [].tap do |keys|
+        keys << :accessKeyId
+        keys << :secretAccessKey
+        keys << :region
+        keys << :logGroup
+      end
+    end
+  end
+
+  class KafkaConfig < OpenStruct
+    attr_accessor :brokers
+    attr_accessor :topics
+
+    def initialize(attributes)
+      super
+      raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
+
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        h[k.to_sym] = v
+      end
+
+      @brokers = []
+      attributes.fetch(:brokers, []).each do |attr|
+        @brokers << BrokerConfig.new(attr)
+      end
+      @topics = []
+      attributes.fetch(:topics, []).each do |attr|
+        @topics << TopicConfig.new(attr)
+      end
+    end
+
+    def valid_keys
+      [].tap do |keys|
+        keys << :brokers
+        keys << :topics
+      end
+    end
+  end

data/bin/ruby_class_converter.rb

@@ -76,7 +76,7 @@ class RubyClassConverter
     init_function << "      raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))\n"
     init_function << "\n"
     init_function << "      attributes = attributes.each_with_object({}) do |(k, v), h|\n"
-    init_function << "        raise \"The input [\#{k}] is invalid\" unless valid_keys.include?(k.to_sym)\n"
+    init_function << "        warn \"The input [\#{k}] is invalid\" unless valid_keys.include?(k.to_sym)\n"
     init_function << "        h[k.to_sym] = v\n"
     init_function << "      end\n"
     init_function << "\n"

data/bin/schema.json

@@ -139,6 +139,19 @@
                 "topics"
             ]
         },
+        "KafkaSASLConfig":{
+            "id": "kafkaSASLConfig",
+            "type": "object",
+            "description": "SASL Configuration for Kafka",
+            "properties": {
+                "username": {
+                    "type": "string"
+                },
+                "password": {
+                    "type": "string"
+                }
+            }
+        },
         "BrokerConfig": {
             "id": "brokerConfig",
             "type": "object",
@@ -149,6 +162,16 @@
                 },
                 "port": {
                     "type": "integer"
+                },
+                "cacert": {
+                    "type": "string"
+                },
+                "authtype": {
+                    "type": "string",
+                    "enum": ["mtls", "sasl"]
+                },
+                "sasl": {
+                    "$ref": "#/definitions/KafkaSASLConfig"
                 }
             },
             "required": [
@@ -167,10 +190,6 @@
                 "name": {
                     "description": "The name of the actual topic on the Kafka server.",
                     "type": "string"
-                },
-                "consumerGroup": {
-                    "description": "Defines the consumer group that should be used for the topic.",
-                    "type": "string"
                 }
             },
             "required": [
@@ -245,6 +264,10 @@
                     "description": "Defines the secret key for the specified bucket.",
                     "type": "string"
                 },
+                "region": {
+                    "description": "Defines the region for the specified bucket.",
+                    "type": "string"
+                },
                 "requestedName": {
                     "description": "The name that was requested for the bucket in the ClowdApp.",
                     "type": "string"
@@ -309,6 +332,10 @@
                 "port": {
                     "description": "Defines the port for the FeatureFlags server",
                     "type": "integer"
+                },
+                "clientAccessToken": {
+                    "description": "Defines the client access token to use when connect to the FeatureFlags server",
+                    "type": "string"
                 }
             },
             "required":[

data/lib/clowder-common-ruby/types.rb

@@ -17,7 +17,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -64,7 +64,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -86,7 +86,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -111,7 +111,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -140,7 +140,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -161,7 +161,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -183,7 +183,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -199,7 +199,6 @@ module ClowderCommonRuby
         keys << :adminUsername
         keys << :adminPassword
         keys << :rdsCa
-        keys << :sslMode
       end
     end
   end
@@ -211,7 +210,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -235,7 +234,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -264,7 +263,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -285,7 +284,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -308,7 +307,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 
@@ -331,7 +330,7 @@ module ClowderCommonRuby
       raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))
 
       attributes = attributes.each_with_object({}) do |(k, v), h|
-        raise "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
+        warn "The input [#{k}] is invalid" unless valid_keys.include?(k.to_sym)
         h[k.to_sym] = v
       end
 

data/lib/clowder-common-ruby/version.rb

@@ -1,3 +1,3 @@
 module ClowderCommonRuby
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/test.json

@@ -1,4 +1,12 @@
 {
+    "metadata": {
+      "deployments": [
+        {
+          "name": "svc",
+          "image": "quay.io/not_us/test_ruby_app:1337"
+        }
+      ]
+    },
     "webPort": 8000,
     "metricsPort": 9000,
     "metricsPath": "/metrics",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clowder-common-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Red Hat Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies: []
 description: This is a ruby interface for preparing Clowder variables.
 email:
@@ -20,6 +20,7 @@ files:
 - README.md
 - Rakefile
 - bin/json_schema_ruby
+- bin/output
 - bin/ruby_class_converter.rb
 - bin/schema.json
 - lib/clowder-common-ruby.rb