trophonius 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b838d18be991c51c6c3190b0a09c552852778726a803ea0cb5a9186e542fb63a
-  data.tar.gz: 36f06cb81b17c474e73684d9f42260a31ff3658c9607e6dbb3a1412ef2749079
+  metadata.gz: a314aa079b0dc7fca08f9796cfed19723f93006d2fef258b59517e9b20dd8c7a
+  data.tar.gz: f75dccd8b89ef66f69f15289f41e0389d946a9c25a96fdc7a19391eb296aa19f
 SHA512:
-  metadata.gz: 043f1c4dc5584aa2627c0a0a6c438f5519b9797223025e5997fc7d0f6f4e1adf0889a9d5d4e41dcecab0049b48f468978f7edaa249ef4ebc7007e16426cb8543
-  data.tar.gz: c7493bb44cf5a9d87ad78d4b82fa61d61272aa8dc6eed200d9e20d82bbf0079265f86c2000e4585ff09259253e47802476c14595cf878739933c9a220a7f7b49
+  metadata.gz: 88e13826eb573c46ad06bc4b6eb63a23769231a5a1134820b3b3a5c6e8ca208a5c7c95756eaf549d5a8c4e44e6be5f5a1fa2a3fdec86b3d80cdc60fab34c237b
+  data.tar.gz: cde2425883080994637eda7c571f3bfa4196c65118d798630e55bc1b7108d45a74a37dafe8f23dc7906becae35bcd39b36635ea4459fa125316655df8d0807b2

data/lib/trophonius_error.rb

@@ -47,258 +47,258 @@ module Trophonius
         raise RecordNotFoundError.new, 'Empty result'
       when '9'
         raise UnauthenticatedError.new, 'User has insufficient privileges'
-      # when '10'
-      # when '11'
-      # when '12'
-      # when '13'
-      # when '14'
-      # when '15'
-      # when '16'
-      # when '17'
-      # when '16'
-      # when '18'
-      # when '19'
-      # when '09'
-      # when '20'
-      # when '21'
-      # when '100'
+        # when "10"
+        # when "11"
+        # when "12"
+        # when "13"
+        # when "14"
+        # when "15"
+        # when "16"
+        # when "17"
+        # when "16"
+        # when "18"
+        # when "19"
+        # when "09"
+        # when "20"
+        # when "21"
+        # when "100"
       when '101'
-        raise RecordNotFoundError.new, 'Record #{more_info} was not found'
+        raise RecordNotFoundError.new, "Record #{more_info} was not found"
       when '102'
         if more_info != 0
           raise FieldUnexistingError.new, "Following field(s) #{more_info} do not exist on layout #{layout_info}"
         else
           raise FieldUnexistingError.new, 'Field does not exist'
         end
-      # when '103'
+        # when "103"
       when '104'
         raise ScriptUnexistingError.new, 'Script does not exist'
       when '105'
         raise LayoutUnexistingError.new, 'Layout does not exist'
-      # when '106'
-      # when '107'
-      # when '108'
-      # when '109'
-      # when '110'
-      # when '111'
-      # when '112'
-      # when '113'
-      # when '114'
-      # when '115'
-      # when '116'
-      # when '117'
-      # when '118'
-      # when '130'
-      # when '131'
-      # when '200'
+        # when "106"
+        # when "107"
+        # when "108"
+        # when "109"
+        # when "110"
+        # when "111"
+        # when "112"
+        # when "113"
+        # when "114"
+        # when "115"
+        # when "116"
+        # when "117"
+        # when "118"
+        # when "130"
+        # when "131"
+        # when "200"
       when '201'
         raise FieldNotModifiableError.new, 'Trying to write to a read-only field'
-      # when '202'
-      # when '203'
-      # when '204'
-      # when '205'
-      # when '206'
-      # when '207'
-      # when '208'
-      # when '209'
-      # when '210'
-      # when '211'
-      # when '212'
-      # when '213'
-      # when '214'
-      # when '215'
-      # when '216'
-      # when '217'
-      # when '218'
-      # when '300'
-      # when '301'
-      # when '302'
-      # when '303'
-      # when '304'
-      # when '306'
-      # when '307'
-      # when '308'
+        # when "202"
+        # when "203"
+        # when "204"
+        # when "205"
+        # when "206"
+        # when "207"
+        # when "208"
+        # when "209"
+        # when "210"
+        # when "211"
+        # when "212"
+        # when "213"
+        # when "214"
+        # when "215"
+        # when "216"
+        # when "217"
+        # when "218"
+        # when "300"
+        # when "301"
+        # when "302"
+        # when "303"
+        # when "304"
+        # when "306"
+        # when "307"
+        # when "308"
       when '400'
         raise EmptyFindError.new, '	Find criteria are empty'
       when '401'
-        raise RecordNotFoundError.new, 'Record #{more_info} was not found'
-      # when '402'
+        raise RecordNotFoundError.new, "Record #{more_info} was not found"
+        # when "402"
       when '403'
         raise UnauthenticatedError.new, 'You are unauthenticated to perform this request'
-      # when '404'
-      # when '405'
-      # when '406'
-      # when '407'
-      # when '408'
-      # when '409'
-      # when '410'
-      # when '412'
-      # when '413'
-      # when '414'
-      # when '415'
-      # when '416'
-      # when '417'
-      # when '418'
+        # when "404"
+        # when "405"
+        # when "406"
+        # when "407"
+        # when "408"
+        # when "409"
+        # when "410"
+        # when "412"
+        # when "413"
+        # when "414"
+        # when "415"
+        # when "416"
+        # when "417"
+        # when "418"
       when '500'
         raise ValidationError.new, 'Data value does not meet validation entry options (hint make sure your date values are formatted as MM/DD/YYYY)'
-      # when '501'
-      # when '502'
-      # when '503'
-      # when '504'
-      # when '505'
-      # when '506'
-      # when '507'
-      # when '508'
-      # when '509'
-      # when '510'
-      # when '511'
-      # when '512'
-      # when '513'
-      # when '600'
-      # when '601'
-      # when '602'
-      # when '603'
-      # when '700'
-      # when '706'
-      # when '707'
-      # when '708'
-      # when '711'
-      # when '714'
-      # when '715'
-      # when '716'
-      # when '717'
-      # when '718'
-      # when '719'
-      # when '720'
-      # when '721'
-      # when '722'
-      # when '723'
-      # when '724'
-      # when '725'
-      # when '726'
-      # when '727'
-      # when '729'
-      # when '730'
-      # when '731'
-      # when '732'
-      # when '733'
-      # when '734'
-      # when '735'
-      # when '736'
-      # when '738'
-      # when '800'
-      # when '801'
-      # when '802'
-      # when '803'
-      # when '804'
-      # when '805'
-      # when '806'
-      # when '807'
-      # when '808'
-      # when '809'
-      # when '810'
-      # when '811'
-      # when '812'
-      # when '813'
-      # when '814'
-      # when '815'
-      # when '816'
-      # when '817'
-      # when '819'
-      # when '820'
-      # when '821'
-      # when '822'
-      # when '823'
-      # when '824'
-      # when '825'
-      # when '826'
-      # when '827'
-      # when '850'
-      # when '851'
-      # when '852'
-      # when '853'
-      # when '900'
-      # when '901'
-      # when '902'
-      # when '903'
-      # when '905'
-      # when '906'
-      # when '920'
-      # when '921'
-      # when '922'
-      # when '923'
-      # when '951'
+        # when "501"
+        # when "502"
+        # when "503"
+        # when "504"
+        # when "505"
+        # when "506"
+        # when "507"
+        # when "508"
+        # when "509"
+        # when "510"
+        # when "511"
+        # when "512"
+        # when "513"
+        # when "600"
+        # when "601"
+        # when "602"
+        # when "603"
+        # when "700"
+        # when "706"
+        # when "707"
+        # when "708"
+        # when "711"
+        # when "714"
+        # when "715"
+        # when "716"
+        # when "717"
+        # when "718"
+        # when "719"
+        # when "720"
+        # when "721"
+        # when "722"
+        # when "723"
+        # when "724"
+        # when "725"
+        # when "726"
+        # when "727"
+        # when "729"
+        # when "730"
+        # when "731"
+        # when "732"
+        # when "733"
+        # when "734"
+        # when "735"
+        # when "736"
+        # when "738"
+        # when "800"
+        # when "801"
+        # when "802"
+        # when "803"
+        # when "804"
+        # when "805"
+        # when "806"
+        # when "807"
+        # when "808"
+        # when "809"
+        # when "810"
+        # when "811"
+        # when "812"
+        # when "813"
+        # when "814"
+        # when "815"
+        # when "816"
+        # when "817"
+        # when "819"
+        # when "820"
+        # when "821"
+        # when "822"
+        # when "823"
+        # when "824"
+        # when "825"
+        # when "826"
+        # when "827"
+        # when "850"
+        # when "851"
+        # when "852"
+        # when "853"
+        # when "900"
+        # when "901"
+        # when "902"
+        # when "903"
+        # when "905"
+        # when "906"
+        # when "920"
+        # when "921"
+        # when "922"
+        # when "923"
+        # when "951"
       when '952'
         raise InvalidTokenError.new, 'Could not retrieve a valid token from FileMaker, check your FileMaker server'
-      # when '954'
-      # when '955'
-      # when '956'
-      # when '957'
-      # when '958'
-      # when '959'
-      # when '960'
-      # when '1200'
-      # when '1201'
-      # when '1202'
-      # when '1203'
-      # when '1204'
-      # when '1205'
-      # when '1206'
-      # when '1207'
-      # when '1208'
-      # when '1209'
-      # when '1210'
-      # when '1211'
-      # when '1212'
-      # when '1213'
-      # when '1214'
-      # when '1215'
-      # when '1216'
-      # when '1217'
-      # when '1218'
-      # when '1219'
-      # when '1220'
-      # when '1221'
-      # when '1222'
-      # when '1223'
-      # when '1224'
-      # when '1225'
-      # when '1300'
-      # when '1301'
-      # when '1400'
-      # when '1401'
-      # when '1402'
-      # when '1403'
-      # when '1404'
-      # when '1405'
-      # when '1406'
-      # when '1407'
-      # when '1408'
-      # when '1409'
-      # when '1413'
-      # when '1414'
-      # when '1450'
-      # when '1451'
-      # when '1501'
-      # when '1502'
-      # when '1503'
-      # when '1504'
-      # when '1505'
-      # when '1506'
-      # when '1507'
-      # when '1550'
-      # when '1551'
-      # when '1626'
-      # when '1627'
-      # when '1628'
-      # when '1629'
-      # when '1630'
+        # when "954"
+        # when "955"
+        # when "956"
+        # when "957"
+        # when "958"
+        # when "959"
+        # when "960"
+        # when "1200"
+        # when "1201"
+        # when "1202"
+        # when "1203"
+        # when "1204"
+        # when "1205"
+        # when "1206"
+        # when "1207"
+        # when "1208"
+        # when "1209"
+        # when "1210"
+        # when "1211"
+        # when "1212"
+        # when "1213"
+        # when "1214"
+        # when "1215"
+        # when "1216"
+        # when "1217"
+        # when "1218"
+        # when "1219"
+        # when "1220"
+        # when "1221"
+        # when "1222"
+        # when "1223"
+        # when "1224"
+        # when "1225"
+        # when "1300"
+        # when "1301"
+        # when "1400"
+        # when "1401"
+        # when "1402"
+        # when "1403"
+        # when "1404"
+        # when "1405"
+        # when "1406"
+        # when "1407"
+        # when "1408"
+        # when "1409"
+        # when "1413"
+        # when "1414"
+        # when "1450"
+        # when "1451"
+        # when "1501"
+        # when "1502"
+        # when "1503"
+        # when "1504"
+        # when "1505"
+        # when "1506"
+        # when "1507"
+        # when "1550"
+        # when "1551"
+        # when "1626"
+        # when "1627"
+        # when "1628"
+        # when "1629"
+        # when "1630"
       when '1631'
         raise ConnectionError.new, 'An error occurred while attempting to connect to the FileMaker server'
-      # when '1632'
-      # when '1633'
+        # when "1632"
+        # when "1633"
       else
-        raise ResponseNotYetImplementedError.new, 'An unknown error has been encountered: err_no was #{error_id}'
+        raise ResponseNotYetImplementedError.new, "An unknown error has been encountered: err_no was #{error_id}"
       end
     end
   end

data/lib/trophonius_model.rb

@@ -1,9 +1,9 @@
-require "json"
-require "trophonius_config"
-require "trophonius_record"
-require "trophonius_recordset"
-require "trophonius_query"
-require "trophonius_error"
+require 'json'
+require 'trophonius_config'
+require 'trophonius_record'
+require 'trophonius_recordset'
+require 'trophonius_query'
+require 'trophonius_error'
 
 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.
@@ -13,10 +13,10 @@ module Trophonius
 
     def initialize(config:)
       @configuration = config
-      @offset = ""
-      @limit = ""
+      @offset = ''
+      @limit = ''
     end
-    
+
     ##
     # Sets up the configuration for the model.
     #
@@ -28,8 +28,8 @@ module Trophonius
       @configuration.non_modifiable_fields = configuration[:non_modifiable_fields]
       @configuration.all_fields = {}
       @configuration.translations = {}
-      @offset = ""
-      @limit = ""
+      @offset = ''
+      @limit = ''
     end
 
     ##
@@ -80,11 +80,9 @@ module Trophonius
 
     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 )
+      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
+      new_instance.current_query.send(method, args) if new_instance.current_query.respond_to?(method)
     end
 
     def method_missing(method, *args, &block)
@@ -106,7 +104,7 @@ module Trophonius
     # @return [Trophonius::Model] new instance of the model
     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 = Trophonius::Query.new(trophonius_model: self, limit: @limit, offset: @offset)
       new_instance.current_query.build_query[0].merge!(fieldData)
       new_instance
     end
@@ -131,38 +129,44 @@ module Trophonius
     # @return [Record] the created record
     #   Model.create(fieldOne: "Data")
     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")
+      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
+      create_translations if @configuration.translations.keys.empty?
       fieldData.keys.each do |k|
         if @configuration.translations.keys.include?(k.to_s)
-          new_field_data.merge!({"#{@configuration.translations[k.to_s]}" => fieldData[k]})
+          new_field_data.merge!({ "#{@configuration.translations[k.to_s]}" => fieldData[k] })
         else
-          new_field_data.merge!({"#{k}" => fieldData[k]})
+          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"
-        if response["messages"][0]["code"] == "102"
+      response = Request.make_request(url, "Bearer #{Request.get_token}", 'post', body)
+      if response['messages'][0]['code'] != '0'
+        if response['messages'][0]['code'] == '102'
           results = Request.retrieve_first(layout_name)
-          if results["messages"][0]["code"] != "0"
-            Error.throw_error("102")
+          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']
-            Error.throw_error("102", (new_field_data.keys.map(&:downcase) - ret_val.keys.map(&:downcase)).flatten.join(', '), layout_name) 
+            r_results = results['response']['data']
+            ret_val = r_results.empty? ? Error.throw_error('102') : r_results[0]['fieldData']
+            Error.throw_error('102', (new_field_data.keys.map(&:downcase) - ret_val.keys.map(&:downcase)).flatten.join(', '), layout_name)
           end
         end
-        Error.throw_error(response["messages"][0]["code"])
+        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
+        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') { 1 }
         return ret_val
       end
     end
@@ -175,25 +179,31 @@ module Trophonius
     # @return [Record] a Record object that correspond to FileMaker record fitting the find request
     #   Model.find_by(fieldOne: "Data")
     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")
+      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
+      create_translations if @configuration.translations.keys.empty?
       fieldData.keys.each do |k|
         if @configuration.translations.keys.include?(k.to_s)
-          new_field_data.merge!({"#{@configuration.translations[k.to_s]}" => fieldData[k]})
+          new_field_data.merge!({ "#{@configuration.translations[k.to_s]}" => fieldData[k] })
         else
-          new_field_data.merge!({"#{k}" => fieldData[k]})
+          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"])
+      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'
+        if response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'
+          return RecordSet.new(self.layout_name, self.non_modifiable_fields)
+        end
+        Error.throw_error(response['messages'][0]['code'])
       else
-        r_results = response["response"]["data"]
+        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)
@@ -210,15 +220,18 @@ module Trophonius
     #
     # @return [Record] the record
     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)
+      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
+        ret_val = build_result(response['response']['data'][0])
+        ret_val.send(:define_singleton_method, 'result_count') { 1 }
         return ret_val
       end
     end
@@ -230,10 +243,15 @@ module Trophonius
     #
     # @return [Boolean] True if the delete was successful
     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"])
+      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
@@ -248,25 +266,24 @@ module Trophonius
     #
     # @return [Boolean] True if the delete was successful
     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}")
+      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
+      create_translations if @configuration.translations.keys.empty?
       fieldData.keys.each do |k|
         if @configuration.translations.keys.include?(k.to_s)
-          new_field_data.merge!({"#{@configuration.translations[k.to_s]}" => fieldData[k]})
+          new_field_data.merge!({ "#{@configuration.translations[k.to_s]}" => fieldData[k] })
         else
-          new_field_data.merge!({"#{k}" => fieldData[k]})
+          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
+      response = Request.make_request(url, "Bearer #{Request.get_token}", 'patch', body)
+      response['messages'][0]['code'] != '0' ? Error.throw_error(response['messages'][0]['code']) : true
     end
 
     ##
@@ -276,45 +293,52 @@ module Trophonius
     #
     # @return [Record] A Record with singleton_methods for the fields where possible
     def self.build_result(result)
-      hash = Trophonius::Record.new()
-      hash.record_id = result["recordId"]
+      hash = Trophonius::Record.new
+      hash.record_id = result['recordId']
       hash.layout_name = layout_name
-      result["fieldData"].keys.each do |key|
+      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}" })
+        @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|
+          @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
+        hash.merge!({ key => result['fieldData'][key] })
+        hash.modifiable_fields.merge!({ key => result['fieldData'][key] }) unless non_modifiable_fields&.include?(key)
       end
-      result["portalData"].keys.each do |key|
+      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|
+        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: '_')
+            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"] }
+              inner_hash.send(:define_singleton_method, 'record_id') { inner_hash['recordId'] }
             end
           end
         end
-        hash.merge!({key => result["portalData"][key]})
+        hash.merge!({ key => result['portalData'][key] })
       end
       return hash
     end
@@ -325,14 +349,12 @@ module Trophonius
     # @return [Record]: a Record corresponding to the FileMaker record.
     def self.first
       results = Request.retrieve_first(layout_name)
-      if results["messages"][0]["code"] != "0"
-        Error.throw_error(results["messages"][0]["code"])
+      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
+        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') { r_results.empty? ? 0 : 1 }
         return ret_val
       end
     end
@@ -345,14 +367,14 @@ module Trophonius
     # @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: "")
+    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"
+      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 = result['response']['scriptResult']
         return ret_val
       end
     end
@@ -365,19 +387,29 @@ module Trophonius
     # @return [RecordSet]: a RecordSet containing all the Record objects that correspond to the FileMaker records.
     def self.all(sort: {})
       results = Request.retrieve_all(layout_name, sort)
-      count = results["response"]["scriptResult"].to_i
+      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}")
+        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}")
+        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 ? 1_000_000 : 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"])
+      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"]
+        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)

data/lib/trophonius_query.rb

@@ -30,6 +30,14 @@ module Trophonius
       @current_query ||= [{}]
     end
 
+    ##
+    # Returns the current sort order, creates an empty sort order if no current sort order exists
+    #
+    # @return [Array[Hash]] array representing the FileMaker sort request
+    def build_sort
+      @current_sort ||= []
+    end
+
     def inspect
       @current_query
     end
@@ -54,6 +62,34 @@ module Trophonius
       args[1]
     end
 
+    ##
+    # Sets or updates the limit and offset for a query
+    #
+    # @param [args] arguments containing the limit and offset
+    # @return [Trophonius::Model] updated base model
+    def paginate(args)
+      @offset = args[0]
+      @limit = args[1]
+      args[2]
+    end
+
+    ##
+    # Adds a sort request to the original query, resulting in an "sorted" query
+    #
+    # @param [args] arguments containing a Hash containing the FileMaker sort request, and the base model object for the query
+    # @return [Trophonius::Model] updated base model
+    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
+      end
+      args[1]
+    end
+
     ##
     # Performs the query in FileMaker
     #
@@ -63,11 +99,15 @@ module Trophonius
     #
     # @return Response of the called method
     def run_query(method, *args, &block)
-      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{@trophonius_model.layout_name}/_find")
+      url =
+        URI(
+          "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{
+            @trophonius_model.layout_name
+          }/_find"
+        )
       new_field_data = @current_query.map { |_q| {} }
-      if @trophonius_model.translations.keys.empty?
-        @trophonius_model.create_translations
-      end
+
+      @trophonius_model.create_translations if @trophonius_model.translations.keys.empty?
       @current_query.each_with_index do |query, index|
         query.keys.each do |k|
           if @trophonius_model.translations.key?(k.to_s)
@@ -77,26 +117,37 @@ module Trophonius
           end
         end
       end
-      if @offset.empty? || @limit.empty?
-        body = { query: new_field_data, limit: '100000' }.to_json
+      if @offset.nil? || @limit.nil? || @offset == '' || @limit == '' || @offset == 0 || @limit == 0
+        body =
+          if @current_sort.nil?
+            { query: new_field_data, limit: '100000' }.to_json
+          else
+            { query: new_field_data, sort: @current_sort, limit: '100000' }.to_json
+          end
       else
-        body = { query: new_field_data, limit: @limit.to_s, offset: @offset.to_s }.to_json
+        body =
+          if @current_sort.nil?
+            { query: new_field_data, limit: @limit.to_s, offset: @offset.to_s }.to_json
+          else
+            { query: new_field_data, sort: @current_sort, limit: @limit.to_s, offset: @offset.to_s }.to_json
+          end
       end
+
       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'
           RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields).send(method, *args, &block)
           return
         else
-          if response["messages"][0]["code"] == "102"
+          if response['messages'][0]['code'] == '102'
             results = Request.retrieve_first(@trophonius_model.layout_name)
-            if results["messages"][0]["code"] != "0"
-              Error.throw_error("102")
+            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']
+              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) 
+              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'])

data/lib/trophonius_redis_manager.rb

@@ -1,4 +1,5 @@
 module Trophonius
+  # the RedisManager module is used to create a (single) connection to a redis store.
   module Trophonius::RedisManager
     def self.connect
       if ENV['REDIS_URL'] && ENV['REDIS_URL'] != ''
@@ -6,27 +7,52 @@ module Trophonius
       else
         @redis ||= Redis.new
       end
+      return nil
     end
 
+    ##
+    # Checks whether the given key exists
+    #
+    # @param [String] key: the key to check
+    # @return [Boolean] true or false depending on whether the key exists in the redis store or not
     def self.key_exists?(key:)
       connect unless connected?
       !(@redis.get(key).nil? || @redis.get(key).empty?)
     end
 
+    ##
+    # Get the value corresponding with the key
+    #
+    # @param [String] key: the key to find
+    # @return [String] the value corresponding with the key
     def self.get_key(key:)
       connect unless connected?
       @redis.get(key)
     end
 
+    ##
+    # Set the value corresponding with a key
+    #
+    # @param [String] key: the key to store in redis
+    # @param [any] value: the value for the key
+    # @return [String] the value corresponding with the key
     def self.set_key(key:, value:)
       connect unless connected?
       @redis.set(key, value)
     end
 
+    ##
+    # Checks whether we are connected to redis
+    #
+    # @return [Boolean] true or false depending on whether a connection to redis has been established
     def self.connected?
       @redis.nil? == false && @redis.connected?
     end
 
+    ##
+    # Disconnects from redis as quickly and as silently as possible
+    #
+    # @return [NilClass] nil
     def self.disconnect
       @redis.disconnect!
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophonius
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Kempen Automatisering
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
 summary: Link between Ruby (on Rails) and FileMaker.