filemaker 0.0.1

data/lib/filemaker/api/query_commands/findquery.rb

@@ -0,0 +1,84 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Find records using compound find query command.
+      #
+      # query(status: 'open', title: 'web') => (q0,q1)
+      # query(status: %w(open closed))      => (q0);(q1)
+      #
+      def query(array_hash)
+        compound_find = CompoundFind.new(array_hash)
+
+        query_hash = compound_find.key_values.merge(
+          '-query' => compound_find.key_maps_string
+        )
+
+        findquery(query_hash)
+      end
+
+      # Raw -findquery if you want to construct your own.
+      def findquery(query_hash, options = {})
+        perform_request('-findquery', query_hash, options)
+      end
+
+      # Convenient compound find query builder
+      class CompoundFind
+        attr_reader :key_values, :key_maps_string
+
+        def initialize(query)
+          @query = query
+          @key_values = {}
+          @key_maps = []
+          @key_maps_string = ''
+          @counter = 0
+
+          become_array(@query).each do |hash|
+            build_key_map(build_key_values(hash))
+          end
+
+          translate_key_maps
+        end
+
+        private
+
+        def build_key_values(hash)
+          q_tag_array = []
+          omit = hash.delete('-omit')
+
+          hash.each do |key, value|
+            q_tag = []
+            become_array(value).each do |v|
+              @key_values["-q#{@counter}"] = key
+              @key_values["-q#{@counter}.value"] = v
+              q_tag << "q#{@counter}"
+              @counter += 1
+            end
+            q_tag_array << q_tag
+          end
+
+          (q_tag_array << '-omit') if omit
+          q_tag_array
+        end
+
+        def build_key_map(q_tag_array)
+          omit = q_tag_array.delete('-omit')
+          len = q_tag_array.length
+          result = q_tag_array.flatten.combination(len).select do |c|
+            q_tag_array.all? { |a| (a & c).size > 0 }
+          end.each { |c| c.unshift('-omit') if omit }
+          @key_maps.concat result
+        end
+
+        def translate_key_maps
+          @key_maps_string << @key_maps.map do |a|
+            "#{'!' if a.delete('-omit')}(#{a.join(',')})"
+          end.join(';')
+        end
+
+        def become_array(value)
+          value.is_a?(Array) ? value : [value]
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/api/query_commands/new.rb

@@ -0,0 +1,21 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Add new record.
+      #
+      # -script
+      # -script.param
+      # -relatedsets.filter
+      # -relatedsets.max
+      #
+      def new(values, options = {})
+        valid_options(options,
+                      :script,
+                      :relatedsets_filter,
+                      :relatedsets_max)
+
+        perform_request('-new', values, options)
+      end
+    end
+  end
+end

data/lib/filemaker/api/query_commands/view.rb

@@ -0,0 +1,11 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Retrieves <metadata> section of XML.
+      #
+      def view
+        perform_request('-view', {}, {})
+      end
+    end
+  end
+end

data/lib/filemaker/configuration.rb

@@ -0,0 +1,28 @@
+module Filemaker
+  class Configuration
+    attr_accessor :host, :account_name, :password, :ssl, :endpoint
+    attr_accessor :log
+
+    def initialize
+      @endpoint = '/fmi/xml/fmresultset.xml'
+    end
+
+    def not_configurable?
+      host_missing? || account_name_missing? || password_missing?
+    end
+
+    %w(host account_name password).each do |name|
+      define_method "#{name}_missing?" do
+        (send(name.to_sym) || '').empty?
+      end
+    end
+
+    def connection_options
+      ssl.is_a?(Hash) ? { ssl: ssl } : {}
+    end
+
+    def url
+      (ssl.is_a?(Hash) || ssl == true) ? "https://#{host}" : "http://#{host}"
+    end
+  end
+end

data/lib/filemaker/core_ext/hash.rb

@@ -0,0 +1,32 @@
+class Hash
+  def transform_keys
+    return enum_for(:transform_keys) unless block_given?
+    result = self.class.new
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  def stringify_keys
+    transform_keys { |key| key.to_s }
+  end
+end
+
+module Filemaker
+  class HashWithIndifferentAndCaseInsensitiveAccess < Hash
+    def []=(key, value)
+      super(convert_key(key), value)
+    end
+
+    def [](key)
+      super(convert_key(key))
+    end
+
+    protected
+
+    def convert_key(key)
+      key.to_s.downcase
+    end
+  end
+end

data/lib/filemaker/database.rb

@@ -0,0 +1,29 @@
+module Filemaker
+  class Database
+    # @return [String] database name
+    attr_reader :name
+
+    # @return [Filemaker::Server] the server
+    attr_reader :server
+
+    # @return [Filemaker::Store::LayoutStore] the layout store
+    attr_reader :layouts
+    alias_method :layout, :layouts
+    alias_method :lay, :layouts
+
+    # @return [Filemaker::Store::ScriptStore] the script store
+    attr_reader :scripts
+
+    def initialize(name, server)
+      @name = name
+      @server = server
+      @layouts = Store::LayoutStore.new(server, self)
+      @scripts = Store::ScriptStore.new(server, self)
+    end
+
+    # A very convenient way to access some layout from this database
+    def [](layout_name)
+      layouts[layout_name]
+    end
+  end
+end

data/lib/filemaker/error.rb

@@ -0,0 +1,391 @@
+module Filemaker
+  module Error
+    class CommunicationError < StandardError; end
+    class AuthenticationError < StandardError; end
+    class ParameterError < StandardError; end
+    class CoerceError < StandardError; end
+
+    class FilemakerError < StandardError
+      attr_reader :code
+
+      def initialize(code, message = nil)
+        @code = code
+        super(message)
+      end
+    end
+
+    class SystemError < FilemakerError; end
+
+    class UnknownError < SystemError; end
+    class UserCancelledError < SystemError; end
+    class MemoryError < SystemError; end
+    class CommandNotAvailableError < SystemError; end
+    class CommandUnknownError < SystemError; end
+    class CommandInvalidError < SystemError; end
+    class FileReadOnlyError < SystemError; end
+    class OutOfMemoryError < SystemError; end
+    class EmptyResultError < SystemError; end
+    class InsufficientPrivilegesError < SystemError; end
+    class RequestedDataMissingError < SystemError; end
+
+    class MissingError < FilemakerError; end
+    class FileMissingError < MissingError; end
+    class RecordMissingError < MissingError; end
+    class FieldMissingError < MissingError; end
+    class ScriptMissingError < MissingError; end
+    class LayoutMissingError < MissingError; end
+    class TableMissingError < MissingError; end
+
+    class SecurityError < FilemakerError; end
+    class RecordAccessDeniedError < SecurityError; end
+    class FieldCannotBeModifiedError < SecurityError; end
+    class FieldAccessDeniedError < SecurityError; end
+
+    class ConcurrencyError < FilemakerError; end
+    class FileLockedError < ConcurrencyError; end
+    class RecordInUseError < ConcurrencyError; end
+    class TableInUseError < ConcurrencyError; end
+    class RecordModificationIdMismatchError < ConcurrencyError; end
+
+    class GeneralError < FilemakerError; end
+    class FindCriteriaEmptyError < GeneralError; end
+    class NoRecordsFoundError < GeneralError; end
+
+    class ValidationError < FilemakerError; end
+    class DateValidationError < ValidationError; end
+    class TimeValidationError < ValidationError; end
+    class NumberValidationError < ValidationError; end
+    class RangeValidationError < ValidationError; end
+    class UniquenessValidationError < ValidationError; end
+    class ExistingValidationError < ValidationError; end
+    class ValueListValidationError < ValidationError; end
+    class CalculationValidationError < ValidationError; end
+    class InvalidFindModeValueValidationError < ValidationError; end
+    class MaximumCharactersValidationError < ValidationError; end
+
+    class FileError < FilemakerError; end
+    class UnableToCreateFileError < FileError; end
+    class UnableToCreateTempFileError < FileError; end
+    class UnableToOpenFileError < FileError; end
+
+    def self.raise_error_by_code(code)
+      msg = error_message_by_code(code)
+      error_class = find_error_class_by_code(code)
+      raise error_class.new(code, msg)
+    end
+
+    def self.error_message_by_code(code)
+      "FileMaker Error: #{code} (#{DESCRIPTION.fetch(code.to_s) { '??' }})"
+    end
+
+    def self.find_error_class_by_code(code)
+      case code
+      when -1  then UnknownError
+      when 1..99
+        if code == 1; UserCancelledError
+        elsif code == 2; MemoryError
+        elsif code == 3; CommandNotAvailableError
+        elsif code == 4; CommandUnknownError
+        elsif code == 5; CommandInvalidError
+        elsif code == 6; FileReadOnlyError
+        elsif code == 7; OutOfMemoryError
+        elsif code == 8; EmptyResultError
+        elsif code == 9; InsufficientPrivilegesError
+        elsif code == 10; RequestedDataMissingError
+        else SystemError; end
+      when 100..199
+        if code == 100; FileMissingError
+        elsif code == 101; RecordMissingError
+        elsif code == 102; FieldMissingError
+        elsif code == 104; ScriptMissingError
+        elsif code == 105; LayoutMissingError
+        elsif code == 106; TableMissingError
+        else MissingError; end
+      when 200..299
+        if code == 200; RecordAccessDeniedError
+        elsif code == 201; FieldCannotBeModifiedError
+        elsif code == 202; FieldAccessDeniedError
+        else SecurityError; end
+      when 300..399
+        if code == 300; FileLockedError
+        elsif code == 301; RecordInUseError
+        elsif code == 302; TableInUseError
+        elsif code == 306; RecordModificationIdMismatchError
+        else ConcurrencyError; end
+      when 400..499
+        if code == 400; FindCriteriaEmptyError
+        elsif code == 401; NoRecordsFoundError
+        else; GeneralError; end
+      when 500..599
+        if code == 500; DateValidationError
+        elsif code == 501; TimeValidationError
+        elsif code == 502; NumberValidationError
+        elsif code == 503; RangeValidationError
+        elsif code == 504; UniquenessValidationError
+        elsif code == 505; ExistingValidationError
+        elsif code == 506; ValueListValidationError
+        elsif code == 507; CalculationValidationError
+        elsif code == 508; InvalidFindModeValueValidationError
+        elsif code == 511; MaximumCharactersValidationError
+        else; ValidationError; end
+      when 800..899
+        if code == 800; UnableToCreateFileError
+        elsif code == 801; UnableToCreateTempFileError
+        elsif code == 802; UnableToOpenFileError
+        elsif code == 804; FileReadOnlyError
+        else; FileError; end
+      else
+        UnknownError
+      end
+    end
+
+    DESCRIPTION = {
+      '-1'  => 'Unknown error',
+      '1'   => 'User cancelled action',
+      '2'   => 'Memory error',
+      '3'   => 'Command is unavailable (for example, wrong operating system, wrong mode, etc.)',
+      '4'   => 'Command is unknown',
+      '5'   => 'Command is invalid (for example, a Set Field script step does not have a calculation specified)',
+      '6'   => 'File is read-only',
+      '7'   => 'Running out of memory',
+      '8'   => 'Empty result',
+      '9'   => 'Insufficient privileges',
+      '10'  => 'Requested data is missing',
+      '11'  => 'Name is not valid',
+      '12'  => 'Name already exists',
+      '13'  => 'File or object is in use',
+      '14'  => 'Out of range',
+      '15'  => 'Can\'t divide by zero',
+      '16'  => 'Operation failed, request retry (for example, a user query)',
+      '17'  => 'Attempt to convert foreign character set to UTF-16 failed',
+      '18'  => 'Client must provide account information to proceed',
+      '19'  => 'String contains characters other than A-Z, a-z, 0-9 (ASCII)',
+      '20'  => 'Command or operation cancelled by triggered script',
+      '21'  => 'Request not supported (for example, when creating a hard link on a file system that does not support hard links)',
+      '100' => 'File is missing',
+      '101' => 'Record is missing',
+      '102' => 'Field is missing',
+      '103' => 'Relationship is missing',
+      '104' => 'Script is missing',
+      '105' => 'Layout is missing',
+      '106' => 'Table is missing',
+      '107' => 'Index is missing',
+      '108' => 'Value list is missing',
+      '109' => 'Privilege set is missing',
+      '110' => 'Related tables are missing',
+      '111' => 'Field repetition is invalid',
+      '112' => 'Window is missing',
+      '113' => 'Function is missing',
+      '114' => 'File reference is missing',
+      '115' => 'Menu set is missing',
+      '116' => 'Layout object is missing',
+      '117' => 'Data source is missing',
+      '118' => 'Theme is missing',
+      '130' => 'Files are damaged or missing and must be reinstalled',
+      '131' => 'Language pack files are missing (such as Starter Solutions)',
+      '200' => 'Record access is denied',
+      '201' => 'Field cannot be modified',
+      '202' => 'Field access is denied',
+      '203' => 'No records in file to print, or password doesn\'t allow print access',
+      '204' => 'No access to field(s) in sort order',
+      '205' => 'User does not have access privileges to create new records; import will overwrite existing data',
+      '206' => 'User does not have password change privileges, or file is not modifiable',
+      '207' => 'User does not have sufficient privileges to change database schema, or file is not modifiable',
+      '208' => 'Password does not contain enough characters',
+      '209' => 'New password must be different from existing one',
+      '210' => 'User account is inactive',
+      '211' => 'Password has expired',
+      '212' => 'Invalid user account and/or password. Please try again',
+      '213' => 'User account and/or password does not exist',
+      '214' => 'Too many login attempts',
+      '215' => 'Administrator privileges cannot be duplicated',
+      '216' => 'Guest account cannot be duplicated',
+      '217' => 'User does not have sufficient privileges to modify administrator account',
+      '218' => 'Password and verify password do not match',
+      '300' => 'File is locked or in use',
+      '301' => 'Record is in use by another user',
+      '302' => 'Table is in use by another user',
+      '303' => 'Database schema is in use by another user',
+      '304' => 'Layout is in use by another user',
+      '306' => 'Record modification ID does not match',
+      '307' => 'Transaction could not be locked because of a communication error with the host',
+      '308' => 'Theme is locked and in use by another user',
+      '400' => 'Find criteria are empty',
+      '401' => 'No records match the request',
+      '402' => 'Selected field is not a match field for a lookup',
+      '403' => 'Exceeding maximum record limit for trial version of FileMaker Pro',
+      '404' => 'Sort order is invalid',
+      '405' => 'Number of records specified exceeds number of records that can be omitted',
+      '406' => 'Replace/Reserialize criteria are invalid',
+      '407' => 'One or both match fields are missing (invalid relationship)',
+      '408' => 'Specified field has inappropriate data type for this operation',
+      '409' => 'Import order is invalid',
+      '410' => 'Export order is invalid',
+      '412' => 'Wrong version of FileMaker Pro used to recover file',
+      '413' => 'Specified field has inappropriate field type',
+      '414' => 'Layout cannot display the result',
+      '415' => 'One or more required related records are not available',
+      '416' => 'A primary key is required from the data source table',
+      '417' => 'Database is not a supported data source',
+      '418' => 'Internal failure in INSERT operation into a field',
+      '500' => 'Date value does not meet validation entry options',
+      '501' => 'Time value does not meet validation entry options',
+      '502' => 'Number value does not meet validation entry options',
+      '503' => 'Value in field is not within the range specified in validation entry options',
+      '504' => 'Value in field is not unique as required in validation entry options',
+      '505' => 'Value in field is not an existing value in the database file as required in validation entry options',
+      '506' => 'Value in field is not listed on the value list specified in validation entry option',
+      '507' => 'Value in field failed calculation test of validation entry option',
+      '508' => 'Invalid value entered in Find mode',
+      '509' => 'Field requires a valid value',
+      '510' => 'Related value is empty or unavailable',
+      '511' => 'Value in field exceeds maximum field size',
+      '512' => 'Record was already modified by another user',
+      '513' => 'No validation was specified but data cannot fit into the field',
+      '600' => 'Print error has occurred',
+      '601' => 'Combined header and footer exceed one page',
+      '602' => 'Body doesn\'t fit on a page for current column setup',
+      '603' => 'Print connection lost',
+      '700' => 'File is of the wrong file type for import',
+      '706' => 'EPSF file has no preview image',
+      '707' => 'Graphic translator cannot be found',
+      '708' => 'Can\'t import the file or need color monitor support to import file',
+      '709' => 'QuickTime movie import failed',
+      '710' => 'Unable to update QuickTime file reference because the database file is read-only',
+      '711' => 'Import translator cannot be found',
+      '714' => 'Password privileges do not allow the operation',
+      '715' => 'Specified Excel worksheet or named range is missing',
+      '716' => 'A SQL query using DELETE, INSERT, or UPDATE is not allowed for ODBC import',
+      '717' => 'There is not enough XML/XSL information to proceed with the import or export',
+      '718' => 'Error in parsing XML file (from Xerces)',
+      '719' => 'Error in transforming XML using XSL (from Xalan)',
+      '720' => 'Error when exporting; intended format does not support repeating fields',
+      '721' => 'Unknown error occurred in the parser or the transformer',
+      '722' => 'Cannot import data into a file that has no fields',
+      '723' => 'You do not have permission to add records to or modify records in the target table',
+      '724' => 'You do not have permission to add records to the target table',
+      '725' => 'You do not have permission to modify records in the target table',
+      '726' => 'There are more records in the import file than in the target table. Not all records were imported',
+      '727' => 'There are more records in the target table than in the import file. Not all records were updated',
+      '729' => 'Errors occurred during import. Records could not be imported',
+      '730' => 'Unsupported Excel version (convert file to Excel 2007/2008 format or a later supported version and try again)',
+      '731' => 'File you are importing from contains no data',
+      '732' => 'This file cannot be inserted because it contains other files',
+      '733' => 'A table cannot be imported into itself',
+      '734' => 'This file type cannot be displayed as a picture',
+      '735' => 'This file type cannot be displayed as a picture. It will be inserted and displayed as a file',
+      '736' => 'There is too much data to be exported to this format. It will be truncated.',
+      '737' => 'Bento table you are importing is missing',
+      '738' => 'The theme you are importing already exists',
+      '800' => 'Unable to create file on disk',
+      '801' => 'Unable to create temporary file on System disk',
+      '802' => 'Unable to open file',
+      '803' => 'File is single user or host cannot be found',
+      '804' => 'File cannot be opened as read-only in its current state',
+      '805' => 'File is damaged; use Recover command',
+      '806' => 'File cannot be opened with this version of FileMaker Pro',
+      '807' => 'File is not a FileMaker Pro file or is severely damaged',
+      '808' => 'Cannot open file because access privileges are damaged',
+      '809' => 'Disk/volume is full',
+      '810' => 'Disk/volume is locked',
+      '811' => 'Temporary file cannot be opened as FileMaker Pro file',
+      '812' => 'Exceeded host\'s capacity',
+      '813' => 'Record Synchronization error on network',
+      '814' => 'File(s) cannot be opened because maximum number is open',
+      '815' => 'Couldn\'t open lookup file',
+      '816' => 'Unable to convert file',
+      '817' => 'Unable to open file because it does not belong to this solution',
+      '819' => 'Cannot save a local copy of a remote file',
+      '820' => 'File is in the process of being closed',
+      '821' => 'Host forced a disconnect',
+      '822' => 'FMI files not found; reinstall missing files',
+      '823' => 'Cannot set file to single-user, guests are connected',
+      '824' => 'File is damaged or not a FileMaker file',
+      '825' => 'File is not authorized to reference the protected file',
+      '826' => 'File path specified is not a valid file path',
+      '850' => 'Path is not valid for the operating system',
+      '851' => 'Cannot delete an external file from disk',
+      '852' => 'Cannot write a file to the external storage',
+      '853' => 'One or more containers failed to transfer',
+      '900' => 'General spelling engine error',
+      '901' => 'Main spelling dictionary not installed',
+      '902' => 'Could not launch the Help system',
+      '903' => 'Command cannot be used in a shared file',
+      '905' => 'No active field selected; command can only be used if there is an active field',
+      '906' => 'Current file is not shared; command can be used only if the file is shared',
+      '920' => 'Can\'t initialize the spelling engine',
+      '921' => 'User dictionary cannot be loaded for editing',
+      '922' => 'User dictionary cannot be found',
+      '923' => 'User dictionary is read-only',
+      '951' => 'An unexpected error occurred',
+      '954' => 'Unsupported XML grammar',
+      '955' => 'No database name',
+      '956' => 'Maximum number of database sessions exceeded',
+      '957' => 'Conflicting commands',
+      '958' => 'Parameter missing in query',
+      '959' => 'Custom Web Publishing technology is disabled',
+      '960' => 'Parameter is invalid',
+      '1200' => 'Generic calculation error',
+      '1201' => 'Too few parameters in the function',
+      '1202' => 'Too many parameters in the function',
+      '1203' => 'Unexpected end of calculation',
+      '1204' => 'Number, text constant, field name or "(" expected',
+      '1205' => 'Comment is not terminated with "*/"',
+      '1206' => 'Text constant must end with a quotation mark',
+      '1207' => 'Unbalanced parenthesis',
+      '1208' => 'Operator missing, function not found or "(" not expected',
+      '1209' => 'Name (such as field name or layout name) is missing',
+      '1210' => 'Plug-in function has already been registered',
+      '1211' => 'List usage is not allowed in this function',
+      '1212' => 'An operator (for example, +, -, *) is expected here',
+      '1213' => 'This variable has already been defined in the Let function',
+      '1214' => 'AVERAGE, COUNT, EXTEND, GETREPETITION, MAX, MIN, NPV, STDEV, SUM and GETSUMMARY: expression found where a field alone is needed',
+      '1215' => 'This parameter is an invalid Get function parameter',
+      '1216' => 'Only Summary fields allowed as first argument in GETSUMMARY',
+      '1217' => 'Break field is invalid',
+      '1218' => 'Cannot evaluate the number',
+      '1219' => 'A field cannot be used in its own formula',
+      '1220' => 'Field type must be normal or calculated',
+      '1221' => 'Data type must be number, date, time, or timestamp',
+      '1222' => 'Calculation cannot be stored',
+      '1223' => 'Function referred to is not yet implemented',
+      '1224' => 'Function referred to does not exist',
+      '1225' => 'Function referred to is not supported in this context',
+      '1300' => 'The specified name can\'t be used',
+      '1301' => 'One of the parameters of the function being imported or pasted has the same name as a function already in the file',
+      '1400' => 'ODBC client driver initialization failed; make sure the ODBC client drivers are properly installed',
+      '1401' => 'Failed to allocate environment (ODBC)',
+      '1402' => 'Failed to free environment (ODBC)',
+      '1403' => 'Failed to disconnect (ODBC)',
+      '1404' => 'Failed to allocate connection (ODBC)',
+      '1405' => 'Failed to free connection (ODBC)',
+      '1406' => 'Failed check for SQL API (ODBC)',
+      '1407' => 'Failed to allocate statement (ODBC)',
+      '1408' => 'Extended error (ODBC)',
+      '1409' => 'Extended error (ODBC)',
+      '1410' => 'Extended error (ODBC)',
+      '1411' => 'Extended error (ODBC)',
+      '1412' => 'Extended error (ODBC)',
+      '1413' => 'Extended error (ODBC)',
+      '1414' => 'SQL statement is too long',
+      '1450' => 'Action requires PHP privilege extension',
+      '1451' => 'Action requires that current file be remote',
+      '1501' => 'SMTP authentication failed',
+      '1502' => 'Connection refused by SMTP server',
+      '1503' => 'Error with SSL',
+      '1504' => 'SMTP server requires the connection to be encrypted',
+      '1505' => 'Specified authentication is not supported by SMTP server',
+      '1506' => 'Email message(s) could not be sent successfully',
+      '1507' => 'Unable to log in to the SMTP server',
+      '1550' => 'Cannot load the plug-in or the plug-in is not a valid plug-in',
+      '1551' => 'Cannot install the plug-in. Cannot delete an existing plug-in or cannot write to the folder or disk',
+      '1626' => 'Protocol is not supported',
+      '1627' => 'Authentication failed',
+      '1628' => 'There was an error with SSL',
+      '1629' => 'Connection timed out; the timeout value is 60 seconds',
+      '1630' => 'URL format is incorrect',
+      '1631' => 'Connection failed',
+      '8003' => 'Lock conflict with database users or other error'
+    }
+  end
+end