class GrabzIt::BaseOptions

@version 3.0 @author GrabzIt

Public Class Methods

new() click to toggle source

@!visibility private

# File lib/grabzit/baseoptions.rb, line 6
def initialize()
        @customId = nil
        @country = nil
        @exportURL = nil
        @encryptionKey = nil
        @delay = nil
        @post = nil
        @proxy = nil
end

Public Instance Methods

country() click to toggle source

@return [String] the country the capture should be created from.

# File lib/grabzit/baseoptions.rb, line 30
def country
        @country
end
country=(value) click to toggle source

Set the country the capture should be created from: Default = “”, Singapore = “SG”, UK = “UK”, US = “US”.

@param value [String] the country to use @return [void]

# File lib/grabzit/baseoptions.rb, line 38
def country=(value)
        @country = value
end
customId() click to toggle source

@return [String] the custom identifier that you can pass through to the web service.

# File lib/grabzit/baseoptions.rb, line 17
def customId
        @customId
end
customId=(value) click to toggle source

Set a custom identifier to pass to the web service. This will be returned with the callback URL you have specified.

@param value [String] the custom identifier @return [void]

# File lib/grabzit/baseoptions.rb, line 25
def customId=(value)
        @customId = value
end
encryptionKey() click to toggle source

@return [String] the encryption key that will be used to encrypt your capture.

# File lib/grabzit/baseoptions.rb, line 56
def encryptionKey
        @encryptionKey
end
encryptionKey=(value) click to toggle source

Set the encryption key that will be used to encrypt your capture.

@param value [String] encryption key to use @return [void]

# File lib/grabzit/baseoptions.rb, line 64
def encryptionKey=(value)
        @encryptionKey = value
end
exportURL() click to toggle source

@return [String] the export URL that should be used to transfer the capture to a third party location.

# File lib/grabzit/baseoptions.rb, line 43
def exportURL
        @exportURL
end
exportURL=(value) click to toggle source

Set the export URL that should be used to transfer the capture to a third party location.

@param value [String] export URL to use @return [void]

# File lib/grabzit/baseoptions.rb, line 51
def exportURL=(value)
        @exportURL = value
end
proxy() click to toggle source

@return [String] the HTTP proxy that should be used to create the capture.

# File lib/grabzit/baseoptions.rb, line 69
def proxy
        @proxy
end
proxy=(value) click to toggle source

Set the HTTP proxy that should be used to create the capture.

@param value [String] HTTP proxy to use @return [void]

# File lib/grabzit/baseoptions.rb, line 77
def proxy=(value)
        @proxy = value
end
startDelay() click to toggle source

@!visibility private

# File lib/grabzit/baseoptions.rb, line 82
def startDelay
        if @delay == nil
                return 0
        end
        return @delay
end

Protected Instance Methods

appendParameter(qs, name, value) click to toggle source
# File lib/grabzit/baseoptions.rb, line 90
def appendParameter(qs, name, value)
        val = ""
        if name != nil && name != ""
                val = CGI.escape(name)
                val += "="
                if value != nil && value != ""
                        val += CGI.escape(value)
                end
        end

        if val == ""
                return qs
        end
        if qs == nil
                qs = val
                return qs
        end
        
        qs += "&"
        qs += val
        return qs
end
createParameters(applicationKey, sig, callBackURL, dataName, dataValue) click to toggle source
# File lib/grabzit/baseoptions.rb, line 114
def createParameters(applicationKey, sig, callBackURL, dataName, dataValue)
        params = Hash.new
        params['key'] = GrabzIt::Utility.nil_check(applicationKey)
        params['country'] = GrabzIt::Utility.nil_check(@country)
        params['customid'] = GrabzIt::Utility.nil_check(@customId)
        params['callback'] = GrabzIt::Utility.nil_check(callBackURL)
        params['export'] = GrabzIt::Utility.nil_check(@exportURL)
        params['encryption'] = GrabzIt::Utility.nil_check(@encryptionKey)
        params['proxy'] = GrabzIt::Utility.nil_check(@proxy)
        params['sig'] = sig
        params[dataName] = GrabzIt::Utility.nil_check(dataValue)

        return params
end