class Assembla::Client::Users::Keys

Constants

VALID_KEY_PARAM_NAMES
VALID_REQUEST_PARAM_VALUES

Public Instance Methods

all(*args)
Alias for: list
create(*args) click to toggle source

Create a public key for the authenticated user

@param [Hash] params @option [String] :title

Required string

@option [String] :key

Required string. sha key

@example

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.create ssh_key: {title: "buildbot@mac", key: "ssh-rsa AAA..."}

@api public

# File lib/assembla_api/client/users/keys.rb, line 55
def create(*args)
  arguments(args) do
    permit VALID_KEY_PARAM_NAMES, recursive: true
    assert_values VALID_REQUEST_PARAM_VALUES
  end
  post_request("/user/ssh_keys", arguments.params)
end
delete(*args) click to toggle source

Delete a public key for the authenticated user

@example

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.delete 571

@api public

# File lib/assembla_api/client/users/keys.rb, line 92
def delete(*args)
  arguments(args, required: [:id])
  delete_request("/user/ssh_keys/#{arguments.id}", arguments.params)
end
edit(*args) click to toggle source

Update a public key for the authenticated user

@param [Hash] params @option [String] :title

Required string

@option [String] :key

Required string. sha key

@example

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.update 571, "title": "buildbot@mac",
  "key": "ssh-rsa AAA..."

@api public

# File lib/assembla_api/client/users/keys.rb, line 77
def edit(*args)
  arguments(args, required: [:id]) do
    permit VALID_KEY_PARAM_NAMES, recursive: true
    assert_values VALID_REQUEST_PARAM_VALUES
  end
  put_request("/user/ssh_keys/#{arguments.id}", arguments.params)
end
find(*args)
Alias for: get
get(*args) click to toggle source

Get a single pulic key for the authenticated user

@example

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.get 571

@api public

# File lib/assembla_api/client/users/keys.rb, line 36
def get(*args)
  arguments(args, required: [:id])
  get_request("/user/ssh_keys/#{arguments.id}", arguments.params)
end
Also aliased as: find
list(*args) { |el| ... } click to toggle source

List public keys for the authenticated user

@example

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.list
assembla.users.keys.list { |key| ... }

@return [Hash]

@api public

# File lib/assembla_api/client/users/keys.rb, line 21
def list(*args)
  params = arguments(args).params
  response = get_request("/user/ssh_keys", params)
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all