class Sorcery::Providers::Jira

This class adds support for OAuth with Jira

config.jira.key = <key>
config.jira.secret = <secret>
...

Attributes

access_token_path[RW]
authorize_path[RW]
callback_url[RW]
private_key_file[RW]
request_token_path[RW]
signature_method[RW]
site[RW]
user_info_path[RW]

Public Class Methods

new() click to toggle source
# File lib/sorcery/providers/jira.rb, line 15
def initialize
  @configuration = {
    authorize_path: '/authorize',
    request_token_path: '/request-token',
    access_token_path: '/access-token'
  }
  @user_info_path = '/users/me'
end

Public Instance Methods

get_consumer() click to toggle source

Override included get_consumer method to provide authorize_path read extra configurations

# File lib/sorcery/providers/jira.rb, line 26
def get_consumer
  @configuration = @configuration.merge(site: site,
                                        signature_method: signature_method,
                                        consumer_key: key,
                                        private_key_file: private_key_file)
  ::OAuth::Consumer.new(@key, @secret, @configuration)
end
get_user_hash(access_token) click to toggle source
# File lib/sorcery/providers/jira.rb, line 34
def get_user_hash(access_token)
  response = access_token.get(user_info_path)

  auth_hash(access_token).tap do |h|
    h[:user_info] = JSON.parse(response.body)['users'].first
    h[:uid] = user_hash[:user_info]['id'].to_s
  end
end
login_url(_params, session) click to toggle source

calculates and returns the url to which the user should be redirected, to get authenticated at the external provider's site.

# File lib/sorcery/providers/jira.rb, line 45
def login_url(_params, session)
  req_token = get_request_token
  session[:request_token]         = req_token.token
  session[:request_token_secret]  = req_token.secret

  # it was like that -> redirect_to authorize_url({ request_token: req_token.token, request_token_secret: req_token.secret })
  # for some reason Jira does not need these parameters

  get_request_token(
    session[:request_token],
    session[:request_token_secret]
  ).authorize_url
end
process_callback(params, session) click to toggle source

tries to login the user from access token

# File lib/sorcery/providers/jira.rb, line 60
def process_callback(params, session)
  args = {
    oauth_verifier:       params[:oauth_verifier],
    request_token:        session[:request_token],
    request_token_secret: session[:request_token_secret]
  }

  args[:code] = params[:code] if params[:code]
  get_access_token(args)
end