Class: Trophonius::Model

Inherits:
Object
  • Object
show all
Defined in:
lib/trophonius_model.rb

Overview

This class will retrieve the records from the FileMaker database and build a RecordSet filled with Record objects. One Record object represents a record in FileMaker.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config:) ⇒ Model

Returns a new instance of Model.



14
15
16
17
18
 
# File 'lib/trophonius_model.rb', line 14

def initialize(config:)
  @configuration = config
  @offset = ""
  @limit = ""
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/trophonius_model.rb', line 90

def method_missing(method, *args, &block)
  if @current_query.respond_to?(method)
    args << self
    @current_query.send(method, args)
  elsif @current_query.response.respond_to?(method)
    ret_val = @current_query.run_query(method, *args, &block)
    @limit = ''
    @offset = ''
    return ret_val
  end
end

Instance Attribute Details

#configuration ⇒ Object (readonly)

Returns the value of attribute configuration.



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

def configuration
  @configuration
end

#current_query ⇒ Object

Returns the value of attribute current_query.



12
13
14
 
# File 'lib/trophonius_model.rb', line 12

def current_query
  @current_query
end

Class Method Details

.all(sort: {}) ⇒ RecordSet

Retrieve the first 10000000 records from FileMaker from the context of the Model.

Parameters:

  • sort: (Hash) (defaults to: {}) —

    a hash containing the fields to sort by and the direction to sort in (optional)

Returns:

  • (RecordSet) —

    : a RecordSet containing all the Record objects that correspond to the FileMaker records.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/trophonius_model.rb', line 356

def self.all(sort: {})
  results = Request.retrieve_all(layout_name, sort)
  count = results["response"]["scriptResult"].to_i
  unless @limit.empty? || @offset.empty?
    url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records?_offset=#{@offset}&_limit=#{@limit}")
  else
    url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records?_limit=#{count == 0 ? 1000000 : count}")
  end
  @limit = ''
  @offset = ''
  results = Request.make_request(url, "Bearer #{Request.get_token}", "get", "{}")
  if results["messages"][0]["code"] != "0"
    Error.throw_error(results["messages"][0]["code"])
  else
    r_results = results["response"]["data"]
    ret_val = RecordSet.new(self.layout_name, self.non_modifiable_fields)
    r_results.each do |r|
      hash = build_result(r)
      ret_val << hash
    end
    ret_val.result_count = count
    return ret_val
  end
end

.build_result(result) ⇒ Record

Builds the resulting Record

Parameters:

  • result: (JSON) —

    the HTTP result from FileMaker

Returns:

  • (Record) —

    A Record with singleton_methods for the fields where possible



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/trophonius_model.rb', line 268

def self.build_result(result)
  hash = Trophonius::Record.new()
  hash.record_id = result["recordId"]
  hash.layout_name = layout_name
  result["fieldData"].keys.each do |key|
    # unless key[/\s/] || key[/\W/]
    @configuration.translations.merge!({ "#{ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_').downcase}" => "#{key}" })
    hash.send(:define_singleton_method, ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_')) do
      hash[key]
    end
    unless non_modifiable_fields&.include?(key)
      @configuration.all_fields.merge!(ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_').downcase => ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_'))
      hash.send(:define_singleton_method, "#{ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_')}=") do |new_val|
        hash[key] = new_val
        hash.modifiable_fields[key] = new_val
        hash.modified_fields[key] = new_val
      end
    end
    # end
    hash.merge!({key => result["fieldData"][key]})
    unless non_modifiable_fields&.include?(key)
      hash.modifiable_fields.merge!({key => result["fieldData"][key]})
    end
  end
  result["portalData"].keys.each do |key|
    unless key[/\s/] || key[/\W/]
      hash.send(:define_singleton_method, ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_')) do
        hash[key]
      end
    end
    result["portalData"][key].each_with_index do |inner_hash|
      inner_hash.keys.each do |inner_key|
        inner_method = ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(inner_key.gsub(/\w+::/, "").to_s), separator: '_')
        unless inner_method[/\s/] || inner_method[/\W/]
          inner_hash.send(:define_singleton_method, inner_method.to_s) { inner_hash[inner_key] }
          inner_hash.send(:define_singleton_method, "record_id") { inner_hash["recordId"] }
        end
      end
    end
    hash.merge!({key => result["portalData"][key]})
  end
  return hash
end

.config(configuration) ⇒ Object

Sets up the configuration for the model.

Parameters:

  • configuration: (Hash) —

    the hash containing the config to setup the model correctly. configuration = “theFileMakerLayoutForThisModel”, non_modifiable_fields: [“an”, “array”, “containing”, “calculation_fields”, “etc.”]



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

def self.config(configuration)
  @configuration ||= Configuration.new
  @configuration.layout_name = configuration[:layout_name]
  @configuration.non_modifiable_fields = configuration[:non_modifiable_fields]
  @configuration.all_fields = {}
  @configuration.translations = {}
  @offset = ""
  @limit = ""
end

.create(fieldData) ⇒ Record

Creates and saves a record in FileMaker

Parameters:

  • fieldData: (Hash) —

    the fields to fill with the data

Returns:

  • (Record) —

    the created record Model.create(fieldOne: “Data”)



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
 
# File 'lib/trophonius_model.rb', line 133

def self.create(fieldData)
  url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records")
  new_field_data = {}
  if @configuration.translations.keys.empty?
    create_translations
  end
  fieldData.keys.each do |k|
    if @configuration.translations.keys.include?(k.to_s)
      new_field_data.merge!({"#{@configuration.translations[k.to_s]}" => fieldData[k]})
    else
      new_field_data.merge!({"#{k}" => fieldData[k]})
    end
  end
  body = "{\"fieldData\": #{new_field_data.to_json}}"
  response = Request.make_request(url, "Bearer #{Request.get_token}", "post", body)
  if response["messages"][0]["code"] != "0"
    Error.throw_error(response["messages"][0]["code"])
  else
    url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{response["response"]["recordId"]}")
    ret_val = build_result(Request.make_request(url, "Bearer #{Request.get_token}", "get", "{}")["response"]["data"][0])
    ret_val.send(:define_singleton_method, "result_count") do
      1
    end
    return ret_val
  end
end

.create_translations ⇒ Hash

creates Rails -> FileMaker field translations by requesting the first record

Returns:

  • (Hash) —

    translations of the fields Rails -> FileMaker



76
77
78
79
 
# File 'lib/trophonius_model.rb', line 76

def self.create_translations
  self.first
  @configuration.translations
end

.delete(record_id) ⇒ Boolean

Deletes a record from FileMaker

Parameters:

  • record_id: (Integer) —

    the record id to retrieve from FileMaker

Returns:

  • (Boolean) —

    True if the delete was successful



222
223
224
225
226
227
228
229
230
 
# File 'lib/trophonius_model.rb', line 222

def self.delete(record_id)
  url = URI("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", "{}")
  if response["messages"][0]["code"] != "0"
    Error.throw_error(response["messages"][0]["code"])
  else
    return true
  end
end

.edit(record_id, fieldData) ⇒ Boolean

Edits a record in FileMaker

Parameters:

  • record_id: (Integer) —

    the record id to edit in FileMaker

  • fieldData: (Hash) —

    A hash containing the fields to edit and the new data to fill them with

Returns:

  • (Boolean) —

    True if the delete was successful



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/trophonius_model.rb', line 240

def self.edit(record_id, fieldData)
  url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{record_id}")
  new_field_data = {}
  if @configuration.translations.keys.empty?
    create_translations
  end
  fieldData.keys.each do |k|
    if @configuration.translations.keys.include?(k.to_s)
      new_field_data.merge!({"#{@configuration.translations[k.to_s]}" => fieldData[k]})
    else
      new_field_data.merge!({"#{k}" => fieldData[k]})
    end
  end
  body = "{\"fieldData\": #{new_field_data.to_json}}"
  response = Request.make_request(url, "Bearer #{Request.get_token}", "patch", body)
  if response["messages"][0]["code"] != "0"
    Error.throw_error(response["messages"][0]["code"])
  else
    true
  end
end

.find(record_id) ⇒ Record

Finds and returns a Record corresponding to the record_id

Parameters:

  • record_id: (Integer) —

    the record id to retrieve from FileMaker

Returns:



202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/trophonius_model.rb', line 202

def self.find(record_id)
  url = URI("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}", "get", "{}")
  if response["messages"][0]["code"] != "0"
    Error.throw_error(response["messages"][0]["code"], record_id)
  else
    ret_val = build_result(response["response"]["data"][0])
    ret_val.send(:define_singleton_method, "result_count") do
      1
    end
    return ret_val
  end
end

.find_by(fieldData) ⇒ Record

Finds and returns the first Record containing fitting the find request

Parameters:

  • fieldData: (Hash) —

    the data to find

Returns:

  • (Record) —

    a Record object that correspond to FileMaker record fitting the find request Model.find_by(fieldOne: “Data”)



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/trophonius_model.rb', line 167

def self.find_by(fieldData)
  url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{self.layout_name}/_find?_limit=1")
  new_field_data = {}
  if @configuration.translations.keys.empty?
    create_translations
  end
  fieldData.keys.each do |k|
    if @configuration.translations.keys.include?(k.to_s)
      new_field_data.merge!({"#{@configuration.translations[k.to_s]}" => fieldData[k]})
    else
      new_field_data.merge!({"#{k}" => fieldData[k]})
    end
  end
  body = {query: [new_field_data], limit:"100000"}.to_json
  response = Request.make_request(url, "Bearer #{Request.get_token}", "post", body)
  if response["messages"][0]["code"] != "0"
    return RecordSet.new(self.layout_name, self.non_modifiable_fields) if response["messages"][0]["code"] == "101" || response["messages"][0]["code"] == "401"
    Error.throw_error(response["messages"][0]["code"])
  else
    r_results = response["response"]["data"]
    ret_val = RecordSet.new(self.layout_name, self.non_modifiable_fields)
    r_results.each do |r|
      hash = build_result(r)
      ret_val << hash
    end
    return ret_val.first
  end
end

.first ⇒ Record

Retrieve the first record from FileMaker from the context of the Model.

Returns:

  • (Record) —

    : a Record corresponding to the FileMaker record.



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/trophonius_model.rb', line 316

def self.first
  results = Request.retrieve_first(layout_name)
  if results["messages"][0]["code"] != "0"
    Error.throw_error(results["messages"][0]["code"])
  else
    r_results = results["response"]["data"]
    ret_val = r_results.empty? ? Trophonius::Record.new() : build_result(r_results[0])
    ret_val.send(:define_singleton_method, "result_count") do
      r_results.empty? ? 0 : 1
    end
    return ret_val
  end
end

.layout_name ⇒ String

Returns the FileMaker layout this Model corresponds to

Returns:

  • (String) —

    layout name of the model



52
53
54
 
# File 'lib/trophonius_model.rb', line 52

def self.layout_name
  @configuration.layout_name
end

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



81
82
83
84
85
86
87
88
 
# File 'lib/trophonius_model.rb', line 81

def self.method_missing(method, *args, &block)
  new_instance = Trophonius::Model.new(config: @configuration)
  new_instance.current_query = Trophonius::Query.new(trophonius_model: self, limit: @limit, offset: @offset )
  args << new_instance
  if new_instance.current_query.respond_to?(method)
    new_instance.current_query.send(method, args)
  end
end

.non_modifiable_fields ⇒ [Array]

Returns the fields that FileMaker won’t allow us to modify

Returns:

  • ([Array]) —

    fields that FileMaker won’t allow us to modify



60
61
62
 
# File 'lib/trophonius_model.rb', line 60

def self.non_modifiable_fields
  @configuration.non_modifiable_fields
end

.paginate(page, limit) ⇒ Trophonius::Model

Limits the found record set.

Parameters:

  • page: (Integer) —

    number of current page

  • limit: (Integer) —

    number of records retreived

Returns:



42
43
44
45
46
 
# File 'lib/trophonius_model.rb', line 42

def self.paginate(page, limit)
  @offset = ((page * limit - limit) + 1).to_s
  @limit = limit.to_s
  self
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



338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/trophonius_model.rb', line 338

def self.run_script(script: "", scriptparameter: "")
  result = Request.run_script(script, scriptparameter, layout_name)
  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"]
    return ret_val
  end
end

.translations ⇒ Hash

Returns the translations of the fields

Returns:

  • (Hash) —

    translations of the fields Rails -> FileMaker



68
69
70
 
# File 'lib/trophonius_model.rb', line 68

def self.translations
  @configuration.translations
end

.where(fieldData) ⇒ Trophonius::Model

Finds all records in FileMaker corresponding to the requested query

Parameters:

  • fieldData: (Hash) —

    the data to find

Returns:



107
108
109
110
111
112
 
# File 'lib/trophonius_model.rb', line 107

def self.where(fieldData)
  new_instance = Trophonius::Model.new(config: @configuration)
  new_instance.current_query = Trophonius::Query.new(trophonius_model: self, limit: @limit, offset: @offset )
  new_instance.current_query.build_query[0].merge!(fieldData)
  new_instance
end

Instance Method Details

#where(fieldData) ⇒ Trophonius::Model

Finds all records in FileMaker corresponding to the requested query This method is created to enable where chaining

Parameters:

  • fieldData: (Hash) —

    the data to find

Returns:



121
122
123
124
 
# File 'lib/trophonius_model.rb', line 121

def where(fieldData)
  @current_query.build_query[0].merge!(fieldData)
  self
end