syrup 0.0.1 → 0.0.2

data/lib/syrup/transaction.rb

@@ -1,10 +1,14 @@
-module Syrup
-  class Transaction
-    attr_accessor :payee, :amount, :posted_at
-    def initialize(attr_hash)
-      attr_hash.each do |k, v|
-        instance_variable_set "@#{k}", v
-      end
-    end
-  end
+module Syrup
+  class Transaction
+    # known statuses are :posted and :pending
+    attr_accessor :id, :payee, :amount, :posted_at, :status
+    
+    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.1"
-end
+module Syrup
+  VERSION = "0.0.2"
+end

data/lib/syrup.rb

@@ -1,10 +1,27 @@
-require 'date'
-require 'mechanize'
-require 'active_support/json'
-require 'syrup/extract'
-require 'syrup/account'
-require 'syrup/transaction'
-
-# require all institutions
-require 'syrup/institutions/abstract_institution'
-Dir[File.dirname(__FILE__) + '/syrup/institutions/*.rb'].each {|file| require file }
+require 'date'
+require 'mechanize'
+require 'active_support/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
+  
+  def institutions
+    Institutions::InstitutionBase.subclasses
+  end
+  
+  def setup_institution(institution_id)
+    institution = institutions.find { |i| i.id == institution_id }
+    
+    if institution
+      i = institution.new
+      i.setup { |config| yield config }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,25 +1,15 @@
-#require 'rubygems'
-#require 'bundler/setup'
-
-Bundler.require(:default)
-
-#RSpec.configure do |config|
-#  config.mock_with :rr
-#  config.before(:each) do
-#    
-#  end
-#end
-
-
-# pass in username, password, secret questions
-
-# zions.fetch_accounts
-# should I store things?
-# List accounts
-#  * create an array of Account objects
-
-# account.transactions OR account.fetch_transactions
-# zions.
-# When getting transactions
-#  * create an array of Transaction objects
-#  * populate as many variables on Account as you can (eg. current_balance, etc.)
+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

@@ -0,0 +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"
+end

data/spec/syrup/institutions/institution_base_spec.rb

@@ -0,0 +1,120 @@
+require "spec_helper"
+
+include Institutions
+
+describe InstitutionBase do
+  
+  before(:each) do
+    @institution = InstitutionBase.new
+    @institution.stub(:fetch_accounts) do
+      [Account.new(:id => 1, :name => 'first')]
+    end
+  end
+  
+  it "keeps a list of classes that extend it" do
+    InstitutionBase.subclasses.should include(ZionsBank)
+  end
+  
+  it "can be setup" do
+    institution = InstitutionBase.new
+    institution.setup do |config|
+      config.username = 'username'
+      config.password = 'pass'
+      config.secret_questions = { 'Do you like candy?' => 'yes' }
+    end
+    
+    institution.username.should == 'username'
+    institution.password.should == 'pass'
+    institution.secret_questions['Do you like candy?'].should == 'yes'
+  end
+  
+  context "when accounts are NOT populated" do
+    it "fetches them when accessed" do
+      @institution.should_receive :fetch_accounts
+      @institution.accounts
+    end
+    
+    it "returns an account with the id populated" do
+      account = @institution.find_account_by_id 21
+      account.id.should == 21
+    end
+    
+    it "returns a previously created account if one exists" do
+      original_account = @institution.find_account_by_id 3
+      different_account = Account.new(:id => 3)
+      
+      new_account = @institution.find_account_by_id 3
+      new_account.should be(original_account)
+      new_account.should_not be(different_account)
+    end
+  end
+  
+  context "when accounts are populated" do
+    before(:each) do
+      @institution.populated = true
+    end
+    
+    it "doesn't fetch them again" do
+      @institution.should_not_receive :fetch_accounts
+      @institution.accounts
+    end
+    
+    it "returns nil if asked for a non-existent account" do
+      account = @institution.find_account_by_id 21
+      account.should be_nil
+    end
+  end
+  
+  
+  context "while populating accounts" do
+    it "filters out non-existent accounts" do
+      @institution.find_account_by_id 21
+      @institution.accounts.each do |a|
+        a.id.should_not be(21)
+      end
+    end
+
+    it "populates data in existent accounts" do
+      account = @institution.find_account_by_id 1
+      @institution.populate_accounts
+      account.name.should == 'first'
+    end
+    
+    it "marks accounts as populated" do
+      @institution.accounts.each do |account|
+        account.populated?.should be_true
+      end
+    end
+    
+    it "marks invalid accounts as invalid" do
+      account = @institution.find_account_by_id 21
+      @institution.populate_accounts
+      account.valid?.should be_false
+    end
+  end
+  
+  context "when asked to populate one account" do
+    it "populates one account" do
+      @institution.stub(:fetch_account) do
+        Account.new :id => 2, :name => 'single account'
+      end
+      
+      account = @institution.populate_account(2)
+      account.name.should == 'single account'
+      account.populated?.should be_true
+    end
+    
+    it "can populate all accounts" do
+      @institution.stub(:fetch_account) do
+        [Account.new(:id => 2, :name => 'single account')]
+      end
+      
+      invalid_account = @institution.find_account_by_id 21
+      @institution.populate_account(2)
+      @institution.populated?.should be_true
+    end
+  end
+  
+  # it "populates transactions"
+  
+end

data/spec/syrup/institutions/zions_bank_spec.rb

@@ -1,5 +1,26 @@
-require "spec_helper"
-
-describe Syrup::Institutions::ZionsBank do
-  it "lists all accounts"
+require "spec_helper"
+
+include Institutions
+
+describe ZionsBank, :bank_integration => true do
+  before(:each) do
+    @bank = ZionsBank.new
+    @bank.setup do |config|
+      config.username = ""
+      config.password = ""
+      config.secret_questions = {}
+    end
+  end
+  
+  it "fetches one account"
+  it "fetches all accounts" do
+    accounts = @bank.fetch_accounts
+    accounts.each do |account|
+      puts "#{account.id} #{account.name}"
+    end
+  end
+  
+  it "fetches transactions given a date range" do
+    @bank.fetch_transactions
+  end
 end

data/spec/syrup/syrup_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Syrup do
+  it "lists all institutions" do
+    institution_list = Syrup.institutions
+    
+    institution_list.size.should be(1)
+    
+    institution_list.should include(Institutions::ZionsBank)
+    
+    institution_list.each do |institution|
+      institution.should respond_to(:name)
+      institution.should respond_to(:id)
+      
+      inst = institution.new
+      inst.should respond_to(:fetch_account)
+      inst.should respond_to(:fetch_accounts)
+      inst.should respond_to(:fetch_transactions)
+    end
+  end
+  
+  it "returns nil if you try to setup an unknown institution" do
+    Syrup.setup_institution('unknown').should be_nil
+  end
+  
+  it "sets up a Zions Bank institution" do
+    username = "user"
+    password = "pass"
+    secret_questions = { 'Do you eat?' => 'yes' }
+    
+    zions = Syrup.setup_institution('zions_bank') do |config|
+      config.username = username
+      config.password = password
+      config.secret_questions = secret_questions
+    end
+    
+    zions.should_not be_nil
+    zions.class.should be(Syrup::Institutions::ZionsBank)
+    zions.username.should be(username)
+  end
+end

data/spec/syrup/transaction_spec.rb

@@ -1,20 +1,21 @@
-require "spec_helper"
-
-describe Syrup::Transaction do
-  before(:all) do
-    @transaction = Syrup::Transaction.new :amount => 10, :payee => "Newegg", :posted_at => DateTime.now
-  end
-  
-  it "has an amount" do
-    @transaction.amount.should_not be_nil
-  end
-  
-  it "has a payee" do
-    @transaction.payee.should_not be_nil
-  end
-  
-  it "has a posted-at date" do
-    @transaction.posted_at.should_not be_nil
-  end
-  
+require "spec_helper"
+
+describe Syrup::Transaction do
+
+  before(:all) do
+    @transaction = Transaction.new :amount => 10, :payee => "Newegg", :posted_at => DateTime.now
+  end
+  
+  it "has an amount" do
+    @transaction.amount.should_not be_nil
+  end
+  
+  it "has a payee" do
+    @transaction.payee.should_not be_nil
+  end
+  
+  it "has a posted-at date" do
+    @transaction.posted_at.should_not be_nil
+  end
+  
 end

data/syrup.gemspec

@@ -1,26 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "syrup/version"
-
-Gem::Specification.new do |s|
-  s.name        = "syrup"
-  s.version     = Syrup::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Don Wilson"]
-  s.email       = ["dontangg@gmail.com"]
-  s.homepage    = "http://github.com/dontangg/syrup"
-  s.summary     = %q{Simple account balance/transactions extractor.}
-  s.description = %q{Simple account balance/transactions extractor by scraping bank websites.}
-  
-  s.add_dependency "mechanize"
-  s.add_dependency "activesupport"
-  
-  s.add_development_dependency "rspec"
-
-  s.rubyforge_project = s.name
-
-  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"]
-end
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "syrup/version"
+
+Gem::Specification.new do |s|
+  s.name        = "syrup"
+  s.version     = Syrup::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Don Wilson"]
+  s.email       = ["dontangg@gmail.com"]
+  s.homepage    = "http://github.com/dontangg/syrup"
+  s.summary     = %q{Simple account balance and transactions extractor.}
+  s.description = %q{Simple account balance and transactions extractor by scraping bank websites.}
+  
+  s.add_dependency "mechanize"
+  s.add_dependency "activesupport"
+  
+  s.add_development_dependency "rspec"
+
+  s.rubyforge_project = s.name
+
+  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"]
+end

metadata

@@ -1,109 +1,99 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: syrup
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Don Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-25 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-06-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mechanize
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &22805304 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *22805304
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &22805052 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *22805052
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22804800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: Simple account balance/transactions extractor by scraping bank websites.
-email: 
+  prerelease: false
+  version_requirements: *22804800
+description: Simple account balance and transactions extractor by scraping bank websites.
+email:
 - dontangg@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - CHANGELOG.rdoc
 - Gemfile
 - README.rdoc
 - Rakefile
+- TODO.rdoc
 - lib/syrup.rb
 - lib/syrup/account.rb
-- lib/syrup/extract.rb
-- lib/syrup/institutions/abstract_institution.rb
+- lib/syrup/information_missing_error.rb
+- lib/syrup/institutions/institution_base.rb
 - lib/syrup/institutions/zions_bank.rb
 - lib/syrup/transaction.rb
 - lib/syrup/version.rb
 - spec/spec_helper.rb
-- spec/syrup/extract_spec.rb
+- spec/syrup/account_spec.rb
+- spec/syrup/institutions/institution_base_spec.rb
 - spec/syrup/institutions/zions_bank_spec.rb
+- spec/syrup/syrup_spec.rb
 - spec/syrup/transaction_spec.rb
 - syrup.gemspec
-has_rdoc: true
 homepage: http://github.com/dontangg/syrup
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: syrup
-rubygems_version: 1.5.0
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Simple account balance/transactions extractor.
-test_files: 
-- spec/spec_helper.rb
-- spec/syrup/extract_spec.rb
-- spec/syrup/institutions/zions_bank_spec.rb
-- spec/syrup/transaction_spec.rb
+summary: Simple account balance and transactions extractor.
+test_files: []

data/lib/syrup/extract.rb

@@ -1,14 +0,0 @@
-module Syrup
-  class Extract
-    def self.from_institution(institution_sym)
-      class_name = institution_sym.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-      Institutions.const_get(class_name).new
-    end
-    
-    def self.list_institutions
-      Institutions::AbstractInstitution.subclasses.map do |subclass|
-        subclass.institution_name
-      end
-    end
-  end
-end

data/lib/syrup/institutions/abstract_institution.rb

@@ -1,26 +0,0 @@
-module Syrup
-  module Institutions
-    class AbstractInstitution
-      
-      def self.inherited(subclass)
-        @subclasses ||= []
-        @subclasses << subclass
-      end
-      
-      def self.subclasses
-        @subclasses
-      end
-      
-      protected
-        
-        def agent
-          @agent || Mechanize.new
-        end
-          
-        def parse_currency(currency)
-          currency.scan(/[0-9.]/).join.to_f
-        end
-      
-    end
-  end
-end

data/spec/syrup/extract_spec.rb

@@ -1,12 +0,0 @@
-require "spec_helper"
-
-describe Syrup::Extract do
-  it "lists all institutions" do
-    Syrup::Extract.list_institutions.size.should == 1
-    puts Syrup::Extract.list_institutions
-  end
-  
-  it "creates a Zions Bank institution" do
-    Syrup::Extract.from_institution(:zions_bank).class.should == Syrup::Institutions::ZionsBank
-  end
-end