rfm 0.1.0

data/README

@@ -0,0 +1,224 @@
+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
+============
+
+To access the API you need to require the right pieces. The easiest way to do this is to:
+
+  require 'rfm/rfm'
+
+near the top of your script. This will cause everhting in the API to be loaded.
+
+Connecting
+----------
+
+You connect with the Rfm::Server object. This little buddy will be your window into FileMaker data.
+
+  require 'rfm/rfm'
+
+  my_server = Rfm::Server.new(
+    :host => 'myservername',
+    :username => 'user',
+    :password => 'pw'
+  )
+
+if your web publishing engine runs on a port other than 80, you can provide the port number as well:
+
+  my_server = Rfm::Server.new(
+    :host => 'myservername',
+    :username => 'user',
+    :password => 'pw',
+    :port => 8080  
+  )
+
+Databases and Layouts
+---------------------
+
+All access to data in FileMaker's XML interface is done through layouts, and layouts live in databases. The Rfm::Server object has a collection of databases called 'db'. So to get ahold of a database called "My Database", you can do this:
+
+  my_db = my_server.db["My Database"]
+
+As a convenience, you can do this too:
+
+  my_db = my_server["My Database"]
+
+Finally, if you want to introspect the server and find out what databases are available, you can do this:
+
+  all_dbs = my_server.db.all
+
+In any case, you get back Rfm::Database objects. A database object in turn has a property called "layout":
+
+  my_layout = my_db.layout["My Layout"]
+
+Again, for convenience:
+
+  my_layout = my_db["My Layout"]
+
+And to get them all:
+
+  all_layouts = my_db.layout.all
+
+Bringing it all together, you can do this to go straight from a server to a specific layout:
+
+  my_layout = my_server["My Database"]["My Layout"]
+
+NOTE: for the ruby experts, Rfm::Server#db is an Rfm::Factory::DatabaseFactory object, which is just a fancied up Hash. So anything you can do with a hash, you can also do with my_server.db. The same goes for my_db.layouts, which is an Rfm::Factory::LayoutFactory.
+
+
+Working with Layouts
+--------------------
+
+Once you have a layout object, you can start doing some real work. To get every record from the layout:
+
+  my_layout.all   # be careful with this
+
+To get a random record:
+
+  my_layout.any
+
+To find every record with "Arizona" in the "State" field:
+
+  my_layout.find({"State" => "Arizona"})
+
+To add a new record with my personal info:
+
+  my_layout.create({
+    :first_name => "Geoff",
+    :last_name => "Coffey",
+    :email => "gwcoffey@gmail.com"}
+  )
+
+Notice that in this case I used symbols instead of strings for the hash keys. The API will accept either form, so if your field names don't have whitespace or punctuation, you might prefer the symbol notation.
+
+To edit the record whos recid (filemaker internal record id) is 200:
+
+  my_layout.edit(200, {:first_name => 'Mamie'})
+
+Note: See the "Record Objects" section below for more on editing records.
+
+To delete the record whose recid is 200:
+
+  my_layout.delete(200)
+
+All of these methods return an Rfm::Result::ResultSet object (see below), and every one of them takes an optional parameter (the very last one) with additional options. For example, to find just a page full of records, you can do this:
+
+  my_layout.find({:state => "AZ"}, {:max_records => 10, :skip_records => 100})
+
+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...
+
+
+ResultSet and Record Objects
+----------------------------
+
+Any method on the Layout object that returns data will return a ResultSet object. Rfm::Result::ResultSet is a subclass of Array, so first and foremost, you can use it like any other array:
+
+  my_result = my_layout.any
+  my_result.size  # returns '1'
+  my_result[0]    # returns the first record (an Rfm::Result::Record object)
+
+The ResultSet object also tells you information about the fields and portals in the result. ResultSet#fields and ResultSet#portals are both standard ruby hashes, with strings for keys. The fields hash has Rfm::Result::Field objects for values. The portals hash has another hash for its values. This nested hash is the fields on the portal. This would print out all the field names:
+
+  my_result.fields.each { |name, field| puts name }
+
+This would print out the tables each portal on the layout is associated with. Below each table name, and indented, it will print the names of all the fields on each portal.
+
+  my_result.portals.each { |table, fields|
+    puts "table: #{table}"
+    fields.each { |name, field| puts "\t#{name}"}
+  }
+
+But most importantly, the ResultSet contains record objects. Rfm::Result::Record is a subclass of Hash, so it can be used in many standard ways. This code would print the value in the 'first_name' field in the first record of the ResultSet:
+
+  my_record = my_result[0]
+  puts my_record["first_name"]
+
+As a convenience, if your field names are valid ruby method names (ie, they don't have spaces or odd punctuation in them), you can do this instead:
+
+  puts my_record.first_name
+
+Since ResultSets are arrays and Records are hashes, you can take advantage of Ruby's wonderful expressiveness. For example, to get a comma-separated list of the full names of all the people in California, you could do this:
+
+  my_layout.find({:state => 'CA'}).collect {|rec| "#{rec.first_name} #{rec.last_name}"}.join(", ")
+
+Record objects can also be edited:
+
+  my_record.first_name = 'Isabel'
+
+Once you have made a series of edits, you can save them back to the database like this:
+
+  my_record.save
+
+The save operation causes the record to be reloaded from the database, so any changes that have been made outside your script will also be picked up after the save.
+
+If you want to detect concurrent modification, you can do this instead:
+
+  my_record.save_if_not_modified
+
+This version will refuse to update the database and raise an error if the record was modified after it was loaded but before it was saved.
+
+Record objects also have portals. While the portals in a ResultSet tell you about the tables and fields the portals show, the portals in a Record have the actual data. For example, if an Order record has Line Item records, you could do this:
+
+  my_order = order_layout.any[0]  # the [0] is important!
+  my_lines = my_order.portals["Line Items"]
+
+At the end of the previous block of code, my_lines is an array of Record objects. In this case, they are the records in the "Line Items" portal for the particular order record. You can then operate on them as you would any other record. 
+
+NOTE: Fields on a portal have the table name and the "::" stripped off of their names if they belong to the table the portal is tied to. In other words, if our "Line Items" portal includes a quantity field and a price field, you would do this:
+
+  my_lines[0]["Quantity"]
+  my_lines[0]["Price"]
+
+You would NOT do this:
+
+  my_lines[0]["Line Items::Quantity"]
+  my_lines[0]["Line Items::Quantity"]
+
+My feeling is that the table name is redundant and cumbersome if it is the same as the portal's table. This is also up for debate.
+
+Again, you can string things together with Ruby. This will calculate the total dollar amount of the order:
+ 
+  total = 0.0
+  my_order.portals["Line Items"].each {|line| total += line.quantity * line.price}
+
+I intend to add a 'delete' method to the Record class as well, but I haven't done this yet. Finally, should you be able to create new records using the Record class? I'm not sure...lots of points to consider on this.
+
+
+Data Types
+----------
+
+FileMaker's field types are coerced to Ruby types thusly:
+
+  Text Field -> String object
+  Number Field -> BigDecimal object  # see below
+  Date Field -> Date object
+  Time Field -> DateTime object # see below
+  TimeStamp Field -> DateTime 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.
+
+Troubleshooting
+---------------
+
+There are two cheesy methods to help track down problems. When you create a server object, you can provide two additional optional parameters:
+
+:log_actions
+When this is 'true' your script will write every URL it sends to the web publishing engine to standard out. For the rails users, this means the action url will wind up in your WEBrick or Mongrel log. If you can't make sense of what you're getting, you might try copying the URL into your browser to see what is actually coming back from FileMaker.
+
+:log_responses
+When this is 'true' your script will dump the actual response it got from FileMaker to standard out (again, in rails, check your logs).
+
+So, for an annoying, but detailed load of output, make a connection like this:
+
+  my_server = Rfm::Server.new(
+    :host => 'myservername',
+    :username => 'user',
+    :password => 'pw',
+    :log_actions => true,
+    :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.

data/lib/rfm.rb

@@ -0,0 +1,5 @@
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'rfm_command'
+require 'rfm_result'
+require 'rfm_factory'

data/lib/rfm_command.rb

@@ -0,0 +1,173 @@
+require 'net/http'
+require 'rexml/document'
+
+module Rfm
+
+  class Server
+    
+    def initialize(options)
+      @state = {
+        :host => 'localhost',
+        :port => 80,
+        :username => '',
+        :password => '',
+        :log_actions => false
+      }.merge(options)
+        
+      @host_name = @state[:host]
+      @port = @state[:port]
+      @username = @state[:username]
+      @password = @state[:password]
+      
+      @db = Rfm::Factory::DbFactory.new(self)
+    end
+         
+    def [](dbname)
+      self.db[dbname]
+    end
+
+    attr_reader :db
+
+    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("&")
+        warn "http://#{@host_name}:#{@port}/fmi/xml/fmresultset.xml?#{qs}"
+      end
+      
+      request = Net::HTTP::Post.new("/fmi/xml/fmresultset.xml")
+      request.basic_auth(@username, @password)
+      request.set_form_data(post)
+      result = Net::HTTP.start(@host_name, @port) { |http|
+        http.request(request)
+      }
+      
+      if @state[:log_responses] == true
+        puts result
+      end
+      
+      result
+    end
+    
+    private
+    
+    def expand_options(options)
+      result = {}
+      options.each {|key,value|
+        case key
+          when :max_records:
+            result['-max'] = value
+          when :skip_records:
+            result['-skip'] = value
+          when :sort_field:
+            result['-sortfield'] = value
+          when :sort_order:
+            result['-sortorder'] = value
+          when :post_script:
+            if value.class == Array
+              result['-script'] = value[0]
+              result['-script.param'] = value[1]
+            else
+              result['-script'] = value
+            end
+          when :pre_find_scripts:
+            if value.class == Array
+              result['-script.prefind'] = value[0]
+              result['-script.prefind.param'] = value[1]
+            else
+              result['-script.presort'] = value
+            end
+          when :pre_sort_script:
+            if value.class == Array
+              result['-script.presort'] = value[0]
+              result['-script.presort.param'] = value[1]
+            else
+              result['-script.presort'] = value
+            end
+          when :response_layout:
+            result['-lay.response'] = value
+          when :logical_operator:
+            result['-lop'] = value
+          else
+            raise "Invalid option: #{key} (are you using a string instead of a symbol?)"
+        end
+      }
+      result
+    end
+    
+  end
+  
+  class Database
+    def initialize(name, server)
+      @name = name
+      @server = server
+      @layout = Rfm::Factory::LayoutFactory.new(server, self)
+      @script = Rfm::Factory::ScriptFactory.new(server, self)
+    end
+    
+    attr_reader :server, :name, :layout, :script
+
+    def [](layout_name)
+      self.layout[layout_name]
+    end
+
+  end
+
+  class Layout
+    def initialize(name, db)
+      @name = name
+      @db = db
+    end
+    
+    attr_reader :name
+    
+    def all(options = {})
+      get_records('-findall', {}, options)
+    end
+    
+    def any(options = {})
+      get_records('-findany', {}, options)
+    end
+
+    def find(query_map, options = {})
+      get_records('-find', query_map, options)
+    end
+
+    def edit(recid, values, options = {})
+      get_records('-edit', {'-recid' => recid}.merge(values), options)
+    end
+    
+    def create(values, options = {})
+      get_records('-new', values, options)
+    end
+    
+    def delete(recid, options = {})
+      get_records('-delete', {'-recid' => recid}, options)
+      return nil
+    end
+    
+    private
+    
+    def get_records(action, extra_params = {}, options = {})
+      Rfm::Result::ResultSet.new(
+        @db.server.do_action(action, params().merge(extra_params), options).body,
+        self)
+    end
+    
+    def params
+      {"-db" => @db.name, "-lay" => self.name}
+    end
+  end
+
+  class Script
+    def initialize(name, db)
+      @name = name
+      @db = db
+    end
+    
+    attr_reader :name
+  end
+
+end
+

data/lib/rfm_error.rb

@@ -0,0 +1,25 @@
+module Rfm::Error
+  class FileMakerError < Exception
+    def self.instance(error_code)
+      case error_code
+        when 101 then return RecordMissingError.new
+        when 102 then return FieldMissingError.new
+        when 104 then return RelationshipMissingError.new
+        when 105 then return LayoutMissingError.new
+        else return FileMakerError.new
+      end
+    end
+  end
+  
+  class RecordMissingError < FileMakerError
+  end
+  
+  class FieldMissingError < FileMakerError
+  end
+  
+  class RelationshipMissingError < FileMakerError
+  end
+  
+  class LayoutMissingError < FileMakerError
+  end
+end

data/lib/rfm_factory.rb

@@ -0,0 +1,75 @@
+module Rfm::Factory
+  class DbFactory < Hash
+  
+    def initialize(server)
+      @server = server
+      @loaded = false
+    end
+    
+    def [](dbname)
+      super or (self[dbname] = Rfm::Database.new(dbname, @server))
+    end
+    
+    def all
+      if !@loaded
+        Rfm::Result::ResultSet.new(@server.do_action('-dbnames', {}).body).each {|record|
+          name = record['DATABASE_NAME']
+          self[name] = Rfm::Database.new(name, @server) if self[name] == nil
+        }
+        @loaded = false
+      end
+      self.values
+    end
+
+  end
+  
+  class LayoutFactory < Hash
+  
+    def initialize(server, database)
+      @server = server
+      @database = database
+      @loaded = false
+    end
+    
+    def [](layout_name)
+      super or (self[layout_name] = Rfm::Layout.new(layout_name, @database))
+    end
+    
+    def all
+      if !@loaded
+        Rfm::Result::ResultSet.new(@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
+        }
+        @loaded = true
+      end
+      self.values
+    end
+
+  end
+
+  class ScriptFactory < Hash
+  
+    def initialize(server, database)
+      @server = server
+      @database = database
+      @loaded = false
+    end
+    
+    def [](script_name)
+      super or (self[script_name] = Rfm::Script.new(script_name, @database))
+    end
+    
+    def all
+      if !@loaded
+        Rfm::Result::ResultSet.new(@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
+        }
+        @loaded = true
+      end
+      self.values
+    end
+
+  end
+end

data/lib/rfm_result.rb

@@ -0,0 +1,156 @@
+require 'bigdecimal'
+
+module Rfm::Result
+  
+  class ResultSet < Array
+    def initialize(fmresultset, layout = nil)
+      @resultset = nil
+      @layout = layout
+      @fields = {}
+      @portals = {}
+      
+      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
+      
+      # process field metadata
+      root.elements['metadata'].each_element('field-definition') { |field|
+        name = field.attributes['name']
+        @fields[name] = Field.new(field)
+      }
+      @fields.freeze
+      
+      # process relatedset metadata
+      root.elements['metadata'].each_element('relatedset-definition') { |relatedset|
+        table = relatedset.attributes['table']
+        fields = {}
+        relatedset.each_element('field-definition') { |field|
+          name = field.attributes['name'].sub(Regexp.new(table + '::'), '')
+          fields[name] = Field.new(field)
+        }
+        @portals[table] = fields
+      }
+      @portals.freeze
+      
+      # build rows
+      root.elements['resultset'].each_element('record') { |record|
+        self << Record.new(record, self, @fields, @layout)
+      }
+    end  
+        
+    attr_reader :fields, :portals
+    
+  end
+  
+  class Record < Hash
+    def initialize(row_element, resultset, fields, layout, portal=nil)
+      @record_id = row_element.attributes['record-id']
+      @mod_id = row_element.attributes['mod-id']
+      @mods = {}
+      @resultset = resultset
+      @layout = layout
+      
+      @loaded = false
+      
+      row_element.each_element('field') { |field| 
+        field_name = field.attributes['name']
+        field_name.sub!(Regexp.new(portal + '::'), '') if portal
+        datum = []
+        field.each_element('data') {|x| datum.push(fields[field_name].coerce(x.text))}
+        if datum.length == 1
+          self[field_name] = datum[0]
+        elsif datum.length == 0
+          self[field_name] = nil
+        else
+          self[field_name] = datum
+        end
+      }
+      
+      @portals = {}
+      row_element.each_element('relatedset') { |relatedset|
+        table = relatedset.attributes['table']
+        records = []
+        relatedset.each_element('record') { |record|
+          records << Record.new(record, @resultset, @resultset.portals[table], @layout, table)
+        }
+        @portals[table] = records
+      }
+      
+      @loaded = true
+    end
+    
+    attr_reader :record_id, :mod_id, :portals
+
+    def save
+      self.merge(@layout.edit(self.record_id, @mods)[0]) if @mods.size > 0
+      @mods.clear
+    end
+
+    def save_if_not_modified
+      self.merge(@layout.edit(@record_id, @mods, {'-modid' => @mod_id})[0]) if @mods.size > 0
+      @mods.clear
+    end
+    
+    def []=(name, value)
+      return super if !@loaded
+      if self[name] != nil
+        @mods[name] = val
+      else
+        raise "No such field: #{name}"
+      end
+    end
+    
+    def method_missing (symbol, *attrs)
+      # check for simple getter
+      val = self[symbol.to_s]
+      return val if val != nil
+
+      # check for setter
+      symbol_name = symbol.to_s
+      if symbol_name[-1..-1] == '=' && self.has_key?(symbol_name[0..-2])
+        return @mods[symbol_name[0..-2]] = attrs[0]
+      end
+      super
+    end
+    
+    def respond_to?(symbol, include_private = false)
+      return true if self[symbol.to_s] != nil
+      super
+    end
+  end
+  
+  class Field
+    def initialize(field)
+      @name = field.attributes['name']
+      @result = field.attributes['result']
+      @type = field.attributes['type']
+      @max_repeats = field.attributes['max-repeats']
+      @global = field.attributes['global']
+    end
+    
+    attr_reader :name, :type, :max_repeats, :global
+
+    def coerce(value)
+      return nil if (value == nil || value == '') && @result != "text"
+      case @result
+      when "text"
+        return value
+      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)
+      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)
+      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)
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification 
+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
+summary: A package to access FileMaker Pro databases
+require_paths: 
+- lib
+email: gwcoffey on gmail.com
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: rfm
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Geoff Coffey
+files: 
+- lib/rfm.rb
+- lib/rfm_command.rb
+- lib/rfm_error.rb
+- lib/rfm_factory.rb
+- lib/rfm_result.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+