trophonius 1.3.1 → 1.4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 193ec5a1a1a35715519760565271544fe7d14e56670ff533b30449db17a9739f
-  data.tar.gz: 7b241ecfc24897f44d288fbb912c22fb950b1e645eddb1ed4b2cccaeb6022198
+  metadata.gz: bbc6e79b6244e3db4d69057e9502565a77b4aed5c053872332d4015bd6a28d95
+  data.tar.gz: 128ec494f7a33e45dd6300c3b9c5386f297cf0384a16c43c170b59cd9d8b5e10
 SHA512:
-  metadata.gz: 3c4e65f40f0f8e484ebf35418c9ec26b998f0c9cbd4610e449ec5f0c0abf2c49daec033b8c0929b8f15979f785a461218607b4f075a4d877b3dab6637f50c57e
-  data.tar.gz: 7b64990a532ca0944514746d78b56adc39ea5b175c3d683ff284a09a101ad4f15fb94c391e8fee67223baf50bb4d5ad2dc6cb34c593f9cf8abf0a5b0fe3e5395
+  metadata.gz: 17cc7cf2bb12e56a07683b5bd26c4d33f872945b88ef707b5b61621eed79aa5e1b79d2e879b9a86ca564e19f49df7daab9632fc9874b70d307ac11b848092ed4
+  data.tar.gz: 260b16ca4aede6110a88e415ad4b676ea9475bb321c6d68ece2464004595272da4eedafdf41f8e122b9ddaea2369a36abdb598f5166715ff9b420390343cb896

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
 
     ##
@@ -60,6 +67,66 @@ module Trophonius
       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
     #
@@ -125,7 +192,6 @@ 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?
@@ -149,6 +215,21 @@ module Trophonius
           end
       end
 
+      if @post_request_script.present?
+        body.merge!(script: @post_request_script)
+        body.merge!('script.param' => @post_request_scriptparam) if @post_request_scriptparam.present?
+      end
+
+      if @prerequest_script.present?
+        body.merge!(script: @prerequest_script)
+        body.merge!('script.prerequest.param' => @prerequest_scriptparam) if @prerequest_scriptparam.present?
+      end
+
+      if @presort_script.present?
+        body.merge!(script: @presort_script)
+        body.merge!('script.presort.param' => @presort_scriptparam) if @presort_scriptparam.present?
+      end
+
       if @portal_limits
         portal_hash = { portal: @portal_limits.map { |portal_name, limit| "#{portal_name}" } }
         body.merge!(portal_hash)
@@ -157,6 +238,7 @@ module Trophonius
 
       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)
@@ -178,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

@@ -48,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(

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: trophonius
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.2.2
 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: []