MuranoCLI 3.0.1 → 3.0.2

data/lib/MrMurano/Exchange.rb

@@ -0,0 +1,137 @@
+# Last Modified: 2017.08.31 /coding: utf-8
+# frozen_string_literal: true
+
+# Copyright © 2016-2017 Exosite LLC.
+# License: MIT. See LICENSE.txt.
+#  vim:tw=0:ts=2:sw=2:et:ai
+
+require 'MrMurano/Exchange-Element'
+
+module MrMurano
+  # The Exchange class represents an end user's Murano IoT Exchange Elements.
+  class Exchange < Business
+    include Http
+    include Verbose
+
+    def get(path='', query=nil, &block)
+      super
+    end
+
+    def element(element_id)
+      ret = get('exchange/' + bid + '/element/' + element_id)
+      return nil unless ret.is_a?(Hash) && !ret.key?(:error)
+      ret
+    end
+
+    def fetch_type(part)
+      whirly_start('Fetching Elements...')
+      ret = get('exchange/' + bid + part) do |request, http|
+        response = http.request(request)
+        case response
+        when Net::HTTPSuccess
+          workit_response(response)
+        else
+          showHttpError(request, response)
+        end
+      end
+      whirly_stop
+      return [] unless ret.is_a?(Hash) && !ret.key?(:error)
+      return [] unless ret.key?(:items)
+      unless ret[:count] == ret[:items].length
+        warning(
+          'Unexpected: ret[:count] != ret[:items].length: ' \
+          "#{ret[:count]} != #{ret[:items].length}"
+        )
+      end
+      ret[:items]
+    end
+
+    def elements(**opts)
+      lookp = {}
+      # Get the user's Business metadata, including their Business tier.
+      overview if @ometa.nil?
+      # Fetch the list of Elements, including Added, Available, and Upgradeable.
+      items = fetch_type('/element/')
+      # Prepare a lookup of the Elements.
+      elems = items.map do |meta|
+        elem = MrMurano::ExchangeElement.new(meta)
+        lookp[elem.elementId] = elem
+        elem
+      end
+      # Fetch the list of Purchased elements.
+      items = fetch_type('/purchase/')
+      # Update the list of all Elements to indicate which have been purchased.
+      items.each do |meta|
+        elem = lookp[meta[:elementId]]
+        if !elem.nil?
+          elem.purchaseId = meta[:purchaseId]
+          # Sanity check.
+          meta[:element].each do |key, val|
+            next if elem.send(key) == val
+            warning(
+              'Unexpected: Exchange Purchase element meta differs: ' \
+              "key: #{key} / elem: #{elem.send(key)} / purchase: #{val}"
+            )
+          end
+        else
+          warning("Unexpected: No Element found for Exchange Purchase: elementId: #{meta[:elementId]}")
+        end
+      end
+      prepare_elements(elems, **opts)
+    end
+
+    def prepare_elements(elems, filter_id: nil, filter_name: nil, filter_fuzzy: nil)
+      if filter_id || filter_name || filter_fuzzy
+        elems.select! do |elem|
+          if (
+            (filter_id && elem.elementId == filter_id) || \
+            (filter_name && elem.name == filter_name) || \
+            (filter_fuzzy &&
+              (
+                elem.elementId =~ /#{Regexp.escape(filter_fuzzy)}/i || \
+                elem.name =~ /#{Regexp.escape(filter_fuzzy)}/i
+              )
+            )
+          )
+            true
+          else
+            false
+          end
+        end
+      end
+
+      available = []
+      purchased = []
+      elems.sort_by(&:name)
+      elems.each do |elem|
+        if elem.purchaseId.nil?
+          available.push(elem)
+          if !@ometa[:tier].nil? && elem.tiers.include?(@ometa[:tier][:id])
+            elem.statusable = :available
+          else
+            elem.statusable = :upgrade
+          end
+        else
+          purchased.push(elem)
+          elem.statusable = :added
+        end
+        #@ometa[:status] = elem.status
+      end
+
+      [elems, available, purchased]
+    end
+
+    def purchase(element_id)
+      whirly_start('Purchasing Element...')
+      ret = post(
+        'exchange/' + bid + '/purchase/',
+        elementId: element_id,
+      )
+      # Returns, e.g.,
+      #  { bizid: "XXX", elementId: "YYY", purchaseId: "ZZZ" }
+      whirly_stop
+      ret
+    end
+  end
+end
+

data/lib/MrMurano/Gateway.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.23 /coding: utf-8
+# Last Modified: 2017.09.11 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -29,10 +29,10 @@ module MrMurano
 
       def initialize
         @solntype = 'product.id'
-        @uriparts_sidex = 1
-        init_sid!
-        @uriparts = [:service, @sid, :device2]
-        @uriparts_sidex = 1
+        @uriparts_apidex = 1
+        init_api_id!
+        @uriparts = [:service, @api_id, :device2]
+        @uriparts_apidex = 1
         @itemkey = :id
       end
 
@@ -195,7 +195,7 @@ module MrMurano
         @here = locallist
       end
 
-      def download(_local, item)
+      def download(_local, item, _options=nil)
         # Not calling, e.g., `return unless download_item_allowed(item[@itemkey])`
         #   See instead: syncup_after and syncdown_after/resources_write
         @here = locallist if @here.nil?
@@ -463,7 +463,7 @@ module MrMurano
         raise "Gateway info not found for #{identifier}" if info.nil?
         fqdn = info[:fqdn]
         debug "Found FQDN: #{fqdn}"
-        fqdn = "#{@sid}.m2.exosite.io" if fqdn.nil?
+        fqdn = "#{@api_id}.m2.exosite.io" if fqdn.nil?
 
         uri = URI("https://#{fqdn}/provision/activate")
         http = Net::HTTP.new(uri.host, uri.port)
@@ -471,8 +471,8 @@ module MrMurano
         http.start
         request = Net::HTTP::Post.new(uri)
         request.form_data = {
-          vendor: @sid,
-          model: @sid,
+          vendor: @api_id,
+          model: @api_id,
           sn: identifier,
         }
         request['User-Agent'] = "MrMurano/#{MrMurano::VERSION}"

data/lib/MrMurano/Keystore.rb

@@ -1,13 +1,15 @@
-# Last Modified: 2017.08.16 /coding: utf-8
+# Last Modified: 2017.09.11 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
 # License: MIT. See LICENSE.txt.
 #  vim:tw=0:ts=2:sw=2:et:ai
 
+require 'MrMurano/Solution-ServiceConfig'
+
 module MrMurano
   class Keystore < ServiceConfig
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       # FIXME/2017-07-03: Do products have a keystore service? What about other soln types?
       @solntype = 'application.id'
       super

data/lib/MrMurano/ReCommander.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.23 /coding: utf-8
+# Last Modified: 2017.08.29 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -77,7 +77,7 @@ module Commander
     # We override -- monkey patch -- it to do other stuff.
     alias old_run_active_command run_active_command
     def run_active_command
-      exit @command_exit if @command_exit
+      exit @command_exit if defined?(@command_exit) && @command_exit
       section = active_command.name
       hooked = MrMurano::Hooked.new(section)
       hooked.check_run_pre_hook
@@ -227,9 +227,7 @@ module Commander
                 opt[:switches].map { |sw| MrMurano::Verbose.fancy_ticks(sw) }.join('|')
               end
               match = match.flatten
-              if match.length > 1
-                match[-1] = "and #{match[-1]}"
-              end
+              match[-1] = "and #{match[-1]}" if match.length > 1
               match = match.join(', ')
               MrMurano::Verbose.error("Ambiguous option: #{ambig} matches: #{match}")
               exit 2

data/lib/MrMurano/Solution-ServiceConfig.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.22 /coding: utf-8
+# Last Modified: 2017.09.11 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -10,7 +10,7 @@ require 'MrMurano/Solution'
 module MrMurano
   # …/serviceconfig
   class ServiceConfig < SolutionBase
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       super
       @uriparts << :serviceconfig
       @scid = nil
@@ -58,7 +58,7 @@ module MrMurano
       post(
         '/',
         {
-          solution_id: @sid,
+          solution_id: @api_id,
           service: pid,
           # 2017-06-26: "name" seems to work, but "script_key" is what web UI uses.
           #   See yeti-ui/bridge/src/js/api/services.js::linkApplicationService
@@ -112,20 +112,20 @@ module MrMurano
   # A much better UI/UX happens with human intervention.
   # :nocov:
   class Services < SolutionBase
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       super
       @uriparts << :service
     end
 
-    def sid_for_name(name)
+    def api_id_for_name(name)
       name = name.to_s unless name.is_a? String
       scr = list.select { |i| i[:alias] == name }.first
       scr[:id]
     end
 
-    def sid
-      return @sid unless @sid.nil?
-      @sid = sid_for_name(@service_name)
+    def api_id
+      return @api_id unless @api_id.nil?
+      @api_id = api_id_for_name(@service_name)
     end
 
     def list
@@ -137,13 +137,13 @@ module MrMurano
       #   sort_by_name(ret[:items])
     end
 
-    def schema(id=sid)
+    def schema(id=api_id)
       # TODO: cache schema in user dir?
       get("/#{id}/schema")
     end
 
     ## Get list of call operations from a schema
-    def callable(id=sid, all=false)
+    def callable(id=api_id, all=false)
       scm = schema(id)
       calls = []
       scm[:paths].each do |path, methods|
@@ -174,14 +174,14 @@ module MrMurano
   # :nocov:
 
   class ServiceConfigApplication < ServiceConfig
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       @solntype = 'application.id'
       super
     end
   end
 
   class ServiceConfigProduct < ServiceConfig
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       @solntype = 'product.id'
       super
     end

data/lib/MrMurano/Solution-Services.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.23 /coding: utf-8
+# Last Modified: 2017.09.11 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -21,7 +21,7 @@ module MrMurano
   ##
   # Things that servers do that is common.
   class ServiceBase < SolutionBase
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       super
     end
 
@@ -67,6 +67,7 @@ module MrMurano
       else
         # I.e., thereitem.phantom, an "undeletable" file that does not
         # exist locally but should not be deleted from server.
+        # MAYBE/2017-09-07: Honor options.ignore_errors here?
         raise 'no file' unless thereitem.script
         script = thereitem.script
       end
@@ -77,7 +78,7 @@ module MrMurano
       name = mkname(thereitem)
       pst = thereitem.to_h.merge(
         #solution_id: $cfg[@solntype],
-        solution_id: @sid,
+        solution_id: @api_id,
         script: script,
         alias: mkalias(thereitem),
         name: name,
@@ -174,7 +175,7 @@ module MrMurano
       [
         'cache',
         self.class.to_s.gsub(/\W+/, '_'),
-        @sid,
+        @api_id,
         'yaml',
       ].join('.')
     end
@@ -258,7 +259,7 @@ module MrMurano
       attr_accessor :solution_id
     end
 
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       @solntype = 'application.id'
       super
       @uriparts << :module
@@ -283,7 +284,7 @@ module MrMurano
     def mkalias(remote)
       raise "Missing parts! #{remote.to_h.to_json}" if remote.name.nil?
       #[$cfg[@solntype], remote[:name]].join('_')
-      [@sid, remote[:name]].join('_')
+      [@api_id, remote[:name]].join('_')
     end
 
     def mkname(remote)
@@ -349,7 +350,7 @@ module MrMurano
       attr_accessor :updated_at
       # @return [String] Timestamp when this was created.
       attr_accessor :created_at
-      # @return [String] The soln's product.id or application.id (Murano's apiId).
+      # @return [String] The soln's product.id or application.id (Murano's api_id).
       attr_accessor :solution_id
       # @return [String] Which service triggers this script.
       attr_accessor :service
@@ -366,7 +367,7 @@ module MrMurano
       attr_accessor :phantom
     end
 
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       super
       @uriparts << :eventhandler
       @itemkey = :alias
@@ -378,7 +379,7 @@ module MrMurano
     def mkalias(remote)
       raise "Missing parts! #{remote.to_h.to_json}" if remote.service.nil? || remote.event.nil?
       #[$cfg[@solntype], remote[:service], remote[:event]].join('_')
-      [@sid, remote[:service], remote[:event]].join('_')
+      [@api_id, remote[:service], remote[:event]].join('_')
     end
 
     def mkname(remote)
@@ -482,12 +483,12 @@ module MrMurano
       end
     end
 
-    def default_event_script(service_or_sid, &block)
+    def default_event_script(service_or_api_id, &block)
       post(
         '/',
         {
-          solution_id: @sid,
-          service: service_or_sid,
+          solution_id: @api_id,
+          service: service_or_api_id,
           event: 'event',
           script: 'print(event)',
         },
@@ -712,7 +713,7 @@ module MrMurano
   PRODUCT_SERVICES = %w[device2 interface].freeze
 
   class EventHandlerSolnPrd < EventHandler
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       @solntype = 'product.id'
       # FIXME/2017-06-20: Should we use separate directories for prod vs app?
       #   See also :services in PrfFile and elsewhere;
@@ -748,7 +749,7 @@ module MrMurano
   end
 
   class EventHandlerSolnApp < EventHandler
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       @solntype = 'application.id'
       # FIXME/2017-06-20: Should we use separate directories for prod vs app?
       @project_section = :services

data/lib/MrMurano/Solution-Users.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.22 /coding: utf-8
+# Last Modified: 2017.09.07 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -56,7 +56,7 @@ module MrMurano
       post('/', remote)
     end
 
-    def download(local, item)
+    def download(local, item, _options=nil)
       # needs to append/merge with file
       # for now, we'll read, modify, write
       here = []

data/lib/MrMurano/Solution.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.23 /coding: utf-8
+# Last Modified: 2017.09.11 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -20,19 +20,19 @@ module MrMurano
     include SolutionId
 
     def initialize(from=nil)
-      @uriparts_sidex = 1
+      @uriparts_apidex = 1
       # Introspection. Feels hacky.
       if from.is_a? MrMurano::Solution
-        init_sid!(from.sid)
-        @valid_sid = from.valid_sid
+        init_api_id!(from.api_id)
+        @valid_api_id = from.valid_api_id
         # We shouldn't need to worry about other things...
         #@token = from.token
         #@http = from.http
         #@json_opts = from.json_opts
       else
-        init_sid!(from)
+        init_api_id!(from)
       end
-      @uriparts = [:solution, @sid]
+      @uriparts = [:solution, @api_id]
       @itemkey = :id
       @project_section = nil unless defined?(@project_section)
     end
@@ -44,7 +44,7 @@ module MrMurano
     protected
 
     def state
-      [@sid, @valid_sid, @uriparts, @solntype, @itemkey, @project_section]
+      [@api_id, @valid_api_id, @sid, @uriparts, @solntype, @itemkey, @project_section]
     end
 
     public
@@ -69,7 +69,7 @@ module MrMurano
       while remaining != 0
         ret = super
         if ret.nil? && !@suppress_error
-          warning "No solution with ID: #{@sid}"
+          warning "No solution with ID: #{@api_id}"
           whirly_interject { say 'Run `murano show` to see the business and list of solutions.' }
           MrMurano::SolutionBase.warn_configfile_env_maybe
           exit 1
@@ -146,11 +146,10 @@ module MrMurano
   end
 
   class Solution < SolutionBase
-    def initialize(sid=nil)
-      # Does it matter if we use :sid or :apiId?
-      meta = sid if sid.is_a?(Hash)
-      sid = sid[:sid] if sid.is_a?(Hash)
-      super(sid)
+    def initialize(api_id=nil)
+      meta = api_id if api_id.is_a?(Hash)
+      api_id = api_id[:api_id] || api_id[:apiId] if api_id.is_a?(Hash)
+      super(api_id)
       set_name
       @meta = {}
       @valid = false
@@ -189,10 +188,10 @@ module MrMurano
       resp = get
       if resp.is_a?(Hash) && !resp.key?(:error)
         self.meta = resp
-        @valid_sid = true
+        @valid_api_id = true
       else
         self.meta = {}
-        @valid_sid = false
+        @valid_api_id = false
       end
       @suppress_error = false
     end
@@ -230,24 +229,22 @@ module MrMurano
       @meta = data
       # Verify the solution ID.
       # NOTE: The Solution info fetched from business/<bizid>/solutions endpoint
-      #   includes the keys, :name, :sid, and :domain (see calls to solutions()).
-      #   The solution details fetched from a call to Solution.get() include the
-      #   keys, :name, :id, and :domain, among others.
+      #   includes the keys, :name, :api_id, :sid, and :domain (see calls to
+      #   solutions()). The solution details fetched from a call to Solution.get()
+      #   include the keys, :name, :id, and :domain, among others.
       #   Note that the info() response does not include :type.
-      #   Also, :apiId is indicated by solutions(), too.
-      sid = @meta[:sid] || @meta[:id] || nil
-      unless @meta[:apiId].to_s.empty?
-        if @meta[:apiId] != @meta[:sid]
-          warning "Unexpected: apiId != sid: #{@meta[:apiId]} != #{@meta[:sid]}"
-        end
-      end
-      unless @sid.to_s.empty? || sid.to_s == @sid.to_s
+      api_id = @meta[:apiId] || @meta[:id]
+      unless @api_id.to_s.empty? || api_id.to_s.empty? || api_id.to_s == @api_id.to_s
         warning(
-          "#{type_name} ID mismatch. Server says #{fancy_ticks(sid)}, " \
-          "but config says #{fancy_ticks(@sid)}."
+          "#{type_name} ID mismatch. Server says #{fancy_ticks(api_id)}, " \
+          "but config says #{fancy_ticks(@api_id)}."
         )
       end
-      self.sid = sid
+      self.api_id = api_id
+      # NOTE: In Murano 1.0 (pre-ADC), api_id != sid; in Murano 1.1, they're ==.
+      #   The sid is used in business/<bid>/solution/<sid>
+      #   The apiId is used in solution/<apiId>
+      @sid = @meta[:sid]
       # Verify/set the name.
       unless @name.to_s.empty? || @meta[:name].to_s == @name.to_s
         warning(
@@ -256,21 +253,18 @@ module MrMurano
         )
       end
       if !@meta[:name].to_s.empty?
-        set_name(@meta[:name])
-        unless @valid_name || type == :solution
-          warning(
-            "Unexpected: Server returned invalid name: #{fancy_ticks(@meta[:name])}"
-          )
+        # NOTE: Pre-ADC (a/k/a migrated) applications are not named, at least
+        # when you query the business/<bid>/solution/ endpoint. But when you
+        # call info_safe, which GETs the solution details, the name is
+        # the domain and contains dots, which is considered an illegal name!
+        if @meta[:name] != @meta[:domain]
+          set_name(@meta[:name])
+          unless @valid_name || type == :solution
+            warning(
+              "Unexpected: Server returned invalid name: #{fancy_ticks(@meta[:name])}"
+            )
+          end
         end
-      elsif @meta[:domain]
-        # This could be a pre-ADC/pre-Murano business.
-        warning(
-          "Unexpected: Server returned no name for domain: #{fancy_ticks(@meta[:domain])}"
-        )
-      else
-        warning(
-          "Unexpected: Server returned no name for solution: #{fancy_ticks(@meta)}"
-        )
       end
     end
 
@@ -283,9 +277,9 @@ module MrMurano
       #   classes should not be formatting output), but this seems okay.
       desc = ''
       desc += "#{type.to_s.capitalize}: " if add_type
-      name = self.name || '~Unnamed~'
-      sid = self.sid || '~No-ID~'
-      desc += "#{Rainbow(name).underline} <#{sid}>"
+      name = !self.name.empty? && self.name || '~Unnamed~'
+      api_id = !self.api_id.empty? && self.api_id || '~No-ID~'
+      desc += "#{Rainbow(name).underline} <#{api_id}>"
       if domain
         desc += ' '
         desc += 'https://' unless raw_url
@@ -341,7 +335,7 @@ module MrMurano
     end
 
     def valid?
-      @valid_sid && @valid_name
+      @valid_api_id && @valid_name
     end
 
     def valid_name?
@@ -358,7 +352,7 @@ module MrMurano
   end
 
   class Application < Solution
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       @solntype = 'application.id'
       super
     end
@@ -391,7 +385,7 @@ The name must contain at least 1 character and no more than 63.
   end
 
   class Product < Solution
-    def initialize(sid=nil)
+    def initialize(api_id=nil)
       # Code path for `murano domain`.
       @solntype = 'product.id'
       super