module Authentication

Public Instance Methods

any_authentication?() click to toggle source

@return [Boolean]

# File lib/wrapper/authentication.rb, line 26
def any_authentication?
  user_facing? or self_authenticating?
end

auth_params() click to toggle source

# File lib/wrapper/authentication.rb, line 5
def auth_params
  if self_authenticating?
    {:token => @user_token}
  else
    {}
  end
end

authenticate(request_token, verifier) click to toggle source

Retrieves an OAuth access token from the Discogs server. @!macro [new] request_token @!macro [new] verifier

@param request_token [OAuth::RequestToken] request token
@param verifier [String] verifier token

@return [OAuth::AccessToken]

# File lib/wrapper/authentication.rb, line 52
def authenticate(request_token, verifier)
  if request_token.is_a?(OAuth::RequestToken)
    @access_token = request_token.get_access_token(:oauth_verifier => verifier)
  else
    raise OAuth::Error, "Invalid Request Token"
  end
end

authenticated?(username=nil) { |: raise_authentication_error| ... } click to toggle source

Returns true if an OAuth access_token is present. If a username is given, the authenticated username must match it. @!macro [new] username

@param username [String] username

@return [Boolean]

# File lib/wrapper/authentication.rb, line 64
def authenticated?(username=nil, &block)
  auth = if username
    any_authentication? and authenticated_username == username
  else
    any_authentication?
  end

  if block_given?
    auth ? yield : raise_authentication_error
  else
    auth
  end
end

get_request_token(app_key, app_secret, callback) click to toggle source

Retrieves an OAuth request token from the Discogs server. @!macro [new] app_key @!macro [new] app_secret

@param app_key [String] application id
@param app_secret [String] application secret

@return [Hash] containing a :request_token that should be stored locally and a :authorize_url that the user must browse to.

# File lib/wrapper/authentication.rb, line 36
def get_request_token(app_key, app_secret, callback)
  consumer = OAuth::Consumer.new(app_key, app_secret,
               :authorize_url => "https://www.discogs.com/oauth/authorize",
               :site          => "https://api.discogs.com")
  request_token = consumer.get_request_token(:oauth_callback => callback)

  {:request_token => request_token,
   :authorize_url => request_token.authorize_url(:oauth_callback => callback)}
end

self_authenticating?() click to toggle source

Indicates whether this instance is self-authenticated. @return [Boolean]

# File lib/wrapper/authentication.rb, line 21
def self_authenticating?
  !!@user_token
end

user_facing?() click to toggle source

Indicates whether this instance is authenticated as a user-facing app. @return [Boolean]

# File lib/wrapper/authentication.rb, line 15
def user_facing?
  !!@access_token
end

Private Instance Methods

authenticated_username() click to toggle source

# File lib/wrapper/authentication.rb, line 80
def authenticated_username
  data = get_identity
  data.username
end