trophonius 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39d58cd73fd9aa4eb16eb71bae7ee950169af5f1d67909d1ad872b1836e21701
-  data.tar.gz: facd02e4e8d4e60953ebb3fc94591ac9e5c67b964c572afa78c5a2e4f19acadc
+  metadata.gz: 21d0e929509f72eea54b627ad8a221d067799a50a0018cabfe1822f81af59e98
+  data.tar.gz: 8f3b25aa6e74b6d8de7aa79df84eb309644fd5cffc5546e12286cbad6adfcb37
 SHA512:
-  metadata.gz: c3068d5fa17f5d8f88baf1a08f4b9e82da6fbc0e9c21ea938c6b6e8b49c93774a3f15c708af6e3a2a7fd413737bed9ae95e1d5c9554daa7a3170e17a37e967b3
-  data.tar.gz: 6bfdb0a45ccca549a011bebb0b0ed738e46f67a6e315f2c79a29cc1348685c91dd83b2212aa75f9486caec9b8d0a2099366486bab6907b64d8fe02f2d2785325
+  metadata.gz: 2cd21fb288d2148692f5b4173fca976a65a4d4a1ab8768fd08c38aae7bb917b70941c3efd5e4d10e8dc1362d0519135d7811cbd81ac334dc970f55bf34e8f167
+  data.tar.gz: dad64504f016d6ffc426f38fcec744530810b9e4d8dfc33c725820f737ea33230fdaed536ebf2e9675c9f655f39c31772193c53df4273cc8d60f209e85723f1c

data/lib/trophonius.rb

@@ -4,6 +4,7 @@ require 'trophonius_config'
 
 module Trophonius # :nodoc:
   def self.configuration
+    Ethon.logger = Logger.new(nil)
     @configuration ||= Configuration.new
   end
 

data/lib/trophonius_model.rb

@@ -2,14 +2,21 @@ require "json"
 require "trophonius_config"
 require "trophonius_record"
 require "trophonius_recordset"
+require "trophonius_query"
 require "trophonius_error"
 
 module Trophonius
   # This class will retrieve the records from the FileMaker database and build a RecordSet filled with Record objects. One Record object represents a record in FileMaker.
   class Trophonius::Model
+    attr_reader :configuration
+    attr_accessor :current_query
+
+    def initialize(config:)
+      @configuration = config
+    end
 
     ##
-    # Sets up the configuration for the model. 
+    # Sets up the configuration for the model.
     #
     # @param [Hash] configuration: the hash containing the config to setup the model correctly.
     #   configuration = {layout_name: "theFileMakerLayoutForThisModel", non_modifiable_fields: ["an", "array", "containing", "calculation_fields", "etc."]}
@@ -23,29 +30,83 @@ module Trophonius
 
     ##
     # Returns the FileMaker layout this Model corresponds to
+    #
+    # @return [String] layout name of the model
     def self.layout_name
       @configuration.layout_name
     end
-    
+
     ##
     # Returns the fields that FileMaker won't allow us to modify
+    #
+    # @return [[Array]] fields that FileMaker won't allow us to modify
     def self.non_modifiable_fields
       @configuration.non_modifiable_fields
     end
 
     ##
     # Returns the translations of the fields
+    #
+    # @return [Hash] translations of the fields Rails -> FileMaker
     def self.translations
       @configuration.translations
     end
-    
+
+    ##
+    # creates Rails -> FileMaker field translations by requesting the first record
+    #
+    # @return [Hash] translations of the fields Rails -> FileMaker
     def self.create_translations
       self.first
+      @configuration.translations
+    end
+    
+    def self.method_missing(method, *args, &block)
+      new_instance = Trophonius::Model.new(config: @configuration)
+      new_instance.current_query = Trophonius::Query.new(trophonius_model: self)
+      # new_instance.current_query.build_query[0].merge!(fieldData)
+      args << new_instance
+      if new_instance.current_query.respond_to?(method)        
+        new_instance.current_query.send(method, args)
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if @current_query.respond_to?(method)
+        args << self
+        @current_query.send(method, args)
+      elsif @current_query.response.respond_to?(method)
+        @current_query.run_query(method, *args, &block)
+      end
+    end
+
+    ##
+    # Finds all records in FileMaker corresponding to the requested query
+    # @param [Hash] fieldData: the data to find
+    #
+    # @return [Trophonius::Model] new instance of the model
+    def self.where(fieldData)
+      new_instance = Trophonius::Model.new(config: @configuration)
+      new_instance.current_query = Trophonius::Query.new(trophonius_model: self)
+      new_instance.current_query.build_query[0].merge!(fieldData)
+      new_instance
+    end
+
+    ##
+    # Finds all records in FileMaker corresponding to the requested query
+    # This method is created to enable where chaining
+    #
+    # @param [Hash] fieldData: the data to find
+    #
+    # @return [Trophonius::Model] new instance of the model
+    def where(fieldData)
+      @current_query.build_query[0].merge!(fieldData)
+      self
     end
 
     ##
     # Creates and saves a record in FileMaker
-    # 
+    #
     # @param [Hash] fieldData: the fields to fill with the data
     #
     # @return [Record] the created record
@@ -76,16 +137,16 @@ module Trophonius
         return ret_val
       end
     end
-    
+
     ##
-    # Finds and returns a RecordSet containing the records fitting the find request
-    # 
+    # Finds and returns the first Record containing fitting the find request
+    #
     # @param [Hash] fieldData: the data to find
     #
-    # @return [RecordSet] a RecordSet containing all the Record objects that correspond to FileMaker records fitting the find request
-    #   Model.where(fieldOne: "Data")
-    def self.where(fieldData)
-      url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{self.layout_name}/_find")
+    # @return [Record] a Record object that correspond to FileMaker record fitting the find request
+    #   Model.find_by(fieldOne: "Data")
+    def self.find_by(fieldData)
+      url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{self.layout_name}/_find?_limit=1")
       new_field_data = {}
       if @configuration.translations.keys.empty?
         create_translations
@@ -109,15 +170,15 @@ module Trophonius
           hash = build_result(r)
           ret_val << hash
         end
-        return ret_val
+        return ret_val.first
       end
     end
 
     ##
     # Finds and returns a Record corresponding to the record_id
-    # 
+    #
     # @param [Integer] record_id: the record id to retrieve from FileMaker
-    # 
+    #
     # @return [Record] the record
     def self.find(record_id)
       url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{record_id}")
@@ -135,10 +196,10 @@ module Trophonius
 
     ##
     # Deletes a record from FileMaker
-    # 
+    #
     # @param [Integer] record_id: the record id to retrieve from FileMaker
     #
-    # @return [Boolean] True if the delete was successful 
+    # @return [Boolean] True if the delete was successful
     def self.delete(record_id)
       url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{layout_name}/records/#{record_id}")
       response = Request.make_request(url, "Bearer #{Request.get_token}", "delete", "{}")
@@ -151,7 +212,7 @@ module Trophonius
 
     ##
     # Edits a record in FileMaker
-    # 
+    #
     # @param [Integer] record_id: the record id to edit in FileMaker
     #
     # @param [Hash] fieldData: A hash containing the fields to edit and the new data to fill them with
@@ -181,7 +242,7 @@ module Trophonius
 
     ##
     # Builds the resulting Record
-    # 
+    #
     # @param [JSON] result: the HTTP result from FileMaker
     #
     # @return [Record] A Record with singleton_methods for the fields where possible
@@ -250,7 +311,7 @@ module Trophonius
     ##
     # Runs a FileMaker script from the context of the Model.
     #
-    # @param [String] script: the FileMaker script to run 
+    # @param [String] script: the FileMaker script to run
     #
     # @param [String] scriptparameter: the parameter required by the FileMaker script
     #
@@ -270,7 +331,7 @@ module Trophonius
     ##
     # Retrieve the first 10000000 records from FileMaker from the context of the Model.
     #
-    # @param [Hash] sort: a hash containing the fields to sort by and the direction to sort in (optional) 
+    # @param [Hash] sort: a hash containing the fields to sort by and the direction to sort in (optional)
     #
     # @return [RecordSet]: a RecordSet containing all the Record objects that correspond to the FileMaker records.
     def self.all(sort: {})

data/lib/trophonius_query.rb

@@ -0,0 +1,99 @@
+require "json"
+require "trophonius_config"
+require "trophonius_record"
+require "trophonius_recordset"
+require "trophonius_error"
+
+module Trophonius
+  class Trophonius::Query
+    attr_reader :response
+
+    ##
+    # Creates a new instance of the Trophonius::Query class
+    # 
+    # @param [Trophonius::Model] base model for the new query
+    # @return [Trophonius::Query] new instance of Trophonius::Query
+    def initialize(trophonius_model:)
+      @response = RecordSet.new(trophonius_model.layout_name, trophonius_model.non_modifiable_fields)
+      @trophonius_model = trophonius_model
+    end
+
+    ##
+    # Returns the current query, creates an empty query if no current query exists
+    #
+    # @return [Array[Hash]] array representing the FileMaker find request
+    def build_query
+      @current_query ||= [{}]
+    end
+
+    def inspect
+      @current_query
+    end
+    
+    ##
+    # Adds a find request to the original query, resulting in an "Or" find-request for FileMaker
+    #
+    # @param [args] arguments containing a Hash containing the FileMaker find request, and the base model object for the query
+    # @return [Trophonius::Model] updated base model
+    def or(args)
+      args[1].current_query.build_query << args[0]
+      args[1]
+    end
+    
+    ##
+    # Adds an omit request to the original query, resulting in an "omit" find for FileMaker
+    #
+    # @param [args] arguments containing a Hash containing the FileMaker omit request, and the base model object for the query
+    # @return [Trophonius::Model] updated base model
+    def not(args)
+      args[1].current_query.build_query << args[0].merge!({omit: true})
+      args[1]
+    end
+    
+    ##
+    # Performs the query in FileMaker
+    #
+    # @param [method] original called method, will be called on the response
+    # @param [*args] original arguments, will be passed to the method call
+    # @param [&block] original block, will be passed to the method call
+    #
+    # @return Response of the called method 
+    def run_query(method, *args, &block)
+      url = URI("http#{Trophonius.config.ssl == true ? "s" : ""}://#{Trophonius.config.host}/fmi/data/v1/databases/#{Trophonius.config.database}/layouts/#{@trophonius_model.layout_name}/_find")
+      new_field_data = @current_query.map { |q| {} }
+      if @trophonius_model.translations.keys.empty?
+        @trophonius_model.create_translations
+      end
+      @current_query.each_with_index do |query, index|
+        query.keys.each do |k|
+          if @trophonius_model.translations.keys.include?(k.to_s)
+            new_field_data[index].merge!({"#{@trophonius_model.translations[k.to_s]}" => query[k].to_s})
+          else
+            new_field_data[index].merge!({"#{k}" => query[k].to_s})
+          end
+        end
+      end
+      body = {query: new_field_data, limit:"100000"}.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"
+          RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields).send(method, *args, &block)
+          return
+        else
+          Error.throw_error(response["messages"][0]["code"])
+        end
+      else
+        r_results = response["response"]["data"]
+        ret_val = RecordSet.new(@trophonius_model.layout_name, @trophonius_model.non_modifiable_fields)
+        r_results.each do |r|
+          hash = @trophonius_model.build_result(r)
+          ret_val << hash
+        end
+        @response = ret_val
+        return @response.send(method, *args, &block)
+      end
+    end
+    
+    alias_method :to_s, :inspect
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trophonius
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.1.0
 platform: ruby
 authors:
 - Kempen Automatisering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -64,6 +64,7 @@ files:
 - lib/trophonius_connection.rb
 - lib/trophonius_error.rb
 - lib/trophonius_model.rb
+- lib/trophonius_query.rb
 - lib/trophonius_record.rb
 - lib/trophonius_recordset.rb
 - lib/trophonius_request.rb