trophonius 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c744efd7c138bb2666a5fbe75aca5098a8503e06c235ed19014e175e331efbb
+  data.tar.gz: e58679a2dd7b909e5349b3493a58262c74f3a251de1ff7245d7491379606cae3
+SHA512:
+  metadata.gz: 8fcf452c57e99c7bd282712c46d564d21801f383a9a4af39cfbb49c81077bd03133c738f7ce343afaed05efa1b13394f51a8f6afacf5c5880896b2c6735fad8b
+  data.tar.gz: 9dfe62d1a27018d9d2cf9f706af9333f84ff92680a68d8afd891d3c572ee1b0ea475679d73a8f85a6a3aab170ffdd6850acf8f06e0ac98246b57ce950aaaeaf9

data/lib/trophonius.rb

@@ -0,0 +1,19 @@
+require 'trophonius_request'
+require 'trophonius_model'
+require 'trophonius_config'
+
+module Trophonius # :nodoc:
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.config
+    @configuration
+  end
+
+  private
+end

data/lib/trophonius_config.rb

@@ -0,0 +1,18 @@
+require 'active_support/configurable'
+
+module Trophonius
+  class Trophonius::Configuration # :nodoc:
+    include ActiveSupport::Configurable
+
+    config_accessor(:host) { '127.0.0.1' }
+    config_accessor(:port) { 0 }
+    config_accessor(:database) { '' }
+    config_accessor(:username) { 'Admin' }
+    config_accessor(:password) { '' }
+    config_accessor(:ssl) { true }
+    config_accessor(:count_result_script) { '' }
+    config_accessor(:layout_name) { '' }
+    config_accessor(:non_modifiable_fields) { [] }
+    config_accessor(:local_network) { false }
+  end
+end

data/lib/trophonius_connection.rb

@@ -0,0 +1,90 @@
+require 'base64'
+require 'typhoeus'
+
+module Trophonius
+  module Trophonius::Connection
+    ##
+    # Creates a new connection to FileMaker
+    #
+    # @return [String] the *token* used to connect with the FileMaker data api
+
+    def self.connect
+      @token = setup_connection
+      @last_connection = Time.now
+      @token
+    end
+
+    ##
+    # Creates and runs a HTTP request to create a new data api connection
+    # This method throws an error when the request returns with a HTTP error or a FileMaker error
+    # @return [String] the *token* used to connect with the FileMaker data api if successful
+
+    def self.setup_connection
+      @token = ''
+      ssl_verifyhost = Trophonius.config.local_network ? 0 : 2
+      ssl_verifypeer = !Trophonius.config.local_network
+      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/sessions")
+      request = Typhoeus::Request.new(
+        url,
+        method: :post,
+        body: {},
+        params: {},
+        ssl_verifyhost: ssl_verifyhost,
+        ssl_verifypeer: ssl_verifypeer,
+        headers: { 'Content-Type' => 'application/json', Authorization: "Basic #{Base64.strict_encode64("#{Trophonius.config.username}:#{Trophonius.config.password}")}" }
+      )
+      temp = request.run
+
+      begin
+        parsed = JSON.parse(temp.response_body)
+        if parsed['messages'][0]['code'] != '0'
+          Error.throw_error(response['messages'][0]['code'])
+        end
+        return parsed['response']['token']
+      rescue Exception
+        Error.throw_error('1631')
+      end
+    end
+
+    ##
+    # Returns the last received token
+    # @return [String] the last valid *token* used to connect with the FileMaker data api
+    def self.token
+      @token
+    end
+
+    ##
+    # Returns the receive time of the last received token
+    # @return [Time] Returns the receive time of the last received token
+    def self.last_connection
+      @last_connection
+    end
+
+    ##
+    # Tests whether the FileMaker token is still valid
+    # @return [Boolean] True if the token is valid False if invalid
+    def self.test_connection
+      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{Trophonius.config.layout_name}/records?_limit=1")
+      begin
+        request = Typhoeus::Request.new(
+          url,
+          method: :get,
+          body: {},
+          params: {},
+          headers: { 'Content-Type' => 'application/json', Authorization: "Bearer #{@token}" }
+        )
+        temp = request.run
+        JSON.parse(temp.response_body)['messages'][0]['code'] == '0'
+      rescue StandardError
+        return false
+      end
+    end
+
+    ##
+    # Returns whether the current connection is still valid
+    # @return [Boolean] True if the connection is valid False if invalid
+    def self.valid_connection?
+      @last_connection.nil? ? false : (((Time.now - last_connection) / 60).round <= 15 || test_connection)
+    end
+  end
+end

data/lib/trophonius_error.rb

@@ -0,0 +1,297 @@
+require 'json'
+require 'trophonius_config'
+
+module Trophonius
+  module Trophonius::Error
+    class RecordNotFoundError < StandardError; end # :nodoc:
+    class FieldUnexistingError < NoMethodError; end # :nodoc:
+    class ScriptUnexistingError < NoMethodError; end # :nodoc:
+    class LayoutUnexistingError < NoMethodError; end # :nodoc:
+    class InvalidTokenError < StandardError; end # :nodoc:
+    class UnauthenticatedError < StandardError; end # :nodoc:
+    class FieldNotModifiableError < StandardError; end # :nodoc:
+    class ResponseNotYetImplementedError < StandardError; end # :nodoc:
+    class UnknownFileMakerError < StandardError; end # :nodoc:
+    class UserCanceledError < StandardError; end # :nodoc:
+    class MemoryError < StandardError; end # :nodoc:
+    class FileError < StandardError; end # :nodoc:
+    class CommandError < StandardError; end # :nodoc:
+    class ConnectionError < StandardError; end # :nodoc:
+
+    ##
+    # Throws an error corresponding to the error number
+    # :args: error_id, more_info
+    def self.throw_error(error_id, more_info = 0)
+      case error_id
+      when '-1'
+        raise UnknownFileMakerError.new, 'Unknown Error Ocurred'
+      when '0'
+        raise UnknownFileMakerError.new, 'Unknown Error Ocurred'
+      when '1'
+        raise UserCanceledError.new, 'An outside source canceled the action'
+      when '2'
+        raise MemoryError.new, 'FileMaker encountered a memory error'
+      when '3'
+        raise CommandError.new, 'Command is unavailable (for example, wrong operating system or mode)'
+      when '4'
+        raise CommandError.new, 'Command is unknown'
+      when '5'
+        raise CommandError.new, 'Command is invalid, check your FileMaker script/calculation'
+      when '6'
+        raise FileError.new, 'File is read-only'
+      when '7'
+        raise MemoryError.new, 'FileMaker is running out of memory'
+      when '8'
+        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 '101'
+        raise RecordNotFoundError.new, "Record #{more_info} was not found"
+      when '102'
+        raise FieldUnexistingError.new, 'Field does not exist'
+      # 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 '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 "400"
+      when '401'
+        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 "500"
+      # 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 '1631'
+        raise ConnectionError.new, 'An error occurred while attempting to connect to the FileMaker server'
+      # when "1632"
+      # when "1633"
+      else
+        raise ResponseNotYetImplementedError.new, "An unknown error has been encountered: err_no was #{error_id}"
+      end
+    end
+  end
+end

data/lib/trophonius_model.rb

@@ -0,0 +1,251 @@
+require "json"
+require "trophonius_config"
+require "trophonius_record"
+require "trophonius_recordset"
+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.
+  class Trophonius::Model
+    # Contains all the fields on the model (modifiable and non_modifiable)
+    attr_reader :all_fields
+
+    ##
+    # 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]
+      @all_fields = {}
+    end
+
+    ##
+    # Returns the FileMaker layout this Model corresponds to
+    def self.layout_name
+      @configuration.layout_name
+    end
+    
+    ##
+    # Returns the fields that FileMaker won't allow us to modify
+    def self.non_modifiable_fields
+      @configuration.non_modifiable_fields
+    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(fieldData)
+      url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records")
+      body = "{\"fieldData\": #{fieldData.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
+    
+    ##
+    # Finds and returns a RecordSet containing the records fitting the find request
+    # 
+    # @param [Hash] fieldData: the data to find
+    #
+    # @return [RecordSet] a RecordSet containing all the Record objects that correspond to FileMaker records fitting the find request
+    #   Model.where(fieldOne: "Data")
+    def self.where(fieldData)
+      url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{self.layout_name}/_find")
+      body = "{\"query\": [#{fieldData.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
+      end
+    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)
+      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
+
+    ##
+    # 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)
+      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
+
+    ##
+    # 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, 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}")
+      body = "{\"fieldData\": #{fieldData.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
+
+    ##
+    # 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)
+      hash = Trophonius::Record.new()
+      hash.id = result["recordId"]
+      hash.layout_name = layout_name
+      result["fieldData"].keys.each do |key|
+        unless key[/\s/] || key[/\W/]
+          hash.send(:define_singleton_method, key.to_s) do
+            hash[key]
+          end
+          unless non_modifiable_fields&.include?(key)
+            @all_fields.merge!(key.to_s.downcase => key.to_s)
+            hash.send(:define_singleton_method, "#{key.to_s}=") do |new_val|
+              hash[key] = new_val
+              hash.modifiable_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, key.to_s) do
+            hash[key]
+          end
+        end
+        result["portalData"][key].each_with_index do |inner_hash|
+          inner_hash.keys.each do |inner_key|
+            inner_method = inner_key.gsub(/\w+::/, "")
+            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, "id") { inner_hash["recordId"] }
+            end
+          end
+        end
+        hash.merge!({key => result["portalData"][key]})
+      end
+      return hash
+    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
+      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
+
+    ##
+    # 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: "")
+      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
+
+    ##
+    # 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: {})
+      results = Request.retrieve_all(layout_name, sort)
+      count = results["response"]["scriptResult"].to_i
+      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}")
+      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
+  end
+end

data/lib/trophonius_record.rb

@@ -0,0 +1,74 @@
+require 'json'
+require 'trophonius_config'
+
+module Trophonius
+  # 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
+  class Trophonius::Record < Hash
+    attr_accessor :id, :layout_name, :modifiable_fields
+
+    ##
+    # Initializes a new Record
+    def initialize
+      @modifiable_fields = {}
+    end
+
+    def []=(field, new_val)
+      modifiable_fields[field] = new_val
+      super
+    end
+
+    ##
+    # Saves the last changes made to the Record to FileMaker.
+    # Throws a FileMaker error if save failed
+    #
+    # @return [True] if successful
+    def save
+      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{id}")
+      body = "{\"fieldData\": #{modifiable_fields.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
+        return true
+      end
+    end
+
+    ##
+    # Deletes the corresponding record from FileMaker
+    # Throws a FileMaker error if save failed
+    #
+    # @return [True] if successful
+    def delete
+      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{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
+
+    ##
+    # Changes and saves the corresponding record in FileMaker
+    # Throws a FileMaker error if save failed
+    #
+    # @param [Hash] fieldData: Fields to be changed and data to fill the fields with
+    #
+    # @return [True] if successful
+    def update(fieldData)
+      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{id}")
+      fieldData.keys.each do |field|
+        modifiable_fields[field] = fieldData[field]
+      end
+      body = "{\"fieldData\": #{fieldData.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
+        return true
+      end
+    end
+  end
+end

data/lib/trophonius_recordset.rb

@@ -0,0 +1,58 @@
+require 'json'
+require 'trophonius_config'
+require 'trophonius_model'
+require 'trophonius_connection'
+
+module Trophonius
+  # A RecordSet contains all records, as Record, retrieved from the FileMaker database
+  class Trophonius::RecordSet < Array
+    attr_accessor :result_count, :layout_name, :non_modifiable_fields, :records
+
+    class EmptyParameterError < ArgumentError; end # :nodoc:
+
+    ##
+    # Initializes a new RecordSet
+    #
+    # @param [String] l_name: name of the FileMaker layout
+    #
+    # @param [Array] nmf: names of the fields that cannot be modified (calculation fields etc.)
+    def initialize(l_name, nmf)
+      self.layout_name = l_name
+      self.non_modifiable_fields = nmf
+      self.records = []
+    end
+
+    def <<(data)
+      records << data
+      super
+    end
+
+    ##
+    # This method allows to chain where statements
+    #
+    # @param [Hash] fielddata: hash containing the query
+    #
+    # @return [RecordSet] the records where the statement holds
+    def where(fielddata)
+      raise EmptyParameterError.new, 'No requested data to find' if fielddata.nil? || fielddata.empty?
+
+      temp = Trophonius::Model
+      temp.config layout_name: layout_name, non_modifiable_fields: non_modifiable_fields
+      retval = temp.where(fielddata)
+      retval
+    end
+
+    ##
+    # This method chops the RecordSet up in parts.
+    #
+    # @param [Integer] page: the current page
+    #
+    # @param [Integer] records_per_page: the amount of records on the page
+    #
+    # @return [RecordSet] the records in the range ((page * records_per_page) - records_per_page) + 1 until ((page * records_per_page) - records_per_page) + 1 + records_per_page
+    def paginate(page, records_per_page)
+      offset = ((page * records_per_page) - records_per_page) + 1
+      records[offset...offset + records_per_page]
+    end
+  end
+end

data/lib/trophonius_request.rb

@@ -0,0 +1,84 @@
+require 'base64'
+require 'trophonius_connection'
+
+module Trophonius
+  module Trophonius::Request
+    ##
+    # Crafts and runs a HTTP request of any type
+    #
+    # @param [URI] urlparam: the url to make the request to
+    #
+    # @param [String] auth: the authentication required for the request
+    #
+    # @param [String] method: the type of HTTP request to make (i.e. get)
+    #
+    # @param [JSONString] body: the body of the HTTP request
+    #
+    # @param [String] params: optional parameters added to the request
+    #
+    # @return [JSON] parsed json of the response
+    def self.make_request(url_param, auth, method, body, params = '')
+      ssl_verifyhost = Trophonius.config.local_network ? 0 : 2
+      ssl_verifypeer = !Trophonius.config.local_network
+      request = Typhoeus::Request.new(
+        url_param,
+        method: method.to_sym,
+        body: body,
+        params: params,
+        ssl_verifyhost: ssl_verifyhost,
+        ssl_verifypeer: ssl_verifypeer,
+        headers: { 'Content-Type' => 'application/json', Authorization: auth.to_s }
+      )
+      temp = request.run
+      begin
+        JSON.parse(temp.response_body)
+      rescue Exception
+        Error.throw_error('1631')
+      end
+    end
+
+    ##
+    # Gets the current FileMaker token
+    #
+    # @return [String] a valid FileMaker token
+    def self.get_token
+      if Connection.valid_connection?
+        Connection.token
+      else
+        Connection.connect
+      end
+    end
+
+    ##
+    # Retrieves the first record from FileMaker
+    #
+    # @return [JSON] The first record from FileMaker
+    def self.retrieve_first(layout_name)
+      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records?_limit=1")
+      make_request(url, "Bearer #{get_token}", 'get', '{}')
+    end
+
+    ##
+    # Runs a FileMaker script
+    #
+    # @return [JSON] The script result from FileMaker
+    def self.run_script(script, scriptparameter, layout_name)
+      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records?_limit=1&script=#{script}&script.param=#{scriptparameter}")
+      make_request(url, "Bearer #{get_token}", 'get', '{}')
+    end
+
+    ##
+    # Retrieves the 10000000 records from FileMaker
+    #
+    # @return [JSON] The first 10000000 records from FileMaker
+    def self.retrieve_all(layout_name, sort)
+      if !sort.empty?
+        sort_order = sort.to_json.to_s
+        url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records?_limit=10000000_sort=#{sort_order}#{Trophonius.config.count_result_script == '' ? '' : "&script=#{Trophonius.config.count_result_script}"}")
+      else
+        url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records?_limit=10000000#{Trophonius.config.count_result_script == '' ? '' : "&script=#{Trophonius.config.count_result_script}"}")
+      end
+      make_request(url, "Bearer #{get_token}", 'get', '{}')
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: trophonius
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kempen Automatisering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+description: An easy to use link between Ruby (on Rails) and FileMaker using the FileMaker
+  Data-API.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/trophonius.rb
+- lib/trophonius_config.rb
+- lib/trophonius_connection.rb
+- lib/trophonius_error.rb
+- lib/trophonius_model.rb
+- lib/trophonius_record.rb
+- lib/trophonius_recordset.rb
+- lib/trophonius_request.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Link between Ruby (on Rails) and FileMaker.
+test_files: []