ruby-paloalto-client 0.0.1

data/spec/lib/palo-alto/models/device_spec.rb

@@ -0,0 +1,43 @@
+require "palo-alto/models/device"
+
+describe "PaloAlto::Models::Device" do
+  let(:name)            { "test-device" }
+  let(:ip)              { "2.2.2.2" }
+  let(:virtual_systems) { [ "a", "b" ] }
+
+  before do
+    @device = PaloAlto::Models::Device.new(name:            name,
+                                           ip:              ip,
+                                           virtual_systems: virtual_systems)
+  end
+
+  it "has a name attribute" do
+    expect(@device).to respond_to(:name)
+  end
+
+  it "has an ip attribute" do
+    expect(@device).to respond_to(:ip)
+  end
+
+  it "has a virtual_systems attribute" do
+    expect(@device).to respond_to(:virtual_systems)
+  end
+
+  describe ".initialize" do
+    it "returns a PaloAlto::Models::Device instance" do
+      expect(@device).to be_instance_of(PaloAlto::Models::Device)
+    end
+
+    it "assigns name" do
+      expect(@device.name).to eq(name)
+    end
+
+    it "assigns ip" do
+      expect(@device.ip).to eq(ip)
+    end
+
+    it "assigns virtual_systems" do
+      expect(@device.virtual_systems).to eq(virtual_systems)
+    end
+  end
+end

data/spec/lib/palo-alto/models/rulebase_spec.rb

@@ -0,0 +1,23 @@
+require "palo-alto/models/rulebase"
+
+describe "PaloAlto::Models::Rulebase" do
+  let(:name) { "test-rulebase" }
+
+  before do
+    @rulebase = PaloAlto::Models::Rulebase.new(name: name)
+  end
+
+  it "has a name attribute" do
+    expect(@rulebase).to respond_to(:name)
+  end
+
+  describe ".initialize" do
+    it "returns a PaloAlto::Models::Rulebase instance" do
+      expect(@rulebase).to be_instance_of(PaloAlto::Models::Rulebase)
+    end
+
+    it "assigns name" do
+      expect(@rulebase.name).to eq(name)
+    end
+  end
+end

data/spec/lib/palo-alto/models/virtual_system_spec.rb

@@ -0,0 +1,53 @@
+require "palo-alto/models/virtual-system"
+
+describe "PaloAlto::Models::VirtualSystem" do
+  let(:name)           { "vsys-1" }
+  let(:addresses)      { [ "a", "b" ] }
+  let(:address_groups) { [ "c", "d" ] }
+  let(:rulebases)      { [ "e", "f" ] }
+
+  before do
+    @virtual_system = PaloAlto::Models::VirtualSystem.new(name:           name,
+                                                          addresses:      addresses,
+                                                          address_groups: address_groups,
+                                                          rulebases:      rulebases)
+  end
+
+  it "has a name attribute" do
+    expect(@virtual_system).to respond_to(:name)
+  end
+
+  it "has an addresses attribute" do
+    expect(@virtual_system).to respond_to(:addresses)
+  end
+
+  it "has an address_groups attribute" do
+    expect(@virtual_system).to respond_to(:address_groups)
+  end
+
+  it "has a rulebases attribute" do
+    expect(@virtual_system).to respond_to(:rulebases)
+  end
+
+  describe ".initialize" do
+    it "returns a PaloAlto::Models::VirtualSystem instance" do
+      expect(@virtual_system).to be_instance_of(PaloAlto::Models::VirtualSystem)
+    end
+
+    it "assigns name" do
+      expect(@virtual_system.name).to eq(name)
+    end
+
+    it "assigns addresses" do
+      expect(@virtual_system.addresses).to eq(addresses)
+    end
+
+    it "assigns address_groups" do
+      expect(@virtual_system.address_groups).to eq(address_groups)
+    end
+
+    it "assigns rulebases" do
+      expect(@virtual_system.rulebases).to eq(rulebases)
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require "palo-alto/v6/address-api"
+require "palo-alto/helpers/rest"
+
+describe "PaloAlto::V6::AddressApi" do
+  # dummy class to demonstrate functionality
+  class DummyClass
+    extend PaloAlto::V6::AddressApi
+
+    def self.endpoint
+      "https://some.host:80/api/"
+    end
+
+    def self.auth_key
+      "OIGHOEIHT()*#Y"
+    end
+  end
+
+  describe ".addresses" do
+    let(:address_xml)       { File.open(fixture_file("addresses.xml")).read }
+    let(:blank_address_xml) { File.open(fixture_file("blank_addresses.xml")).read }
+
+    describe "when addresses exist" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(address_xml)
+      end
+
+      it "parses the XML response into the required format" do
+        expect(DummyClass.addresses).to be_instance_of(Array)
+      end
+    end
+
+    describe "when no addresses exist" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(blank_address_xml)
+      end
+
+      it "returns an empty array" do
+        expect(DummyClass.addresses).to eq([])
+      end
+    end
+
+    describe "when errors occur" do
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_raise(Exception)
+        expect{ DummyClass.addresses }.to raise_exception
+      end
+
+      it "raises an exception if an error occurred reported in the XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(File.open(fixture_file("failure.xml")).read)
+        expect{ DummyClass.addresses }.to raise_exception
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+require "palo-alto/v6/address-group-api"
+require "palo-alto/helpers/rest"
+require "palo-alto/models/address"
+require "palo-alto/models/address-group"
+require "nokogiri"
+
+describe "PaloAlto::V6::AddressGroupApi" do
+  # dummy class to demonstrate functionality
+  class DummyClass
+    extend PaloAlto::V6::AddressGroupApi
+
+    def self.endpoint
+      "https://some.host:80/api/"
+    end
+
+    def self.auth_key
+      "OIGHOEIHT()*#Y"
+    end
+  end
+
+  describe ".address_groups" do
+    let(:address_group_xml)           { File.open(fixture_file("address_groups.xml")).read }
+    let(:blank_address_group_xml)     { File.open(fixture_file("blank_address_groups.xml")).read }
+    let(:no_member_address_group_xml) { File.open(fixture_file("no_members_address_groups.xml")).read }
+
+    describe "when address groups exist" do
+      it "parses the XML response into the required format" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(address_group_xml)
+        @address_groups = DummyClass.address_groups
+
+        expect(@address_groups).to be_instance_of(Array)
+      end
+
+      describe "for groups that contain members" do
+        before do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(address_group_xml)
+          @address_groups = DummyClass.address_groups
+        end
+
+        it "returns a list of addresses" do
+          expect(@address_groups[0].addresses).to_not be_empty
+        end
+      end
+
+      describe "for groups that have no members" do
+        before do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(no_member_address_group_xml)
+          @address_groups = DummyClass.address_groups
+        end
+
+        it "returns an empty array" do
+          expect(@address_groups[0].addresses).to be_empty
+        end
+      end
+    end
+
+    describe "when no address groups exist" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(blank_address_group_xml)
+      end
+
+      it "returns an empty array" do
+        expect(DummyClass.address_groups).to eq([])
+      end
+    end
+
+    describe "when errors occur" do
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_raise(Exception)
+        expect{ DummyClass.address_groups }.to raise_exception
+      end
+
+      it "raises an exception if an error occurred reported in the XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(File.open(fixture_file("failure.xml")).read)
+        expect{ DummyClass.address_groups }.to raise_exception
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+require "palo-alto/v6/api"
+
+describe "PaloAlto::V6::Api" do
+end

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

@@ -0,0 +1,78 @@
+require "palo-alto/v6/device-api"
+require "palo-alto/helpers/rest"
+require "palo-alto/models/virtual-system"
+require "nokogiri"
+
+describe "PaloAlto::V6::DeviceApi" do
+  # dummy class to demonstrate functionality
+  class DummyClass
+    extend PaloAlto::V6::DeviceApi
+
+    def self.endpoint
+      "https://some.host:80/api/"
+    end
+
+    def self.auth_key
+      "OIGHOEIHT()*#Y"
+    end
+  end
+
+  describe ".devices" do
+    let(:device_xml)         { File.open(fixture_file("devices.xml")).read }
+    let(:blank_device_xml)   { File.open(fixture_file("blank_devices.xml")).read }
+    let(:no_vsys_device_xml) { File.open(fixture_file("no_vsys_devices.xml")).read }
+
+    describe "when devices exist" do
+      it "parses the XML response into the required format" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(device_xml)
+        @devices = DummyClass.devices
+
+        expect(@devices).to be_instance_of(Array)
+      end
+
+      describe "for devices that contain virtual_systems" do
+        before do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(device_xml)
+          @devices = DummyClass.devices
+        end
+
+        it "returns a list of virtual_systems" do
+          expect(@devices[0].virtual_systems).to_not be_empty
+        end
+      end
+
+      describe "for devices that have no virtual_systems" do
+        before do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(no_vsys_device_xml)
+          @devices = DummyClass.devices
+        end
+
+        it "returns an empty array" do
+          expect(@devices[0].virtual_systems).to be_empty
+        end
+      end
+    end
+
+    describe "when no devices exist" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(blank_device_xml)
+      end
+
+      it "returns an empty array" do
+        expect(DummyClass.devices).to eq([])
+      end
+    end
+
+    describe "when errors occur" do
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_raise(Exception)
+        expect{ DummyClass.devices }.to raise_exception
+      end
+
+      it "raises an exception if an error occurred reported in the XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(File.open(fixture_file("failure.xml")).read)
+        expect{ DummyClass.devices }.to raise_exception
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require "palo-alto/v6/virtual-system-api"
+require "palo-alto/helpers/rest"
+require "nokogiri"
+
+describe "PaloAlto::V6::VirtualSystemApi" do
+  # dummy class to demonstrate functionality
+  class DummyClass
+    extend PaloAlto::V6::VirtualSystemApi
+
+    def self.endpoint
+      "https://some.host:80/api/"
+    end
+
+    def self.auth_key
+      "OIGHOEIHT()*#Y"
+    end
+  end
+
+  describe ".virtual_systems" do
+    let(:virtual_system_xml)                  { File.open(fixture_file("virtual_systems.xml")).read }
+    let(:blank_virtual_system_xml)            { File.open(fixture_file("blank_virtual_systems.xml")).read }
+    let(:no_rulebase_virtual_system_xml)      { File.open(fixture_file("no_rulebase_virtual_systems.xml")).read }
+    let(:no_address_virtual_system_xml)       { File.open(fixture_file("no_address_virtual_systems.xml")).read }
+    let(:no_address_group_virtual_system_xml) { File.open(fixture_file("no_address_group_virtual_systems.xml")).read }
+
+    describe "when virtual systems exist" do
+      it "parses the XML response into the required format" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(virtual_system_xml)
+        @virtual_systems = DummyClass.virtual_systems
+
+        expect(@virtual_systems).to be_instance_of(Array)
+      end
+
+      it "returns an array of addresses, address_groups and virtual_systems" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(virtual_system_xml)
+        @virtual_systems = DummyClass.virtual_systems
+
+        expect(@virtual_systems[0].addresses).to_not be_empty
+        expect(@virtual_systems[0].address_groups).to_not be_empty
+        expect(@virtual_systems[0].rulebases).to_not be_empty
+      end
+
+      it "returns an empty array for addresses when none exist" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(no_address_virtual_system_xml)
+        @virtual_systems = DummyClass.virtual_systems
+        expect(@virtual_systems[0].addresses).to be_empty
+      end
+
+      it "returns an empty array for address_groups when none exist" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(no_address_group_virtual_system_xml)
+        @virtual_systems = DummyClass.virtual_systems
+        expect(@virtual_systems[0].address_groups).to be_empty
+      end
+
+      it "returns an empty array for rulebases when none exist" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(no_rulebase_virtual_system_xml)
+        @virtual_systems = DummyClass.virtual_systems
+        expect(@virtual_systems[0].rulebases).to be_empty
+      end
+
+      describe "address group addresses" do
+        it "associates addresses with the corresponding address group" do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(virtual_system_xml)
+          @virtual_systems = DummyClass.virtual_systems
+
+          expect(@virtual_systems[0].address_groups[0].addresses).to_not be_empty
+        end
+      end
+    end
+
+    describe "when no virtual systems exist" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(blank_virtual_system_xml)
+      end
+
+      it "returns an empty array" do
+        expect(DummyClass.virtual_systems).to eq([])
+      end
+    end
+
+    describe "when errors occur" do
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_raise(Exception)
+        expect{ DummyClass.virtual_systems }.to raise_exception
+      end
+
+      it "raises an exception if an error occurred reported in the XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(File.open(fixture_file("failure.xml")).read)
+        expect{ DummyClass.virtual_systems }.to raise_exception
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require "fakeweb"
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "/spec"
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end
+
+# define the root of the spec files
+unless defined?(SPEC_ROOT)
+  SPEC_ROOT = File.join(File.dirname(__FILE__))
+end
+
+# define an easy way to load fixture files (clean up code a bit)
+def fixture_file(*name)
+  File.join(SPEC_ROOT, 'fixtures', name)
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: ruby-paloalto-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Karimi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby-based client library to interact with the PaloAlto APIs.
+email:
+- jekhokie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/palo-alto/client.rb
+- lib/palo-alto/client/version.rb
+- lib/palo-alto/common/base-api.rb
+- lib/palo-alto/helpers/rest.rb
+- lib/palo-alto/models/address-group.rb
+- lib/palo-alto/models/address.rb
+- lib/palo-alto/models/device.rb
+- lib/palo-alto/models/rulebase.rb
+- lib/palo-alto/models/virtual-system.rb
+- lib/palo-alto/v6/address-api.rb
+- lib/palo-alto/v6/address-group-api.rb
+- lib/palo-alto/v6/api.rb
+- lib/palo-alto/v6/device-api.rb
+- lib/palo-alto/v6/virtual-system-api.rb
+- ruby-paloalto-client.gemspec
+- spec/fixtures/address_groups.xml
+- spec/fixtures/addresses.xml
+- spec/fixtures/blank_address_groups.xml
+- spec/fixtures/blank_addresses.xml
+- spec/fixtures/blank_devices.xml
+- spec/fixtures/blank_virtual_systems.xml
+- spec/fixtures/devices.xml
+- spec/fixtures/failure.xml
+- spec/fixtures/no_address_group_virtual_systems.xml
+- spec/fixtures/no_address_virtual_systems.xml
+- spec/fixtures/no_members_address_groups.xml
+- spec/fixtures/no_rulebase_virtual_systems.xml
+- spec/fixtures/no_vsys_devices.xml
+- spec/fixtures/virtual_systems.xml
+- spec/lib/palo-alto/client_spec.rb
+- spec/lib/palo-alto/common/base_api_spec.rb
+- spec/lib/palo-alto/helpers/rest_spec.rb
+- spec/lib/palo-alto/models/address_group_spec.rb
+- spec/lib/palo-alto/models/address_spec.rb
+- spec/lib/palo-alto/models/device_spec.rb
+- spec/lib/palo-alto/models/rulebase_spec.rb
+- spec/lib/palo-alto/models/virtual_system_spec.rb
+- spec/lib/palo-alto/v6/address_api_spec.rb
+- spec/lib/palo-alto/v6/address_group_api_spec.rb
+- spec/lib/palo-alto/v6/api_spec.rb
+- spec/lib/palo-alto/v6/device_api_spec.rb
+- spec/lib/palo-alto/v6/virtual_system_api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby PaloAlto Client (API V6.X)
+test_files:
+- spec/fixtures/address_groups.xml
+- spec/fixtures/addresses.xml
+- spec/fixtures/blank_address_groups.xml
+- spec/fixtures/blank_addresses.xml
+- spec/fixtures/blank_devices.xml
+- spec/fixtures/blank_virtual_systems.xml
+- spec/fixtures/devices.xml
+- spec/fixtures/failure.xml
+- spec/fixtures/no_address_group_virtual_systems.xml
+- spec/fixtures/no_address_virtual_systems.xml
+- spec/fixtures/no_members_address_groups.xml
+- spec/fixtures/no_rulebase_virtual_systems.xml
+- spec/fixtures/no_vsys_devices.xml
+- spec/fixtures/virtual_systems.xml
+- spec/lib/palo-alto/client_spec.rb
+- spec/lib/palo-alto/common/base_api_spec.rb
+- spec/lib/palo-alto/helpers/rest_spec.rb
+- spec/lib/palo-alto/models/address_group_spec.rb
+- spec/lib/palo-alto/models/address_spec.rb
+- spec/lib/palo-alto/models/device_spec.rb
+- spec/lib/palo-alto/models/rulebase_spec.rb
+- spec/lib/palo-alto/models/virtual_system_spec.rb
+- spec/lib/palo-alto/v6/address_api_spec.rb
+- spec/lib/palo-alto/v6/address_group_api_spec.rb
+- spec/lib/palo-alto/v6/api_spec.rb
+- spec/lib/palo-alto/v6/device_api_spec.rb
+- spec/lib/palo-alto/v6/virtual_system_api_spec.rb
+- spec/spec_helper.rb