syrup 0.0.9 → 0.0.10

data/lib/syrup/institutions/zions_bank.rb

@@ -1,178 +1,181 @@
-require 'date'
-
-module Syrup
-  module Institutions
-    class ZionsBank < InstitutionBase
-      
-      class << self
-        def name
-          "Zions Bank"
-        end
-        
-        def id
-          "zions_bank"
-        end
-      end
-      
-      def fetch_account(account_id)
-        fetch_accounts
-      end
-      
-      def fetch_accounts
-        ensure_authenticated
-
-        # List accounts
-        page = agent.get('https://banking.zionsbank.com/ibuir/displayAccountBalance.htm')
-        json = MultiJson.decode(page.body)
-
-        accounts = []
-        json['accountBalance']['depositAccountList'].each do |account|
-          new_account = Account.new(:id => account['accountId'], :institution => self)
-          new_account.name = unescape_html(account['name'])
-          new_account.account_number = account['number']
-          new_account.current_balance = parse_currency(account['currentAmt'])
-          new_account.available_balance = parse_currency(account['availableAmt'])
-          new_account.type = :deposit
-          
-          accounts << new_account
-        end
-        json['accountBalance']['creditAccountList'].each do |account|
-          new_account = Account.new(:id => account['accountId'], :institution => self)
-          new_account.name = unescape_html(account['name'])
-          new_account.account_number = account['number']
-          new_account.current_balance = parse_currency(account['balanceDueAmt'])
-          new_account.type = :credit
-          
-          accounts << new_account
-        end
-
-        accounts
-      end
-      
-      def fetch_transactions(account_id, starting_at, ending_at)
-        ensure_authenticated
-        
-        transactions = []
-        
-        post_vars = { "actAcct" => account_id, "dayRange.searchType" => "dates", "dayRange.startDate" => starting_at.strftime('%m/%d/%Y'), "dayRange.endDate" => ending_at.strftime('%m/%d/%Y'), "submit_view.x" => 11, "submit_view.y" => 11, "submit_view" => "view" }
-        
-        page = agent.post("https://banking.zionsbank.com/zfnb/userServlet/app/bank/user/register_view_main?reSort=false&actAcct=#{account_id}", post_vars)
-        
-        # Get all the transactions
-        page.search('tr').each do |row_element|
-          # Look for the account information first
-          account = find_account_by_id(account_id)
-          datapart = row_element.css('.acct')
-          if datapart && datapart.inner_html.size > 0
-            if match = /Prior Day Balance:\s*([^<]+)/.match(datapart.inner_html)
-              account.prior_day_balance = parse_currency(match[1])
-            end
-            if match = /Current Balance:\s*([^<]+)/.match(datapart.inner_html)
-              account.current_balance = parse_currency(match[1])
-            end
-            if match = /Available Balance:\s*([^<]+)/.match(datapart.inner_html)
-              account.available_balance = parse_currency(match[1])
-            end
-          end
-        
-          data = []
-          datapart = row_element.css('.data')
-          if datapart
-            data += datapart
-            datapart = row_element.css('.curr')
-            data += datapart if datapart
-          end
-          
-          datapart = row_element.css('.datagrey')
-          if datapart
-            data += datapart
-            datapart = row_element.css('.currgrey')
-            data += datapart if datapart
-          end
-          
-          if data.size == 7
-            data.map! {|cell| cell.inner_html.strip.gsub(/[^ -~]/, '') }
-            
-            transaction = Transaction.new
-
-            transaction.posted_at = Date.strptime(data[0], '%m/%d/%Y')
-            transaction.payee = unescape_html(data[2])
-            transaction.status = data[3].include?("Posted") ? :posted : :pending
-            unless data[4].empty?
-              transaction.amount = -parse_currency(data[4])
-            end
-            unless data[5].empty?
-              transaction.amount = parse_currency(data[5])
-            end
-            
-            transactions << transaction
-          end
-        end
-        
-        transactions
-      end
-      
-      private
-      
-      def ensure_authenticated
-        
-        # Check to see if already authenticated
-        page = agent.get('https://banking.zionsbank.com/ibuir/')
-        if page.body.include?("SessionTimeOutException")
-          
-          raise InformationMissingError, "Please supply a username" unless self.username
-          raise InformationMissingError, "Please supply a password" unless self.password
-          
-          # Enter the username
-          page = agent.get('https://www.zionsbank.com')
-          form = page.form('logonForm')
-          form.publicCred1 = username
-          page = form.submit
-          
-          # If the supplied username is incorrect, raise an exception
-          raise InformationMissingError, "Invalid username" if page.title == "Error Page"
-
-          # Go on to the next page
-          page = page.links.first.click
-
-          # Find the secret question
-          question = page.search('div.form_field')[2].css('div').inner_text
-          
-          # If the answer to this question was not supplied, raise an exception
-          raise InformationMissingError, "Please answer the question, \"#{question}\"" unless secret_questions && secret_questions[question]
-          
-          # Enter the answer to the secret question
-          form = page.forms.first
-          form["challengeEntry.answerText"] = secret_questions[question]
-          form.radiobutton_with(:value => 'false').check
-          submit_button = form.button_with(:name => '_eventId_submit')
-          page = form.submit(submit_button)
-          
-          # If the supplied answer is incorrect, raise an exception
-          raise InformationMissingError, "\"#{secret_questions[question]}\" is not the correct answer to, \"#{question}\"" unless page.search('#errorComponent').empty?
-
-          # Enter the password
-          form = page.forms.first
-          form.privateCred1 = password
-          submit_button = form.button_with(:name => '_eventId_submit')
-          page = form.submit(submit_button)
-          
-          # If the supplied password is incorrect, raise an exception
-          raise InformationMissingError, "An invalid password was supplied" unless page.search('#errorComponent').empty?
-
-          # Clicking this link logs us into the banking.zionsbank.com domain
-          page = page.links.first.click
-          
-          if page.uri.to_s != "https://banking.zionsbank.com/ibuir/displayUserInterface.htm"
-            page = agent.get('https://banking.zionsbank.com/zfnb/userServlet/app/bank/user/viewaccountsbysubtype/viewAccount')
-            
-            raise "Unknown URL reached. Try logging in manually through a browser." if page.body.include?("SessionTimeOutException")
-          end
-        end
-        
-        true
-      end
-      
-    end
-  end
-end
+require 'date'
+
+module Syrup
+  module Institutions
+    class ZionsBank < InstitutionBase
+      
+      class << self
+        def name
+          "Zions Bank"
+        end
+        
+        def id
+          "zions_bank"
+        end
+      end
+      
+      def fetch_account(account_id)
+        fetch_accounts
+      end
+      
+      def fetch_accounts
+        ensure_authenticated
+
+        # List accounts
+        page = agent.get('https://banking.zionsbank.com/ibuir/displayAccountBalance.htm')
+        json = MultiJson.decode(page.body)
+
+        accounts = []
+        json['accountBalance']['depositAccountList'].each do |account|
+          new_account = Account.new(:id => account['accountId'], :institution => self)
+          new_account.name = unescape_html(account['name'])
+          new_account.account_number = account['number']
+          new_account.current_balance = parse_currency(account['currentAmt'])
+          new_account.available_balance = parse_currency(account['availableAmt'])
+          new_account.type = :deposit
+          
+          accounts << new_account
+        end
+        json['accountBalance']['creditAccountList'].each do |account|
+          new_account = Account.new(:id => account['accountId'], :institution => self)
+          new_account.name = unescape_html(account['name'])
+          new_account.account_number = account['number']
+          new_account.current_balance = parse_currency(account['balanceDueAmt'])
+          new_account.type = :credit
+          
+          accounts << new_account
+        end
+
+        accounts
+      end
+      
+      def fetch_transactions(account_id, starting_at, ending_at)
+        ensure_authenticated
+        
+        transactions = []
+        
+        post_vars = { "actAcct" => account_id, "dayRange.searchType" => "dates", "dayRange.startDate" => starting_at.strftime('%m/%d/%Y'), "dayRange.endDate" => ending_at.strftime('%m/%d/%Y'), "submit_view.x" => 11, "submit_view.y" => 11, "submit_view" => "view" }
+        
+        page = agent.post("https://banking.zionsbank.com/zfnb/userServlet/app/bank/user/register_view_main?reSort=false&actAcct=#{account_id}", post_vars)
+        
+        # Get all the transactions
+        page.search('tr').each do |row_element|
+          # Look for the account information first
+          account = find_account_by_id(account_id)
+          datapart = row_element.css('.acct')
+          if datapart && datapart.inner_html.size > 0
+            if match = /Prior Day Balance:\s*([^<]+)/.match(datapart.inner_html)
+              account.prior_day_balance = parse_currency(match[1])
+            end
+            if match = /Current Balance:\s*([^<]+)/.match(datapart.inner_html)
+              account.current_balance = parse_currency(match[1])
+            end
+            if match = /Available Balance:\s*([^<]+)/.match(datapart.inner_html)
+              account.available_balance = parse_currency(match[1])
+            end
+          end
+        
+          data = []
+          datapart = row_element.css('.data')
+          if datapart
+            data += datapart
+            datapart = row_element.css('.curr')
+            data += datapart if datapart
+          end
+          
+          datapart = row_element.css('.datagrey')
+          if datapart
+            data += datapart
+            datapart = row_element.css('.currgrey')
+            data += datapart if datapart
+          end
+          
+          if data.size == 7
+            data.map! {|cell| cell.inner_html.strip.gsub(/[^ -~]/, '') }
+            
+            transaction = Transaction.new
+
+            transaction.posted_at = Date.strptime(data[0], '%m/%d/%Y')
+            transaction.payee = unescape_html(data[2])
+            transaction.status = data[3].include?("Posted") ? :posted : :pending
+            unless data[4].empty?
+              transaction.amount = -parse_currency(data[4])
+            end
+            unless data[5].empty?
+              transaction.amount = parse_currency(data[5])
+            end
+            
+            transactions << transaction
+          end
+        end
+        
+        transactions
+      end
+      
+      private
+      
+      def ensure_authenticated
+        
+        # Check to see if already authenticated
+        page = agent.get('https://banking.zionsbank.com/ibuir/')
+        if page.body.include?("SessionTimeOutException")
+          
+          raise InformationMissingError, "Please supply a username" unless self.username
+          raise InformationMissingError, "Please supply a password" unless self.password
+          
+          # Enter the username
+          page = agent.get('https://www.zionsbank.com')
+          form = page.form('logonForm')
+          form.publicCred1 = username
+          page = form.submit
+          
+          # If the supplied username is incorrect, raise an exception
+          raise InformationMissingError, "Invalid username" if page.title == "Error Page"
+
+          # Go on to the next page
+          page = page.links.first.click
+
+          # Skip the secret question if we are prompted for the password
+          unless page.body.include?("Site Validation and Password")
+            # Find the secret question
+            question = page.search('div.form_field')[2].css('div').inner_text
+            
+            # If the answer to this question was not supplied, raise an exception
+            raise InformationMissingError, "Please answer the question, \"#{question}\"" unless secret_questions && secret_questions[question]
+            
+            # Enter the answer to the secret question
+            form = page.forms.first
+            form["challengeEntry.answerText"] = secret_questions[question]
+            form.radiobutton_with(:value => 'false').check
+            submit_button = form.button_with(:name => '_eventId_submit')
+            page = form.submit(submit_button)
+            
+            # If the supplied answer is incorrect, raise an exception
+            raise InformationMissingError, "\"#{secret_questions[question]}\" is not the correct answer to, \"#{question}\"" unless page.search('#errorComponent').empty?
+          end
+
+          # Enter the password
+          form = page.forms.first
+          form.privateCred1 = password
+          submit_button = form.button_with(:name => '_eventId_submit')
+          page = form.submit(submit_button)
+          
+          # If the supplied password is incorrect, raise an exception
+          raise InformationMissingError, "An invalid password was supplied" unless page.search('#errorComponent').empty?
+
+          # Clicking this link logs us into the banking.zionsbank.com domain
+          page = page.links.first.click
+          
+          if page.uri.to_s != "https://banking.zionsbank.com/ibuir/displayUserInterface.htm"
+            page = agent.get('https://banking.zionsbank.com/zfnb/userServlet/app/bank/user/viewaccountsbysubtype/viewAccount')
+            
+            raise "Unknown URL reached. Try logging in manually through a browser." if page.body.include?("SessionTimeOutException")
+          end
+        end
+        
+        true
+      end
+      
+    end
+  end
+end

data/lib/syrup/transaction.rb

@@ -1,20 +1,20 @@
-module Syrup
-  class Transaction
-    ##
-    # :attr_accessor: status
-    # Currently, the only valid types are :posted and :pending
-    
-    #
-    attr_accessor :id, :payee, :amount, :posted_at, :status
-    
-    # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
-    # attributes (pass a hash with key names matching the associated attribute names).
-    def initialize(attr_hash = nil)
-      if attr_hash
-        attr_hash.each do |k, v|
-          instance_variable_set "@#{k}", v
-        end
-      end
-    end
-  end
+module Syrup
+  class Transaction
+    ##
+    # :attr_accessor: status
+    # Currently, the only valid types are :posted and :pending
+    
+    #
+    attr_accessor :id, :payee, :amount, :posted_at, :status
+    
+    # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
+    # attributes (pass a hash with key names matching the associated attribute names).
+    def initialize(attr_hash = nil)
+      if attr_hash
+        attr_hash.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      end
+    end
+  end
 end

data/lib/syrup/version.rb

@@ -1,3 +1,3 @@
-module Syrup
-  VERSION = "0.0.9"
-end
+module Syrup
+  VERSION = "0.0.10"
+end

data/lib/syrup.rb

@@ -1,46 +1,46 @@
-require 'date'
-require 'mechanize'
-require 'multi_json'
-require 'syrup/information_missing_error'
-require 'syrup/account'
-require 'syrup/transaction'
-
-# require all institutions
-require 'syrup/institutions/institution_base'
-Dir[File.dirname(__FILE__) + '/syrup/institutions/*.rb'].each {|file| require file }
-
-module Syrup
-  extend self
-  
-  # Returns an array of institutions.
-  #
-  #   Syrup.institutions.each do |institution|
-  #     puts "name: #{institution.name}, id: #{institution.id}"
-  #   end
-  def institutions
-    Institutions::InstitutionBase.subclasses
-  end
-  
-  # Returns a new institution object with the specified +institution_id+.
-  # If you pass in a block, you can use it to setup the username, password, and secret_questions.
-  #
-  #   Syrup.setup_institution('zions_bank') do |config|
-  #     config.username = "my_user"
-  #     config.password = "my_password"
-  #     config.secret_questions = {
-  #       'How long is your beard?' => '6in'
-  #     }
-  #   end
-  def setup_institution(institution_id)
-    institution = institutions.find { |i| i.id == institution_id }
-    
-    if institution
-      i = institution.new
-      if block_given?
-        i.setup { |config| yield config }
-      else
-        i
-      end
-    end
-  end
-end
+require 'date'
+require 'mechanize'
+require 'multi_json'
+require 'syrup/information_missing_error'
+require 'syrup/account'
+require 'syrup/transaction'
+
+# require all institutions
+require 'syrup/institutions/institution_base'
+Dir[File.dirname(__FILE__) + '/syrup/institutions/*.rb'].each {|file| require file }
+
+module Syrup
+  extend self
+  
+  # Returns an array of institutions.
+  #
+  #   Syrup.institutions.each do |institution|
+  #     puts "name: #{institution.name}, id: #{institution.id}"
+  #   end
+  def institutions
+    Institutions::InstitutionBase.subclasses
+  end
+  
+  # Returns a new institution object with the specified +institution_id+.
+  # If you pass in a block, you can use it to setup the username, password, and secret_questions.
+  #
+  #   Syrup.setup_institution('zions_bank') do |config|
+  #     config.username = "my_user"
+  #     config.password = "my_password"
+  #     config.secret_questions = {
+  #       'How long is your beard?' => '6in'
+  #     }
+  #   end
+  def setup_institution(institution_id)
+    institution = institutions.find { |i| i.id == institution_id }
+    
+    if institution
+      i = institution.new
+      if block_given?
+        i.setup { |config| yield config }
+      else
+        i
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,15 +1,15 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'syrup'
-
-RSpec.configure do |config|
-  include Syrup
-  
-  config.filter_run_excluding :bank_integration => true
-end
-
-module Syrup
-  def spec_resource_path
-    File.dirname(__FILE__) + '/resources/'
-  end
-end
+require 'rubygems'
+require 'bundler/setup'
+require 'syrup'
+
+RSpec.configure do |config|
+  include Syrup
+  
+  config.filter_run_excluding :bank_integration => true
+end
+
+module Syrup
+  def spec_resource_path
+    File.dirname(__FILE__) + '/resources/'
+  end
+end

data/spec/syrup/account_spec.rb

@@ -1,53 +1,53 @@
-require "spec_helper"
-
-describe Account do
-  before(:each) do
-    @institution = double()
-    @institution.stub(:populate_account) do
-      @account.populated = true
-      @account.instance_variable_set :@name, 'my name'
-    end
-    @institution.stub(:fetch_transactions) do
-      [
-        Transaction.new(:id => 1, :payee => 'Wal-Mart', :posted_at => Date.today - 1, :amount => 30.14),
-        Transaction.new(:id => 2, :payee => 'Pizza Hut', :posted_at => Date.today - 2, :amount => 10.23)
-      ]
-    end
-    @account = Account.new :id => 1, :institution => @institution
-  end
-  
-  it "has lots of useful properties" do
-    account = Account.new
-
-    account.should respond_to(:id)
-    account.should respond_to(:name)
-    account.should respond_to(:type)
-    account.should respond_to(:account_number)
-    account.should respond_to(:current_balance)
-    account.should respond_to(:available_balance)
-    account.should respond_to(:prior_day_balance)
-  end
-  
-  it "is populated when properties are accessed" do
-    @account.instance_variable_get(:@name).should be_nil
-    @account.name.should == "my name"
-  end
-  
-  it "is considered == if the id is the same" do
-    account1 = Account.new :id => 1, :name => "checking"
-    account2 = Account.new :id => 1, :name => "savings"
-    account3 = Account.new :id => 2, :name => "trash"
-    
-    account1.should == account2
-    account1.should_not == account3
-  end
-  
-  context "given a date range" do
-    it "gets transactions" do
-      @account.find_transactions(Date.today - 30)
-    end
-    #it "only fetches transactions when needed"
-  end
-
-  #it "doesn't allow there to be too many cached transactions"
+require "spec_helper"
+
+describe Account do
+  before(:each) do
+    @institution = double()
+    @institution.stub(:populate_account) do
+      @account.populated = true
+      @account.instance_variable_set :@name, 'my name'
+    end
+    @institution.stub(:fetch_transactions) do
+      [
+        Transaction.new(:id => 1, :payee => 'Wal-Mart', :posted_at => Date.today - 1, :amount => 30.14),
+        Transaction.new(:id => 2, :payee => 'Pizza Hut', :posted_at => Date.today - 2, :amount => 10.23)
+      ]
+    end
+    @account = Account.new :id => 1, :institution => @institution
+  end
+  
+  it "has lots of useful properties" do
+    account = Account.new
+
+    account.should respond_to(:id)
+    account.should respond_to(:name)
+    account.should respond_to(:type)
+    account.should respond_to(:account_number)
+    account.should respond_to(:current_balance)
+    account.should respond_to(:available_balance)
+    account.should respond_to(:prior_day_balance)
+  end
+  
+  it "is populated when properties are accessed" do
+    @account.instance_variable_get(:@name).should be_nil
+    @account.name.should == "my name"
+  end
+  
+  it "is considered == if the id is the same" do
+    account1 = Account.new :id => 1, :name => "checking"
+    account2 = Account.new :id => 1, :name => "savings"
+    account3 = Account.new :id => 2, :name => "trash"
+    
+    account1.should == account2
+    account1.should_not == account3
+  end
+  
+  context "given a date range" do
+    it "gets transactions" do
+      @account.find_transactions(Date.today - 30)
+    end
+    #it "only fetches transactions when needed"
+  end
+
+  #it "doesn't allow there to be too many cached transactions"
 end