nvx-sds 0.0.1

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

@@ -0,0 +1,52 @@
+# The SoapUpload file is used to upload a file to Nirvanix in parts using SOAP.
+#
+# == Usage
+# session = Session.new("APP-KEY", "USERNAME", "APP NAME", "PASSWORD")
+#
+# SoapUpload.UploadFile("/path/RemoteFilename.txt","C:\\localfile.txt", session.account_login)
+module NVX
+    module SDS
+        
+        require 'transport'
+        require 'apicommand'
+        require 'apiparam'
+        require 'soap/defaultDriver'
+        require 'base64'
+        
+        # The SoapTransfer class is used for upload.  Since this method doesnt have a specific
+        # file size limit other than the 256gb max file size limit this method is used instead of
+        # the http upload which is limited to 2gb.  This is due to the 
+        class SoapUpload
+
+            # Uploads a file in parts at a using a buffer of 65k.
+            #
+            # == Usage
+            # session = Session.new("APP-KEY", "USERNAME", "APP NAME", "PASSWORD")
+            #
+            # SoapUpload.UploadFile("/path/RemoteFilename.txt","C:\\localfile.txt", session.account_login)
+            def SoapUpload.UploadFile(path, local_path, account_login)
+                # Get the Upload node passing in the total file size.
+                result = Transport.execute_command_post(APICommand.GetUploadNode, [APIParam.new("sizeBytes", "1000")], account_login)
+
+                # extract the upload token, host name and build a new transfer object.
+                upload_token = result.root.elements["//AccessToken"].get_text.value
+                node = result.root.elements["//IPAddress"].get_text.value
+                # set the URL based on the node that was returned from Nirvanix.
+                soap = NVX::SDS::SOAP::TransferSoap.new("http://#{node}/ws/transfer.asmx")
+                
+                # Open the local file
+                file = File.open(local_path, "rb")
+                # Loop through the entire file uploading each file part.
+                while !file.eof?
+                    # Send a 65k file part to Nirvanix using the upload token.
+                    params = NVX::SDS::SOAP::AppendFile.new(upload_token, path, Base64.encode64(file.read(65536)), false)
+                    soap.appendFile(params)
+                end
+                # Send an empty data with a True for last packet, this finalizes the upload and will
+                # make the file available for download.
+                params = NVX::SDS::SOAP::AppendFile.new(upload_token, path, nil, true)
+                soap.appendFile(params)
+            end
+        end
+    end
+end

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

@@ -0,0 +1,97 @@
+# = Overview
+#
+# The utilities file contains a utilites class that has several static methods for formatting and other routine operations
+# such as getting download URLs and Getting and settign generic information that requires special formatting.
+module NVX
+    module SDS
+        
+        $:.unshift File.dirname(__FILE__)
+        require 'transport'
+        require 'apicommand'
+        require 'apiparam'
+        require 'accountinfo'
+        require 'accountlimit'
+        require 'accountfeatureusage'
+
+        # The utilites class has several static methods for formatting and other routine operations such as 
+        # getting download URLs and Getting and settign generic information that requires special formatting.
+        class Utilities
+            # Gets a download url for either hosted or session based downloads.  This will output a url in the format of
+            # http://downloadnode.nirvanix.com/sessiontoken/appname/username/path/file.txt or 
+            # http://downloadnode.nirvanix.com/appname/username/path/file.txt
+            def Utilities.GetDownloadUrl(account_login, path, include_session = true)
+                doc = Transport.execute_command_post(APICommand.GetDownloadNodes, [APIParam.new("filePath", path)], account_login)
+                
+                url = "http://" + doc.root.elements["//Response/DownloadNode"].get_text.value + "/"
+                url += account_login.session_token + "/" if include_session
+                url += account_login.app_name + "/" + account_login.username + "/"
+                url += path.to_s.split("/").last
+                return url
+            end
+            
+            # Returns the account information in an accountInfo object.
+            def Utilities.GetAccountInfo(account_login, username)
+                doc = Transport.execute_command_post(APICommand.GetAccountInfo, [APIParam.new("username", username)], account_login)
+                return AccountInfo.new(doc)
+            end
+
+            # Gets account limits extracting each limit and creating a new AccountLimit object to contain each.
+            def Utilities.GetAccountLimits(account_login, username)
+                doc = Transport.execute_command_post(APICommand.GetAccountLimits, [APIParam.new("username", username)], account_login)
+                
+                accountlimits = Array.new
+
+                #if there is any metadata loop through
+                if doc.root.elements["//Response/Limits"]
+                    doc.root.elements.each("//Response/Limits") do |limit|
+                        #add to the array the type and value of each in the xml.
+                        accountlimits << AccountLimit.new(limit.elements["Type"][0].to_s, limit.elements["Value"][0].to_s)
+                    end
+                end
+                return accountlimits
+            end
+
+            # Gets account usage extracting each usage type and creating a new AccountFeatureUsage object to contain each.
+            def Utilities.GetAccountUsage(account_login, username)
+                doc = Transport.execute_command_post(APICommand.GetAccountUsage, [APIParam.new("username", username)], account_login)
+                
+                features = Array.new
+
+                #if there is any metadata loop through
+                if doc.root.elements["//Response/GetUsage"]
+                    doc.root.elements.each("//Response/GetUsage") do |feature|
+                        features << AccountFeatureUsage.new(feature)
+                    end
+                end
+
+                return features
+            end
+            
+            # Sets the account info for a child or parent.
+            def Utilities.SetAccountInfo(account_login, username, first_name, last_name, 
+                    middle_initial, phone_number, email_address, email_format, address_line1, address_line2, 
+                    city, state, country, postal_code)
+
+                email_format = email_format.nil? ? "TEXT" : email_format
+                country = country.nil? ? "1" : country
+                
+                params = Array.new
+                params << APIParam.new("username", username)
+                params << APIParam.new("emailFormat", email_format)
+                params << APIParam.new("firstName", first_name) if !first_name.nil?
+                params << APIParam.new("lastName", last_name) if !last_name.nil?
+                params << APIParam.new("middleInitial", middle_initial) if !middle_initial.nil?
+                params << APIParam.new("phoneNumber", phone_number) if !phone_number.nil?
+                params << APIParam.new("emailAddress", email_address) if !email_address.nil?
+                params << APIParam.new("addressLine1", address_line1) if !address_line1.nil?
+                params << APIParam.new("addressLine2", address_line2) if !address_line2.nil?
+                params << APIParam.new("city", city) if !city.nil?
+                params << APIParam.new("state", state) if !state.nil?
+                params << APIParam.new("country", country) if !country.nil?
+                params << APIParam.new("postalCode", postal_code) if !postal_code.nil?
+                    
+                Transport.execute_command_post(APICommand.SetAccountInfo, params, account_login)
+            end
+        end
+    end
+end

data/lib/nvx/sds/SOAP/TransferClient.rb

@@ -0,0 +1,68 @@
+# This file is generated by Soap2wsdl.  It was left in the Gem intentionally
+# to show example usage of the soap interfaces of the transfer namespace.
+
+#!/usr/bin/env ruby
+require 'defaultDriver.rb'
+
+endpoint_url = ARGV.shift
+obj = TransferSoap.new(endpoint_url)
+
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+# SYNOPSIS
+#   UploadFile(parameters)
+#
+# ARGS
+#   parameters      UploadFile - {http://transfer.nirvanix.com/ws/Transfer}UploadFile
+#
+# RETURNS
+#   parameters      UploadFileResponse - {http://transfer.nirvanix.com/ws/Transfer}UploadFileResponse
+#
+parameters = nil
+puts obj.uploadFile(parameters)
+
+# SYNOPSIS
+#   AppendFile(parameters)
+#
+# ARGS
+#   parameters      AppendFile - {http://transfer.nirvanix.com/ws/Transfer}AppendFile
+#
+# RETURNS
+#   parameters      AppendFileResponse - {http://transfer.nirvanix.com/ws/Transfer}AppendFileResponse
+#
+parameters = nil
+puts obj.appendFile(parameters)
+
+
+endpoint_url = ARGV.shift
+obj = TransferSoap.new(endpoint_url)
+
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+# SYNOPSIS
+#   UploadFile(parameters)
+#
+# ARGS
+#   parameters      UploadFile - {http://transfer.nirvanix.com/ws/Transfer}UploadFile
+#
+# RETURNS
+#   parameters      UploadFileResponse - {http://transfer.nirvanix.com/ws/Transfer}UploadFileResponse
+#
+parameters = nil
+puts obj.uploadFile(parameters)
+
+# SYNOPSIS
+#   AppendFile(parameters)
+#
+# ARGS
+#   parameters      AppendFile - {http://transfer.nirvanix.com/ws/Transfer}AppendFile
+#
+# RETURNS
+#   parameters      AppendFileResponse - {http://transfer.nirvanix.com/ws/Transfer}AppendFileResponse
+#
+parameters = nil
+puts obj.appendFile(parameters)
+
+

data/lib/nvx/sds/SOAP/default.rb

@@ -0,0 +1,80 @@
+# <b>This is a wrapper for the SOAP driver created with Soap2wsdl
+# Please see the documentation for SoapUpload for usage and an upload
+# example.</b>
+
+module NVX
+    module SDS
+        module SOAP
+            
+            require 'xsd/qname'
+            
+            # <b>This is a wrapper class for the SOAP driver created with Soap2wsdl
+            # Please see the documentation for SoapUpload for usage and an upload
+            # example.</b>
+            class UploadFile
+              @@schema_type = "UploadFile"
+              @@schema_ns = "http://transfer.nirvanix.com/ws/Transfer"
+              @@schema_qualified = "true"
+              @@schema_element = [["uploadToken", "SOAP::SOAPString"], ["path", "SOAP::SOAPString"], ["fileData", "SOAP::SOAPBase64"]]
+            
+              attr_accessor :uploadToken
+              attr_accessor :path
+              attr_accessor :fileData
+            
+              def initialize(uploadToken = nil, path = nil, fileData = nil)
+                @uploadToken = uploadToken
+                @path = path
+                @fileData = fileData
+              end
+            end
+            
+            # <b>This is a wrapper class for the SOAP driver created with Soap2wsdl
+            # Please see the documentation for SoapUpload for usage and an upload
+            # example.</b>
+            class UploadFileResponse
+              @@schema_type = "UploadFileResponse"
+              @@schema_ns = "http://transfer.nirvanix.com/ws/Transfer"
+              @@schema_qualified = "true"
+              @@schema_element = []
+            
+              def initialize
+              end
+            end
+            
+            # <b>This is a wrapper class for the SOAP driver created with Soap2wsdl
+            # Please see the documentation for SoapUpload for usage and an upload
+            # example.</b>
+            class AppendFile
+              @@schema_type = "AppendFile"
+              @@schema_ns = "http://transfer.nirvanix.com/ws/Transfer"
+              @@schema_qualified = "true"
+              @@schema_element = [["uploadToken", "SOAP::SOAPString"], ["path", "SOAP::SOAPString"], ["fileData", "SOAP::SOAPBase64"], ["endOfFile", "SOAP::SOAPBoolean"]]
+            
+              attr_accessor :uploadToken
+              attr_accessor :path
+              attr_accessor :fileData
+              attr_accessor :endOfFile
+            
+              def initialize(uploadToken = nil, path = nil, fileData = nil, endOfFile = nil)
+                @uploadToken = uploadToken
+                @path = path
+                @fileData = fileData
+                @endOfFile = endOfFile
+              end
+            end
+            
+            # <b>This is a wrapper class for the SOAP driver created with Soap2wsdl
+            # Please see the documentation for SoapUpload for usage and an upload
+            # example.</b>
+            class AppendFileResponse
+              @@schema_type = "AppendFileResponse"
+              @@schema_ns = "http://transfer.nirvanix.com/ws/Transfer"
+              @@schema_qualified = "true"
+              @@schema_element = []
+            
+              def initialize
+              end
+            end
+        end
+    end
+end

data/lib/nvx/sds/SOAP/defaultDriver.rb

@@ -0,0 +1,70 @@
+# <b>This is a wrapper for the SOAP driver created with Soap2wsdl
+# Please see the documentation for SoapUpload for usage and an upload
+# example.</b>
+
+module NVX
+    module SDS
+        module SOAP
+            
+            $:.unshift File.dirname(__FILE__)
+            require 'default.rb'
+            
+            require 'soap/rpc/driver'
+            
+            # <b>This is a wrapper class for the SOAP driver created with Soap2wsdl
+            # Please see the documentation for SoapUpload for usage and an upload
+            # example.</b>
+            class TransferSoap < ::SOAP::RPC::Driver
+              protected
+              
+              DefaultEndpointUrl = "http://node1.nirvanix.com/ws/transfer.asmx"
+              MappingRegistry = ::SOAP::Mapping::Registry.new
+            
+              Methods = [
+                [ "http://transfer.nirvanix.com/ws/Transfer/UploadFile",
+                  "uploadFile",
+                  [ ["in", "parameters", ["::SOAP::SOAPElement", "http://transfer.nirvanix.com/ws/Transfer", "UploadFile"], true],
+                    ["out", "parameters", ["::SOAP::SOAPElement", "http://transfer.nirvanix.com/ws/Transfer", "UploadFileResponse"], true] ],
+                  { :request_style =>  :document, :request_use =>  :literal,
+                    :response_style => :document, :response_use => :literal }
+                ],
+                [ "http://transfer.nirvanix.com/ws/Transfer/AppendFile",
+                  "appendFile",
+                  [ ["in", "parameters", ["::SOAP::SOAPElement", "http://transfer.nirvanix.com/ws/Transfer", "AppendFile"], true],
+                    ["out", "parameters", ["::SOAP::SOAPElement", "http://transfer.nirvanix.com/ws/Transfer", "AppendFileResponse"], true] ],
+                  { :request_style =>  :document, :request_use =>  :literal,
+                    :response_style => :document, :response_use => :literal }
+                ]
+              ]
+            
+              def initialize(endpoint_url = nil)
+                endpoint_url ||= DefaultEndpointUrl
+                super(endpoint_url, nil)
+                self.mapping_registry = MappingRegistry
+                init_methods
+              end
+            
+            private
+            
+              def init_methods
+                Methods.each do |definitions|
+                  opt = definitions.last
+                  if opt[:request_style] == :document
+                    add_document_operation(*definitions)
+                  else
+                    add_rpc_operation(*definitions)
+                    qname = definitions[0]
+                    name = definitions[2]
+                    if qname.name != name and qname.name.capitalize == name.capitalize
+                      ::SOAP::Mapping.define_singleton_method(self, qname.name) do |*arg|
+                        __send__(name, *arg)
+                      end
+                    end
+                  end
+                end
+              end
+            end
+        end
+    end
+end
+

data/lib/nvx/sds/accountlogin.rb

@@ -0,0 +1,68 @@
+# = Overview
+# The AccountLogin object is used to hold the session and application information
+# for a specific account.  The AccountLogin object is created from the session object.
+# it is used to store the current user information.
+
+module NVX
+    module SDS
+        $:.unshift File.dirname(__FILE__)
+        require 'transport'
+        require 'apicommand'
+        require 'apiparam'
+        
+        # = Overview
+        # The AccountLogin object is used to hold the session and application information
+        # for a specific account.  The AccountLogin object is created from the session object.
+        # it is used to store the current user information.
+        class AccountLogin
+            
+            # The initialize method is used to set the parameters being passed by the 
+            # session object.
+            def initialize(app_key, username, app_name, password = nil, session_token = nil)
+                @app_key, @username, @app_name = app_key, username, app_name
+                @password = password
+                @session_token = session_token 
+                @impersonation = !session_token.nil?
+            end
+            
+            # Current session token for the current logged in user.
+            def session_token
+               @session_token
+            end
+            
+            # Stores the currently logged in username
+            def username
+                @username
+            end
+            
+            # Sets the username
+            def username=(username)
+               @username=username
+            end
+
+            # Gets the current application key.
+            def app_key
+                @app_key                
+            end
+            
+            # Gets the current application name.
+            def app_name
+               @app_name
+            end
+
+            # Convenient function to get the root of the current application.
+            def root_path
+               @root_path = "//" + @app_name + "/" + @username; 
+            end
+
+            # The Login method signs the user in using the information passed in the initialize method.
+            def Login
+                if @impersonation
+                    raise "This account is impersonated and cannot be logged in."
+                end
+                result = Transport.execute_command_post(APICommand.Login, [APIParam.new("appKey", @app_key), APIParam.new("username", @username), APIParam.new("password", @password)], nil)
+                @session_token = result.root.elements["SessionToken"].get_text.value
+            end
+        end
+    end
+end