clowder-common-ruby 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d168646c5d5d8cade020019e0a92c9abbf784aee38e000bb09e7385eb7bdcd33
-  data.tar.gz: d9bfd039f488a90bbea2d5174812f7d7c26129cf4f9618f03cf8e8c2b56499ca
+  metadata.gz: b5a31730c5274d307ff7d9ef22f75d2e70a6c5ca44fb66d26f8b7eee4affdd7f
+  data.tar.gz: a70f87a031e547234e2f4d4049702147624127b6ff8e4824e320b1dea69dd7b2
 SHA512:
-  metadata.gz: 6084c009bf2b0dd7d04b65d186d96d1f0e3c26f1a3a332e39a2278696d0fdb110ae290ccdf9d7ac42c25a5dc69952e493960a1fa77a8966f1417982d2fbb8643
-  data.tar.gz: 1c834382855bcb9d0844715225b271b2f179f9d852790a6c96cfde2f2e4124a41c876cd2778eb95bc3a13460565480d50913339ed3a8d96a7334aaf10044a944
+  metadata.gz: a50970cfbc1d9dc96547f358c598043db05a71be2420e1a4094f7b437b0af49666a7480aac53566df579230859158b567ba6e7a98b007bb5aa8ae28e2d86a5ae
+  data.tar.gz: 8583447351853c20a44d0d8eacc0a31e6f93c1a2db24f83caa2b24f0caf6da68ced490aedce016aa0256d544f29351e890933f66ff811d92a9bbca3b643c4319

data/README.md

@@ -47,6 +47,10 @@ The ``clowder`` library also comes with several other helpers
 
 See [test.json](test.json) for all available values
 
+### Usage in Rails 
+
+In Rails applications, requiring the ```clowder-common-ruby/engine``` will run the initializer, the output of which will be accessible under ```Settings```.  
+
 ### Kafka Topics
 
 Topics are structured as a hash `<requested_name> => <name>`

data/bin/bump_version

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+text = File.read('../lib/clowder-common-ruby/version.rb')
+
+patch = text.sub(/^.*'\d+\.\d+\.(\d+)'.*$/m, '\1').to_i
+
+File.open('../lib/clowder-common-ruby/version.rb', 'w') do |f|
+  f.write text.sub(/^(.*'\d+\.\d+\.)\d+('.*)$/m, "\\1#{patch + 1}\\2")
+end

data/bin/schema.json

@@ -72,7 +72,7 @@
                     "type": "string"
                 },
                 "hashCache": {
-                    "description": "A set of config/secret hashes",
+                    "description": "A set of configMap/secret hashes",
                     "type": "string"
                 }
             },

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

@@ -0,0 +1,7 @@
+require 'rails/engine'
+
+module ClowderCommonRuby
+  class Engine < ::Rails::Engine
+    isolate_namespace(ClowderCommonRuby)
+  end
+end

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

@@ -0,0 +1,176 @@
+require 'clowder-common-ruby'
+
+module ClowderCommonRuby
+  class RailsConfig
+    class << self
+      # Rails configuration hash
+      def to_h
+        config = ClowderCommonRuby::Config.load
+
+        {
+          kafka: configure_kafka(config),
+          logging: configure_cloudwatch(config),
+          redis: configure_redis(config),
+          endpoints: configure_endpoints(config, :dependency_endpoints),
+          private_endpoints: configure_endpoints(config, :private_dependency_endpoints),
+          database: configure_database(config),
+          prometheus_exporter_port: config&.metricsPort,
+          tls_ca_path: config.tlsCAPath,
+          web_port: config.webPort
+        }
+      end
+
+      # Short path for db config
+      def db_config
+        config = ClowderCommonRuby::Config.load
+        
+        configure_database(config)
+      end
+      
+      private 
+
+      # Kafka configuration hash
+      def configure_kafka(config)
+        # In case there are no kafka brokers, an empty string is ensured in place of ':'
+        build_kafka_security(config).merge(
+          brokers: build_kafka_brokers(config) || '',
+          topics: build_kafka_topics(config) 
+        )
+      end
+
+      # Kafka security settings hash
+      def build_kafka_security(config)
+        server_config = config.kafka.brokers[0]
+        authtype = server_config&.dig('authtype')
+        cacert = server_config&.dig('cacert')
+
+        return { security_protocol: 'plaintext' } unless authtype
+
+        unless authtype == 'sasl'
+          raise "Unsupported Kafka security protocol '#{authtype}'" 
+        end
+
+        {
+          sasl_username: server_config&.dig('sasl', 'username'),
+          sasl_password: server_config&.dig('sasl', 'password'),
+          sasl_mechanism: server_config&.dig('sasl', 'saslMechanism'),
+          security_protocol: server_config&.dig('sasl', 'securityProtocol'),
+          ssl_ca_location: build_kafka_certificate(cacert)
+        }.compact
+        # In case build_kafka_certificate returns nil, ssl_ca_location is removed from the hash with compact
+      end
+
+      # Gives location of ssl certificate and makes sure it exists
+      def build_kafka_certificate(cacert)
+        return unless cacert.present? 
+
+        kafka_config[:ssl_ca_location] = Rails.root.join('tmp', 'kafka_ca.crt')
+
+        write_temporary_file(kafka_config[:ssl_ca_location], cacert)
+
+        kafka_config[:ssl_ca_location]
+      end
+
+      # Kafka brokers list
+      def build_kafka_brokers(config)
+        config.kafka.brokers&.map do |broker|
+          "#{broker.hostname}:#{broker.port}"
+        end&.join(',')
+      end
+
+      # Kafka topics hash
+      def build_kafka_topics(config)
+        config.kafka.topics&.each_with_object({}) do |topic, obj|
+          k = "#{topic.name.sub(/^platform./, '')}".parameterize.underscore.to_sym
+          obj[k] = topic.name
+        end
+      end
+
+      # Redis configuration hash
+      def configure_redis(config)
+        inMemoryDb = config&.dig('inMemoryDb')
+        redis_url = "redis://#{inMemoryDb.dig('hostname')}:#{inMemoryDb.dig('port')}"
+
+        {
+          url: redis_url,
+          password: inMemoryDb.dig('password')
+        }
+      end
+
+      # Cloudwatch configuration hash
+      def configure_cloudwatch(config)
+        cloudwatch = config.logging&.cloudwatch
+
+        {
+          region: cloudwatch&.region,
+          log_group: cloudwatch&.logGroup,
+          log_stream: Socket.gethostname,
+          type: config.logging&.type,
+          credentials: {
+            access_key_id: cloudwatch&.accessKeyId,
+            secret_access_key: cloudwatch&.secretAccessKey
+          }
+        }
+      end
+
+      # All endpoints' configuration hash
+      def configure_endpoints(config, field)
+        config.try(field)&.each_with_object({}) do |(name, endpoint), obj|
+          service = endpoint.dig('service')
+
+          next unless service
+
+          key = name.underscore.to_sym
+          obj[key] = build_endpoint(config, service)
+        end
+      end
+
+      # Endpoint configuration hash
+      def build_endpoint(config, endpoint)
+        scheme = config.tlsCAPath ? 'https' : 'http'
+        port = config.tlsCAPath ? endpoint.tlsPort : endpoint.port
+        host = "#{endpoint.hostname}:#{port}"
+
+        {
+          scheme: scheme,
+          host: host,
+          url: "#{scheme}://#{host}"
+        }
+      end
+
+      # Database configuration hash
+      def configure_database(config)
+        {
+          database: config.database.name,
+          username: config.database.username,
+          password: config.database.password,
+          host: config.database.hostname,
+          port: config.database.port,
+          admin_username: config.database.adminUsername,
+          admin_password: config.database.adminPassword,
+          rds_ca: config.database.rdsCa,
+          ssl_mode: config.database.sslMode,
+          ssl_root_cert: build_database_certificate(config.database.rdsCa)
+        }
+      end
+      
+      # Gives location of database ssl certificate and makes sure it exists
+      def build_database_certificate(rdsca)
+        return unless rdsca.present?
+
+        db_config = Rails.root.join('tmp', 'rdsCa')
+
+        write_temporary_file(db_config, rdsca)
+
+        db_config
+      end
+
+      # Creates and writes file if it doesn't exist
+      def write_temporary_file(path, content)
+        File.open(path, 'w') do |f|
+          f.write(content)
+        end unless File.exist?(path)        
+      end
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module ClowderCommonRuby
-  VERSION = '0.2.6'.freeze
+  VERSION = '0.3.0'.freeze # Patch version is being automatically bumped
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: clowder-common-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Red Hat Developers
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies: []
 description: This is a ruby interface for preparing Clowder variables.
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -19,11 +19,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/bump_version
 - bin/json_schema_ruby
 - bin/ruby_class_converter.rb
 - bin/schema.json
 - lib/clowder-common-ruby.rb
 - lib/clowder-common-ruby/config.rb
+- lib/clowder-common-ruby/engine.rb
+- lib/clowder-common-ruby/rails_config.rb
 - lib/clowder-common-ruby/test.rb
 - lib/clowder-common-ruby/types.rb
 - lib/clowder-common-ruby/version.rb
@@ -33,7 +36,7 @@ homepage: https://github.com/RedHatInsights/clowder-common-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -48,8 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Supporting files and libraries for Clowder environmental variables.
 test_files: []