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

data/lib/MrMurano/Business.rb

@@ -24,19 +24,34 @@ module MrMurano
     include Verbose
 
     attr_writer :bid
-    attr_writer :name
-    attr_accessor :role
     attr_reader :meta
-    attr_reader :ometa
+    attr_reader :network_status
+    attr_accessor :role
+
+    # BizAPI responses.
+    attr_reader :billing
+    attr_reader :members
+    attr_reader :network
+    attr_reader :owner
+    attr_reader :tier
 
     def initialize(data=nil)
       super()
+
       @bid = nil
       @name = nil
+      self.meta = data unless data.nil?
+      @network_status = :unknown
+      @role = nil
+
+      @billing = nil
+      @network = nil
+      @members = nil
+      @owner = nil
+      @tier = nil
+
       @valid = false
       @user_bizes = {}
-      self.meta = data unless data.nil?
-      @ometa = nil
     end
 
     def valid?
@@ -66,6 +81,18 @@ module MrMurano
       other.class == self.class && other.state == state
     end
 
+    def name=(name)
+      patch("business/#{bid}", name: name)
+    end
+
+    def email=(email)
+      patch("business/#{bid}/billing", email: email)
+    end
+
+    def contact=(contact)
+      patch("business/#{bid}/billing", contact: contact)
+    end
+
     protected
 
     def state
@@ -94,63 +121,173 @@ module MrMurano
       raise MrMurano::ConfigError.new(Business.missing_business_id_msg) if bid.to_s.empty?
     end
 
-    def must_child!
+    def must_child_id!
       raise MrMurano::ConfigError.new(Business.missing_child_msg) if cid.to_s.empty?
     end
 
     def self.missing_business_id_msg
       %(
-        business ID not specified. For hints: #{MrMurano::EXE_NAME} business --help
+The business ID is not specified. For help, run:
+
+  #{MrMurano::EXE_NAME} business --help
       ).strip
     end
 
     def self.missing_child_msg
       %(
-        network child business ID not specified. For hints: #{MrMurano::EXE_NAME} business --help
+The network child business ID is not specified. For help, run:
+
+  #{MrMurano::EXE_NAME} business --help
       ).strip
     end
 
     def pretty_name_and_id
-      "#{fancy_ticks(Rainbow(name).underline)} <#{bid}>"
+      if !name.to_s.empty?
+        "#{fancy_ticks(Rainbow(name).underline)} <#{bid}>"
+      else
+        "<#{bid}>"
+      end
+    end
+
+    # ---------------------------------------------------------------------
+
+    def fetch_member
+      whirly_msg("Fetching Business details (#{pretty_name_and_id}) / members...")
+      get("business/#{bid}/member/")
+    end
+
+    def fetch_network
+      whirly_msg("Fetching Business details (#{pretty_name_and_id}) / network...")
+      get("business/#{bid}/network")
+    end
+
+    def fetch_owner
+      whirly_msg("Fetching Business details (#{pretty_name_and_id}) / owner...")
+      get("business/#{bid}/owner")
+    end
+
+    def fetch_tier
+      whirly_msg("Fetching Business details (#{pretty_name_and_id}) / tier...")
+      get("business/#{bid}/tier")
     end
 
     # ---------------------------------------------------------------------
 
-    #def projects?(id)
-    #  ret = get("business/#{id}/overview")
-    #  return false unless ret.is_a?(Hash)
-    #  return false unless ret.key?(:tier)
-    #  tier = ret[:tier]
-    #  return false unless tier.is_a?(Hash)
-    #  return false unless tier.key?(:enableProjects)
-    #  tier[:enableProjects]
-    #end
-
-    def overview(&block)
-      # TODO: (PL) - The overview endpoint has been split up into smaller
-      # endpoints that should be used instead of this one
+    def overview(detailed: false, networks: false)
+      @meta ||= {}
+
+      # (lb): 2018-08-08: The base Business endpoint contains 3 fields, e.g.,
+      #   {:name=>"Exosite LLC", :email=>"mur.cli@exosite.com", :contact=>"MurCLI"}
+      # but note that :email and :contact are deprecated (and should come from billing/).
+      whirly_msg("Fetching Business details (#{pretty_name_and_id}) / name...")
+      bid_data = get("business/#{bid}")
+      @name = bid_data[:name]
+      @meta[:name] = bid_data[:name]
+      # (lb): There are 2 paths to setting @valid=true: Get list of businesses,
+      # via Account.businesses, which calls meta= (which also sets @role); or
+      # get specific business, which calls this method, overview (which does
+      # not set @role unless detailed=true).
+      @valid = true
+
+      prepare_details_info if detailed
+      prepare_network_info if networks
+    end
+
+    def prepare_details_info
+      # The billing/ endpoint contains, e.g.,
+      #   {:balance=>0, :overdue=>0, :terms=>0, :email=>"...", :contact=>"..."}
+      whirly_msg("Fetching Business details (#{pretty_name_and_id}) / billing...")
+      @billing = get("business/#{bid}/billing") if @billing.nil? # Leverages ChargeOver
+      unless @billing.nil?
+        @meta[:email] = @billing[:email]
+        @meta[:contact] = @billing[:contact]
+        # (lb): There are some other potentially interesting fields, like
+        #   @billing[:lineitems] (which for my businesses is empty, so...).
+      end
+
+      # Retrieve Business tier info.
+      @tier = fetch_tier if @tier.nil?
+      @meta[:tier] = @tier[:name] unless @tier.nil?
+
+      # Retrieve Business member list.
+      # NOTE: The owner/ endpoint (fetch_owner) reflects the Business Network,
+      #   and not the User members of the Business.
+      @members = fetch_member if @members.nil?
+      @meta[:role] = 'N/A'
+      @members.each do |member|
+        next unless member[:email] == $cfg['user.name']
+        # (lb): 2018-08-08: Note that :membership is deprecated; use :role instead.
+        @meta[:role] = member[:role]
+        break
+      end
+
+      # (lb): 2018-08-08: Deprecated endpoints (listed to avoid future confusion):
       #
-      # Here are all the goodies that the overview endpoint returns:
-      #  {:name=>"XXX", :email=>"XXX", :contact=>"XXX",
-      #   :billing=>{
-      #     :terms=>0, :balance=>0, :overdue=>0},
-      #   :tier=>{
-      #     :name=>"Community", :id=>"free", :price=>0, :users=>nil, :domains=>0,
-      #     :ssl=>false, :rebrand=>false, :billing=>false, :multisolution=>true,
-      #     :phonesupport=>false, :supportLevel=>"Community", :servicesTier=>"Core",
-      #     :onboarding=>{}, :enableMurano=>true, :enableProjects=>true},
-      #   :accountManager=>{
-      #     :name=>"", :email=>"", :phone=>""},
-      #   :accountLimits=>{
-      #     :teamMembers=>1, :solutionApis=>1, :productModels=>1,
-      #     :perModelDevices=>10, :perApiUsers=>10}, :lineitems=>[]}
-      # EXPLAIN/2017-06-30: Which value(s) tell us if ADC is enabled?
-      whirly_start('Fetching Business...')
-      data = get("business/#{bid}/overview", &block)
-      whirly_stop
-      @valid = !data.nil?
-      @name = data[:name] if @valid
-      @ometa = data
+      #     get("business/#{bid}/overview")
+      #       Split into separate endpoints, like /billing, /tier, etc.
+      #
+      #     get("business/#{bid}/lineitems")
+      #       Incorporated into /billing, e.g., @billing[:lineitems]
+      #
+      # Other endpoints:
+      #
+      #     get("business/#{bid}/creditcard")
+      #       (lb): I'm not sure if this works, because I use a dummy card.
+      #
+      #     get("business/#{bid}/transaction")
+      #       (lb): I saw this documented, but got `404: Not Found`.
+      #
+      #     get("business/#{bid}/tierset")
+      #       Describes all the tiers offered by the platform.
+      #
+      # Handled by specific commands:
+      #
+      #     get("business/#{bid}/network")
+      #       See commands/network.rb.
+      #
+      #     get("business/#{bid}/usage")
+      #       See commands/usage.rb.
+    end
+
+    # ---------------------------------------------------------------------
+
+    def prepare_network_info
+      @tier = fetch_tier if @tier.nil?
+      network_enabled = @tier[:features][:network]
+
+      if network_enabled
+        # Parents of business networks.
+        fetch_network_info_parent
+      else
+        # Check if the biz is a child of a network.
+        maybe_add_network_info_child
+      end
+    end
+
+    def fetch_network_info_parent
+      @meta[:network_relationship] = 'parent'
+      @network = fetch_network if @network.nil?
+      network_name = @network[:name]
+      if network_name
+        @meta[:network_name] = network_name
+        @network_status = :parent_configured
+      else
+        @meta[:network_name] = '<Not configured>'
+        @network_status = :parent_unconfigured
+      end
+    end
+
+    def maybe_add_network_info_child
+      @owner = fetch_owner if @owner.nil?
+      if !@owner.empty?
+        @meta[:network_relationship] = 'child'
+        @meta[:network_name] = @owner[:network][:name]
+        @network_status = :child_configured
+      else
+        @meta[:network_relationship] = ''
+        @meta[:network_name] = 'N/A'
+        @network_status = :child_unconfigured
+      end
     end
 
     # ---------------------------------------------------------------------
@@ -239,7 +376,9 @@ module MrMurano
     ## Given a type (:application or :product), return a Solution instance.
     def solution_from_type!(type)
       type = type.to_s.to_sym
-      raise "Unknown type(#{type})" unless type.to_s.empty? || ALLOWED_TYPES.include?(type)
+      unless type.to_s.empty? || ALLOWED_TYPES.include?(type)
+        raise "Unknown type(#{type})"
+      end
       api_id = MrMurano::Solution::INVALID_API_ID
       if type == :application
         sol = MrMurano::Application.new(api_id)

data/lib/MrMurano/Config.rb

@@ -60,6 +60,7 @@ module MrMurano
         self[:data] = IniFile.new(filename: path.to_s) if self[:data].nil?
         self[:data].save
         path.chmod(0o600)
+        nil
       end
     end
 

data/lib/MrMurano/Exchange.rb

@@ -42,8 +42,8 @@ module MrMurano
     end
 
     def elements(skip_purchased: false, **opts)
-      # Get the user's Business metadata, including their Business tier.
-      overview if @ometa.nil?
+      # Get the user's Business tier data.
+      @tier = fetch_tier if @tier.nil?
 
       elems = nil
       id_maybe = opts[:filter_id] || opts[:filter_fuzzy]
@@ -172,7 +172,7 @@ module MrMurano
       elems.each do |elem|
         if elem.purchaseId.nil?
           available.push(elem)
-          if !@ometa[:tier].nil? && elem.tiers.include?(@ometa[:tier][:id])
+          if !@tier.nil? && elem.tiers.include?(@tier[:id])
             elem.statusable = :available
           else
             elem.statusable = :upgrade
@@ -181,7 +181,6 @@ module MrMurano
           purchased.push(elem)
           elem.statusable = :added
         end
-        #@ometa[:status] = elem.status
       end
 
       [elems, available, purchased]

data/lib/MrMurano/Solution-Services.rb

@@ -223,11 +223,21 @@ module MrMurano
       cache_file = $cfg.file_at(cache_file_name)
       if cache_file.file?
         cache_file.open('r+') do |io|
-          cache = YAML.load(io)
-          cache ||= {}
-          io.rewind
-          cache[local_path.to_s] = entry
-          io << cache.to_yaml
+          # Try to load a pre-existing cache.
+          begin
+            cache = YAML.load(io)
+            cache ||= {}
+            io.rewind
+            cache[local_path.to_s] = entry
+            io << cache.to_yaml
+          rescue StandardError => err
+            # TODO: (tvc): add error handling here, this should help us
+            #   understand why this fails sometimes
+            warning("ERROR: Failed to load the cache file at: #{cache_file}")
+            warning(err.to_s)
+            # (lb): I'm suspect that this stack trace will actually be useful.
+            warning(err.backtrace.inspect)
+          end
         end
       else
         cache_file.open('w') do |io|
@@ -365,7 +375,7 @@ module MrMurano
       root = root.expand_path
       if path.basename.sub(/\.lua$/i, '').to_s.include?('.')
         warning(
-          "WARNING: Do not use periods in filenames." +
+          'WARNING: Do not use periods in filenames.' \
           " Rename: #{fancy_ticks(path.basename)}"
         )
       end
@@ -373,7 +383,7 @@ module MrMurano
         break if ancestor == root
         if ancestor.basename.to_s.include?('.')
           warning(
-            "WARNING: Do not use periods in directory names." +
+            'WARNING: Do not use periods in directory names.' \
             " Rename: #{fancy_ticks(ancestor.basename)}"
           )
         end
@@ -401,6 +411,14 @@ module MrMurano
       #   :updated_at
       # @return [String] Internal Alias name
       attr_accessor :alias
+      # (lb): 2018-08-09: This has been missing until now, when the
+      #   recently added warning in Item's []= started complaining
+      #   about it.
+      # (lb): FIXME/2018-08-09: Do we need to leverage this attribute
+      #   at all? For now we're just consuming it from the platform,
+      #   but we not using it (though we use script_key elsewhere in
+      #   the code).
+      attr_accessor :script_key
       # @return [String] Timestamp when this was created.
       attr_accessor :created_at
       # @return [String] The soln's product.id or application.id (Murano's api_id).

data/lib/MrMurano/Webservice-File.rb

@@ -245,15 +245,13 @@ module MrMurano
         xsum_is_sha1 = false
         if xsum_is_sha1
           digobj = remote_item_checksum_sha1(path)
-        else
+        elsif file_size.zero?
           # MD5 of the empty string is not empty (it's d41d8cd98f00b204e9800998ecf8427e)
           # but BizAPI (or Pegasus; whomever) sends an empty string for an empty file.
-          if file_size.zero?
-            checksum = ''
-            digobj = nil
-          else
-            digobj = remote_item_checksum_md5(path)
-          end
+          checksum = ''
+          digobj = nil
+        else
+          digobj = remote_item_checksum_md5(path)
         end
 
         checksum = digobj.hexdigest unless digobj.nil?