ultravault 1.0.2.0

data/lib/ultravault/soap_service.rb

@@ -0,0 +1,29 @@
+module UltraVault
+  
+  # @private
+  class SoapService
+    attr_reader :client
+    
+    def initialize(service)
+      api_request = UltraVault::ApiRequest.new( host: UltraVault.config.host,
+                                  port: UltraVault.config.port,
+                                  service: service,
+                                  api_verison: UltraVault.config.api_version,
+                                  ssl: UltraVault.config.ssl) 
+      @client = UltraVault::Client.new( endpoint: api_request.endpoint,
+                              namespace: api_request.namespace,
+                              username: UltraVault.config.username,
+                              password: UltraVault.config.password)     
+    end
+    
+    def extract_params(response_hash, type)
+      return response_hash[type][:return] if response_hash[type]
+      nil
+    end
+    
+    def extract_params_array(response_hash, type)
+      [extract_params(response_hash,type)].flatten.compact
+    end
+    
+  end
+end

data/lib/ultravault/soap_service/agent_service.rb

@@ -0,0 +1,62 @@
+module UltraVault
+  # @private
+  class AgentService < UltraVault::SoapService    
+    
+    def initialize
+      super(:Agent)
+    end
+    
+    def find_agent_by_id(agent_id)
+      response_hash = client.request(:getAgentByID, :id => agent_id).to_hash
+      params = extract_params(response_hash, :get_agent_by_id_response)
+      UltraVault::Agent.new(params)
+    end
+    
+    def all_agents
+      response_hash = client.request(:getAgents).to_hash
+      params = extract_params_array(response_hash, :get_agents_response)
+      params.collect do |agent|
+        UltraVault::Agent.new(agent)
+      end  
+    end
+    
+    def create_agent(params)
+      response_hash = client.request(:createAgentWithObject,
+        :agent => map_agent_params(params)).to_hash
+        params = extract_params(response_hash,
+          :create_agent_with_object_response)
+      UltraVault::Agent.new(params)   
+    end
+    
+    def update_agent(params)
+      client.request(:updateAgent,
+        :agent => map_agent_params(params)).to_hash
+      UltraVault::Agent.new(params)      
+    end
+    
+    def destroy_agent(id)
+      client.request(:deleteAgentById, id: id)
+      nil
+    end
+    
+    private
+    
+    def map_agent_params(params)
+      mapped_params = {}
+      params.keys.each do |key|
+        case key
+          when :port_number
+            mapped_params[:portNumber] = params[key]                             
+          when :os_type
+            mapped_params[:osType] = params[key]                
+          else
+            mapped_params[key] = params[key]  
+        end
+      end
+      mapped_params
+    end
+    
+  end
+  
+end
+

data/lib/ultravault/soap_service/disk_safe_service.rb

@@ -0,0 +1,18 @@
+module UltraVault
+  # @private  
+  class DiskSafeService < UltraVault::SoapService
+
+    def initialize
+      super(:DiskSafe)
+    end
+    
+    def find_disksafes_by_agent_id(agent_id)
+      response_hash = client.request(:getDiskSafesForAgent, :agent => {:id => agent_id }).to_hash
+      params = extract_params_array(response_hash,
+        :get_disk_safes_for_agent_response)
+      params.collect do |disk_safe|
+        UltraVault::DiskSafe.new(disk_safe)
+      end
+    end
+  end
+end

data/lib/ultravault/soap_service/recovery_point_service.rb

@@ -0,0 +1,21 @@
+module UltraVault
+  # @private
+  class RecoveryPointService < UltraVault::SoapService
+    
+    def initialize
+      super(:RecoveryPoints)
+    end
+    
+    def find_recovery_points_by_disk_safe_id(disk_safe_id)
+      response_hash = client.request(:getRecoveryPoints,
+        :diskSafe => {:id => disk_safe_id },
+        :includeMerged => false).to_hash
+      params = extract_params_array(response_hash,
+        :get_recovery_points_response)
+      params.collect do |recovery_point|
+        UltraVault::RecoveryPoint.new(recovery_point)
+      end
+
+    end
+  end
+end

data/test/all.rb

@@ -0,0 +1,6 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(dir)
+
+Dir["#{dir}/**/test_*.rb"].sort.each do |file|
+  require file.sub(/^#{dir}\/(.*)\.rb$/, '\1')
+end

data/test/integration/client_code.rb

@@ -0,0 +1,88 @@
+require_relative '../test_helper'
+require_relative '../../lib/ultravault'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "#{File.dirname(__FILE__)}/../vcr_cassettes"
+  c.hook_into :webmock # or :fakeweb
+end
+
+class ClientCodeTest < Test::Unit::TestCase
+
+  context "typical usage" do            
+    
+    should "retrieve agents, disksafes and recovery points" do
+      VCR.use_cassette('all_agents') do
+              
+        # Set up the service
+        UltraVault.configure do |config|
+          config.host = 'foo.bar.baz'
+          config.port = 9080
+          config.api_version = 1
+          config.ssl = false
+          config.username = 'foo'
+          config.password = 'bar'
+          config.debug = false
+        end
+         
+        # Get all agents
+        agents = UltraVault::Agent.all
+        assert agents.count > 0
+
+        # Check disksafes
+        agent = agents.first
+        assert agent.disk_safes.count > 0
+                                        
+        # Check recovery points
+        disk_safe = agent.disk_safes.first
+        assert disk_safe.recovery_points.count > 0
+      end   
+      
+      VCR.use_cassette('agent_by_id') do
+        # Get an agent
+        agent = UltraVault::Agent.find_by_id("157b9915-0ec8-45cd-a04f-aeea13f48c8e")
+        assert_not_nil agent
+      end
+    end
+    
+    should "create, modify and delete agents" do
+      VCR.use_cassette('create_mod_rm_agents') do
+              
+        # Set up the service
+        UltraVault.configure do |config|
+          config.host = 'foo.bar.baz'
+          config.port = 9080
+          config.api_version = 1
+          config.ssl = false
+          config.username = 'foo'
+          config.password = 'bar'
+          config.debug = false
+        end
+         
+        # Create new agent
+        agent = UltraVault::Agent.create(
+                :hostname => 'foobar.com', :port_number => 9080,
+                :description => 'foobarbazbar',
+                :os_type => 'linux'
+        )
+        
+        assert_not_nil agent
+        
+        agent_id = agent.id
+        agent_old_host = agent.hostname
+        
+        # Update an agent's properties
+        agent.update(:hostname => 'bazbar')
+        assert_not_equal agent_old_host, agent.host
+        
+        # Delete an agent
+        agent.destroy
+
+        # Prove it's gone
+        assert_raise Savon::SOAP::Fault do
+          agent = UltraVault::Agent.find_by_id(agent_id)
+        end
+      end   
+    end
+  end
+end

data/test/support/fixtures.rb

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

data/test/support/fixtures/agent_service.rb

@@ -0,0 +1,56 @@
+module UltraVault
+  module Fixtures
+    def load_agent_service_fixtures
+      @agent_by_id =   { :database_add_on_enabled=>false,
+                      :description=>"test-MSSQL",
+                      :hostname=>"1.2.3.4",
+                      :id=>"e9bd701b-dac1-4921-ab1c-467f35209e21",
+                      :os_type=>"WINDOWS", :port_number=>"1167"
+                  }
+      
+      @agent_by_id_wrapper = {
+                    :get_agent_by_id_response=>
+                     {
+                       :return=> @agent_by_id,
+                       :"@xmlns:ns1"=>"http://agent.api.server.backup.r1soft.com/"
+                     }
+                   }
+      @update_agent_wrapper = {
+                   :update_agent_response=>
+                    {
+                      :return=> @agent_by_id,
+                      :"@xmlns:ns1"=>"http://agent.api.server.backup.r1soft.com/"
+                    }
+                  }
+      @agent_with_object_wrapper = {
+                   :create_agent_with_object_response=>
+                    {
+                      :return=> @agent_by_id,
+                      :"@xmlns:ns1"=>"http://agent.api.server.backup.r1soft.com/"
+                    }
+                  }
+      @all_agents = [
+                      { :database_add_on_enabled=>false,
+                                     :description=>"test-MSSQL",
+                                     :hostname=>"1.2.3.4",
+                                     :id=>"e9bd701b-dac1-4921-ab1c-467f35209e21",
+                                     :os_type=>"WINDOWS", :port_number=>"1167"
+                      },
+                      { :database_add_on_enabled=>false,
+                                     :description=>"test-MSSQL2",
+                                     :hostname=>"2.3.4.5",
+                                     :id=>"b107db9e-dac1-4921-ab1d-12e90253f764support",
+                                     :os_type=>"LINUX", :port_number=>"1168"
+                      }
+                    ]
+
+      @all_agents_wrapper = {
+                   :get_agents_response=>
+                    {
+                      :return=> @all_agents,
+                      :"@xmlns:ns1"=>"http://agent.api.server.backup.r1soft.com/"
+                    }
+                  }
+    end
+  end
+end

data/test/support/fixtures/disk_safe.rb

@@ -0,0 +1,35 @@
+module UltraVault
+  module Fixtures
+    def load_disk_safe_fixtures
+      @disk_safe_params = {:agent_id=>"e9bd701b-dac1-4921-ab1c-467f35209e21",
+                :compression_level=>"LOW", 
+                :compression_type=>"QUICKLZ", 
+                :description=>"test-MSSQL", 
+                :device_count=>"2", 
+                :device_list=>{
+                  :capacity=>"64421359616", 
+                  :device_content_type=>"NTFS", 
+                  :device_path=>"\\\\?\\Volume{1b1cac04-b25f-11e0-bc49-806e6f6e6963}", 
+                  :enabled=>true, 
+                  :mount_point=>"C:\\", 
+                  :mounted=>true}, 
+                :disk_safe_attribute_map=>{:entry=>
+                  [{:key=>"ARCHIVING_ENABLED", :value=>true},
+                   {:key=>"FILE_EXCLUDES_ENABLED",  :value=>true}, 
+                   {:key=>"QUOTA_TYPE",  :value=>"NONE"}, 
+                   {:key=>"CONTROLPANELS_ENABLED",  :value=>true}, 
+                   {:key=>"ARCHIVE_POINT_LIMIT", :value=>"-1"},
+                   {:key=>"RECOVERY_POINT_LIMIT", :value=>"-1"}, 
+                   {:key=>"SOFT_QUOTA_VALUE", :value=>"-1.0"}, 
+                   {:key=>"REPLICATION_FREQUENCY_LIMIT", :value=>"NO_LIMIT"}, 
+                   {:key=>"HARD_QUOTA_VALUE", :value=>"-1.0"}]
+                   }, 
+                :id=>"3067f030-9814-4314-ae03-75933ac29e37",
+                :open=>true, 
+                :recovery_point_count=>"2", 
+                :size=>"20931331073", 
+                :size_of_deltas_in_disk_safe=>"18665326744", 
+                :volume_id=>"9b77052e-e1d3-4c51-a49a-51544fcb12e1"}      
+    end
+  end
+end

data/test/support/fixtures/disk_safe_service.rb

@@ -0,0 +1,60 @@
+module UltraVault
+  module Fixtures
+    def load_disk_safe_service_fixtures
+      @disk_safes_by_agent_id = {
+                  :agent_id=>"e9bd701b-dac1-4921-ab1c-467f35209e21",
+                  :backup_partition_table=>true,
+                  :backup_unmounted_devices=>true, 
+                  :bytes_on_disk=>"20931331073",
+                  :compression_level=>"LOW",
+                  :compression_type=>"QUICKLZ",
+                  :deltas_in_disk_safe=>"6920703",
+                  :description=>"test-MSSQL",
+                  :device_backup_type=>"AUTO_ADD_DEVICES",
+                  :device_count=>"2",
+                  :device_list=>{
+                    :allocated_blocks=>"7843190",
+                    :block_size=>"4096",
+                    :capacity=>"64421359616",
+                    :content_id=>"0004AFF104AFE7BC",
+                    :device_content_type=>"NTFS",
+                    :device_path=>"\\\\?\\Volume{1b1cac04-b25f-11e0-bc49-806e6f6e6963}",
+                    :enabled=>true,
+                    :mount_point=>"C:\\",
+                    :mounted=>true,
+                    :total_blocks=>"15727871"
+                  },
+                  :disk_safe_attribute_map=>{
+                    :entry=>[
+                      {:key=>"ARCHIVING_ENABLED", :value=>true},
+                      {:key=>"FILE_EXCLUDES_ENABLED", :value=>true},
+                      {:key=>"QUOTA_TYPE", :value=>"NONE"},
+                      {:key=>"CONTROLPANELS_ENABLED", :value=>true},
+                      {:key=>"ARCHIVE_POINT_LIMIT", :value=>"-1"},
+                      {:key=>"RECOVERY_POINT_LIMIT", :value=>"-1"},
+                      {:key=>"SOFT_QUOTA_VALUE", :value=>"-1.0"},
+                      {:key=>"REPLICATION_FREQUENCY_LIMIT", :value=>"NO_LIMIT"},
+                      {:key=>"HARD_QUOTA_VALUE", :value=>"-1.0"}
+                     ]},
+                   :id=>"3067f030-9814-4314-ae03-75933ac29e37",
+                   :open=>true,
+                   :path=>"/data/test-volume/3067f030-9814-4314-ae03-75933ac29e37",
+                   :recovery_point_count=>"2",
+                   :size=>"20931331073",
+                   :size_of_deltas_in_disk_safe=>"18665326744",
+                   :total_free_pages=>"0",
+                   :total_free_pages_bytes=>"0",
+                   :total_page_bytes=>"20924334080",
+                   :total_page_count=>"638560",
+                   :volume_id=>"9b77052e-e1d3-4c51-a49a-51544fcb12e1"
+                 }
+
+      @disk_safes_by_agent_id_wrapper = {
+                    :get_disk_safes_for_agent_response=>{
+                      :return=> @disk_safes_by_agent_id,
+                      :"@xmlns:ns1"=>"http://disksafe.api.server.backup.r1soft.com/"
+                     }
+                   }
+    end
+  end
+end

data/test/support/fixtures/recovery_point_service.rb

@@ -0,0 +1,26 @@
+module UltraVault
+  module Fixtures
+    def load_recovery_point_service_fixtures
+      @recovery_points_by_disk_safe_id =   [
+                    {:agent_id=>"e9bd701b-dac1-4921-ab1c-467f35209e21",
+                     :created_on_timestamp_in_millis=>"1330361712361",
+                     :disk_safe_id=>"3067f030-9814-4314-ae03-75933ac29e37",
+                     :recovery_point_id=>"1",
+                     :recovery_point_state=>"AVAILABLE"},
+                    {:agent_id=>"e9bd701b-dac1-4921-ab1c-467f35209e21",
+                     :created_on_timestamp_in_millis=>"1330427016495",
+                     :disk_safe_id=>"3067f030-9814-4314-ae03-75933ac29e37",
+                     :recovery_point_id=>"2",
+                     :recovery_point_state=>"AVAILABLE"}
+                  ]
+      
+      @recovery_points_by_disk_safe_id_wrapper = {
+                    :get_recovery_points_response=>
+                     {
+                       :return=> @recovery_points_by_disk_safe_id,
+                       :"@xmlns:ns1"=>"http://recoverypoints.api.server.backup.r1soft.com/"
+                     }
+                   }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'webmock/test_unit'
+require 'savon'
+require 'ostruct'
+
+include WebMock::API
+
+require_relative '../lib/ultravault/api_request'
+require_relative '../lib/ultravault/client'
+require_relative '../lib/ultravault/config'
+require_relative '../lib/ultravault/data_objects/agent'
+require_relative '../lib/ultravault/data_objects/disk_safe'
+require_relative '../lib/ultravault/data_objects/recovery_point'
+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 'support/fixtures'
+
+include UltraVault::Fixtures
+
+UltraVault.configure do |config|
+  config.host = 'foo.bar.baz'
+  config.port = 9080
+  config.api_version = 1
+  config.ssl = false
+  config.username = 'foo'
+  config.password = 'bar'
+end