Class: Eco::API::Session::Config::People

Inherits:
BaseConfig show all
Defined in:
lib/eco/api/session/config/people.rb

Instance Attribute Summary

Attributes inherited from BaseConfig

#config

Attributes included from Language::AuxiliarLogger

#logger

Instance Method Summary collapse

Methods inherited from BaseConfig

#apis, attr_key, #clone, #file_manager, #initialize

Methods included from Language::AuxiliarLogger

#log

Methods inherited from Hash

#deep_merge, #deep_merge!

Constructor Details

This class inherits a constructor from Eco::API::Session::Config::BaseConfig

Instance Method Details

#api_excluded(&block) ⇒ Object

with given a person what is the criteria of exclusion



54
55
56
57
58
 
# File 'lib/eco/api/session/config/people.rb', line 54

def api_excluded(&block)
  return self['api_excluded'] unless block_given?

  self['api_excluded'] = block
end

#cache ⇒ Object 



10
11
12
 
# File 'lib/eco/api/session/config/people.rb', line 10

def cache
  self['cache'] ||= 'cache/people.json'
end

#cache=(file) ⇒ Object 



6
7
8
 
# File 'lib/eco/api/session/config/people.rb', line 6

def cache=(file)
  self['cache'] = file
end

#default_login_method? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/eco/api/session/config/people.rb', line 80

def 
  !!
end

#default_schema? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/eco/api/session/config/people.rb', line 76

def default_schema?
  !!default_schema
end

#default_usergroup? ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/eco/api/session/config/people.rb', line 72

def default_usergroup?
  !!default_usergroup
end

#discarded_file ⇒ Object 



49
50
51
 
# File 'lib/eco/api/session/config/people.rb', line 49

def discarded_file
  self['discarded_file']
end

#discarded_file=(file) ⇒ Object

people to exclude from update feeds



45
46
47
 
# File 'lib/eco/api/session/config/people.rb', line 45

def discarded_file=(file)
  self['discarded_file'] = file
end

#fields_mapper ⇒ Object 



65
66
67
 
# File 'lib/eco/api/session/config/people.rb', line 65

def fields_mapper
  self['fields_mapper']
end

#fields_mapper=(file) ⇒ Object

internal-external fields map



61
62
63
 
# File 'lib/eco/api/session/config/people.rb', line 61

def fields_mapper=(file)
  self['fields_mapper'] = file
end

#parser(format: :csv) ⇒ Eco::API::Common::People::PersonParser

The person parser/serializer for a given format (default csv).

Parameters:

  • format (Symbol) (defaults to: :csv) —

    the format this parser/serializer recognizes.

Returns:



92
93
94
95
96
97
98
99
100
 
# File 'lib/eco/api/session/config/people.rb', line 92

def parser(format: :csv)
  prs = parsers[format] ||= Eco::API::Common::People::PersonParser.new
  if block_given?
    yield(prs)
    self
  else
    prs
  end
end

#parsers ⇒ Hash

Returns with defined pairs format key and Person parsers.

Returns:

  • (Hash) —

    with defined pairs format key and Person parsers.



85
86
87
 
# File 'lib/eco/api/session/config/people.rb', line 85

def parsers
  self['parsers'] ||= {}
end

#partial_cache ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/eco/api/session/config/people.rb', line 14

def partial_cache
  return unless (file = self.cache)

  extension = File.extname(file)
  basename  = File.basename(file, extension)

  File.join(
    File.dirname(file),
    "#{basename}_partial#{extension}"
  )
end

#requests_folder ⇒ Object 



40
41
42
 
# File 'lib/eco/api/session/config/people.rb', line 40

def requests_folder
  self['requests_folder'] ||= 'requests'
end

#requests_folder=(folder) ⇒ Object

api queried logs



36
37
38
 
# File 'lib/eco/api/session/config/people.rb', line 36

def requests_folder=(folder)
  self['requests_folder'] = folder
end

#strict_search=(value) ⇒ Object

specifies if people search should be strict or not



27
28
29
 
# File 'lib/eco/api/session/config/people.rb', line 27

def strict_search=(value)
  self['strict_search'] = !!value
end

#strict_search? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/eco/api/session/config/people.rb', line 31

def strict_search?
  self['strict_search']
end