trophonius 1.2.4.7 → 1.2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87b5962e8bf79819ab3df5175b31f73bf9a83d53bf6b311c717d369f674e960
-  data.tar.gz: d94a6ab5b1ad8a7c6eb661a067b7dddbc7ec68060abfe28225592c7e72efcf07
+  metadata.gz: 41574e377e8690e833092a9dedd6e7929ae57bdc10d34aa61b76ff89369f8051
+  data.tar.gz: '0096a1ae118fc10514f68005ad6408710ebc37269e7f2a1ba6fab7395e0f48da'
 SHA512:
-  metadata.gz: 119b0873da297f849a3bfaf99c58b2dfed33bca974073ce585807c1aded77b7398e4fb1f4de6673f977db0d2a36bea40486759d428d5200e7b4172a32cf65f65
-  data.tar.gz: 853a79cb6ffc76bcf07c69243aa26e03ec604de9153707bbe2ae375715f84ae183be79b11684dfba085dddc819a2f9f5b167d085b4f2d86cbbbfdc008aef6cca
+  metadata.gz: 2ef4fb3e20cb91540f88e391ffd83acc7f54165b2974d7a9ad62a18ebf35ca867829f9d6d09e7e1bcccbabdf1690f6bb0bfb8e083b4c387f598b6e4b31865a38
+  data.tar.gz: e3f3eab5629b894e7e7a7aebc6dbe1252ed56d2c9a902d0a929f9a513bdc9edad66def8a20dcca697002f107f3016fa6c5151f0d48b838e74e836d2647e2d4f2

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_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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophonius
 version: !ruby/object:Gem::Version
-  version: 1.2.4.7
+  version: 1.2.6.1
 platform: ruby
 authors:
 - Kempen Automatisering
@@ -43,9 +43,6 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
       - !ruby/object:Gem::Version
         version: 6.0.3.1
   type: :runtime
@@ -53,9 +50,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
       - !ruby/object:Gem::Version
         version: 6.0.3.1
 description: An easy to use link between Ruby (on Rails) and FileMaker using the FileMaker