Class: Nimbu::Endpoints::Channels

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

Defined Under Namespace

Classes: Entries

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, #initialize, #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

This class inherits a constructor from Nimbu::Endpoint

Dynamic Method Handling

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

Instance Method Details

#add_webhook(*args) ⇒ Object 



40
41
42
43
44
 
# File 'lib/nimbu-api/endpoints/channels.rb', line 40

def add_webhook(*args)
  arguments(args, :required => [:channel_id])

  post_request("/channels/#{channel_id}/webhooks", arguments.params)
end

#entries(options = {}, &block) ⇒ Object 



8
9
10
 
# File 'lib/nimbu-api/endpoints/channels.rb', line 8

def entries(options={}, &block)
  Nimbu::Builder.new('Channels::Entries', current_options.merge(options), &block)
end

#first(*args) ⇒ Object 



21
22
23
24
25
 
# File 'lib/nimbu-api/endpoints/channels.rb', line 21

def first(*args)
  arguments(args)

  get_request("/channels", arguments.params.merge(limit: 1)).first
end

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



27
28
29
30
31
 
# File 'lib/nimbu-api/endpoints/channels.rb', line 27

def get(*args)
  arguments(args, :required => [:channel_id])

  get_request("/channels/#{channel_id}", arguments.params)
end

#list(*args) ⇒ Object Also known as: all 



12
13
14
15
16
17
18
 
# File 'lib/nimbu-api/endpoints/channels.rb', line 12

def list(*args)
  arguments(args)

  response = get_request("/channels", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

#poll_webhook(*args) ⇒ Object 



46
47
48
49
50
 
# File 'lib/nimbu-api/endpoints/channels.rb', line 46

def poll_webhook(*args)
  arguments(args, :required => [:channel_id])

  post_request("/channels/#{channel_id}/webhooks/poll", arguments.params)
end

#webhooks(*args) ⇒ Object 



34
35
36
37
38
 
# File 'lib/nimbu-api/endpoints/channels.rb', line 34

def webhooks(*args)
  arguments(args, :required => [:channel_id])

  get_request("/channels/#{channel_id}/webhooks", arguments.params)
end