Class: Assembla::Client::Users

Inherits:
API
  • Object
show all
Defined in:
lib/assembla_api/client/users.rb

Defined Under Namespace

Classes: Keys

Constant Summary collapse

VALID_USER_PARAMS_NAMES = 
%w[
].freeze

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Assembla::Constants

Assembla::Constants::ACCEPT, Assembla::Constants::ACCEPTED_OAUTH_SCOPES, Assembla::Constants::ACCEPT_CHARSET, Assembla::Constants::CACHE_CONTROL, Assembla::Constants::CONTENT_LENGTH, Assembla::Constants::CONTENT_TYPE, Assembla::Constants::DATE, Assembla::Constants::ETAG, Assembla::Constants::HEADER_LAST, Assembla::Constants::HEADER_LINK, Assembla::Constants::HEADER_NEXT, Assembla::Constants::LOCATION, Assembla::Constants::META_FIRST, Assembla::Constants::META_LAST, Assembla::Constants::META_NEXT, Assembla::Constants::META_PREV, Assembla::Constants::META_REL, Assembla::Constants::OAUTH_SCOPES, Assembla::Constants::PARAM_PAGE, Assembla::Constants::PARAM_PER_PAGE, Assembla::Constants::PARAM_START_PAGE, Assembla::Constants::RATELIMIT_LIMIT, Assembla::Constants::RATELIMIT_REMAINING, Assembla::Constants::SERVER, Assembla::Constants::USER_AGENT

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #execute, extend_with_actions, extra_methods, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, #process_basic_auth, request_methods, root!, #run_callbacks, #set, #setup, #with, #yield_or_eval

Methods included from Assembla::ClassMethods

#configuration, #configure, #require_all

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Assembla::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Assembla::API

Instance Method Details

#get(*args) ⇒ Object Also known as: find, me

Get a single user

Get the authenticated user

Examples:

assembla = Assembla.new oauth_token: '...'
assembla.users.get user: 'user-name'
assembla = Assembla.new oauth_token: '...'
assembla.users.me


28
29
30
31
32
33
34
35
36
 
# File 'lib/assembla_api/client/users.rb', line 28

def get(*args)
  params = arguments(args).params

  if user_name = params.delete('user')
    get_request("/users/#{user_name}", params)
  else
    get_request("/user")
  end
end

#picture(*args) ⇒ Object

Examples:

api.users.picture 'mike'


43
44
45
46
47
 
# File 'lib/assembla_api/client/users.rb', line 43

def picture(*args)
  arguments(args, required: [ :user ])
  arguments.params['raw'] = true
  get_request("/users/#{arguments.user}/picture", arguments.params)
end