Class: AccountTokenController

Inherits:
ApplicationController show all
Defined in:
app/controllers/account_token_controller.rb

Overview

This class defines the API methods related to account_token management

Instance Method Summary (collapse)

Instance Method Details

- (Object) create

Creates a new account token for the specified user

Restricted to: authenticated user, admin

Return values:

  • On success: 201 CREATED => account_token

  • On failure:

    • 404 NOT FOUND => false (no such user)

    • 422 UNPROCESSABLE ENTITY => false (bad parameters)

POST Params:

  • account_token:

    • label: label for the account token (string, length <= 255)

  • auth_token: time-based token generated (string, length == 8)

URL Params:

  • <login>: the user the account token will be created for

  • <format>: the output format wanted

Query URLs:

  • POST /users/<login>/account_token

  • POST /users/<login>/account_token.<format>



81
82
83
84
85
86
87
 
# File 'app/controllers/account_token_controller.rb', line 81

def create
   = @user..create(params[:account_token])
  success = .save
  @response.body = success ?  : .errors
  @response.status = success ? :created : :unprocessable_entity
  respond
end

- (Object) destroy

Deletes (revokes) the specified account token for the specified user

Restricted to: authenticated user, admin

Return values:

  • On success: 200 OK => true

  • On failure: 404 NOT FOUND => false (token not belonging to specified user, no such user or no such token)

URL params:

  • <login>: the user the account token belongs to

  • <token_id>: the account_token id

  • <format>: the output format wanted

DELETE params:

  • auth_token: time-based token generated (string, length == 8)

Query URLs:

  • DELETE /users/<login>/account_token/<token_id>

  • DELETE /users/<login>/account_token/<token_id>.<format>



142
143
144
145
146
147
148
 
# File 'app/controllers/account_token_controller.rb', line 142

def destroy
  success = !@account_token.nil?
  @response.body = success ? true : false
  @response.status = success ? :ok : :not_found
  @account_token.revoke unless !success
  respond
end

- (Object) get_account_token 



150
151
152
 
# File 'app/controllers/account_token_controller.rb', line 150

def 
  @account_token = @user..active.find_by_id params[:id]
end

- (Object) index

Lists all the user's account tokens

Restricted to: authenticated user, admin

Return values;

  • On success: 200 OK => account tokens

  • On failure: 404 NOT FOUND => false (no such user)

URL params:

  • <login>: the user the account token belongs to

  • <format>: the output format wanted

GET params:

  • auth_token: time-based token generated (string, length == 8)

Query URLs:

  • GET /users/<login>/account_token

  • GET /users/<login>/account_token.<format>



26
27
28
29
30
31
 
# File 'app/controllers/account_token_controller.rb', line 26

def index
  success = !@user.nil?
  @response.status = success ? :ok : :not_found
  @response.body = success ? @user. : false
  respond
end

- (Object) show

Gets the account token information

Restricted to: authenticated user, admin

Return values

  • On success: 200 OK => @account_token

  • On failure: 404 NOT FOUND => false (no such account token, or account_token not belonging to specified user)

URL params:

  • <login>: the user the account token belongs to

  • <token_id>: the account_token id

  • <format>: the output format wanted

GET params:

  • auth_token: time-based token generated (string, length == 8)

Query URLs:

  • GET /users/<login>/account_token/<token_id>

  • GET /users/<login>/account_token/<token_id>.<format>



52
53
54
55
56
57
 
# File 'app/controllers/account_token_controller.rb', line 52

def show
  success = !@account_token.nil?
  @response.body = success ? @account_token : false
  @response.status = success ? :ok : :not_found
  respond
end

- (Object) update

Creates a new account token for the specified user

Restricted to: authenticated user, admin

Return values:

  • On success: 201 CREATED => account_token

  • On failure:

    • 404 NOT FOUND => false (no such user)

    • 422 UNPROCESSABLE ENTITY => false (bad parameters)

PUT Params:

  • account_token:

    • label: label for the account token (string, length <= 255)

  • auth_token: time-based token generated (string, length == 8)

URL Params:

  • <login>: the user the account token will be created for

  • <format>: the output format wanted

Query URLs:

  • PUT /users/<login>/account_token

  • PUT /users/<login>/account_token.<format>



111
112
113
114
115
116
117
118
119
120
121
 
# File 'app/controllers/account_token_controller.rb', line 111

def update
  if @account_token.nil?
    @response.body = false
    @response.status = :not_found
  else
    success = @account_token.update_attributes(params[:account_token])
    @response.body = success ? @account_token : @account_token.errors
    @response.status = success ? :ok : :unprocessable_entity
  end
  respond
end