nvx-sds 0.0.1

data/LICENSE

@@ -0,0 +1,64 @@
+#  Limited Permissive License
+#  September 05, 2007
+#  
+#  Nirvanix Licensing Limited Permissive License
+#  
+#  This license governs use of the accompanying software. If you use the 
+#  software, you accept this license. If you do not accept the license, 
+#  do not use the software.
+#  
+#  1. DEFINITIONS
+#  
+#  The terms �reproduce,� �reproduction,� �derivative works,� and 
+#  �distribution� have the same meaning here as under U.S. copyright law.
+#  A �contribution� is the original software, or any additions or changes 
+#  to the software. A �contributor� is any person that distributes its 
+#  contribution under this license. �License patents� are a contributor�s 
+#  patent claims that read directly on its contribution.
+#  
+#  2. GRANT OF RIGHTS
+#  
+#  A. Copyright Grant � Subject to the terms of this license, including 
+#  the license conditions and limitations in section 3, each contributor 
+#  grants you a non-exclusive, worldwide, royalty-free copyright license 
+#  to reproduce its contribution, prepare derivative works of its 
+#  contribution, and distribute its contribution or any derivative works 
+#  that you create.
+#  
+#  B. Patent Grant � Subject to the terms of this license, including the 
+#  license conditions and limitations in section 3, each contributor 
+#  grants you a non-exclusive, worldwide, royalty-free license under its 
+#  licensed patents to make, have made, use, sell, offer for sale, import, 
+#  and/or otherwise dispose of its contribution in the software or 
+#  derivative works of the contribution in the software.
+#  
+#  3. CONDITIONS AND LIMITATIONS
+#  
+#  A. No Trademark License � This license does not grant you rights to 
+#  use any contributors� name, logo, or trademarks.
+#  
+#  B. If you bring a patent claim against any contributor over patents 
+#  that you claim are infringed by the software, your patent license from 
+#  such contributor to the software ends automatically.
+#  
+#  C. If you distribute any portion of the software, you must retain all 
+#  copyright, patent, trademark, and attribution notices that are present 
+#  in the software.
+#  
+#  D. If you distribute any portion of the software in source code form, 
+#  you may do so only under this license by including a complete copy of 
+#  this license with your distribution. If you distribute any portion of 
+#  the software in compiled or object code form, you may only do so 
+#  under a license that complies with this license.
+#  
+#  E. The software is licensed �as-is.� You bear the risk of using it. 
+#  The contributors give no express warranties, guarantees or 
+#  conditions. You may have additional consumer rights under your local 
+#  laws which this license cannot change. To the extent permitted under 
+#  your local laws, the contributors exclude the implied warranties of 
+#  merchantability, fitness for a particular purpose and 
+#  non-infringement.
+#  
+#  F. Platform Limitation � The licenses granted in sections 2 A. & 2 B. 
+#  extend only to the software or derivative works that you create that 
+#  utilize the Nirvanix Web Services Platform.

data/README

@@ -0,0 +1,80 @@
+#= NVX::SDS
+#== A Ruby SDK for Nirvanix Storage Delivery System (SDS).
+#=== Getting the Library
+#==== Download with RubyGems
+#
+#sudo gem i nvx-sds 
+#==== Download from the svn repository
+#
+#svn co svn://rubyforge.org/var/svn/nirvanix/sds/trunk nvx-sds 
+#The latest release and support is always available at Nirvanix Development Site
+#
+#=== Getting started
+#After the gems library is installed you will need to:
+#
+#require 'nvx_sds' 
+#==== Creating a Session
+#Most operations using this library will use go through the Session object. The session holds authentication and persistent connection information for the Nirvanix account.
+#
+#Creating a session can be done using:
+#
+#session = Session.new("APP-KEY", "USERNAME", "APP NAME", "PASSWORD") 
+#
+#To get an account go to http://nmp.nirvanix.com/ and sign up. This will generate a new account and application key that you can use the pass to the session initialize method.
+#
+#When you are finished with a session always be sure to log that session out to invalidate the active session token.
+#
+#session.Logout 
+#==== Uploading a file
+#To upload a file you will need to create a session and a SoapUpload object. The call takes a local file and streams it to the remote server. Below is an example of an upload:
+#
+#session = Session.new("APP-KEY", "USERNAME", "APP NAME", "PASSWORD")
+#
+#remote_file = "/TestUpload.txt"
+#
+##Get a file in the current directory
+#
+#local_file = File.expand_path(File.join(File.dirname(__FILE__), '.')) + remote_file
+#
+#SoapUpload.UploadFile(remote_file, local_file, session.account_login)
+#
+#==== General File operations
+#There are many different file operations that are available once a file has been uploaded through the API. To get to these operations you can retrieve the root folder. The example below shows this and prints out each folder name.
+#
+#session = Session.new("APP-KEY", "USERNAME", "APP NAME", "PASSWORD")
+#
+#root_folder = session.GetRootFolder(1, 500, 0, true)
+#
+#root_folder.folders.each do |folder|
+#
+#	print folder.name
+#
+#end
+#
+#The parameters are:
+#
+#* CurrentPage - The current page you are requesting 
+#* NumberPerPage - This is the total number of items files or folders 
+#* FolderSortCode - How the list of items returned should be sorted 
+#* SortDescending - If the list of items should be listed in descending order 
+#The maximum number of items reutrned in a single page is 500
+#
+#The folder sort codes are: 
+#
+#* Name 
+#* CreatedDate 
+#* SizeBytes 
+#* FileType 
+#
+#LoadChildren must be called to handle paging, due to memory concerns we didnt want to return too many items in one request, doing so could cause problems for people using shared servers with memory caps or other limitations. 
+#
+#After getting a folder object you can copy, move, rename and delete files or folders.  You can read more about folder oprations in the Folder RubyDoc entry.
+#
+#File operations can be completed in a similar manor using the NVXFile object
+#
+#=== Accounting Operations
+#The session object lets you get or set account information about the account you used to create the session. This is contact information and the username. The session object can also be used to retrieve a MasterAccount object that will give you the ability to create and delete child accounts, setting and getting account notes and impersonation of children under that master account.
+#
+#The master account has a unique set of children and file system per application key but only one set of account contact information. This means each application key is a unique space under the master account. You can read more about this relationship in the official Nirvanix API Documentation.
+#
+#As a master account you will not need the password of the child account only the username you wish to impersonate.

data/lib/nvx/sds/APIClasses/accountfeatureusage.rb

@@ -0,0 +1,60 @@
+# = Overview
+#
+# AccountFeatureUsage is a class to define feature usage.  This lets you get usage for a particular account.  
+# There are several usage types such as:
+#
+# * Storage Amount
+# * Download Bandwidth Amount
+# * Upload Bandwidth Amount
+module NVX
+    module SDS
+        
+        $:.unshift File.dirname(__FILE__)
+        require 'REXML/Document'
+        include REXML
+        
+        # = Overview
+        #
+        # AccountFeatureUsage is a class to define feature usage.  This lets you get usage for a particular account.  
+        # There are several usage types such as:
+        #
+        # * Storage Amount
+        # * Download Bandwidth Amount
+        # * Upload Bandwidth Amount
+        class AccountFeatureUsage
+
+            # Extracts the Usage information from the xml node element.
+            def initialize(element)
+                @feature_name = (text = element.elements["FeatureName"].get_text and text.value)
+                @total_usage_amount = (text = element.elements["TotalUsageAmount"].get_text and text.value)
+                @usage_start_date = (text = element.elements["UsageStartDate"].get_text and text.value)
+                @usage_end_date = (text = element.elements["UsageEndDate"].get_text and text.value)            
+            end
+            
+            # Returns a nicely formatted feature name : usage amount string. Eg. "Storage Amount: 10000"
+            def to_s
+                @feature_name + ":" + @total_usage_amount
+            end
+
+            # Returns the name of the feature.
+            def feature_name
+                @feature_name
+            end
+            
+            # Returns the total amount of usage.
+            def total_usage_amount
+                @total_usage_amount
+            end
+            
+            # Returns the start date when this usage information applies.
+            def usage_start_date
+                @usage_start_date
+            end
+            
+            # Returns the end date when this usage information applies.
+            def usage_end_date
+                @usage_end_date
+            end
+        end        
+    end
+end

data/lib/nvx/sds/APIClasses/accountinfo.rb

@@ -0,0 +1,30 @@
+# = Overview
+# 
+# Holds the account information from the GetAccountInfo call.
+module NVX
+    module SDS
+        
+        $:.unshift File.dirname(__FILE__)
+        require 'contactinfo'
+        
+        # Holds the account information from the GetAccountInfo call.
+        class AccountInfo
+        
+            # Stores the username and creates a new contact object.
+            def initialize(doc)
+                @username = (text = doc.root.elements["//Username"].get_text and text.value)
+                @contact = ContactInfo.new(doc)
+            end
+            
+            # The username.
+            def username
+                @username
+            end
+            
+            # The contact object.
+            def contact
+                @contact
+            end
+        end            
+    end
+end

data/lib/nvx/sds/APIClasses/accountlimit.rb

@@ -0,0 +1,25 @@
+# = Overview
+#
+# AccountLimit holds the account limit information.
+module NVX
+    module SDS
+        # AccountLimit holds the account limit information.
+        class AccountLimit
+            # stores the limit type and value for that limit.
+            def initialize(type, value)
+                @type = type
+                @value = value
+            end
+            
+            # Returns the limit type.
+            def type
+                @type
+            end
+            
+            # Returns the value for the limit.
+            def value
+                @value
+            end
+        end
+    end
+end

data/lib/nvx/sds/APIClasses/contactinfo.rb

@@ -0,0 +1,74 @@
+# = Overview
+#
+# The contact information is stored from the GetAccountInfo call.
+module NVX
+    module SDS
+        # The contact information is stored from the GetAccountInfo call.
+        class ContactInfo
+            
+            def initialize(doc)
+                @first_name = (text = doc.root.elements["//FirstName"].get_text and text.value)
+                @last_name = (text = doc.root.elements["//LastName"].get_text and text.value)
+                @middle_initial = (text = doc.root.elements["//MiddleInitial"].get_text and text.value)
+                @phone_number = (text = doc.root.elements["//PhoneNumber"].get_text and text.value)
+                @email_address = (text = doc.root.elements["//EmailAddress"].get_text and text.value)
+                @email_format = (text = doc.root.elements["//EmailFormat"].get_text and text.value)
+                @address_line1 = (text = doc.root.elements["//AddressLine1"].get_text and text.value)
+                @address_line2 = (text = doc.root.elements["//AddressLine2"].get_text and text.value)
+                @city = (text = doc.root.elements["//City"].get_text and text.value)
+                @state = (text = doc.root.elements["//State"].get_text and text.value)
+                @country = (text = doc.root.elements["//CountryID"].get_text and text.value)
+                @postal_code = (text = doc.root.elements["//PostalCode"].get_text and text.value)
+            end
+
+            def first_name
+                @first_name
+            end
+            
+            def last_name
+                @last_name
+            end
+            
+            def middle_initial
+                @middle_initial
+            end
+            
+            def phone_number
+                @phone_number
+            end
+            
+            def email_address
+                @email_address
+            end
+            
+            def email_format
+                @email_format
+            end
+            
+            def address_line1
+                @address_line1
+            end
+            
+            def address_line2
+                @address_line2
+            end
+            
+            def city
+                @city
+            end
+            
+            def state
+                @state
+            end
+            
+            def country
+                @country
+            end
+            
+            def postal_code
+                @postal_code
+            end
+        end
+    end
+end
+

data/lib/nvx/sds/APIClasses/fsfileattributes.rb

@@ -0,0 +1,50 @@
+# FSFileAttributes is an internal class used to extract file information from a ListFolders call.
+module NVX
+    module SDS
+
+        # Used to extract file information from a ListFolders call.
+        class FSFileAttributes
+            # Reads the File node from the xml fragment.
+            def initialize(xml)
+                doc = REXML::Document.new(xml)
+                
+                @name = (text = doc.root.elements["//File/Name"].get_text and text.value)
+                @path = (text = doc.root.elements["//File/Path"].get_text and text.value)
+                @created_date = (text = doc.root.elements["//File/CreatedDate"].get_text and text.value)
+                @size_bytes = (text = doc.root.elements["//File/SizeBytes"].get_text and text.value)                
+                @metadata = (text = doc.root.elements["//File/Metadata"].get_text and text.value)
+                @file_tags = (text = doc.root.elements["//File/FileTags"].get_text and text.value)
+            end
+
+            # The filename.
+            def name
+                @name
+            end
+
+            # The full relative path to the file.
+            def path
+                @path.nil? ? "" : @path
+            end
+            
+            # The date the file was created on the local system.
+            def created_date
+                @created_date.nil? ? "" : @created_date
+            end
+            
+            # The size of the file.
+            def size_bytes
+                @size_bytes
+            end
+
+            # The metadata for the file.
+            def metadata
+                @metadata.nil? ? "" : @metadata
+            end
+
+            # The array of tags.
+            def file_tags
+                @fileTags
+            end            
+        end
+    end
+end

data/lib/nvx/sds/APIClasses/fsfolderattributes.rb

@@ -0,0 +1,53 @@
+# FSFolderAttributes is an internal class used to extract folder information from a ListFolders call.
+module NVX
+    module SDS
+        
+        # FSFolderAttributes is an internal class used to extract folder information from a ListFolders call.
+        class FSFolderAttributes
+            
+            # Extract the folder information from the xml fragment.
+            def initialize(xml)
+                if !xml.nil?
+                    doc = REXML::Document.new(xml)
+                    @name = (text = doc.root.elements["//Folder/Name"].get_text and text.value)
+                    @path = (text = doc.root.elements["//Folder/Path"].get_text and text.value)
+                    @created_date = (text = doc.root.elements["//Folder/CreatedDate"].get_text and text.value)
+                    @folder_count = (text = doc.root.elements["//Folder/FolderCount"].get_text and text.value)
+                    @file_count = (text = doc.root.elements["//Folder/FileCount"].get_text and text.value)
+                end
+            end
+            
+            # Creates the Base root folder, used internally for ListFolders call.
+            def EmptyRootFolder(name, path, created_date)
+                @name = name
+                @path = path
+                @created_date = created_date
+            end
+            
+            # The name of the folder
+            def name
+                @name
+            end
+
+            # The path to the folder.
+            def path
+                @path
+            end
+            
+            # The date created.
+            def created_date
+                @created_date.nil? ? "" : @created_date
+            end
+            
+            # The children folder count.
+            def folder_count
+                @folder_count
+            end
+            
+            # the children file count
+            def file_count
+                @file_count
+            end
+        end
+    end
+end

data/lib/nvx/sds/APIClasses/fsfolderlist.rb

@@ -0,0 +1,70 @@
+# FSFolderList is an internal class used to extract file and folder information from a ListFolders call.
+module NVX
+    module SDS
+        
+        $:.unshift File.dirname(__FILE__)
+        require 'fsfolderattributes'        
+        require 'fsfileattributes'        
+        require 'REXML/Document'
+        include REXML
+        
+        # FSFolderList is an internal class used to extract file and folder information from a ListFolders call.
+        class FSFolderList
+
+            # Extracts count and file / folder arrays from the ListFolders response.
+            def initialize(xml)
+                doc = REXML::Document.new(xml)
+                @total_folder_count = (text = doc.root.elements["//Response/ListFolder/TotalFolderCount"].get_text and text.value)
+                @total_file_count = (text = doc.root.elements["//Response/ListFolder/TotalFileCount"].get_text and text.value)
+                @page_folder_count = (text = doc.root.elements["//Response/ListFolder/PageFolderCount"].get_text and text.value)
+                @page_file_count = (text = doc.root.elements["//Response/ListFolder/PageFileCount"].get_text and text.value)
+                
+                @folder_attributes = Array.new
+                @file_attributes = Array.new
+                
+                if doc.root.elements["//Response/ListFolder/Folder"]
+                    doc.root.elements.each("//Response/ListFolder/Folder") do |folder|
+                        @folder_attributes << FSFolderAttributes.new(folder.to_s)
+                    end
+                end
+
+                if doc.root.elements["//Response/ListFolder/File"]
+                    doc.root.elements.each("//Response/ListFolder/File") do |file|
+                        @file_attributes << FSFileAttributes.new(file.to_s)
+                    end
+                    
+                end
+            end
+
+            # The total folder count outside of paging.
+            def total_folder_count
+                @total_folder_count.nil? ? 0 : @total_folder_count.to_i
+            end
+
+            # The total file count outside of paging.
+            def total_file_count
+                @total_file_count.nil? ? 0 : @total_file_count.to_i
+            end
+
+            # The paging folder count
+            def page_folder_count
+                @page_folder_count.nil? ? 0 : @page_folder_count.to_i
+            end
+
+            # the paging file count
+            def page_file_count
+                @page_file_count.nil? ? 0 : @page_file_count.to_i
+            end
+        
+            # The folder attributes array.
+            def folder_attributes
+                @folder_attributes
+            end
+    
+            # The file attributes array.
+            def file_attributes
+                @file_attributes
+            end
+        end
+    end
+end

data/lib/nvx/sds/APIClasses/metadatainfo.rb

@@ -0,0 +1,26 @@
+# = Overview
+#
+# The MetadataInfo object stores the type and value pair.
+module NVX
+    module SDS
+        
+        # The MetadataInfo object stores the type and value pair.
+        class MetadataInfo
+            # Sets the type and value
+            def initialize(type, value)
+                @type = type
+                @value = value
+            end
+            
+            # The Metadata type
+            def type
+                @type
+            end
+            
+            # The Metadata value
+            def value
+                @value
+            end
+        end
+    end
+end

data/lib/nvx/sds/APIClasses/responsecodes.rb

@@ -0,0 +1,97 @@
+#Response Codes that can be returned from the services are listed below as constants
+module NVX
+    module SDS
+
+        #Response Codes that can be returned from the services are listed below as constants
+        OK = 0,
+
+        # API errors.
+        MissingRequiredParameter = 100,
+        InvalidParameter = 101,
+        UnsupportedOperation = 160,
+
+        # Billing errors
+        ParameterOutOfAcceptedRange = 50103,
+        InvalidPayment = 55001,
+
+        CreditCardChargeFailed = 55100,
+
+        # Account errors.
+        CreateAccountFailed = 65001,
+        CreateAccountContactFailed = 65002,
+        InvalidAppKey = 65004,
+        InvalidAccountType = 65005,
+        DuplicateUserNameUnderAppKey = 65006,
+        DuplicateAppName = 65007,
+        PageSizeExceedsLimit = 65008,
+        DeletedAccount = 65009,
+        InvalidStatus = 65010,
+        InvalidSecurityResponse = 65011,
+        InvalidUserNameOrPassword = 65012,
+        DuplicateMasterAccountUserName = 65016,
+        PageNumberExceeded = 65017,
+
+        InvalidContactParameter = 65101,
+        AppNameNotFound = 65102,
+        UserNameNotFoundUnderAppKey = 65103,
+        UserNameNotFound = 65104,
+
+        # File system errors.
+        FolderNotFound = 70001,
+        FileNotFound = 70002,
+        PathNotFound = 70003,
+        AlreadyExists = 70004,
+        InvalidPath = 70005,
+        DownloadPathNotFound = 70006,
+        MetadataDoesNotExist = 70007,
+        FolderAlreadyExists = 70008,
+        PathTooLong = 70009,
+        FileFolderNameTooLong = 70010,
+        ItemAlreadyShared = 70012,
+        PathNotShared = 70013,
+
+        NullOrEmptyPath = 70101,
+        InvalidPathCharacter = 70102,
+        InvalidAbsolutePath = 70103,
+        InvalidRelativePath = 70104,
+        FileIntegrityError = 70106,
+        InvalidMetadata = 70107,
+        RangeNotSatisfiable = 70108,
+        PathTooShort = 70109,
+        FileOffline = 70110,
+        InvalidImageDimensions = 70111,
+        InvalidRotateFlipType = 70112,
+        InvalidSearchItem = 70113,
+        InvalidFileFolderNameCharacter = 70114,
+
+        # Authentication/Authorizarion errors.
+        LoginFailed = 80001,
+        AccessDenied = 80003,
+        InvalidMasterAccountID = 80004,
+        InvalidBillableAccountID = 80005,
+        SessionNotFound = 80006,
+        AccountExpired = 80007,
+        OutOfBytes = 80015,
+        OutOfBytesNonOwner = 80016,
+        InvalidIPAddress = 80018,
+        DownloadFileSizeLimitExceded = 80019,
+        UploadBandwidthLimitExceeded = 80020,
+        StorageLimitExceeded = 80021,
+        LimitAlreadyExceeded = 80022,
+        InvalidAccessToken = 80023,
+        InvalidSessionToken = 80101,
+        ExpiredAccessToken = 80102,
+        InvalidDownloadToken = 80103,
+
+        # Storage errors
+        StorageNotAvailable = 85001,
+        ServerNotFound = 85003,
+
+        # Utility errors.
+        Configuration = 90001,
+        SSLRequired = 90002,
+
+        # SQL Errors
+        Database = 100001
+    end
+end