MuranoCLI 2.2.4 → 3.0.0

data/lib/MrMurano/Solution-Users.rb

@@ -1,16 +1,32 @@
-require 'uri'
-require 'net/http'
+# Last Modified: 2017.08.17 /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 'json'
-require 'yaml'
+require 'net/http'
 require 'pp'
+require 'uri'
+require 'yaml'
 require 'MrMurano/Solution'
+#require 'MrMurano/SyncRoot'
 
 module MrMurano
   ##
   # User Management common things
   class UserBase < SolutionBase
-    def list()
-      get()
+    def initialize
+      super
+    end
+
+    def list
+      get
+      # MAYBE/2017-08-17:
+      #   ret = get
+      #   return [] unless ret.is_a?(Array)
+      #   sort_by_name(ret)
     end
 
     def fetch(id)
@@ -22,18 +38,19 @@ module MrMurano
     end
 
     # @param modify Bool: True if item exists already and this is changing it
-    def upload(local, remote, modify)
+    def upload(_local, remote, _modify)
       # Roles cannot be modified, so must delete and post.
       delete('/' + remote[@itemkey]) do |request, http|
         response = http.request(request)
         case response
+        # rubocop:disable Lint/EmptyWhen: Avoid when branches without a body.
         when Net::HTTPSuccess
         when Net::HTTPNotFound
         else
           showHttpError(request, response)
         end
       end
-      remote.reject!{|k,v| k==:synckey or k==:bundled}
+      remote.reject! { |k, _v| %i[bundles synckey synctype].include? k }
       post('/', remote)
     end
 
@@ -41,16 +58,19 @@ module MrMurano
       # needs to append/merge with file
       # for now, we'll read, modify, write
       here = []
-      if local.exist? then
-        local.open('rb') {|io| here = YAML.load(io)}
+      if local.exist?
+        # FIXME/2017-07-18: Security/YAMLLoad: Prefer using YAML.safe_load over YAML.load.
+        #   Disabling [rubo]cop for now.
+        # rubocop:disable Security/YAMLLoad
+        local.open('rb') { |io| here = YAML.load(io) }
         here = [] if here == false
       end
       here.delete_if do |i|
         Hash.transform_keys_to_symbols(i)[@itemkey] == item[@itemkey]
       end
-      here << item.reject{|k,v| k==:synckey}
+      here << item.reject { |k, _v| %i[synckey synctype].include? k }
       local.open('wb') do |io|
-        io.write here.map{|i| Hash.transform_keys_to_strings(i)}.to_yaml
+        io.write here.map { |i| Hash.transform_keys_to_strings(i) }.to_yaml
       end
     end
 
@@ -58,64 +78,83 @@ module MrMurano
       # needs to append/merge with file
       # for now, we'll read, modify, write
       here = []
-      if local.exist? then
-        local.open('rb') {|io| here = YAML.load(io)}
+      if local.exist?
+        # FIXME/2017-07-18: Security/YAMLLoad: Prefer using YAML.safe_load over YAML.load.
+        local.open('rb') { |io| here = YAML.load(io) }
         here = [] if here == false
       end
       key = @itemkey.to_sym
       here.delete_if do |it|
         Hash.transform_keys_to_symbols(it)[key] == item[key]
       end
-      local.open('wb') do|io|
-        io.write here.map{|i| Hash.transform_keys_to_strings(i)}.to_yaml
+      local.open('wb') do |io|
+        io.write here.map { |i| Hash.transform_keys_to_strings(i) }.to_yaml
       end
     end
 
-    def tolocalpath(into, item)
+    def tolocalpath(into, _item)
       into
     end
 
     def localitems(from)
-      from = Pathname.new(from) unless from.kind_of? Pathname
-      if not from.exist? then
-        warning "Skipping missing #{from.to_s}"
+      from = Pathname.new(from) unless from.is_a? Pathname
+      unless from.exist?
+        warning "Skipping missing #{from}"
         return []
       end
-      unless from.file? then
-        warning "Cannot read from #{from.to_s}"
+      unless from.file?
+        warning "Cannot read from #{from}"
         return []
       end
 
+      # MAYBE/2017-07-03: Do we care if there are duplicate keys in the yaml? See dup_count.
       here = []
-      from.open {|io| here = YAML.load(io) }
+      # FIXME/2017-07-18: Security/YAMLLoad: Prefer using YAML.safe_load over YAML.load.
+      from.open { |io| here = YAML.load(io) }
       here = [] if here == false
 
-      here.map{|i| Hash.transform_keys_to_symbols(i)}
+      here.map! { |i| Hash.transform_keys_to_symbols(i) }
+
+      sort_by_name(here)
     end
   end
 
   # …/role
   class Role < UserBase
     def initialize
+      @solntype = 'application.id'
+      #@solntype = 'product.id'
       super
-      @uriparts << 'role'
+      @uriparts << :role
       @itemkey = :role_id
     end
+
+    def self.description
+      %(Role)
+    end
   end
-  #SyncRoot.add('roles', Role, 'R', %{Roles})
+  #SyncRoot.instance.add('roles', Role, 'G', false)
 
   # …/user
   # :nocov:
   class User < UserBase
     def initialize
+      # 2017-07-03: [lb] tried 'product.id' and got 403 Forbidden;
+      #   And I tried 'application.id' and get() returned an empty [].
+      @solntype = 'application.id'
+      #@solntype = 'product.id'
       super
-      @uriparts << 'user'
+      @uriparts << :user
+    end
+
+    def self.description
+      %(User)
     end
 
     # @param modify Bool: True if item exists already and this is changing it
-    def upload(local, remote, modify)
-      # TODO figure out APIs for updating users.
-      warning "Updating Users isn't working currently."
+    def upload(_local, _remote, _modify)
+      # TODO: figure out APIs for updating users.
+      warning %(Updating Users is not yet implemented.)
       # post does work if the :password field is set.
     end
 
@@ -124,6 +163,6 @@ module MrMurano
     end
   end
   # :nocov:
-  #SyncRoot.add('users', User, 'U', %{Users})
+  #SyncRoot.instance.add('users', User, 'U', false)
 end
-#  vim: set ai et sw=2 ts=2 :
+

data/lib/MrMurano/Solution.rb

@@ -1,59 +1,418 @@
+# Last Modified: 2017.08.17 /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 'rainbow'
 require 'uri'
-require 'MrMurano/Config'
 require 'MrMurano/http'
 require 'MrMurano/verbosing'
+require 'MrMurano/Config'
+require 'MrMurano/SolutionId'
 require 'MrMurano/SyncUpDown'
 
 module MrMurano
   class SolutionBase
-    def initialize
-      @sid = $cfg['solution.id']
-      raise MrMurano::ConfigError.new("No solution!") if @sid.nil?
+    include Http
+    include Verbose
+    include SolutionId
+
+    def initialize(from=nil)
+      @uriparts_sidex = 1
+      # Introspection. Feels hacky.
+      if from.is_a? MrMurano::Solution
+        init_sid!(from.sid)
+        @valid_sid = from.valid_sid
+        # We shouldn't need to worry about other things...
+        #@token = from.token
+        #@http = from.http
+        #@json_opts = from.json_opts
+      else
+        init_sid!(from)
+      end
       @uriparts = [:solution, @sid]
       @itemkey = :id
-      @project_section = nil
+      @project_section = nil unless defined?(@project_section)
     end
 
-    include Http
-    include Verbose
+    def ==(other)
+      other.class == self.class && other.state == state
+    end
+
+    protected
+
+    def state
+      [@sid, @valid_sid, @uriparts, @solntype, @itemkey, @project_section]
+    end
+
+    public
 
     ## Generate an endpoint in Murano
     # Uses the uriparts and path
     # @param path String: any additional parts for the URI
     # @return URI: The full URI for this enpoint.
-    def endPoint(path='')
+    def endpoint(path='')
+      super
       parts = ['https:/', $cfg['net.host'], 'api:1'] + @uriparts
-      s = parts.map{|v| v.to_s}.join('/')
+      s = parts.map(&:to_s).join('/')
       URI(s + path.to_s)
     end
     # …
 
+    def get(path='', query=nil, &block)
+      aggregate = nil
+      total = nil
+      remaining = -1
+      orig_query = (query || []).dup
+      while remaining != 0
+        ret = super
+        if ret.nil? && !@suppress_error
+          warning "No solution with ID: #{@sid}"
+          whirly_interject { say 'Run `murano show` to see the business and list of solutions.' }
+          MrMurano::SolutionBase.warn_configfile_env_maybe
+          exit 1
+        end
+        return nil if ret.nil?
+        # Pagination: Check if more data.
+        if ret.is_a?(Hash) && ret.key?(:total) && ret.key?(:items)
+          query = orig_query.dup
+          if total.nil?
+            total = ret[:total]
+            remaining = total - ret[:items].length
+            # The response also includes a hint of how to get the next page.
+            #   ret[:next] == "/api/v1/eventhandler?query={\
+            #     \"solution_id\":\"XXXXXXXXXXXXXXXX\"}&limit=20&offset=20"
+            # But note that the URL we use is a little different
+            #   https://bizapi.hosted.exosite.io/api:1/solution/XXXXXXXXXXXXXXXXX/eventhandler
+          else
+            if total != ret[:total]
+              warning "Unexpected: subsequence :total not total: #{ret[:total]} != #{total}"
+            end
+            remaining -= ret[:items].length
+          end
+          if remaining > 0
+            #query.push ['limit', 20]
+            query.push ['offset', total - remaining]
+          elsif remaining != 0
+            warning "Unexpected: negative remaining: ‘#{total}’"
+            remaining = 0
+          end
+          if aggregate.nil?
+            aggregate = ret
+          else
+            aggregate[:items].concat ret[:items]
+          end
+        else
+          # ret is not a hash, or it's missing :total or :items.
+          warning "Unexpected: aggregate set: #{aggregate} / ret: #{ret}" unless aggregate.nil?
+          aggregate = ret
+          remaining = 0
+        end
+      end
+      aggregate
+    end
+
+    # This at least works for EventHandler and ServiceConfig.
+    # - ServiceConfig overrides to fetch also 'script_key'.
+    def search(svc_name, path=nil)
+      # NOTE: You can ask the server to filter the list.
+      #   E.g., the web UI filters with:
+      #     ?select=service,id,solution_id,script_key,alias
+      #   NOTE: ServiceConfig has 'script_key', but EventHandler does not.
+      #     So a default filter would exclude 'script_key'.
+      #   HOWEVER: As of 2017-06-28, there is no discernible change in
+      #     processing time, so no real reason to ask server to filter
+      #     the results.
+      #path = path || '?select=id,service'
+      matches = list(path)
+      matches.select { |match| match[:service] == svc_name }
+    end
+
+    def self.warn_configfile_env_maybe
+      if !$cfg.get('business.id', :env).to_s.empty? &&
+         !$cfg.get('business.id', :project).to_s.empty? &&
+         $cfg.get('business.id', :env) != $cfg.get('business.id', :project)
+        MrMurano::Verbose.warning(
+          'NOTE: MURANO_CONFIGFILE specifies a different business.id than the local project file'
+        )
+      end
+    end
+
     include SyncUpDown
   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)
+      set_name
+      @meta = {}
+      @valid = false
+      self.meta = meta unless meta.nil?
+    end
+
+    # The Solution @name.
+    attr_reader :name
+
+    # A reference to the business account object.
+    attr_accessor :biz
+
+    attr_reader :meta
+
+    protected
+
+    def state
+      parts = super
+      parts + [@name, @meta, @valid]
+    end
+
+    public
+
+    # *** Network calls
+
     def version
       get('/version')
     end
 
     def info
-      get()
+      get
+    end
+
+    def info_safe
+      @suppress_error = true
+      resp = get
+      if resp.is_a?(Hash) && !resp.key?(:error)
+        self.meta = resp
+        @valid_sid = true
+      else
+        self.meta = {}
+        @valid_sid = false
+      end
+      @suppress_error = false
     end
 
     def list
       get('/')
+      # MAYBE/2017-08-17:
+      #   ret = get('/')
+      #   return [] unless ret.is_a?(Array)
+      #   sort_by_name(ret)
+    end
+
+    def usage
+      get('/usage')
     end
 
     def log
       get('/logs')
     end
 
-    def usage
-      get('/usage')
+    # *** Solution utils
+
+    def cfg_key_id
+      "#{type}.id"
     end
 
+    def cfg_key_name
+      "#{type}.name"
+    end
+
+    # meta is from the list of solutions fetched from business/<bizid>/solution/,
+    # e.g., from a call to solutions(), applications(), or products(); or it's
+    # from a call to info.
+    def meta=(data)
+      @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.
+      #   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
+        warning "#{type_name} ID mismatch. Server says ‘#{sid}’, but config says ‘#{@sid}’."
+      end
+      self.sid = sid
+      # Verify/set the name.
+      unless @name.to_s.empty? || @meta[:name].to_s == @name.to_s
+        warning "Name mismatch. Server says ‘#{@meta[:name]}’, but config says ‘#{@name}’."
+      end
+      if !@meta[:name].to_s.empty?
+        set_name(@meta[:name])
+        unless @valid_name || type == :solution
+          warning "Unexpected: Server returned invalid name: ‘#{@meta[:name]}’"
+        end
+      elsif @meta[:domain]
+        # This could be a pre-ADC/pre-Murano business.
+        warning "Unexpected: Server returned no name for domain: ‘#{@meta[:domain]}’"
+      else
+        warning "Unexpected: Server returned no name for solution: ‘#{@meta}’"
+      end
+    end
+
+    def domain
+      @meta[:domain]
+    end
+
+    def pretty_desc(add_type: false, raw_url: false)
+      # [lb] would normally put presentation code elsewhere (i.e., model
+      #   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}>"
+      if domain
+        desc += ' '
+        desc += 'https://' unless raw_url
+        desc += domain
+      end
+      desc
+    end
+
+    def type
+      # info() doesn't return :type. So get from class name, e.g.,
+      # if soln.class == 'MrMurano::Product', type is :product.
+      #self.class.to_s.gsub(/^.*::/, '')
+      #raise 'Not implemented'
+      # Return, e.g., :application or :product.
+      self.class.to_s.gsub(/^.*::/, '').downcase.to_sym
+    end
+
+    def type_name
+      type.to_s.capitalize
+    end
+
+    # FIXME/Rubocop/2017-07-02: Style/AccessorMethodName
+    #   Rename set_name, perhaps to apply_name?
+    # rubocop:disable Style/AccessorMethodName
+    def set_name(name=nil)
+      # Use duck typing instead of `is_a? String` to be more duck-like.
+      if name.respond_to?(:to_str) && name != ''
+        @name = name
+        # FIXME/Rubocop/2017-07-02: Double-negation
+        @valid_name = !@name.match(name_validate_regex).nil?
+      else
+        @name = ''
+        @valid_name = false
+      end
+    end
+
+    # FIXME/Rubocop/2017-07-02: Style/AccessorMethodName
+    #   Or maybe no. Cannot create method `def name!=(name)` and I [lb]
+    #   kinda like the bang!. You could call it apply_name!, perhaps.
+    def set_name!(name)
+      raise 'Expecting name, not nothing' unless name && name != ''
+      raise MrMurano::ConfigError.new(name_validate_help) unless name.match(name_validate_regex)
+      @name = name
+      @valid_name = true
+    end
+
+    def quoted_name
+      if @name.to_s.empty?
+        ''
+      else
+        "‘#{@name}’"
+      end
+    end
+
+    def valid?
+      @valid_sid && @valid_name
+    end
+
+    def valid_name?
+      @valid_name
+    end
+
+    def name_validate_regex
+      /^$/
+    end
+
+    def name_validate_help
+      ''
+    end
+  end
+
+  class Application < Solution
+    def initialize(sid=nil)
+      @solntype = 'application.id'
+      super
+    end
+
+    # FIXME/2017-07-02: Test long names:
+    # Murano Appl:
+    #     /^[a-zA-Z0-9-\s]{1,63}$/
+    #   E.g., longest acceptable name:
+    #     #ABCdefGHIjklMNOpqrSTUvwxYZAbcdefghijklmnopqrstuvwxyz34567890123
+    #     99-Party-TIME-XXX-YOU-BETCHA-letsallridebikes4ever-and-4ever111
+    # Murano Prod:
+    #     /^(?![0-9])[a-zA-Z0-9]{2,63}$/
+    #     Yassssssssssssssssssss11111111111111111111111111111111111111111
+    # Either (should be too long):
+    #     abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz345678901234567890123456789
+
+    # FIXME/2017-06-28: Test uppercase characters again.
+
+    # SYNC_ME: See regex in bizapi: lib/api/route/business/solution.js
+    def name_validate_regex
+      /^[a-zA-Z0-9\-\s]{1,63}$/
+    end
+
+    def name_validate_help
+      %(
+The Application name may only contain letters, numbers, and dashes.
+The name must contain at least 1 character and no more than 63.
+      ).strip
+    end
   end
 
+  class Product < Solution
+    def initialize(sid=nil)
+      # Code path for `murano domain`.
+      @solntype = 'product.id'
+      super
+    end
+
+    # SYNC_ME: See regex in bizapi: lib/api/route/business/solution.js
+    def name_validate_regex
+      /^(?![0-9])[a-zA-Z0-9]{2,63}$/
+    end
+
+    def name_validate_help
+      %(
+The Product name may contain only letters and numbers, and the name may
+not start with a number. The name must contain at least 3 characters and
+no more than 63.
+      ).strip
+    end
+  end
+end
+
+def solution_factory_reset(sol)
+  new_sol = nil
+  if sol.is_a? MrMurano::Solution
+    unless sol.meta[:template].to_s.empty?
+      begin
+        clazz = Object.const_get("MrMurano::#{sol.meta[:template].capitalize}")
+        new_sol = clazz.new(sol)
+        new_sol.meta = sol.meta
+      rescue NameError => _err
+        MrMurano::Verbose.warning(
+          "Unrecognized solution :template value: #{sol.meta[:template]}"
+        )
+      end
+    end
+  end
+  new_sol || sol
 end
 
-#  vim: set ai et sw=2 ts=2 :