jcf 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9477e6264cb699c3505cfe016acb802bff09e9c71fe98072ea9a1598a021119
-  data.tar.gz: 05a70e89d7593faa6308a6d0b78d03a3990466dae549a8343625288bf104a4ea
+  metadata.gz: 9479fc4468d9132f60c15f22782820798f35ae649d5bb09d575e7b051d77ddda
+  data.tar.gz: 4090a17eb90884a706b11ea865805a4a99ada9b8bfbbfc1206fd6ddbf21e4af6
 SHA512:
-  metadata.gz: ec4fa652bb3341babc362145fe150e9418944e3b5c2d5aeb2b798c7d82af39849a3c467b1432941638a9c4b0650f468b56c537e927c4ab5b7793884faf31e491
-  data.tar.gz: 25bad72e4df60a12ef1df353abb6472e9db88623f9a4c7ebcd1e4150222bb92c4a2a63684582c9b5758eec353bdcab263b59cfdd67e259aeb42be071f9691827
+  metadata.gz: 06fc37725e7ae5ad94b16e5e4a365ecd69760c45ca7e21922d81ca57e24e826cd43328d67d50e3b7bce5366a5421d09e99eb4fe03529d05562b9a6d4463ca546
+  data.tar.gz: 2b508ca2c6441a640f13aa03fa05fb19438467f0bfa053e5cd23f37b8b861176f9648f22746cc2576a73c371e641e50684e02c0960da1e39401bfc89b676a1fc

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [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/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,7 +14,7 @@ module JCF
     module Commands
       module CF
         class Metrics < Command
-          argument :offering, required: true, values: %w[postgres aws-s3-bucket],
+          argument :offering, required: true, values: %w[postgres mysql aws-s3-bucket],
                           desc: "Choose a service instance offering to query"
 
           option :template, aliases: ["-t"], required: true, type: :string,

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.rb

@@ -12,6 +12,7 @@ module JCF
       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/text.rb

@@ -7,9 +7,17 @@ module JCF
     module OutputFormatters
       class Text
         class << self
-          def format(data)
+          def format(data, tree: false)
             return "" if data.nil?
 
+            if tree
+              render_tree(data)
+            else
+              render_data(data)
+            end
+          end
+
+          def render_data(data)
             keys = collect_keys(data)
             values = collect_values(data)
 
@@ -17,6 +25,10 @@ module JCF
             table.render(:unicode, resize: true)
           end
 
+          def render_tree(data)
+            TTY::Tree.new(data).render
+          end
+
           def collect_values(data)
             if data.is_a?(Array)
               data.map { |d| d.attributes.values.collect(&:to_s) }

data/lib/jcf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcf
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Jamie van Dyke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2023-10-12 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
@@ -273,6 +287,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,6 +301,7 @@ 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/version.rb