ofx_for_ruby 0.1.1

data/lib/ofx/1.0.2/header.rb

@@ -0,0 +1,48 @@
+# Copyright © 2007 Chris Guidry <chrisguidry@gmail.com>
+#
+# This file is part of OFX for Ruby.
+# 
+# OFX for Ruby is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OFX for Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OFX
+    class Header
+        def to_ofx_102_s
+            headers = ""
+
+            headers += "OFXHEADER:" + self.header_version.to_compact_s + "\n"
+            headers += "DATA:" + self.content_type.to_s + "\n"
+            headers += "VERSION:" + self.document_version.to_compact_s + "\n"
+            headers += "SECURITY:" + self.security.to_s + "\n"
+            headers += "ENCODING:" + self.content_encoding.to_s + "\n"
+            headers += "CHARSET:" + self.content_character_set.to_s + "\n"
+            headers += "COMPRESSION:" + self.compression.to_s + "\n"
+            headers += "OLDFILEUID:" + self.previous_unique_identifier.to_s + "\n"
+            headers += "NEWFILEUID:" + self.unique_identifier.to_s + "\n"
+
+            headers
+        end
+        
+        def self.from_ofx_102_s(header_string)
+            header = OFX::Header.new
+        
+            header_pattern = /^(\w+)\:(.*)$/
+            header_string.split("\n").each do |this_header|
+                header_match = header_pattern.match(this_header)
+                header[header_match[1]] = header_match[2]
+           end
+            
+            header
+        end
+    end
+end

data/lib/ofx/1.0.2/interbank_funds_transfer_message_set.rb

@@ -0,0 +1,30 @@
+# Copyright © 2007 Chris Guidry <chrisguidry@gmail.com>
+#
+# This file is part of OFX for Ruby.
+# 
+# OFX for Ruby is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OFX for Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OFX
+    class InterbankFundsTransferMessageSet < MessageSet
+    end
+    
+    class InterbankFundsTransferMessageSetProfile < MessageSetProfile
+        def self.from_ofx_102_hash(message_set_description_hash)
+            profile = OFX::InterbankFundsTransferMessageSetProfile.new
+            profile.message_set_class = OFX::InterbankFundsTransferMessageSet
+            profile.from_ofx_102_hash(message_set_description_hash)
+            profile
+        end
+    end
+end

data/lib/ofx/1.0.2/investment_security_list_message_set.rb

@@ -0,0 +1,30 @@
+# Copyright © 2007 Chris Guidry <chrisguidry@gmail.com>
+#
+# This file is part of OFX for Ruby.
+# 
+# OFX for Ruby is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OFX for Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OFX
+    class InvestmentSecurityListMessageSet < MessageSet
+    end
+    
+    class InvestmentSecurityListMessageSetProfile < MessageSetProfile
+        def self.from_ofx_102_hash(message_set_description_hash)
+            profile = OFX::InvestmentSecurityListMessageSetProfile.new
+            profile.message_set_class = OFX::InvestmentSecurityListMessageSet
+            profile.from_ofx_102_hash(message_set_description_hash)
+            profile
+        end
+    end
+end

data/lib/ofx/1.0.2/investment_statement_message_set.rb

@@ -0,0 +1,30 @@
+# Copyright © 2007 Chris Guidry <chrisguidry@gmail.com>
+#
+# This file is part of OFX for Ruby.
+# 
+# OFX for Ruby is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OFX for Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OFX
+    class InvestmentStatementMessageSet < MessageSet
+    end
+    
+    class InvestmentStatementMessageSetProfile < MessageSetProfile
+        def self.from_ofx_102_hash(message_set_description_hash)
+            profile = OFX::InvestmentStatementMessageSetProfile.new
+            profile.message_set_class = OFX::InvestmentStatementMessageSet
+            profile.from_ofx_102_hash(message_set_description_hash)
+            profile
+        end
+    end
+end

data/lib/ofx/1.0.2/lexer.rb

@@ -0,0 +1,135 @@
+#--
+# DO NOT MODIFY!!!!
+# This file is automatically generated by rex 1.0.2
+# from lexical definition file "ofx_102.rex".
+#++
+
+require 'racc/parser'
+# Copyright © 2007 Chris Guidry <chrisguidry@gmail.com>
+#
+# This file is part of OFX for Ruby.
+# 
+# OFX for Ruby is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OFX for Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OFX
+module OFX102
+class Parser < Racc::Parser
+  require 'strscan'
+
+  class ScanError < StandardError ; end
+
+  attr_reader :lineno
+  attr_reader :filename
+
+  def scan_setup ; end
+
+  def action &block
+    yield
+  end
+
+  def scan_str( str )
+    scan_evaluate  str
+    do_parse
+  end
+
+  def load_file( filename )
+    @filename = filename
+    open(filename, "r") do |f|
+      scan_evaluate  f.read
+    end
+  end
+
+  def scan_file( filename )
+    load_file  filename
+    do_parse
+  end
+
+  def next_token
+    @rex_tokens.shift
+  end
+
+  def scan_evaluate( str )
+    scan_setup
+    @rex_tokens = []
+    @lineno  =  1
+    ss = StringScanner.new(str)
+    state = nil
+    until ss.eos?
+      text = ss.peek(1)
+      @lineno  +=  1  if text == "\n"
+      case state
+      when nil
+        case
+        when (text = ss.scan(/\<\//))
+           @rex_tokens.push action { state = :TAG; [:etag_in, text] }
+
+        when (text = ss.scan(/\</))
+           @rex_tokens.push action { state = :TAG; [:tag_in, text] }
+
+        when (text = ss.scan(/\s+(?=\S)/))
+          ;
+
+        when (text = ss.scan(/.*?(?=(\<|\<\/)+?)/))
+           @rex_tokens.push action {               [:text, text] }
+
+        when (text = ss.scan(/.*\S(?=\s*$)/))
+           @rex_tokens.push action {               [:text, text] }
+
+        when (text = ss.scan(/\s+(?=$)/))
+          ;
+
+        else
+          text = ss.string[ss.pos .. -1]
+          raise  ScanError, "can not match: '" + text + "'"
+        end  # if
+
+      when :TAG
+        case
+        when (text = ss.scan(/\>/))
+           @rex_tokens.push action { state = nil;  [:tag_out, text] }
+
+        when (text = ss.scan(/[\w\-\.]+/))
+           @rex_tokens.push action {               [:element, text] }
+
+        else
+          text = ss.string[ss.pos .. -1]
+          raise  ScanError, "can not match: '" + text + "'"
+        end  # if
+
+      else
+        raise  ScanError, "undefined state: '" + state.to_s + "'"
+      end  # case state
+    end  # until ss
+  end  # def scan_evaluate
+
+end # class
+
+end # module OFX102
+end # module OFX
+
+=begin
+if __FILE__ == $0
+  exit  if ARGV.size != 1
+  filename = ARGV.shift
+  rex = OFX::OFX102::Parser.new
+  begin
+    rex.load_file  filename
+    while  token = rex.next_token
+      p token
+    end
+  rescue
+    $stderr.printf  "%s:%d:%s\n", rex.filename, rex.lineno, $!.message
+  end
+end
+=end

data/lib/ofx/1.0.2/message_set.rb

@@ -0,0 +1,165 @@
+# Copyright © 2007 Chris Guidry <chrisguidry@gmail.com>
+#
+# This file is part of OFX for Ruby.
+# 
+# OFX for Ruby is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OFX for Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OFX
+    class MessageSet
+        def to_ofx_102_s
+            request_message = requests.length > 0
+            request_message = responses.length == 0
+
+            message = ''
+            
+            if request_message
+                message += "  <#{ofx_102_message_set_name}MSGSRQV#{version}>\n"
+                requests.each do |request|
+                    message += request.to_ofx_102_s + "\n"
+                end
+                message += "  </#{ofx_102_message_set_name}MSGSRQV#{version}>\n"
+            else
+                message += "  <#{ofx_102_message_set_name}MSGSRSV#{version}>\n"
+                responses.each do |response|
+                    message += response.to_ofx_102_s + "\n"
+                end
+                message += "  </#{ofx_102_message_set_name}MSGSRSV#{version}>\n"
+            end
+                
+            message
+        end
+
+        def ofx_102_message_set_name
+            raise NotImplementedError
+        end
+        
+        def self.from_ofx_102_message_set_hash(message_set_name, message_set_hash)
+            match = /^(\w+)MSGSR([QS])V(\d+)$/.match(message_set_name)
+            raise NotImplementedError unless match
+            
+            message_set_class = MESSAGE_SET_NAMES_TO_CLASSES[$1]
+            raise NotImplementedError unless message_set_class
+            
+            return message_set_class.from_ofx_102_hash(message_set_hash)
+        end
+        
+        def request_or_response_from_ofx_102_tag_name(response_or_request_name)
+            raise NotImplementedError
+        end
+        
+        private
+        MESSAGE_SET_NAMES_TO_CLASSES = 
+        {
+            'SIGNON'        => SignonMessageSet,
+            'SIGNUP'        => SignupMessageSet,
+            'PROF'          => FinancialInstitutionProfileMessageSet,
+            'BANK'          => BankingMessageSet,
+            'CREDITCARD'    => CreditCardStatementMessageSet
+        }
+    end
+    
+    class MessageSetProfile        
+        def from_ofx_102_hash(message_set_description_hash)           
+            message_set_core_hash = message_set_description_hash['MSGSETCORE']
+            @version = OFX::Version.new(message_set_core_hash['VER'])
+            @service_provider_name = message_set_core_hash['SPNAME']
+            @message_url = URI.parse(message_set_core_hash['URL']) if message_set_core_hash['URL']
+            @required_ofx_security = message_set_core_hash['OFXSEC']
+            @requires_transport_security = message_set_core_hash['TRANSPSEC'] == 'Y' ? true : false
+            @signon_realm = message_set_core_hash['SIGNONREALM']
+            @language = message_set_core_hash['LANGUAGE']
+            @synchronization_mode = message_set_core_hash['SYNCMODE']
+            @supports_response_file_error_recovery = message_set_core_hash['RESPFILEER'] == 'Y' ? true : false
+        end
+    end
+
+    class Request
+        def to_ofx_102_s
+            request = ''
+            request += "    <#{ofx_102_name}RQ>\n"
+
+            request += ofx_102_request_body + "\n"
+
+            request += "    </#{ofx_102_name}RQ>"
+            request
+        end
+
+        def ofx_102_request_body
+            raise NotImplementedError
+        end
+    end
+
+    class TransactionalRequest < Request
+        def to_ofx_102_s
+            request = ''
+            request += "    <#{ofx_102_name}TRNRQ>\n"
+
+            request += "      <TRNUID>#{transaction_identifier}\n"
+            request += "      <CLTCOOKIE>#{client_cookie}\n" if client_cookie
+            request += "      <TAN>#{transaction_authorization_number}\n" if transaction_authorization_number
+
+            request += "      <#{ofx_102_name}RQ>\n"
+
+            request += ofx_102_request_body + "\n"
+
+            request += "      </#{ofx_102_name}RQ>\n"
+
+            request += "    </#{ofx_102_name}TRNRQ>"
+            request
+        end
+
+        def ofx_102_request_body
+            raise NotImplementedError
+        end
+    end
+    
+    class Response
+        def to_ofx_102_s
+            response = ''
+            response += "    <#{ofx_102_name}RS>\n"
+
+            response += ofx_102_response_body + "\n"
+
+            response += "    </#{ofx_102_name}RS>"
+            response
+        end
+
+        def ofx_102_response_body
+            raise NotImplementedError
+        end
+    end
+
+    class TransactionalResponse < Response
+        def to_ofx_102_s
+            response = ''
+            response += "    <#{ofx_102_name}TRNRS>\n"
+
+            response += "      <TRNUID>#{transaction_identifier}\n"
+            response += "      <CLTCOOKIE>#{client_cookie}\n" if client_cookie
+
+            response += "      <#{ofx_102_name}RS>\n"
+
+            response += ofx_102_response_body + "\n"
+
+            response += "      </#{ofx_102_name}RS>\n"
+
+            response += "    </#{ofx_102_name}TRNRS>"
+            response
+        end
+
+        def ofx_102_response_body
+            raise NotImplementedError
+        end
+    end
+end

data/lib/ofx/1.0.2/ofx_102.racc

@@ -0,0 +1,90 @@
+# Copyright © 2007 Chris Guidry <chrisguidry@gmail.com>
+#
+# This file is part of OFX for Ruby.
+# 
+# OFX for Ruby is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# OFX for Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+class OFX::OFX102::Parser
+    
+    rule
+    target        :
+    | ofx_body
+    
+    ofx_body      : tag_from  contents  tag_to
+    
+    tag_from      : tag_in  element tag_out		{ start_tag(val[1]) }
+    tag_to        : etag_in element tag_out		{ end_tag(val[1]) }
+    
+    contents      : /* none */
+    | contents  content
+    
+    content       : text
+    | aggregate
+    | value
+    
+    aggregate     : tag_from  contents  tag_to
+    value         : tag_from  text				{ data_value(val[1])  }
+    
+end
+
+---- header ----
+#
+# generated by racc
+#
+require File.dirname(__FILE__) + '/lexer'
+
+---- inner ----
+
+attr :documents
+attr :ofx_hashes
+
+def initialize
+    @documents = []
+    @ofx_hashes = []
+    
+    @tags_stack = []
+end
+
+private
+def start_tag(tag_name)
+    # push an empty aggregate/value tag
+    @tags_stack.push({ tag_name => {} })
+end
+
+def data_value(value)
+    # pop the most recent tag, and use it's name as the key in the next higher tag's hash
+    tag = @tags_stack.pop
+    @tags_stack.last[@tags_stack.last.keys[0]][tag.keys[0]] = CGI::unescapeHTML(value)
+end
+
+def end_tag(tag_name)
+    # pop the most recent tag, stop and recognize this as a full document if this is the last tag; otherwise,
+    # use this tag's naem as the key in the next higher tag's hash
+    tag = @tags_stack.pop
+    if (@tags_stack.empty?)
+        @ofx_hashes << tag
+        @documents << OFX::Document.from_ofx_102_hash(tag)
+    else
+        previous = @tags_stack.last[@tags_stack.last.keys[0]][tag.keys[0]]
+        if previous == nil
+            @tags_stack.last[@tags_stack.last.keys[0]][tag.keys[0]] = tag[tag.keys[0]]
+        elsif previous.kind_of?(Array)
+            previous << tag[tag.keys[0]]
+        else
+            @tags_stack.last[@tags_stack.last.keys[0]][tag.keys[0]] = [previous, tag[tag.keys[0]]]
+        end
+    end
+end
+
+---- footer ----