winton-sum 0.1.0

data/features/support/env.rb

@@ -0,0 +1,27 @@
+$testing = true
+$root = File.expand_path(File.dirname(__FILE__) + "/../../")
+$:.unshift "#{$root}/lib"
+
+require 'sum'
+
+gem 'bmabey-email_spec', '=0.2.0'
+gem 'rspec', '=1.2.7'
+
+require 'email_spec'
+require 'rack/test'
+require 'spec/mocks'
+require 'test/unit'
+require "#{$root}/vendor/webrat/lib/webrat"
+
+World do
+  def app
+    Application
+  end
+  
+  include EmailSpec::Helpers
+  include EmailSpec::Matchers
+  include Rack::Test::Methods
+  include Test::Unit::Assertions
+  include Webrat::Matchers
+  include Webrat::Methods
+end

data/features/support/helpers.rb

@@ -0,0 +1,44 @@
+def current_email_address
+  "cucumber@sumapp.com"
+end
+
+def fill_all_with_valid_data(hash={})
+  valid = {
+    'savings' => '0',
+    'income' => '0',
+    'bills' => '0',
+    'email' => current_email_address
+  }.merge(hash)
+  valid.each do |key, value|
+    fill_in "user[#{key}]", :with => value
+  end
+end
+
+def find_user
+  UserEmail.find_by_email(current_email_address).user
+end
+
+def generate_email(options={})
+<<EMAIL
+Delivered-To: test@sumapp.com
+Return-Path: <#{options[:from] || current_email_address}>
+From: Winton Welsh <#{options[:from] || current_email_address}>
+To: test@sumapp.com
+Subject: #{options[:subject] || ''}
+Content-Type: multipart/alternative; boundary=000325574d2a5057e1046eae4ba5
+
+--000325574d2a5057e1046eae4ba5
+Content-Type: text/plain; charset=ISO-8859-1
+Content-Transfer-Encoding: 7bit
+
+#{options[:body] || ''}
+
+--000325574d2a5057e1046eae4ba5
+Content-Type: text/html; charset=ISO-8859-1
+Content-Transfer-Encoding: 7bit
+
+#{options[:body] || ''}<br>
+
+--000325574d2a5057e1046eae4ba5--
+EMAIL
+end

data/features/support/rspec.rb

@@ -0,0 +1,11 @@
+Before do
+  $rspec_mocks ||= Spec::Mocks::Space.new
+end
+
+After do
+  begin
+    $rspec_mocks.verify_all
+  ensure
+    $rspec_mocks.reset_all
+  end
+end

data/features/support/webrat.rb

@@ -0,0 +1,3 @@
+Webrat.configure do |config|
+  config.mode = :rack
+end

data/features/update_user.feature

@@ -0,0 +1,76 @@
+Feature: Update user
+
+  As a user
+  I want to submit my information
+  In order to see a success page
+  
+  Scenario: I submit a valid form with decimals
+    When I visit the front page
+    And I submit a valid form with decimals
+    Then I should see a success page
+  
+  Scenario: I submit a valid form with numbers only
+    When I visit the front page
+    And I submit a valid form with numbers only
+    Then I should see a success page
+  
+  Scenario: I submit a valid form with dollar signs
+    When I visit the front page
+    And I submit a valid form with dollar signs
+    Then I should see a success page
+  
+  Scenario: I submit an invalid savings amount
+    When I visit the front page
+    And submit an invalid savings amount
+    Then I should see a form
+    And the savings field should have an error
+    And the error should be "is not a number"
+  
+  Scenario: I submit an empty savings amount
+    When I visit the front page
+    And submit an empty savings amount
+    Then I should see a form
+    And the savings field should have an error
+    And the error should be "is not a number"
+  
+  Scenario: I submit an invalid income amount
+    When I visit the front page
+    And submit an invalid income amount
+    Then I should see a form
+    And the income field should have an error
+    And the error should be "is not a number"
+  
+  Scenario: I submit an empty income amount
+    When I visit the front page
+    And submit an empty income amount
+    Then I should see a form
+    And the income field should have an error
+    And the error should be "is not a number"
+
+  Scenario: I submit an invalid bills amount
+    When I visit the front page
+    And submit an invalid bills amount
+    Then I should see a form
+    And the bills field should have an error
+    And the error should be "is not a number"
+
+  Scenario: I submit an empty bills amount
+    When I visit the front page
+    And submit an empty bills amount
+    Then I should see a form
+    And the bills field should have an error
+    And the error should be "is not a number"
+    
+  Scenario: I submit an invalid email
+    When I visit the front page
+    And submit an invalid email
+    Then I should see a form
+    And the email field should have an error
+    And the error should be "is invalid"
+  
+  Scenario: I submit an empty email
+    When I visit the front page
+    And submit an empty email
+    Then I should see a form
+    And the email field should have an error
+    And the error should be "can't be blank"

data/gemspec.rb

@@ -0,0 +1,45 @@
+GEM_NAME = 'sum'
+GEM_FILES = FileList['**/*'] - FileList[
+  '*.gem',
+  '*.log',
+  'config/database.yml',
+  'config/deploy.rb',
+  'config/mail.yml',
+  'coverage',
+  'coverage/**/*',
+  'log',
+  'log/**/*',
+  'pkg',
+  'pkg/**/*',
+  'tmp',
+  'tmp/**/*'
+]
+GEM_SPEC = Gem::Specification.new do |s|
+  # == CONFIGURE ==
+  s.author = "Winton Welsh"
+  s.email = "mail@wintoni.us"
+  s.homepage = "http://github.com/winton/#{GEM_NAME}"
+  s.summary = "A simple budgeting app built on Sinatra"
+  # == CONFIGURE ==
+  s.add_dependency('bmabey-email_spec', '=0.2.0')
+  s.add_dependency('cucumber', '>=0.3.11')
+  s.add_dependency('haml', '=2.0.9')
+  s.add_dependency('less', '>=0.8.11')
+  s.add_dependency('javan-whenever', '=0.3.6')
+  s.add_dependency('rack', '>=1.0.0')
+  s.add_dependency('rack-test', '>=0.4.0')
+  s.add_dependency('rspec', '>=1.2.7')
+  s.add_dependency('shotgun', '>=0.3')
+  s.add_dependency('sinatra', '=0.9.2')
+  s.add_dependency('winton-active_wrapper', '=0.1.5')
+  s.add_dependency('winton-externals', '=1.0.2')
+  s.add_dependency('winton-fetcher', '=0.1.2')
+  s.add_dependency('winton-secret_key', '=0.1.0')
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = GEM_FILES.to_a
+  s.has_rdoc = false
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.version = "0.1.0"
+end

data/lib/sum/boot.rb

@@ -0,0 +1,29 @@
+require "#{File.dirname(__FILE__)}/model/incoming_mail"
+
+Application.class_eval do
+  
+  # Sinatra
+  enable :raise_errors
+  set :environment, $testing ? :test : environment
+  set :root, File.expand_path("#{File.dirname(__FILE__)}/../../")
+  set :public, "#{root}/public"
+  set :logging, true
+  set :static, true
+  set :views, "#{root}/lib/sum/view"
+    
+  # Database, logging, and email
+  $db, $log, $mail = ActiveWrapper.setup(
+    :base => root,
+    :env => environment,
+    :stdout => environment != :test
+  )
+  $db.establish_connection
+  if $mail.config
+    ActionMailer::Base.raise_delivery_errors = true
+    imap = { :receiver => IncomingMail, :type => :imap }
+    $mail.config[:imap].merge!(imap)
+  end
+  
+  # Secret key
+  $secret_key = SecretKey.new(root).read
+end

data/lib/sum/controller/cron.rb

@@ -0,0 +1,12 @@
+Application.class_eval do
+  
+  get "/#{environment == :production ? $secret_key : 'cron'}" do
+    IncomingMail.process!
+    User.reset_users!
+    User.reset_spent_today!
+    User.send_emails! do |user|
+      haml(:email, :layout => false, :locals => { :u => user })
+    end
+    true
+  end
+end

data/lib/sum/controller/front.rb

@@ -0,0 +1,6 @@
+Application.class_eval do
+  
+  get '/' do
+    haml :front
+  end
+end

data/lib/sum/controller/new.rb

@@ -0,0 +1,15 @@
+Application.class_eval do
+  
+  post '/new' do
+    if email = UserEmail.find_by_email(params[:user][:email])
+      if @user = email.user
+        @user.send_now = true
+        @user.update_attributes(params[:user])
+      end
+    else
+      @user = User.create(params[:user])
+    end
+    @title = valid? ? 'Success!' : 'Fix mistakes'
+    haml :new
+  end
+end

data/lib/sum/helper/application.rb

@@ -0,0 +1,8 @@
+Application.class_eval do
+  helpers do
+    
+    def partial(name, options={})
+      haml name, options.merge(:layout => false)
+    end
+  end
+end

data/lib/sum/helper/cron.rb

@@ -0,0 +1,12 @@
+Application.class_eval do
+  helpers do
+    
+    def days(day)
+      day <= 1 ? "day" : "#{day} days"
+    end
+    
+    def money(amount)
+      "$#{sprintf("%.2f", amount)}"
+    end
+  end
+end

data/lib/sum/helper/new.rb

@@ -0,0 +1,26 @@
+Application.class_eval do
+  helpers do
+    
+    def errors_on(attribute)
+      @user && @user.errors.on(attribute)
+    end
+    
+    def field(attribute, question)
+      partial(
+        :field,
+        :locals => {
+          :attribute => attribute,
+          :question => question
+        }
+      )
+    end
+    
+    def valid?(attribute=nil)
+      if attribute
+        @user && @user.errors.on(attribute).nil?
+      else
+        @user && @user.valid?
+      end
+    end
+  end
+end

data/lib/sum/model/incoming_mail.rb

@@ -0,0 +1,89 @@
+class IncomingMail < ActionMailer::Base
+  
+  class <<self
+    def process!
+      if $mail.config
+        Fetcher.create($mail.config[:imap]).fetch
+      end
+    end
+  end
+  
+  def receive(mail)
+    return unless body = get_body(mail)
+    emails = parse_emails(mail.subject, body.body)
+    numbers = parse_numbers(mail.subject, body.body)
+    start = parse_start(mail.subject, body.body)
+    stop = parse_stop(mail.subject, body.body)
+    
+    if mail.from[0] && email = UserEmail.find_by_email(mail.from[0])
+      user = email.user
+    else
+      return
+    end
+    
+    if user
+      emails.each do |email|
+        user.add_email!(email, true)
+      end
+      numbers.each do |number|
+        user.spend!(number)
+      end
+      email.activate! if start
+      email.deactivate! if stop
+    end
+    
+    [ emails, numbers, start, stop ]
+  end
+  
+  private
+  
+  def get_body(mail)
+    if mail.parts.empty?
+      mail
+    else
+      mail.parts.select { |part|
+        part['content-type'].content_type == 'text/plain'
+      }.first
+    end
+  end
+  
+  def parse_emails(*args)
+    args.collect { |text|
+      text = text_upto(text, /\s/)
+      text.scan(/\S+@\S+\.\S+/)
+    }.flatten
+  end
+  
+  def parse_numbers(*args)
+    args.collect { |text|
+      text = text_upto(text, /[^-+\d\.\s]/)
+      numbers = text.scan(/([-+]*)(\d+\.*\d*)/)
+      numbers.collect do |number|
+        operator, number = number
+        (operator == '+' ? -1 : 1) * number.to_f
+      end
+    }.flatten
+  end
+  
+  def parse_start(*args)
+    args.collect { |text|
+      text.strip[0..4].downcase == 'start'
+    }.include?(true)
+  end
+  
+  def parse_stop(*args)
+    args.collect { |text|
+      text.strip[0..3].downcase == 'stop'
+    }.include?(true)
+  end
+  
+  def text_upto(text, regex)
+    first_instance = text.index(regex)
+    return '' if first_instance == 0
+    if first_instance
+      text[0..first_instance-1]
+    else
+      text
+    end
+  end
+end

data/lib/sum/model/user.rb

@@ -0,0 +1,286 @@
+class User < ActiveRecord::Base
+  
+  attr_accessible :email
+  attr_accessible :bills
+  attr_accessible :income
+  attr_accessible :savings
+  attr_accessible :timezone_offset
+  
+  after_create :after_create_email
+  before_create :before_create_timestamps
+  
+  before_save :before_save_recent_transactions
+  before_save :before_save_savings_goal
+  before_save :before_save_spending_goal
+  
+  has_many :emails, :class_name => 'UserEmail', :dependent => :destroy
+  
+  serialize :recent_transactions
+  
+  validates_format_of(
+    :email,
+    :with => /\S+@\S+\.\S+/,
+    :unless => lambda { |r| r.email.blank? }
+  )
+  validates_numericality_of(
+    :bills,
+    :income,
+    :savings,
+    :unless => lambda { |r| r.bills.nil? && r.income.nil? && r.savings.nil? }
+  )
+  validates_presence_of :email, :unless => lambda { |r| r.email.nil? }
+  
+  # Class methods
+  
+  class <<self
+    
+    def reset_users!
+      conditions = [ 'reset_at <= ?', Time.now.utc ]
+      users = self.find(:all, :conditions => conditions)
+      users.each do |user|
+        user.reset!
+      end
+    end
+    
+    def reset_spent_today!
+      conditions = [ 'send_at <= ?', Time.now.utc ]
+      users = self.find(:all, :conditions => conditions)
+      users.each do |user|
+        user.reset_spent_today!
+      end
+    end
+    
+    def send_emails!(&block)
+      conditions = [
+        'send_now = 1 OR send_at <= ?',
+        Time.now.utc
+      ]
+      users = self.find(:all, :conditions => conditions)
+      users.each do |user|
+        user.emails.each do |email|
+          next unless email.active? && email.failures <= 5
+          begin
+            $mail.deliver(
+              :from => 'sum@sumapp.com',
+              :to => email.email,
+              :subject => "Today's budget",
+              :body => yield(user)
+            )
+            email.sent!
+          rescue Exception => e
+            email.increment!(:failures)
+          end
+        end
+        user.sent!
+      end
+    end
+  end
+  
+  # Instance methods
+  
+  [ :email, :bills, :income, :savings ].each do |attribute|
+    define_method(attribute) do
+      read_attribute attribute
+    end
+    define_method("#{attribute}=") do |value|
+      write_attribute(
+        attribute,
+        attribute == :email ? value : to_number(value)
+      )
+    end
+  end
+  
+  def add_email!(address, send=false)
+    UserEmail.create(:email => address, :user_id => self.id)
+    if send
+      self.flash = "Successfully added #{address} to your account."
+      self.send_now = true
+      self.save
+    end
+  end
+  
+  # Beginning of fiscal month
+  def beginning_of_month
+    self.reset_at - 1.month
+  end
+  
+  # Days in this fiscal month
+  def days_in_month
+    self.reset_at.to_date - self.beginning_of_month.to_date
+  end
+  
+  # Days left in this fiscal month
+  def days_left
+    to_local(self.reset_at).to_date - to_local(Time.now).to_date - 1
+  end
+  
+  # Days left in this fiscal month, including today
+  def days_left_including_today
+    self.days_left + 1
+  end
+  
+  # Days passed in this fiscal month
+  def days_passed
+    to_local(Time.now).to_date - to_local(self.beginning_of_month).to_date
+  end
+  
+  # Days passed in this fiscal month, including today
+  def days_passed_including_today
+     self.days_passed + 1
+  end
+  
+  # Reset spent_today
+  def reset_spent_today!
+    self.update_attribute :spent_today, 0
+  end
+  
+  def reset!
+    self.temporary_spending_cut = self.total_left * -1
+    if self.temporary_spending_cut < 0
+      self.temporary_spending_cut = 0
+    end
+    self.spent_this_month = 0
+    update_reset_at
+    self.save
+  end
+  
+  def sent!
+    self.flash = nil
+    self.send_now = false
+    update_send_at unless self.send_now_changed?
+    self.save
+  rescue
+    # This fixes a really confusing error when running cucumber features:
+    #   No response yet. Request a page first. (Rack::Test::Error)
+    # Happens on User#save after using $mail.deliver.
+  end
+  
+  # How much the user should have spent in this period
+  def should_have_spent
+    self.spending_per_day * self.days_passed_including_today
+  end
+  
+  def spend!(amount)
+    amount = amount.to_f if amount.respond_to?(:upcase)
+    self.recent_transactions ||= []
+    self.recent_transactions.unshift(amount)
+    self.spent_this_month += amount
+    self.spent_today += amount
+    self.send_now = true
+    self.save
+  end
+  
+  # Spending goal for the month
+  def spending_goal
+    read_attribute(:spending_goal) - self.temporary_spending_cut
+  end
+  
+  # Today's spending goal
+  def spending_goal_today
+    (self.surplus(:exclude_today) / self.days_left_including_today) - self.spent_today
+  end
+  
+  # Today's spending goal with savings included in money left to spend
+  def spending_goal_today_savings
+    (self.savings_goal + self.surplus(:exclude_today)) / self.days_left_including_today
+  end
+  
+  # How much the user is spending per day (ideally)
+  def spending_per_day
+    self.spending_goal / self.days_in_month
+  end
+  
+  # How much the user has spent this month
+  def spent_this_month(option=nil)
+    case option
+    when :exclude_today
+      read_attribute(:spent_this_month) - self.spent_today
+    else
+      read_attribute(:spent_this_month)
+    end
+  end
+  
+  # Variance from budget based on savings_goal
+  def surplus(option=nil)
+    two_decimals(self.spending_goal - spent_this_month(option))
+  end
+  
+  # Variance from budget based on should_have_spent
+  def surplus_for_period(option=nil)
+    two_decimals(self.should_have_spent - spent_this_month(option))
+  end
+  
+  # Total remaining money for the month
+  def total_left(option=nil)
+    self.surplus(option) + self.savings_goal
+  end
+
+  private
+  
+  def after_create_email
+    self.add_email!(read_attribute(:email))
+  end
+  
+  def before_create_timestamps
+    self.reset_at = update_send_at
+    update_reset_at
+  end
+  
+  def before_save_recent_transactions
+    if self.recent_transactions
+      self.recent_transactions = self.recent_transactions[0..4]
+    end
+  end
+  
+  def before_save_savings_goal
+    if self.savings
+      self.savings_goal = self.savings
+    end
+  end
+  
+  def before_save_spending_goal
+    if self.income && self.bills && self.savings
+      self.spending_goal = self.income - self.bills - self.savings
+    end
+  end
+  
+  def local_12am_to_server_time
+    time = to_local(Time.now)
+    time = DateTime.strptime(
+      time.strftime("%m/%d/%Y 12:00 AM %Z"),
+      "%m/%d/%Y %I:%M %p %Z"
+    )
+    to_system(time.to_time)
+  end
+  
+  def to_local(time)
+    return time.utc unless self.timezone_offset
+    time.utc + self.timezone_offset
+  end
+  
+  def to_number(string)
+    string = string.gsub(/[^\d\.]/, '')
+    string.blank? ? string : string.to_f
+  end
+  
+  def to_system(time)
+    return time.utc unless self.timezone_offset
+    time.utc - self.timezone_offset
+  end
+  
+  def two_decimals(amount)
+    sprintf("%.2f", amount).to_f
+  end
+  
+  def update_reset_at
+    self.reset_at = self.reset_at + 1.month
+  end
+  
+  def update_send_at
+    if self.send_at
+      self.send_at = self.send_at + 1.day
+    else
+      self.send_at = local_12am_to_server_time
+    end
+  end
+end