sum 0.1.1

data/Capfile

@@ -0,0 +1,3 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+load 'config/deploy'

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,69 @@
+Sum
+===
+
+A budgeting app built on Sinatra. Use it at [sumapp.com](http://sumapp.com).
+
+The flow
+--------
+
+Fill out a form containing your total monthly bills, income, and desired savings. When you use your credit card or the ATM, send an email to [sum@sumapp.com](mailto:sum@sumapp.com) with the dollar amount. Every midnight, you will receive an email with budgeting metrics for the day. 
+
+Take a look at the [read email feature](http://github.com/winton/sum/blob/master/features/read_email.feature) to see example budget email scenarios.
+
+Development setup
+-----------------
+
+Install the sum gem for its dependencies:
+
+<pre>
+gem sources -a http://gems.github.com
+sudo gem install winton-sum
+</pre>
+
+Fork the [Sum repository](http://github.com/winton/sum) on [GitHub](http://github.com).
+
+<pre>
+git clone git@github.com:YOUR_NAME/sum.git
+cd sum
+</pre>
+
+Create your database:
+
+<pre>
+mysql -uroot -e "create database sum;"
+</pre>
+
+Copy and edit the example config files:
+
+<pre>
+cp config/database.example.yml config/database.yml
+cp config/mail.example.yml config/mail.yml
+mate config/database.yml config/mail.yml
+</pre>
+
+Migrate the database:
+
+<pre>
+rake db:migrate
+</pre>
+
+Start the application with shotgun:
+
+<pre>
+shotgun
+</pre>
+
+Architecture
+------------
+
+The application consists of a simple form that updates the user table and a non-public-facing action that doubles as a background job. The background action is designed to be <code>curl</code>ed by cron every minute. It handles email and time-sensitive user updates.
+
+Running the test suite
+----------------------
+
+Sum uses [Cucumber](http://github.com/aslakhellesoy/cucumber), [Webrat](http://github.com/brynary/webrat), and [email-spec](http://github.com/bmabey/email-spec) for functional tests and [rspec](http://github.com/dchelimsky/rspec) for unit tests:
+
+<pre>
+rake features
+rake spec
+</pre>

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+
+gems = [
+  [ 'cucumber', '=0.3.93' ],
+  [ 'rspec', '=1.2.8' ],
+  [ 'winton-active_wrapper', '=0.1.9' ]
+]
+
+gems.each do |name, version|
+  begin
+    gem name, version
+  rescue Exception
+    $:.unshift "#{File.dirname(__FILE__)}/vendor/#{name}/lib"
+  end
+end
+
+require 'rake'
+require 'active_wrapper/tasks'
+require 'cucumber/rake/task'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'gemspec'
+
+ActiveWrapper::Tasks.new(
+  :base => File.dirname(__FILE__),
+  :env => ENV['ENV']
+)
+
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{Dir.pwd}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(GEM_SPEC.to_ruby)
+  end
+end
+
+desc "Install gem"
+task :install do
+  Rake::Task['gem'].invoke
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `sudo gem install pkg/#{GEM_NAME}*.gem`
+  `rm -Rf pkg`
+end
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format pretty"
+end
+
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.gem_spec = GEM_SPEC
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.rcov = true
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/config.ru

@@ -0,0 +1,3 @@
+require "#{File.dirname(__FILE__)}/lib/sum"
+
+run Application

data/config/database.example.yml

@@ -0,0 +1,10 @@
+development: &dev
+  adapter: mysql
+  database: sum
+  username: root
+  password:
+  host: localhost
+production:
+  <<: *dev
+test:
+  <<: *dev

data/config/deploy.example.rb

@@ -0,0 +1,36 @@
+set :ubistrano, {
+  :application => :sum_beta,
+  :platform    => :sinatra,  # :php, :rails, :sinatra
+  :repository  => 'git@github.com:winton/sum.git',
+  
+  :ec2 => {
+    :access_key => '',
+    :secret_key => ''
+  },
+  
+  :mysql => {
+    :root_password => '',
+    :app_password  => ''
+  },
+  
+  :production => {
+    :domains => [ 'beta.sumapp.com' ],
+    :host    => '174.129.231.24'
+  },
+  
+  :staging => {
+    :domains => [ 'staging.beta.sumapp.com' ],
+    :host    => '174.129.231.24'
+  }
+}
+
+require 'ubistrano'
+
+after "deploy:update_code", "deploy:update_crontab"
+
+namespace :deploy do
+  desc "Update the crontab file"
+  task :update_crontab, :roles => :web do
+    run "cd #{release_path} && whenever --update-crontab #{application}"
+  end
+end

data/config/externals.yml

@@ -0,0 +1,18 @@
+winton-active_wrapper:
+  repo: git@github.com:winton/active_wrapper.git
+  path: vendor
+email-spec:
+  repo: git://github.com/bmabey/email-spec.git
+  path: vendor
+winton-fetcher:
+  repo: git@github.com:winton/fetcher.git
+  path: vendor
+winton-secret_key:
+  repo: git@github.com:winton/secret_key.git
+  path: vendor
+sinatra:
+  repo: git://github.com/sinatra/sinatra.git
+  path: vendor
+webrat:
+  repo: git://github.com/brynary/webrat.git
+  path: vendor

data/config/mail.example.yml

@@ -0,0 +1,32 @@
+development:
+  imap:
+    password: password
+    port: 993
+    server: imap.gmail.com
+    ssl: true
+    use_login: true
+    username: test@sumapp.com
+  smtp:
+    address: smtp.gmail.com
+    authentication: :plain
+    domain: sumapp.com
+    password: 
+    port: 587
+    enable_starttls_auto: true
+    user_name: test@sumapp.com
+production:
+  imap:
+    password: password
+    port: 993
+    server: imap.gmail.com
+    ssl: true
+    use_login: true
+    username: sum@sumapp.com
+  smtp:
+    address: smtp.gmail.com
+    authentication: :plain
+    domain: sumapp.com
+    password: 
+    port: 587
+    enable_starttls_auto: true
+    user_name: sum@sumapp.com

data/config/schedule.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+begin
+  gem 'winton-secret_key', '=0.1.0'
+rescue Exception
+  $:.unshift "#{File.dirname(__FILE__)}/vendor/winton-secret_key/lib"
+end
+
+require 'secret_key'
+key = SecretKey.new(File.dirname(__FILE__)).read
+
+every 1.minute do
+  puts @environment
+  case @environment
+  when 'development'
+    command "curl http://localhost:#{@port}/cron"
+  else
+    command "curl https://sumapp.com/#{key}"
+  end
+end

data/db/migrate/001_users.rb

@@ -0,0 +1,22 @@
+class Users < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.column :flash, :string
+      t.column :recent_transactions, :string, :limit => 1024
+      t.column :savings_goal, :decimal, :precision => 10, :scale => 2, :default => 0
+      t.column :send_now, :boolean, :default => false
+      t.column :spending_goal, :decimal, :precision => 10, :scale => 2, :default => 0
+      t.column :spent_this_month, :decimal, :precision => 10, :scale => 2, :default => 0
+      t.column :spent_today, :decimal, :precision => 10, :scale => 2, :default => 0
+      t.column :temporary_spending_cut, :decimal, :precision => 10, :scale => 2, :default => 0
+      t.column :timezone_offset, :integer, :default => 0
+      t.column :reset_at, :datetime
+      t.column :send_at, :datetime
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/db/migrate/002_user_emails.rb

@@ -0,0 +1,15 @@
+class UserEmails < ActiveRecord::Migration
+  def self.up
+    create_table :user_emails do |t|
+      t.column :active, :boolean, :default => true
+      t.column :email, :string
+      t.column :failures, :integer, :default => 0
+      t.column :user_id, :integer
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :user_emails
+  end
+end

data/features/front_page.feature

@@ -0,0 +1,15 @@
+Feature: Front page 
+
+  As a user
+  I want to enter my information into a form
+  In order to submit that information
+  
+  Scenario: I visit the front page
+    When I visit the front page
+    Then I should see a form
+    And I should see a savings text field
+    And I should see an income text field
+    And I should see a bills text field
+    And I should see an email text field
+    And I should see a tos checkbox
+    And I should see a submit button

data/features/read_email.feature

@@ -0,0 +1,445 @@
+Feature: Read email
+
+  As a user
+  I want to read a budget email
+  In order to know how much I can spend
+  
+  Background:
+    Given today is June 1, 2009
+    And I have created an account with these attributes:
+      | savings | income | bills |
+      | 1000    | 5000   | 2500  |
+    And my email queue is empty
+  
+  Scenario: I see some static information every day
+    When the background job runs
+    And I open the email
+    Then I should see "Today's budget" in the subject
+    And I should see "Fiscal month: 06/01/09 to 07/01/09 (30 days)" in the email
+  
+  
+  # Day 1
+  
+  Scenario: I see budget information for day 1, having spent nothing today
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $50.00 today.
+      
+      If you don't spend anything today, you will have
+        $51.72 to spend each day.
+        $362.07 to spend each week.
+        $1500.00 to spend over the next 29 days.
+      
+      You have saved $50.00 more than expected for a 1 day period.
+      """
+      # days in month = 30
+      # spending money / days in month = 50
+      # days left = 29
+      # spending money / days left = 51.72
+      # spending money / days left * 7 = 362.07
+  
+  Scenario: I see budget information for day 1, having deposited money
+    Given it is day 1
+    And I have deposited $1.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $51.00 today.
+      
+      If you don't spend anything today, you will have
+        $51.76 to spend each day.
+        $362.31 to spend each week.
+        $1501.00 to spend over the next 29 days.
+      
+      You have saved $51.00 more than expected for a 1 day period.
+      """
+      # (spending money / days in month) - spent today = 51
+      # spending money + 1 = 1501
+  
+  Scenario: I see budget information for day 1, having spent under budget
+    Given it is day 1
+    And today I have spent $49.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $1.00 today.
+      
+      If you only spend $49.00 today, you will have
+        $50.03 to spend each day.
+        $350.24 to spend each week.
+        $1451.00 to spend over the next 29 days.
+      
+      You have saved $1.00 more than expected for a 1 day period.
+      """
+  
+  Scenario: I see budget information for day 1, having spent exactly my budget
+    Given it is day 1
+    And today I have spent $50.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You have spent your budget for today.
+      
+      If you only spend $50.00 today, you will have
+        $50.00 to spend each day.
+        $350.00 to spend each week.
+        $1450.00 to spend over the next 29 days.
+      
+      You have spent exactly as expected for a 1 day period.
+      """
+  
+  Scenario: I see budget information for day 1, having spent over budget
+    Given it is day 1
+    And today I have spent $51.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You have spent your budget for today, plus an additional $1.00.
+      
+      If you only spend $51.00 today, you will have
+        $49.97 to spend each day.
+        $349.76 to spend each week.
+        $1449.00 to spend over the next 29 days.
+      
+      You have spent $1.00 more than expected for a 1 day period.
+      """
+  
+  Scenario: I see budget information for day 1, having spent all of my spending money
+    Given it is day 1
+    And today I have spent $1500.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You should not spend any money for the next 29 days if you want to continue to save $1000.00.
+      
+      If you wish to spend into your savings this month, you can afford to spend
+        $34.48 each day.
+        $241.38 each week.
+        $1000.00 over the next 29 days.
+      
+      You have spent $1450.00 more than expected for a 1 day period.
+      """
+      # total left = 1000
+      # total left / days left = 34.48
+      # total left / days left * 7 = 241.38
+  
+  Scenario: I see budget information for day 1, having spent all of my savings
+    Given it is day 1
+    And today I have spent $2500.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You should not spend any money for the next 29 days if you want to avoid going into debt.
+      
+      You have spent $2450.00 more than expected for a 1 day period.
+      """
+  
+  Scenario: I see budget information for day 1, having gone into debt
+    Given it is day 1
+    And today I have spent $2501.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You need to earn $0.03 today.
+      
+      Continue to do so for the next 29 days to avoid going into debt.
+      
+      If you do not, Sum will temporarily decrease your spending money for next month to account for the debt.
+      
+      You have spent $2451.00 more than expected for a 1 day period.
+      """
+      # total left = -1
+      # total left / days left including today * -1 = 0.03
+
+  # Day 15
+
+  Scenario: I see budget information for day 15, having spent nothing today
+    Given it is day 15
+    And before today I spent $700.00
+    And today I have spent $0.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $50.00 today.
+      
+      If you don't spend anything today, you will have
+        $53.33 to spend each day.
+        $373.33 to spend each week.
+        $800.00 to spend over the next 15 days.
+      
+      You have saved $50.00 more than expected for a 15 day period.
+      """
+
+  Scenario: I see budget information for day 15, having deposited money
+    Given it is day 15
+    And I have deposited $1.00
+    And before today I spent $700.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $51.00 today.
+      
+      If you don't spend anything today, you will have
+        $53.40 to spend each day.
+        $373.80 to spend each week.
+        $801.00 to spend over the next 15 days.
+      
+      You have saved $51.00 more than expected for a 15 day period.
+      """
+
+  Scenario: I see budget information for day 15, having spent under budget
+    Given it is day 15
+    And before today I spent $700.00
+    And today I have spent $49.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $1.00 today.
+      
+      If you only spend $49.00 today, you will have
+        $50.07 to spend each day.
+        $350.47 to spend each week.
+        $751.00 to spend over the next 15 days.
+      
+      You have saved $1.00 more than expected for a 15 day period.
+      """
+
+  Scenario: I see budget information for day 15, having spent exactly my budget
+    Given it is day 15
+    And before today I spent $700.00
+    And today I have spent $50.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You have spent your budget for today.
+      
+      If you only spend $50.00 today, you will have
+        $50.00 to spend each day.
+        $350.00 to spend each week.
+        $750.00 to spend over the next 15 days.
+      
+      You have spent exactly as expected for a 15 day period.
+      """
+
+  Scenario: I see budget information for day 15, having spent over budget
+    Given it is day 15
+    And before today I spent $700.00
+    And today I have spent $51.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You have spent your budget for today, plus an additional $1.00.
+      
+      If you only spend $51.00 today, you will have
+        $49.93 to spend each day.
+        $349.53 to spend each week.
+        $749.00 to spend over the next 15 days.
+      
+      You have spent $1.00 more than expected for a 15 day period.
+      """
+    
+  Scenario: I see budget information for day 15, having spent all of my spending money
+    Given it is day 15
+    And before today I spent $700.00
+    And today I have spent $800.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You should not spend any money for the next 15 days if you want to continue to save $1000.00.
+      
+      If you wish to spend into your savings this month, you can afford to spend
+        $66.67 each day.
+        $466.67 each week.
+        $1000.00 over the next 15 days.
+      
+      You have spent $750.00 more than expected for a 15 day period.
+      """
+
+  Scenario: I see budget information for day 15, having spent all of my savings
+    Given it is day 15
+    And before today I spent $700.00
+    And today I have spent $1050.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You should not spend any money for the next 15 days if you want to continue to save $750.00.
+      
+      If you wish to spend into your savings this month, you can afford to spend
+        $50.00 each day.
+        $350.00 each week.
+        $750.00 over the next 15 days.
+      
+      You have spent $1000.00 more than expected for a 15 day period.
+      """
+  
+  Scenario: I see budget information for day 15, having gone into debt
+    Given it is day 15
+    And before today I spent $700.00
+    And today I have spent $1801.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You need to earn $0.06 today.
+      
+      Continue to do so for the next 15 days to avoid going into debt.
+      
+      If you do not, Sum will temporarily decrease your spending money for next month to account for the debt.
+      
+      You have spent $1751.00 more than expected for a 15 day period.
+      """
+
+  # Day 30
+
+  Scenario: I see budget information for day 30, having spent nothing today
+    Given it is day 30
+    And before today I spent $1450.00
+    And today I have spent $0.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $50.00 today.
+      
+      You have saved $50.00 more than expected for a 30 day period.
+      """
+  
+  Scenario: I see budget information for day 30, having deposited money
+    Given it is day 30
+    And I have deposited $1.00
+    And before today I spent $1450.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $51.00 today.
+      
+      You have saved $51.00 more than expected for a 30 day period.
+      """
+  
+  Scenario: I see budget information for day 30, having spent under budget
+    Given it is day 30
+    And before today I spent $1450.00
+    And today I have spent $49.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You can spend $1.00 today.
+      
+      You have saved $1.00 more than expected for a 30 day period.
+      """
+  
+  Scenario: I see budget information for day 30, having spent exactly my budget
+    Given it is day 30
+    And before today I spent $1450.00
+    And today I have spent $50.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You should not spend any money if you want to continue to save $1000.00.
+      
+      You have spent exactly as expected for a 30 day period.
+      """
+  
+  Scenario: I see budget information for day 30, having spent over budget
+    Given it is day 30
+    And before today I spent $1450.00
+    And today I have spent $51.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You should not spend any money if you want to continue to save $999.00.
+      
+      You have spent $1.00 more than expected for a 30 day period.
+      """
+  
+  Scenario: I see budget information for day 30, having spent all of my savings
+    Given it is day 30
+    And before today I spent $1450.00
+    And today I have spent $1050.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You should not spend any money if you want to avoid going into debt.
+      
+      You have spent $1000.00 more than expected for a 30 day period.
+      """
+  
+  Scenario: I see budget information for day 30, having gone into debt
+    Given it is day 30
+    And before today I spent $1450.00
+    And today I have spent $1051.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      You need to earn $1.00 today.
+      
+      If you do not, Sum will temporarily decrease your spending money for next month to account for the debt.
+      
+      You have spent $1001.00 more than expected for a 30 day period.
+      """
+  
+  
+  # Transactions
+  
+  Scenario: I see my last transaction
+    Given today I have spent $1.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      Last transaction:
+        $-1.00
+      """
+  
+  Scenario: I see my last two transactions
+    Given today I have spent $1.00
+    And today I have spent $2.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      Last 2 transactions:
+        $-2.00
+        $-1.00
+      """
+
+  Scenario: I see my last five transactions
+    Given today I have spent $1.00
+    And today I have spent $2.00
+    And today I have spent $3.00
+    And today I have spent $4.00
+    And today I have spent $5.00
+    And today I have spent $6.00
+    When the background job runs
+    And I open the email
+    Then I should see in the email:
+      """
+      Last 5 transactions:
+        $-6.00
+        $-5.00
+        $-4.00
+        $-3.00
+        $-2.00
+      """