nvx-sds 0.0.1

data/lib/nvx/sds/session.rb

@@ -0,0 +1,110 @@
+# = Overview
+#
+# The session is the primary object for interaction with the Gem.  You will use the session to get the root folder and subsiquent
+# IMFS objects and Accounting objects.
+module NVX
+    module SDS
+        $:.unshift File.dirname(__FILE__)
+        require 'accountlogin'
+        require 'folder'
+        require 'apiclasses/utilities'
+        require 'hosteditem'
+        
+        # The session is the primary object for interaction with the Gem.  You will use the session to get the root folder and subsiquent
+        # IMFS objects and Accounting objects.
+        class Session
+
+            # Creates a new session object.  The password is optional only when called to impersonate a child account.
+            # when creating a new session use the context:
+            # <b>session = Session.new("APPKEY", "USERNAME", "APPNAME", "PASSWORD")</b>
+            def initialize(appKey, username, appName, password = nil, session_token = nil)
+                @account_login = AccountLogin.new(appKey, username, appName, password, session_token)
+                @account_login.Login if session_token.nil?
+            end
+
+            # Gets the account login object.
+            def account_login
+                @account_login
+            end
+            
+            # Sets the account login object.
+            def account_login=(account_login)
+                @account_login=account_login
+            end
+
+            # Logs the current user out ending the session.
+            def Logout
+                result = Transport.execute_command_post(APICommand.Logout, nil, @account_login)
+                @account_login = nil
+            end
+
+            # Gets the root folder.  You can use this to access all of the files and folders.
+            def GetRootFolder(page_number = 1, page_size = 500, folder_sort_code = nil, should_sort_descending = true)
+                folder = Folder.ListFolder(@account_login, @account_login.root_path, page_number, page_size, folder_sort_code, should_sort_descending)
+                return folder                
+            end
+
+            # Gets a specific folder based on the supplied path.
+            def GetFolder(path, page_number = 1, page_size = 500, folder_sort_code = nil, should_sort_descending = true)
+                if path.index("//").nil?
+                    path = @account_login.root_path + path
+                end
+                folder = Folder.ListFolder(@account_login, path, page_number, page_size, folder_sort_code, should_sort_descending)
+                return folder                
+            end
+
+            # Gets the account information as an AccountInfo object from the current session user.
+            def GetAccountInfo
+                Utilities.GetAccountInfo(@account_login, @account_login.username)
+            end
+
+            # Gets the account limits as an array of AccountLimit objects.
+            def GetAccountLimits
+                Utilities.GetAccountLimits(@account_login, @account_login.username)
+            end
+            
+            # Gets the account usage as an array of AccountFeatureUsage objects.
+            def GetAccountUsage
+                Utilities.GetAccountUsage(@account_login, @account_login.username)
+            end
+            
+            # Sets the account information for the current session user.
+            def SetAccountInfo(first_name, last_name, middle_initial, phone_number, email_address,
+                    email_format, address_line1, address_line2, city, state, country, postal_code)
+                    
+                Utilities.SetAccountInfo(@account_login, @account_login.username, first_name, last_name, 
+                    middle_initial, phone_number, email_address, email_format, address_line1, address_line2, 
+                    city, state, country, postal_code)
+                    
+            end
+            
+            # Deletes all the files from an array of strings passed.
+            def DeleteFiles(file_paths_to_delete)
+                params = Array.new
+                file_paths_to_delete.each do |path|
+                    params << APIParam.new("filePath", path)
+                end
+                Transport.execute_command_post(APICommand.DeleteFiles, params, @account_login)
+            end
+            
+            # Deletes all the folders from an array of strings passed. <b>**THIS WILL REMOVE ALL SUB FOLDERS AND FILES AS WELL.</b>
+            def DeleteFolders(folder_paths_to_delete)
+                params = Array.new
+                folder_paths_to_delete.each do |path|
+                    params << APIParam.new("folderPath", path)
+                end
+                Transport.execute_command_post(APICommand.DeleteFolders, params, @account_login)
+            end
+            
+            # Returns an array of hosted files and folders that have been hosted.
+            def ListHostedItems(page_number = 1, page_size = 500)
+                HostedItem.ListHostedItems(@account_login, page_number, page_size)
+            end
+            
+            # Returns the master account object.
+            def GetMasterAccount
+                MasterAccount.new(self, @account_login)
+            end
+        end
+    end
+end

data/lib/nvx/sds/transport.rb

@@ -0,0 +1,129 @@
+# = Overview
+#
+# The Transport is an internal class that handles the requests and responses from the Nirvanix REST web services.
+# Requests can be made via HTTP GET or POST.
+module NVX
+    module SDS
+
+        $:.unshift File.dirname(__FILE__)
+        require 'apiparam'
+        require 'apicommand'
+        require 'apiclasses/responsecodes'
+        require 'net/https'
+        require 'net/http'
+        require 'REXML/Document'
+        require 'uri'
+        
+        Newline = "\r\n" unless const_defined? "Newline"
+
+        # = Overview
+        #
+        # This is an internal class that handles the requests and responses from the Nirvanix REST web services.
+        # Requests can be made via HTTP GET or POST.
+        class Transport
+            
+            # A method to execute a nirvanix command with the parameters passed via a GET HTTP call.
+            # be aware that the parameters passed to this command will be limited in size due to the maximum
+            # url length allowed by http.  With calls that require many parameters such as array be sure to use
+            # the post method.
+            def Transport.execute_command_get(apicommand, apiparams, account_login)
+                rest_api_url = "services.nirvanix.com"
+                webservice_root = "/ws/"
+                
+                url = webservice_root + apicommand.command_path
+
+                apiparams = Array.new if apiparams.nil?
+                apiparams << APIParam.new("sessionToken", account_login.session_token) if !account_login.nil?
+                
+                first = true
+                apiparams.each {|apiParam|
+                    url = first == true ? url + '?' + apiParam.to_s : url + '&' + apiParam.to_s
+                    first = false
+                }
+                
+                #print "OUTPUT URL: " + url + "\r\n\r\n"
+                
+                port = apicommand.is_secure? ? 443 : 80
+                
+                http = Net::HTTP.new(rest_api_url, port)
+                http.use_ssl = apicommand.is_secure?
+                http.start do |http|
+                    request = Net::HTTP::Get.new(url)
+                    response = http.request(request)
+                    response.value
+                    #print "RESPONSE XML: " + response.body + "\r\n\r\n"
+                    return REXML::Document.new(response.body)
+                end
+            end
+
+            # A method to execute a nirvanix command with the parameters passed via a POST HTTP call.
+            def Transport.execute_command_post(apicommand, apiparams, account_login)
+                rest_api_url = "services.nirvanix.com"
+                webservice_root = "/ws/"
+                
+                url = webservice_root + apicommand.command_path
+                
+                # add the session token in if valid.
+                apiparams = Array.new if apiparams.nil?
+                apiparams << APIParam.new("sessionToken", account_login.session_token) if !account_login.nil?
+
+                params = ""
+                first = true
+                apiparams.each do |apiParam|
+                    params = first == true ? apiParam.to_s : params + '&' + apiParam.to_s
+                    first = false
+                end
+                
+                port = apicommand.is_secure? ? 443 : 80
+                
+                # Create the first http(s) object.
+                h = Net::HTTP.new(rest_api_url, port)
+                
+                # if you are just testing and do not have a SSL certificate setup properly you can
+                # disable warnings with the below line.  Just uncomment to ignore SSL session warnings.
+                h.verify_mode = OpenSSL::SSL::VERIFY_NONE if apicommand.is_secure?
+                
+                # put the SSL in the correct mode based on the apicommand
+                h.use_ssl = apicommand.is_secure?
+                
+                # do the command and return the response.
+                response = h.post(url, params)
+
+                #print "OUTPUT URL: " + rest_api_url + url + "\r\n\r\n"
+                #print "RESPONSE XML: " +  response.body + "\r\n\r\n"
+
+                doc = REXML::Document.new(response.body)
+                response_code = (text = doc.root.elements["//Response/ResponseCode"].get_text and text.value)
+
+                if response_code.to_i == SessionNotFound
+                    # login and refresh session token
+                    account_login.Login
+                    # execute the command again so there is no interruption to the user.
+                    return Transport.execute_command_post(apicommand, apiparams, account_login)
+                end
+                if response_code.to_i != 0
+                    error_message = (text = doc.root.elements["//Response/ErrorMessage"].get_text and text.value)
+                    raise error_message
+                end
+                return doc
+            end
+
+            # Retrieves a file from the remote server and saves it to the local file system
+            # The path can be relative or absolute, if you are a master account you can pass the absolute path
+            # to retrieve a child accounts file.
+            def Transport.DownloadFile(path, local_path, account_login)
+                # Get the download node this will get the proper node for a path.
+                doc = Transport.execute_command_post(APICommand.GetDownloadNodes, [APIParam.new("filePath", path)], account_login)
+                node = doc.root.elements["//Response/DownloadNode"].get_text.value
+                
+                # Transfer the file to the local path.
+                Net::HTTP.start(node) do |http|
+                    resp = http.get(path)
+                    open(local_path, "wb") do |file|
+                        file.write(resp.body)
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/nvx_sds.rb

@@ -0,0 +1,19 @@
+# NVX-SDS: $Id:$
+# 
+# Entry point to the framework.
+# Loads all the files under the 'nvx/sds' subdirectory
+require "rubygems"
+
+here = File.dirname( __FILE__ )
+dir = File.join( here , 'nvx/sds' )
+require File.join( dir, "accountlogin" )
+require File.join( dir, "apicommand" )
+require File.join( dir, "apiparam" )
+require File.join( dir, "countries" )
+require File.join( dir, "folder" )
+require File.join( dir, "session" )
+require File.join( dir, "transport" )
+require File.join( dir, "masteraccount" )
+require File.join( dir, "apiclasses/soapupload" )
+require File.join( dir, "apiclasses/fsfolderlist" )
+require File.join( dir, "apiclasses/metadatainfo" )

data/tests/TestUpload.txt

@@ -0,0 +1,9 @@
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas eget odio. Ut dignissim, lorem et tincidunt bibendum, neque augue vulputate metus, sit amet varius libero enim ac ligula. Proin malesuada condimentum nibh. Proin in erat. Sed tincidunt augue ac nunc. Suspendisse potenti. Mauris dignissim sem tincidunt urna. Vivamus nec arcu. Vivamus odio ligula, imperdiet ut, posuere a, ultricies in, erat. Etiam dictum est in nulla. Nulla rhoncus. Cras justo velit, consectetuer sit amet, posuere vitae, porta sit amet, neque. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Quisque imperdiet, turpis et vulputate suscipit, ipsum lorem varius risus, eget congue lacus ligula vel turpis. Curabitur lacus lorem, pulvinar non, vulputate vitae, interdum eu, turpis. Nam sem.
+
+Proin quis arcu. Vivamus porta, mauris id tincidunt luctus, massa purus elementum tellus, dictum sollicitudin mauris turpis vitae erat. Etiam sem. Fusce arcu. In lobortis elit ut augue. Nunc nisl. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Quisque sapien. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Nam vitae est non mauris tempus vehicula. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+
+Vivamus dignissim lectus at dolor. Maecenas ac risus. Morbi in enim. Duis ac mi vel velit vehicula venenatis. Ut erat. Suspendisse arcu orci, ullamcorper eget, rutrum ac, bibendum pretium, orci. Etiam sodales tempor nulla. Cras vitae purus et pede accumsan ultricies. Nullam lacus. Curabitur dapibus ante non pede. Fusce eget arcu. Nulla facilisi. Vivamus sed pede. Pellentesque vehicula, erat at volutpat auctor, enim massa volutpat justo, sed malesuada nulla turpis sed purus. Cras egestas, ligula eu condimentum tincidunt, diam massa euismod pede, eget vulputate odio dolor luctus mi. Vivamus lacinia tortor non dui. Proin sem magna, aliquam ac, mollis sit amet, laoreet vitae, est. Donec sed urna eu augue vestibulum feugiat. Aliquam tellus velit, vestibulum vel, dapibus bibendum, mattis id, nisi.
+
+Ut et urna a quam rhoncus eleifend. Maecenas a mauris. Fusce vestibulum nulla vitae enim. Etiam nec ante. Maecenas ornare, magna vitae nonummy aliquam, lacus purus porttitor tortor, sit amet lacinia magna dolor quis sapien. Duis ornare, est at rhoncus ultrices, odio turpis viverra ante, non pulvinar odio erat ac purus. Integer nunc est, condimentum vel, interdum ac, adipiscing id, quam. Aliquam convallis. Etiam ultricies tristique mi. Curabitur suscipit arcu id tortor. Etiam dui sapien, eleifend a, adipiscing ac, dignissim vitae, quam. Suspendisse potenti. Sed consequat metus quis nunc. Phasellus dictum nibh id ipsum. Aenean posuere dictum purus. Morbi venenatis vulputate lectus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed euismod. Aenean velit justo, vulputate in, molestie vel, adipiscing eu, tortor.
+
+Vestibulum sollicitudin ante eget nunc. Donec nec lectus at purus mollis egestas. Mauris risus. Morbi vehicula felis vel nibh. Etiam laoreet laoreet eros. Pellentesque neque. Nulla vitae ipsum. Praesent scelerisque tempus enim. Sed aliquam. Aenean a quam. Phasellus in diam. Vestibulum nec arcu nec nibh pulvinar laoreet.

data/tests/accountlogintest.rb

@@ -0,0 +1,19 @@
+# AccountLogin test
+
+require 'test/unit'
+require File.dirname(__FILE__) + '/testconfig'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'nvx/sds/accountlogin'
+
+class AccountLoginTest < Test::Unit::TestCase
+    include NVX::SDS
+
+    def test_Login        
+        accountLogin = AccountLogin.new(APP_KEY, USERNAME, APP_NAME, PASSWORD)
+        accountLogin.Login
+        assert accountLogin.username == "uploadtest"
+        assert accountLogin.app_name == "Upload Test"
+        assert accountLogin.session_token != nil
+        print "Session Token: " + accountLogin.session_token
+    end
+end

data/tests/apicommandtest.rb

@@ -0,0 +1,186 @@
+# apicommand test
+
+require 'test/unit'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'nvx/sds/apicommand'
+
+class APICommandTest < Test::Unit::TestCase
+    include NVX::SDS
+
+    #Authorization Namespace tests
+    def test_Login
+        assert APICommand.Login.command_path == "Authentication/Login.ashx"
+        assert APICommand.Login.is_secure?
+    end
+
+    def test_Logout
+        assert APICommand.Logout.command_path == "Authentication/Logout.ashx"
+        assert !APICommand.Logout.is_secure?
+    end
+    
+    #IMFS Namespace tests
+    def test_ListFolder
+        assert APICommand.ListFolder.command_path == "IMFS/ListFolder.ashx"
+        assert !APICommand.ListFolder.is_secure?
+    end
+
+    def test_CreateFolders
+        assert APICommand.CreateFolders.command_path == "IMFS/CreateFolders.ashx"
+        assert !APICommand.CreateFolders.is_secure?
+    end
+    
+    def test_DeleteFolders
+        assert APICommand.DeleteFolders.command_path == "IMFS/DeleteFolders.ashx"
+        assert !APICommand.DeleteFolders.is_secure?
+    end
+    
+    def test_CopyFolders
+        assert APICommand.CopyFolders.command_path == "IMFS/CopyFolders.ashx"
+        assert !APICommand.CopyFolders.is_secure?
+    end
+    
+    def test_MoveFolders
+        assert APICommand.MoveFolders.command_path == "IMFS/MoveFolders.ashx"
+        assert !APICommand.MoveFolders.is_secure?
+    end
+    
+    def test_CopyFiles
+        assert APICommand.CopyFiles.command_path == "IMFS/CopyFiles.ashx"
+        assert !APICommand.CopyFiles.is_secure?
+    end
+    
+    def test_MoveFiles
+        assert APICommand.MoveFiles.command_path == "IMFS/MoveFiles.ashx"
+        assert !APICommand.MoveFiles.is_secure?
+    end
+    
+    def test_RenameFolder
+        assert APICommand.RenameFolder.command_path == "IMFS/RenameFolder.ashx"
+        assert !APICommand.RenameFolder.is_secure?
+    end
+    
+    def test_RenameFile
+        assert APICommand.RenameFile.command_path == "IMFS/RenameFile.ashx"
+        assert !APICommand.RenameFile.is_secure?
+    end
+        
+    def test_DeleteFiles
+        assert APICommand.DeleteFiles.command_path == "IMFS/DeleteFiles.ashx"
+        assert !APICommand.DeleteFiles.is_secure?
+    end
+    
+    def test_GetDownloadNodes
+        assert APICommand.GetDownloadNodes.command_path == "IMFS/GetDownloadNodes.ashx"
+        assert !APICommand.GetDownloadNodes.is_secure?
+    end
+
+    def test_GetUploadNode
+        assert APICommand.GetUploadNode.command_path == "IMFS/GetUploadNode.ashx"
+        assert !APICommand.GetUploadNode.is_secure?
+    end
+    
+    
+    # MetaData Namespace
+    def test_DeleteAllMetadata
+        assert APICommand.DeleteAllMetadata.command_path == "Metadata/DeleteAllMetadata.ashx"
+        assert !APICommand.DeleteAllMetadata.is_secure?
+    end
+
+    def test_DeleteAllTags
+        assert APICommand.DeleteAllTags.command_path == "Metadata/DeleteAllTags.ashx"
+        assert !APICommand.DeleteAllTags.is_secure?
+    end
+
+    def test_DeleteMetadata
+        assert APICommand.DeleteMetadata.command_path == "Metadata/DeleteMetadata.ashx"
+        assert !APICommand.DeleteMetadata.is_secure?
+    end
+
+    def test_DeleteTags
+        assert APICommand.DeleteTags.command_path == "Metadata/DeleteTags.ashx"
+        assert !APICommand.DeleteTags.is_secure?
+    end
+
+    def test_GetMetadata
+        assert APICommand.GetMetadata.command_path == "Metadata/GetMetadata.ashx"
+        assert !APICommand.GetMetadata.is_secure?
+    end
+
+    def test_GetTags
+        assert APICommand.GetTags.command_path == "Metadata/GetTags.ashx"
+        assert !APICommand.GetTags.is_secure?
+    end
+
+    def test_SetMetadata
+        assert APICommand.SetMetadata.command_path == "Metadata/SetMetadata.ashx"
+        assert !APICommand.SetMetadata.is_secure?
+    end
+
+    def test_SetTags
+        assert APICommand.SetTags.command_path == "Metadata/SetTags.ashx"
+        assert !APICommand.SetTags.is_secure?
+    end
+
+    # Sharing Namespace
+    def test_CreateHostedItem
+        assert APICommand.CreateHostedItem.command_path == "Sharing/CreateHostedItem.ashx"
+        assert !APICommand.CreateHostedItem.is_secure?
+    end
+
+    def test_RemoveHostedItem
+        assert APICommand.RemoveHostedItem.command_path == "Sharing/RemoveHostedItem.ashx"
+        assert !APICommand.RemoveHostedItem.is_secure?
+    end
+
+    def test_ListHostedItems
+        assert APICommand.ListHostedItems.command_path == "Sharing/ListHostedItems.ashx"
+        assert !APICommand.ListHostedItems.is_secure?
+    end
+
+    # Accounting Namespace
+    def test_CreateChildAccount
+        assert APICommand.CreateChildAccount.command_path == "Accounting/CreateChildAccount.ashx"
+        assert !APICommand.CreateChildAccount.is_secure?
+    end    
+
+    def test_DeleteChildAccount
+        assert APICommand.DeleteChildAccount.command_path == "Accounting/DeleteChildAccount.ashx"
+        assert !APICommand.DeleteChildAccount.is_secure?
+    end    
+
+    def test_GetAccountInfo
+        assert APICommand.GetAccountInfo.command_path == "Accounting/GetAccountInfo.ashx"
+        assert !APICommand.GetAccountInfo.is_secure?
+    end    
+
+    def test_GetAccountNotes
+        assert APICommand.GetAccountNotes.command_path == "Accounting/GetAccountNotes.ashx"
+        assert !APICommand.GetAccountNotes.is_secure?
+    end    
+
+    def test_GetAccountLimits
+        assert APICommand.GetAccountLimits.command_path == "Accounting/GetAccountLimits.ashx"
+        assert !APICommand.GetAccountLimits.is_secure?
+    end    
+
+    def test_GetAccountUsage
+        assert APICommand.GetAccountUsage.command_path == "Accounting/GetAccountUsage.ashx"
+        assert !APICommand.GetAccountUsage.is_secure?
+    end    
+
+    def test_SetAccountInfo
+        assert APICommand.SetAccountInfo.command_path == "Accounting/SetAccountInfo.ashx"
+        assert !APICommand.SetAccountInfo.is_secure?
+    end    
+
+    def test_SetAccountLimits
+        assert APICommand.SetAccountLimits.command_path == "Accounting/SetAccountLimits.ashx"
+        assert !APICommand.SetAccountLimits.is_secure?
+    end    
+
+    def test_SetAccountNotes
+        assert APICommand.SetAccountNotes.command_path == "Accounting/SetAccountNotes.ashx"
+        assert !APICommand.SetAccountNotes.is_secure?
+    end    
+
+end

data/tests/apiparamtest.rb

@@ -0,0 +1,24 @@
+# command test
+
+require 'test/unit'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'nvx/sds/apiparam'
+
+class APIParamTest < Test::Unit::TestCase
+    include NVX::SDS
+    
+    def test_key
+        assert APIParam.new("key", "value").key == "key"
+        assert APIParam.new("key", "value").key != "notkey"
+    end
+    
+    def test_value
+        assert APIParam.new("key", "value").value == "value"
+        assert APIParam.new("key", "value").value != "notvalue"
+    end
+    
+    def test_to_s
+        assert APIParam.new("key", "value").to_s == "key=value"
+        assert APIParam.new("key", "?value").to_s == "key=%3Fvalue"
+    end
+end

data/tests/countriestest.rb

@@ -0,0 +1,20 @@
+# countries test
+
+require 'test/unit'
+$:.unshift File.dirname(__FILE__) + '/../lib/nvx/sds/'
+require 'countries'
+
+class CountriesTest < Test::Unit::TestCase
+    include NVX::SDS
+
+    def test_Countries
+        # display all of the countries
+        Countries.country_list.each do |country|
+            print country.to_s + "\r\n"
+        end
+        # verify one entry is the correct index
+        assert Countries.country_list["United States"] == 1
+        # verify the count
+        assert Countries.country_list.size == 244
+    end
+end

data/tests/foldertest.rb

@@ -0,0 +1,26 @@
+# folder test
+
+require 'test/unit'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'nvx/sds/folder'
+require 'nvx/sds/session'
+require 'REXML/Document'
+include REXML
+require File.dirname(__FILE__) + '/testconfig'
+
+class FolderTest < Test::Unit::TestCase
+    include NVX::SDS
+
+    Newline = "\r\n"
+    
+    def test_Folder
+        
+        session = Session.new(APP_KEY, USERNAME, APP_NAME, PASSWORD)
+        #page_number, page_size, folder_sort_code, should_sort_descending)
+        root_folder = session.GetRootFolder(1, 500, "Name", true)
+        print "total_folder_count" + root_folder.total_folder_count.to_s
+        assert root_folder.total_folder_count == 5
+    end
+    
+    
+end