module Ohmage::API::User

Public Instance Methods

user_create(params = {}) click to toggle source

ohmage user/create call @see github.com/ohmage/server/wiki/User-Manipulation#userCreate @returns [Object: Ohmage::User]

# File lib/ohmage/user.rb, line 33
def user_create(params = {})
  request = Ohmage::Request.new(self, :post, 'user/create', params)
  request.perform
  user_read(user_list: params[:username])
end
user_delete(params = {}) click to toggle source
# File lib/ohmage/user.rb, line 58
def user_delete(params = {})
  request = Ohmage::Request.new(self, :post, 'user/delete', params)
  request.perform
end
user_info_read() click to toggle source

ohmage user_info/read call @see github.com/ohmage/server/wiki/User-Manipulation#userInfoRead @returns Object: detailed list of classes/campaign current user can access

# File lib/ohmage/user.rb, line 23
def user_info_read
  request = Ohmage::Request.new(self, :post, 'user_info/read', {})
  Ohmage::User.new(request.perform[:data])
end
user_password(params = {}) click to toggle source
# File lib/ohmage/user.rb, line 50
def user_password(params = {}) # is this method name odd?
  # this api call demands current user's info.
  params[:user] = user
  params[:password] = password
  request = Ohmage::Request.new(self, :post, 'user/change_password', params)
  request.perform
end
user_read(params = {}) click to toggle source

ohmage user/read call @see github.com/ohmage/server/wiki/User-Manipulation#userRead @returns [Array: Ohmage::User objects] that match param criteria

# File lib/ohmage/user.rb, line 9
def user_read(params = {})
  request = Ohmage::Request.new(self, :post, 'user/read', params)
  t = []
  request.perform[:data].each do |k, v|
    t << Ohmage::User.new(k => v)
  end
  t
end
user_setup(params = {}) click to toggle source

ohmage user/setup call @see github.com/ohmage/server/wiki/User-Manipulation#userSetup @returns Hash with username and password param.

# File lib/ohmage/user.rb, line 68
def user_setup(params = {})
  # server bug returns empty page if user setup disabled.
  return false unless server_config[:user_setup_enabled]
  request = Ohmage::Request.new(self, :post, 'user/setup', params)
  request.perform
end
user_update(params = {}) click to toggle source

ohmage user/update call @see github.com/ohmage/server/wiki/User-Manipulation#userUpdate @returns [Object: Ohmage::User]

# File lib/ohmage/user.rb, line 44
def user_update(params = {})
  request = Ohmage::Request.new(self, :post, 'user/update', params)
  request.perform
  user_read(user_list: params[:username])
end