ofx_for_ruby 0.1.1

data/lib/ofx/document.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 Document
+
+        attr_accessor :header
+        attr :message_sets
+
+        def initialize
+            @header = OFX::Header.new
+            @message_sets = []
+        end
+
+    end
+end

data/lib/ofx/email_message_set.rb

@@ -0,0 +1,42 @@
+# 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 EmailMessageSet < MessageSet
+        def precedence
+            9
+        end
+        def version
+            1
+        end
+    end
+    
+    class EmailMessageSetProfile < MessageSetProfile
+        def self.message_set_class
+            EmailMessageSet
+        end
+        
+        attr_accessor :supports_email
+        def supports_email?
+            supports_email
+        end
+        attr_accessor :supports_mime_messages
+        def supports_mime_messages?
+            supports_mime_messages
+        end
+    end
+end

data/lib/ofx/file_unique_identifier.rb

@@ -0,0 +1,28 @@
+# 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 FileUniqueIdentifier
+        def initialize
+            @timestamp = DateTime.now
+        end
+
+        def to_s
+            @timestamp.strftime('%Y%m%d%H%M%S')
+        end
+    end
+end

data/lib/ofx/financial_client.rb

@@ -0,0 +1,76 @@
+# 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/>.
+
+require 'date'
+
+module OFX
+    class FinancialClient
+
+        @financial_institutions_and_credentials = []
+        
+        attr_accessor :date_of_last_profile_update
+
+        def initialize(financial_institutions_and_credentials)
+            @financial_institutions_and_credentials = financial_institutions_and_credentials
+        end
+
+        def financial_institution_identification_for(financial_institution_id)
+            @financial_institutions_and_credentials.each do |pair|
+                return pair[0] if (pair[0].financial_institution_identifier == financial_institution_id)
+            end
+            return nil
+        end
+        def user_identification_for(financial_institution_id)
+            @financial_institutions_and_credentials.each do |pair|
+                return pair[1] if (pair[0].financial_institution_identifier == financial_institution_id)
+            end
+            return nil
+        end
+
+        def application_identification
+            OFX::ApplicationIdentification.new('OFX', '0010')
+        end
+
+        def create_signon_request_message(financial_institution_id)
+            signonMessageSet = OFX::SignonMessageSet.new
+
+            signonRequest = OFX::SignonRequest.new
+            signonRequest.date = DateTime.now
+            signonRequest.user_identification = self.user_identification_for(financial_institution_id)
+            signonRequest.generate_user_key = false
+            signonRequest.language = "ENG"
+            signonRequest.financial_institution_identification = self.financial_institution_identification_for(financial_institution_id)
+            signonRequest.session_cookie = nil
+            signonRequest.application_identification = self.application_identification
+            signonMessageSet.requests << signonRequest
+
+            signonMessageSet
+        end
+        
+        def create_profile_update_request_message()
+            profileMessageSet = OFX::FinancialInstitutionProfileMessageSet.new
+            
+            profileRequest = OFX::FinancialInstitutionProfileRequest.new
+            profileRequest.transaction_identifier = OFX::TransactionUniqueIdentifier.new
+            profileRequest.client_routing = 'MSGSET'
+            profileRequest.date_of_last_profile_update = self.date_of_last_profile_update
+            profileMessageSet.requests << profileRequest
+            
+            profileMessageSet
+        end
+    end
+end

data/lib/ofx/financial_institution.rb

@@ -0,0 +1,83 @@
+# 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/>.
+
+require 'uri'
+
+module OFX
+    class FinancialInstitution
+
+        def self.get_institution(financial_institution_name)
+            case financial_institution_name
+                when 'Capital One'
+                    FinancialInstitution.new('Capital One',
+                                             URI.parse('https://onlinebanking.capitalone.com/scripts/serverext.dll'),
+                                             OFX::Version.new("1.0.2"))
+                when 'Citi'
+                    FinancialInstitution.new('Citi',
+                                             URI.parse('https://secureofx2.bankhost.com/citi/cgi-forte/ofx_rt?servicename=ofx_rt&pagename=ofx'),
+                                             OFX::Version.new("1.0.2"))
+                else
+                    raise NotImplementedError
+            end
+        end
+
+        attr :name
+        attr :ofx_uri
+        attr :ofx_version
+
+        def initialize(name, ofx_uri, ofx_version)
+            @name = name
+            @ofx_uri = ofx_uri
+            @ofx_version = ofx_version
+        end
+
+        def create_request_document()
+            document = OFX::Document.new
+
+            case ofx_version
+                when OFX::Version.new("1.0.2")
+                    document.header.header_version = OFX::Version.new("1.0.0")
+                    document.header.content_type = "OFXSGML"
+                    document.header.document_version = OFX::Version.new("1.0.2")
+                else
+                    raise NotImplementedError
+            end
+
+            document.header.security = "NONE"
+
+            document.header.content_encoding = "USASCII"
+            document.header.content_character_set = "1252"
+
+            document.header.compression = "NONE"
+
+            document.header.previous_unique_identifier = "NONE"
+            document.header.unique_identifier = OFX::FileUniqueIdentifier.new
+
+            document
+        end
+
+        def send(document)
+            serializer = OFX::Serializer.get(@ofx_version)
+            request_body = serializer.to_http_post_body(document)
+
+            client = OFX::HTTPClient.new(@ofx_uri)
+            response_body = client.send(request_body)
+
+            return serializer.from_http_response_body(response_body)
+        end
+    end
+end

data/lib/ofx/financial_institution_profile_message_set.rb

@@ -0,0 +1,67 @@
+# 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 FinancialInstitutionProfileMessageSet < MessageSet
+        def precedence
+            11
+        end
+        def version
+            1
+        end
+    end
+    
+    class FinancialInstitutionProfileMessageSetProfile < MessageSetProfile
+        def self.message_set_class
+            FinancialInstitutionProfileMessageSet
+        end
+    end
+    
+    class SignonRealm
+        attr_accessor :name
+        attr_accessor :password_length_constraint
+        attr_accessor :password_characters_constraint
+        attr_accessor :case_sensitive
+        attr_accessor :allows_special_characters
+        attr_accessor :allows_spaces
+        attr_accessor :supports_pin_changes
+        attr_accessor :requires_initial_pin_change
+    end
+
+    class FinancialInstitutionProfileRequest < TransactionalRequest
+        attr_accessor :client_routing
+        attr_accessor :date_of_last_profile_update
+    end
+    
+    class FinancialInstitutionProfileResponse < TransactionalResponse
+        attr_accessor :message_sets
+        attr_accessor :signon_realms
+
+        attr_accessor :date_of_last_profile_update
+        attr_accessor :financial_institution_name
+        attr_accessor :address
+        attr_accessor :city
+        attr_accessor :state
+        attr_accessor :postal_code
+        attr_accessor :country
+        attr_accessor :customer_service_telephone
+        attr_accessor :technical_support_telephone
+        attr_accessor :facsimile_telephone
+        attr_accessor :url
+        attr_accessor :email_address
+    end
+end

data/lib/ofx/header.rb

@@ -0,0 +1,115 @@
+# 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
+
+    # = Summary
+    # The OFX headers for one message.  The headers provide metadata about
+    # the OFX request/response, including message versioning, security, and
+    # encoding.
+    #
+    # = Specifications
+    # OFX 1.0.2:: 2.2 (pp. 12-14)
+    class Header
+
+        def initialize
+            @headers = {}
+        end
+
+        def [](key)
+            @headers[key]
+        end
+
+        def []=(key, value)
+            @headers[key] = value
+        end
+
+        # The version of this OFX header
+        # OFX 1.0.2:: 2.2.1
+        # OFX 1.0.3:: 2.2.1
+        def header_version
+            OFX::Version.new(@headers['OFXHEADER'])
+        end
+        def header_version=(value)
+            @headers['OFXHEADER'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.2
+        def content_type
+            @headers['DATA']
+        end
+        def content_type=(value)
+            @headers['DATA'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.3
+        def document_version
+            OFX::Version.new(@headers['VERSION'])
+        end
+        def document_version=(value)
+            @headers['VERSION'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.4
+        def security
+            @headers['SECURITY']
+        end
+        def security=(value)
+            @headers['SECURITY'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.5
+        def content_encoding
+            @headers['ENCODING']
+        end
+        def content_encoding=(value)
+            @headers['ENCODING'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.5
+        def content_character_set
+            @headers['CHARSET']
+        end
+        def content_character_set=(value)
+            @headers['CHARSET'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.6
+        def compression
+            @headers['COMPRESSION']
+        end
+        def compression=(value)
+            @headers['COMPRESSION'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.7
+        def unique_identifier
+            @headers['NEWFILEUID']
+        end
+        def unique_identifier=(value)
+            @headers['NEWFILEUID'] = value
+        end
+
+        # OFX 1.0.2:: 2.2.7
+        def previous_unique_identifier
+            @headers['OLDFILEUID']
+        end
+        def previous_unique_identifier=(value)
+            @headers['OLDFILEUID'] = value
+        end
+    end
+end