Class: Nimbu::Endpoints::Login

Inherits:
Nimbu::Endpoint show all
Defined in:
lib/nimbu-api/endpoints/login.rb

Constant Summary

Constants included from Request

Request::METHODS, Request::METHODS_WITH_BODIES

Constants included from Utils::Constants

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

Constants included from Connection

Connection::ALLOWED_OPTIONS

Instance Attribute Summary

Attributes inherited from Nimbu::Endpoint

#current_options

Attributes included from Authentication

#scopes

Instance Method Summary collapse

Methods inherited from Nimbu::Endpoint

#api_methods_in, #append_arguments, #arguments, inherited, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from Authentication

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

Constructor Details

#initialize(options = {}, &block) ⇒ Login

Returns a new instance of Login.



7
8
9
10
11
12
13
14
 
# File 'lib/nimbu-api/endpoints/login.rb', line 7

def initialize(options={}, &block)
  super

  require_authentication

  # fetch api token
  @response = post_request("/auth/login")
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Nimbu::Endpoint

Instance Method Details

#require_authentication ⇒ Object

Raises:

  • (ArgumentError) 


20
21
22
 
# File 'lib/nimbu-api/endpoints/login.rb', line 20

def require_authentication
  raise ArgumentError, 'A username and password is required in order to login' unless authenticated?
end

#response ⇒ Object 



16
17
18
 
# File 'lib/nimbu-api/endpoints/login.rb', line 16

def response
  @response
end