palo_alto 0.1.8 → 0.1.9

data/lib/palo_alto/op.rb

@@ -1,58 +1,90 @@
-require "nokogiri"
+# frozen_string_literal: true
+
+require 'nokogiri'
 
 module PaloAlto
   class XML
-
     def op
       Op.new
     end
 
     class Op
-      def execute(obj, additional_payload = {})
+      def execute(cmd, type: nil, location: nil, additional_payload: {})
+        payload = build_payload(cmd).merge(additional_payload)
+
+        if type == 'tpl'
+          run_with_template_scope(location) { XML.execute(payload) }
+        elsif type == 'dg'
+          XML.execute(payload.merge({ vsys: location }))
+        elsif !type || type == 'shared'
+          XML.execute(payload)
+        else
+          raise(ArgumentError, "invalid type: #{type.inspect}")
+        end
+      end
+
+      def run_with_template_scope(name)
+        if block_given?
+          run_with_template_scope(name)
+          begin
+            return yield
+          ensure
+            run_with_template_scope(nil)
+          end
+        end
+
+        cmd = if name
+                { set: { system: { setting: { target: { template: { name: name } } } } } }
+              else
+                { set: { system: { setting: { target: 'none' } } } }
+              end
+
+        execute(cmd)
+      end
 
+      def build_payload(obj)
         cmd = to_xml(obj)
 
-        if obj=='commit' || obj.keys.first.to_sym == :commit
-          type='commit'
-          action='panorama'
-        elsif obj=='commit-all' || obj.keys.first.to_sym == :'commit-all'
-          type='commit'
-          action='all'
+        if obj == 'commit' || obj.keys.first.to_sym == :commit
+          type = 'commit'
+          action = 'panorama'
+        elsif obj == 'commit-all' || obj.keys.first.to_sym == :'commit-all'
+          type = 'commit'
+          action = 'all'
         else
-          type='op'
-          action='panorama'
+          type = 'op'
+          action = 'panorama'
         end
 
-        payload = {
-          type:   type,
+        {
+          type: type,
           action: action,
-          cmd:   cmd
-        }.merge(additional_payload)
-
-        XML.execute(payload)
+          cmd: cmd
+        }
       end
 
       def escape_xpath_tag(tag)
         if tag.to_s.include?('-') # https://stackoverflow.com/questions/48628259/nokogiri-how-to-name-a-node-comment
           tag
         else
-          tag.to_s + "_"
+          "#{tag}_"
         end
       end
 
       def xml_builder(xml, ops, obj)
-        if obj.is_a?(String)
+        case obj
+        when String
           section = obj
           data = nil
-        elsif obj.is_a?(Hash)
+        when Hash
           section = obj.keys.first
           data = obj[section]
         else
           raise obj.pretty_inspect
         end
 
-        unless ops.has_key?(section.to_s)
-          err = "Error #{section.to_s} does not exist. Valid: " + ops.keys.pretty_inspect
+        unless ops.key?(section.to_s)
+          err = "Error #{section} does not exist. Valid: " + ops.keys.pretty_inspect
           raise err
         end
 
@@ -64,50 +96,49 @@ module PaloAlto
         when :element
           xml.public_send(section, data)
         when :array
-          xml.public_send(section) {
-            data.each{|el|
+          xml.public_send(section) do
+            data.each do |el|
               key = ops_tree.keys.first
               xml.public_send(escape_xpath_tag(key), el)
-            }
-          }
+            end
+          end
         when :sequence
-          if data==nil
+          if data.nil?
             xml.send(section)
           elsif data.is_a?(Hash)
-            xml.send(section){
+            xml.send(section)  do
               xml_builder(xml, ops_tree, data)
-            }
+            end
           else # array
 
             if data.is_a?(Array)
-              attr = data.find { |child| child.is_a?(Hash) && ops_tree[child.keys.first.to_s][:obj]==:'attr-req' }
+              attr = data.find { |child| child.is_a?(Hash) && ops_tree[child.keys.first.to_s][:obj] == :'attr-req' }
               data.delete(attr)
             else
               attr = {}
             end
 
-            xml.public_send(section, attr){
-              data.each{|child|
+            xml.public_send(section, attr) do
+              data.each do |child|
                 xml_builder(xml, ops_tree, child)
-              }
-            }
+              end
+            end
           end
         when :union
-          k,v=obj.first
-          xml.send("#{k}_"){
+          k, v = obj.first
+          xml.send("#{k}_")  do
             xml_builder(xml, ops_tree, v)
-          }
+          end
         else
           raise ops_tree[:obj].pretty_inspect
         end
         xml
       end
 
-
       def to_xml(obj)
-        builder = Nokogiri::XML::Builder.new{|xml|
+        builder = Nokogiri::XML::Builder.new do |xml|
           xml_builder(xml, @@ops, obj)
-        }
+        end
         builder.doc.root.to_xml
       end
 @@ops={"schedule"=>

data/lib/palo_alto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaloAlto
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

data/lib/palo_alto.rb

@@ -263,18 +263,6 @@ module PaloAlto
       end
     end
 
-    def execute_with_type(cmd, type:, location:)
-      if type == 'tpl'
-        run_with_template_scope(location) { Op.new.execute(cmd) }
-      elsif type == 'dg'
-        Op.new.execute(cmd, { vsys: location })
-      elsif !type || type == 'shared'
-        Op.new.execute(cmd)
-      else
-        raise(ArgumentError, "invalid type: #{type.inspect}")
-      end
-    end
-
     # will execute block if given and unlock afterwards. returns false if lock could not be aquired
     def lock(area:, comment: nil, type: nil, location: nil)
       if block_given?
@@ -291,7 +279,7 @@ module PaloAlto
 
       begin
         cmd = { request: { "#{area}-lock": { add: { comment: comment || '(null)' } } } }
-        execute_with_type(cmd, type: type, location: location)
+        Op.new.execute(cmd, type: type, location: location)
         true
       rescue PaloAlto::InternalErrorException
         false
@@ -305,7 +293,7 @@ module PaloAlto
               else
                 { request: { "#{area}-lock": 'remove' } }
               end
-        execute_with_type(cmd, type: type, location: location)
+        Op.new.execute(cmd, type: type, location: location)
       rescue PaloAlto::InternalErrorException
         return false
       end
@@ -315,30 +303,11 @@ module PaloAlto
     def remove_all_locks
       %w[config commit].each do |area|
         show_locks(area: area).each do |lock|
-          unlock(area: area, type: lock[:type], location: lock[:location], name: area=='commit' ? lock[:name] : nil )
+          unlock(area: area, type: lock[:type], location: lock[:location], name: area == 'commit' ? lock[:name] : nil)
         end
       end
     end
 
-    def run_with_template_scope(name)
-      if block_given?
-        run_with_template_scope(name)
-        begin
-          return yield
-        ensure
-          run_with_template_scope(nil)
-        end
-      end
-
-      cmd = if name
-              { set: { system: { setting: { target: { template: { name: name } } } } } }
-            else
-              { set: { system: { setting: { target: 'none' } } } }
-            end
-
-      Op.new.execute(cmd)
-    end
-
     def check_for_changes(usernames: [XML.username])
       result = Op.new.execute({ show: { config: { list: { 'change-summary': { partial: { admin: usernames } } } } } })
       result.xpath('response/result/summary/device-group/member').map(&:inner_text)
@@ -349,7 +318,8 @@ module PaloAlto
       start = Time.now
       loop do
         result = Op.new.execute(cmd)
-        return result unless result.at_xpath('response/result/job/status')&.text == 'ACT'
+        status = result.at_xpath('response/result/job/status')&.text
+        return result unless %w[ACT PEND].include?(status)
 
         sleep wait
         break unless start + timeout > Time.now

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palo_alto
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Sebastian Roesner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock