trophonius 1.4.5.5 → 2.1

data/lib/model.rb

@@ -0,0 +1,394 @@
+require 'json'
+require 'config'
+require 'record'
+require 'recordset'
+require 'translator'
+require 'query'
+require 'error'
+# require 'time'
+# require 'date_time'
+# require 'date'
+
+require 'active_support/inflector'
+
+module Trophonius
+  # 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.
+  class Model
+    attr_reader :configuration
+    attr_accessor :current_query
+
+    def initialize(config:)
+      @configuration = config
+      @offset = ''
+      @limit = ''
+    end
+
+    ##
+    # Sets up the configuration for the model.
+    #
+    # @param [Hash] configuration: the hash containing the config to setup the model correctly.
+    #   configuration = {layout_name: "theFileMakerLayoutForThisModel",
+    #   non_modifiable_fields: ["an", "array", "containing", "calculation_fields", "etc."]}
+    def self.config(configuration)
+      @configuration ||= Configuration.new
+      @configuration.layout_name = configuration[:layout_name]
+      @configuration.non_modifiable_fields = configuration[:non_modifiable_fields] || []
+      @configuration.translations = {}
+      @configuration.has_many_relations = {}
+      @configuration.belongs_to_relations = {}
+      @offset = ''
+      @limit = ''
+    end
+
+    ##
+    # Add a belongs to relationship.
+    #
+    # @param [Symbol] model_name: the name of the model to build a relation with
+    # @param [String] primary_key: the name of the field containing the primary to build the relation over
+    # @param [String] foreign_key: the name of the field containing the primary to build the relation over
+    def self.belongs_to(model_name, primary_key:, foreign_key:)
+      @configuration.belongs_to_relations.merge!({ model_name => { primary_key: primary_key, foreign_key: foreign_key } })
+    end
+
+    ##
+    # Add a has many relationship.
+    #
+    # @param [Symbol] model_name: the name of the model to build a relation with
+    # @param [String] primary_key: the name of the field containing the primary to build the relation over
+    # @param [String] foreign_key: the name of the field containing the primary to build the relation over
+    def self.has_many(model_name, primary_key:, foreign_key:)
+      @configuration.has_many_relations.merge!({ model_name => { primary_key: primary_key, foreign_key: foreign_key } })
+    end
+
+    ##
+    # Limits the found record set.
+    #
+    # @param [Integer] page: number of current page
+    # @param [Integer] limit: number of records retreived
+    #
+    # @return [Trophonius::Model] Self
+    def self.paginate(page, limit)
+      @offset = (((page * limit) - limit) + 1).to_s
+      @limit = limit.to_s
+      self
+    end
+
+    ##
+    # Returns the FileMaker layout this Model corresponds to
+    #
+    # @return [String] layout name of the model
+    def self.layout_name
+      @configuration.layout_name
+    end
+
+    ##
+    # Returns the Hash containing the related parent models
+    #
+    # @return [Hash] child models
+    def self.has_many_relations
+      @configuration.has_many_relations
+    end
+
+    ##
+    # Returns the Hash containing the related parent models
+    #
+    # @return [Hash] parent models
+    def self.belongs_to_relations
+      @configuration.belongs_to_relations
+    end
+
+    ##
+    # Returns the fields that FileMaker won't allow us to modify
+    #
+    # @return [[Array]] fields that FileMaker won't allow us to modify
+    def self.non_modifiable_fields
+      @configuration.non_modifiable_fields
+    end
+
+    ##
+    # Returns the translations of the fields
+    #
+    # @return [Hash] translations of the fields Rails -> FileMaker
+    def self.translations
+      @configuration.translations
+    end
+
+    ##
+    # creates Rails -> FileMaker field translations by requesting the first record
+    #
+    # @return [Hash] translations of the fields Rails -> FileMaker
+    def self.create_translations
+      extend Trophonius::Translator
+      field_names = if Trophonius.config.fm_18
+                      Trophonius::DatabaseRequest.get_layout_field_names(layout_name)
+                    else
+                      DatabaseRequest.retrieve_first(layout_name).dig(
+                        'response', 'data', 0, 'fieldData'
+                      ).keys
+                    end
+      field_names.each do |field|
+        new_name = methodize_field(field.to_s).to_s
+        @configuration.translations.merge!(
+          { new_name => field.to_s }
+        )
+      end
+      @configuration.translations
+    end
+
+    def self.method_missing(method, *args)
+      new_instance = Trophonius::Model.new(config: @configuration)
+      new_instance.current_query = Trophonius::Query.new(trophonius_model: self, limit: @limit, offset: @offset)
+      args << new_instance
+      new_instance.current_query.send(method, args) if new_instance.current_query.respond_to?(method)
+    end
+
+    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 = ''
+        ret_val
+      end
+    end
+
+    ##
+    # Finds all records in FileMaker corresponding to the requested query
+    # @param [Hash] fieldData: the data to find
+    #
+    # @return [Trophonius::Model] new instance of the model
+    def self.where(field_data)
+      create_translations if @configuration.translations.keys.empty?
+
+      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!(field_data)
+      new_instance
+    end
+
+    ##
+    # Finds all records in FileMaker corresponding to the requested query
+    # This method is created to enable where chaining
+    #
+    # @param [Hash] fieldData: the data to find
+    #
+    # @return [Trophonius::Model] new instance of the model
+    def where(field_data)
+      @current_query.build_query[0].merge!(field_data)
+      self
+    end
+
+    ##
+    # Creates and saves a record in FileMaker
+    #
+    # @param [Hash] fieldData: the fields to fill with the data
+    #
+    # @return [Record] the created record
+    #   Model.create(fieldOne: "Data")
+    def self.create(field_data, portal_data: {})
+      create_translations if @configuration.translations.keys.empty?
+
+      field_data.transform_keys! { |k| (@configuration.translations[k.to_s] || k).to_s }
+
+      portal_data.each do |portal_name, values|
+        values.map { |record| record.transform_keys! { |k| "#{portal_name}::#{k}" } }
+      end
+
+      body = { fieldData: field_data }
+      body.merge!({ portalData: portal_data }) if portal_data.present?
+
+      response = DatabaseRequest.make_request("/layouts/#{layout_name}/records", 'post', body.to_json)
+
+      return throw_field_missing(field_data) if response['messages'][0]['code'] == '102'
+
+      return Error.throw_error(response['messages'][0]['code']) if response['messages'][0]['code'] != '0'
+
+      new_record = DatabaseRequest.make_request("/layouts/#{layout_name}/records/#{response['response']['recordId']}", 'get', '{}')
+      record = build_result(new_record['response']['data'][0])
+      record.send(:define_singleton_method, 'result_count') { 1 }
+      record
+    end
+
+    ##
+    # Finds and returns the first Record containing fitting the find request
+    #
+    # @param [Hash] fieldData: the data to find
+    #
+    # @return [Record] a Record object that correspond to FileMaker record fitting the find request
+    #   Model.find_by(fieldOne: "Data")
+    def self.find_by(field_data)
+      url = "layouts/#{layout_name}/_find?_limit=1"
+      create_translations if @configuration.translations.keys.empty?
+
+      field_data.transform_keys! { |k| (@configuration.translations[k.to_s] || k).to_s }
+
+      body = { query: [field_data], limit: '1' }.to_json
+      response = DatabaseRequest.make_request(url, 'post', body)
+      code = response['messages'][0]['code']
+
+      return nil if %w[101 401].include?(code)
+
+      Error.throw_error(code) if code != '0'
+
+      r_results = response['response']['data']
+      build_result(r_results.first) if r_results.first.present?
+    end
+
+    ##
+    # Finds and returns a Record corresponding to the record_id
+    #
+    # @param [Integer] record_id: the record id to retrieve from FileMaker
+    #
+    # @return [Record] the record
+    def self.find(record_id)
+      create_translations if @configuration.translations.keys.empty?
+
+      url = "layouts/#{layout_name}/records/#{record_id}"
+      response = DatabaseRequest.make_request(url, 'get', '{}')
+      if response['messages'][0]['code'] == '0'
+        ret_val = build_result(response['response']['data'][0])
+        ret_val.send(:define_singleton_method, 'result_count') { 1 }
+        ret_val
+      else
+        Error.throw_error(response['messages'][0]['code'], record_id)
+      end
+    end
+
+    ##
+    # Deletes a record from FileMaker
+    #
+    # @param [Integer] record_id: the record id to retrieve from FileMaker
+    #
+    # @return [Boolean] True if the delete was successful
+    def self.delete(record_id)
+      create_translations if @configuration.translations.keys.empty?
+
+      url = "layouts/#{layout_name}/records/#{record_id}"
+      response = DatabaseRequest.make_request(url, 'delete', '{}')
+      if response['messages'][0]['code'] == '0'
+        true
+      else
+        Error.throw_error(response['messages'][0]['code'])
+      end
+    end
+
+    ##
+    # Edits a record in FileMaker
+    #
+    # @param [Integer] record_id: the record id to edit in FileMaker
+    #
+    # @param [Hash] fieldData: A hash containing the fields to edit and the new data to fill them with
+    #
+    # @return [Boolean] True if the delete was successful
+    def self.edit(record_id, field_data)
+      url = "layouts/#{layout_name}/records/#{record_id}"
+      new_field_data = {}
+      create_translations if @configuration.translations.keys.empty?
+
+      field_data.each_key do |k|
+        field_name = (@configuration.translations[k.to_s] || k).to_s
+        new_field_data.merge!({ field_name => field_data[k] })
+      end
+
+      body = "{\"fieldData\": #{new_field_data.to_json}}"
+      response = DatabaseRequest.make_request(url, 'patch', body)
+      response['messages'][0]['code'] == '0' ? true : Error.throw_error(response['messages'][0]['code'])
+    end
+
+    ##
+    # Builds the resulting Record
+    #
+    # @param [JSON] result: the HTTP result from FileMaker
+    #
+    # @return [Record] A Record with singleton_methods for the fields where possible
+    def self.build_result(result)
+      record = Trophonius::Record.new(result, name)
+      record.layout_name = layout_name
+      record
+    end
+
+    ##
+    # Retrieve the first record from FileMaker from the context of the Model.
+    #
+    # @return [Record]: a Record corresponding to the FileMaker record.
+    def self.first
+      create_translations if @configuration.translations.keys.empty?
+      results = DatabaseRequest.retrieve_first(layout_name)
+      if results['messages'][0]['code'] == '0'
+        r_results = results['response']['data']
+        ret_val = r_results.empty? ? Trophonius::Record.new({}, name) : build_result(r_results[0])
+        ret_val.send(:define_singleton_method, 'result_count') { r_results.empty? ? 0 : 1 }
+        ret_val
+      else
+        Error.throw_error(results['messages'][0]['code'])
+      end
+    end
+
+    ##
+    # Runs a FileMaker script from the context of the Model.
+    #
+    # @param [String] script: the FileMaker script to run
+    #
+    # @param [String] scriptparameter: the parameter required by the FileMaker script
+    #
+    # @return [String]: string representing the script result returned by FileMaker
+    def self.run_script(script: '', scriptparameter: '')
+      create_translations if @configuration.translations.keys.empty?
+      result = DatabaseRequest.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
+        result['response']['scriptResult']
+      end
+    end
+
+    ##
+    # Retrieve the first 10000000 records from FileMaker from the context of the Model.
+    #
+    # @param [Hash] sort: a hash containing the fields to sort by and the direction to sort in (optional)
+    #
+    # @return [RecordSet]: a RecordSet containing all the Record objects that correspond to the FileMaker records.
+    def self.all(sort: {})
+      create_translations if @configuration.translations.keys.empty?
+      path = "/layouts/#{layout_name}/records?"
+      path += @limit.present? ? "_limit=#{@limit}" : '_limit=10000000'
+      path += "&_offset=#{@offset}" if @offset.present?
+      sort = sort.map { |k, v| { fieldName: k, sortOrder: v } }
+      path += "&_sort=#{sort.to_json}" unless sort.blank?
+
+      @limit = ''
+      @offset = ''
+      results = DatabaseRequest.make_request(path, 'get', '{}')
+      if results['messages'][0]['code'] == '0'
+        r_results = results['response']['data']
+        ret_val = RecordSet.new(layout_name, non_modifiable_fields)
+        r_results.each do |r|
+          hash = build_result(r)
+          ret_val << hash
+        end
+        ret_val.result_count = count
+        ret_val
+      else
+        Error.throw_error(results['messages'][0]['code'])
+      end
+    end
+
+    private
+
+    def throw_field_missing(field_data)
+      results = DatabaseRequest.retrieve_first(layout_name)
+      if results['messages'][0]['code'] == '0' && !results['response']['data'].empty?
+        r_results = results['response']['data']
+        ret_val = r_results[0]['fieldData']
+        Error.throw_error('102', (field_data.keys.map(&:downcase) - ret_val.keys.map(&:downcase)).flatten.join(', '), layout_name)
+      else
+        Error.throw_error('102')
+      end
+    end
+  end
+end

data/lib/{trophonius_query.rb → query.rb}

@@ -1,11 +1,11 @@
 require 'json'
-require 'trophonius_config'
-require 'trophonius_record'
-require 'trophonius_recordset'
-require 'trophonius_error'
+require 'config'
+require 'record'
+require 'recordset'
+require 'error'
 
 module Trophonius
-  class Trophonius::Query
+  class Query
     attr_reader :response
     attr_accessor :presort_script, :presort_scriptparam, :prerequest_script, :prerequest_scriptparam, :post_request_script, :post_request_scriptparam
 
@@ -53,7 +53,7 @@ module Trophonius
     # Returns the current portal limits
     #
     # @return [Hash] Hash representing the portal limits
-    def build_portal_limits()
+    def build_portal_limits
       @portal_limits ||= {}
     end
 
@@ -153,7 +153,7 @@ module Trophonius
     # @param [args] arguments containing the limit and offset
     # @return [Trophonius::Model] updated base model
     def paginate(args)
-      @offset = ((args[0] * args[1] - args[1]) + 1)
+      @offset = (((args[0] * args[1]) - args[1]) + 1)
       @limit = args[1]
       args[2]
     end
@@ -166,11 +166,11 @@ module Trophonius
     def sort(args)
       @trophonius_model.create_translations if @trophonius_model.translations.keys.empty?
       args[0].each do |key, value|
-        if @trophonius_model.translations.key?(key.to_s)
-          args[1].current_query.build_sort << { fieldName: "#{@trophonius_model.translations[key.to_s]}", sortOrder: "#{value}" }
-        else
-          args[1].current_query.build_sort << { fieldName: "#{key}", sortOrder: "#{value}" }
-        end
+        args[1].current_query.build_sort << if @trophonius_model.translations.key?(key.to_s)
+                                              { fieldName: @trophonius_model.translations[key.to_s], sortOrder: value }
+                                            else
+                                              { fieldName: key, sortOrder: value }
+                                            end
       end
       args[1]
     end
@@ -184,20 +184,12 @@ module Trophonius
     #
     # @return Response of the called method
     def run_query(method, *args, &block)
-      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/#{@trophonius_model.layout_name}/_find"
-          )
-        )
+      url = "layouts/#{@trophonius_model.layout_name}/_find"
       new_field_data = @current_query.map { |_q| {} }
 
       @trophonius_model.create_translations if @trophonius_model.translations.keys.empty?
       @current_query.each_with_index do |query, index|
-        query.keys.each do |k|
+        query.each_key do |k|
           if @trophonius_model.translations.key?(k.to_s)
             new_field_data[index].merge!(@trophonius_model.translations[k.to_s].to_s => query[k].to_s)
           else
@@ -205,16 +197,13 @@ module Trophonius
           end
         end
       end
-      if @offset.nil? || @limit.nil? || @offset == '' || @limit == '' || @offset == 0 || @limit == 0
-        body = @current_sort.nil? ? { query: new_field_data, limit: '100000' } : { query: new_field_data, sort: @current_sort, limit: '100000' }
-      else
-        body =
-          if @current_sort.nil?
-            { query: new_field_data, limit: @limit.to_s, offset: @offset.to_s }
-          else
-            { query: new_field_data, sort: @current_sort, limit: @limit.to_s, offset: @offset.to_s }
-          end
-      end
+      body = if @offset.nil? || @limit.nil? || @offset == '' || @limit == '' || @offset == 0 || @limit == 0
+               @current_sort.nil? ? { query: new_field_data, limit: '100000' } : { query: new_field_data, sort: @current_sort, limit: '100000' }
+             elsif @current_sort.nil?
+               { query: new_field_data, limit: @limit.to_s, offset: @offset.to_s }
+             else
+               { query: new_field_data, sort: @current_sort, limit: @limit.to_s, offset: @offset.to_s }
+             end
 
       if @post_request_script.present?
         body.merge!(script: @post_request_script)
@@ -222,43 +211,25 @@ module Trophonius
       end
 
       if @prerequest_script.present?
-        body.merge!("script.prerequest" => @prerequest_script)
+        body.merge!('script.prerequest' => @prerequest_script)
         body.merge!('script.prerequest.param' => @prerequest_scriptparam) if @prerequest_scriptparam.present?
       end
 
       if @presort_script.present?
-        body.merge!("script.presort" => @presort_script)
+        body.merge!('script.presort' => @presort_script)
         body.merge!('script.presort.param' => @presort_scriptparam) if @presort_scriptparam.present?
       end
 
       if @portal_limits
-        portal_hash = { portal: @portal_limits.map { |portal_name, limit| "#{portal_name}" } }
+        portal_hash = { portal: @portal_limits.map { |portal_name, _limit| portal_name } }
         body.merge!(portal_hash)
         @portal_limits.each { |portal_name, limit| body.merge!({ "limit.#{portal_name}" => limit.to_s }) }
       end
 
       body = body.to_json
-      response = Request.make_request(url, "Bearer #{Request.get_token}", 'post', body)
-
-      if response['messages'][0]['code'] != '0'
-        if response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'
-          resp = RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields).send(method, *args, &block)
-          return resp
-        else
-          if response['messages'][0]['code'] == '102'
-            results = Request.retrieve_first(@trophonius_model.layout_name)
-            if results['messages'][0]['code'] != '0'
-              Error.throw_error('102')
-            else
-              r_results = results['response']['data']
-              ret_val = r_results.empty? ? Error.throw_error('102') : r_results[0]['fieldData']
-              query_keys = new_field_data.map { |q| q.keys.map(&:downcase) }.uniq
-              Error.throw_error('102', (query_keys - ret_val.keys.map(&:downcase)).flatten.join(', '), @trophonius_model.layout_name)
-            end
-          end
-          Error.throw_error(response['messages'][0]['code'])
-        end
-      else
+      response = DatabaseRequest.make_request(url, 'post', body)
+
+      if response['messages'][0]['code'] == '0'
         r_results = response['response']['data']
         ret_val = RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields)
 
@@ -285,7 +256,23 @@ module Trophonius
           ret_val << hash
         end
         @response = ret_val
-        return @response.send(method, *args, &block)
+        @response.send(method, *args, &block)
+      elsif response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'
+        RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields).send(method, *args, &block)
+
+      else
+        if response['messages'][0]['code'] == '102'
+          results = DatabaseRequest.retrieve_first(@trophonius_model.layout_name)
+          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 = new_field_data.map { |q| q.keys.map(&:downcase) }.uniq
+            Error.throw_error('102', (query_keys - ret_val.keys.map(&:downcase)).flatten.join(', '), @trophonius_model.layout_name)
+          else
+            Error.throw_error('102')
+          end
+        end
+        Error.throw_error(response['messages'][0]['code'])
       end
     end