trophonius 1.2.4.8 → 1.2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec0214fb6fc5a8cd1fd4d994cb7c5fee184a682199b5adf0120dd385cb31766d
-  data.tar.gz: 44ac6914a04de0e5662c38359073bad47b0db6033241b332ce54185c7149ab30
+  metadata.gz: 1bc9d3598ba559ee5887065d65fe023952f2192a1a5472d23d431304ba4d4cf7
+  data.tar.gz: dd179a8dc6dfa8810f91e877a04ee5af8d2ec592dbc6f9b2230ecefb86cb9eb1
 SHA512:
-  metadata.gz: 97a534c6e3453bdfbfa134af4dae74713537f035a4f45bc2a71ae7b9e54197feecdbcb812024e203a02772f177e3b61cc93ca377b74b97f25be61da7640c6b03
-  data.tar.gz: 8acb6b48dc37c6834c6b26e1abbdf135a8693b499dac8deddec8e17f365d43fd9e9f4759c6d11872723eea7e311d1cf3d1254ab460da75eaa74594ce02697422
+  metadata.gz: 102ec3dc23e80c19ec238051454363f1d263e5e209b60f86cfad6d1498e03e65273ff2127ea57fbb61d83e1bcd7d1f715fe187b78b465bcfc3f95700a1f2e6d1
+  data.tar.gz: 535b030eb950218d4bb54d1a554834c03e402abc56bff1c40e44637467c8274b47c7657b0d73b18f95da4a8d95b8d4a304c5873cfa2cbb37fd60beb6cb899c82

data/lib/trophonius.rb

@@ -1,6 +1,8 @@
 require 'trophonius_request'
 require 'trophonius_model'
 require 'trophonius_config'
+require 'trophonius_date'
+require 'trophonius_time'
 
 module Trophonius # :nodoc:
   def self.configuration

data/lib/trophonius_config.rb

@@ -18,6 +18,8 @@ module Trophonius
     config_accessor(:non_modifiable_fields) { [] }
     config_accessor(:all_fields) { {} }
     config_accessor(:translations) { {} }
+    config_accessor(:has_many_relations) { {} }
+    config_accessor(:belongs_to_relations) { {} }
     config_accessor(:local_network) { false }
     config_accessor(:redis_connection) { false }
   end

data/lib/trophonius_connection.rb

@@ -77,6 +77,43 @@ module Trophonius
       return parsed['response']['token']
     end
 
+    ##
+    # Disconnects from the FileMaker server
+    #
+    def self.disconnect
+      url =
+        URI(
+          "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/sessions/#{
+            Trophonius.config.redis_connection ? Trophonius::RedisManager.get_key(key: 'token') : @token
+          }"
+        )
+      puts url
+      ssl_verifyhost = Trophonius.config.local_network ? 0 : 2
+      ssl_verifypeer = !Trophonius.config.local_network
+
+      request =
+        Typhoeus::Request.new(
+          url,
+          method: :delete,
+          params: {},
+          ssl_verifyhost: ssl_verifyhost,
+          ssl_verifypeer: ssl_verifypeer,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+      temp = request.run
+
+      begin
+        parsed = JSON.parse(temp.response_body)
+      rescue Exception => e
+        Error.throw_error('1631')
+      end
+      Error.throw_error(parsed['messages'][0]['code']) if parsed['messages'][0]['code'] != '0'
+      Trophonius::RedisManager.disconnect! if Trophonius.config.redis_connection
+      @token = nil
+      @last_connection = nil
+      return true
+    end
+
     ##
     # Returns the last received token
     # @return [String] the last valid *token* used to connect with the FileMaker data api

data/lib/trophonius_date.rb

@@ -0,0 +1,5 @@
+class Date
+  def to_fm
+    self.strftime('%m/%d/%Y')
+  end
+end

data/lib/trophonius_error.rb

@@ -19,6 +19,14 @@ module Trophonius
     class ConnectionError < StandardError; end # :nodoc:
     class EmptyFindError < StandardError; end # :nodoc:
     class ValidationError < StandardError; end # :nodoc:
+    class DateValueError < ValidationError; end # :nodoc:
+    class TimeValueError < ValidationError; end # :nodoc:
+    class NumberValueError < ValidationError; end # :nodoc:
+    class ValueOutOfRangeError < ValidationError; end # :nodoc:
+    class ValueNotUniqueError < ValidationError; end # :nodoc:
+    class ValueNotExistingError < ValidationError; end # :nodoc:
+    class ValueNotInValuelistError < ValidationError; end # :nodoc:
+    class ValueFailedCalculationError < ValidationError; end # :nodoc:
 
     ##
     # Throws an error corresponding to the error number
@@ -140,14 +148,21 @@ module Trophonius
         # 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"
+        raise DateValueError.new, 'Date value does not meet validation entry options (hint make sure your date values are formatted as MM/DD/YYYY)'
+      when '501'
+        raise TimeValueError.new, 'Time value does not meet validation entry options'
+      when '502'
+        raise NumberValueError.new, 'Number value does not meet validation entry options'
+      when '503'
+        raise ValueOutOfRangeError.new, 'Value in field is not within the range specified in validation entry options'
+      when '504'
+        raise ValueNotUniqueError.new, 'Value in field is not unique, as required in validation entry options'
+      when '505'
+        raise ValueNotExistingError.new, 'Value in field is not an existing value in the file, as required in validation entry options'
+      when '506'
+        raise ValueNotInValuelistError.new, 'Value in field is not listed in the value list specified in validation entry options'
+      when '507'
+        raise ValueFailedCalculationError.new, 'Value in field failed calculation test of validation entry options'
         # when "508"
         # when "509"
         # when "510"

data/lib/trophonius_model.rb

@@ -28,10 +28,32 @@ module Trophonius
       @configuration.non_modifiable_fields = configuration[:non_modifiable_fields]
       @configuration.all_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.
     #
@@ -53,6 +75,22 @@ module Trophonius
       @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
     #
@@ -296,6 +334,8 @@ module Trophonius
       hash = Trophonius::Record.new
       hash.record_id = result['recordId']
       hash.layout_name = layout_name
+      hash.model_name = name
+
       result['fieldData'].keys.each do |key|
         # unless key[/\s/] || key[/\W/]
         @configuration.translations.merge!(

data/lib/trophonius_record.rb

@@ -8,7 +8,7 @@ module Trophonius
   #
   # 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 :record_id, :layout_name, :modifiable_fields, :modified_fields
+    attr_accessor :record_id, :model_name, :layout_name, :modifiable_fields, :modified_fields
 
     ##
     # Initializes a new Record
@@ -22,20 +22,147 @@ module Trophonius
       super
     end
 
+    def method_missing(method, *args, &block)
+      if ActiveSupport::Inflector.pluralize(method).to_s == method.to_s
+        model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(method)))
+        pk_model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(model_name)))
+
+        if model.belongs_to_relations[ActiveSupport::Inflector.parameterize(model_name).to_sym]
+          relation = model.belongs_to_relations[ActiveSupport::Inflector.parameterize(model_name).to_sym]
+          layout = model.layout_name
+          model.create_translations if model.translations.keys.empty?
+
+          url =
+            URI(
+              "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
+                Trophonius.config.database
+              }/layouts/#{layout}/_find"
+            )
+
+          if model.translations.key?(relation[:foreign_key])
+            foreign_key_field = model.translations[relation[:foreign_key]].to_s
+          else
+            foreign_key_field = relation[:foreign_key].to_s
+          end
+
+          if pk_model.translations.key?(relation[:primary_key])
+            primary_key_field = pk_model.translations[relation[:primary_key]].to_s
+          else
+            primary_key_field = relation[:primary_key].to_s
+          end
+
+          body = { query: [{ foreign_key_field => self[primary_key_field].to_s }], limit: 100_000 }.to_json
+          response = Request.make_request(url, "Bearer #{Request.get_token}", 'post', body)
+
+          if response['messages'][0]['code'] != '0'
+            if response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'
+              resp = RecordSet.new(layout, model.non_modifiable_fields)
+              return resp
+            else
+              if response['messages'][0]['code'] == '102'
+                results = Request.retrieve_first(layout)
+                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 = [foreign_key_field]
+                  Error.throw_error('102', (query_keys - ret_val.keys.map(&:downcase)).flatten.join(', '), layout)
+                end
+              end
+              Error.throw_error(response['messages'][0]['code'])
+            end
+          else
+            r_results = response['response']['data']
+            ret_val = RecordSet.new(layout, model.non_modifiable_fields)
+            r_results.each do |r|
+              hash = model.build_result(r)
+              ret_val << hash
+            end
+            @response = ret_val
+            return @response
+          end
+        end
+      elsif ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(method))).respond_to?('first')
+        fk_model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(model_name)))
+        pk_model = ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.classify(ActiveSupport::Inflector.singularize(method)))
+
+        if pk_model.has_many_relations[ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.pluralize(model_name)).to_sym]
+          relation = pk_model.has_many_relations[ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.pluralize(model_name)).to_sym]
+          layout = pk_model.layout_name
+          pk_model.create_translations if pk_model.translations.keys.empty?
+
+          url =
+            URI(
+              "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
+                Trophonius.config.database
+              }/layouts/#{layout}/_find"
+            )
+
+          if fk_model.translations.key?(relation[:foreign_key])
+            foreign_key_field = fk_model.translations[relation[:foreign_key]].to_s
+          else
+            foreign_key_field = relation[:foreign_key].to_s
+          end
+
+          if pk_model.translations.key?(relation[:primary_key])
+            primary_key_field = pk_model.translations[relation[:primary_key]].to_s
+          else
+            primary_key_field = relation[:primary_key].to_s
+          end
+
+          body = { query: [{ primary_key_field => self[foreign_key_field].to_s }], limit: 1 }.to_json
+
+          response = Request.make_request(url, "Bearer #{Request.get_token}", 'post', body)
+          if response['messages'][0]['code'] != '0'
+            if response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'
+              resp = RecordSet.new(layout, pk_model.non_modifiable_fields)
+              return resp
+            else
+              if response['messages'][0]['code'] == '102'
+                results = Request.retrieve_first(layout)
+                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 = [primary_key_field]
+                  Error.throw_error('102', (query_keys - ret_val.keys.map(&:downcase)).flatten.join(', '), layout)
+                end
+              end
+              Error.throw_error(response['messages'][0]['code'])
+            end
+          else
+            r_results = response['response']['data']
+            ret_val = RecordSet.new(layout, pk_model.non_modifiable_fields)
+            r_results.each do |r|
+              hash = pk_model.build_result(r)
+              ret_val << hash
+            end
+            @response = ret_val
+            return @response.first
+          end
+        end
+      else
+        super
+      end
+    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/#{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}"
+        )
       body = "{\"fieldData\": #{modified_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
-        true
-      end
+      response['messages'][0]['code'] != '0' ? Error.throw_error(response['messages'][0]['code']) : true
     end
 
     ##
@@ -44,13 +171,14 @@ module Trophonius
     #
     # @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/#{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
-        true
-      end
+      response['messages'][0]['code'] != '0' ? Error.throw_error(response['messages'][0]['code']) : true
     end
 
     ##
@@ -61,24 +189,27 @@ module Trophonius
     #
     # @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/#{record_id}")
-      fieldData.keys.each do |field|
-        modifiable_fields[field] = fieldData[field]
-      end
+      url =
+        URI(
+          "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{
+            layout_name
+          }/records/#{record_id}"
+        )
+      fieldData.keys.each { |field| modifiable_fields[field] = fieldData[field] }
       body = "{\"fieldData\": #{fieldData.to_json}}"
       response = Request.make_request(url, "Bearer #{Request.get_token}", 'patch', body)
       if response['messages'][0]['code'] != '0'
-        if response["messages"][0]["code"] == "102"
+        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", (fieldData.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', (fieldData.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
         true
       end
@@ -94,14 +225,15 @@ module Trophonius
     #
     # @return [True] if successful
     def upload(container_name:, container_repetition: 1, file:)
-      url = URI("http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{record_id}/containers/#{container_name}/#{container_repetition}")
+      url =
+        URI(
+          "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{
+            layout_name
+          }/records/#{record_id}/containers/#{container_name}/#{container_repetition}"
+        )
 
       response = Request.upload_file_request(url, "Bearer #{Request.get_token}", file)
-      if response['messages'][0]['code'] != '0'
-        Error.throw_error(response['messages'][0]['code'])
-      else
-        true
-      end
+      response['messages'][0]['code'] != '0' ? Error.throw_error(response['messages'][0]['code']) : true
     end
   end
 end

data/lib/trophonius_time.rb

@@ -0,0 +1,5 @@
+class Time
+  def to_fm
+    self.strftime('%m-%d-%Y %H:%M:%S')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophonius
 version: !ruby/object:Gem::Version
-  version: 1.2.4.8
+  version: 1.2.6.2
 platform: ruby
 authors:
 - Kempen Automatisering
@@ -42,22 +42,22 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
+        version: '6.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.x
+        version: 6.0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
+        version: '6.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.x
+        version: 6.0.3.1
 description: An easy to use link between Ruby (on Rails) and FileMaker using the FileMaker
   Data-API.
 email: 
@@ -68,6 +68,7 @@ files:
 - lib/trophonius.rb
 - lib/trophonius_config.rb
 - lib/trophonius_connection.rb
+- lib/trophonius_date.rb
 - lib/trophonius_error.rb
 - lib/trophonius_model.rb
 - lib/trophonius_query.rb
@@ -75,6 +76,7 @@ files:
 - lib/trophonius_recordset.rb
 - lib/trophonius_redis_manager.rb
 - lib/trophonius_request.rb
+- lib/trophonius_time.rb
 homepage: https://github.com/Willem-Jan/Trophonius
 licenses:
 - MIT