ginjo-rfm 3.0.9 → 3.0.10

data/lib/rfm/utilities/connection.rb

@@ -5,30 +5,31 @@
 
 require 'net/https'
 require 'cgi'
+
 module Rfm
-# These have been moved to rfm.rb.
-# 	SaxParser.default_class = CaseInsensitiveHash
-# 	SaxParser.template_prefix = File.join(File.dirname(__FILE__), './sax/')
-# 	SaxParser.templates.merge!({
-# 		:fmpxmllayout => 'fmpxmllayout.yml',
-# 		:fmresultset => 'fmresultset.yml',
-# 		:fmpxmlresult => 'fmpxmlresult.yml',
-# 		:none => nil
-# 	})
-	
+  # These have been moved to rfm.rb.
+  #   SaxParser.default_class = CaseInsensitiveHash
+  #   SaxParser.template_prefix = File.join(File.dirname(__FILE__), './sax/')
+  #   SaxParser.templates.merge!({
+  #     :fmpxmllayout => 'fmpxmllayout.yml',
+  #     :fmresultset => 'fmresultset.yml',
+  #     :fmpxmlresult => 'fmpxmlresult.yml',
+  #     :none => nil
+  #   })
+
   class Connection
-  	include Config  	
-  
-		def initialize(action, params, request_options={},  *args)
-    	config *args
-      
+    include Config
+
+    def initialize(action, params, request_options={},  *args)
+      config(*args)
+
       # Action sent to FMS
       @action = action
       # Query params sent to FMS
       @params = params
       # Additional options sent to FMS
       @request_options = request_options
-      
+
       @defaults = {
         :host => 'localhost',
         #:port => 80,
@@ -49,66 +50,73 @@ module Rfm
         :template => :fmresultset,
         :grammar => 'fmresultset'
       }   #.merge(options)
-	
     end
 
     def state(*args)
-    	@defaults.merge(super(*args))
+      @defaults.merge(super(*args))
+    end
+
+    def host_name
+      state[:host]
+    end
+
+    def scheme
+      state[:ssl] ? "https" : "http"
+    end
+
+    def port
+      state[:ssl] && state[:port].nil? ? 443 : state[:port]
     end
-    
-	  def host_name; state[:host]; end
-	  def scheme; state[:ssl] ? "https" : "http"; end
-	  def port; state[:ssl] && state[:port].nil? ? 443 : state[:port]; end
 
     def connect(action=@action, params=@params, request_options = @request_options, account_name=state[:account_name], password=state[:password])
-    	grammar_option = request_options.delete(:grammar)
+      grammar_option = request_options.delete(:grammar)
       post = params.merge(expand_options(request_options)).merge({action => ''})
       grammar = select_grammar(post, :grammar=>grammar_option)
       http_fetch(host_name, port, "/fmi/xml/#{grammar}.xml", account_name, password, post)
     end
 
     def select_grammar(post, options={})
-			grammar = state(options)[:grammar] || 'fmresultset'
-			if grammar.to_s.downcase == 'auto'
-				# TODO: Build grammar parser in new sax engine templates to handle FMPXMLRESULT.
-				return "fmresultset"
-				post.keys.find(){|k| %w(-find -findall -dbnames -layoutnames -scriptnames).include? k.to_s} ? "FMPXMLRESULT" : "fmresultset"   
-    	else
-    		grammar
-    	end
+      grammar = state(options)[:grammar] || 'fmresultset'
+      if grammar.to_s.downcase == 'auto'
+        # TODO: Build grammar parser in new sax engine templates to handle FMPXMLRESULT.
+        return "fmresultset"
+        # post.keys.find(){|k| %w(-find -findall -dbnames -layoutnames -scriptnames).include? k.to_s} ? "FMPXMLRESULT" : "fmresultset"   
+      else
+        grammar
+      end
     end
-    
+
     def parse(template=nil, initial_object=nil, parser=nil, options={})
-    	template ||= state[:template]
-    	#(template =  'fmresultset.yml') unless template
-    	#(template = File.join(File.dirname(__FILE__), '../sax/', template)) if template.is_a? String
-    	Rfm::SaxParser.parse(connect.body, template, initial_object, parser, state(*options)).result
+      template ||= state[:template]
+      #(template =  'fmresultset.yml') unless template
+      #(template = File.join(File.dirname(__FILE__), '../sax/', template)) if template.is_a? String
+      Rfm::SaxParser.parse(connect.body, template, initial_object, parser, state(*options)).result
     end
 
 
 
 
-  private
-  
+    private
+
     def http_fetch(host_name, port, path, account_name, password, post_data, limit=10)
       raise Rfm::CommunicationError.new("While trying to reach the Web Publishing Engine, RFM was redirected too many times.") if limit == 0
-  
+
       if state[:log_actions] == true
         #qs = post_data.collect{|key,val| "#{CGI::escape(key.to_s)}=#{CGI::escape(val.to_s)}"}.join("&")
         qs_unescaped = post_data.collect{|key,val| "#{key.to_s}=#{val.to_s}"}.join("&")
         #warn "#{@scheme}://#{@host_name}:#{@port}#{path}?#{qs}"
         log.info "#{scheme}://#{host_name}:#{port}#{path}?#{qs_unescaped}"
       end
-  
+
       request = Net::HTTP::Post.new(path)
       request.basic_auth(account_name, password)
       request.set_form_data(post_data)
-  
-  		if state[:proxy]
-	  		connection = Net::HTTP::Proxy(*state[:proxy]).new(host_name, port)
-  		else
-	      connection = Net::HTTP.new(host_name, port)
-	    end
+
+      if state[:proxy]
+        connection = Net::HTTP::Proxy(*state[:proxy]).new(host_name, port)
+      else
+        connection = Net::HTTP.new(host_name, port)
+      end
       #ADDED LONG TIMEOUT TIMOTHY TING 05/12/2011
       connection.open_timeout = connection.read_timeout = state[:timeout]
       if state[:ssl]
@@ -120,20 +128,20 @@ module Rfm
           connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
       end
-  
+
       response = connection.start { |http| http.request(request) }
       if state[:log_responses] == true
         response.to_hash.each { |key, value| log.info "#{key}: #{value}" }
         log.info response.body
       end
-  
+
       case response
       when Net::HTTPSuccess
         response
       when Net::HTTPRedirection
         if state[:warn_on_redirect]
           log.warn "The web server redirected to " + response['location'] + 
-          ". You should revise your connection hostname or fix your server configuration if possible to improve performance."
+            ". You should revise your connection hostname or fix your server configuration if possible to improve performance."
         end
         newloc = URI.parse(response['location'])
         http_fetch(newloc.host, newloc.port, newloc.request_uri, account_name, password, post_data, limit - 1)
@@ -148,18 +156,18 @@ module Rfm
         raise Rfm::CommunicationError.new(msg)
       end
     end
-  
+
     def expand_options(options)
       result = {}
       field_mapping = options.delete(:field_mapping) || {}
       options.each do |key,value|
         case key.to_sym
         when :max_portal_rows
-        	result['-relatedsets.max'] = value
-        	result['-relatedsets.filter'] = 'layout'
+          result['-relatedsets.max'] = value
+          result['-relatedsets.filter'] = 'layout'
         when :ignore_portals
-        	result['-relatedsets.max'] = 0
-        	result['-relatedsets.filter'] = 'layout'
+          result['-relatedsets.max'] = 0
+          result['-relatedsets.filter'] = 'layout'
         when :max_records
           result['-max'] = value
         when :skip_records
@@ -211,8 +219,8 @@ module Rfm
       end
       return result
     end  
-  
+
   end # Connection
 
-  
-end # Rfm
+
+end # Rfm

data/lib/rfm/utilities/core_ext.rb

@@ -1,140 +1,140 @@
 require 'forwardable'
 
 Module.module_eval do
-	# Adds ability to forward methods to other objects using 'def_delegator'
-	include Forwardable
+  # Adds ability to forward methods to other objects using 'def_delegator'
+  include Forwardable
 end
 
 class Object
 
-	#extend Forwardable
+  #extend Forwardable
 
-	# Adds methods to put instance variables in rfm_metaclass, plus getter/setters
-	# This is useful to hide instance variables in objects that would otherwise show "too much" information.
+  # Adds methods to put instance variables in rfm_metaclass, plus getter/setters
+  # This is useful to hide instance variables in objects that would otherwise show "too much" information.
   def self.meta_attr_accessor(*names)
-		meta_attr_reader(*names)
-		meta_attr_writer(*names)
+    meta_attr_reader(*names)
+    meta_attr_writer(*names)
   end
-  
+
   def self.meta_attr_reader(*names)
     names.each do |n|
       define_method(n.to_s) {rfm_metaclass.instance_variable_get("@#{n}")}
     end
   end
-  
+
   def self.meta_attr_writer(*names)
     names.each do |n|
       define_method(n.to_s + "=") {|val| rfm_metaclass.instance_variable_set("@#{n}", val)}
     end
   end
-  
+
   # Wrap an object in Array, if not already an Array,
-	# since XmlMini doesn't know which will be returnd for any particular element.
-	# See Rfm Layout & Record where this is used.
-	def rfm_force_array
-		return [] if self.nil?
-		self.is_a?(Array) ? self : [self]
-	end
-	
-	# Just testing this functionality
-	def rfm_local_methods
-		self.methods - self.class.superclass.methods
-	end
-  
-private
-
-	# Like singleton_method or 'metaclass' from ActiveSupport.
-	def rfm_metaclass
-		class << self
-			self
-		end
-	end
-  
+  # since XmlMini doesn't know which will be returnd for any particular element.
+  # See Rfm Layout & Record where this is used.
+  def rfm_force_array
+    return [] if self.nil?
+    self.is_a?(Array) ? self : [self]
+  end
+
+  # Just testing this functionality
+  def rfm_local_methods
+    self.methods - self.class.superclass.methods
+  end
+
+  private
+
+  # Like singleton_method or 'metaclass' from ActiveSupport.
+  def rfm_metaclass
+    class << self
+      self
+    end
+  end
+
   # Get the superclass object of self.
   def rfm_super
     SuperProxy.new(self)
   end
-  
+
 end # Object
 
 
 class Array
-	# Taken from ActiveSupport extract_options!.
-	def rfm_extract_options!
-	  last.is_a?(::Hash) ? pop : {}
-	end
-
-	# These methods allow dynamic extension of array members with other modules.
-	# These methods also carry the @root object for reference, when you don't have the
-	# root object explicity referenced anywhere.
-	#
-	# These methods might slow down array traversal, as
-	# they add interpreted code to methods that were otherwise pure C.	
+  # Taken from ActiveSupport extract_options!.
+  def rfm_extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+
+  # These methods allow dynamic extension of array members with other modules.
+  # These methods also carry the @root object for reference, when you don't have the
+  # root object explicity referenced anywhere.
+  #
+  # These methods might slow down array traversal, as
+  # they add interpreted code to methods that were otherwise pure C.
   def rfm_extend_members(klass, caller=nil)
-  	@parent = caller
+    @parent = caller
     @root = caller.instance_variable_get(:@root)
-  	@member_extension = klass
-  	self.instance_eval do
-  	  class << self
-  	  	attr_accessor :parent
-	
-    		alias_method 'old_reader', '[]'
-    		def [](*args)
-    			member = old_reader(*args)
+    @member_extension = klass
+    self.instance_eval do
+      class << self
+        attr_accessor :parent
+
+        alias_method 'old_reader', '[]'
+        def [](*args)
+          member = old_reader(*args)
           rfm_extend_member(member, @member_extension, args[0]) if args[0].is_a? Integer
-    			member
-    		end
-		
-    		alias_method 'old_each', 'each'
-    		def each
-    			i = -1
-    			old_each do |member|
-    				i = i + 1
-    				rfm_extend_member(member, @member_extension, i)
-    				yield(member)
-    			end
-    		end
-  	  end
-  	end unless defined? old_reader
-  	self
-  end
-  
+          member
+        end
+
+        alias_method 'old_each', 'each'
+        def each
+          i = -1
+          old_each do |member|
+            i = i + 1
+            rfm_extend_member(member, @member_extension, i)
+            yield(member)
+          end
+        end
+      end
+    end unless defined? old_reader
+    self
+  end
+
   def rfm_extend_member(member, extension, i=nil)
-  	if member and extension
-	    unless member.instance_variable_get(:@root)
-			  member.instance_variable_set(:@root, @root)
-			  member.instance_variable_set(:@parent, self)
-			  member.instance_variable_set(:@index, i)
-	  		member.instance_eval(){def root; @root; end}
-	  		member.instance_eval(){def parent; @parent; end}
-	  		member.instance_eval(){def get_index; @index; end}
-	  	end
-			member.extend(extension)
-		end  
+    if member and extension
+      unless member.instance_variable_get(:@root)
+        member.instance_variable_set(:@root, @root)
+        member.instance_variable_set(:@parent, self)
+        member.instance_variable_set(:@index, i)
+        member.instance_eval(){def root; @root; end}
+        member.instance_eval(){def parent; @parent; end}
+        member.instance_eval(){def get_index; @index; end}
+      end
+      member.extend(extension)
+    end
   end
 
 end # Array
 
 class Hash
-	# TODO: Possibly deprecated, delete if not used.
-	def rfm_only(*keepers)
-		self.dup.each_key {|k| self.delete(k) if !keepers.include?(k)}
-	end
-	
-	def rfm_filter(*args)
-		options = args.rfm_extract_options!
-		delete = options[:delete]
-		self.dup.each_key do |k|
-			self.delete(k) if (delete ? args.include?(k) : !args.include?(k))
-		end
-	end
-	
-	# Convert hash to Rfm::CaseInsensitiveHash
-	def to_cih
-		new = Rfm::CaseInsensitiveHash.new
-		self.each{|k,v| new[k] = v}
-		new
-	end
+  # TODO: Possibly deprecated, delete if not used.
+  def rfm_only(*keepers)
+    self.dup.each_key {|k| self.delete(k) if !keepers.include?(k)}
+  end
+
+  def rfm_filter(*args)
+    options = args.rfm_extract_options!
+    delete = options[:delete]
+    self.dup.each_key do |k|
+      self.delete(k) if (delete ? args.include?(k) : !args.include?(k))
+    end
+  end
+
+  # Convert hash to Rfm::CaseInsensitiveHash
+  def to_cih
+    new = Rfm::CaseInsensitiveHash.new
+    self.each{|k,v| new[k] = v}
+    new
+  end
 end # Hash
 
 # Allows access to superclass object
@@ -150,27 +150,22 @@ end # SuperProxy
 
 
 class Time
-	# Returns array of [date,time] in format suitable for FMP.
-	def to_fm_components(reset_time_if_before_today=false)
-		d = self.strftime('%m/%d/%Y')
-		t = if (Date.parse(self.to_s) < Date.today) and reset_time_if_before_today==true
-			"00:00:00"
-		else
-			self.strftime('%T')
-		end
-		[d,t]
-	end
+  # Returns array of [date,time] in format suitable for FMP.
+  def to_fm_components(reset_time_if_before_today=false)
+    d = self.strftime('%m/%d/%Y')
+    t = if (Date.parse(self.to_s) < Date.today) and reset_time_if_before_today==true
+          "00:00:00"
+        else
+          self.strftime('%T')
+        end
+    [d,t]
+  end
 end # Time
 
 class String
-	def title_case
-		self.gsub(/\w+/) do |word|
-		  word.capitalize
-		end
-	end
+  def title_case
+    self.gsub(/\w+/) do |word|
+      word.capitalize
+    end
+  end
 end # String
-
-
-
-
-