syrup 0.0.3 → 0.0.4

data/.gitignore

@@ -1,7 +1,8 @@
-*.swp
-**/*.swp
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-doc/*
+*.swp
+**/*.swp
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+doc/*
+.DS_Store

data/.rspec

@@ -1,2 +1,2 @@
---color
---format documentation
+--color
+--format documentation

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
-0.0.1 (Date)
-
+0.0.3 (Jun 29, 2011)
+
+* removed activesupport dependency in favor of multi_json
+* ZionsBank now populates balance information while fetching transactions
+* Account only tries to populate itself if the data being requested isn't there
+
+0.0.1
+
 * initial release

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in syrup.gemspec
-gemspec
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in syrup.gemspec
+gemspec

data/README.rdoc

@@ -1,46 +1,46 @@
-= Syrup
-
-Syrup helps you to extract bank account information and transactions.
-
-== Usage
-
-  # Setup an instance of the bank
-  zions_bank = Syrup.setup_institution('zions_bank') do |config|
-    config.username = 'user'
-    config.password = 'pass'
-    config.secret_questions = {'What is your secret question?' => "I don't know"}
-  end
-  
-  # List accounts
-  zions_bank.accounts.each do |account|
-    puts "#{account.name} (#{account.current_balance}) # => "Checking (100.0)"
-  end
-  
-  # Get transactions
-  account = zions_bank.find_account_by_id 123456
-  transactions = account.find_transactions(Date.today - 30) # => an array of Transactions from the last 30 days
-  transactions = account.find_transactions(Date.parse('2011-01-01'), Date.parse('2011-02-01') - 1) # => an array of Transactions from the month of January
-
-== Installation
-
-The latest version of Syrup can be installed with Rubygems:
-
-  [sudo] gem install "syrup"
-
-In <b>Rails 3</b>, add this to your Gemfile and run the +bundle+ command.
-
-  gem "syrup"
-
-In <b>Rails 2</b>, add this to your environment.rb file.
-
-  config.gem "syrup"
-
-== Supported Institutions
-
-Currently, only Zions Bank[http://zionsbank.com] is supported. I will be
-implementing UCCU, USAA, and Wells Fargo (probably in that order). If you would
-like support for a different bank, you have two options:
-
-1. Get me the credentials to log into an account with that bank (you'd have to
-   trust me).
-2. Implement it yourself and submit a pull request. See {Adding Support For Another Institution}[https://github.com/dontangg/syrup/wiki/Adding-Support-For-Another-Institution]
+= Syrup
+
+Syrup helps you to extract bank account information and transactions.
+
+== Usage
+
+  # Setup an instance of the bank
+  zions_bank = Syrup.setup_institution('zions_bank') do |config|
+    config.username = 'user'
+    config.password = 'pass'
+    config.secret_questions = {'What is your secret question?' => "I don't know"}
+  end
+  
+  # List accounts
+  zions_bank.accounts.each do |account|
+    puts "#{account.name} (#{account.current_balance}) # => "Checking (100.0)"
+  end
+  
+  # Get transactions
+  account = zions_bank.find_account_by_id 123456
+  transactions = account.find_transactions(Date.today - 30) # => an array of Transactions from the last 30 days
+  transactions = account.find_transactions(Date.parse('2011-01-01'), Date.parse('2011-02-01') - 1) # => an array of Transactions from the month of January
+
+== Installation
+
+The latest version of Syrup can be installed with Rubygems:
+
+  [sudo] gem install "syrup"
+
+In <b>Rails 3</b>, add this to your Gemfile and run the +bundle+ command.
+
+  gem "syrup"
+
+In <b>Rails 2</b>, add this to your environment.rb file.
+
+  config.gem "syrup"
+
+== Supported Institutions
+
+Currently, only {Zions Bank}[http://zionsbank.com] is supported. I will be
+implementing UCCU, USAA, and Wells Fargo (probably in that order). If you would
+like support for a different bank, you have two options:
+
+1. Get me the credentials to log into an account with that bank (you'd have to
+   trust me).
+2. Implement it yourself and submit a pull request. See {Adding Support For Another Institution}[https://github.com/dontangg/syrup/wiki/Adding-Support-For-Another-Institution]

data/Rakefile

@@ -1,9 +1,9 @@
-require 'bundler'
-require 'rspec/core/rake_task'
-
-Bundler::GemHelper.install_tasks
-
-desc "Run tests"
-RSpec::Core::RakeTask.new
-
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc "Run tests"
+RSpec::Core::RakeTask.new
+
 task :default => :spec

data/TODO.rdoc

@@ -1,12 +1,12 @@
-
-Make sure that mechanize validates SSL certificates
-
-When getting transactions
-* populate as many variables on Account as you can (eg. current_balance, etc.)
-
-Tests
-* Add generic tests to test institution implementations
-* Add tests to test Zions Bank without storing username, password, etc.
-
-Documentation
-* Improve GitHub wiki documentation
+
+Make sure that mechanize validates SSL certificates
+
+When getting transactions
+* populate as many variables on Account as you can (eg. current_balance, etc.)
+
+Tests
+* Add generic tests to test institution implementations
+* Add tests to test Zions Bank without storing username, password, etc.
+
+Documentation
+* Improve GitHub wiki documentation

data/lib/syrup/account.rb

@@ -1,144 +1,143 @@
-require 'date'
-
-module Syrup
-  # An account contains all the information related to the account. Information
-  # is loaded lazily so that you can use an account to get transactions without
-  # incurring the cost of getting any account information.
-  class Account
-    ##
-    # :attr_reader: name
-    # Gets the name of the account (eg. "Don's Checking").
-    
-    ##
-    # :attr_reader: type
-    # Gets the type of account. Currently, the only valid types are :deposit and :credit.
-    
-    ##
-    # :attr_reader: account_number
-    
-    ##
-    # :attr_reader: available_balance
-    
-    ##
-    # :attr_reader: current_balance
-    
-    ##
-    # :attr_reader: prior_day_balance
-    
-    ##
-    # :attr_reader: populated?
-    
-    ##
-    # :attr_writer: populated
-    
-    ##
-    # :attr_reader: valid?
-    # Since account information is lazily loaded, the validity of this account isn't immediately
-    # known. Once this account has been populated, this will return true if the account is a
-    # valid account, nil otherwise. Calling this method causes the account to attempt to be populated.
-    
-    ##
-    # :attr_writer: valid
-    
-    #
-    attr_accessor :id
-    attr_writer :name, :type, :account_number, :current_balance, :available_balance, :prior_day_balance
-    
-    
-    def name
-      populate unless @name
-      @name
-    end
-    
-    def type
-      populate unless @type
-      @type
-    end
-    
-    def account_number
-      populate unless @account_number
-      @account_number
-    end
-    
-    def current_balance
-      populate unless @current_balance
-      @current_balance
-    end
-    
-    def available_balance
-      populate unless @available_balance
-      @available_balance
-    end
-    
-    def prior_day_balance
-      populate unless @prior_day_balance
-      @prior_day_balance
-    end
-    
-    # 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
-      
-      @cached_transactions = []
-    end
-    
-    def populated?
-      @populated
-    end
-    
-    def populated=(value)
-      @populated = value
-    end
-    
-    # Populates this account with all of its information
-    def populate
-      puts "populate called"
-      unless populated? || @institution.nil?
-        raise "The account id must not be nil when populating an account" if id.nil?
-        @institution.populate_account(id)
-      end
-    end
-    
-    # Tests equality of this account with another account. Accounts are considered equal
-    # if they have the same id.
-    def ==(other_account)
-      other_account.id == self.id && other_account.is_a?(Account)
-    end
-    
-    # Returns an array of transactions from this account for the supplied date range.
-    def find_transactions(starting_at, ending_at = Date.today)
-      return [] if starting_at > ending_at
-      
-      @institution.fetch_transactions(self.id, starting_at, ending_at)
-    end
-    
-    # Merges this account information with another account. The other account's information
-    # overrides this account's.
-    def merge!(account_with_info)
-      if account_with_info
-        account_with_info.instance_variables.each do |filled_var|
-          self.instance_variable_set(filled_var, account_with_info.instance_variable_get(filled_var))
-        end
-      end
-      self
-    end
-    
-    def valid?
-      if @valid.nil?
-        populate
-        @valid = populated?
-      end
-      @valid
-    end
-    
-    def valid=(validity)
-      @valid = validity
-    end
-    
-  end
+require 'date'
+
+module Syrup
+  # An account contains all the information related to the account. Information
+  # is loaded lazily so that you can use an account to get transactions without
+  # incurring the cost of getting any account information.
+  class Account
+    ##
+    # :attr_reader: name
+    # Gets the name of the account (eg. "Don's Checking").
+    
+    ##
+    # :attr_reader: type
+    # Gets the type of account. Currently, the only valid types are :deposit and :credit.
+    
+    ##
+    # :attr_reader: account_number
+    
+    ##
+    # :attr_reader: available_balance
+    
+    ##
+    # :attr_reader: current_balance
+    
+    ##
+    # :attr_reader: prior_day_balance
+    
+    ##
+    # :attr_reader: populated?
+    
+    ##
+    # :attr_writer: populated
+    
+    ##
+    # :attr_reader: valid?
+    # Since account information is lazily loaded, the validity of this account isn't immediately
+    # known. Once this account has been populated, this will return true if the account is a
+    # valid account, nil otherwise. Calling this method causes the account to attempt to be populated.
+    
+    ##
+    # :attr_writer: valid
+    
+    #
+    attr_accessor :id
+    attr_writer :name, :type, :account_number, :current_balance, :available_balance, :prior_day_balance
+    
+    
+    def name
+      populate unless @name
+      @name
+    end
+    
+    def type
+      populate unless @type
+      @type
+    end
+    
+    def account_number
+      populate unless @account_number
+      @account_number
+    end
+    
+    def current_balance
+      populate unless @current_balance
+      @current_balance
+    end
+    
+    def available_balance
+      populate unless @available_balance
+      @available_balance
+    end
+    
+    def prior_day_balance
+      populate unless @prior_day_balance
+      @prior_day_balance
+    end
+    
+    # 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
+      
+      @cached_transactions = []
+    end
+    
+    def populated?
+      @populated
+    end
+    
+    def populated=(value)
+      @populated = value
+    end
+    
+    # Populates this account with all of its information
+    def populate
+      unless populated? || @institution.nil?
+        raise "The account id must not be nil when populating an account" if id.nil?
+        @institution.populate_account(id)
+      end
+    end
+    
+    # Tests equality of this account with another account. Accounts are considered equal
+    # if they have the same id.
+    def ==(other_account)
+      other_account.id == self.id && other_account.is_a?(Account)
+    end
+    
+    # Returns an array of transactions from this account for the supplied date range.
+    def find_transactions(starting_at, ending_at = Date.today)
+      return [] if starting_at > ending_at
+      
+      @institution.fetch_transactions(self.id, starting_at, ending_at)
+    end
+    
+    # Merges this account information with another account. The other account's information
+    # overrides this account's.
+    def merge!(account_with_info)
+      if account_with_info
+        account_with_info.instance_variables.each do |filled_var|
+          self.instance_variable_set(filled_var, account_with_info.instance_variable_get(filled_var))
+        end
+      end
+      self
+    end
+    
+    def valid?
+      if @valid.nil?
+        populate
+        @valid = populated?
+      end
+      @valid
+    end
+    
+    def valid=(validity)
+      @valid = validity
+    end
+    
+  end
 end

data/lib/syrup/information_missing_error.rb

@@ -1,9 +1,9 @@
-module Syrup
-  # This error is raised when the information supplied was invalid or incorrect.
-  # Here are some example situations:
-  #
-  # * A username/password wasn't supplied.
-  # * The password supplied didn't work.
-  class InformationMissingError < StandardError
-  end
+module Syrup
+  # This error is raised when the information supplied was invalid or incorrect.
+  # Here are some example situations:
+  #
+  # * A username/password wasn't supplied.
+  # * The password supplied didn't work.
+  class InformationMissingError < StandardError
+  end
 end