Class: ContextIO::Folder

Inherits:
Object
  • Object
show all
Includes:
CallHelpers
Defined in:
lib/context_io/shared/folder.rb

Constant Summary collapse

FOLDER_READERS = 
%I(symbolic_name attributes delim nb_messages xlist_name
nb_unseen_messages resource_url name)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from CallHelpers

#build_url, #call_api_return_new_object, #call_api_return_updated_object, #delete, #get_request, #parse_response, #return_post_api_call_made, #success?, #validate_params

Methods included from CollectionHelper

#collection_return, #contact_collection_return

Constructor Details

#initialize(parent:, identifier: nil, response: nil, status: nil, success: nil, api_call_made: nil) ⇒ Folder

Returns a new instance of Folder.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/context_io/shared/folder.rb', line 13

def initialize(parent:,
               identifier: nil,
               response: nil,
               status: nil,
               success: nil,
               api_call_made: nil)
  @status = status
  @success = success
  @parent = parent
  @connection = parent.connection
  @name = identifier
  @api_call_made = api_call_made
  if response
    parse_response(response)
  end
end

Instance Attribute Details

#api_call_made ⇒ Object

Returns the value of attribute api_call_made.



11
12
13
 
# File 'lib/context_io/shared/folder.rb', line 11

def api_call_made
  @api_call_made
end

Instance Method Details

#call_url ⇒ Object 



34
35
36
 
# File 'lib/context_io/shared/folder.rb', line 34

def call_url
  build_url("folders", encoded_name)
end

#encoded_name ⇒ Object 



30
31
32
 
# File 'lib/context_io/shared/folder.rb', line 30

def encoded_name
  ERB::Util.url_encode(name)
end

#get(**kwargs) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/context_io/shared/folder.rb', line 42

def get(**kwargs)
  if source_parent?
    get_request(given_params: kwargs, valid_params: ValidGetParams::SOURCE_FOLDER)
  else
    get_request(given_params: kwargs)
  end
end

#get_messages(**kwargs) ⇒ Object 



50
51
52
53
54
55
 
# File 'lib/context_io/shared/folder.rb', line 50

def get_messages(**kwargs)
  collection_return(url: "#{call_url}/messages",
                    klass: Message,
                    valid_params: ValidGetParams::SOURCE_FOLDER_MESSAGES,
                    given_params: kwargs)
end

#source_parent? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/context_io/shared/folder.rb', line 38

def source_parent?
  parent.class == Sources
end