class RightSignature::Connection

Attributes

configuration[RW]
oauth_connection[RW]
token_connection[RW]

Public Class Methods

new(creds={}) click to toggle source

Creates new instance of RightSignature::Connection to make API calls

  • creds: Hash of credentials for API Token or OAuth. If both are specified, it uses API Token

    • Hash key for API Token:

      • :api_token

    • Hash keys for OAuth:

      • :consumer_key

      • :consumer_secret

      • :access_token

      • :access_secret

Example for Api Token:

@rs_connection = RightSignature::Connection.new(:api_token => "MYTOKEN")

Example for OAuth:

@rs_connection = RightSignature::Connection.new(:consumer_key => "ckey", :consumer_secret => "csecret", :access_token => "atoken", :access_secret => "asecret")
# File lib/rightsignature/connection.rb, line 27
def initialize(creds={})
  @configuration = {}
  RightSignature::Connection.oauth_keys.each do |key|
    @configuration[key] = creds[key].to_s
  end

  RightSignature::Connection.api_token_keys.each do |key|
    @configuration[key] = creds[key].to_s
  end

  @token_connection = RightSignature::TokenConnection.new(*RightSignature::Connection.api_token_keys.map{|k| @configuration[k]})
  @oauth_connection = RightSignature::OauthConnection.new(@configuration)

  @configuration
end

Public Instance Methods

check_credentials() click to toggle source

Checks if credentials are set for either API Token or for OAuth

# File lib/rightsignature/connection.rb, line 45
def check_credentials
  raise "Please set load_configuration with #{RightSignature::Connection.api_token_keys.join(',')} or #{RightSignature::Connection.oauth_keys.join(',')}" unless has_api_token? || has_oauth_credentials?
end
has_api_token?() click to toggle source

Checks if API Token credentials are set. Does not validate creds with server.

# File lib/rightsignature/connection.rb, line 51
def has_api_token?
  return false if @configuration.nil?
  RightSignature::Connection.api_token_keys.each do |key|
    return false if @configuration[key].nil? || @configuration[key].match(/^\s*$/)
  end

  return true
end
has_oauth_credentials?() click to toggle source

Checks if OAuth credentials are set. Does not validate creds with server.

# File lib/rightsignature/connection.rb, line 62
def has_oauth_credentials?
  return false if @configuration.nil?
  RightSignature::Connection.oauth_keys.each do |key| 
    return false if @configuration[key].nil? || @configuration[key].match(/^\s*$/)
  end

  return true
end