jcf 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9477e6264cb699c3505cfe016acb802bff09e9c71fe98072ea9a1598a021119
-  data.tar.gz: 05a70e89d7593faa6308a6d0b78d03a3990466dae549a8343625288bf104a4ea
+  metadata.gz: 33389a4011279ad183dc738318b71355a50601dde4f602d867cb060b305e7a49
+  data.tar.gz: 42f129b8aa7ab515bd51fac1f2c8f78ee6785f8750debb5778c88fa2d062dca1
 SHA512:
-  metadata.gz: ec4fa652bb3341babc362145fe150e9418944e3b5c2d5aeb2b798c7d82af39849a3c467b1432941638a9c4b0650f468b56c537e927c4ab5b7793884faf31e491
-  data.tar.gz: 25bad72e4df60a12ef1df353abb6472e9db88623f9a4c7ebcd1e4150222bb92c4a2a63684582c9b5758eec353bdcab263b59cfdd67e259aeb42be071f9691827
+  metadata.gz: 35548f0ce298af159e532eb6b0517594d8e990857d8c5f77aab5e0b770920758e2a11f74ca063c113342adc1a46df120ed2d4577684ae69b60db90578a4a5d8d
+  data.tar.gz: 1fd422e325af12931d444728c4aca883eceaceab60bea50bc33e143bc62e70d783b1ed4103a2c181302fc6d5e7b44eeff70aa4ff53278cb12710e7b6ec806ee6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [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.
+- Add a `jcf plugins` command to list available plugins (currently only ones in the `lib/jcf/plugins` directory)
+- Refactored specs for output formatters
+
+## [0.0.11] - 2023-10-12
+
+- Add a tree output for a new command `jcf services NAME` that will show all the offerings and instances for that broker. In a tree. Because trees are cool.
+
 ## [0.0.10] - 2023-10-03
 
 - Added the template parsing options to metrics command

data/README.md

@@ -1,8 +1,25 @@
-![tests](https://github.com/fearoffish/paas-org-metric-gathering-gem/actions/workflows/main.yml/badge.svg)
+[![tests](https://github.com/fearoffish/paas-org-metric-gathering-gem/actions/workflows/main.yml/badge.svg)](https://github.com/fearoffish/paas-org-metric-gathering-gem/actions)
 [![Gem Version](https://badge.fury.io/rb/jcf.svg)](https://badge.fury.io/rb/jcf)
 
 # Jcf
 
+## What is it?
+
+If you use CloudFoundry you'll know that some commands/queries require you to use `cf curl` and that can get a little tedious. This gem is a wrapper around `cf curl` to make it easier to query the CloudFoundry API, as well as being able to query the CloudWatch metrics for the AWS services that are used by the CF services.
+
+Some handy features:
+
+```
+jcf u jamie # find all users with a partial username of jamie
+jcf o foo  # find all orgs with a partial name of foo
+jcf sb s3 # find all service brokers with a partial name of s3
+jcf so bucket # find all service offerings with a partial name of bucket
+jcf sp medium # find all service plans with a partial name of medium
+
+# find all metrics for the rds-broker service, postgres offering, output it to a csv file
+jcf m postgres -t 'rdsbroker-{guid}' -o admin -f csv --ouput postgres-metrics.csv
+```
+
 ## Installation
 
 ```sh
@@ -134,3 +151,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Jcf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fearoffish/paas-org-metric-gathering-gem/blob/main/CODE_OF_CONDUCT.md).
+
+## Credits
+
+- Hanami for the [CLI framework](https://hanamirb.org/guides/1.3/cli/overview/)
+  I borrowed some ideas from there. Thanks!

data/lib/jcf/cf/base.rb

@@ -23,6 +23,14 @@ module JCF
         { name: name, guid: guid, relationships: relationships }
       end
 
+      def keys
+        attributes.keys
+      end
+
+      def values
+        attributes.values
+      end
+
       def initialize(name: nil, guid: nil, relationships: nil)
         @name = name
         @guid = guid
@@ -32,12 +40,14 @@ module JCF
       class << self
         attr_accessor :endpoint
 
+        def keys; new.keys; end
+
         def find_by(attrs)
           objects = all
           objects.find_all do |obj|
-            # only find by attributes we have and our object has
             keys = obj.attributes.keys & attrs.keys
             keys.all? do |key|
+              return true if attrs[key].nil?
               obj.attributes[key].include? attrs[key]
             end
           end
@@ -51,6 +61,7 @@ module JCF
           new(guid: guid).populate!
         end
 
+        # TODO: make this less greedy
         def all(params = {})
           params.compact!
 

data/lib/jcf/cf/services.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module JCF
+  module CF
+    class Services
+      def self.first(name:)
+        # Find the broker, then find all offerings for that broker, then all plans
+        # { broker: { offerings: { plans: [] } }
+        # e.g. { "p-mysql (guid)": { "10mb (guid)": [], "100mb (guid)": [] } }
+        broker = ServiceBroker.first(name: name)
+        offerings = ServiceOffering.all(service_broker_guids: broker.guid).map do |offering|
+          plans = ServicePlan.all(service_offering_guids: offering.guid)
+          { offering.to_s => plans }
+        end
+        { broker.to_s => offerings }
+      end
+    end
+  end
+end

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

@@ -14,38 +14,51 @@ module JCF
     module Commands
       module CF
         class Metrics < Command
-          argument :offering, required: true, values: %w[postgres aws-s3-bucket],
-                          desc: "Choose a service instance offering to query"
+          argument :broker, required: true,
+            desc: "Choose a service instance offering to query. Get the broker name from the command: jcf sb"
+          argument :iaas_plugin, aliases: ["-m"], required: true, type: :string,
+            values: ::JCF::Plugins.plugins.keys.collect(&:to_s),
+            desc: "Select a IaaS plugin this broker is backed by"
 
           option :template, aliases: ["-t"], required: true, type: :string,
-                   desc: "Template for backend service instance names e.g. \"rdsbroker-{guid}-{name}\""
+            desc: "Template for backend service instance names e.g. \"rdsbroker-{guid}-{name}\""
           option :values, aliases: ["-v"], required: false, type: :string, default: "",
-                   desc: "Values for the template. 'guid' is the service instance guid e.g. \"name=test\""
+            desc: "Values for the template. 'guid' is the service instance guid e.g. \"name=test\""
           option :org, aliases: ["-o"], required: true, type: :string,
-                       desc: "Choose an organization (can be multiple comma-separated)"
+            desc: "Choose an organization (can be multiple comma-separated)"
           option :name, aliases: ["-n"], type: :string, desc: "Choose a service instance name"
 
           def call(*_args, **options)
             validate_options(options)
+            JCF.plugin options[:iaas_plugin].to_sym
+            plugin = JCF::Plugins.plugins[options[:iaas_plugin].to_sym]
+
             orgs = options[:org].include?(",") ? options[:org].split(",") : [options[:org]]
 
+            brokers = service_brokers.select { |b| b.name == options[:broker] }
+            # find the offerings for those brokers
+            offerings = service_offerings.select do |o|
+              brokers.find { |b| b.guid == o.relationships.service_broker.guid }
+            end
+            if offerings && offerings.empty?
+              err.puts "No offerings found for broker #{options[:broker]}"
+              exit(1)
+            end
+            err.puts "Found #{offerings.count} offerings"
+
             orgs.each do |org|
               org_guid = organizations.find { |o| o.name == org }.guid
               err.puts "Found org guid: #{org_guid}"
 
-              offering_guid = service_offerings.find { |s| s.name == options[:offering] }&.guid
-              err.puts "Found offering guid: #{offering_guid}"
-
-              unless offering_guid
-                err.puts "No offerings found for type #{options[:offering]}"
-                exit(1)
-              end
-
-              # find the plans for those gatherings
+              # find the plans for those offerings
               plan_guids = service_plans.find_all do |plan|
-                plan.relationships.service_offering.guid == offering_guid
+                offerings.collect(&:guid).include? plan.relationships.service_offering.guid
               end.collect(&:guid)
               err.puts "Found plan guids: #{plan_guids.count}"
+              if plan_guids.empty?
+                err.puts "No plans found for offerings"
+                exit(1)
+              end
 
               # look up the instances that match the plans and org
               # "/v3/service_instances?organization_guids=${org_guids}&service_plan_guids=${plan_guids}"
@@ -56,11 +69,9 @@ module JCF
               instances.select! { |i| i.name.include? options[:name] } if options[:name]
               err.puts "Found instances: #{instances.count}"
 
-              cw = JCF::AWS::CloudWatch.new
-              values = []
+              values = {}
 
               Thread.abort_on_exception = true
-              # use a the number of processors as the number of threads
               instances.each_slice(Concurrent.processor_count) do |slice|
                 slice.collect do |instance|
                   service_plan = instance.relationships.service_plan.populate!
@@ -68,42 +79,42 @@ module JCF
                   service_broker = service_offering.relationships.service_broker.populate!
 
                   Thread.new do
-                    m = JCF::CF::Metric.new
-                    m.name = (instance.name || "")
-                    err.puts "Getting metrics for #{m.name}"
-                    m.region = ENV["AWS_REGION"]
-                    m.deploy_env = options[:env]
-                    m.organization = org
-                    m.organization_guid = org_guid
+                    metrics = {}
+                    metrics[:name] = (instance.name || "")
+                    metrics[:instance_guid] = instance.guid
+                    err.puts "Getting metrics for #{instance.name}"
+                    metrics[:region] = ENV["AWS_REGION"]
+                    metrics[:organization] = org
+                    metrics[:organization_guid] = org_guid
                     space = spaces.find { |s| s.guid == instance.relationships.space.guid }
-                    m.space = space.name
-                    m.space_guid = space.guid
-                    m.service_broker_name = service_broker.name
-                    m.service_broker_guid = service_broker.guid
-                    m.service_offering = service_offering.name
-                    m.service_plan = service_plan.name
+                    metrics[:space] = space.name
+                    metrics[:space_guid] = space.guid
+                    metrics[:service_broker_name] = service_broker.name
+                    metrics[:service_broker_guid] = service_broker.guid
+                    metrics[:service_offering] = service_offering.name
+                    metrics[:service_plan] = service_plan.name
 
                     template = options[:template]
                     t_values = parse_values(options[:values], instance.guid)
 
-                    if service_offering.name == "postgres"
-                      m.storage_used = to_gb(cw.rds_storage_used(name: JCF::CLI.template_parser(template, t_values)) || "")
-                        m.storage_allocated = to_gb(cw.storage_allocated(name: JCF::CLI.template_parser(template, t_values)) || "")
-                        m.storage_free = to_gb(cw.storage_free(name: JCF::CLI.template_parser(template, t_values)) || "")
-                        m.iops = (cw.iops(name: JCF::CLI.template_parser(template, t_values)).to_fs(:rounded, precision: 0) || "")
-                        m.cpu = (cw.cpu(name: JCF::CLI.template_parser(template, t_values)).to_fs(:rounded, precision: 0) || "")
-                    end
-
-                    if service_offering.name == "aws-s3-bucket"
-                      m.storage_used = to_gb(cw.s3_storage_used(name: JCF::CLI.template_parser(template, t_values)) || "")
+                    t = JCF::CLI.template_parser(template, t_values)
+                    plugin.new(name: t).metrics.each do |k, v|
+                      metrics[k] = v
                     end
-                    values << m
+                    values[instance.guid] = metrics
                   end
-                end.map(&:value)
+                end.each(&:join)
               end
 
-              values << JCF::CF::Metric.new if values.empty?
-              out.puts formatter.format(values)
+              # values = { guid: { name: "name", space: "space" }, guid2: { name: "name2", space: "space2" } }
+              output = Hash.new { |hash, key| hash[key] = [] }
+              values.each do |guid, metrics|
+                metrics.each do |k, v|
+                  output[k] << v
+                end
+              end
+
+              out.puts formatter.format(data: output)
               err.puts "Done."
             end
           end
@@ -141,13 +152,7 @@ module JCF
           end
 
           def service_brokers
-            JCF::CF::ServiceBroker.all
-          end
-
-          def to_gb(bytes)
-            Filesize.from("#{bytes} b").to("GB").to_fs(:rounded, precision: 2)
-          rescue ArgumentError
-            0
+            @service_brokers ||= JCF::CF::ServiceBroker.all
           end
         end
       end

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

@@ -8,14 +8,17 @@ module JCF
     module Commands
       module CF
         class Organizations < Command
+          include JCF::CF
+
           argument :name, required: false, desc: "Organization name"
 
           def call(name: nil, **)
-            if name
-              out.puts formatter.format(JCF::CF::Organization.find_by(name: name))
+            values = if name
+              Organization.find_by(name: name).collect(&:values)
             else
-              out.puts formatter.format(JCF::CF::Organization.all)
+              Organization.all.collect(&:values)
             end
+            out.puts formatter.format(headers: Organization.keys, values: values)
           end
         end
       end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require_relative "../../errors"
+require "tty-tree"
+
+module JCF
+  module CLI
+    module Commands
+      module CF
+        class Services < Command
+          argument :broker, required: false, desc: "Broker name"
+
+          def call(broker: nil, **)
+            # 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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module JCF
+  module CLI
+    module Commands
+      class Plugins < Command
+        desc "Show JCF plugins"
+
+        def call(*)
+          out.puts "JCF Plugins:"
+          plugin_dir = File.join(JCF.root, "jcf", "plugins", "*.rb")
+          pp "plugin dir: #{plugin_dir}" if ENV["DEBUG"]
+          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
+          JCF::Plugins.plugins.each do |plugin|
+            out.puts "  #{plugin}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jcf/cli/commands.rb

@@ -7,11 +7,13 @@ module JCF
 
     def self.register_commands!
       register "version", Commands::Version, aliases: ["v", "-v", "--version"]
+      register "plugins", Commands::Plugins
       register "metrics", Commands::CF::Metrics, aliases: ["m"]
 
       register "organizations", Commands::CF::Organizations, aliases: %w[o orgs organization]
       register "spaces", Commands::CF::Spaces, aliases: %w[s space]
       register "users", Commands::CF::Users, aliases: %w[u user]
+      register "services", Commands::CF::Services
       register "service_brokers", Commands::CF::ServiceBrokers, aliases: %w[sb service_broker]
       register "service_offerings", Commands::CF::ServiceOfferings, aliases: %w[so service_offering]
       register "service_instances", Commands::CF::ServiceInstances, aliases: %w[si service_instance]

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

@@ -7,24 +7,12 @@ module JCF
     module OutputFormatters
       class CSV
         class << self
-          def format(data)
-            case data
-            in Array
-              array = data.collect(&:serializable_hash)
-              generate_csv(headers: array.first&.keys, values: array)
-            in Hash
-              generate_csv(headers: data.keys.sort, values: [data.serializable_hash])
-            else
-              generate_csv(headers: [], values: [])
-            end
-          end
-
-          private
+          def format(data:)
+            return "" if data.nil? || data.empty?
 
-          def generate_csv(headers:, values:)
-            ::CSV.generate(headers: headers, write_headers: true) do |csv|
-              values.each do |hash|
-                csv << hash.values
+            ::CSV.generate(headers: data.keys, write_headers: true) do |csv|
+              data.values.transpose.each do |value|
+                csv << value
               end
             end
           end

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

@@ -6,12 +6,10 @@ module JCF
   module CLI
     module OutputFormatters
       class JSON
-        def self.format(data)
-          if data.is_a?(Enumerable)
-            ::JSON.generate data.collect(&:serializable_hash)
-          else
-            ::JSON.generate data.serializable_hash
-          end
+        def self.format(data:)
+          return "{}" if data.nil? || data.empty?
+
+          data.to_json
         end
       end
     end

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

@@ -7,9 +7,19 @@ module JCF
     module OutputFormatters
       class Text
         class << self
-          def format(data)
-            return "" if data.nil?
+          def format(data:, tree: false)
+            return "" if data.nil? || data.empty?
 
+            if tree
+              render_tree(data)
+            else
+              render_data(data)
+            end
+          end
+
+          private
+
+          def render_data(data)
             keys = collect_keys(data)
             values = collect_values(data)
 
@@ -17,19 +27,34 @@ module JCF
             table.render(:unicode, resize: true)
           end
 
-          def collect_values(data)
+          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.map { |d| d.attributes.values.collect(&:to_s) }
+              data.first.keys.collect(&:to_s)
+            elsif data.is_a?(Hash)
+              data.keys.collect(&:to_s) || ["Empty result"]
             else
-              [data.attributes.values.collect(&:to_s)]
+              data.keys.collect(&:to_s)
             end
           end
 
-          def collect_keys(data)
+          # 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.first&.attributes&.keys || ["Empty result"]
+              data.map { |d| d.attributes.values.collect(&:to_s) }
+            elsif data.is_a?(Hash)
+              data.values.transpose
             else
-              data.attributes.keys
+              [data.attributes.values.collect(&:to_s)]
             end
           end
         end

data/lib/jcf/cli.rb

@@ -14,6 +14,50 @@ module JCF
     @cache ||= MiniCache::Store.new
   end
 
+  def self.plugin(plugin)
+    plugin = JCF::Plugins.load_plugin(plugin) if plugin.is_a?(Symbol)
+    validate_plugin!(plugin)
+    plugin.load_dependencies(self, *args, &block) if plugin.respond_to?(:load_dependencies)
+    plugin.configure(self, *args, &block) if plugin.respond_to?(:configure)
+  end
+
+  def self.validate_plugin!(plugin)
+    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}\")" \
+        unless plugin.new(name: nil).respond_to?(method)
+    end
+  rescue JCF::CLI::NotLoggedInError => e
+    puts e.message
+    exit 1
+  end
+
+  module Plugins
+    @plugins = {}
+
+    def self.plugins
+      @plugins
+    end
+
+    def self.load_plugin(name)
+      return @plugins[name] if @plugins[name]
+
+      puts "Loading plugin #{name}" if ENV["DEBUG"]
+      require "jcf/plugins/#{name}"
+      raise "Plugin didn't correctly register itself" unless @plugins[name]
+      @plugins[name]
+    end
+
+    # Plugins need to call this method to register themselves:
+    #
+    #   JCF::Plugins.register_plugin :render, Render
+    def self.register_plugin(name, mod)
+      puts "Registering plugin #{name}" if ENV["DEBUG"]
+      @plugins[name] = mod
+    end
+  end
+
   module CLI
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def self.loader
@@ -59,7 +103,9 @@ module JCF
 
     extend Dry::CLI::Registry
 
+    puts "Loading formatters..." if ENV["DEBUG"]
     register_formatters!
+    puts "Loading commands..." if ENV["DEBUG"]
     register_commands!
   end
 end

data/lib/jcf/metric.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module JCF
+  class Metric
+    attr_accessor :name, :value
+
+    def to_s
+      "#{name}: #{value}"
+    end
+  end
+end

data/lib/jcf/plugins/aws_rds.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "aws-sdk-cloudwatch"
+require "aws-sdk-rds"
+require "active_support/core_ext/integer/time"
+require "active_support/isolated_execution_state"
+require "filesize"
+
+module JCF
+  module Plugins
+    class AwsRds
+      def initialize(name:)
+        @name = name
+        @metrics = {}
+        check_token!
+      end
+
+      def names
+        %w[storage_used storage_allocated storage_free iops cpu]
+      end
+
+      def values
+        names.map { |name| send(name.to_sym) }
+      end
+
+      def metrics
+        @metrics[:storage_used] = to_gb(storage_used(name: @name || ""))
+        @metrics[:storage_allocated] = to_gb(storage_allocated(name: @name) || "")
+        @metrics[:storage_free] = to_gb(storage_free(name: @name) || "")
+        @metrics[:iops] = (iops(name: @name).to_fs(:rounded, precision: 0) || "")
+        @metrics[:cpu] = (cpu(name: @name).to_fs(:rounded, precision: 0) || "")
+        @metrics
+      end
+
+      def to_s
+       metrics.to_s
+      end
+
+      private
+
+      def check_token!
+        Aws::STS::Client.new.get_caller_identity({})
+      rescue Aws::Errors::MissingCredentialsError
+        raise JCF::CLI::NotLoggedInError, "Your AWS token has expired.  Please log in again."
+      end
+
+      METRICS = {
+        free_storage: "FreeStorageSpace",
+        allocated_storage: "AllocatedStorage",
+        iops: "WriteIOPS",
+        cpu: "CPUUtilization"
+      }.freeze
+
+      def storage_free(name:)
+        storage_free = cloudwatch(name: name, metric: "FreeStorageSpace")
+        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 storage_used(name:)
+        free = storage_free(name: name)
+        allocated = storage_allocated(name: name)
+        allocated - free
+      end
+
+      def iops(name:)
+        cloudwatch(name: name, metric: :iops)
+      end
+
+      def cpu(name:)
+        cloudwatch(name: name, metric: :cpu)
+      end
+
+      # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      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"]
+        })
+
+        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/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      def to_gb(bytes)
+        Filesize.from("#{bytes} b").to("GB").to_fs(:rounded, precision: 2)
+      rescue ArgumentError
+        0
+      end
+    end
+
+    register_plugin :aws_rds, AwsRds
+  end
+end

data/lib/jcf/plugins/aws_s3.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "aws-sdk-s3"
+require "active_support/core_ext/integer/time"
+require "active_support/isolated_execution_state"
+require "filesize"
+
+module JCF
+  module Plugins
+    class AwsS3
+      def initialize(name:)
+        @name = name
+        @metrics = {}
+        check_token!
+      end
+
+      def names
+        %w[storage_used]
+      end
+
+      def values
+        names.map { |name| send(name.to_sym) }
+      end
+
+      def metrics
+        @metrics[:storage_used] = to_gb(s3_storage_used(name: @name || ""))
+        @metrics
+      end
+
+      def to_s
+        metrics.to_s
+      end
+
+      private
+
+      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 check_token!
+        Aws::STS::Client.new.get_caller_identity({})
+      rescue Aws::Errors::MissingCredentialsError
+        raise JCF::CLI::NotLoggedInError, "Your AWS token has expired.  Please log in again."
+      end
+
+      def to_gb(bytes)
+        Filesize.from("#{bytes} b").to("GB").to_fs(:rounded, precision: 2)
+      rescue ArgumentError
+        0
+      end
+    end
+
+    register_plugin :aws_s3, AwsS3
+  end
+end

data/lib/jcf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcf
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Jamie van Dyke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -240,6 +240,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: tty-tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description:
 email:
 - me@fearof.fish
@@ -265,7 +279,6 @@ files:
 - lib/jcf/cf.rb
 - lib/jcf/cf/.DS_Store
 - lib/jcf/cf/base.rb
-- lib/jcf/cf/metric.rb
 - lib/jcf/cf/organization.rb
 - lib/jcf/cf/quota.rb
 - lib/jcf/cf/relationships.rb
@@ -273,6 +286,7 @@ files:
 - lib/jcf/cf/service_instance.rb
 - lib/jcf/cf/service_offering.rb
 - lib/jcf/cf/service_plan.rb
+- lib/jcf/cf/services.rb
 - lib/jcf/cf/space.rb
 - lib/jcf/cf/user.rb
 - lib/jcf/cli.rb
@@ -286,14 +300,19 @@ files:
 - lib/jcf/cli/commands/cf/service_instances.rb
 - lib/jcf/cli/commands/cf/service_offerings.rb
 - lib/jcf/cli/commands/cf/service_plans.rb
+- lib/jcf/cli/commands/cf/services.rb
 - lib/jcf/cli/commands/cf/spaces.rb
 - lib/jcf/cli/commands/cf/users.rb
+- lib/jcf/cli/commands/plugins.rb
 - lib/jcf/cli/commands/version.rb
 - lib/jcf/cli/errors.rb
 - lib/jcf/cli/output_formatters.rb
 - lib/jcf/cli/output_formatters/csv.rb
 - lib/jcf/cli/output_formatters/json.rb
 - lib/jcf/cli/output_formatters/text.rb
+- lib/jcf/metric.rb
+- lib/jcf/plugins/aws_rds.rb
+- lib/jcf/plugins/aws_s3.rb
 - lib/jcf/version.rb
 - sig/jcf.rbs
 homepage: https://github.com/fearoffish/paas-org-metric-gathering-gem
@@ -320,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Gather metrics from AWS for CloudFoundry installations

data/lib/jcf/cf/metric.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module JCF
-  module CF
-    class Metric < Base
-      attr_accessor :name, :region, :deploy_env, :organization, :organization_guid, :space, :space_guid,
-                    :service_broker_name, :service_broker_guid, :service_offering, :service_plan,
-                    :storage_allocated, :storage_used, :storage_free, :iops, :cpu
-
-      # rubocop:disable Metrics/MethodLength
-      def attributes
-        {
-          name: name,
-          region: region,
-          organization: organization,
-          organization_guid: organization_guid,
-          space: space,
-          space_guid: space_guid,
-          service_broker_name: service_broker_name,
-          service_broker_guid: service_broker_guid,
-          service_offering: service_offering,
-          service_plan: service_plan,
-          storage_used: storage_used,
-          storage_allocated: storage_allocated,
-          storage_free: storage_free,
-          iops: iops,
-          cpu: cpu
-        }
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def to_s
-        "#{name}: used(#{storage_used}) allocated(#{storage_allocated}) free(#{storage_free}) iops(#{iops}) cpu(#{cpu})"
-      end
-    end
-  end
-end