lardawge-rfm 1.1.0 → 1.2.0

data/lib/rfm_command.rb

@@ -1,6 +1,6 @@
-require 'net/http'
-require 'rexml/document'
+require 'net/https'
 require 'cgi'
+require 'hpricot'
 
 # This module includes classes that represent base FileMaker concepts like servers,
 # layouts, and scripts. These classes allow you to communicate with FileMaker Server,
@@ -58,6 +58,46 @@ module Rfm
   
   class Server
     
+    #
+    # SSL AND CERTIFICATE VERIFICATION ARE ON BY DEFAULT
+    #     
+    # Example to turn off SSL:
+    # 
+    # response = myServer.do_action(
+    #           :host => 'localhost',
+    #           :account_name => 'sample',
+    #           :password => '12345',
+    #           :ssl => false 
+    #           )
+    #           
+    # Example using SSL without *root_cert*:
+    #           
+    # response = myServer.do_action(
+    #           :host => 'localhost',
+    #           :account_name => 'sample',
+    #           :password => '12345',
+    #           :root_cert => false 
+    #           )
+    #           
+    # Example using SSL with *root_cert* at file root:
+    # 
+    # response = myServer.do_action(
+    #            :host => 'localhost',
+    #            :account_name => 'sample',
+    #            :password => '12345',
+    #            :root_cert_name => 'example.pem' 
+    #            )
+    #            
+    # Example using SSL with *root_cert* specifying *root_cert_path*:
+    # 
+    # response = myServer.do_action(
+    #            :host => 'localhost',
+    #            :account_name => 'sample',
+    #            :password => '12345',
+    #            :root_cert_name => 'example.pem'
+    #            :root_cert_path => '/usr/cert_file/'
+    #            )
+    #
     # To create a Server obejct, you typically need at least a host name:
     # 
     #   myServer = Rfm::Server.new({:host => 'my.host.com'})
@@ -68,12 +108,18 @@ module Rfm
     #
     # * *port* the port number the WPE is listening no (defaults to 80 unless *ssl* +true+ which sets it to 443)
     #
-    # * *ssl* +true+ if you want to use SSL (HTTPS) to connect to FileMaker (defaults to +false+)
+    # * *ssl* +false+ if you want to turn SSL (HTTPS) off when connecting to connect to FileMaker (default is +true+)
+    #
+    # If you have SSL on and want
+    # * *root_cert* +false+ if you do not want to verify your SSL session (default is +true+). 
+    #   You will want to turn this off if you are using a self signed certificate and do not have a certificate authority cert file.
+    #   If you choose this option you will need to provide a cert *root_cert_name* and *root_cert_path* (if not in root directory).
     #
-    # * *root_cert* name of pem file for certificate verification (Root cert from certificate authority who issued certificate.
+    # * *root_cert_name* name of pem file for certificate verification (Root cert from certificate authority who issued certificate.
     #   If self signed certificate do not use this option!!). You can download the entire bundle of CA Root Certificates
-    #   from http://curl.haxx.se/ca/cacert.pem. Place the pem file in config directory. (WARNING: If left blank there is no guarantee that your
-    #   session is secure)
+    #   from http://curl.haxx.se/ca/cacert.pem. Place the pem file in config directory.
+    #
+    # * *root_cert_path* path to cert file. (defaults to '/' if no path given)
     #
     # * *account_name* the default account name to log in to databases with (you can also supply a
     #   account name on a per-database basis if necessary)
@@ -94,12 +140,15 @@ module Rfm
     # * *raise_on_401* although RFM raises error when FileMaker returns error responses, it typically
     #   ignores FileMaker's 401 error (no records found) and returns an empty record set instead; if you
     #   prefer a raised error when a find produces no errors, set this option to +true+
+    
     def initialize(options)
       @state = {
         :host => 'localhost',
         :port => 80,
-        :ssl => false,
-        :root_cert => '',
+        :ssl => true,
+        :root_cert => true,
+        :root_cert_name => '',
+        :root_cert_path => '/',
         :account_name => '',
         :password => '',
         :log_actions => false,
@@ -117,7 +166,7 @@ module Rfm
       
       @host_name = @state[:host]
       @scheme = @state[:ssl] ? "https" : "http"
-      @port = @state[:ssl] && options[:port].blank? ? 443 : @state[:port]
+      @port = @state[:ssl] && options[:port].nil? ? 443 : @state[:port]
       
       @db = Rfm::Factory::DbFactory.new(self)
     end
@@ -194,11 +243,11 @@ module Rfm
       request.set_form_data(post_data)
 
       response = Net::HTTP.new(host_name, port)
-      if @scheme == "https"  # enable SSL/TLS
+      if @scheme == "https"  # enable SSL
         response.use_ssl = true
-        unless @state[:root_cert].blank?
+        if @state[:root_cert]
           response.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          response.ca_file = File.join("#{RAILS_ROOT}/config/", @state[:root_cert])
+          response.ca_file = File.join(@state[:root_cert_path], @state[:root_cert_name])
         else
           response.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end

data/lib/rfm_result.rb

@@ -71,48 +71,47 @@ module Rfm::Result
       @total_count = nil
       @foundset_count = nil
       
-      doc = REXML::Document.new(fmresultset)
-      root = doc.root
+      doc = Hpricot.XML(fmresultset)
       
       # check for errors
-      error = root.elements['error'].attributes['code'].to_i
+      error = doc.search('error').attr('code').to_i
       if error != 0 && (error != 401 || @server.state[:raise_on_401])
         raise Rfm::Error::FileMakerError.getError(error) 
       end
       
       # 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'])
-
+      datasource = doc.search('datasource')
+      @date_format = convertFormatString(datasource.attr('date-format'))
+      @time_format = convertFormatString(datasource.attr('time-format'))
+      @timestamp_format = convertFormatString(datasource.attr('timestamp-format'))
+      
       # process count metadata
       @total_count = datasource.attributes['total-count'].to_i
       @foundset_count = root.elements['resultset'].attributes['count'].to_i
       
       # process field metadata
-      root.elements['metadata'].each_element('field-definition') { |field|
+      doc.search('field-definition').each do |field|
         name = field.attributes['name']
         @fields[name] = Field.new(self, field)
-      }
+      end
       @fields.freeze
       
       # process relatedset metadata
-      root.elements['metadata'].each_element('relatedset-definition') { |relatedset|
-        table = relatedset.attributes['table']
+      doc.search('relatedset-definition').each do |relatedset|
+        table = relatedset.attr('table')
         fields = {}
-        relatedset.each_element('field-definition') { |field|
-          name = field.attributes['name'].sub(Regexp.new(table + '::'), '')
+        relatedset.search('field-definition').each do |field|
+          name = field.attr('name').sub(Regexp.new(table + '::'), '')
           fields[name] = Field.new(self, field)
-        }
+        end
         @portals[table] = fields
-      }
+      end
       @portals.freeze
       
       # build rows
-      root.elements['resultset'].each_element('record') { |record|
+      doc.search('record').each do |record|
         self << Record.new(record, self, @fields, @layout)
-      }
+      end
     end  
         
     attr_reader :server, :fields, :portals, :date_format, :time_format, :timestamp_format, :total_count, :foundset_count, :layout
@@ -236,11 +235,13 @@ module Rfm::Result
       
       @loaded = false
       
-      row_element.each_element('field') { |field| 
+      row_element.search('field').each do |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))}
+        field.search('data').each do |x| 
+          datum.push(fields[field_name].coerce(x.inner_text))
+        end
         if datum.length == 1
           self[field_name] = datum[0]
         elsif datum.length == 0
@@ -248,18 +249,17 @@ module Rfm::Result
         else
           self[field_name] = datum
         end
-      }
+      end
       
       @portals = Rfm::Util::CaseInsensitiveHash.new
-      row_element.each_element('relatedset') { |relatedset|
+      row_element.search('relatedset').each do |relatedset|
         table = relatedset.attributes['table']
         records = []
-        relatedset.each_element('record') { |record|
+        relatedset.search('record').each do |record|
           records << Record.new(record, @resultset, @resultset.portals[table], @layout, table)
-        }
+        end
         @portals[table] = records
-      }
-      
+      end      
       @loaded = true
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lardawge-rfm
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Geoff Coffey