ofx_for_ruby 0.1.1

data/lib/ofx/1.0.2/signup_message_set.rb

@@ -0,0 +1,186 @@
+# 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 ofx_102_message_set_name
+            'SIGNUP'
+        end
+        
+        def request_or_response_from_ofx_102_tag_name(response_or_request_name)
+            case response_or_request_name
+                when "ACCTINFOTRNRQ" then   AccountInformationRequest.new
+                when "ACCTINFOTRNRS" then   AccountInformationResponse.new
+                else                        raise NotImplementedError, response_or_request_name
+            end
+        end
+        
+        def self.from_ofx_102_hash(message_set_hash)
+            message_set = SignupMessageSet.new
+            
+            message_set_hash.each_pair() do |transaction_name, transaction_hash|
+                case transaction_name
+                    when "ACCTINFOTRNRQ" then   message_set.requests << AccountInformationRequest.from_ofx_102_hash(transaction_hash)
+                    when "ACCTINFOTRNRS" then   message_set.responses << AccountInformationResponse.from_ofx_102_hash(transaction_hash)
+                    else                        raise NotImplementedError, transaction_name
+                end
+            end
+            
+            return message_set
+        end
+    end
+    
+    class SignupMessageSetProfile < MessageSetProfile
+        def self.from_ofx_102_hash(message_set_description_hash)
+            profile = OFX::SignupMessageSetProfile.new
+            profile.message_set_class = OFX::SignupMessageSet
+            profile.from_ofx_102_hash(message_set_description_hash)
+            
+            if (message_set_description_hash['CLIENTENROLL'])
+                profile.enrollment = OFX::ClientEnrollment.new((message_set_description_hash['CLIENTENROLL']['ACCTREQUIRED'] == 'Y'))
+            elsif (message_set_description_hash['WEBENROLL'])
+                profile.enrollment = OFX::WebEnrollment.new(URI.parse(message_set_description_hash['WEBENROLL']['URL']))
+            elsif (message_set_description_hash['OTHERENROLL'])
+                profile.enrollment = OFX::OtherEnrollment.new(message_set_description_hash['OTHERENROLL']['MESSAGE'])
+            end
+            
+            profile.user_information_changes_allowed = message_set_description_hash['CHGUSERINFO'] == 'Y'
+            profile.available_account_requests_allowed = message_set_description_hash['AVAILACCTS'] == 'Y'
+            profile.service_activation_requests_allowed = message_set_description_hash['CLIENTACTREQ'] == 'Y'
+            
+            profile
+        end
+    end
+    class SignupMessageSetProfile < MessageSetProfile
+        def self.message_set_class
+            SignupMessageSet
+        end
+        
+        attr_accessor :enrollment
+    end
+    class Enrollment
+    end
+    class ClientEnrollment < Enrollment
+        attr_accessor :account_number_required
+        def account_number_required?
+            @account_number_required
+        end
+    end
+    class WebEnrollment < Enrollment
+        attr_accessor :url
+    end
+    class OtherEnrollment < Enrollment
+        attr_accessor :message
+    end
+    
+    class AccountInformationRequest < TransactionalRequest
+        def ofx_102_name
+            'ACCTINFO'
+        end
+        
+        def ofx_102_request_body
+            "      <DTACCTUP>#{date_of_last_account_update.to_ofx_102_s}"
+        end
+        
+        def self.from_ofx_102_hash(request_hash)
+            raise NotImplementedError
+        end
+    end
+    
+    class AccountInformationResponse < TransactionalResponse
+        def ofx_102_name
+            'ACCTINFO'
+        end
+        
+        def ofx_102_response_body
+            raise NotImplementedError
+        end
+        
+        def self.from_ofx_102_hash(transaction_hash)
+            response = AccountInformationResponse.new
+                       
+            response.transaction_identifier = transaction_hash['TRNUID']
+            response.status = OFX::Status.from_ofx_102_hash(transaction_hash['STATUS'])
+            
+            response_hash = transaction_hash['ACCTINFORS']
+            response.date_of_last_account_update = response_hash['DTACCTUP'].to_datetime
+            
+            response.accounts = []
+            account_infos = response_hash['ACCTINFO'] if response_hash['ACCTINFO'].kind_of?(Array)
+            account_infos = [response_hash['ACCTINFO']] if response_hash['ACCTINFO'].kind_of?(Hash)
+            account_infos = [] unless account_infos
+            account_infos.each do |account_info_hash|
+                account_info = OFX::AccountInformation.new
+                account_info.description = account_info_hash['DESC']
+                account_info.phone_number = account_info_hash['PHONE']
+                
+                if account_info_hash['BANKACCTINFO']
+                    bank_acct_info_hash = account_info_hash['BANKACCTINFO']
+                    account_info.account_information = OFX::BankingAccountInformation.new
+                    
+                    acct_from_hash = bank_acct_info_hash['BANKACCTFROM']
+                    account_info.account_information.account = OFX::BankingAccount.new
+                    account_info.account_information.account.bank_identifier = acct_from_hash['BANKID']
+                    account_info.account_information.account.branch_identifier = acct_from_hash['BRANCHID']
+                    account_info.account_information.account.account_identifier = acct_from_hash['ACCTID']
+                    account_info.account_information.account.account_type = case acct_from_hash['ACCTTYPE']
+                                                                                when 'CHECKING' then :checking
+                                                                                when 'SAVINGS' then :savings
+                                                                                when 'MONEYMRKT' then :money_market
+                                                                                when 'CREDITLINE' then :line_of_credit
+                                                                                else raise NotImplementedError
+                                                                            end
+                    account_info.account_information.account.account_key = acct_from_hash['ACCTKEY']
+                    
+                    account_info.account_information.supports_transaction_detail_downloads = bank_acct_info_hash['SUPTXDL'] == 'Y'
+                    account_info.account_information.transfer_source = bank_acct_info_hash['XFERSRC'] == 'Y'
+                    account_info.account_information.transfer_destination = bank_acct_info_hash['XFERDEST'] == 'Y'
+                    account_info.account_information.status = case bank_acct_info_hash['SVCSTATUS']
+                                                                when 'AVAIL' then :available
+                                                                when 'PEND' then :pending
+                                                                when 'ACTIVE' then :active
+                                                                else raise NotImplementedError
+                                                              end
+                elsif account_info_hash['CCACCTINFO']
+                    cc_acct_info_hash = account_info_hash['CCACCTINFO']
+                    account_info.account_information = OFX::CreditCardAccountInformation.new
+                    
+                    acct_from_hash = cc_acct_info_hash['CCACCTFROM']
+                    account_info.account_information.account = OFX::CreditCardAccount.new
+                    account_info.account_information.account.account_identifier = acct_from_hash['ACCTID']
+                    account_info.account_information.account.account_key = acct_from_hash['ACCTKEY']
+                    
+                    account_info.account_information.supports_transaction_detail_downloads = cc_acct_info_hash['SUPTXDL'] == 'Y'
+                    account_info.account_information.transfer_source = cc_acct_info_hash['XFERSRC'] == 'Y'
+                    account_info.account_information.transfer_destination = cc_acct_info_hash['XFERDEST'] == 'Y'
+                    account_info.account_information.status = case cc_acct_info_hash['SVCSTATUS']
+                                                                when 'AVAIL' then :available
+                                                                when 'PEND' then :pending
+                                                                when 'ACTIVE' then :active
+                                                                else raise NotImplementedError
+                                                              end
+                else
+                    raise NotImplementedError
+                end
+                
+                response.accounts << account_info
+            end
+            
+            response
+        end
+    end
+end

data/lib/ofx/1.0.2/statements.rb

@@ -0,0 +1,54 @@
+# 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
+        def self.from_ofx_102_hash(balance_hash)
+            balance = Balance.new
+        
+            balance.amount = balance_hash['BALAMT']
+            balance.as_of = balance_hash['DTASOF'].to_datetime
+            
+            balance
+        end
+    end
+    
+    class Transaction
+        def self.ofx_102_transaction_type_name_to_transaction_type(transaction_type_name)
+            case transaction_type_name
+                when 'CREDIT'       then :credit
+                when 'DEBIT'        then :debit
+                when 'INT'          then :interest
+                when 'DIV'          then :dividend
+                when 'FEE'          then :fee
+                when 'SRVCHG'       then :service_charge
+                when 'DEP'          then :deposit
+                when 'ATM'          then :automated_teller_machine
+                when 'POS'          then :point_of_sale
+                when 'XFER'         then :transfer
+                when 'CHECK'        then :check
+                when 'PAYMENT'      then :electronic_payment
+                when 'CASH'         then :cash_withdrawal
+                when 'DIRECTDEP'    then :direct_deposit
+                when 'DIRECTDEBIT'  then :direct_debit
+                when 'REPEATPMT'    then :repeating_payment
+                when 'OTHER'        then :other
+                else raise NotImplementedError
+            end
+        end
+    end
+end

data/lib/ofx/1.0.2/status.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 Status       
+        def self.from_ofx_102_hash(status_hash)
+            return OFX::Status.from_numerical_code_severity_and_message(status_hash['CODE'].to_i,
+                                                                        case status_hash['SEVERITY']
+                                                                            when 'INFO' then :information
+                                                                            when 'WARN' then :warning
+                                                                            when 'ERROR' then :error
+                                                                        end,
+                                                                        status_hash['MESSAGE'])
+        end
+    end
+end

data/lib/ofx/1.0.2/wire_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 WireFundsTransferMessageSet < MessageSet
+    end
+    
+    class WireFundsTransferMessageSetProfile < MessageSetProfile
+        def self.from_ofx_102_hash(message_set_description_hash)
+            profile = OFX::WireFundsTransferMessageSetProfile.new
+            profile.message_set_class = OFX::WireFundsTransferMessageSet
+            profile.from_ofx_102_hash(message_set_description_hash)
+            profile
+        end
+    end
+end

data/lib/ofx/banking_message_set.rb

@@ -0,0 +1,125 @@
+# 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 BankingMessageSet < MessageSet
+        def precedence
+            3
+        end
+        def version
+            1
+        end
+    end
+    
+    class BankingMessageSetProfile < MessageSetProfile
+        def self.message_set_class
+            OFX::BankingMessageSet
+        end
+        
+        attr_accessor :invalid_account_types
+        attr_accessor :closing_statement_available
+        def closing_statement_available?
+            closing_statement_available
+        end
+
+        attr_accessor :intrabank_transfer_profile
+        attr_accessor :stop_check_profile
+        attr_accessor :email_profile
+    end
+    class IntrabankTransferProfile
+        attr_accessor :processing_days_off
+        attr_accessor :processing_end_time_of_day
+        attr_accessor :supports_scheduled_transfers
+        def supports_scheduled_transfers?
+            supports_scheduled_transfers
+        end
+        attr_accessor :supports_recurring_transfers
+        def supports_recurring_transfers?
+            supports_recurring_transfers
+        end
+        attr_accessor :supports_modification_of_transfers
+        def supports_modification_of_transfers?
+            supports_modification_of_transfers
+        end
+        attr_accessor :supports_modification_of_models
+        def supports_modification_of_models?
+            supports_modification_of_models
+        end
+        attr_accessor :model_window
+        attr_accessor :number_of_days_early_funds_are_withdrawn
+        attr_accessor :default_number_of_days_to_pay
+    end
+    class StopCheckProfile
+        attr_accessor :processing_days_off
+        attr_accessor :processing_end_time_of_day
+        attr_accessor :can_stop_a_range_of_checks
+        def can_stop_a_range_of_checks?
+            can_stop_a_range_of_checks
+        end
+        attr_accessor :can_stop_checks_by_description
+        def can_stop_checks_by_description?
+            can_stop_checks_by_description
+        end
+        attr_accessor :default_stop_check_fee
+    end
+    class BankingEmailProfile
+        attr_accessor :supports_banking_email
+        def supports_banking_email?
+            supports_banking_email
+        end
+        attr_accessor :supports_notifications
+        def supports_notifications?
+            supports_notifications
+        end
+    end
+    
+    class BankingAccount
+        attr_accessor :bank_identifier
+        attr_accessor :branch_identifier
+        attr_accessor :account_identifier
+        attr_accessor :account_type
+        attr_accessor :account_key
+    end
+    class BankingAccountInformation
+        attr_accessor :account
+        attr_accessor :supports_transaction_detail_downloads
+        attr_accessor :transfer_source
+        attr_accessor :transfer_destination
+        attr_accessor :status
+    end
+    
+    
+    class BankingStatementRequest < TransactionalRequest
+        attr_accessor :account
+        attr_accessor :include_transactions
+        def include_transactions?
+            include_transactions
+        end
+        attr_accessor :included_range
+    end
+    class BankingStatementResponse < TransactionalResponse
+        attr_accessor :default_currency
+        attr_accessor :account
+        attr_accessor :marketing_information
+        
+        attr_accessor :ledger_balance
+        attr_accessor :available_balance
+        
+        attr_accessor :transaction_range
+        attr_accessor :transactions
+    end
+end

data/lib/ofx/credit_card_statement_message_set.rb

@@ -0,0 +1,104 @@
+# 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 CreditCardStatementMessageSet < MessageSet
+        def precedence
+            4
+        end
+        def version
+            1
+        end
+    end
+    
+    class CreditCardStatementMessageSetProfile < MessageSetProfile
+        def self.message_set_class
+            CreditCardStatementMessageSet
+        end
+        
+        attr_accessor :closing_statement_available
+        def closing_statement_available?
+            closing_statement_available
+        end
+    end
+    
+    class CreditCardAccount
+        attr_accessor :account_identifier
+        attr_accessor :account_key
+    end
+    class CreditCardAccountInformation
+        attr_accessor :account
+        attr_accessor :supports_transaction_detail_downloads
+        attr_accessor :transfer_source
+        attr_accessor :transfer_destination
+        attr_accessor :status
+    end
+    
+    class CreditCardStatementRequest < TransactionalRequest
+        attr_accessor :account
+        attr_accessor :include_transactions
+        def include_transactions?
+            include_transactions
+        end
+        attr_accessor :included_range
+    end
+    class CreditCardStatementResponse < TransactionalResponse
+        attr_accessor :default_currency
+        attr_accessor :account
+        attr_accessor :marketing_information
+        
+        attr_accessor :ledger_balance
+        attr_accessor :available_balance
+        
+        attr_accessor :transaction_range
+        attr_accessor :transactions
+    end
+    
+    class CreditCardClosingStatementRequest < TransactionalRequest
+        attr_accessor :account
+        attr_accessor :statement_range
+    end
+    class CreditCardClosingStatementResponse < TransactionalResponse
+        attr_accessor :default_currency
+        attr_accessor :account
+        
+        attr_accessor :statements
+    end
+    class CreditCardClosingStatement
+        attr_accessor :currency
+        
+        attr_accessor :finanical_institution_transaction_identifier
+        attr_accessor :statement_range
+        attr_accessor :next_statement_close
+
+        attr_accessor :opening_balance
+        attr_accessor :closing_balance
+        
+        attr_accessor :payment_due_date
+        attr_accessor :minimum_payment_due
+
+        attr_accessor :finance_charge
+        attr_accessor :total_of_payments_and_charges
+        attr_accessor :total_of_purchases_and_advances
+        attr_accessor :debit_adjustements
+        attr_accessor :credit_limit
+        
+        attr_accessor :transaction_range
+        
+        attr_accessor :marketing_information
+    end
+end