MuranoCLI 3.2.0.beta.9 → 3.2.1.pre.beta.3

data/lib/MrMurano/Gateway.rb

@@ -17,6 +17,7 @@ require 'MrMurano/Config'
 require 'MrMurano/SolutionId'
 require 'MrMurano/SyncRoot'
 require 'MrMurano/SyncUpDown'
+require 'MrMurano/SyncUpDown-Item'
 
 module MrMurano
   ## The details of talking to the Gateway [Device2] service.
@@ -114,6 +115,33 @@ module MrMurano
     class Resources < GweBase
       include SyncUpDown
 
+      class GatewayItem < Item
+        # @return [String] The type of data stored in aliases for this resource.
+        #   (string|boolean|number)
+        attr_accessor :format
+        # @return [String] Helpful unit description for the alias.
+        attr_accessor :unit
+        # @return [Boolean] List of data format validations.
+        attr_accessor :settable
+        # @return [Array] True if the cloud can write to this.
+        attr_accessor :allowed
+        # @return [String] The resource alias.
+        attr_accessor :alias
+
+        def reject_ephemeral!
+          super.reject do |attr_key, _|
+            [
+              # Server-siders:
+              #  :format,
+              #  :unit,
+              #  :settable,
+              #  :allowed,
+              #  :alias,
+            ].include? attr_key
+          end
+        end
+      end
+
       def initialize
         super
         @itemkey = :alias
@@ -132,7 +160,7 @@ module MrMurano
         # convert hash to array.
         res = []
         ret[:resources].each_pair do |key, value|
-          res << value.merge(alias: key.to_s)
+          res << GatewayItem.new(value.merge(alias: key.to_s))
         end
         res
         # MAYBE/2017-08-17:
@@ -144,7 +172,8 @@ module MrMurano
         res = {}
         data.each do |value|
           key = value[:alias]
-          res[key] = value.reject { |k, _v| k == :alias }
+          # (lb): Item has reject method, but convert to Hash, for patch.
+          res[key] = value.to_h.reject { |k, _v| k == :alias }
         end
 
         patch('', resources: res)
@@ -194,8 +223,6 @@ module MrMurano
 
       def syncdown_before
         super
-        # TEST/2017-07-02: Could there be duplicate gateway items?
-        #   [lb] just added code to SyncUpDown.locallist and is curious.
         @here = locallist
       end
 
@@ -247,10 +274,11 @@ module MrMurano
       def resources_write(file_path)
         num_synced = 0
         # User can blow away specs/ directory if they want; we'll just make
-        # a new one. [This code somewhat copy-paste from make_directory.]
+        # a new one. [This code is somewhat copy-paste from make_directory.]
         basedir = file_path
         basedir = basedir.dirname unless basedir.extname.empty?
-        raise 'Unexpected: bad basedir' if basedir.to_s.empty? || basedir == File::SEPARATOR
+        bad_basedir = basedir.to_s.empty? || basedir == File::SEPARATOR
+        raise 'Unexpected: bad basedir' if bad_basedir
 
         unless basedir.exist?
           if $cfg['tool.dry']
@@ -277,7 +305,7 @@ module MrMurano
           @here.each do |value|
             key = value[:alias]
             res[key] = Hash.transform_keys_to_strings(
-              value.reject { |k, _v| k == :alias }
+              value.to_h.reject { |k, _v| k == :alias }
             )
           end
           ohash = ordered_hash(res)
@@ -334,7 +362,9 @@ module MrMurano
 
         res = []
         here.each_pair do |key, value|
-          res << Hash.transform_keys_to_symbols(value).merge(alias: key.to_s)
+          hash = Hash.transform_keys_to_symbols(value).merge(alias: key.to_s)
+          item = GatewayItem.new(hash)
+          res << item
         end
 
         sort_by_name(res)
@@ -398,8 +428,17 @@ module MrMurano
       # @option opts [String,Pathname,IO] :key Shared secret for hash, password, token types;
       #                                        or public key for certificate auth type.
       #                                        May be string or IO/Pathname to file.
-      # @option opts [String] :type One of: certificate, hash, password, signature, token
-      DEVICE_AUTH_TYPES = %i[certificate hash password signature token].freeze
+      # @option opts [String] :type One of: DEVICE_AUTH_TYPES.
+
+      DEVICE_AUTH_TYPES = %i[
+        certificate
+        hash
+        password
+        signature
+        token
+        csr
+      ].freeze
+
       def enable(id, opts=nil)
         opts = {} if opts.nil?
         props = { auth: {}, locked: false }
@@ -421,6 +460,8 @@ module MrMurano
           props[:auth][:type] = opts[:type]
         end
         unless opts[:key].nil?
+          # 2018-07-10: (lb): I think the `read` feature is no longer used
+          #   (no callers pass in a File object any more).
           props[:auth][:key] = opts[:key].is_a?(String) && opts[:key] || opts[:key].read
           props[:auth][:type] = :certificate if props[:auth][:type].nil?
         end

data/lib/MrMurano/ReCommander.rb

@@ -370,7 +370,7 @@ module Commander
     def verify_solutions_unmanaged!
       return if $cfg['tool.skip-managed']
       # (lb): All @exosite.com employees are welcome behind the curtain.
-      if $cfg['user.name'] && $cfg['user.name'].end_with?("@exosite.com")
+      if $cfg['user.name'] && $cfg['user.name'].end_with?('@exosite.com')
         MrMurano::Verbose.verbose(
           "Welcome behind the curtain, #{$cfg['user.name']}!"
         )

data/lib/MrMurano/Solution-Services.rb

@@ -53,13 +53,14 @@ module MrMurano
       end
     end
 
-    # ??? remove
-    def remove(name)
-      return unless remove_item_allowed(name)
-      delete('/' + name)
+    def remove(itemkey)
+      return unless remove_item_allowed(itemkey)
+      delete('/' + itemkey)
     end
 
-    def remove_lite(_name, item, modify=false)
+    def remove_or_clear(itemkey, item, modify=false)
+      # Note that item.phantom, well, it did, until we called reject_ephemeral!.
+      return unless remove_item_allowed(itemkey)
       # This is a :phantom item, which has a default script, e.g.,
       #   item[:script] => "--#EVENT timer timer\n"
       localpath = tolocalpath(location, item)
@@ -71,7 +72,6 @@ module MrMurano
     def upload(localpath, thereitem, _modify=false)
       localpath = Pathname.new(localpath) unless localpath.is_a?(Pathname)
       if localpath.exist?
-        # we assume these are small enough to slurp.
         script = localpath.read
       else
         # I.e., thereitem.phantom, an "undeletable" file that does not
@@ -84,18 +84,19 @@ module MrMurano
       script = config_vars_decode(script)
 
       name = mkname(thereitem)
-      pst = thereitem.to_h.merge(
+      req_body = thereitem.to_h.merge(
         solution_id: @api_id,
         script: script,
         alias: mkalias(thereitem),
         name: name,
       )
-      debug "f: #{localpath} >> #{pst.reject { |k, _| k == :script }.to_json}"
+
+      debug "f: #{localpath} >> #{req_body.reject { |k, _| k == :script }.to_json}"
       therealias = mkalias(thereitem)
-      upload_script(therealias, name, localpath, pst)
+      upload_script(therealias, name, localpath, req_body)
     end
 
-    def upload_script(therealias, name, localpath, pst)
+    def upload_script(therealias, name, localpath, req_body)
       # Try PUT. If 404, then POST.
       # I.e., PUT if not exists, else POST to create.
       updated_at = nil
@@ -105,7 +106,7 @@ module MrMurano
       get_again = false
       create_it = false
 
-      put('/' + therealias, pst) do |request, http|
+      put('/' + therealias, req_body) do |request, http|
         response = http.request(request)
         isj, jsn = isJSON(response.body)
         # ORDER: An HTTPNoContent is also a HTTPSuccess, so the latter comes first.
@@ -131,7 +132,10 @@ module MrMurano
           create_it = true
         else
           relpath = localpath.sub(File.join(Dir.pwd, ''), '')
-          if response.is_a?(Net::HTTPBadRequest) && isj && jsn[:message] == 'Validation errors'
+          if (
+            response.is_a?(Net::HTTPBadRequest) &&
+            isj && jsn[:message] == 'Validation errors'
+          )
             warning "Validation errors detected in #{relpath}:"
             puts MrMurano::Pretties.makeJsonPretty(
               jsn[:errors], Struct.new(:pretty).new(true),
@@ -141,6 +145,7 @@ module MrMurano
           end
           warning "Failed to upload: #{relpath}"
         end
+        response
       end
       if get_again
         ret = get('/' + CGI.escape(name))
@@ -150,7 +155,7 @@ module MrMurano
           warning "Failed to verify updated_at: #{ret}"
         end
       end
-      post('/', pst) if create_it
+      post('/', req_body) if create_it
       cache_update_time_for(localpath, updated_at)
     end
 
@@ -285,12 +290,20 @@ module MrMurano
     class ModuleItem < Item
       # @return [String] Internal Alias name
       attr_accessor :alias
-      # @return [String] Timestamp when this was updated.
-      attr_accessor :updated_at
       # @return [String] Timestamp when this was created.
       attr_accessor :created_at
       # @return [String] The application solution's ID.
       attr_accessor :solution_id
+
+      def reject_ephemeral!
+        super.reject do |attr_key, _|
+          [
+            :alias,
+            :created_at,
+            :solution_id,
+          ].include? attr_key
+        end
+      end
     end
 
     def initialize(api_id=nil)
@@ -335,13 +348,14 @@ module MrMurano
       #   sort_by_name(ret[:items])
     end
 
-    def to_remote_item(root, path)
+    def to_remote_items(root, path)
       if $cfg['modules.no-nesting']
         name = path.basename.to_s.sub(/\..*/, '')
       else
         name = remote_item_nested_name(root, path)
       end
-      ModuleItem.new(name: name)
+      item = ModuleItem.new(name: name)
+      [item]
     end
 
     def remote_item_nested_name(root, path)
@@ -349,14 +363,16 @@ module MrMurano
       root = root.expand_path
       if path.basename.sub(/\.lua$/i, '').to_s.include?('.')
         warning(
-          "WARNING: Do not use periods in filenames. Rename: #{fancy_ticks(path.basename)}"
+          "WARNING: Do not use periods in filenames." +
+          " Rename: #{fancy_ticks(path.basename)}"
         )
       end
       path.dirname.ascend do |ancestor|
         break if ancestor == root
         if ancestor.basename.to_s.include?('.')
           warning(
-            "WARNING: Do not use periods in directory names. Rename: #{fancy_ticks(ancestor.basename)}"
+            "WARNING: Do not use periods in directory names." +
+            " Rename: #{fancy_ticks(ancestor.basename)}"
           )
         end
       end
@@ -401,6 +417,24 @@ module MrMurano
       attr_accessor :phantom
       # @return [Boolean] True if a service that should not be deleted remotely.
       attr_accessor :undeletable
+
+      def reject_ephemeral!
+        super.reject do |attr_key, attr_val|
+          [
+            # Server-siders:
+            #  :alias,
+            #  :service,
+            #  :event,
+            #  :type,
+            :updated_at,
+            :created_at,
+            :solution_id,
+            :svc_alias,
+            :phantom,
+            :undeletable,
+          ].include?(attr_key) || ((attr_key == :type) && (attr_val.nil?))
+        end
+      end
     end
 
     def initialize(api_id=nil)
@@ -413,13 +447,15 @@ module MrMurano
     end
 
     def mkalias(remote)
-      raise "Missing parts! #{remote.to_h.to_json}" if remote.service.nil? || remote.event.nil?
+      missing_parts = remote.service.nil? || remote.event.nil?
+      raise "Missing parts! #{remote.to_h.to_json}" if missing_parts
       #[$cfg[@solntype], remote[:service], remote[:event]].join('_')
       [@api_id, remote[:service], remote[:event]].join('_')
     end
 
     def mkname(remote)
-      raise "Missing parts! #{remote.to_h.to_json}" if remote.service.nil? || remote.event.nil?
+      missing_parts = remote.service.nil? || remote.event.nil?
+      raise "Missing parts! #{remote.to_h.to_json}" if missing_parts
       [remote[:service], remote[:event]].join('_')
     end
 
@@ -449,10 +485,18 @@ module MrMurano
       # Substitute '{product.id}' for the actual product.id if a corresponding
       # local file does not exist, or if the local file already uses the alias.
       encode_items = {}
+      build_svc_alias_map_from_local(encode_items, local)
+      resolve_name_svc_alias!(encode_items, there)
+    end
+
+    def build_svc_alias_map_from_local(encode_items, local)
       local.each do |item|
         encode_items[item.service] = {} if encode_items[item.service].nil?
         encode_items[item.service][item.event] = item.svc_alias
       end
+    end
+
+    def resolve_name_svc_alias!(encode_items, there)
       there.map! do |item|
         if (
           !encode_items[item.service].nil? &&
@@ -536,21 +580,20 @@ module MrMurano
       "#{item[:name]}.lua"
     end
 
-    def to_remote_item(from, path)
-      # This allows multiple events to be in the same file. This is a lie.
-      # This only finds the last event in a file.
-      # :legacy support doesn't allow for that. But that's ok.
-      path = Pathname.new(path) unless path.is_a?(Pathname)
+    def to_remote_items(from, path)
+      # Parses file which may contain multiple events. Return array of Items.
       items = []
       cur = nil
       lineno = 0
+      path = Pathname.new(path) unless path.is_a?(Pathname)
       path.readlines.each do |line|
         lineno += 1
         # @match_header finds a service and an event string, e.g., "--EVENT svc evt\n"
         md = @match_header.match(line)
         if !md.nil?
           cur[:line_end] = lineno - 1 unless cur.nil?
-          cur = to_remote_item_create(md, path, line, lineno)
+          header = line.strip
+          cur = to_remote_item_create(md, path, header, lineno)
           items << cur
         elsif !cur.nil? && !cur[:script].nil?
           cur[:script] += line
@@ -563,22 +606,23 @@ module MrMurano
       else
         # If cur is nil here, then we need to do a :legacy check.
         cur = to_remote_item_legacy_check(cur, path, from, lineno)
-        items << cur
+        items << cur unless cur.nil?
       end
 
       items
     end
 
-    def to_remote_item_create(md, path, line, lineno)
+    def to_remote_item_create(md, path, header, lineno)
       service, config_var = decode_config_var(md[:service])
       event_event, event_type = resolve_event_type(service, md[:event])
-      # Header line.
+      header = config_vars_decode(header)
       svc_alias = config_var if service != md[:service]
       EventHandlerItem.new(
-        # Skip: name, id, line_end, diff, selected, synckey, synctype, type,
-        # updated_at, dup_count, alias, updted_at, created_at, solution_id, phantom.
+        # Skipping: alias, updated_at, created_at, solution_id, phantom, undeletable
+        # name, id, line_end, diff, selected, synckey, synctype, updated_at, dup_count
         local_path: path,
-        script: line,
+        header: header,
+        script: '',
         line_beg: lineno,
         service: service,
         event: event_event,
@@ -751,9 +795,10 @@ module MrMurano
       undeletable.updated_at = nil
       # Even if the user deletes the contents of a script,
       # the platform still sends the magic header.
-      undeletable.script = (
-        "--#EVENT #{therebox[key].service} #{therebox[key].event}\n"
+      undeletable.header = (
+        "--#EVENT #{therebox[key].service} #{therebox[key].event}"
       )
+      undeletable.script = ''
       undeletable.local_path = Pathname.new(
         File.join(location, tolocalname(thereitem, key))
       )

data/lib/MrMurano/Solution-Users.rb

@@ -115,6 +115,7 @@ module MrMurano
 
       here.map! { |i| Hash.transform_keys_to_symbols(i) }
 
+      # (lb): FIXME?: To be like other localitems methods, should return Item list, not Hash.
       sort_by_name(here)
     end
   end

data/lib/MrMurano/SyncRoot.rb

@@ -57,9 +57,16 @@ module MrMurano
 
     ##
     # Remove all syncables.
-    def reset
-      @syncset = []
-      @synctypes = {}
+    def reset(syncsetypes=nil)
+      new_syncsetypes = [@syncset, @synctypes]
+      if syncsetypes.nil?
+        @syncset = []
+        @synctypes = {}
+      else
+        @syncset = syncsetypes[0]
+        @synctypes = syncsetypes[1]
+      end
+      new_syncsetypes
     end
 
     ##

data/lib/MrMurano/SyncUpDown-Core.rb

@@ -51,21 +51,28 @@ module MrMurano
       tomod = dt[:tomod]
 
       itemkey = @itemkey.to_sym
-      todel.each do |item|
+
+      todel.reject { |item| item[:phantom] }.each do |item|
         syncup_item(item, options, :delete, 'Removing') do |aitem|
-          remove_lite(aitem[itemkey], aitem.reject { |k, _v| k == :local_path }, true)
+          remove(aitem[itemkey])
+          num_synced += 1
+        end
+      end
+      todel.select { |item| item[:phantom] }.each do |item|
+        syncup_item(item, options, :delete, 'Clearing') do |aitem|
+          remove_or_clear(aitem[itemkey], aitem.reject_ephemeral!, true)
           num_synced += 1
         end
       end
       toadd.each do |item|
         syncup_item(item, options, :create, 'Adding') do |aitem|
-          upload(aitem[:local_path], aitem.reject { |k, _v| k == :local_path }, false)
+          upload(aitem[:local_path], aitem.reject_ephemeral!, false)
           num_synced += 1
         end
       end
       tomod.each do |item|
         syncup_item(item, options, :update, 'Updating') do |aitem|
-          upload(aitem[:local_path], aitem.reject { |k, _v| k == :local_path }, true)
+          upload(aitem[:local_path], aitem.reject_ephemeral!, true)
           num_synced += 1
         end
       end
@@ -163,7 +170,7 @@ module MrMurano
     def dodiff(merged, local, _there=nil, options={})
       localname = dodiff_resolve_localname(merged)
       trmt, tlcl = dodiff_tempfile_paths(localname)
-      dodiff_header_aware(merged, trmt, tlcl, options)
+      dodiff_header_aware(merged, local, trmt, tlcl, options)
     end
 
     def dodiff_resolve_localname(merged)
@@ -186,10 +193,10 @@ module MrMurano
       raise
     end
 
-    def dodiff_header_aware(merged, trmt, tlcl, options)
+    def dodiff_header_aware(merged, local, trmt, tlcl, options)
       dodiff_download_remote(merged, trmt, options)
       MrMurano::Verbose.whirly_stop
-      dodiff_prepare_local_and_diff(merged, trmt, tlcl, options)
+      dodiff_prepare_local_and_diff(merged, local, trmt, tlcl, options)
     ensure
       trmt.close
       trmt.unlink
@@ -202,13 +209,9 @@ module MrMurano
       diff_download(tmp_path, merged, options)
     end
 
-    def dodiff_prepare_local_and_diff(merged, trmt, tlcl, options)
+    def dodiff_prepare_local_and_diff(merged, local, trmt, tlcl, options)
       cmd = dodiff_build_cmd(trmt, tlcl, options)
-      merged[:exclude_header] = true
-      outp = dodiff_flexible(merged, tlcl, local, cmd, use_header=false)
-      return outp if outp.to_s.empty? || !merged.key?(:script)
-      merged[:exclude_header] = false
-      dodiff_diff_dynamic(merged, tlcl, local, cmd, use_header=true)
+      dodiff_flexible(merged, local, tlcl, cmd, use_header: true)
     end
 
     def dodiff_build_cmd(trmt, tlcl, options)
@@ -232,18 +235,22 @@ module MrMurano
       cmd
     end
 
-    def dodiff_flexible(merged, tlcl, local, cmd, use_header)
-      dodiff_local_to_tempfile(merged, tlcl, local, use_header)
+    def dodiff_flexible(merged, local, tlcl, cmd, use_header: true)
+      dodiff_local_to_tempfile(merged, local, tlcl, use_header: use_header)
       dodiff_do_diff(cmd)
     end
 
-    def dodiff_local_to_tempfile(merged, tlcl, local, use_header)
+    def dodiff_local_to_tempfile(merged, local, tlcl, use_header: true)
       Pathname.new(tlcl.path).open('wb') do |io|
         # Copy the local file to a temp file, for the diff command.
         # And for resources, remove the local-only :selected key, as
         # it's not part of the remote item that gets downloaded next.
         if merged.key?(:script)
-          io << config_vars_decode(merged[:header]) if use_header
+          if use_header && !merged[:header].to_s.empty?
+            io << config_vars_decode(merged[:header])
+            # Add newline after the :header.
+            io.puts
+          end
           io << config_vars_decode(merged[:script])
         else
           # For most items, read the local file.
@@ -379,17 +386,7 @@ module MrMurano
 
       items_cull_clashes!(statuses)
 
-      # 2018-04-24: (lb): How did I not see this til now? :unselected is :notimplemented.
-      unless options[:unselected]
-        statuses.each do |bucket, items|
-          select_selected(items)
-          next unless $cfg['tool.debug']
-          loci = items.map { |item| item.location_friendly(full_path: true) }
-          selected_paths = loci.sort.join("\n  ")
-          selected_paths = (selected_paths.empty? && ' <none>' || "\n  ") + selected_paths
-          debug %(#{self.class}: Selected #{bucket} items:#{selected_paths})
-        end
-      end
+      item_select_selected!(statuses, options)
 
       statuses
     end
@@ -631,14 +628,6 @@ module MrMurano
       end
     end
 
-    def select_selected(items)
-      items.select! { |item| item[:selected] }
-      items.map do |item|
-        item.delete(:selected)
-        item
-      end
-    end
-
     def items_cull_clashes!(statuses)
       clash = []
       statuses.each_value do |items|
@@ -656,6 +645,28 @@ module MrMurano
       end
       statuses[:clash] = clash
     end
+
+    def item_select_selected!(statuses, options)
+      # (lb): :unselected is currently only used by tests.
+      return if options[:unselected]
+      statuses.each do |bucket, items|
+        select_selected!(items)
+        debug_selected(bucket, items)
+      end
+    end
+
+    def select_selected!(items)
+      items.select! { |item| item[:selected] }
+      items.map { |item| item.delete(:selected) }
+    end
+
+    def debug_selected(bucket, items)
+      return unless $cfg['tool.debug']
+      loci = items.map { |item| item.location_friendly(full_path: true) }
+      selected_paths = loci.sort.join("\n  ")
+      selected_paths = (selected_paths.empty? && ' <none>' || "\n  ") + selected_paths
+      debug %(#{self.class}: Selected #{bucket} items:#{selected_paths})
+    end
   end
 end