class OEHClient::Config::Space

Attributes

api_key[RW]

————- Attributes

host[RW]

————- Attributes

meta_password[RW]

————- Attributes

shared_secret[RW]

————- Attributes

site_key[RW]

————- Attributes

username[RW]

————- Attributes

workspace[RW]

————- Attributes

Public Class Methods

create(properties={}) click to toggle source

create builds a new instance of the Site class, populats the attributes using the properties HASH provided

and returns an instance of the class.
# File lib/oehclient/config/space.rb, line 30
def self.create(properties={})

        # create a new instance of the OHEClient::Space class
        space_instance = OEHClient::Config::Space.new()

        # assign all attributes from the passed properties hash
        space_instance.site_key               = properties[:site_key]                     if (properties.has_key?(:site_key))
        space_instance.host                   = properties[:host]                            if (properties.has_key?(:host))
        space_instance.api_key                        = properties[:api_key]                      if (properties.has_key?(:api_key))
        space_instance.shared_secret  = properties[:shared_secret]    if (properties.has_key?(:shared_secret))
        space_instance.username                       = properties[:username]                     if (properties.has_key?(:username))
        space_instance.meta_password  = properties[:meta_password]    if (properties.has_key?(:meta_password))

        # return the instance of the OEHClient::Site Class
        space_instance

end

Public Instance Methods

get_workspace() click to toggle source

retrieve the workspace meta-data object from the thinstance in realtime

# File lib/oehclient/config/space.rb, line 107
def get_workspace()
        # create an active session with ONE
        workspace = OEHClient::Meta::Session.attach(self).workspace(site_key)         if (workspace.nil?)
        # return the active workspace object
        workspace
end
is_valid?() click to toggle source

is_valid determines if the current class has values for all the attributes. Each attribute is required with a non-nul / non-blank value to be considered valid

# File lib/oehclient/config/space.rb, line 80
def is_valid?()
        ((!@site_key.nil? && !@site_key.empty?) && (!@host.nil? && !@host.empty?) && 
        (!@api_key.nil? && !@api_key.empty?) && (!@shared_secret.nil? && !@shared_secret.empty?) && 
        (!@username.nil? && !@username.empty?))
end
login_url() click to toggle source

return the URL for the posting a login request

# File lib/oehclient/config/space.rb, line 98
def login_url()
        "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}/one/idm_login"
end
logout_url() click to toggle source

return the URL for posting a logout request

# File lib/oehclient/config/space.rb, line 102
def logout_url()
        "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}/one/logout"
end
meta_access?() click to toggle source

determines if the space configuration appears to be valid for access to the raw meta-data entities. The method expects the standard valid attributes from is_valid? as well as the meta_password attribute

# File lib/oehclient/config/space.rb, line 89
def meta_access?()
        self.is_valid? && (!@meta_password.blank?)
end
meta_credentials() click to toggle source

return the hash that

# File lib/oehclient/config/space.rb, line 94
def meta_credentials()
        {:username => @username, :password => @meta_password, :rememberMe => "false"}
end
oauth_consumer() click to toggle source

return a new instance of the OAuth::Consumer using the details of the space

# File lib/oehclient/config/space.rb, line 71
def oauth_consumer()
        OAuth::Consumer.new("#{@api_key}!#{@username}", 
                                                                                @shared_secret,
                                                                                {:site => "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}",
                                                                                        :scheme => :header})
end
token() click to toggle source

token is the method used to generate a new OAuth::AccessToken object based on the configuration of

the related space
# File lib/oehclient/config/space.rb, line 56
def token()

        # raise the OEHClient::InvalidSpaceException the current instance is not valid
        raise OEHClient::Exception::InvalidSpaceConfigException unless is_valid?
        
        # Create the consumer and access token
        oauth_consumer = OAuth::Consumer.new("#{@api_key}!#{@username}", 
                                                                                @shared_secret,
                                                                                {:site => "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}",
                                                                                        :scheme => :header})
        # return the access token
        return(OAuth::AccessToken.new(oauth_consumer))

end