ruby-paloalto-client 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02a369bdffd33aae3c9e09ed5c7c12144085507
-  data.tar.gz: ef555e5807be0c37aff0141bbf8b9ad0543d83a1
+  metadata.gz: 17a2840f834cb5377d8a8b63cb21c4b6cd28afeb
+  data.tar.gz: a76992e8ba1c4931c0fe9dcc86986c334e052222
 SHA512:
-  metadata.gz: 5813efa8c094d8f3e5f3f84ed002163bffa23b57b3ac594560875ad5fe2678895ad5289049754de220855b3e7d07c19f6ee515f2dd8e76cb074f496d8e5e5b54
-  data.tar.gz: ee5e1550103d91610627bd32e7e8cd8c139e8731af6e91b4d6927b015fe4a5b29d02e223b2def1acc5fe426d3da71e39dbe74288f274cb42248314d2832db9a3
+  metadata.gz: 36ce78b3ac071f0296750d4c9cc24fd6455a36fc5505896a0375f14529c3b26d4631fa545b3c2bf88eb86dcf31f4591a546de8873ff3bfb34022af76e48aedec
+  data.tar.gz: ec5fb27f26375f00fda3d9cb708dd356922c83f2d19ca83611dd2396e6119fe0d90df3be9b482d19f70d9f215e350c6249a75ee26ff50763bbfdf571b0f84aa1

data/lib/palo_alto/client/version.rb

@@ -1,5 +1,5 @@
 module PaloAlto
   module Client
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/lib/palo_alto/v6/api.rb

@@ -6,6 +6,7 @@ require "palo_alto/v6/log_api"
 require "palo_alto/v6/security_rule_api"
 require "palo_alto/v6/commit_api"
 require "palo_alto/v6/zone_api"
+require "palo_alto/v6/job_api"
 
 module PaloAlto
   module V6
@@ -19,6 +20,7 @@ module PaloAlto
       include PaloAlto::V6::SecurityRuleApi
       include PaloAlto::V6::CommitApi
       include PaloAlto::V6::ZoneApi
+      include PaloAlto::V6::JobApi
     end
   end
 end

data/lib/palo_alto/v6/job_api.rb

@@ -0,0 +1,38 @@
+require "crack/xml"
+
+module PaloAlto
+  module V6
+    module JobApi
+      # Get information about a particular operational
+      #
+      # == Parameters
+      #
+      #  * +job_id+ - ID of the job to query for
+      #
+      # == Returns
+      #
+      #  * +JSON+ - JSON data containing the job ID and corresponding status
+      #
+      # == Raises
+      #
+      #  * +Exception+ - Raises an exception if the request is unsuccessful
+      def operational_job(job_id:)
+        job_json = { id: job_id }
+
+        # configure options for the request
+        options = {}
+        options[:url]     = self.endpoint
+        options[:method]  = :post
+        options[:payload] = { :type       => "op",
+                              :cmd        => "<show><jobs><id>#{job_id}</id></jobs></show>",
+                              :key        => self.auth_key }
+
+        html_result = Helpers::Rest.make_request(options)
+
+        raise "Error obtaining log job XML" if html_result.nil?
+
+        return Crack::XML.parse(html_result)
+      end
+    end
+  end
+end

data/spec/fixtures/job.xml

@@ -0,0 +1,19 @@
+<response status="success">
+  <result>
+    <job>
+      <tenq>2015/07/27 11:13:31</tenq>
+      <id>94</id>
+      <user>testuser</user>
+      <type>Commit</type>
+      <status>FIN</status>
+      <stoppable>no</stoppable>
+      <result>OK</result>
+      <tfin>11:14:36</tfin>
+      <progress>11:14:36</progress>
+      <details>
+        <line>Configuration committed successfully</line>
+      </details>
+      <warnings/>
+    </job>
+  </result>
+</response>

data/spec/fixtures/job_not_found.xml

@@ -0,0 +1,5 @@
+<response status="error">
+  <msg>
+    <line>job 4 not found</line>
+  </msg>
+</response>

data/spec/lib/palo-alto/v6/job_api_spec.rb

@@ -0,0 +1,43 @@
+require "palo_alto/v6/job_api"
+require "palo_alto/helpers/rest"
+require "nokogiri"
+
+describe "PaloAlto::V6::JobApi" do
+  # dummy class to demonstrate functionality
+  class DummyClass
+    extend PaloAlto::V6::JobApi
+
+    def self.endpoint
+      "https://some.host:80/api/"
+    end
+
+    def self.auth_key
+      "OIGHOEIHT()*#Y"
+    end
+  end
+
+  describe ".job(id)" do
+    let(:job_id)            { "4" }
+    let(:job_xml)           { File.open(fixture_file("job.xml")).read }
+    let(:job_not_found_xml) { File.open(fixture_file("job_not_found.xml")).read }
+
+    describe "when the job exists" do
+      it "parses the XML response into the required format" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(job_xml)
+        job_info = DummyClass.operational_job(job_id: job_id)
+
+        expect(job_info["response"]["result"]["job"]["status"]).to eq("FIN")
+      end
+    end
+
+    describe "when the job does not exist" do
+      it "returns XML indicating no job exists" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(job_not_found_xml)
+        job_info = DummyClass.operational_job(job_id: job_id)
+
+        expect(job_info["response"]["status"]).to eq("error")
+        expect(job_info["response"]["msg"]["line"]).to eq("job #{job_id} not found")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-paloalto-client
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Justin Karimi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crack
@@ -155,6 +155,7 @@ files:
 - lib/palo_alto/v6/api.rb
 - lib/palo_alto/v6/commit_api.rb
 - lib/palo_alto/v6/device_api.rb
+- lib/palo_alto/v6/job_api.rb
 - lib/palo_alto/v6/log_api.rb
 - lib/palo_alto/v6/security_rule_api.rb
 - lib/palo_alto/v6/virtual_system_api.rb
@@ -173,6 +174,8 @@ files:
 - spec/fixtures/commit_in_progress.xml
 - spec/fixtures/devices.xml
 - spec/fixtures/failure.xml
+- spec/fixtures/job.xml
+- spec/fixtures/job_not_found.xml
 - spec/fixtures/log_complete.xml
 - spec/fixtures/log_in_progress.xml
 - spec/fixtures/log_job.xml
@@ -209,6 +212,7 @@ files:
 - spec/lib/palo-alto/v6/api_spec.rb
 - spec/lib/palo-alto/v6/commit_api_spec.rb
 - spec/lib/palo-alto/v6/device_api_spec.rb
+- spec/lib/palo-alto/v6/job_api_spec.rb
 - spec/lib/palo-alto/v6/log_api_spec.rb
 - spec/lib/palo-alto/v6/security_rule_api_spec.rb
 - spec/lib/palo-alto/v6/virtual_system_api_spec.rb
@@ -252,6 +256,8 @@ test_files:
 - spec/fixtures/commit_in_progress.xml
 - spec/fixtures/devices.xml
 - spec/fixtures/failure.xml
+- spec/fixtures/job.xml
+- spec/fixtures/job_not_found.xml
 - spec/fixtures/log_complete.xml
 - spec/fixtures/log_in_progress.xml
 - spec/fixtures/log_job.xml
@@ -288,6 +294,7 @@ test_files:
 - spec/lib/palo-alto/v6/api_spec.rb
 - spec/lib/palo-alto/v6/commit_api_spec.rb
 - spec/lib/palo-alto/v6/device_api_spec.rb
+- spec/lib/palo-alto/v6/job_api_spec.rb
 - spec/lib/palo-alto/v6/log_api_spec.rb
 - spec/lib/palo-alto/v6/security_rule_api_spec.rb
 - spec/lib/palo-alto/v6/virtual_system_api_spec.rb