Class: Trophonius::Record

Inherits:
Hash
  • Object
show all
Defined in:
lib/trophonius_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

Constructor Details

#initialize(model = '') ⇒ Record

Initializes a new Record



15
16
17
18
19
20
21
22
 
# File 'lib/trophonius_record.rb', line 15

def initialize(model = '')
  @modifiable_fields = {}
  @modified_fields = {}
  model_name = model
  @model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(model_name)))

  super
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



29
30
31
32
33
34
35
36
37
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
154
155
156
157
158
159
160
161
 
# File 'lib/trophonius_record.rb', line 29

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?

      uri = URI::RFC2396_Parser.new
      url =
        URI(
          uri.escape(
            "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
              Trophonius.config.database
            }/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 = Request.make_request(url, "Bearer #{Request.get_token}", '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 = Request.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?

      uri = URI::RFC2396_Parser.new
      url =
        URI(
          uri.escape(
            "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
              Trophonius.config.database
            }/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 = Request.make_request(url, "Bearer #{Request.get_token}", '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 = Request.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.



11
12
13
 
# File 'lib/trophonius_record.rb', line 11

def layout_name
  @layout_name
end

#model_name ⇒ Object

Returns the value of attribute model_name.



11
12
13
 
# File 'lib/trophonius_record.rb', line 11

def model_name
  @model_name
end

#modifiable_fields ⇒ Object

Returns the value of attribute modifiable_fields.



11
12
13
 
# File 'lib/trophonius_record.rb', line 11

def modifiable_fields
  @modifiable_fields
end

#modified_fields ⇒ Object

Returns the value of attribute modified_fields.



11
12
13
 
# File 'lib/trophonius_record.rb', line 11

def modified_fields
  @modified_fields
end

#record_id ⇒ Object

Returns the value of attribute record_id.



11
12
13
 
# File 'lib/trophonius_record.rb', line 11

def record_id
  @record_id
end

Instance Method Details

#[]=(field, new_val) ⇒ Object 



24
25
26
27
 
# File 'lib/trophonius_record.rb', line 24

def []=(field, new_val)
  modifiable_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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/trophonius_record.rb', line 219

def delete
  uri = URI::RFC2396_Parser.new
  url =
    URI(
      uri.escape(
        "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
          Trophonius.config.database
        }/layouts/#{layout_name}/records/#{record_id}"
      )
    )
  response = Request.make_request(url, "Bearer #{Request.get_token}", '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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/trophonius_record.rb', line 171

def run_script(script: '', scriptparameter: '')
  uri = URI::RFC2396_Parser.new
  url =
    URI(
      uri.escape(
        "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
          Trophonius.config.database
        }/layouts/#{layout_name}/records/#{record_id}?script=#{script}&script.param=#{scriptparameter}"
      )
    )

  result = Request.make_request(url, "Bearer #{Request.get_token}", '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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/trophonius_record.rb', line 199

def save
  uri = URI::RFC2396_Parser.new
  url =
    URI(
      uri.escape(
        "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
          Trophonius.config.database
        }/layouts/#{layout_name}/records/#{record_id}"
      )
    )
  body = "{\"fieldData\": #{modified_fields.to_json}}"
  response = Request.make_request(url, "Bearer #{Request.get_token}", '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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/trophonius_record.rb', line 240

def update(field_data, portal_data: {})
  uri = URI::RFC2396_Parser.new
  url =
    URI(
      uri.escape(
        "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
          Trophonius.config.database
        }/layouts/#{layout_name}/records/#{record_id}"
      )
    )
  field_data.each_key { |field| modifiable_fields[field] = field_data[field] }
  new_portal_data = {}
  portal_data.each do |portal_name, portal_values|
    new_portal_data.merge!(
      portal_name =>
        portal_values.map do |record|
          record.each_with_object({}) do |(key, value), new_hash|
            if key.to_s.downcase.include?('id') && key.to_s.downcase.include?('record')
              new_hash['recordId'] = value
            else
              new_hash["#{portal_name}::#{key}"] = value
            end
          end
        end
    )
  end
  body =
    if new_portal_data == {}
      "{\"fieldData\": #{field_data.to_json} }"
    else
      "{\"fieldData\": #{field_data.to_json}, \"portalData\": #{new_portal_data.to_json}}"
    end

  puts "BODY SENT TO FILEMAKER WAS: #{body}"
  response = Request.make_request(url, "Bearer #{Request.get_token}", 'patch', body)
  if response['messages'][0]['code'] == '0'
    true
  else
    if response['messages'][0]['code'] == '102'
      results = Request.retrieve_first(layout_name)
      if results['messages'][0]['code'] == '0'
        r_results = results['response']['data']
        Error.throw_error('102') if r_results.empty?
        ret_val = r_results[0]['fieldData']
        Error.throw_error('102', (field_data.keys.map { |key| key.to_s.downcase } - ret_val.keys.map(&:downcase)).flatten.join(', '), layout_name)
      else
        Error.throw_error('102')
      end
    end
    Error.throw_error(response['messages'][0]['code'])
  end
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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/trophonius_record.rb', line 302

def upload(container_name:, file:, container_repetition: 1)
  uri = URI::RFC2396_Parser.new
  url =
    URI(
      uri.escape(
        "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
          Trophonius.config.database
        }/layouts/#{layout_name}/records/#{record_id}/containers/#{container_name}/#{container_repetition}"
      )
    )

  response = Request.upload_file_request(url, "Bearer #{Request.get_token}", file)
  response['messages'][0]['code'] == '0' ? true : Error.throw_error(response['messages'][0]['code'])
end