ultravault 1.0.2.0 → 1.2.0

data/lib/ultravault.rb

@@ -13,5 +13,7 @@ module UltraVault
   autoload :RecoveryPoint,        "ultravault/data_objects/recovery_point" 
   autoload :RecoveryPointService, "ultravault/soap_service/recovery_point_service" 
   autoload :SoapService,          "ultravault/soap_service"
+  autoload :Policy,               "ultravault/data_objects/policy"
+  autoload :PolicyService,        "ultravault/soap_service/policy_service"
   
-end
+end

data/lib/ultravault/data_objects/agent.rb

@@ -16,7 +16,11 @@ module UltraVault
     # @return [[UltraVault::DiskSafe]] disk safes for this agent
     # @raise [Savon::SOAP::Fault] errors from the soap transaction    
     def disk_safes
-      @disk_safes ||= UltraVault::DiskSafe.find_all_by_agent_id(id)
+      if UltraVault.config.api_version > 1
+        @disk_safes ||= UltraVault::DiskSafe.all.map { |disk_safe| disk_safe if disk_safe.agent_id == id }.compact
+      else
+        @disk_safes ||= UltraVault::DiskSafe.find_all_by_agent_id(id)
+      end
     end
     
     # Returns an agent, if found.
@@ -101,4 +105,4 @@ module UltraVault
     end
     
   end
-end
+end

data/lib/ultravault/data_objects/disk_safe.rb

@@ -11,8 +11,8 @@ module UltraVault
       @compression_type = params[:compression_type]
       @description = params[:description]
       @device_count = params[:device_count].to_i
-      @device_list = [params[:device_list]].flatten.collect do |device| 
-        DeviceList.new(device)
+      @device_list = [params[:device_list]].flatten.collect do |device|
+        DeviceList.new(device) if device
       end
       @id = params[:id]      
       @open = params[:open]                        
@@ -21,11 +21,16 @@ module UltraVault
       @size_of_deltas = params[:size_of_deltas_in_disk_safe].to_i
       @volume_id = params[:volume_id]
       extract_attributes params[:disk_safe_attribute_map]
+      super(params)
     end
     
     def recovery_points
       @recovery_points ||= UltraVault::RecoveryPointService.new.find_recovery_points_by_disk_safe_id(id)
     end
+
+    def policies
+      @policies ||= UltraVault::Policy.all.map { |policy| policy if policy.disk_safe_id == id }.compact
+    end
     
     # Returns an array of disk safes, if found.
     # 
@@ -34,7 +39,15 @@ module UltraVault
     # @raise [Savon::SOAP::Fault] errors from the soap transaction
     def self.find_all_by_agent_id(agent_id)
       UltraVault::DiskSafeService.new.find_disksafes_by_agent_id agent_id
-    end                      
+    end  
+
+    # Returns all disk safes for the current user.
+    # 
+    # @return [[UltraVault::DiskSafe]] current user's disk safes
+    # @raise [Savon::SOAP::Fault] errors from the soap transaction    
+    def self.all
+      UltraVault::DiskSafeService.new.all_disk_safes
+    end
   
   private
   
@@ -61,4 +74,4 @@ module UltraVault
       
     end
   end
-end
+end

data/lib/ultravault/data_objects/policy.rb

@@ -0,0 +1,22 @@
+module UltraVault
+  class Policy < OpenStruct
+
+    # Returns an agent, if found.
+    # 
+    # @param [String] policy_id the UUID of the policy 
+    # @return [UltraVault::Policy] the policy matching the policy_id
+    # @raise [Savon::SOAP::Fault] errors from the soap transaction
+    def self.find_by_id(policy_id)
+      UltraVault::PolicyService.new.find_policy_by_id(policy_id)
+    end
+
+    # Returns all policies for the current user.
+    # 
+    # @return [[UltraVault::Policy]] current user's policies
+    # @raise [Savon::SOAP::Fault] errors from the soap transaction    
+    def self.all
+      UltraVault::PolicyService.new.all_policies
+    end
+    
+  end
+end

data/lib/ultravault/soap_service/disk_safe_service.rb

@@ -14,5 +14,14 @@ module UltraVault
         UltraVault::DiskSafe.new(disk_safe)
       end
     end
+    
+    def all_disk_safes
+      response_hash = client.request(:getDiskSafes).to_hash
+      params = extract_params_array(response_hash,
+        :get_disk_safes_response)
+      params.collect do |disk_safe|
+        UltraVault::DiskSafe.new(disk_safe)
+      end
+    end
   end
-end
+end

data/lib/ultravault/soap_service/policy_service.rb

@@ -0,0 +1,24 @@
+module UltraVault
+  # @private  
+  class PolicyService < UltraVault::SoapService
+
+    def initialize
+      super(:Policy)
+    end
+    
+    def find_policy_by_id(policy_id)
+      response_hash = client.request(:getPolicyById, :id => policy_id).to_hash
+      params = extract_params(response_hash, :get_policy_by_id_response)
+      UltraVault::Policy.new(params)
+    end
+    
+    def all_policies
+      response_hash = client.request(:getPolicies).to_hash
+      params = extract_params_array(response_hash,
+        :get_policies_response)
+      params.collect do |policy|
+        UltraVault::Policy.new(policy)
+      end
+    end
+  end
+end

data/test/support/fixtures.rb

@@ -1,4 +1,5 @@
 require_relative 'fixtures/agent_service'
 require_relative 'fixtures/disk_safe'
 require_relative 'fixtures/disk_safe_service'
-require_relative 'fixtures/recovery_point_service'
+require_relative 'fixtures/recovery_point_service'
+require_relative 'fixtures/policy_service'

data/test/support/fixtures/policy_service.rb

@@ -0,0 +1,58 @@
+module UltraVault
+  module Fixtures
+    def load_policy_service_fixtures
+      @policy_by_id =   { :description=>nil,
+                          :disk_safe_id=>"d1da6e8c-392f-4918-b780-6e5a5d62dd39",
+                          :enabled=>true,
+                          :force_full_block_scan=>false,
+                          :frequency_type=>"DAILY",
+                          :frequency_values=>{:hours_of_day=>"4", :starting_minute=>"0"},
+                          :id=>"04071ece-4129-4623-b008-05d9b9a67a32",
+                          :name=>"melbourne-kickstart",
+                          :recovery_point_limit=>"10",
+                          :state=>"OK"
+                      }
+      
+      @policy_by_id_wrapper = {
+                    :get_policy_by_id_response=>
+                     {
+                       :return=> @policy_by_id,
+                       :"@xmlns:ns1"=>"http://policy.api.server.backup.r1soft.com/"
+                     }
+                   }
+
+      @all_policies = [
+                      {   :description=>nil,
+                          :disk_safe_id=>"d1da6e8c-392f-4918-b780-6e5a5d62dd39",
+                          :enabled=>true,
+                          :force_full_block_scan=>false,
+                          :frequency_type=>"DAILY",
+                          :frequency_values=>{:hours_of_day=>"4", :starting_minute=>"0"},
+                          :id=>"04071ece-4129-4623-b008-05d9b9a67a32",
+                          :name=>"melbourne-kickstart",
+                          :recovery_point_limit=>"10",
+                          :state=>"OK"
+                      },
+                      {   :description=>nil,
+                          :disk_safe_id=>"d1da6e8c-392f-4918-b780-6e5a5d62dd39",
+                          :enabled=>true,
+                          :force_full_block_scan=>false,
+                          :frequency_type=>"DAILY",
+                          :frequency_values=>{:hours_of_day=>"4", :starting_minute=>"0"},
+                          :id=>"d1da6e8c-4129-4623-b780-05d9b9a67a32",
+                          :name=>"melbourne-kickstart2",
+                          :recovery_point_limit=>"10",
+                          :state=>"OK"
+                      }
+                    ]
+
+      @all_policies_wrapper = {
+                   :get_policies_response=>
+                    {
+                      :return=> @all_policies,
+                      :"@xmlns:ns1"=>"http://policy.api.server.backup.r1soft.com/"
+                    }
+                  }
+    end
+  end
+end

data/test/test_helper.rb

@@ -20,6 +20,8 @@ require_relative '../lib/ultravault/soap_service'
 require_relative '../lib/ultravault/soap_service/agent_service'
 require_relative '../lib/ultravault/soap_service/disk_safe_service'
 require_relative '../lib/ultravault/soap_service/recovery_point_service'
+require_relative '../lib/ultravault/soap_service/policy_service'
+require_relative '../lib/ultravault/data_objects/policy'
 
 require_relative 'support/fixtures'
 
@@ -32,4 +34,4 @@ UltraVault.configure do |config|
   config.ssl = false
   config.username = 'foo'
   config.password = 'bar'
-end
+end

data/test/unit/lib/ultravault/data_objects/test_agent.rb

@@ -44,6 +44,23 @@ module UltraVault
                 @params[:id]).returns(stub)
           @agent.disk_safes
         end
+
+      end
+
+      context 'with an API version > 1' do
+
+        setup do
+          UltraVault.configure do |config|
+            config.api_version = 2
+          end
+          @agent = Agent.new(@params)
+        end
+
+        should "respond to .disk_safes via an api call" do
+          DiskSafe.expects(:all).returns(Array.new)
+          assert_equal 2, UltraVault.config.api_version
+          @agent.disk_safes
+        end
       
       end
     
@@ -130,4 +147,4 @@ module UltraVault
       end
     end
   end
-end
+end

data/test/unit/lib/ultravault/soap_service/test_policy_service.rb

@@ -0,0 +1,61 @@
+require_relative '../../../../test_helper'
+
+module UltraVault
+  class PolicyServiceTest < Test::Unit::TestCase
+  
+    context 'a new policy service' do
+    
+      setup do
+        load_policy_service_fixtures
+      end
+    
+      context 'public methods' do
+      
+        setup do
+          ApiRequest.expects(:new).returns(stub(endpoint: 'foo',
+              namespace: 'bar'))
+          @service = PolicyService.new
+          @client = stub
+          @service.expects(:client).returns(@client)
+          @error = Savon::SOAP::Fault.new(stub(body: 'foo'))
+        end
+      
+        context '#find_policy_by_id' do
+          should "return a policy object if it exists" do
+            @client.expects(:request).with(
+              :getPolicyById, id: 'foo').returns(mock(to_hash: @policy_by_id_wrapper))
+            Policy.expects(:new).returns(stub_everything)
+            policy = @service.find_policy_by_id('foo')
+          end
+      
+          should "raise an error if it does not exist" do
+            @client.expects(:request).with(
+              :getPolicyById, id: 'bar').raises(@error)
+            assert_raise Savon::SOAP::Fault do
+              policy = @service.find_policy_by_id('bar')
+            end
+          end
+        end
+    
+        context '#all_policies' do
+          should "return all policies available" do
+            @client.expects(:request).with(:getPolicies).returns(
+              mock(to_hash: @all_policies_wrapper)) 
+            Policy.expects(:new).at_least_once.returns(stub_everything)
+            policies = @service.all_policies
+          end
+        
+          should "raise an error if something goes wrong" do
+            @client.expects(:request).with(:getPolicies).raises(@error)
+            assert_raise Savon::SOAP::Fault do
+              agent = @service.all_policies
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/ultravault.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name    = "ultravault"
-  gem.version = "1.0.2.0"
+  gem.version = "1.2.0"
 
   gem.homepage    = "http://github.com/melbourne/ultravault"
   gem.summary     = "UltraVault"
@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "vcr"
   gem.add_development_dependency "simplecov"
   
-  gem.add_dependency "savon"
+  gem.add_dependency "savon", "~> 0.9.9"
 
   gem.author = "Carpet & Sean"
   gem.email  = "andrew.turner@melbourne.co.uk;sean.handley@melbourne.co.uk"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultravault
 version: !ruby/object:Gem::Version
-  version: 1.0.2.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,17 +128,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.9
 description: ! '    UltraVault Interface
 
 '
@@ -157,10 +157,12 @@ files:
 - lib/ultravault/config.rb
 - lib/ultravault/data_objects/agent.rb
 - lib/ultravault/data_objects/disk_safe.rb
+- lib/ultravault/data_objects/policy.rb
 - lib/ultravault/data_objects/recovery_point.rb
 - lib/ultravault/soap_service.rb
 - lib/ultravault/soap_service/agent_service.rb
 - lib/ultravault/soap_service/disk_safe_service.rb
+- lib/ultravault/soap_service/policy_service.rb
 - lib/ultravault/soap_service/recovery_point_service.rb
 - test/all.rb
 - test/integration/client_code.rb
@@ -168,6 +170,7 @@ files:
 - test/support/fixtures/agent_service.rb
 - test/support/fixtures/disk_safe.rb
 - test/support/fixtures/disk_safe_service.rb
+- test/support/fixtures/policy_service.rb
 - test/support/fixtures/recovery_point_service.rb
 - test/test_helper.rb
 - test/unit/lib/ultravault/data_objects/test_agent.rb
@@ -175,6 +178,7 @@ files:
 - test/unit/lib/ultravault/data_objects/test_recovery_point.rb
 - test/unit/lib/ultravault/soap_service/test_agent_service.rb
 - test/unit/lib/ultravault/soap_service/test_disk_safe_service.rb
+- test/unit/lib/ultravault/soap_service/test_policy_service.rb
 - test/unit/lib/ultravault/soap_service/test_recovery_point_service.rb
 - test/unit/lib/ultravault/test_api_request.rb
 - test/unit/lib/ultravault/test_client.rb
@@ -209,4 +213,3 @@ signing_key:
 specification_version: 3
 summary: UltraVault
 test_files: []
-has_rdoc: