Class: Trophonius::Record

Inherits:
Hash
  • Object
show all
Includes:
Translator
Defined in:
lib/record.rb

Overview

This class will hold a singular record

A Record is contained in a RecordSet and has methods to retrieve data from the fields inside the Record-hash

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Translator

#methodize_field, #methodize_portal_field

Constructor Details

#initialize(fm_record = {}, model = '') ⇒ Record

Initializes a new Record



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/record.rb', line 21

def initialize(fm_record = {}, model = '')
  @modifiable_fields = {}
  @modified_fields = {}
  @model_name = model
  @model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(model_name)))
  @layout_name = @model.layout_name
  define_field_methods(fm_record)
  define_portal_methods(fm_record)
  super()
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/record.rb', line 38

def method_missing(method, *args, &block)
  if ActiveSupport::Inflector.pluralize(method).to_s == method.to_s
    model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(method)))
    pk_model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(model_name)))

    if model.belongs_to_relations[ActiveSupport::Inflector.parameterize(model_name).to_sym]
      relation = model.belongs_to_relations[ActiveSupport::Inflector.parameterize(model_name).to_sym]
      layout = model.layout_name
      model.create_translations if model.translations.keys.empty?

      url = "/layouts/#{layout}/_find"
      foreign_key_field = if model.translations.key?(relation[:foreign_key])
                            model.translations[relation[:foreign_key]].to_s
                          else
                            relation[:foreign_key].to_s
                          end

      primary_key_field = if pk_model.translations.key?(relation[:primary_key])
                            pk_model.translations[relation[:primary_key]].to_s
                          else
                            relation[:primary_key].to_s
                          end

      body = { query: [{ foreign_key_field => self[primary_key_field].to_s }], limit: 100_000 }.to_json
      response = DatabaseRequest.make_request(url, 'post', body)

      if response['messages'][0]['code'] == '0'
        r_results = response['response']['data']
        ret_val = RecordSet.new(layout, model.non_modifiable_fields)
        r_results.each do |r|
          hash = model.build_result(r)
          ret_val << hash
        end
        @response = ret_val
        @response
      elsif response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'
        RecordSet.new(layout, model.non_modifiable_fields)

      else
        if response['messages'][0]['code'] == '102'
          results = DatabaseRequest.retrieve_first(layout)
          if results['messages'][0]['code'] == '0'
            r_results = results['response']['data']
            ret_val = r_results.empty? ? Error.throw_error('102') : r_results[0]['fieldData']
            query_keys = [foreign_key_field]
            Error.throw_error('102', (query_keys - ret_val.keys.map(&:downcase)).flatten.join(', '), layout)
          else
            Error.throw_error('102')
          end
        end
        Error.throw_error(response['messages'][0]['code'])
      end
    end
  elsif ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(method))).respond_to?('first')
    fk_model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(model_name)))
    pk_model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(method)))

    if pk_model.has_many_relations[ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.pluralize(model_name)).to_sym]
      relation = pk_model.has_many_relations[ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.pluralize(model_name)).to_sym]
      layout = pk_model.layout_name
      pk_model.create_translations if pk_model.translations.keys.empty?

      url = "/layouts/#{layout}/_find"

      foreign_key_field = if fk_model.translations.key?(relation[:foreign_key])
                            fk_model.translations[relation[:foreign_key]].to_s
                          else
                            relation[:foreign_key].to_s
                          end

      primary_key_field = if pk_model.translations.key?(relation[:primary_key])
                            pk_model.translations[relation[:primary_key]].to_s
                          else
                            relation[:primary_key].to_s
                          end

      body = { query: [{ primary_key_field => self[foreign_key_field].to_s }], limit: 1 }.to_json

      response = DatabaseRequest.make_request(url, 'post', body)
      if response['messages'][0]['code'] == '0'
        r_results = response['response']['data']
        ret_val = RecordSet.new(layout, pk_model.non_modifiable_fields)
        r_results.each do |r|
          hash = pk_model.build_result(r)
          ret_val << hash
        end
        @response = ret_val
        @response.first
      elsif response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'
        RecordSet.new(layout, pk_model.non_modifiable_fields)

      else
        if response['messages'][0]['code'] == '102'
          results = DatabaseRequest.retrieve_first(layout)
          if results['messages'][0]['code'] == '0'
            r_results = results['response']['data']
            ret_val = r_results.empty? ? Error.throw_error('102') : r_results[0]['fieldData']
            query_keys = [primary_key_field]
            Error.throw_error('102', (query_keys - ret_val.keys.map(&:downcase)).flatten.join(', '), layout)
          else
            Error.throw_error('102')
          end
        end
        Error.throw_error(response['messages'][0]['code'])
      end
    end
  else
    super
  end
rescue NameError => e
  if e.message.include?('constant')
    Error.throw_error('102', e.message.split(' ')[-1], layout_name)
  else
    raise e
  end
end

Instance Attribute Details

#layout_name ⇒ Object

Returns the value of attribute layout_name.



17
18
19
 
# File 'lib/record.rb', line 17

def layout_name
  @layout_name
end

#model_name ⇒ Object

Returns the value of attribute model_name.



17
18
19
 
# File 'lib/record.rb', line 17

def model_name
  @model_name
end

#modifiable_fields ⇒ Object

Returns the value of attribute modifiable_fields.



17
18
19
 
# File 'lib/record.rb', line 17

def modifiable_fields
  @modifiable_fields
end

#modified_fields ⇒ Object

Returns the value of attribute modified_fields.



17
18
19
 
# File 'lib/record.rb', line 17

def modified_fields
  @modified_fields
end

#record_id ⇒ Object

Returns the value of attribute record_id.



17
18
19
 
# File 'lib/record.rb', line 17

def record_id
  @record_id
end

Instance Method Details

#[]=(field, new_val) ⇒ Object 



32
33
34
35
36
 
# File 'lib/record.rb', line 32

def []=(field, new_val)
  modifiable_fields[field] = new_val
  modified_fields[field] = new_val
  super
end

#delete ⇒ True

Deletes the corresponding record from FileMaker Throws a FileMaker error if save failed

Returns:

  • (True) —

    if successful



195
196
197
198
199
200
 
# File 'lib/record.rb', line 195

def delete
  url = "layouts/#{layout_name}/records/#{record_id}"

  response = DatabaseRequest.make_request(url, 'delete', '{}')
  response['messages'][0]['code'] == '0' ? true : Error.throw_error(response['messages'][0]['code'])
end

#run_script(script: '', scriptparameter: '') ⇒ String

Runs a FileMaker script from the context of the Model.

Parameters:

  • script: (String) (defaults to: '') —

    the FileMaker script to run

  • scriptparameter: (String) (defaults to: '') —

    the parameter required by the FileMaker script

Returns:

  • (String) —

    : string representing the script result returned by FileMaker



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/record.rb', line 163

def run_script(script: '', scriptparameter: '')
  url = "layouts/#{layout_name}/records/#{record_id}?script=#{script}&script.param=#{scriptparameter}"
  result = DatabaseRequest.make_request(url, 'get', '{}')

  if result['messages'][0]['code'] != '0'
    Error.throw_error(result['messages'][0]['code'])
  elsif result['response']['scriptResult'] == '403'
    Error.throw_error(403)
  else
    ret_val = result['response']['scriptResult']
    ret_val || true
  end
end

#save ⇒ True

Saves the last changes made to the Record to FileMaker. Throws a FileMaker error if save failed

Returns:

  • (True) —

    if successful



182
183
184
185
186
187
188
 
# File 'lib/record.rb', line 182

def save
  url = "layouts/#{layout_name}/records/#{record_id}"

  body = "{\"fieldData\": #{modified_fields.to_json}}"
  response = DatabaseRequest.make_request(url, 'patch', body)
  response['messages'][0]['code'] == '0' ? true : Error.throw_error(response['messages'][0]['code'])
end

#update(field_data, portal_data: {}) ⇒ True

Changes and saves the corresponding record in FileMaker Throws a FileMaker error if save failed

Parameters:

  • field_data: (Hash) —

    Fields to be changed and data to fill the fields with

Returns:

  • (True) —

    if successful



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/record.rb', line 209

def update(field_data, portal_data: {})
  url = "layouts/#{layout_name}/records/#{record_id}"
  field_data.each_key { |field| modifiable_fields[field] = field_data[field] }
  field_data.transform_keys! { |k| (@model.translations[k.to_s] || k).to_s }

  portal_data.each do |portal_name, values|
    values.map do |record|
      record.transform_keys! do |k|
        if k.to_s.downcase.include?('id') && k.to_s.downcase.include?('record')
          'recordId'
        else
          "#{portal_name}::#{k}"
        end
      end
    end
  end

  body = { fieldData: field_data }
  body.merge!({ portalData: portal_data }) if portal_data.present?

  response = DatabaseRequest.make_request(url, 'patch', body.to_json)
  code = response['messages'][0]['code']

  return throw_field_missing(field_data) if code == '102'
  return Error.throw_error(code) if code != '0'

  true
end

#upload(container_name:, file:, container_repetition: 1) ⇒ True

Uploads a file to a container field of the record Throws a FileMaker error if upload failed

Parameters:

  • container_name: (String) —

    Case sensitive name of the container field on the layout

  • container_repetition: (Integer) (defaults to: 1) —

    Number of the repetition of the container field to set

  • file: (Tempfile or File) —

    File to upload

Returns:

  • (True) —

    if successful



247
248
249
250
251
252
 
# File 'lib/record.rb', line 247

def upload(container_name:, file:, container_repetition: 1)
  url = "layouts/#{layout_name}/records/#{record_id}/containers/#{container_name}/#{container_repetition}"

  response = DatabaseRequest.upload_file_request(url, file)
  response['messages'][0]['code'] == '0' ? true : Error.throw_error(response['messages'][0]['code'])
end