MuranoCLI 3.2.1.pre.beta.4 → 3.2.1.pre.beta.5

data/docs/release.rst

@@ -0,0 +1,275 @@
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+Murano CLI Ruby Gem Release Guide
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+####################
+Gem Release Overview
+####################
+
+There are currently 3 Gems that Exosite publishes to support Murano CLI.
+[Current as of 2018-08-07.]
+
+- Murano CLI (``MuranoCLI``)
+
+- Ruby Commander (``murano-cli-rb-commander``)
+
+- Whirly (``murano-cli-whirly``)
+
+You will need XXX access to each gem at http://rubygems.org to be able
+to publish new versions (using ``gem push``, e.g., via ``rake release``).
+
+##############
+Ruby Gem Links
+##############
+
+==========
+Murano CLI
+==========
+
+http://rubygems.org/gems/MuranoCLI
+
+===========
+Hacked Gems
+===========
+
+(lb): FIXME/2018-08-07: It's entirely possible that we could get these
+changes incorporated upstream by opening Pull Requests, but I haven't
+wanted to manage those conversations yet. (It's too easy to fork and publish!)
+
+- Ruby Commander fork
+
+  http://rubygems.org/gems/murano-cli-commander
+
+  - Adds support for empty string option values,
+    e.g., ``--option ""``.
+
+- Whirly fork
+
+  http://rubygems.org/gems/murano-cli-whirly
+
+  - Fixes width calculation to not count ANSI color codes. Otherwise,
+    too many spaces might be printed to clear the line, erroneously
+    creating a line break (and pushing the progress up a line, when
+    it should instead remain on its current line).
+
+########################
+Gem Release Instructions
+########################
+
+===================================
+Murano CLI Gem Release Instructions
+===================================
+
+- Ensure tests pass.
+
+- Bump the version, if not already done.
+
+   Manually: Open ``lib/MrMurano/version.rb``, edit, commit, push, etc.
+
+   Automated: Use a rake task to bump the version, discussed below.
+
+  - a). If you're working on a feature and want to release a pre-release
+    gem, you can just change the version in your branch.
+    
+    Choose one of the following rake tasks to run:
+
+    .. code-block:: sh
+
+      # Increment just the beta number:
+      rake bump:beta
+
+      # Or, increment the patch number, and start a fresh beta version:
+      rake bump:patch
+
+      # Or, increment the minor number, and start a fresh patch.beta version:
+      rake bump:minor
+
+      # Or, increment the major number, and start a fresh minor.patch.beta version:
+      rake bump:major
+
+    - Incorporate the version bump in the PR for the feature on which
+      you're working. Once the feature in merged to develop, you can
+      move to step #3 and make the pre-release.
+
+  - b). If you're instead ready to prepare a real release, bump the version
+    on the develop branch:
+
+    .. code-block:: sh
+
+      # Or, drop the beta version, and prepare an official release:
+      rake bump:release
+
+    - Follow the URL printed by the rake task and open a PR for
+      the version bump. Approve it, merge the change, and delete
+      the release branch.
+
+- Kick off the Gem release builder.
+
+  - a.) To prepare a pre-release Gem from the ``develop`` branch, run:
+
+    .. code-block:: sh
+
+      rake package:develop
+
+  - b.) To prepare an official release Gem from the ``master`` branch, run:
+
+    .. code-block:: sh
+
+      rake package:master
+
+  You'll be directed 
+
+- Copy the Gem locally, and upload it to the official Gem repository.
+
+    .. code-block:: sh
+
+      rake package:publish
+
+Deprecated Resources
+--------------------
+
+Build project on old Jenkins server (2018-08-07: no longer used, but still alive):
+
+  https://build.exosite.com/view/MuranoCLI/job/MrMurano%20Gem%20Release/
+
+Old Travic-CI project, from when project was public:
+
+  https://travis-ci.org/exosite/MuranoCLI
+
+==============================================
+Forked Ruby Commander Gem Release Instructions
+==============================================
+
+First, set the current version, and the version about to be released.
+
+.. code-block:: sh
+
+  WAS_VERS='4.4.6'
+  CUR_VERS='4.4.10'
+
+Next, prepare the branch, and then test, build and publish.
+
+.. code-block:: sh
+
+  cd /exo/clients/exosite/MuranoCLIs/murano-cli-commander
+  git co feature/empty_arg_support
+
+  git fetch commander-rb
+  git rebase commander-rb/master
+
+  /bin/sed -i -r \
+    "s/^  VERSION = '${WAS_VERS}'.freeze$/  VERSION = '${CUR_VERS}'.freeze/" \
+    lib/murano-cli-commander/version.rb
+  git diff lib/murano-cli-commander/version.rb
+
+  git add lib/murano-cli-commander/version.rb
+  git ci -m "Version ${CUR_VERS}"
+
+  # If you need to delete an existing tag of the same name, try:
+  #   git tag -d "v${CUR_VERS}"
+
+  # Tag the version. `rake release` also does this.
+  git tag -a "v${CUR_VERS}" -m "Version ${CUR_VERS}" feature/empty_arg_support
+  git push origin "v${CUR_VERS}"
+
+  # Test it.
+  rake spec
+
+  # Build it.
+  rake build
+
+  # Publish it (to Rubygems).
+  rake release
+
+If you need to pull a bad release, yank it.
+
+WARNING: You will never again be able to publish another release using the same version.
+
+.. code-block:: sh
+
+  $ gem yank murano-cli-commander -v ${CUR_VERS}
+
+##########################################
+Troubleshooting Gem Release/Publish Issues
+##########################################
+
+===================================================================
+Gem Remove / Gem Purge / Remove Release / Kill Release Instructions
+===================================================================
+
+Yank/Remove/Unpublish Gem Version
+---------------------------------
+
+You can ``gem yank <gem-name> -v <gem-vers>`` to remove a published gem.
+
+- Delete the gem from Rubygems.org using ``gem yank``.
+
+  See below for installation instructions.
+
+- You should also delete any corresponding archive managed by the repo,
+  i.e., at ``https://github.com/exosite/<gem-name>/releases``.
+
+  https://github.com/exosite/MuranoCLI/releases
+
+  https://github.com/exosite/murano-cli-commander/releases
+
+  https://github.com/exosite/murano-cli-whirly/releases
+
+  - Click the **release name** (*not the Edit button*)
+    and there you'll find the Delete option.
+
+- Caveat/Beware!: You cannot republish a yanked Gem!
+
+E.g.,
+
+  .. code-block:: sh
+
+    $ gem yank my-gem -v 1.0.0
+
+    $ rake release
+    # my-gem 1.0.0 built to pkg/my-gem-1.0.0.gem.
+    # Tag v1.1.0 has already been created.
+    # rake aborted!
+    # Pushing gem to https://rubygems.org...
+    # Repushing of gem versions is not allowed.
+    # Please use `gem yank` to remove bad gem releases.
+    # /home/user/.gem/ruby/2.3.3/gems/rake-12.3.1/exe/rake:27:in `<top (required)>'
+    # Tasks: TOP => release => release:rubygem_push
+    # (See full trace by running task with --trace)
+
+Install ``gemcutter`` (``gem yank``)
+------------------------------------
+
+Prerequisites::
+
+  gem update --system
+  gem install gemcutter
+
+OUTPUT::
+
+  Fetching: gemcutter-0.7.1.gem (100%)
+  ********************************************************************************
+
+             Thanks for installing Gemcutter! You can now run:
+
+    gem push        merged into RubyGems 1.3.6
+    gem owner       merged into RubyGems 1.3.6
+    gem webhook     register urls to be pinged when gems are pushed
+    gem yank        remove a specific version of a gem from RubyGemgem.org
+
+  ********************************************************************************
+  Successfully installed gemcutter-0.7.1
+  Parsing documentation for gemcutter-0.7.1
+  Installing ri documentation for gemcutter-0.7.1
+  Done installing documentation for gemcutter after 0 seconds
+  1 gem installed
+
+Delete/Remove/Revoke Published Ruby Gem, e.g.,::
+
+  gem yank MuranoCLI -v 3.2.0
+
+OUTPUT::
+
+  Yanking gem from https://rubygems.org...
+  Successfully deleted gem: MuranoCLI (3.2.0)
+

data/lib/MrMurano/Account.rb

@@ -16,12 +16,14 @@ module MrMurano
     include AccountBase
     include Verbose
 
-    def businesses(bid: nil, name: nil, fuzzy: nil, options: nil)
+    def businesses(bid: nil, name: nil, fuzzy: nil, detailed: nil, networks: nil)
       # Ask user for name and password, if not saved to config and password files.
       login_info if user.empty?
       raise 'Missing user?!' if user.empty?
 
       MrMurano::Verbose.whirly_start 'Fetching Businesses...'
+      # (lb): FIXME: This endpoint should be moved to class User eventually
+      #   (when User is finally implemented).
       bizes = get('user/' + user + '/membership/')
       MrMurano::Verbose.whirly_stop
       return [] unless bizes.is_a?(Array) && bizes.any?
@@ -29,76 +31,70 @@ module MrMurano
       # 2017-06-30: The data for each message contains a :bizid, :role, and :name.
       #   :role is probably generally "owner".
 
-      if (options && options.network)
-        # add network information and sort list
-        bizes = add_businesses_network(bizes)
-        match_bid_name_fuzzy!(bizes, bid, name, fuzzy)
+      match_bid_name_fuzzy!(bizes, bid, name, fuzzy)
+
+      if detailed || networks
+        bizes = add_business_details(bizes, detailed: detailed, networks: networks)
+      end
+
+      if networks
+        # Sort results by network status, then name.
+        sort_by_networks(bizes)
       else
-        # Sort results.
-        match_bid_name_fuzzy!(bizes, bid, name, fuzzy)
+        # Sort results by name.
         bizes.sort_by!(&:name)
       end
     end
 
     # ---------------------------------------------------------------------
 
-    def add_businesses_network(bizes)
-      # Get network information
-      bizes_without_network = []
-      bizes_unconfigured = []
+    def sort_by_networks(bizes)
       bizes_in_network = []
-      all_bizes = []
+      bizes_unconfigured = []
+      bizes_without_network = []
 
-      MrMurano::Verbose.whirly_start 'Fetching Network Information...'
       bizes.each do |biz|
-        biz[:network] = ''
-        biz[:network_relationship] = ''
-        business_tier = get('business/' + biz[:bizid] + '/tier')
-        network_enabled = business_tier[:features][:network]
-
-        if network_enabled # Parents of business networks
-          add_network_info_parent!(biz, bizes_in_network, bizes_unconfigured)
-        else # check if the biz is a child of a network
-          maybe_add_network_info_child!(biz, bizes_without_network, bizes_in_network)
-        end
+        classify_business_by_network(
+          biz, bizes_in_network, bizes_unconfigured, bizes_without_network
+        )
       end
-      MrMurano::Verbose.whirly_stop
 
       # Assemble the master list so that confgured networks are on top, followed
       # by unconfigured networks, followed by non-network businesses
-      all_bizes.concat(bizes_in_network.sort_by! { |biz| biz[:network] })
-      all_bizes.concat(bizes_unconfigured.sort_by! { |biz| biz[:name] })
-      all_bizes.concat(bizes_without_network.sort_by! { |biz| biz[:name] })
+      all_bizes = []
+      all_bizes.concat(bizes_in_network.sort_by! { |biz| biz.meta[:network_name] })
+      all_bizes.concat(bizes_unconfigured.sort_by!(&:name))
+      all_bizes.concat(bizes_without_network.sort_by!(&:name))
     end
 
-    # ---------------------------------------------------------------------
-    def add_network_info_parent!(biz, bizes_in_network, bizes_unconfigured)
-      biz[:network_relationship] = 'parent'
-      network_name = get('business/' + biz[:bizid] + '/network')[:name]
-      if network_name
-        biz[:network] = network_name
+    def classify_business_by_network(
+      biz, bizes_in_network, bizes_unconfigured, bizes_without_network
+    )
+      case biz.network_status
+      when :parent_configured
         bizes_in_network.push(biz)
-      else
-        biz[:network] = '--Not configured yet--'
+      when :parent_unconfigured
         bizes_unconfigured.push(biz)
+      when :child_configured
+        bizes_in_network.push(biz)
+      when :child_unconfigured
+        bizes_without_network.push(biz)
+      else
+        assert(false)
       end
     end
 
     # ---------------------------------------------------------------------
-    def maybe_add_network_info_child!(biz, bizes_without_network, bizes_in_network)
-      owner = get('business/' + biz[:bizid] + '/owner')
-      if owner.empty?
-        biz[:network] = 'N/A'
-        bizes_without_network.push(biz)
-      else
-        biz[:network_relationship] = 'child'
-        biz[:network] = owner[:network][:name]
-        bizes_in_network.push(biz)
+
+    def add_business_details(bizes, detailed: nil, networks: nil)
+      bizes.each do |biz|
+        biz.overview(detailed: detailed, networks: networks)
       end
     end
 
     # ---------------------------------------------------------------------
-    # helper for filtering businesses when using the find command
+
+    # Filter Businesses (e.g., used by the `business find` command).
     def match_bid_name_fuzzy!(bizes, bid, name, fuzzy)
       match_bid = ensure_array(bid)
       match_name = ensure_array(name)
@@ -109,8 +105,9 @@ module MrMurano
             match_bid.include?(biz[:bizid]) ||
             match_name.include?(biz[:name]) ||
             match_fuzzy.any? do |term|
-              biz[:name] =~ (
-                /#{Regexp.escape(term)}/i || biz[:bizid] =~ /#{Regexp.escape(term)}/i
+              (
+                (biz[:name] =~ /#{Regexp.escape(term)}/i) ||
+                (biz[:bizid] =~ /#{Regexp.escape(term)}/i)
               )
             end
           )
@@ -144,10 +141,12 @@ module MrMurano
     # ---------------------------------------------------------------------
 
     def new_business(name)
+      assert(False) # Not called.
       post('business/', name: name)
     end
 
     def delete_business(id)
+      assert(False) # Not called.
       delete("business/#{id}")
     end
   end

data/lib/MrMurano/AccountBase.rb

@@ -63,6 +63,7 @@ module MrMurano
       # Do not prompt for password if using token.
       if !MrMurano::HttpAuthed.instance.logging_on && $cfg['auth.scheme-token']
         token = MrMurano::HttpAuthed.instance.token_resolve
+        # (lb): FIXME/2018-08-09: These appears to be missing a return value...!
         return unless token.to_s.empty?
       end
       password = MrMurano::HttpAuthed.instance.password_get_or_ask(