jcf 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33389a4011279ad183dc738318b71355a50601dde4f602d867cb060b305e7a49
-  data.tar.gz: 42f129b8aa7ab515bd51fac1f2c8f78ee6785f8750debb5778c88fa2d062dca1
+  metadata.gz: 65808aa6761614f5fd189ae66ffe581709eaaebe1bbca0b9833ee00ead7957be
+  data.tar.gz: 223665d3d2608a6a2a12d870e718fd969753c43fb73db5edad10c4bc4dfa3166
 SHA512:
-  metadata.gz: 35548f0ce298af159e532eb6b0517594d8e990857d8c5f77aab5e0b770920758e2a11f74ca063c113342adc1a46df120ed2d4577684ae69b60db90578a4a5d8d
-  data.tar.gz: 1fd422e325af12931d444728c4aca883eceaceab60bea50bc33e143bc62e70d783b1ed4103a2c181302fc6d5e7b44eeff70aa4ff53278cb12710e7b6ec806ee6
+  metadata.gz: 179b7adbe213bbc2a317fbd06407abdd1f2d3ce27e3da8e2e42495db4b9fc748d5a798f4920017d00d0039c34fa168d2dfa1ef721313853abf1202be5b5de4d7
+  data.tar.gz: f2e8ec3f17848da098d049ae482e8529927f77e52337023fbda07ce6f4a438cb2ac441d69095552396e913a59d2c6e52099171c6bfc0bea62f05d8a1c0785270

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.0.14] - 2023-10-19
+
+- Fix all the output I broker in the last release...I need some more extensive tests
+
+## [0.0.13] - 2023-10-19
+
+- Fix a bug where I'd left in some unnecessary code
+
 ## [0.0.12] - 2023-10-19
 
 - Refactored broker backend querying for metrics to use a plugin system that can be extended to support other brokers. Currently only the AWS and S3 broker is supported, but it should be easy to add others.

data/lib/jcf/cf/base.rb

@@ -40,7 +40,7 @@ module JCF
       class << self
         attr_accessor :endpoint
 
-        def keys; new.keys; end
+        def keys = new.keys
 
         def find_by(attrs)
           objects = all
@@ -48,6 +48,7 @@ module JCF
             keys = obj.attributes.keys & attrs.keys
             keys.all? do |key|
               return true if attrs[key].nil?
+
               obj.attributes[key].include? attrs[key]
             end
           end
@@ -72,6 +73,15 @@ module JCF
           endpoint || name.demodulize.tableize
         end
 
+        def format(data)
+          data.each_with_object({}) do |broker, h|
+            broker.attributes.each do |k, v|
+              h[k] ||= []
+              h[k] << v
+            end
+          end
+        end
+
         private
 
         def resources(params: {})

data/lib/jcf/cli/commands/cf/metrics.rb

@@ -107,6 +107,7 @@ module JCF
               end
 
               # values = { guid: { name: "name", space: "space" }, guid2: { name: "name2", space: "space2" } }
+              # output = { header1: %w[name1 name2], header2: %w[space1 space2]}
               output = Hash.new { |hash, key| hash[key] = [] }
               values.each do |guid, metrics|
                 metrics.each do |k, v|

data/lib/jcf/cli/commands/cf/organizations.rb

@@ -13,12 +13,12 @@ module JCF
           argument :name, required: false, desc: "Organization name"
 
           def call(name: nil, **)
-            values = if name
-              Organization.find_by(name: name).collect(&:values)
-            else
-              Organization.all.collect(&:values)
-            end
-            out.puts formatter.format(headers: Organization.keys, values: values)
+            data = if name
+                     Organization.find_by(name: name)
+                   else
+                     Organization.all
+                   end
+            out.puts formatter.format(data: JCF::CF::Base.format(data))
           end
         end
       end

data/lib/jcf/cli/commands/cf/quota.rb

@@ -13,11 +13,12 @@ module JCF
           option :org, aliases: ["-o", "--org", "--organization"], type: :string, desc: "Filter to an organization"
 
           def call(name: nil, **options)
-            if name
-              out.puts formatter.format(JCF::CF::Quota.find_by(name: name))
-            else
-              out.puts formatter.format(JCF::CF::Quota.all(org: options[:org]))
-            end
+            data = if name
+                     JCF::CF::Quota.find_by(name: name)
+                   else
+                     JCF::CF::Quota.all(org: options[:org])
+                   end
+            out.puts formatter.format(data: JCF::CF::Base.format(data))
           end
         end
       end

data/lib/jcf/cli/commands/cf/service_brokers.rb

@@ -8,19 +8,25 @@ module JCF
     module Commands
       module CF
         class ServiceBrokers < Command
+          include JCF::CF
+
           argument :name, required: false, desc: "Service Broker name"
 
           option :space, aliases: ["-s", "--space"], type: :string, desc: "Filter to a space"
 
           def call(name: nil, **options)
             if name
-              out.puts formatter.format(JCF::CF::ServiceBroker.find_by(name: name))
+              out.puts formatter.format(data: JCF::CF::ServiceBroker.find_by(name: name))
             else
-              out.puts formatter.format(
-                JCF::CF::ServiceBroker.all(
-                  space_guids: options[:space]
-                )
-              )
+              # [
+              #   #<ServiceBroker @name="cdn-broker", @guid="aaaa", @relationships=[]>,
+              #   #<ServiceBroker @name="rds-broker", @guid="bbbb", @relationships=[]>
+              # ]
+              # output = { name: %w[cdn-broker rds-broker], header2: %w[aaaa bbbb]}
+
+              data = ServiceBroker.all(space_guids: options[:space])
+
+              out.puts formatter.format(data: JCF::CF::Base.format(data))
             end
           end
         end

data/lib/jcf/cli/commands/cf/service_instances.rb

@@ -15,21 +15,19 @@ module JCF
           option :service_plan, aliases: ["-p", "--plan", "--service-plan"], type: :string,
                                 desc: "Filter to a service plan"
 
-          # rubocop:disable Metrics/MethodLength
           def call(name: nil, **options)
-            if name
-              out.puts formatter.format(JCF::CF::ServiceInstance.find_by(name: name))
-            else
-              out.puts formatter.format(
-                JCF::CF::ServiceInstance.all(
-                  organization_guids: options[:org],
-                  space_guids: options[:space],
-                  service_plan: options[:service_plan]
-                )
-              )
-            end
+            data = if name
+                     JCF::CF::ServiceInstance.find_by(name: name)
+                   else
+                     JCF::CF::ServiceInstance.all(
+                       organization_guids: options[:org],
+                       space_guids: options[:space],
+                       service_plan: options[:service_plan]
+                     )
+                   end
+
+            out.puts formatter.format(data: JCF::CF::Base.format(data))
           end
-          # rubocop:enable Metrics/MethodLength
         end
       end
     end

data/lib/jcf/cli/commands/cf/service_offerings.rb

@@ -13,11 +13,13 @@ module JCF
           option :org, aliases: ["-o", "--org", "--organization"], type: :string, desc: "Filter to an organization guid"
 
           def call(name: nil, **options)
-            if name
-              out.puts formatter.format(JCF::CF::ServiceOffering.find_by(name: name))
-            else
-              out.puts formatter.format(JCF::CF::ServiceOffering.all(organization_guids: options[:org]))
-            end
+            data = if name
+                     JCF::CF::ServiceOffering.find_by(name: name)
+                   else
+                     JCF::CF::ServiceOffering.all(organization_guids: options[:org])
+                   end
+
+            out.puts formatter.format(data: JCF::CF::Base.format(data))
           end
         end
       end

data/lib/jcf/cli/commands/cf/service_plans.rb

@@ -13,15 +13,13 @@ module JCF
           option :org, aliases: ["-o", "--org", "--organization"], type: :string, desc: "Filter to an organization"
 
           def call(name: nil, **options)
-            if name
-              out.puts formatter.format(JCF::CF::ServicePlan.find_by(name: name))
-            else
-              out.puts formatter.format(
-                JCF::CF::ServicePlan.all(
-                  organization_guids: options[:org]
-                )
-              )
-            end
+            data = if name
+                     JCF::CF::ServicePlan.find_by(name: name)
+                   else
+                     JCF::CF::ServicePlan.all(organization_guids: options[:org])
+                   end
+
+            out.puts formatter.format(data: JCF::CF::Base.format(data))
           end
         end
       end

data/lib/jcf/cli/commands/cf/services.rb

@@ -9,16 +9,11 @@ module JCF
     module Commands
       module CF
         class Services < Command
-          argument :broker, required: false, desc: "Broker name"
+          argument :broker, required: true, desc: "Broker name"
 
-          def call(broker: nil, **)
+          def call(broker:, **)
             # gather all service offerings and plans for a single broker
-            if broker
-              out.puts formatter.format(JCF::CF::Services.first(name: broker), tree: true)
-            else
-              # TODO: this is a stub, it should be a list of all brokers
-              # out.puts formatter.format(JCF::CF::Organization.all)
-            end
+            out.puts formatter.format(data: JCF::CF::Services.first(name: broker), tree: true)
           end
         end
       end

data/lib/jcf/cli/commands/cf/spaces.rb

@@ -13,11 +13,13 @@ module JCF
           option :org, aliases: ["-o", "--org", "--organization"], type: :string, desc: "Filter to an organization"
 
           def call(name: nil, **options)
-            if name
-              out.puts formatter.format(JCF::CF::Space.find_by(name: name))
-            else
-              out.puts formatter.format(JCF::CF::Space.all(organization_guids: options[:org]))
-            end
+            data = if name
+                     JCF::CF::Space.find_by(name: name)
+                   else
+                     JCF::CF::Space.all(organization_guids: options[:org])
+                   end
+
+            out.puts formatter.format(data: JCF::CF::Base.format(data))
           end
         end
       end

data/lib/jcf/cli/commands/cf/users.rb

@@ -11,11 +11,13 @@ module JCF
           argument :name, required: false, desc: "Partial username"
 
           def call(name: nil, **_options)
-            if name
-              out.puts formatter.format(JCF::CF::User.all(partial_usernames: name))
-            else
-              out.puts formatter.format(JCF::CF::User.all)
-            end
+            data = if name
+                     JCF::CF::User.all(partial_usernames: name)
+                   else
+                     JCF::CF::User.all
+                   end
+
+            out.puts formatter.format(data: JCF::CF::Base.format(data))
           end
         end
       end

data/lib/jcf/cli/commands/plugins.rb

@@ -10,10 +10,20 @@ module JCF
           out.puts "JCF Plugins:"
           plugin_dir = File.join(JCF.root, "jcf", "plugins", "*.rb")
           pp "plugin dir: #{plugin_dir}" if ENV["DEBUG"]
+          load_plugins(plugin_dir)
+          list_plugins
+        end
+
+        private
+
+        def load_plugins(plugin_dir)
           Dir[plugin_dir].each do |plugin|
             out.puts "  file: #{File.basename(plugin, ".rb")}" if ENV["DEBUG"]
             JCF::Plugins.load_plugin(File.basename(plugin, ".rb").to_sym)
           end
+        end
+
+        def list_plugins
           JCF::Plugins.plugins.each do |plugin|
             out.puts "  #{plugin}"
           end

data/lib/jcf/cli/commands.rb

@@ -5,6 +5,7 @@ module JCF
     module Commands
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.register_commands!
       register "version", Commands::Version, aliases: ["v", "-v", "--version"]
       register "plugins", Commands::Plugins
@@ -19,5 +20,6 @@ module JCF
       register "service_instances", Commands::CF::ServiceInstances, aliases: %w[si service_instance]
       register "service_plans", Commands::CF::ServicePlans, aliases: %w[sp service_plan]
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/jcf/cli/errors.rb

@@ -5,13 +5,9 @@ module JCF
     class Error < StandardError
     end
 
-    class NotImplementedError < Error
-    end
-
-    class NotLoggedInError < StandardError
-    end
-
-    class InvalidOptionError < StandardError
-    end
+    class NotImplementedError < Error; end
+    class NotLoggedInError < StandardError; end
+    class InvalidOptionError < StandardError; end
+    class EmptyResultError < StandardError; end
   end
 end

data/lib/jcf/cli/output_formatters/text.rb

@@ -7,6 +7,19 @@ module JCF
     module OutputFormatters
       class Text
         class << self
+          # @param data [Hash] the data to be formatted
+          # @param tree [Boolean] whether to format as a tree or a table
+          # @return [String] the formatted data
+          # @example
+          #
+          # data: { header1: %w[name1 name2], header2: %w[space1 space2]}
+          # output:
+          # ┌────────┬────────┐
+          # │header1 │header2 │
+          # ├────────┼────────┤
+          # │name1   │space1  │
+          # │name2   │space2  │
+          # └────────┴────────┘
           def format(data:, tree: false)
             return "" if data.nil? || data.empty?
 
@@ -19,9 +32,15 @@ module JCF
 
           private
 
+          # @param data [Hash] the data to be formatted
+          # @return [String] the formatted data
+          # @example
+          #
+          # data: { header1: %w[name1 name2], header2: %w[space1 space2]}
+          # values: [["name1", "space1"], ["name2", "space2"]]
           def render_data(data)
-            keys = collect_keys(data)
-            values = collect_values(data)
+            keys = data.keys.collect(&:to_s)
+            values = data.values.transpose
 
             table = TTY::Table.new(keys, values)
             table.render(:unicode, resize: true)
@@ -30,33 +49,6 @@ module JCF
           def render_tree(data)
             TTY::Tree.new(data).render
           end
-
-          def collect_keys(data)
-            return ["Empty result"] if !data || data.empty?
-
-            if data.is_a?(Array)
-              data.first.keys.collect(&:to_s)
-            elsif data.is_a?(Hash)
-              data.keys.collect(&:to_s) || ["Empty result"]
-            else
-              data.keys.collect(&:to_s)
-            end
-          end
-
-          # Hash:
-          #   values: [["name1", "name2"], ["space1", "space2"]]
-          #   output: [["name1", "space1"], ["name2", "space2"]]
-          def collect_values(data)
-            return [["Empty result"]] if !data || data.empty?
-
-            if data.is_a?(Array)
-              data.map { |d| d.attributes.values.collect(&:to_s) }
-            elsif data.is_a?(Hash)
-              data.values.transpose
-            else
-              [data.attributes.values.collect(&:to_s)]
-            end
-          end
         end
       end
     end

data/lib/jcf/cli.rb

@@ -25,7 +25,7 @@ module JCF
     puts "Validating plugin (#{plugin}) implementation conforms to interface" if ENV["DEBUG"]
 
     %i[metrics names values].each do |method|
-      raise "Plugin does not conform to interface (missing method \"#{method.to_s}\")" \
+      raise "Plugin does not conform to interface (missing method \"#{method}\")" \
         unless plugin.new(name: nil).respond_to?(method)
     end
   rescue JCF::CLI::NotLoggedInError => e
@@ -46,6 +46,7 @@ module JCF
       puts "Loading plugin #{name}" if ENV["DEBUG"]
       require "jcf/plugins/#{name}"
       raise "Plugin didn't correctly register itself" unless @plugins[name]
+
       @plugins[name]
     end
 
@@ -98,8 +99,6 @@ module JCF
     require_relative "cli/output_formatters"
     require_relative "cli/commands"
     require_relative "cli/errors"
-    # require_relative "cf.rb"
-    require_relative "aws/cloudwatch"
 
     extend Dry::CLI::Registry
 

data/lib/jcf/plugins/aws_rds.rb

@@ -33,7 +33,7 @@ module JCF
       end
 
       def to_s
-       metrics.to_s
+        metrics.to_s
       end
 
       private
@@ -59,8 +59,8 @@ module JCF
       def storage_allocated(name:)
         rds = Aws::RDS::Client.new
         size = rds
-                .describe_db_instances(db_instance_identifier: name)
-                .db_instances.first.allocated_storage
+               .describe_db_instances(db_instance_identifier: name)
+               .db_instances.first.allocated_storage
         Filesize.from("#{size} GB").to_i
       end
 
@@ -78,18 +78,18 @@ module JCF
         cloudwatch(name: name, metric: :cpu)
       end
 
-      # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/MethodLength
       def cloudwatch(name:, metric:)
         cloudwatch = Aws::CloudWatch::Client.new
         res = cloudwatch.get_metric_statistics({
-          namespace: "AWS/RDS",
-          metric_name: metric,
-          dimensions: [{ name: "DBInstanceIdentifier", value: name }],
-          start_time: 1.day.ago,
-          end_time: Time.now,
-          period: 86_400,
-          statistics: ["Average"]
-        })
+                                                 namespace: "AWS/RDS",
+                                                 metric_name: metric,
+                                                 dimensions: [{ name: "DBInstanceIdentifier", value: name }],
+                                                 start_time: 1.day.ago,
+                                                 end_time: Time.now,
+                                                 period: 86_400,
+                                                 statistics: ["Average"]
+                                               })
 
         pp res if ENV["DEBUG"]
 
@@ -97,7 +97,7 @@ module JCF
       rescue Aws::Errors::MissingCredentialsError
         puts "You are not logged in to an AWS shell.  'gds aws <ACCOUNT> -s'"
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/MethodLength
 
       def to_gb(bytes)
         Filesize.from("#{bytes} b").to("GB").to_fs(:rounded, precision: 2)

data/lib/jcf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JCF
-  VERSION = "0.0.12"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jcf
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.1.0
 platform: ruby
 authors:
 - Jamie van Dyke
@@ -275,7 +275,6 @@ files:
 - lib/.DS_Store
 - lib/jcf.rb
 - lib/jcf/.DS_Store
-- lib/jcf/aws/cloudwatch.rb
 - lib/jcf/cf.rb
 - lib/jcf/cf/.DS_Store
 - lib/jcf/cf/base.rb

data/lib/jcf/aws/cloudwatch.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require "aws-sdk-cloudwatch"
-require "aws-sdk-rds"
-require "aws-sdk-s3"
-require "active_support/core_ext/integer/time"
-require "active_support/isolated_execution_state"
-require "filesize"
-
-module JCF
-  module AWS
-    class CloudWatch
-      NAMESPACES = {
-        rds: "AWS/RDS",
-        s3: "AWS/S3"
-      }.freeze
-      METRICS = {
-        free_storage: "FreeStorageSpace",
-        allocated_storage: "AllocatedStorage",
-        iops: "WriteIOPS",
-        cpu: "CPUUtilization"
-      }.freeze
-
-      def storage_free(name:)
-        storage_free = rds(name: name, metric: :free_storage)
-        storage_free.to_i
-      end
-
-      def storage_allocated(name:)
-        rds = Aws::RDS::Client.new
-        size = rds
-               .describe_db_instances(db_instance_identifier: name)
-               .db_instances.first.allocated_storage
-        Filesize.from("#{size} GB").to_i
-      end
-
-      def rds_storage_used(name:)
-        free = storage_free(name: name)
-        allocated = storage_allocated(name: name)
-        allocated - free
-      end
-
-      def s3_storage_used(name:)
-        s3 = Aws::S3::Client.new
-        total_size = 0
-        response = s3.list_objects_v2(bucket: name)
-        response.contents.each do |object|
-          total_size += object.size
-        end
-        total_size
-      end
-
-      def iops(name:)
-        rds(name: name, metric: :iops)
-      end
-
-      def cpu(name:)
-        rds(name: name, metric: :cpu)
-      end
-
-      private
-
-      def rds(name:, metric:)
-        dimensions = { name: "DBInstanceIdentifier", value: name }
-        aws(namespace: NAMESPACES[:rds], metric: METRICS[metric], dimensions: dimensions)
-      end
-
-      # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      def aws(namespace:, metric:, dimensions:, start_time: nil, end_time: nil, period: nil, statistic: nil)
-        cloudwatch = Aws::CloudWatch::Client.new
-        res = cloudwatch.get_metric_statistics({
-                                                 namespace: namespace,
-                                                 metric_name: metric,
-                                                 dimensions: [dimensions],
-                                                 start_time: (start_time || 1.day.ago),
-                                                 end_time: (end_time || Time.now),
-                                                 period: (period || 86_400),
-                                                 statistics: [(statistic || "Average")]
-                                               })
-
-        pp res if ENV["DEBUG"]
-
-        res.datapoints.first&.average || 0
-      rescue Aws::Errors::MissingCredentialsError
-        puts "You are not logged in to an AWS shell.  'gds aws <ACCOUNT> -s'"
-      end
-      # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    end
-  end
-end