trophonius 1.2.7 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a94743894d1780d9502732ea12d63065c0d45df4553d84dc37a766600a7dc4
-  data.tar.gz: d3aa3192857584c40fefe7596998039cf3c9497f88532985ee7d0b36cf4dc1db
+  metadata.gz: 5cd1b995810aa5284fcf855c4e4398d232c8c89ddccc7198ae52b96141dd7d5f
+  data.tar.gz: d63843e3b6c432e52ae9b94b49a0e75307a8680be92f997b4a34b045728334f1
 SHA512:
-  metadata.gz: c7fefc47d7faaadc70d2dbe0ff406164eee1e8994dfaf8dd32991c35223ffe545d815585b42aeb6a121046dbc0ba472e4600ab84f62fa114ffd953f9c91d1598
-  data.tar.gz: 7623409b3827a3e5fee64302a593d232761ef3a84f6212371121e7100b8d3fa70bcacf12eaca95d4f85fd542da255a547c256b8fece821471061f9eba323a4d3
+  metadata.gz: 75eafee6437ab8b647abf164f80cdf144a0a21dca37963e94b3cdea1ed6ebb48c470b332544a96dc0c085b16a737e3a0e15a178ca6d3ac5e15bfef1f0bd51c7b
+  data.tar.gz: 4a6b0d5eb0d552855e087b5d2388fe1b58da5f425cd251805c95adc7863e5c53c52fbf1a2796877a0c1814e9bd9df10c4fd2f7450692941d3c22e2439cbaef3a

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

@@ -0,0 +1,216 @@
+require 'trophonius_date'
+require 'trophonius_time'
+require 'trophonius_error'
+require 'trophonius_record'
+require 'trophonius_recordset'
+
+module Trophonius
+  class Trophonius::Single
+    attr_reader :query
+    def initialize(config:)
+      @config = config
+      @query = {}
+      @translations = {}
+      @all_fields = {}
+    end
+
+    def where(fieldData)
+      url =
+        URI(
+          URI.escape(
+            "http#{@config[:ssl] == true ? 's' : ''}://#{@config[:host]}/fmi/data/v1/databases/#{@config[:database]}/layouts/#{
+              @config[:layout_name]
+            }/_find"
+          )
+        )
+      @query.merge!(query: [fieldData])
+      @query.merge!(limit: '10000000')
+      token = setup_connection
+      response = make_request(url, token, 'post', @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
+      @query = {}
+      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)
+      hash = Trophonius::Record.new
+      hash.record_id = result['recordId']
+      hash.layout_name = @config[:layout_name]
+      hash.model_name = 'Single'
+
+      result['fieldData'].keys.each do |key|
+        # unless key[/\s/] || key[/\W/]
+        @translations.merge!(
+          { "#{ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_').downcase}" => "#{key}" }
+        )
+        hash.send(:define_singleton_method, ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_')) do
+          hash[key]
+        end
+        unless @config[:non_modifiable_fields]&.include?(key)
+          @all_fields.merge!(
+            ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_').downcase =>
+              ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_')
+          )
+          hash.send(
+            :define_singleton_method,
+            "#{ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_')}="
+          ) do |new_val|
+            hash[key] = new_val
+            hash.modifiable_fields[key] = new_val
+            hash.modified_fields[key] = new_val
+          end
+        end
+        # end
+        hash.merge!({ key => result['fieldData'][key] })
+        hash.modifiable_fields.merge!({ key => result['fieldData'][key] }) unless @config[:non_modifiable_fields]&.include?(key)
+      end
+      result['portalData'].keys.each do |key|
+        unless key[/\s/] || key[/\W/]
+          hash.send(:define_singleton_method, ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(key.to_s), separator: '_')) do
+            hash[key]
+          end
+        end
+        result['portalData'][key].each_with_index do |inner_hash|
+          inner_hash.keys.each do |inner_key|
+            inner_method =
+              ActiveSupport::Inflector.parameterize(ActiveSupport::Inflector.underscore(inner_key.gsub(/\w+::/, '').to_s), separator: '_')
+            unless inner_method[/\s/] || inner_method[/\W/]
+              inner_hash.send(:define_singleton_method, inner_method.to_s) { inner_hash[inner_key] }
+              inner_hash.send(:define_singleton_method, 'record_id') { inner_hash['recordId'] }
+            end
+          end
+        end
+        hash.merge!({ key => result['portalData'][key] })
+      end
+      return hash
+    end
+
+    def make_request(url_param, token, method, body, params = '')
+      ssl_verifyhost = @config[:local_network] ? 0 : 2
+      ssl_verifypeer = !@config[:local_network]
+      request =
+        Typhoeus::Request.new(
+          url_param,
+          method: method.to_sym,
+          body: body,
+          params: params,
+          ssl_verifyhost: ssl_verifyhost,
+          ssl_verifypeer: ssl_verifypeer,
+          headers: { 'Content-Type' => 'application/json', Authorization: "Bearer #{token}" }
+        )
+      temp = request.run
+      begin
+        JSON.parse(temp.response_body)
+      rescue Exception => e
+        close_connection(token)
+        Error.throw_error('1631')
+      end
+    end
+
+    def setup_connection
+      ssl_verifyhost = @config[:local_network] ? 0 : 2
+      ssl_verifypeer = !@config[:local_network]
+      url = URI(URI.escape("http#{@config[:ssl] == true ? 's' : ''}://#{@config[:host]}/fmi/data/v1/databases/#{@config[:database]}/sessions"))
+      request =
+        Typhoeus::Request.new(
+          url,
+          method: :post,
+          body:
+            if @config[:external_name].nil? || @config[:external_name].empty?
+              {}
+            else
+              {
+                fmDataSource: [{ database: @config[:external_name], username: @config[:external_username], password: @config[:external_password] }]
+              }.to_json
+            end,
+          params: {},
+          ssl_verifyhost: ssl_verifyhost,
+          ssl_verifypeer: ssl_verifypeer,
+          headers: {
+            'Content-Type' => 'application/json', Authorization: "Basic #{Base64.strict_encode64("#{@config[:username]}:#{@config[:password]}")}"
+          }
+        )
+      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'
+      return parsed['response']['token']
+    end
+
+    def close_connection(token)
+      url =
+        URI(URI.escape("http#{@config[:ssl] == true ? 's' : ''}://#{@config[:host]}/fmi/data/v1/databases/#{@config[:database]}/sessions/#{token}"))
+      ssl_verifyhost = @config[:local_network] ? 0 : 2
+      ssl_verifypeer = !@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'
+      return true
+    end
+  end
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: trophonius
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.4.0
 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
@@ -71,12 +73,13 @@ files:
 - lib/trophonius_recordset.rb
 - lib/trophonius_redis_manager.rb
 - lib/trophonius_request.rb
+- lib/trophonius_single.rb
 - lib/trophonius_time.rb
 homepage: https://github.com/Willem-Jan/Trophonius
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,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: []