filemaker 0.0.18 → 0.0.19

data/lib/filemaker/model/optional.rb

@@ -42,7 +42,7 @@ module Filemaker
 
         sort_spec.each do |spec|
           fieldname, direction = spec.split(' ')
-          direction = 'asc' unless direction
+          direction ||= 'asc'
 
           field = klass.find_field_by_name(fieldname)
 

data/lib/filemaker/model/pagination.rb

@@ -5,7 +5,7 @@ module Filemaker
       def page(value)
         value = 1 if value.nil?
         chains << :page
-        @_page = value.to_i
+        @_page = positive_page(value.to_i)
         update_skip
       end
 
@@ -37,6 +37,11 @@ module Filemaker
         skip(skip) unless skip.zero?
         self
       end
+
+      def positive_page(page)
+        return 1 if page.nil? || !page.is_a?(Integer)
+        page.positive? ? page : 1
+      end
     end
   end
 end

data/lib/filemaker/model/persistable.rb

@@ -10,7 +10,7 @@ module Filemaker
       # Call save! but do not raise error.
       def save
         save!
-      rescue
+      rescue StandardError
         errors.add(:base) << $! # Does this works?
         nil
       end

data/lib/filemaker/model/relations/proxy.rb

@@ -26,8 +26,11 @@ module Filemaker
           @class_name.constantize
         end
 
+        # Rubocop will complain and ask to fallback on `super`, but we won't be
+        # able to do that because the target may have method that throw
+        # exception
         def method_missing(name, *args, &block)
-          target.send(name, *args, &block) || super
+          target.send(name, *args, &block)
         end
 
         def respond_to_missing?(method_name, include_private = false)

data/lib/filemaker/model/selectable.rb

@@ -56,7 +56,7 @@ module Filemaker
         first
       end
 
-      %w(eq cn bw ew gt gte lt lte neq).each do |operator|
+      %w[eq cn bw ew gt gte lt lte neq].each do |operator|
         define_method(operator) do |criterion, &block|
           if chains.include?(:in)
             raise Filemaker::Errors::MixedClauseError,
@@ -82,7 +82,7 @@ module Filemaker
 
           # Inside define_method, we cannot have yield or block_given?, so we
           # just use &block
-          block.call(options) if block
+          block&.call(options)
           self
         end
       end

data/lib/filemaker/model/types/attachment.rb

@@ -0,0 +1,102 @@
+require 'net/http'
+require 'mimemagic'
+
+module Filemaker
+  module Model
+    module Types
+      class Attachment
+        attr_reader :_body, :content_type, :extension, :klass
+
+        def initialize(value, klass)
+          @value = value
+          @klass = klass
+        end
+
+        def url
+          @value.to_s
+        end
+
+        def file_extension
+          # We need to use .path to eliminate query string
+          File.extname(URI.parse(url).path)
+        end
+
+        def filename
+          return if url.blank?
+          File.basename(URI.parse(url).path)
+        end
+
+        def body
+          return @_body if defined?(@_body)
+
+          valid_files = %w[
+            .pdf
+            .jpeg .jpg .png .gif .tif .tiff
+            .doc .docx .xls .xlsx .ppt .pptx .pptm
+            .txt
+            .rar .zip .webarchive
+            .htm .html
+            .java
+          ]
+
+          @_body = download_protected_file
+
+          if !file_extension.blank? &&
+             valid_files.include?(file_extension.try(:downcase))
+
+            @content_type = MimeMagic.by_extension(file_extension).try(:type)
+            @extension = file_extension
+          else
+            mime_type = MimeMagic.by_magic(@_body)
+
+            unless mime_type.blank?
+              case mime_type.type.downcase
+              when 'application/msword'
+                @content_type = 'application/msword'
+                @extension = '.doc'
+              when 'application/pdf'
+                @content_type = 'application/pdf'
+                @extension = '.pdf'
+              when 'application/x-ole-storage'
+                @content_type = 'application/vnd.ms-excel'
+                @extension = '.xls'
+              when 'application/vnd.ms-excel'
+                @content_type = 'application/vnd.ms-excel'
+                @extension = '.xls'
+              when 'image/jpeg'
+                @content_type = 'image/jpeg'
+                @extension = '.jpg'
+              when 'image/png'
+                @content_type = 'image/png'
+                @extension = '.png'
+              when 'application/vnd.oasis.opendocument.text'
+                @content_type = 'application/vnd.oasis.opendocument.text'
+                @extension = '.odt'
+              else
+                # No choice, we have to assign it somehow
+                @content_type = mime_type.type
+                @extension = MIME::Types[@content_type].first
+                                                       .try(:extensions)
+                                                       .try(:first)
+                @extension = ".#{@extension}" if @extension
+              end
+            end
+          end
+
+          @_body
+        end
+
+        private
+
+        def download_protected_file
+          req = Net::HTTP::Get.new(url)
+          req.basic_auth(klass.server.account_name, klass.server.password)
+          res = Net::HTTP.new(klass.server.host, 80)
+          res = res.start { |http| http.request(req) }
+
+          res.body
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/model/types/email.rb

@@ -0,0 +1,41 @@
+module Filemaker
+  module Model
+    module Types
+      class Email
+        def initialize(value)
+          # to_s incoming value, this can prevent similar type from
+          # nesting deeply
+          @value = value.nil? ? nil : value.to_s
+        end
+
+        def value
+          email = @value&.strip&.split(%r{,|\(|\/|\s})
+                  &.reject(&:empty?)&.first&.downcase
+                  &.gsub(/[\uFF20\uFE6B\u0040]/, '@')
+
+          email&.include?('@') ? email : nil
+        end
+
+        def value=(v)
+          self.value = v
+        end
+
+        def to_s
+          value
+        end
+
+        def ==(other)
+          to_s == other.to_s
+        end
+        alias eql? ==
+
+        # In FileMaker, at-sign is for wildcard query. In order to search for
+        # email, we need to escape at-sign. Note the single-quote escaping!
+        # e.g. 'a@host.com' will become 'a\\@host.com'
+        def to_query
+          value.gsub('@', '\@')
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/record.rb

@@ -51,10 +51,13 @@ module Filemaker
     end
 
     def []=(key, value)
-      return super unless @ready
-      raise(Filemaker::Errors::InvalidFieldError, "Invalid field: #{key}") \
+      if @ready
+        raise(Filemaker::Errors::InvalidFieldError, "Invalid field: #{key}") \
         unless key?(key)
-      @dirty[key] = value
+        @dirty[key] = value
+      else
+        super
+      end
     end
 
     private
@@ -87,7 +90,7 @@ module Filemaker
       super
     end
 
-    def respond_to_missing?
+    def respond_to_missing?(method_name, include_private = false)
       super
     end
   end

data/lib/filemaker/server.rb

@@ -48,11 +48,23 @@ module Filemaker
       response = @connection.public_send(method, endpoint, params)
 
       case response.status
-      when 200 then [response, params]
-      when 401 then raise Errors::AuthenticationError, 'Auth failed.'
-      when 0   then raise Errors::CommunicationError, 'Empty response.'
-      when 404 then raise Errors::CommunicationError, 'HTTP 404 Not Found'
-      when 302 then raise Errors::CommunicationError, 'Redirect not supported'
+      when 200
+        [response, params]
+      when 401
+        raise Errors::AuthenticationError,
+              "[#{response.status}] Authentication failed."
+      when 0
+        raise Errors::CommunicationError,
+              "[#{response.status}] Empty response."
+      when 404
+        raise Errors::CommunicationError,
+              "[#{response.status}] Not found"
+      when 302
+        raise Errors::CommunicationError,
+              "[#{response.status}] Redirect not supported"
+      when 502
+        raise Errors::CommunicationError,
+              "[#{response.status}] Bad gateway. Too many records."
       else
         msg = "Unknown response status = #{response.status}"
         raise Errors::CommunicationError, msg
@@ -70,21 +82,29 @@ module Filemaker
 
       Faraday.new(@config.url, faraday_options) do |faraday|
         faraday.request :url_encoded
-        faraday.adapter :typhoeus
         faraday.headers[:user_agent] = \
           "filemaker-ruby-#{Filemaker::VERSION}".freeze
         faraday.basic_auth @config.account_name, @config.password
+
+        # The order of the middleware is important, so adapter must be the last
+        faraday.adapter :typhoeus
       end
     end
 
+    # {"-db"=>"mydb", "-lay"=>"mylay", "email"=>"a@b.com", "updated_at": Date}
     def serialize_args(args)
       return {} if args.nil?
 
       args.each do |key, value|
         case value
-        when DateTime then args[key] = value.strftime('%m/%d/%Y %H:%M:%S')
-        when Date     then args[key] = value.strftime('%m/%d/%Y')
-        when Time     then args[key] = value.strftime('%H:%M')
+        when DateTime
+          args[key] = value.strftime('%m/%d/%Y %H:%M:%S')
+        when Date
+          args[key] = value.strftime('%m/%d/%Y')
+        when Time
+          args[key] = value.strftime('%H:%M')
+        when Filemaker::Model::Types::Email
+          args[key] = value.to_query
         else
           # Especially for range operator (...), we want to output as String
           args[key] = value.to_s
@@ -164,10 +184,10 @@ module Filemaker
 
     # 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)
-      when :curl      then log_curl(params)
-      when :curl_auth then log_curl(params, true)
+      case @config.log.to_s
+      when 'simple'    then log_simple(params)
+      when 'curl'      then log_curl(params)
+      when 'curl_auth' then log_curl(params, true)
       end
     end
 

data/lib/filemaker/version.rb

@@ -1,3 +1,3 @@
 module Filemaker
-  VERSION = '0.0.18'.freeze
+  VERSION = '0.0.19'.freeze
 end

data/lib/generators/filemaker/model/model_generator.rb

@@ -26,7 +26,8 @@ module Filemaker
           'number' => 'number',
           'date' => 'date',
           'time' => 'datetime',
-          'timestamp' => 'datetime'
+          'timestamp' => 'datetime',
+          'container' => 'string'
         }
 
         template(

data/spec/filemaker/configuration_spec.rb

@@ -8,7 +8,7 @@ describe 'Configuration' do
       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
+      expect(Filemaker.registry['default'].log).to eq 'curl'
     end
 
     it 'raises ConfigurationError for wrong environment' do

data/spec/filemaker/layout_spec.rb

@@ -46,7 +46,7 @@ describe Filemaker::Layout do
       it 'allows -max, -skip' do
         resultset = @layout.findall(
           max: 5, skip: 10,
-          sortfield: %w(f1 f2), sortorder: ['descend']
+          sortfield: %w[f1 f2], sortorder: ['descend']
         )
 
         expect(resultset.params['-max']).to eq 5
@@ -60,8 +60,8 @@ describe Filemaker::Layout do
       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)
+            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::Errors::ParameterError
       end
@@ -69,8 +69,8 @@ describe Filemaker::Layout do
       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)
+            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::Errors::ParameterError
       end
@@ -174,7 +174,7 @@ describe Filemaker::Layout do
 
     describe 'query' do
       it 'transform {a: [1,2]} to (q0);(q1)' do
-        resultset = @layout.query(status: %w(open closed))
+        resultset = @layout.query(status: %w[open closed])
         expect(resultset.params['-query']).to eq '(q0);(q1)'
       end
 
@@ -205,7 +205,7 @@ describe Filemaker::Layout do
       end
 
       it 'can do -script.prefind.param' do
-        resultset = @layout.find(1, script_prefind: %w(Unique yes))
+        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
@@ -216,7 +216,7 @@ describe Filemaker::Layout do
       end
 
       it 'can do -script.presort.param' do
-        resultset = @layout.find(1, script_presort: %w(Order ascend))
+        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

data/spec/filemaker/metadata/field_spec.rb

@@ -1,9 +1,10 @@
 describe Filemaker::Metadata::Field do
   let(:server) do
     Filemaker::Server.new do |config|
-      config.host         = 'https://host'
+      config.host         = 'host'
       config.account_name = 'account_name'
       config.password     = 'password'
+      config.ssl          = { verify: false }
     end
   end
   let(:xml) { import_xml_as_string('portal.xml') }
@@ -69,5 +70,12 @@ describe Filemaker::Metadata::Field do
       expect(field.coerce('/fmi/xml/cnt/1234jpg').to_s).to eq \
         'https://host/fmi/xml/cnt/1234jpg'
     end
+
+    it 'converts container with existing http' do
+      allow(field).to receive(:data_type).and_return 'container'
+      expect(field.coerce('http://host/fmi/xml/cnt/1234jpg')).to be_a URI
+      expect(field.coerce('http://host/fmi/xml/cnt/1234jpg').to_s).to eq \
+        'http://host/fmi/xml/cnt/1234jpg'
+    end
   end
 end

data/spec/filemaker/model/criteria_spec.rb

@@ -6,7 +6,7 @@ describe Filemaker::Model::Criteria do
     describe 'where' do
       it 'raises MixedClauseError if mixed with -findquery' do
         expect do
-          criteria.in(status: %w(pending subscribed)).where(name: 'Bob')
+          criteria.in(status: %w[pending subscribed]).where(name: 'Bob')
         end.to raise_error Filemaker::Errors::MixedClauseError
       end
 
@@ -85,7 +85,7 @@ describe Filemaker::Model::Criteria do
     context 'comparison operators' do
       it 'only works on `where` query' do
         expect do
-          criteria.in(status: %w(pending subscribed)).eq(name: 'Bob')
+          criteria.in(status: %w[pending subscribed]).eq(name: 'Bob')
         end.to raise_error Filemaker::Errors::MixedClauseError
       end
 
@@ -121,32 +121,32 @@ describe Filemaker::Model::Criteria do
     describe 'in' do
       it 'raises MixedClauseError if mixed with -find' do
         expect do
-          criteria.where(name: 'Bob').in(status: %w(pending subscribed))
+          criteria.where(name: 'Bob').in(status: %w[pending subscribed])
         end.to raise_error Filemaker::Errors::MixedClauseError
       end
 
       it '{a: [1, 2]} to (q0);(q1)' do
-        criteria.in(name: %w(Bob Lee))
+        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) }]
+        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])
+        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] }]
+          [{ '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')
+        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 }]
+          [{ 'name' => %w[Bob Lee], 'passage of time' => 30 }]
       end
 
       it '{a: 1, b: 2} to (q0,q1)' do
@@ -166,11 +166,11 @@ describe Filemaker::Model::Criteria do
       end
 
       it '[{a: [1, 2]}, {b: [1, 2]}] to (q0);(q1);(q2);(q3)' do
-        criteria.in([{ name: %w(Bob Lee) }, { age: [20, 30] }])
+        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] }]
+          [{ 'name' => %w[Bob Lee] }, { 'passage of time' => [20, 30] }]
       end
 
       it '[{a: 1}, {b: 2}] to (q0);(q1)' do
@@ -200,20 +200,20 @@ describe Filemaker::Model::Criteria do
 
     describe 'not_in' do
       it '{a: [1, 2]} to !(q0);!(q1)' do
-        criteria.not_in(name: %w(Bob Lee))
+        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])
+        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')
+        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
@@ -231,7 +231,7 @@ describe Filemaker::Model::Criteria do
       end
 
       it '[{a: [1, 2]}, {b: [1, 2]}] to !(q0);!(q1);!(q2);!(q3)' do
-        criteria.not_in([{ name: %w(Bob Lee) }, { age: [20, 30] }])
+        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
@@ -255,7 +255,7 @@ describe Filemaker::Model::Criteria do
       end
 
       it 'using in and not_in at the same time' do
-        criteria.in(name: %w(Bob Lee)).not_in(age: 20, email: 'A')
+        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
@@ -297,7 +297,7 @@ describe Filemaker::Model::Criteria do
 
     it 'will default to asc for missing order' do
       criteria.order('name, email')
-      expect(criteria.options[:sortorder]).to eq %w(ascend ascend)
+      expect(criteria.options[:sortorder]).to eq %w[ascend ascend]
     end
 
     it 'will use real FileMaker fieldname' do