filemaker 0.0.1

data/lib/filemaker/store/database_store.rb

@@ -0,0 +1,21 @@
+module Filemaker
+  module Store
+    class DatabaseStore < Hash
+      def initialize(server)
+        @server = server
+      end
+
+      def [](name)
+        super || self[name] = Filemaker::Database.new(name, @server)
+      end
+
+      def all
+        response, _params = @server.perform_request(:post, '-dbnames', nil)
+        resultset = Filemaker::Resultset.new(@server, response.body)
+        resultset.map do |record|
+          record['DATABASE_NAME']
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/store/layout_store.rb

@@ -0,0 +1,23 @@
+module Filemaker
+  module Store
+    class LayoutStore < Hash
+      def initialize(server, database)
+        @server = server
+        @database = database
+      end
+
+      def [](name)
+        super || self[name] = Filemaker::Layout.new(name, @server, @database)
+      end
+
+      def all
+        args = { '-db' => @database.name }
+        response, _params = @server.perform_request(:post, '-layoutnames', args)
+        resultset = Filemaker::Resultset.new(@server, response.body)
+        resultset.map do |record|
+          record['LAYOUT_NAME']
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/store/script_store.rb

@@ -0,0 +1,23 @@
+module Filemaker
+  module Store
+    class ScriptStore < Hash
+      def initialize(server, database)
+        @server = server
+        @database = database
+      end
+
+      def [](name)
+        super || self[name] = Filemaker::Script.new(name, @server, @database)
+      end
+
+      def all
+        args = { '-db' => @database.name }
+        response, _params = @server.perform_request(:post, '-scriptnames', args)
+        resultset = Filemaker::Resultset.new(@server, response.body)
+        resultset.map do |record|
+          record['SCRIPT_NAME']
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/version.rb

@@ -0,0 +1,3 @@
+module Filemaker
+  VERSION = '0.0.1'
+end

data/spec/filemaker/api/query_commands/compound_find_spec.rb

@@ -0,0 +1,69 @@
+describe Filemaker::Api::QueryCommands::CompoundFind do
+
+  context 'with hash' do
+    it '{a: [1, 2]} to (q0);(q1)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        a: [1, 2]
+      ).key_maps_string).to eq '(q0);(q1)'
+    end
+
+    it '{a: [1, 2, 3]} to (q0);(q1);(q2)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        a: [1, 2, 3]
+      ).key_maps_string).to eq '(q0);(q1);(q2)'
+    end
+
+    it '{a: 1, b: 2} to (q0,q1)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        a: 1, b: 2
+      ).key_maps_string).to eq '(q0,q1)'
+    end
+
+    it '{a: 1, b: 2} to (q0,q1)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        a: 1, b: 2
+      ).key_maps_string).to eq '(q0,q1)'
+    end
+
+    it '{a: [1, 2], b: 2} to (q0,q2);(q1,q2)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        a: [1, 2], b: 1
+      ).key_maps_string).to eq '(q0,q2);(q1,q2)'
+    end
+
+    it '{a: [1, 2], b: 2, c: 3} to (q0,q2,q3);(q1,q2,q3)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        a: [1, 2], b: 2, c: 3
+      ).key_maps_string).to eq '(q0,q2,q3);(q1,q2,q3)'
+    end
+
+    it '{a: [1, 2], "-omit": true} to !(q0);!(q1)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        a: [1, 2], '-omit' => true
+      ).key_maps_string).to eq '!(q0);!(q1)'
+    end
+  end
+
+  context 'with array' do
+    it '[{a: 1}, {b: 2}] to (q0);(q1)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        [{ a: 1 }, { b: 2 }]
+      ).key_maps_string).to eq '(q0);(q1)'
+    end
+
+    it '[{a: 1, b: 2}, {c: 3}] to (q0,q1);(q2)' do
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        [{ a: 1, b: 2 }, { c: 3 }]
+      ).key_maps_string).to eq '(q0,q1);(q2)'
+    end
+
+    it '[{a: [1, 2, 3], b: 1}, {c: 4, "-omit" => true}] to
+      (q0,q3);(q1,q3);(q2,q3);!(q4)' do
+
+      expect(Filemaker::Api::QueryCommands::CompoundFind.new(
+        [{ a: [1, 2, 3], b: 1 }, { c: 4, '-omit' => true }]
+      ).key_maps_string).to eq '(q0,q3);(q1,q3);(q2,q3);!(q4)'
+    end
+  end
+
+end

data/spec/filemaker/error_spec.rb

@@ -0,0 +1,257 @@
+describe Filemaker::Error do
+
+  context '-1 to 100 errors' do
+    it 'raises UnknownError for -1' do
+      expect do
+        Filemaker::Error.raise_error_by_code(-1)
+      end.to raise_error Filemaker::Error::UnknownError
+    end
+
+    it 'raises UserCancelledError for 1' do
+      expect do
+        Filemaker::Error.raise_error_by_code(1)
+      end.to raise_error Filemaker::Error::UserCancelledError
+    end
+
+    it 'raises MemoryError for 2' do
+      expect do
+        Filemaker::Error.raise_error_by_code(2)
+      end.to raise_error Filemaker::Error::MemoryError
+    end
+
+    it 'raises CommandNotAvailableError for 3' do
+      expect do
+        Filemaker::Error.raise_error_by_code(3)
+      end.to raise_error Filemaker::Error::CommandNotAvailableError
+    end
+
+    it 'raises CommandUnknownError for 4' do
+      expect do
+        Filemaker::Error.raise_error_by_code(4)
+      end.to raise_error Filemaker::Error::CommandUnknownError
+    end
+
+    it 'raises CommandInvalidError for 5' do
+      expect do
+        Filemaker::Error.raise_error_by_code(5)
+      end.to raise_error Filemaker::Error::CommandInvalidError
+    end
+
+    it 'raises FileReadOnlyError for 6' do
+      expect do
+        Filemaker::Error.raise_error_by_code(6)
+      end.to raise_error Filemaker::Error::FileReadOnlyError
+    end
+
+    it 'raises OutOfMemoryError for 7' do
+      expect do
+        Filemaker::Error.raise_error_by_code(7)
+      end.to raise_error Filemaker::Error::OutOfMemoryError
+    end
+
+    it 'raises EmptyResultError for 8' do
+      expect do
+        Filemaker::Error.raise_error_by_code(8)
+      end.to raise_error Filemaker::Error::EmptyResultError
+    end
+
+    it 'raises InsufficientPrivilegesError for 9' do
+      expect do
+        Filemaker::Error.raise_error_by_code(9)
+      end.to raise_error Filemaker::Error::InsufficientPrivilegesError
+    end
+
+    it 'raises RequestedDataMissingError for 10' do
+      expect do
+        Filemaker::Error.raise_error_by_code(10)
+      end.to raise_error Filemaker::Error::RequestedDataMissingError
+    end
+  end
+
+  context '100 to 199 errors' do
+    it 'raises FileMissingError for 100' do
+      expect do
+        Filemaker::Error.raise_error_by_code(100)
+      end.to raise_error Filemaker::Error::FileMissingError
+    end
+
+    it 'raises RecordMissingError for 101' do
+      expect do
+        Filemaker::Error.raise_error_by_code(101)
+      end.to raise_error Filemaker::Error::RecordMissingError
+    end
+
+    it 'raises FieldMissingError for 102' do
+      expect do
+        Filemaker::Error.raise_error_by_code(102)
+      end.to raise_error Filemaker::Error::FieldMissingError
+    end
+
+    it 'raises ScriptMissingError for 104' do
+      expect do
+        Filemaker::Error.raise_error_by_code(104)
+      end.to raise_error Filemaker::Error::ScriptMissingError
+    end
+
+    it 'raises LayoutMissingError for 105' do
+      expect do
+        Filemaker::Error.raise_error_by_code(105)
+      end.to raise_error Filemaker::Error::LayoutMissingError
+    end
+
+    it 'raises TableMissingError for 106' do
+      expect do
+        Filemaker::Error.raise_error_by_code(106)
+      end.to raise_error Filemaker::Error::TableMissingError
+    end
+
+    it 'raises MissingError for 116' do
+      expect do
+        Filemaker::Error.raise_error_by_code(106)
+      end.to raise_error Filemaker::Error::MissingError
+    end
+  end
+
+  context '200 to 299 errors' do
+    it 'raises RecordAccessDeniedError for 200' do
+      expect do
+        Filemaker::Error.raise_error_by_code(200)
+      end.to raise_error Filemaker::Error::RecordAccessDeniedError
+    end
+
+    it 'raises FieldCannotBeModifiedError for 201' do
+      expect do
+        Filemaker::Error.raise_error_by_code(201)
+      end.to raise_error Filemaker::Error::FieldCannotBeModifiedError
+    end
+
+    it 'raises FieldAccessDeniedError for 202' do
+      expect do
+        Filemaker::Error.raise_error_by_code(202)
+      end.to raise_error Filemaker::Error::FieldAccessDeniedError
+    end
+  end
+
+  context '300 to 399 errors' do
+    it 'raises FileLockedError for 300' do
+      expect do
+        Filemaker::Error.raise_error_by_code(300)
+      end.to raise_error Filemaker::Error::FileLockedError
+    end
+
+    it 'raises FileLockedError for 301' do
+      expect do
+        Filemaker::Error.raise_error_by_code(301)
+      end.to raise_error Filemaker::Error::RecordInUseError
+    end
+
+    it 'raises TableInUseError for 302' do
+      expect do
+        Filemaker::Error.raise_error_by_code(302)
+      end.to raise_error Filemaker::Error::TableInUseError
+    end
+
+    it 'raises RecordModificationIdMismatchError for 306' do
+      expect do
+        Filemaker::Error.raise_error_by_code(306)
+      end.to raise_error Filemaker::Error::RecordModificationIdMismatchError
+    end
+  end
+
+  context '400 to 499 errors' do
+    it 'raises FindCriteriaEmptyError for 400' do
+      expect do
+        Filemaker::Error.raise_error_by_code(400)
+      end.to raise_error Filemaker::Error::FindCriteriaEmptyError
+    end
+
+    it 'raises NoRecordsFoundError for 401' do
+      expect do
+        Filemaker::Error.raise_error_by_code(401)
+      end.to raise_error Filemaker::Error::NoRecordsFoundError
+    end
+  end
+
+  context '500 to 599 errors' do
+    it 'raises DateValidationError for 500' do
+      expect do
+        Filemaker::Error.raise_error_by_code(500)
+      end.to raise_error Filemaker::Error::DateValidationError
+    end
+
+    it 'raises TimeValidationError for 501' do
+      expect do
+        Filemaker::Error.raise_error_by_code(501)
+      end.to raise_error Filemaker::Error::TimeValidationError
+    end
+
+    it 'raises NumberValidationError for 502' do
+      expect do
+        Filemaker::Error.raise_error_by_code(502)
+      end.to raise_error Filemaker::Error::NumberValidationError
+    end
+
+    it 'raises RangeValidationError for 503' do
+      expect do
+        Filemaker::Error.raise_error_by_code(503)
+      end.to raise_error Filemaker::Error::RangeValidationError
+    end
+
+    it 'raises UniquenessValidationError for 504' do
+      expect do
+        Filemaker::Error.raise_error_by_code(504)
+      end.to raise_error Filemaker::Error::UniquenessValidationError
+    end
+
+    it 'raises ExistingValidationError for 505' do
+      expect do
+        Filemaker::Error.raise_error_by_code(505)
+      end.to raise_error Filemaker::Error::ExistingValidationError
+    end
+
+    it 'raises ValueListValidationError for 506' do
+      expect do
+        Filemaker::Error.raise_error_by_code(506)
+      end.to raise_error Filemaker::Error::ValueListValidationError
+    end
+
+    it 'raises CalculationValidationError for 507' do
+      expect do
+        Filemaker::Error.raise_error_by_code(507)
+      end.to raise_error Filemaker::Error::CalculationValidationError
+    end
+
+    it 'raises InvalidFindModeValueValidationError for 508' do
+      expect do
+        Filemaker::Error.raise_error_by_code(508)
+      end.to raise_error Filemaker::Error::InvalidFindModeValueValidationError
+    end
+
+    it 'raises MaximumCharactersValidationError for 511' do
+      expect do
+        Filemaker::Error.raise_error_by_code(511)
+      end.to raise_error Filemaker::Error::MaximumCharactersValidationError
+    end
+  end
+
+  context '800 to 899 errors' do
+    it 'raises UnableToCreateFileError for 800' do
+      expect do
+        Filemaker::Error.raise_error_by_code(800)
+      end.to raise_error Filemaker::Error::UnableToCreateFileError
+    end
+
+    it 'raises UnableToCreateTempFileError for 801' do
+      expect do
+        Filemaker::Error.raise_error_by_code(801)
+      end.to raise_error Filemaker::Error::UnableToCreateTempFileError
+    end
+
+    it 'raises UnableToOpenFileError for 802' do
+      expect do
+        Filemaker::Error.raise_error_by_code(802)
+      end.to raise_error Filemaker::Error::UnableToOpenFileError
+    end
+  end
+
+end

data/spec/filemaker/layout_spec.rb

@@ -0,0 +1,229 @@
+describe Filemaker::Layout do
+
+  it 'presets -db and -lay' do
+    database = Filemaker::Database.new('candidates', double)
+    layout = Filemaker::Layout.new('profile', double, database)
+    expected_params = { '-db' => 'candidates', '-lay' => 'profile' }
+    expect(layout.default_params).to eq expected_params
+  end
+
+  context 'api' do
+
+    before do
+      @server = Filemaker::Server.new do |config|
+        config.host         = 'host'
+        config.account_name = 'account_name'
+        config.password     = 'password'
+      end
+
+      fake_post_response(@server, nil, 'employment.xml')
+      @layout = @server.db['candidates']['Profile']
+    end
+
+    describe 'findany' do
+      it 'finds a random record' do
+        resultset = @layout.findany
+        expect(resultset.params).to have_key('-findany')
+        expect(resultset.params['-db']).to eq 'candidates'
+        expect(resultset.params['-lay']).to eq 'Profile'
+        expect(resultset.params['-findany']).to eq ''
+      end
+
+      it 'ignores -skip, -max' do
+        resultset = @layout.findany(max: 1, skip: 2)
+        expect(resultset.params).to_not have_key('-max')
+        expect(resultset.params).to_not have_key('-skip')
+      end
+    end
+
+    describe 'findall' do
+      it 'finds all records' do
+        resultset = @layout.findall
+        expect(resultset.params).to have_key('-findall')
+        expect(resultset.params['-db']).to eq 'candidates'
+        expect(resultset.params['-lay']).to eq 'Profile'
+        expect(resultset.params['-findall']).to eq ''
+      end
+
+      it 'allows -max, -skip' do
+        resultset = @layout.findall(
+          max: 5, skip: 10,
+          sortfield: %w(f1 f2), sortorder: ['descend']
+        )
+
+        expect(resultset.params['-max']).to eq 5
+        expect(resultset.params['-skip']).to eq 10
+        expect(resultset.params['-sortfield.1']).to eq 'f1'
+        expect(resultset.params['-sortfield.2']).to eq 'f2'
+        expect(resultset.params['-sortorder.1']).to eq 'descend'
+        expect(resultset.params['-sortorder.2']).to eq 'ascend'
+      end
+
+      it 'will not accept more than 9 sortfields' do
+        expect do
+          @layout.findall(
+            sortfield: %w(f1 f2 f3 f4 f5 f6 f7 f8 f9 f10),
+            sortorder: %w(o1 o2 o3 o4 o5 o6 o7 o8 o9)
+          )
+        end.to raise_error Filemaker::Error::ParameterError
+      end
+
+      it 'will not accept more than 9 sortorders' do
+        expect do
+          @layout.findall(
+            sortfield: %w(f1 f2 f3 f4 f5 f6 f7 f8 f9),
+            sortorder: %w(o1 o2 o3 o4 o5 o6 o7 o8 o9 o10)
+          )
+        end.to raise_error Filemaker::Error::ParameterError
+      end
+    end
+
+    describe 'find' do
+      it 'finds a single record using -recid' do
+        resultset = @layout.find(1)
+        expect(resultset.params).to have_key('-find')
+        expect(resultset.params['-db']).to eq 'candidates'
+        expect(resultset.params['-lay']).to eq 'Profile'
+        expect(resultset.params['-find']).to eq ''
+        expect(resultset.params['-recid']).to eq '1'
+      end
+
+      it 'finds some records with criteria' do
+        args = { name: 'Bob', day: Date.parse('25/8/2014') }
+        resultset = @layout.find(args, max: 1)
+
+        expect(resultset.params['name']).to eq 'Bob'
+        expect(resultset.params['day']).to eq '08/25/2014'
+        expect(resultset.params['-max']).to eq 1
+      end
+
+      it 'switches layout for response' do
+        resultset = @layout.find({}, lay_response: 'my_layout')
+        expect(resultset.params['-lay.response']).to eq 'my_layout'
+      end
+
+      it 'OR the query' do
+        resultset = @layout.find({}, lop: 'or')
+        expect(resultset.params['-lop']).to eq 'or'
+      end
+    end
+
+    describe 'delete' do
+      it 'deletes a record' do
+        resultset = @layout.delete(1)
+        expect(resultset.params).to have_key('-delete')
+        expect(resultset.params['-db']).to eq 'candidates'
+        expect(resultset.params['-lay']).to eq 'Profile'
+        expect(resultset.params['-delete']).to eq ''
+        expect(resultset.params['-recid']).to eq '1'
+      end
+    end
+
+    describe 'edit' do
+      it 'edits a record' do
+        resultset = @layout.edit(123, { first_name: 'Bob' }, modid: 55)
+        expect(resultset.params).to have_key('-edit')
+        expect(resultset.params['-db']).to eq 'candidates'
+        expect(resultset.params['-lay']).to eq 'Profile'
+        expect(resultset.params['-edit']).to eq ''
+        expect(resultset.params['-recid']).to eq '123'
+        expect(resultset.params['first_name']).to eq 'Bob'
+        expect(resultset.params['-modid']).to eq 55
+      end
+
+      it 'filters layout relatedset and returns all portal records' do
+        args = { first_name: 'Bob' }
+        options = { relatedsets_filter: 'layout', relatedsets_max: 'all' }
+        resultset = @layout.edit(123, args, options)
+        expect(resultset.params['-relatedsets.filter']).to eq 'layout'
+        expect(resultset.params['-relatedsets.max']).to eq 'all'
+      end
+
+      it 'deletes a portal record using -edit' do
+        resultset = @layout.edit(123, {}, delete_related: 'jobtable.20')
+        expect(resultset.params['-delete.related']).to eq 'jobtable.20'
+      end
+    end
+
+    describe 'new' do
+      it 'adds a new record' do
+        resultset = @layout.new({ first_name: 'Bob' })
+        expect(resultset.params).to have_key('-new')
+        expect(resultset.params['-db']).to eq 'candidates'
+        expect(resultset.params['-lay']).to eq 'Profile'
+        expect(resultset.params['-new']).to eq ''
+        expect(resultset.params['first_name']).to eq 'Bob'
+      end
+    end
+
+    describe 'dup' do
+      it 'duplicates a record' do
+        resultset = @layout.dup(123)
+        expect(resultset.params).to have_key('-dup')
+        expect(resultset.params['-db']).to eq 'candidates'
+        expect(resultset.params['-lay']).to eq 'Profile'
+        expect(resultset.params['-dup']).to eq ''
+        expect(resultset.params['-recid']).to eq '123'
+      end
+    end
+
+    describe 'view' do
+      it 'retrieves layout information with zero record' do
+        resultset = @layout.view
+        expect(resultset.params).to have_key('-view')
+        expect(resultset.params['-view']).to eq ''
+      end
+    end
+
+    describe 'query' do
+      it 'transform {a: [1,2]} to (q0);(q1)' do
+        resultset = @layout.query(status: %w(open closed))
+        expect(resultset.params['-query']).to eq '(q0);(q1)'
+      end
+
+      it 'transforms [{a:1, b:2}, {c:3}, {d:4}, {e:5, "-omit": true}] to \
+        (q0,q1);(q2);(q3);!(q4)' do
+
+        resultset = @layout.query(
+          [{ a: 1, b: 2 }, { c: 3 }, { d: 4 }, { e: 5, '-omit' => true }]
+        )
+        expect(resultset.params['-query']).to eq '(q0,q1);(q2);(q3);!(q4)'
+      end
+    end
+
+    context 'script, prefind, and presort' do
+      it 'can do -script' do
+        resultset = @layout.find(1, script: 'Remove Duplicates')
+        expect(resultset.params['-script']).to eq 'Remove Duplicates'
+      end
+
+      it 'can do -script.param' do
+        resultset = @layout.find(1, script: ['Remove Duplicates', 'reverse'])
+        expect(resultset.params['-script']).to eq 'Remove Duplicates'
+        expect(resultset.params['-script.param']).to eq 'reverse'
+      end
+
+      it 'can do -script.prefind' do
+        resultset = @layout.find(1, script_prefind: 'Unique')
+        expect(resultset.params['-script.prefind']).to eq 'Unique'
+      end
+
+      it 'can do -script.prefind.param' do
+        resultset = @layout.find(1, script_prefind: %w(Unique yes))
+        expect(resultset.params['-script.prefind']).to eq 'Unique'
+        expect(resultset.params['-script.prefind.param']).to eq 'yes'
+      end
+
+      it 'can do -script.presort' do
+        resultset = @layout.find(1, script_presort: 'Order')
+        expect(resultset.params['-script.presort']).to eq 'Order'
+      end
+
+      it 'can do -script.presort.param' do
+        resultset = @layout.find(1, script_presort: %w(Order ascend))
+        expect(resultset.params['-script.presort']).to eq 'Order'
+        expect(resultset.params['-script.presort.param']).to eq 'ascend'
+      end
+    end
+  end
+end