rfm 0.1.0 → 0.2.0

data/README

@@ -1,13 +1,16 @@
 This documentation is hastily thrown together and probably contains lots of errors. Needless to say, this will need to be documented better soon :)
 
-Code Samples
-============
+Installation
+------------
 
-To access the API you need to require the right pieces. The easiest way to do this is to:
+rfm is availabl as a gem from rubyforge.org, so you can get it like this:
 
-  require 'rfm/rfm'
+  gem install rfm
+
+Once the gem is installed, you can use rfm in your ruby scripts by requiring it:
 
-near the top of your script. This will cause everhting in the API to be loaded.
+  require 'rubygems'
+  require 'rfm'
 
 Connecting
 ----------
@@ -106,7 +109,7 @@ All of these methods return an Rfm::Result::ResultSet object (see below), and ev
 
 For a complete list of the available options, see the "expand_options" method in the Rfm::Server object in the file named rfm_command.rb.
 
-Finally, if filemaker returns an error when executing any of these methods, an error will be raised in your ruby script. There is one exception to this, though. If a find results in no records being found (FileMaker error # 401) I just ignore it and return you a ResultSet with zero records in it. This is open for debate...
+Finally, if filemaker returns an error when executing any of these methods, an error will be raised in your ruby script. There is one exception to this, though. If a find results in no records being found (FileMaker error # 401) I just ignore it and return you a ResultSet with zero records in it. If you prefer an error in this case, add :raise_on_401 => true to the options you pass the Rfm::Server when you create it.
 
 
 ResultSet and Record Objects
@@ -195,11 +198,20 @@ FileMaker's field types are coerced to Ruby types thusly:
   Date Field -> Date object
   Time Field -> DateTime object # see below
   TimeStamp Field -> DateTime object
+  Container Field -> URI object
 
 FileMaker's number field is insanely robust. The only data type in ruby that can handle the same magnitude and precision of a FileMaker number is Ruby's BigDecimal. (This is an extension class, so you have to require 'bigdecimal' to use it yourself). Unfortuantely, BigDecimal is not a "normal" ruby numeric class, so it might be really annoying that your tiny filemaker numbers have to go this route. This is a great topic for debate.
 
 Also, Ruby doesn't have a Time type that stores just a normal time (with no date attached). The Time class in ruby is a lot like DateTime, or a Timestamp in FileMaker. When I get a Time field from FileMaker, I turn it into a DateTime object, and set its date to the oldest date Ruby supports. You can still compare these in all the normal ways, so this should be fine, but it will look weird if you, ie, to_s one and see an odd date attached to your time.
 
+Finally, container fields will come back as URI objects. You can:
+
+  - use Net::HTTP to download the contents of the container field using this URI
+  - to_s the URI and use it as the src attribute of an HTML image tag
+  - etc...
+
+Specifically, the URI refers to the _contents_ of the container field. When accessed, the file, picture, or movie in the field will be downloaded.
+
 Troubleshooting
 ---------------
 
@@ -221,4 +233,4 @@ So, for an annoying, but detailed load of output, make a connection like this:
     :log_responses => true
   )
 
-These options will change in the future. They're only there now as a quick-easy way for me to track down problems. I'm open to suggestions for what kind of loggin options will make sense in the final release.
+These options will change in the future. They're only there now as a quick-easy way for me to track down problems. I'm open to suggestions for what kind of loggin options will make sense in the final release.

data/lib/rfm_command.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'rexml/document'
+require 'cgi'
 
 module Rfm
 
@@ -11,9 +12,11 @@ module Rfm
         :port => 80,
         :username => '',
         :password => '',
-        :log_actions => false
-      }.merge(options)
-        
+        :log_actions => false,
+        :log_responses => false,
+        :raise_on_401 => false
+      }.merge(options).freeze
+      
       @host_name = @state[:host]
       @port = @state[:port]
       @username = @state[:username]
@@ -26,13 +29,13 @@ module Rfm
       self.db[dbname]
     end
 
-    attr_reader :db
+    attr_reader :db, :host_name, :port, :state
 
     def do_action(action, args, options = {})
       post = args.merge(expand_options(options)).merge({action => ''})
       
       if @state[:log_actions] == true
-        qs = post.collect{|key,val| "#{key}=#{val}"}.join("&")
+        qs = post.collect{|key,val| "#{CGI::escape(key.to_s)}=#{CGI::escape(val.to_s)}"}.join("&")
         warn "http://#{@host_name}:#{@port}/fmi/xml/fmresultset.xml?#{qs}"
       end
       
@@ -44,7 +47,10 @@ module Rfm
       }
       
       if @state[:log_responses] == true
-        puts result
+        result.to_hash.each {|key, value|
+          warn "#{key}: #{value}"
+        }
+        warn result.body
       end
       
       result
@@ -71,7 +77,7 @@ module Rfm
             else
               result['-script'] = value
             end
-          when :pre_find_scripts:
+          when :pre_find_script:
             if value.class == Array
               result['-script.prefind'] = value[0]
               result['-script.prefind.param'] = value[1]
@@ -89,6 +95,8 @@ module Rfm
             result['-lay.response'] = value
           when :logical_operator:
             result['-lop'] = value
+          when :modification_id:
+            result['-modid'] = value
           else
             raise "Invalid option: #{key} (are you using a string instead of a symbol?)"
         end
@@ -151,7 +159,7 @@ module Rfm
     
     def get_records(action, extra_params = {}, options = {})
       Rfm::Result::ResultSet.new(
-        @db.server.do_action(action, params().merge(extra_params), options).body,
+        @db.server, @db.server.do_action(action, params().merge(extra_params), options).body,
         self)
     end
     

data/lib/rfm_factory.rb

@@ -12,11 +12,11 @@ module Rfm::Factory
     
     def all
       if !@loaded
-        Rfm::Result::ResultSet.new(@server.do_action('-dbnames', {}).body).each {|record|
+        Rfm::Result::ResultSet.new(@server, @server.do_action('-dbnames', {}).body).each {|record|
           name = record['DATABASE_NAME']
           self[name] = Rfm::Database.new(name, @server) if self[name] == nil
         }
-        @loaded = false
+        @loaded = true
       end
       self.values
     end
@@ -37,7 +37,7 @@ module Rfm::Factory
     
     def all
       if !@loaded
-        Rfm::Result::ResultSet.new(@server.do_action('-layoutnames', {"-db" => @database.name}).body).each {|record|
+        Rfm::Result::ResultSet.new(@server, @server.do_action('-layoutnames', {"-db" => @database.name}).body).each {|record|
           name = record['LAYOUT_NAME']
           self[name] = Rfm::Layout.new(name, @database) if self[name] == nil
         }
@@ -62,7 +62,7 @@ module Rfm::Factory
     
     def all
       if !@loaded
-        Rfm::Result::ResultSet.new(@server.do_action('-scriptnames', {"-db" => @database.name}).body).each {|record|
+        Rfm::Result::ResultSet.new(@server, @server.do_action('-scriptnames', {"-db" => @database.name}).body).each {|record|
           name = record['SCRIPT_NAME']
           self[name] = Rfm::Script.new(name, @database) if self[name] == nil
         }

data/lib/rfm_result.rb

@@ -1,25 +1,36 @@
 require 'bigdecimal'
+require 'date'
 
 module Rfm::Result
   
   class ResultSet < Array
-    def initialize(fmresultset, layout = nil)
+    def initialize(server, fmresultset, layout = nil)
+      @server = server
       @resultset = nil
       @layout = layout
       @fields = {}
       @portals = {}
+      @date_format = nil
+      @time_format = nil
+      @timestamp_format = nil
       
       doc = REXML::Document.new(fmresultset)
       root = doc.root
       
       # check for errors
       error = root.elements['error'].attributes['code'].to_i
-      raise "Error #{error} occurred while processing the request" if error != 0 && error != 401
+      raise "Error #{error} occurred while processing the request" if error != 0 && (error != 401 || @server.state[:raise_on_401])
+      
+      # ascertain date and time formats
+      datasource = root.elements['datasource']
+      @date_format = convertFormatString(datasource.attributes['date-format'])
+      @time_format = convertFormatString(datasource.attributes['time-format'])
+      @timestamp_format = convertFormatString(datasource.attributes['timestamp-format'])
       
       # process field metadata
       root.elements['metadata'].each_element('field-definition') { |field|
         name = field.attributes['name']
-        @fields[name] = Field.new(field)
+        @fields[name] = Field.new(self, field)
       }
       @fields.freeze
       
@@ -29,7 +40,7 @@ module Rfm::Result
         fields = {}
         relatedset.each_element('field-definition') { |field|
           name = field.attributes['name'].sub(Regexp.new(table + '::'), '')
-          fields[name] = Field.new(field)
+          fields[name] = Field.new(self, field)
         }
         @portals[table] = fields
       }
@@ -41,7 +52,13 @@ module Rfm::Result
       }
     end  
         
-    attr_reader :fields, :portals
+    attr_reader :server, :fields, :portals, :date_format, :time_format, :timestamp_format
+    
+    private
+    
+    def convertFormatString(fm_format)
+      fm_format.gsub('MM', '%m').gsub('dd', '%d').gsub('yyyy', '%Y').gsub('HH', '%H').gsub('mm', '%M').gsub('ss', '%S')
+    end
     
   end
   
@@ -90,7 +107,7 @@ module Rfm::Result
     end
 
     def save_if_not_modified
-      self.merge(@layout.edit(@record_id, @mods, {'-modid' => @mod_id})[0]) if @mods.size > 0
+      self.merge(@layout.edit(@record_id, @mods, {:modification_id => @mod_id})[0]) if @mods.size > 0
       @mods.clear
     end
     
@@ -123,7 +140,8 @@ module Rfm::Result
   end
   
   class Field
-    def initialize(field)
+    def initialize(result_set, field)
+      @result_set = result_set
       @name = field.attributes['name']
       @result = field.attributes['result']
       @type = field.attributes['type']
@@ -141,14 +159,13 @@ module Rfm::Result
       when "number"
         return BigDecimal.new(value)
       when "date"
-        (day, month, year) = /(\d\d)\/(\d\d)\/(\d+)/.match(value)
-        return Date.new(year.to_i, month.to_i, day.to_i)
+        return Date.strptime(value, @result_set.date_format)
       when "time"
-        (hour, min, sec) = /(\d+):(\d+):(\d+)/.match(value)
-        return DateTime.civil(-4712, 1, 1, hour.to_i, min.to_i, sec.to_i)
+        return DateTime.strptime("1/1/-4712 " + value, "%m/%d/%Y #{@result_set.time_format}")
       when "timestamp"
-        (month, day, year, hour, min, sec) = /(\d+)\/(\d+)\/(\d+)\s+(\d+):(\d+):(\d+)/.match(value)
-        return DateTime.civil(year.to_i, month.to_i, day.to_i, hour.to_i, min.to_i, sec.to_i)
+        return DateTime.strptime(value, @result_set.timestamp_format)
+      when "container"
+        return URI.parse("http://#{@result_set.server.host_name}:#{@result_set.server.port}#{value}")
       end
     end
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rfm
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-09-28 00:00:00 -07:00
+  version: 0.2.0
+date: 2007-06-23 00:00:00 -07:00
 summary: A package to access FileMaker Pro databases
 require_paths: 
 - lib