trophonius 1.3.0 → 1.4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8cddd8754bce7e159a2e6930652e3ee4579e5c2ec1b10e2dc8559c7d4c07ec9
-  data.tar.gz: 66bbed12eacca09ebea09541ea5698e5910afa6110f4da00f7d588d1a41d2f27
+  metadata.gz: a0949793d21332ffb6c5af748bfa63343381852320139c87d0ac42eebb081e9a
+  data.tar.gz: 9a15a879d7aa1ba1cec4429922336d455cc0b7ceb9976dc0eb5208a4e596ba61
 SHA512:
-  metadata.gz: 9aa8781709105e8485d56cc7c34f0f40558f34a664eb2707eb7047518896e2676624fda3e34af4153b43bbcf15fce48ea8c4e355144e52e4bff9a59cc9a7e22e
-  data.tar.gz: cef048e4cd82415827901a735c256f55cd0b3c5741b34b19c4922bb3178985e9c3dc4de3b88ca6a0bcd8c18682af2f03fcd7059a24649d7320f21133c01135e8
+  metadata.gz: fbc67931cd98a46274da0d322d8d3e7e5a5a45e65cce58f38e24eb151d9ff27967272f64000b66b33afdf3ad56266db63a3965b32ffaa1568204f373639f9928
+  data.tar.gz: c4311588cec27ccaa4af3f5112cc90a65d266395e54d27d0e105a25ee17aeff07ec260cb788fa430343338308f9526b743c0830fa8aa213da26ee98d424d97b2

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_query.rb

@@ -7,6 +7,7 @@ require 'trophonius_error'
 module Trophonius
   class Trophonius::Query
     attr_reader :response
+    attr_accessor :presort_script, :presort_scriptparam, :prerequest_script, :prerequest_scriptparam, :post_request_script, :post_request_scriptparam
 
     ##
     # Creates a new instance of the Trophonius::Query class
@@ -20,6 +21,12 @@ module Trophonius
       @trophonius_model = trophonius_model
       @limit = limit
       @offset = offset
+      @presort_script = ''
+      @presort_scriptparam = ''
+      @prerequest_script = ''
+      @prerequest_scriptparam = ''
+      @post_request_script = ''
+      @post_request_scriptparam = ''
     end
 
     ##
@@ -42,6 +49,84 @@ 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 post-request script to the request
+    #
+    # @param [args] arguments containing a String with the name of the script
+    # @return [Trophonius::Model] updated base model
+    def set_post_request_script(args)
+      args[1].current_query.post_request_script = args[0]
+      args[1]
+    end
+
+    ##
+    # Adds a post-request scriptparameter to the request
+    #
+    # @param [args] arguments containing a String with the name of the scriptparameter
+    # @return [Trophonius::Model] updated base model
+    def set_post_request_script_param(args)
+      args[1].current_query.post_request_scriptparam = args[0]
+      args[1]
+    end
+
+    ##
+    # Adds a pre-request script to the request
+    #
+    # @param [args] arguments containing a String with the name of the script
+    # @return [Trophonius::Model] updated base model
+    def set_prerequest_script(args)
+      args[1].current_query.prerequest_script = args[0]
+      args[1]
+    end
+
+    ##
+    # Adds a pre-request scriptparameter to the request
+    #
+    # @param [args] arguments containing a String with the name of the scriptparameter
+    # @return [Trophonius::Model] updated base model
+    def set_prerequest_script_param(args)
+      args[1].current_query.prerequest_scriptparam = args[0]
+      args[1]
+    end
+
+    ##
+    # Adds a pre-sort script to the request
+    #
+    # @param [args] arguments containing a String with the name of the script
+    # @return [Trophonius::Model] updated base model
+    def set_presort_script(args)
+      args[1].current_query.presort_script = args[0]
+      args[1]
+    end
+
+    ##
+    # Adds a pre-request scriptparameter to the request
+    #
+    # @param [args] arguments containing a String with the name of the scriptparameter
+    # @return [Trophonius::Model] updated base model
+    def set_presort_script_param(args)
+      args[1].current_query.presort_scriptparam = args[0]
+      args[1]
+    end
+
     ##
     # Adds a find request to the original query, resulting in an "Or" find-request for FileMaker
     #
@@ -120,22 +205,40 @@ 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 @post_request_script.present?
+        body.merge!(script: @post_request_script)
+        body.merge!('script.param' => @post_request_script_param) if @post_request_scriptparam.present?
+      end
+
+      if @prerequest_script.present?
+        body.merge!(script: @prerequest_script)
+        body.merge!('script.param' => @prerequest_script_param) if @prerequest_scriptparam.present?
+      end
+
+      if @presort_script.present?
+        body.merge!(script: @presort_script)
+        body.merge!('script.param' => @presort_script_param) if @presort_scriptparam.present?
+      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'
           resp = RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields).send(method, *args, &block)
@@ -157,7 +260,26 @@ module Trophonius
       else
         r_results = response['response']['data']
         ret_val = RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields)
+
         r_results.each do |r|
+          r['fieldData'].merge!('post_request_script_result' => response['response']['scriptResult']) if response['response']['scriptResult']
+
+          if response['response']['scriptResult.presort']
+            r['fieldData'].merge!('presort_script_result' => response['response']['scriptResult.presort'])
+          end
+
+          if response['response']['scriptResult.prerequest']
+            r['fieldData'].merge!('prerequest_script_result' => response['response']['scriptResult.prerequest'])
+          end
+
+          r['fieldData'].merge!('post_request_script_error' => response['response']['scriptError']) if response['response']['scriptError']
+
+          r['fieldData'].merge!('presort_script_error' => response['response']['scriptError.presort']) if response['response']['scriptError.presort']
+
+          if response['response']['scriptError.prerequest']
+            r['fieldData'].merge!('prerequest_script_error' => response['response']['scriptError.prerequest'])
+          end
+
           hash = @trophonius_model.build_result(r)
           ret_val << hash
         end

data/lib/trophonius_single.rb

@@ -30,6 +30,7 @@ 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)
@@ -47,6 +48,38 @@ 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(
@@ -62,8 +95,10 @@ module Trophonius
       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']
@@ -146,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.3.0
+  version: 1.4.2.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: []