Module: ZohoApiFinders

Included in:
ZohoApi::Crm
Defined in:
lib/zoho_api_finders.rb

Constant Summary collapse

NUMBER_OF_RECORDS_TO_GET = 
200

Instance Method Summary collapse

Instance Method Details

#find_record_by_field(module_name, sc_field, condition, value) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/zoho_api_finders.rb', line 12

def find_record_by_field(module_name, sc_field, condition, value)
  field = sc_field.rindex('id') ? sc_field.downcase : sc_field
  search_condition = "(#{field}:#{value})"
  r = self.class.get(create_url("#{module_name}", 'searchRecords'),
                     :query => { :newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
                                 :selectColumns => 'All', :criteria => search_condition,
                                 :fromIndex => 1, :toIndex => NUMBER_OF_RECORDS_TO_GET })
  check_for_errors(r)
  x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
  to_hash(x, module_name)
end

#find_record_by_id(module_name, id) ⇒ Object

Raises:

  • (RuntimeError) 


24
25
26
27
28
29
30
31
32
 
# File 'lib/zoho_api_finders.rb', line 24

def find_record_by_id(module_name, id)
  r = self.class.get(create_url("#{module_name}", 'getRecordById'),
                     :query => { :newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
                                 :selectColumns => 'All', :id => id })
  raise(RuntimeError, 'Bad query', "#{module_name} #{id}") unless r.body.index('<error>').nil?
  check_for_errors(r)
  x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
  to_hash(x, module_name)
end

#find_record_by_related_id(module_name, sc_field, value) ⇒ Object

Raises:

  • (RuntimeError) 


34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/zoho_api_finders.rb', line 34

def find_record_by_related_id(module_name, sc_field, value)
  raise(RuntimeError, "[RubyZoho] Not a valid query field #{sc_field} for module #{module_name}") unless valid_related?(module_name, sc_field)
  field = sc_field.downcase
  r = self.class.get(create_url("#{module_name}", 'getSearchRecordsByPDC'),
                     :query => { :newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
                                 :selectColumns => 'All', :version => 2, :searchColumn => field,
                                 :searchValue => value })
  check_for_errors(r)
  x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
  to_hash(x, module_name)
end

#find_records(module_name, field, condition, value) ⇒ Object 



4
5
6
7
8
9
10
 
# File 'lib/zoho_api_finders.rb', line 4

def find_records(module_name, field, condition, value)
  sc_field = field == :id ? primary_key(module_name) : ApiUtils.symbol_to_string(field)
  related_id?(module_name, sc_field)
  return find_record_by_related_id(module_name, sc_field, value) if related_id?(module_name, sc_field)
  primary_key?(module_name, sc_field) == false ? find_record_by_field(module_name, sc_field, condition, value) :
      find_record_by_id(module_name, value)
end