filemaker 0.0.1 → 0.0.2

data/lib/filemaker/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails'
+
+module Rails
+  module Filemaker
+    class Railtie < Rails::Railtie
+      initializer 'filemaker-load-config-yml' do
+        config_file = Rails.root.join('config', 'filemaker.yml')
+
+        if config_file.file?
+          Filemaker.load!(config_file, Rails.env)
+        else
+          fail Error::ConfigurationError, 'No config file provided'
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/record.rb

@@ -9,10 +9,13 @@ module Filemaker
     # @return [Hash] additional nested records
     attr_reader :portals
 
+    attr_reader :dirty
+
     def initialize(record, resultset, portal_table_name = nil)
       @mod_id    = record['mod-id']
       @record_id = record['record-id']
       @portals   = HashWithIndifferentAndCaseInsensitiveAccess.new
+      @dirty     = {} # Keep track of field modification
 
       record.xpath('field').each do |field|
         # `field` is Nokogiri::XML::Element
@@ -36,6 +39,21 @@ module Filemaker
       end
 
       build_portals(record.xpath('relatedset'), resultset)
+
+      @ready = true
+    end
+
+    def [](key)
+      fail(Filemaker::Error::InvalidFieldError, "Invalid field: #{key}") \
+        unless key?(key)
+      super
+    end
+
+    def []=(key, value)
+      return super unless @ready
+      fail(Filemaker::Error::InvalidFieldError, "Invalid field: #{key}") \
+        unless key?(key)
+      @dirty[key] = value
     end
 
     private
@@ -60,5 +78,12 @@ module Filemaker
       return nil if datum.empty?
       (datum.size == 1) ? datum.first : datum
     end
+
+    def method_missing(symbol, *args, &block)
+      method = symbol.to_s
+      return self[method] if key?(method)
+      return @dirty[$`] = args.first if method =~ /(=)$/ && key?($`)
+      super
+    end
   end
 end

data/lib/filemaker/resultset.rb

@@ -38,9 +38,9 @@ module Filemaker
     # @return [String] the raw XML for inspection
     attr_reader :xml
 
-    # @param xml [Filemaker::Server] server
-    # @param xml [String] the XML string from response
-    # @param xml [Hash] the request params used to construct request
+    # @param [Filemaker::Server] server
+    # @param [String] xml The XML string from response
+    # @param [Hash] params The request params used to construct request
     def initialize(server, xml, params = nil)
       @list = []
       @fields = {}
@@ -76,10 +76,18 @@ module Filemaker
       list.each(*args, &block)
     end
 
+    def size
+      list.size
+    end
+    alias_method :length, :size
+
     private
 
+    # For 401 (No records match the request) and 101 (Record is missing), we
+    # will return empty array or nil back rather than raise those errors. Is it
+    # a good design? We need to find out after production usage.
     def raise_potential_error!(error_code)
-      return if error_code.zero?
+      return if error_code.zero? || error_code == 401 || error_code == 101
 
       Filemaker::Error.raise_error_by_code(error_code)
     end

data/lib/filemaker/server.rb

@@ -14,13 +14,13 @@ module Filemaker
     alias_method :database, :databases
     alias_method :db, :databases
 
-    def_delegators :@config, :host, :url, :ssl, :endpoint
+    def_delegators :@config, :host, :url, :ssl, :endpoint, :log
     def_delegators :@config, :account_name, :password
 
     def initialize(options = {})
       @config = Configuration.new
       yield @config if block_given?
-      fail ArgumentError if @config.not_configurable?
+      fail ArgumentError, 'Missing config block' if @config.not_configurable?
 
       @databases = Store::DatabaseStore.new(self)
       @connection = get_connection(options)
@@ -39,13 +39,13 @@ module Filemaker
         .merge(expand_options(options))
         .merge({ action => '' })
 
-      # Serialize the params for submission
-      params = params.stringify_keys
+      # Serialize the params for submission??
+      params.stringify_keys!
 
       log_action(params)
 
       # yield params if block_given?
-      response = @connection.__send__(method, endpoint, params)
+      response = @connection.public_send(method, endpoint, params)
 
       case response.status
       when 200 then [response, params]
@@ -86,6 +86,7 @@ module Filemaker
         when DateTime then args[key] = value.strftime('%m/%d/%Y %H:%M:%S')
         when Time     then args[key] = value.strftime('%H:%M')
         else
+          # Especially for range operator (...), we want to output as String
           args[key] = value.to_s
         end
       end
@@ -161,6 +162,7 @@ module Filemaker
       expanded
     end
 
+    # TODO: Should we convert it to string so 'cURL' will work also?
     def log_action(params)
       case @config.log
       when :simple    then log_simple(params)

data/lib/filemaker/version.rb

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

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

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

data/spec/filemaker/configuration_spec.rb

@@ -0,0 +1,23 @@
+describe 'Configuration' do
+
+  context 'with yaml file' do
+    it 'load settings based on environment' do
+      path = File.expand_path('../../support/filemaker.yml', __FILE__)
+      Filemaker.load!(path, 'development')
+      expect(Filemaker.registry['default']).to be_a Filemaker::Server
+      expect(Filemaker.registry['default'].host).to eq 'host.com'
+      expect(Filemaker.registry['default'].account_name).to eq \
+        'FILEMAKER_ACCOUNT_NAME'
+      expect(Filemaker.registry['default'].ssl).to eq({ 'verify' => false })
+      expect(Filemaker.registry['default'].log).to eq :curl
+    end
+
+    it 'raises ConfigurationError for wrong environment' do
+      path = File.expand_path('../../support/filemaker.yml', __FILE__)
+      expect do
+        Filemaker.load!(path, 'unknown')
+      end.to raise_error Filemaker::Error::ConfigurationError
+    end
+  end
+
+end

data/spec/filemaker/layout_spec.rb

@@ -91,7 +91,6 @@ describe Filemaker::Layout do
       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

data/spec/filemaker/model/criteria_spec.rb

@@ -0,0 +1,304 @@
+describe Filemaker::Model::Criteria do
+
+  let(:criteria) { Filemaker::Model::Criteria.new(MyModel) }
+  let(:cf) { Filemaker::Api::QueryCommands::CompoundFind }
+
+  context 'selectable' do
+    describe 'where' do
+      it 'raises MixedClauseError if mixed with -findquery' do
+        expect do
+          criteria.in(status: %w(pending subscribed)).where(name: 'Bob')
+        end.to raise_error Filemaker::Error::MixedClauseError
+      end
+
+      it 'single hash criterion are recorded as is' do
+        criteria.where(name: 'Bob', email: 'bob@cern.org')
+        expect(criteria.selector).to eq(
+          { 'name' => 'Bob', 'email' => 'bob@cern.org' }
+        )
+      end
+
+      it 'chains where' do
+        criteria.where(name: 'Bob').where(email: 'bob@cern.org')
+        expect(criteria.selector).to eq(
+          { 'name' => 'Bob', 'email' => 'bob@cern.org' }
+        )
+      end
+
+      it 'accepts a block to configure additional options' do
+        criteria.where(name: 'Bob') do |options|
+          options[:script] = 'Remove Duplicates'
+        end
+
+        expect(criteria.options[:script]).to eq 'Remove Duplicates'
+      end
+
+      it 'only accepts fields from model' do
+        criteria.where(name: 'Bob', email: 'bob@cern.org', unit: '< 50')
+        expect(criteria.selector).to eq(
+          { 'name' => 'Bob', 'email' => 'bob@cern.org' }
+        )
+      end
+    end
+
+    describe 'or' do
+      it 'chains `or` as logical OR option' do
+        criteria.where(name: 'Bob').or(email: 'bob@cern.org')
+        expect(criteria.selector).to eq(
+          { 'name' => 'Bob', 'email' => 'bob@cern.org' }
+        )
+        expect(criteria.options[:lop]).to eq 'or'
+      end
+
+      it 'chains multiple `or`, adding more fields' do
+        criteria.where(name: 'Bob').or(email: 'bob@cern.org').or(salary: 5000)
+        expect(criteria.selector).to eq(
+          { 'name' => 'Bob', 'email' => 'bob@cern.org', 'salary' => 5000 }
+        )
+        expect(criteria.options[:lop]).to eq 'or'
+      end
+    end
+
+    context 'comparison operators' do
+      it 'only works on `where` query' do
+        expect do
+          criteria.in(status: %w(pending subscribed)).eq(name: 'Bob')
+        end.to raise_error Filemaker::Error::MixedClauseError
+      end
+
+      describe 'not' do
+        it 'appends neq operator on the field name' do
+          criteria.not(salary: 50)
+          expect(criteria.selector['salary']).to eq 50
+          expect(criteria.selector['salary.op']).to eq 'neq'
+        end
+      end
+
+      describe 'cn' do
+        it 'appends cn operator on the field name' do
+          criteria.cn(name: 'Chong') do |options|
+            options[:script] = 'Remove Duplicates'
+          end
+
+          expect(criteria.selector['name']).to eq 'Chong'
+          expect(criteria.selector['name.op']).to eq 'cn'
+        end
+      end
+
+      describe 'bw' do
+        it 'can do range operation ...' do
+          criteria.bw(salary: '3000...4500')
+          expect(criteria.selector['salary']).to eq '3000...4500'
+        end
+      end
+
+      # TODO: Do more operator tests
+    end
+
+    describe 'in' do
+      it 'raises MixedClauseError if mixed with -find' do
+        expect do
+          criteria.where(name: 'Bob').in(status: %w(pending subscribed))
+        end.to raise_error Filemaker::Error::MixedClauseError
+      end
+
+      it '{a: [1, 2]} to (q0);(q1)' do
+        criteria.in(name: %w(Bob Lee))
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0);(q1)'
+        expect(criteria.selector).to eq [{ 'name' => %w(Bob Lee) }]
+      end
+
+      it '{a: [1, 2], b: [3, 4]} to (q0,q2);(q0,q3);(q1,q2);(q1,q3)' do
+        criteria.in(name: %w(Bob Lee), age: ['20', 30])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq \
+          '(q0,q2);(q0,q3);(q1,q2);(q1,q3)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => %w(Bob Lee), 'passage of time' =>  [20, 30] }]
+      end
+
+      it '{a: [1, 2], b: 3} to (q0,q2);(q1,q2)' do
+        criteria.in(name: %w(Bob Lee), age: '30')
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0,q2);(q1,q2)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => %w(Bob Lee), 'passage of time' => 30 }]
+      end
+
+      it '{a: 1, b: 2} to (q0,q1)' do
+        criteria.in(name: 'Bob', age: 30)
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0,q1)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => 'Bob', 'passage of time' => 30 }]
+      end
+
+      it '{a: 1, b: [2, 3]} to (q0,q1);(q0,q2)' do
+        criteria.in(name: 'Bob', age: [20, 30])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0,q1);(q0,q2)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => 'Bob', 'passage of time' => [20, 30] }]
+      end
+
+      it '[{a: [1, 2]}, {b: [1, 2]}] to (q0);(q1);(q2);(q3)' do
+        criteria.in([{ name: %w(Bob Lee) }, { age: [20, 30] }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0);(q1);(q2);(q3)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => %w(Bob Lee) }, { 'passage of time' => [20, 30] }]
+      end
+
+      it '[{a: 1}, {b: 2}] to (q0);(q1)' do
+        criteria.in([{ name: 'Bob' }, { age: 20 }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0);(q1)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => 'Bob' }, { 'passage of time' => 20 }]
+      end
+
+      it '[{a: 1}, {b: [1, 2]}] to (q0);(q1);(q2)' do
+        criteria.in([{ name: 'Bob' }, { age: [20, 30] }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0);(q1);(q2)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => 'Bob' }, { 'passage of time' => [20, 30] }]
+      end
+
+      it '[{a: 1}, {b: 1, c: 2}] to (q0);(q1,q2)' do
+        criteria.in([{ name: 'Bob' }, { age: 20, email: 'A' }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0);(q1,q2)'
+        expect(criteria.selector).to eq \
+          [{ 'name' => 'Bob' }, { 'passage of time' => 20, 'email' => 'A' }]
+      end
+    end
+
+    describe 'not_in' do
+      it '{a: [1, 2]} to !(q0);!(q1)' do
+        criteria.not_in(name: %w(Bob Lee))
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0);!(q1)'
+      end
+
+      it '{a: [1, 2], b: [3, 4]} to !(q0,q2);!(q0,q3);!(q1,q2);!(q1,q3)' do
+        criteria.not_in(name: %w(Bob Lee), age: ['20', 30])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq \
+          '!(q0,q2);!(q0,q3);!(q1,q2);!(q1,q3)'
+      end
+
+      it '{a: [1, 2], b: 3} to !(q0,q2);!(q1,q2)' do
+        criteria.not_in(name: %w(Bob Lee), age: '30')
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0,q2);!(q1,q2)'
+      end
+
+      it '{a: 1, b: 2} to !(q0,q1)' do
+        criteria.not_in(name: 'Bob', age: 30)
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0,q1)'
+      end
+
+      it '{a: 1, b: [2, 3]} to !(q0,q1);!(q0,q2)' do
+        criteria.not_in(name: 'Bob', age: [20, 30])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0,q1);!(q0,q2)'
+      end
+
+      it '[{a: [1, 2]}, {b: [1, 2]}] to !(q0);!(q1);!(q2);!(q3)' do
+        criteria.not_in([{ name: %w(Bob Lee) }, { age: [20, 30] }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0);!(q1);!(q2);!(q3)'
+      end
+
+      it '[{a: 1}, {b: 2}] to !(q0);!(q1)' do
+        criteria.not_in([{ name: 'Bob' }, { age: 20 }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0);!(q1)'
+      end
+
+      it '[{a: 1}, {b: [1, 2]}] to !(q0);!(q1);!(q2)' do
+        criteria.not_in([{ name: 'Bob' }, { age: [20, 30] }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0);!(q1);!(q2)'
+      end
+
+      it '[{a: 1}, {b: 1, c: 2}] to !(q0);!(q1,q2)' do
+        criteria.not_in([{ name: 'Bob' }, { age: 20, email: 'A' }])
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '!(q0);!(q1,q2)'
+      end
+
+      it 'using in and not_in at the same time' do
+        criteria.in(name: %w(Bob Lee)).not_in(age: 20, email: 'A')
+        compound_find = cf.new(criteria.selector)
+        expect(compound_find.key_maps_string).to eq '(q0);(q1);!(q2,q3)'
+      end
+    end
+  end
+
+  context 'optional' do
+    it 'accepts skip option' do
+      criteria.skip(10)
+      expect(criteria.options[:skip]).to eq 10
+    end
+
+    it 'will override skip if chain repeatedly' do
+      criteria.skip(10).skip(100).skip(1000)
+      expect(criteria.options[:skip]).to eq 1000
+    end
+
+    it 'accepts limit option' do
+      criteria.limit(10)
+      expect(criteria.options[:max]).to eq 10
+    end
+
+    it 'will override limit if chain repeatedly' do
+      criteria.limit(10).limit(100).limit(1000)
+      expect(criteria.options[:max]).to eq 1000
+    end
+
+    it 'accepts order option' do
+      criteria.order('name desc')
+      expect(criteria.options[:sortfield]).to eq ['name']
+      expect(criteria.options[:sortorder]).to eq ['descend']
+    end
+
+    it 'does not entertain invalid fieldname' do
+      criteria.order('zzz desc')
+      expect(criteria.options[:sortfield]).to be_nil
+      expect(criteria.options[:sortorder]).to be_nil
+    end
+
+    it 'will default to asc for missing order' do
+      criteria.order('name, email')
+      expect(criteria.options[:sortorder]).to eq %w(ascend ascend)
+    end
+
+    it 'will use real FileMaker fieldname' do
+      criteria.order('updated_at desc')
+      expect(criteria.options[:sortfield]).to eq ['modifieddate']
+    end
+  end
+
+  context 'pagination' do
+    it 'sets the limit' do
+      expect(criteria.per(50).options[:max]).to eq 50
+    end
+
+    it 'sets the page to skip' do
+      expect(criteria.page(2).per(50).options[:skip]).to eq 50
+    end
+
+    it 'sets the page to skip with larger page' do
+      expect(criteria.page(12).per(50).options[:skip]).to eq 550
+    end
+
+    it 'will not populate skip option if there is no page' do
+      expect(criteria.per(50).options[:skip]).to be_nil
+    end
+  end
+
+end