ofx_for_ruby 0.1.1

data/lib/ofx/signup_message_set.rb

@@ -0,0 +1,84 @@
+# 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 SignupMessageSet < MessageSet
+        def precedence
+            2
+        end
+        def version
+            1
+        end
+    end
+    
+    class SignupMessageSetProfile < MessageSetProfile
+        def self.message_set_class
+            SignupMessageSet
+        end
+        
+        attr_accessor :enrollment
+        attr_accessor :user_information_changes_allowed
+        def user_information_changes_allowed?
+            user_information_changes_allowed
+        end
+        attr_accessor :available_account_requests_allowed
+        def available_account_requests_allowed?
+            available_account_requests_allowed
+        end
+        attr_accessor :service_activation_requests_allowed
+        def service_activation_requests_allowed?
+            service_activation_requests_allowed
+        end
+    end
+    class Enrollment
+    end
+    class ClientEnrollment < Enrollment
+        attr_accessor :account_number_required
+        def account_number_required?
+            @account_number_required
+        end
+        def initialize(account_number_required)
+            @account_number_required = account_number_required
+        end
+    end
+    class WebEnrollment < Enrollment
+        attr_accessor :url
+        def initialize(url)
+            @url = url
+        end
+    end
+    class OtherEnrollment < Enrollment
+        attr_accessor :message
+        def initialize(message)
+            @message = message
+        end
+    end
+    
+    class AccountInformationRequest < TransactionalRequest
+        attr_accessor :date_of_last_account_update
+    end
+    class AccountInformationResponse < TransactionalResponse
+        attr_accessor :date_of_last_account_update
+        attr_accessor :accounts
+    end
+    
+    class AccountInformation
+        attr_accessor :description
+        attr_accessor :phone_number
+        attr_accessor :account_information
+    end
+end

data/lib/ofx/statements.rb

@@ -0,0 +1,49 @@
+# 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 Balance
+        attr_accessor :amount
+        attr_accessor :as_of
+    end
+    
+    class Transaction
+        attr_accessor :transaction_type
+        
+        attr_accessor :date_posted
+        attr_accessor :date_initiated
+        attr_accessor :date_available
+        
+        attr_accessor :amount
+        attr_accessor :currency
+        
+        attr_accessor :financial_institution_transaction_identifier
+        attr_accessor :corrected_financial_institution_transaction_identifier
+        attr_accessor :correction_action
+        attr_accessor :server_transaction_identifier
+        attr_accessor :check_number
+        attr_accessor :reference_number
+        
+        attr_accessor :standard_industrial_code
+        
+        attr_accessor :payee_identifier
+        attr_accessor :payee
+        attr_accessor :transfer_destination_account
+        
+        attr_accessor :memo
+    end
+end

data/lib/ofx/status.rb

@@ -0,0 +1,100 @@
+# 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 Status
+        attr_accessor :code
+        attr_accessor :severity
+        attr_accessor :message
+        
+        def initialize(code, severity, message)
+            @code = code
+            @severity = severity
+            @message = message
+        end
+        
+        def self.from_numerical_code_severity_and_message(code, severity, message)
+            status_class = CODES_TO_OFX_STATUS[code] || SEVERITIES_TO_UNKNOWN_OFX_STATUS[severity]
+            raise unless status_class
+            
+            status_class.new(code, severity, message)
+        end
+    end
+
+    class Information < Status
+    end
+    class Warning < Status
+    end
+    class Error < Status
+    end
+    
+    class UnknownInformation < Information
+    end
+    class UnknownWarning < Warning
+    end
+    class UnknownError < Error
+    end
+    
+    # general statuses
+    class Success < Information
+    end
+    class GeneralError < Error
+    end
+    class UnsupportedVersion < Error
+    end
+    
+    # signon message set
+    class MustChangePassword < Information
+    end
+    class SignonInvalid < Error
+    end
+    class CustomerAccountAlreadyInUse < Error
+    end
+    class AccountLockedOut < Error
+    end
+    
+    # financial institution profile message set
+    class ClientUpToDate < Information
+    end
+    
+    # build tables of the status subclasses
+    class Status
+        private
+        SEVERITIES_TO_UNKNOWN_OFX_STATUS =
+        {
+            :information    => UnknownInformation,
+            :warning        => UnknownWarning,
+            :error          => UnknownError
+        }
+        CODES_TO_OFX_STATUS =
+        {
+            # general codes
+            0       => Success,
+            2000    => GeneralError,
+            2021    => UnsupportedVersion,
+            
+            # signon message set
+            15000   => MustChangePassword,
+            15500   => SignonInvalid,
+            15501   => CustomerAccountAlreadyInUse,
+            15502   => AccountLockedOut,
+            
+            # financial institution profile message set
+            1       => ClientUpToDate
+        }
+    end
+end

data/lib/ofx/transaction_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 TransactionUniqueIdentifier
+        def initialize
+            @timestamp = DateTime.now
+        end
+
+        def to_s
+            @timestamp.strftime('%Y%m%d%H%M%S')
+        end
+    end
+end

data/lib/ofx/version.rb

@@ -0,0 +1,82 @@
+# 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 Version
+        include Comparable
+
+        def initialize(version)
+            @version = [0, 0, 0]
+
+            version = version.to_a if version.kind_of?(Version)
+
+            @version[0] = version if version.kind_of?(Integer)
+            return unless version.respond_to?(:length)
+
+            @version[0] = version[0..0].to_s.to_i if (version.length >= 1)
+
+            if (version.length == 3)
+                @version[1] = version[1..1].to_s.to_i
+                @version[2] = version[2..2].to_s.to_i
+            elsif (version.length == 5)
+                @version[1] = version[2..2].to_s.to_i
+                @version[2] = version[4..4].to_s.to_i
+            end
+        end
+
+        def major
+            @version[0]
+        end
+
+        def minor
+            @version[1]
+        end
+
+        def revision
+            @version[2]
+        end
+
+        def to_dotted_s
+            @version.join('.')
+        end
+        def to_compact_s
+            @version.join('')
+        end
+
+        def to_a
+            @version.dup
+        end
+
+        def empty?
+            @version == [0, 0, 0]
+        end
+
+        def <=> (other)
+            @version <=> other.to_a
+        end
+        def eql?(other)
+            other_a = other.to_a
+            
+            return @version[0] == other_a[0] && @version[1] == other_a[1] && @version[2] == other_a[2]
+        end
+        def hash()
+            return @version.hash
+        end
+    end
+    
+    VERSION = Version.new('0.1.1')
+end

data/lib/ofx/wire_funds_transfer_message_set.rb

@@ -0,0 +1,33 @@
+# 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 WireFundsTransferMessageSet < MessageSet
+        def precedence
+            7
+        end
+        def version
+            1
+        end
+    end
+    
+    class WireFundsTransferMessageSetProfile < MessageSetProfile
+        def self.message_set_class
+            WireFundsTransferMessageSet
+        end
+    end
+end

data/ofx_for_ruby.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ofx/version"
+
+Gem::Specification.new do |s|
+  s.name = "ofx_for_ruby"
+  s.version = OFX::VERSION.to_dotted_s
+  s.platform = Gem::Platform::RUBY
+  
+  s.authors = ["Chris Guidry"]
+  s.description = "OFX for Ruby is a pure Ruby implementation of Open Financial Exchange specifications (1.0.2 through 2.1.1) for building both financial clients and servers, providing parsers/serializers for each version, and a uniform object model across all versions."
+  s.email = ["chrisguidry@gmail.com"]
+  s.summary = "Pure Ruby implementation of Open Financial Exchange specifications"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.homepage    = "http://github.com/baconpat/ofx_for_ruby"
+  
+  s.add_dependency "activesupport"
+  
+  s.add_development_dependency "racc"
+  s.add_development_dependency "rex"
+  s.add_development_dependency "rcov"
+end

data/test/capital_one/capital_one_helper.rb

@@ -0,0 +1,77 @@
+# 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 File.dirname(__FILE__) + '/../test_helper'
+
+require 'uri'
+
+module CapitalOneHelper
+
+    def setup_capital_one_credentials()
+        File.open(File.dirname(__FILE__) + '/fixtures/capital-one-credentials') do |file|
+            @user_name, @password = file.gets.split(',')
+        end
+    end
+    
+    def setup_capital_one_accounts()
+        File.open(File.dirname(__FILE__) + '/fixtures/capital-one-accounts') do |file|
+            @accounts = {}
+            file.each_line do |line|
+                type, account = line.split(',')
+                @accounts[type.chomp.to_sym] = account.chomp
+            end
+        end
+    end
+
+    def verify_capital_one_header(response_document)
+        assert_not_equal(nil, response_document.header)
+        assert_equal(OFX::Version.new("1.0.0"), response_document.header.header_version)
+        assert_equal('OFXSGML', response_document.header.content_type)
+        assert_equal(OFX::Version.new("1.0.2"), response_document.header.document_version)
+        assert_equal('NONE', response_document.header.security)
+        assert_equal('USASCII', response_document.header.content_encoding)
+        assert_equal('1252', response_document.header.content_character_set)
+        assert_equal('NONE', response_document.header.compression)
+        assert_not_equal(nil, response_document.header.unique_identifier)
+        assert_not_equal(nil, response_document.header.previous_unique_identifier)
+    end
+    
+    def verify_capital_one_signon_response(response_document)
+        signon_message = response_document.message_sets[0]
+        assert signon_message.kind_of?(OFX::SignonMessageSet)
+        assert_equal(1, signon_message.responses.length)
+        
+        signon_response = signon_message.responses[0]
+        assert signon_response.kind_of?(OFX::SignonResponse)
+        assert_not_equal(nil, signon_response.status)
+        assert signon_response.status.kind_of?(OFX::Information)
+        assert signon_response.status.kind_of?(OFX::Success)
+        assert_equal(0, signon_response.status.code)
+        assert_equal(:information, signon_response.status.severity)
+        assert_not_equal(nil, signon_response.status.message)
+        assert_not_equal(nil, signon_response.date)
+        assert_equal(nil, signon_response.user_key)
+        assert_equal('ENG', signon_response.language)
+        assert_not_equal(nil, signon_response.date_of_last_profile_update)
+        assert_not_equal(nil, signon_response.date_of_last_account_update)
+        assert_not_equal(nil, signon_response.financial_institution_identification)
+        assert_equal('Hibernia', signon_response.financial_institution_identification.organization)
+        assert_equal('1001', signon_response.financial_institution_identification.financial_institution_identifier)
+        assert_equal(nil, signon_response.session_cookie)
+    end
+    
+end