trophonius 1.4.5.5 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eecfcdce6515f91456cd8e482da0eec5104f2e8fde6b3625baf0db732bc12969
-  data.tar.gz: 6b79cbc8b44fe728171a3123d12def4f4df2eaf8f43c66b8201564ed14e12cae
+  metadata.gz: 6ecc1055be56103548bd16bca808ff5a939e0ee7bbb2650d92f14cfb8e4d18da
+  data.tar.gz: 5b7319bc6b276601a9208db83771f7e2b94c1a981d43f752f5af74370ddad44d
 SHA512:
-  metadata.gz: a048ab92bfc7971e9d0f80a33e45ba7dc689cbff9d711863cdc5aa0308b29bec48412d9bda6adacb38e267b552a0345a6eb3f8214fa383ecacaaabcf8410db20
-  data.tar.gz: 885bee6b19febf90d566c64b7e2fc714d9323efabe10bc0a47fab0a10ae823aec84b5935a3555834e83363e9378322314f2623c727bba1dde2c48d302971c8ad
+  metadata.gz: 2922556fcf044ffd33a83f7b2645d866e22f4be011813c833eecbb087e9563e9c9f15c72954645544ffc6bad2982b1f66057de0696f35febd3be9878f6bdf006
+  data.tar.gz: bf26bdb6b2ce439f4d302fdd3075c9fc07d73acbdfe0dd0ec5981e2ebad5c2ef89735a69d419e812b77bc965f72f730c8fef1335fae0f04d8355d95597ef93d8

data/lib/{trophonius_config.rb → config.rb}

@@ -1,7 +1,12 @@
+# require 'time'
+# require 'date_time'
+# require 'date'
+
 require 'active_support/configurable'
+require 'ethon'
 
 module Trophonius
-  class Trophonius::Configuration # :nodoc:
+  class Configuration # :nodoc:
     include ActiveSupport::Configurable
 
     config_accessor(:host) { '127.0.0.1' }
@@ -13,15 +18,17 @@ module Trophonius
     config_accessor(:username) { 'Admin' }
     config_accessor(:password) { '' }
     config_accessor(:ssl) { true }
-    config_accessor(:fm_18) { false }
+    config_accessor(:fm_18) { true }
     config_accessor(:count_result_script) { '' }
     config_accessor(:layout_name) { '' }
     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 }
+    config_accessor(:redis_no_verify) { false }
+    config_accessor(:pool_size) { 5 }
+    config_accessor(:debug) { false }
   end
 end

data/lib/{trophonius_connection.rb → connectors/connection.rb}

@@ -1,139 +1,167 @@
 require 'time'
 require 'base64'
-require 'typhoeus'
-require 'trophonius_redis_manager'
+require 'securerandom'
+require 'connectors/redis_manager'
+require 'debug_printer'
+
 module Trophonius
-  module Trophonius::Connection
-    ##
-    # Creates a new connection to FileMaker
-    #
-    # @return [String] the *token* used to connect with the FileMaker data api
+  class Connection
+    include DebugPrinter
+    attr_reader :id
 
-    def self.connect
-      if Trophonius.config.redis_connection
-        Trophonius::RedisManager.set_key(key: 'token', value: setup_connection)
-        Trophonius::RedisManager.set_key(key: 'last_connection', value: Time.now)
-        Trophonius::RedisManager.get_key(key: 'token')
-      else
-        @token = setup_connection
-        @last_connection = Time.now
-        @token
-      end
+    def initialize
+      @id = SecureRandom.uuid
+      @token = ''
+      connect
     end
 
     ##
-    # Creates and runs a HTTP request to create a new data api connection
-    # This method throws an error when the request returns with a HTTP error or a FileMaker error
-    # @return [String] the *token* used to connect with the FileMaker data api if successful
-
-    def self.setup_connection
-      if Trophonius.config.redis_connection
-        Trophonius::RedisManager.set_key(key: 'token', value: '')
-        Trophonius::RedisManager.set_key(key: 'last_connection', value: nil)
+    # Returns the last received token
+    # @return [String] the last valid *token* used to connect with the FileMaker data api
+    def token
+      if valid_connection?
+        Trophonius.config.redis_connection ? Trophonius::RedisManager.get_key(key: 'token') : @token
       else
-        @token = ''
+        connect
       end
-      ssl_verifyhost = Trophonius.config.local_network ? 0 : 2
-      ssl_verifypeer = !Trophonius.config.local_network
+    end
+
+    ##
+    # Disconnects from the FileMaker server
+    #
+    def disconnect
       uri = URI::RFC2396_Parser.new
       url =
         URI(
           uri.escape(
-            "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/sessions"
+            "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}"
           )
         )
+      ssl_verifyhost = Trophonius.config.local_network ? 0 : 2
+      ssl_verifypeer = !Trophonius.config.local_network
+
       request =
         Typhoeus::Request.new(
           url,
-          method: :post,
-          body:
-            if Trophonius.config.external_name.empty?
-              {}
-            else
-              {
-                fmDataSource: [
-                  {
-                    database: Trophonius.config.external_name,
-                    username: Trophonius.config.external_username,
-                    password: Trophonius.config.external_password
-                  }
-                ]
-              }.to_json
-            end,
+          method: :delete,
           params: {},
           ssl_verifyhost: ssl_verifyhost,
           ssl_verifypeer: ssl_verifypeer,
-          headers: {
-            'Content-Type' => 'application/json',
-            Authorization: "Basic #{Base64.strict_encode64("#{Trophonius.config.username}:#{Trophonius.config.password}")}"
-          }
+          headers: { 'Content-Type' => 'application/json' }
         )
       temp = request.run
-      body = temp.response_body
-      headers = temp.headers
-      code = temp.code
 
       begin
-        parsed = JSON.parse(body)
-      rescue Exception => e
+        parsed = JSON.parse(temp.response_body)
+
+        DebugPrinter.print_debug('RECEIVED DISCONNECT', parsed)
+      rescue StandardError => e
         puts e
         puts e.backtrace
         Error.throw_error('1631')
       end
       Error.throw_error(parsed['messages'][0]['code']) if parsed['messages'][0]['code'] != '0'
-      parsed['response']['token']
+      Trophonius::RedisManager.disconnect! if Trophonius.config.redis_connection
+      @token = nil
+      @last_connection = nil
+      true
     end
 
+    private
+
     ##
-    # Disconnects from the FileMaker server
+    # Creates a new connection to FileMaker
     #
-    def self.disconnect
+    # @return [String] the *token* used to connect with the FileMaker data api
+
+    def connect
+      if Trophonius.config.redis_connection
+        Trophonius::RedisManager.set_key(key: 'token', value: setup_connection)
+        Trophonius::RedisManager.set_key(key: 'last_connection', value: Time.now)
+        Trophonius::RedisManager.get_key(key: 'token')
+      else
+        @token = setup_connection
+        @last_connection = Time.now
+        @token
+      end
+    end
+
+    def reset_token
+      if Trophonius.config.redis_connection
+        Trophonius::RedisManager.set_key(key: 'token', value: '')
+        Trophonius::RedisManager.set_key(key: 'last_connection', value: nil)
+      else
+        @token = ''
+        @last_connection = nil
+      end
+    end
+
+    def fm_external_data_source
+      if Trophonius.config.external_name.empty?
+        {}
+      else
+        {
+          fmDataSource: [
+            {
+              database: Trophonius.config.external_name,
+              username: Trophonius.config.external_username,
+              password: Trophonius.config.external_password
+            }
+          ]
+        }.to_json
+      end
+    end
+
+    ##
+    # Creates and runs a HTTP request to create a new data api connection
+    # This method throws an error when the request returns with a HTTP error or a FileMaker error
+    # @return [String] the *token* used to connect with the FileMaker data api if successful
+
+    def setup_connection
+      reset_token
+
       uri = URI::RFC2396_Parser.new
       url =
         URI(
           uri.escape(
-            "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}"
+            "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/sessions"
           )
         )
       ssl_verifyhost = Trophonius.config.local_network ? 0 : 2
       ssl_verifypeer = !Trophonius.config.local_network
-
       request =
         Typhoeus::Request.new(
           url,
-          method: :delete,
+          method: :post,
+          body: fm_external_data_source,
           params: {},
           ssl_verifyhost: ssl_verifyhost,
           ssl_verifypeer: ssl_verifypeer,
-          headers: { 'Content-Type' => 'application/json' }
+          headers: {
+            'Content-Type' => 'application/json',
+            Authorization: "Basic #{Base64.strict_encode64("#{Trophonius.config.username}:#{Trophonius.config.password}")}"
+          }
         )
       temp = request.run
+      body = temp.response_body
 
       begin
-        parsed = JSON.parse(temp.response_body)
-      rescue Exception => e
+        parsed = JSON.parse(body)
+      rescue StandardError => e
+        puts e
+        puts e.backtrace
         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
-      true
-    end
-
-    ##
-    # Returns the last received token
-    # @return [String] the last valid *token* used to connect with the FileMaker data api
-    def self.token
-      Trophonius.config.redis_connection ? Trophonius::RedisManager.get_key(key: 'token') : @token
+      parsed['response']['token']
     end
 
     ##
     # Returns the receive time of the last received token
     # @return [Time] Returns the receive time of the last received token
-    def self.last_connection
+    def last_connection
       last = Trophonius.config.redis_connection ? Trophonius::RedisManager.get_key(key: 'last_connection') : nil
       last = last.nil? ? nil : Time.parse(last)
       Trophonius.config.redis_connection ? last : @last_connection
@@ -142,37 +170,23 @@ module Trophonius
     ##
     # Tests whether the FileMaker token is still valid
     # @return [Boolean] True if the token is valid False if invalid
-    def self.test_connection
-      uri = URI::RFC2396_Parser.new
-      url =
-        URI(
-          uri.escape(
-            "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{
-              Trophonius.config.database
-            }/layouts/#{Trophonius.config.layout_name}/records?_limit=1"
-          )
-        )
-      begin
-        request =
-          Typhoeus::Request.new(
-            url,
-            method: :get, body: {}, params: {}, headers: { 'Content-Type' => 'application/json', Authorization: "Bearer #{token}" }
-          )
-        temp = request.run
-        json_parsed = JSON.parse(temp.response_body)
+    def test_connection
+      return last_connection.nil? || last_connection < Time.now - (15 * 60) if Trophonius.config.layout_name == ''
 
-        json_parsed['messages'][0]['code'] == '0'
-      rescue StandardError => e
-        puts e
-        puts e.backtrace
-        false
-      end
+      path = "/layouts/#{Trophonius.config.layout_name}/records?_limit=1"
+      response =
+        Trophonius::DatabaseRequest.make_request(path, :get, {}, bypass_queue_with: "Bearer #{@token}")
+      response['messages'][0]['code'] == '0'
+    rescue StandardError => e
+      puts e
+      puts e.backtrace
+      false
     end
 
     ##
     # Returns whether the current connection is still valid
     # @return [Boolean] True if the connection is valid False if invalid
-    def self.valid_connection?
+    def valid_connection?
       if Trophonius.config.layout_name != '' && test_connection == false
         false
       else

data/lib/connectors/connection_manager.rb

@@ -0,0 +1,39 @@
+require 'debug_printer'
+module Trophonius
+  class ConnectionManager
+    include DebugPrinter
+    def initialize
+      @connections = {}
+      Trophonius.config.pool_size.times do
+        connection = Connection.new
+        @connections[connection.id] = { connection: connection, queue: [] }
+
+        DebugPrinter.print_debug('CONNECTION CREATED', @connections[connection.id].inspect)
+      end
+    end
+
+    def enqueue(id)
+      connection = @connections.values.min_by { |c| c[:queue].length }
+      connection[:queue].push(id)
+      puts "in,#{connection[:connection].id},#{connection[:connection].token},#{connection[:queue].length}" if Trophonius.config.debug == true
+      auth_header_bearer(connection[:connection].id)
+    end
+
+    def dequeue(id)
+      connection = @connections.values.find { |c| c[:queue].include?(id) }
+      connection[:queue].delete_if { |q_id| q_id == id }
+      puts "out,#{connection[:connection].id},#{connection[:connection].token},#{connection[:queue].length}" if Trophonius.config.debug == true
+      nil
+    end
+
+    def disconnect_all
+      @connections.each { |_connection_id, connection| connection[:connection].disconnect }
+    end
+
+    private
+
+    def auth_header_bearer(id)
+      "Bearer #{@connections.dig(id, :connection).token}"
+    end
+  end
+end

data/lib/connectors/database_request.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'connectors/connection_manager'
+require 'debug_printer'
+require 'typhoeus'
+require 'uri'
+require 'securerandom'
+require 'net/http'
+
+module Trophonius
+  module DatabaseRequest
+    include DebugPrinter
+    ##
+    # Crafts and runs a HTTP request of any type
+    #
+    # @param [URI] url_path: the url to make the request to
+    #
+    # @param [String] method: the type of HTTP request to make (i.e. get)
+    #
+    # @param [JSONString] body: the body of the HTTP request
+    #
+    # @param [String] params: optional parameters added to the request
+    #
+    # @param [String] bypass_queue_with: optional way to bypass the ConnectionManager
+    #
+    # @return [JSON] parsed json of the response
+    def self.make_request(url_path, method, body, params = '', bypass_queue_with: '')
+      ssl_verifyhost = Trophonius.config.local_network ? 0 : 2
+      ssl_verifypeer = !Trophonius.config.local_network
+      base_url = "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}"
+      uri = URI::RFC2396_Parser.new
+      url =
+        URI(
+          uri.escape("#{base_url}/#{url_path}")
+        )
+
+      id = SecureRandom.uuid
+      auth = bypass_queue_with.empty? ? auth_header_bearer(id) : bypass_queue_with
+
+      request =
+        Typhoeus::Request.new(
+          url,
+          method: method.to_sym,
+          body: body,
+          params: params,
+          ssl_verifyhost: ssl_verifyhost,
+          ssl_verifypeer: ssl_verifypeer,
+          headers: { 'Content-Type' => 'application/json', Authorization: auth }
+        )
+
+      DebugPrinter.print_debug('USED URL', url)
+      DebugPrinter.print_debug('SENT BODY', body)
+
+      temp = request.run
+
+      Trophonius.connection_manager.dequeue(id) if bypass_queue_with.empty?
+
+      begin
+        response_body = JSON.parse(temp.response_body)
+        DebugPrinter.print_debug('RECEIVED BODY', JSON.pretty_generate(response_body))
+        response_body
+      rescue StandardError => e
+        puts e
+        puts e.backtrace
+        Error.throw_error('1631')
+      end
+    end
+
+    ##
+    # Crafts and runs a HTTP request for uploading a file to a container
+    #
+    # @param [URI] urlparam: the url to make the request to
+    #
+    # @param [String] auth: the authentication required for the request
+    #
+    # @param [Tempfile or File] file: file to upload
+    #
+    # @return [JSON] parsed json of the response
+    def self.upload_file_request(url_param, file)
+      base_url = "http#{Trophonius.config.ssl == true ? 's' : ''}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}"
+      url = URI("#{base_url}/#{url_param}")
+
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+
+      id = SecureRandom.uuid
+      request = Net::HTTP::Post.new(url)
+      request['Authorization'] = auth_header_bearer(id)
+      request['Content-Type'] = 'multipart/form-data;'
+      form_data = [['upload', file]]
+      request.set_form form_data, 'multipart/form-data'
+      response = https.request(request)
+      Trophonius.connection_manager.dequeue(id)
+      begin
+        JSON.parse(response.read_body)
+      rescue StandardError
+        Error.throw_error('1631')
+      end
+    end
+
+    ##
+    # Gets a valid auth header containing the access token
+    #
+    # @return [String] a valid auth header containing the access token
+    def self.auth_header_bearer(id)
+      Trophonius.connection_manager.enqueue(id)
+    end
+
+    ##
+    # Retrieves the first record from FileMaker
+    #
+    # @return [JSON] The first record from FileMaker
+    def self.retrieve_first(layout_name)
+      make_request("layouts/#{layout_name}/records?_limit=1", 'get', '{}')
+    end
+
+    ##
+    # Retrieves the fieldnames of a layout
+    #
+    # @return [JSON] The fieldnames of a layout
+    def self.get_layout_field_names(layout_name)
+      make_request("layouts/#{layout_name}", 'get', '{}')['response']['fieldMetaData'].map { |field| field['name'] }
+    rescue StandardError => e
+      puts e
+      puts e.backtrace
+      Error.throw_error('1631')
+    end
+
+    ##
+    # Runs a FileMaker script
+    #
+    # @return [JSON] The script result from FileMaker
+    def self.run_script(script, scriptparameter, layout_name)
+      make_request("/layouts/#{layout_name}/records?_limit=1&script=#{script}&script.param=#{scriptparameter}", 'get', '{}')
+    end
+
+    ##
+    # Retrieves the 10000000 records from FileMaker
+    #
+    # @return [JSON] The first 10000000 records from FileMaker
+    def self.retrieve_all(layout_name, sort)
+      path = "layouts/#{layout_name}/records?_limit=10000000#{
+        Trophonius.config.count_result_script == '' ? '' : "&script=#{Trophonius.config.count_result_script}"
+      }"
+      path += "&_sort=#{sort_order}" if sort.present?
+      path += "&script=#{Trophonius.config.count_result_script}" if Trophonius.config.count_result_script.present?
+      make_request(path, 'get', '{}')
+    end
+  end
+end

data/lib/{trophonius_redis_manager.rb → connectors/redis_manager.rb}

@@ -2,14 +2,15 @@ module Trophonius
   # the RedisManager module is used to create a (single) connection to a redis store.
   module Trophonius::RedisManager
     def self.connect
-      if Trophonius.config.redis_connection
-        if ENV['REDIS_URL'] && ENV['REDIS_URL'] != ''
-          @redis ||= Redis.new(url: ENV['REDIS_URL'])
-        else
-          @redis ||= Redis.new
-        end
-      end
-      return nil
+      return unless Trophonius.config.redis_connection
+
+      redis_url = ENV.fetch('REDIS_URL')
+      options = {}
+      options.merge!(url: redis_url) if redis_url && redis_url != ''
+      options.merge!(ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE }) if Trophonius.config.redis_no_verify
+      @redis ||= Redis.new(options)
+
+      nil
     end
 
     ##

data/lib/debug_printer.rb

@@ -0,0 +1,11 @@
+module Trophonius
+  module DebugPrinter
+    def self.print_debug(open_close_message, message)
+      return unless Trophonius.config.debug == true
+
+      puts "======== #{open_close_message} ========"
+      puts message
+      puts "======== #{open_close_message} ========"
+    end
+  end
+end

data/lib/{trophonius_error.rb → error.rb}

@@ -1,8 +1,8 @@
 require 'json'
-require 'trophonius_config'
+require 'config'
 
 module Trophonius
-  module Trophonius::Error
+  module Error
     class RecordNotFoundError < StandardError; end # :nodoc:
     class FieldUnexistingError < NoMethodError; end # :nodoc:
     class ScriptUnexistingError < NoMethodError; end # :nodoc:
@@ -89,7 +89,7 @@ module Trophonius
       when '101'
         raise RecordNotFoundError.new, "Record #{more_info} was not found"
       when '102'
-        raise FieldUnexistingError.new, 'Field does not exist' if more_info.zero?
+        raise FieldUnexistingError.new, 'Field does not exist' if more_info.is_a?(Integer) && more_info.zero?
 
         raise FieldUnexistingError.new, "Following field(s) #{more_info} do not exist on layout #{layout_info}"
       when '103'

data/lib/{trophonius_date.rb → fm_date.rb}

@@ -1,6 +1,6 @@
 class Date
   def to_fm
-    self.strftime('%m/%d/%Y')
+    strftime('%m/%d/%Y')
   end
 
   def self.from_fm(fm_date)

data/lib/fm_time.rb

@@ -0,0 +1,11 @@
+class Time
+  def to_fm
+    strftime('%m-%d-%Y %H:%M:%S')
+  end
+
+  def self.from_fm(time)
+    Time.strptime(time, '%m/%d/%Y %H:%M:%S')
+  end
+
+  alias convert_to_fm to_fm
+end

data/lib/generators/trophonius_generator.rb

@@ -22,6 +22,7 @@ module Trophonius
   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
+  config.fm_18 = true
   # 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"