trophonius 1.2.7.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b4fa3606dce996196ab6530704a27b93fbbf3e2134add785319b7b7921696cb
-  data.tar.gz: 16042983fe5510c9a29986aab3b77018033063980f1191d5fbf4234aa6bd229c
+  metadata.gz: 4cf39904e7500cbacbd16e8f3a78a1df4efa2ded1d64b4c6703c2a1a28c62c9c
+  data.tar.gz: d14b38291d4f6a49b3cd825fabdc82ce676c14d27afc738c80c42c6f61ee7144
 SHA512:
-  metadata.gz: 36fa65b8130dfe29303627c0727fb8504e832ac50e7b5d74f574f810efeaf9842a55898f68595ba7e2931afefabc4db0f98ec12e0d7aa8d790cde86672b1a614
-  data.tar.gz: ebdd54e6f7486fedb7cb03cdf87cf6d1df28ce7c06ab6bc3afaa8320bb9a6f94244cb68a59a158bf4059a578795c1cc932092b7e6c40f5dabc1ca7d71bbffbea
+  metadata.gz: 9508bca471f2602c71c1d8be927ed848e19d5d937f66a90bb2b71eb8d34bb59f904d3dbc1ffabaa1053c244e29d89ec25e333d83a01c9b6716f91871fee86732
+  data.tar.gz: 2a98ea6373a6c7ac63ba72b0f13a3852ebbaffbbfca9bab5f8e6c4aabd40e534bbc4ac05249bdd5f0c183674444977c5a2e8853e4d8bfd2ec6dd8bcb5d27afac

data/lib/generators/trophonius_generator.rb

@@ -0,0 +1,30 @@
+require 'rails'
+
+module Trophonius
+  class InstallGenerator < ::Rails::Generators::Base
+    namespace 'trophonius'
+
+    class_option :host, type: :string, default: 'location_to.your_filemakerserver.com'
+    class_option :database, type: :string, default: 'Name_of_your_database'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'add the config file'
+
+    def copy_initializer_file
+      @host = options['host']
+      @database = options['database']
+      create_file 'config/initializers/trophonius.rb',
+                  "Trophonius.configure do |config|
+  config.host = '#{@host}'
+  config.database = '#{@database}'
+  config.username = Rails.application.credentials.dig(:username) # (requires >= Rails 5.2) otherwise use old secrets
+  config.password = Rails.application.credentials.dig(:password) # (requires >= Rails 5.2) otherwise use old secrets
+  config.redis_connection = false # default false, true if you want to store the token in redis
+  config.ssl = true # or false depending on whether https or http should be used
+  # USE THE NEXT OPTION WITH CAUTION
+  config.local_network = false # if true the ssl certificate will not be verified to allow for self-signed certificates
+end"
+    end
+  end
+end

data/lib/generators/trophonius_model_generator.rb

@@ -0,0 +1,23 @@
+require 'rails'
+
+module Trophonius
+  class ModelGenerator < ::Rails::Generators::Base
+    namespace 'trophonius_model'
+
+    class_option :model, type: :string, default: 'MyModel'
+    class_option :layout, type: :string, default: 'MyModelsLayout'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'add the config file'
+
+    def copy_model_file
+      @model = options['model']
+      @layout = options['layout']
+      create_file "app/models/#{@model.downcase}.rb",
+                  "class #{@model.humanize} < Trophonius::Model
+  config layout_name: '#{@layout}'
+end"
+    end
+  end
+end

data/lib/trophonius_model.rb

@@ -175,7 +175,7 @@ module Trophonius
     #
     # @return [Record] the created record
     #   Model.create(fieldOne: "Data")
-    def self.create(fieldData)
+    def self.create(fieldData, portalData: {})
       url =
         URI(
           URI.escape(
@@ -193,7 +193,26 @@ module Trophonius
           new_field_data.merge!({ "#{k}" => fieldData[k] })
         end
       end
-      body = "{\"fieldData\": #{new_field_data.to_json}}"
+
+      new_portal_data = {}
+      portalData.each do |portal_name, portal_values|
+        new_portal_data.merge!(
+          portal_name =>
+            portal_values.map do |record|
+              record.inject({}) do |new_hash, (key, value)|
+                new_hash["#{portal_name}::#{key}"] = value
+                new_hash
+              end
+            end
+        )
+      end
+
+      body =
+        if new_portal_data != {}
+          "{\"fieldData\": #{new_field_data.to_json}, \"portalData\": #{new_portal_data.to_json}}"
+        else
+          "{\"fieldData\": #{new_field_data.to_json} }"
+        end
       response = Request.make_request(url, "Bearer #{Request.get_token}", 'post', body)
       if response['messages'][0]['code'] != '0'
         if response['messages'][0]['code'] == '102'

data/lib/trophonius_query.rb

@@ -42,6 +42,24 @@ module Trophonius
       @current_query
     end
 
+    ##
+    # Returns the current portal limits
+    #
+    # @return [Hash] Hash representing the portal limits
+    def build_portal_limits()
+      @portal_limits ||= {}
+    end
+
+    ##
+    # Adds a portal limit to the request
+    #
+    # @param [args] arguments containing a Hash with the format {portalName: requiredLimit}
+    # @return [Trophonius::Model] updated base model
+    def set_portal_limits(args)
+      args[1].current_query.build_portal_limits.merge!(args[0])
+      args[1]
+    end
+
     ##
     # Adds a find request to the original query, resulting in an "Or" find-request for FileMaker
     #
@@ -107,6 +125,7 @@ module Trophonius
             }/layouts/#{@trophonius_model.layout_name}/_find"
           )
         )
+
       new_field_data = @current_query.map { |_q| {} }
 
       @trophonius_model.create_translations if @trophonius_model.translations.keys.empty?
@@ -120,21 +139,23 @@ module Trophonius
         end
       end
       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
+        body = @current_sort.nil? ? { query: new_field_data, limit: '100000' } : { query: new_field_data, sort: @current_sort, limit: '100000' }
       else
         body =
           if @current_sort.nil?
-            { query: new_field_data, limit: @limit.to_s, offset: @offset.to_s }.to_json
+            { query: new_field_data, limit: @limit.to_s, offset: @offset.to_s }
           else
-            { query: new_field_data, sort: @current_sort, limit: @limit.to_s, offset: @offset.to_s }.to_json
+            { query: new_field_data, sort: @current_sort, limit: @limit.to_s, offset: @offset.to_s }
           end
       end
 
+      if @portal_limits
+        portal_hash = { portal: @portal_limits.map { |portal_name, limit| "#{portal_name}" } }
+        body.merge!(portal_hash)
+        @portal_limits.each { |portal_name, limit| body.merge!({ "limit.#{portal_name}" => limit.to_s }) }
+      end
+
+      body = body.to_json
       response = Request.make_request(url, "Bearer #{Request.get_token}", 'post', body)
       if response['messages'][0]['code'] != '0'
         if response['messages'][0]['code'] == '101' || response['messages'][0]['code'] == '401'

data/lib/trophonius_record.rb

@@ -152,6 +152,36 @@ module Trophonius
       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 run_script(script: '', scriptparameter: '')
+      url =
+        URI(
+          URI.escape(
+            "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
+              Trophonius.config.database
+            }/layouts/#{layout_name}/records/#{record_id}?script=#{script}&script.param=#{scriptparameter}"
+          )
+        )
+
+      result = Request.make_request(url, "Bearer #{Request.get_token}", 'get', '{}')
+
+      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 || true
+      end
+    end
+
     ##
     # Saves the last changes made to the Record to FileMaker.
     # Throws a FileMaker error if save failed

data/lib/trophonius_single.rb

@@ -30,8 +30,10 @@ module Trophonius
 
       r_results = response['response']['data']
       if response['messages'][0]['code'] != '0' && response['messages'][0]['code'] != '401'
+        close_connection(token)
         Error.throw_error(response['messages'][0]['code'])
       elsif response['messages'][0]['code'] == '401'
+        close_connection(token)
         return RecordSet.new(@config[:layout_name], @config[:non_modifiable_fields])
       else
         ret_val = RecordSet.new(@config[:layout_name], @config[:non_modifiable_fields])
@@ -46,6 +48,67 @@ module Trophonius
       return ret_val
     end
 
+    def first
+      url =
+        URI(
+          URI.escape(
+            "http#{@config[:ssl] == true ? 's' : ''}://#{@config[:host]}/fmi/data/v1/databases/#{@config[:database]}/layouts/#{
+              @config[:layout_name]
+            }/records?_limit=1"
+          )
+        )
+
+      token = setup_connection
+      response = make_request(url, token, 'get', @query.to_json)
+
+      r_results = response['response']['data']
+      if response['messages'][0]['code'] != '0' && response['messages'][0]['code'] != '401'
+        close_connection(token)
+        Error.throw_error(response['messages'][0]['code'])
+      elsif response['messages'][0]['code'] == '401'
+        close_connection(token)
+        return RecordSet.new(@config[:layout_name], @config[:non_modifiable_fields])
+      else
+        ret_val = RecordSet.new(@config[:layout_name], @config[:non_modifiable_fields])
+        r_results.each do |r|
+          hash = build_result(r)
+          ret_val << hash
+        end
+      end
+      close_connection(token)
+
+      return ret_val
+    end
+
+    def run_script(script:, scriptparameter:)
+      url =
+        URI(
+          URI.escape(
+            "http#{@config[:ssl] == true ? 's' : ''}://#{@config[:host]}/fmi/data/v1/databases/#{@config[:database]}/layouts/#{
+              @config[:layout_name]
+            }/records?_limit=1&script=#{script}&script.param=#{scriptparameter}"
+          )
+        )
+
+      token = setup_connection
+      result = make_request(url, "Bearer #{token}", 'get', '{}')
+      ret_val = ''
+
+      if result['messages'][0]['code'] != '0'
+        close_connection(token)
+        Error.throw_error(result['messages'][0]['code'])
+      elsif result['response']['scriptResult'] == '403'
+        close_connection(token)
+        Error.throw_error(403)
+      else
+        ret_val = result['response']['scriptResult']
+      end
+
+      close_connection(token)
+
+      return ret_val
+    end
+
     private
 
     def build_result(result)
@@ -118,6 +181,7 @@ module Trophonius
       begin
         JSON.parse(temp.response_body)
       rescue Exception => e
+        close_connection(token)
         Error.throw_error('1631')
       end
     end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: trophonius
 version: !ruby/object:Gem::Version
-  version: 1.2.7.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Kempen Automatisering
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-12-16 00:00:00.000000000 Z
@@ -54,11 +54,13 @@ dependencies:
         version: '5.0'
 description: A lightweight, easy to use link between Ruby (on Rails) and FileMaker
   using the FileMaker Data-API.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/trophonius_generator.rb
+- lib/generators/trophonius_model_generator.rb
 - lib/trophonius.rb
 - lib/trophonius_config.rb
 - lib/trophonius_connection.rb
@@ -77,7 +79,7 @@ homepage: https://github.com/Willem-Jan/Trophonius
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Link between Ruby (on Rails) and FileMaker.
 test_files: []