open_porch 0.5.0

data/Gemfile

@@ -0,0 +1,41 @@
+source 'http://rubygems.org'
+
+gem 'rails', '>= 3.0.4'
+gem 'pg', '0.10.1' # See installation notes below
+gem 'haml', '3.0.25'
+gem 'spatial_adapter', '1.2.0', :require => 'spatial_adapter/postgresql'
+gem 'wristband', '>= 1.0.4'
+gem 'formatted_form', '>= 1.0.1'
+gem 'geokit', '1.5.0'
+gem 'active_link_to', '0.0.6'
+gem "meta_where", '1.0.1'
+gem "meta_search", '1.0.1'
+gem "will_paginate", "~> 3.0.pre2"
+gem 'whenever', '0.6.2', :require => false
+gem 'postageapp'
+
+group :test do
+  gem "bundler"
+  gem "jeweler"
+  gem 'test_dummy'
+  gem 'faker'
+  gem 'mocha'
+end
+
+
+# Initial postgress configuration: 
+# http://www.glom.org/wiki/index.php?title=Initial_Postgres_Configuration
+
+
+
+# Installing the pg gem (https://bitbucket.org/ged/ruby-pg/wiki/Home)
+# ------------------------------------------------------------------------
+# 1 - You need to set the path to 'pg_config' in your PATH (i.e. where your postgres was installed )
+#   Example:
+#     /Library/PostgreSQL/9.0/bin
+
+# 2 - On Mac you need to specify the achitecture
+#   For Snow Leopard 32-bit build use: '-arch i386'
+#   For Snow Leopard 64-bit build use: '-arch x86_64'
+#   Example:
+#     ARCHFLAGS="-arch x86_64" gem install pg

data/Gemfile.lock

@@ -0,0 +1,130 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    GeoRuby (1.3.4)
+    aaronh-chronic (0.3.9)
+    abstract (1.0.0)
+    actionmailer (3.0.4)
+      actionpack (= 3.0.4)
+      mail (~> 2.2.15)
+    actionpack (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    active_link_to (0.0.6)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+    activesupport (3.0.4)
+    arel (2.0.8)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    faker (0.9.5)
+      i18n (~> 0.4)
+    formatted_form (1.0.1)
+    geokit (1.5.0)
+    git (1.2.5)
+    haml (3.0.25)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    meta_search (1.0.1)
+      actionpack (~> 3.0.2)
+      activerecord (~> 3.0.2)
+      activesupport (~> 3.0.2)
+      arel (~> 2.0.2)
+    meta_where (1.0.1)
+      activerecord (~> 3.0.2)
+      activesupport (~> 3.0.2)
+      arel (~> 2.0.2)
+    mime-types (1.16)
+    mocha (0.9.12)
+    pg (0.10.1)
+    polyglot (0.3.1)
+    postageapp (1.0.10)
+      json (>= 1.4.6)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.4)
+      actionmailer (= 3.0.4)
+      actionpack (= 3.0.4)
+      activerecord (= 3.0.4)
+      activeresource (= 3.0.4)
+      activesupport (= 3.0.4)
+      bundler (~> 1.0)
+      railties (= 3.0.4)
+    railties (3.0.4)
+      actionpack (= 3.0.4)
+      activesupport (= 3.0.4)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    spatial_adapter (1.2.0)
+      GeoRuby (>= 1.3.0)
+      activerecord (>= 2.2.2)
+    test_dummy (0.2.6)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    whenever (0.6.2)
+      aaronh-chronic (>= 0.3.9)
+      activesupport (>= 2.3.4)
+    will_paginate (3.0.pre2)
+    wristband (1.0.4)
+      formatted_form (>= 1.0.0)
+      formatted_form
+      haml (>= 3.0.25)
+      haml (>= 3.0.25)
+      rails (>= 3.0.4)
+      rails (>= 3.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_link_to (= 0.0.6)
+  bundler
+  faker
+  formatted_form (>= 1.0.1)
+  geokit (= 1.5.0)
+  haml (= 3.0.25)
+  jeweler
+  meta_search (= 1.0.1)
+  meta_where (= 1.0.1)
+  mocha
+  pg (= 0.10.1)
+  postageapp
+  rails (>= 3.0.4)
+  spatial_adapter (= 1.2.0)
+  test_dummy
+  whenever (= 0.6.2)
+  will_paginate (~> 3.0.pre2)
+  wristband (>= 1.0.4)

data/README.md

@@ -0,0 +1,170 @@
+# Open Porch
+* * *
+
+## Overview
+
+[Open Porch](http://openporch.org) was created by 2010 [Knight News Challenge](http://www.newschallenge.org/) winner [Front Porch Forum](http://frontporchforum.com) thanks to support from the [John S. and James L. Knight Foundation](http://www.knightfoundation.org/).  
+
+The software was built by [The Working Group, Inc.](http://www.theworkinggroup.ca/).  
+
+Open Porch design is based on experienced gained by operating the successful Front Porch Forum pilot project in Burlington, Vermont, USA, 2006-2010.
+
+Front Porch Forum's mission is to help nearby neighbors connect and build community.  It does that by hosting regional networks of small online neighborhood forums.  By early 2011, 24,000 households subscribed to its Vermont pilot, including half of those in Burlington.  People make great use of FPF to find lost cats, report car break-ins, borrow ladders, recommend plumbers, debate school budgets, announce a blood drive, organize a block party and much more.  Since each posting is shared among clearly identified nearby neighbors, people report that over time they feel more connected to neighbors and better informed about what's going on around them. This leads eventually, for many, to get more involved in local issues and fulfills FPF's mission.
+
+Front Porch Forum's new platform is based on Open Porch.  Open Porch is a Ruby on Rails gem released under an MIT open source license.
+
+**The Knight News Challenge:** KNC is a media innovation contest that aims to advance the future of news by funding new ways to digitally inform communities.
+
+**The Working Group, Inc.:** Since 2002, TWG has designed and built web sites, web applications, iPhone apps, and system integrations for entrepreneurs, mature businesses, governments, and non-profit organizations.
+
+
+* * *
+## Functionality
+
+### Overview
+
+* **User registration:** 
+  * A user can choose his neighbourhood on a map by entering his address. The system uses geolocation to direct the user to the closest neighbourhood.
+  * Once the user is logged in he can edit his account.
+  
+* **User authentication:** 
+  * This includes the basic login, logout, remember me functionality, forgot password and email verification.
+  
+* **Neighbourhood forums:** 
+  * Each user has access to a forum in his neighbourhood.
+  * The posts in a Neighborhood Forum are grouped in issues that are emailed periodically to all the members of the neighbourhood.
+  * A user can read the current issue on his Neighbourhood Forum or search for older issues.
+
+* **User participation:** 
+  * Users are encouraged to contribute to their Neighbourhood Forum by posting new messages via email of via the website.
+  
+### Administration
+
+* **Users:**
+  * As an administrator you can use the admin interface you can create, edit and delete users in the system.
+  * Users can be filtered by name, email or role.
+
+* **Areas:** 
+  * As an administrator you have access to all the areas (Neighbourhoods) in the system.
+  * Each area is represented by a polygon on a map. The points of an area can be manipulated directly by using the map editor tool provided.
+  * From the admin interface you can manage the area details, memberships and issues.
+  
+* **Issues:** 
+  * An area can operate in two distinct modes: immediate and batched.
+  * In immediate mode each message posted to a furum is immediatelly send to each user of the forum.
+  * In batched mode messages are held back for review by the administrator and can be edited and added to an issue individually. Each issue can then be scheduled individually.
+  
+* **Reports:** 
+  * Areas can be searched by name or location using the admin interface.
+  * Each area maintains records of it's activity regarding number of new users, quitters, new posts and new issues which can be visualized in a chart and filtered by date.
+
+
+
+* * *
+## Installation
+
+Open Porch uses [Postgres 9.0](http://www.postgresql.org) and [PostGIS](http://postgis.refractions.net) so we'll assume you have these as well as the [pg gem](https://bitbucket.org/ged/ruby-pg/wiki/Home) installed.
+
+
+### 1. Add gem definition to your Gemfile:
+    
+    gem 'open_porch'
+    
+### 2. Install your gems:
+    
+    bundle install
+    
+### 3. Run the generator:
+    
+    rails g open_porch
+    
+### 4. Setup your database.yml file using the sample provided database_example_.yml
+
+    development:
+      adapter: postgresql
+      encoding: utf8
+      schema_search_path: public
+      template: template_postgis
+      database: open_porch_development
+      pool: 5
+      username: open_porch
+      password:
+    
+The `template` option is particularly important because it is used on the database creation. 
+
+### 5. Create your spacially enabled database
+
+    rake db:create
+    
+When you instal the [PostGIS](http://postgis.refractions.net) extension you should make sure you also have the `template_postgis` database generated for you. This database contains all the functions needed for spacial calculations.
+
+Once you run `rake db:create`, a copy of `template_postgis` will be used to create your database.
+
+### 6. Run the migrations
+    
+    rake db:migrate
+    
+    
+  
+* * *
+## The generator
+
+    rails g open_porch
+
+The generator will give you a list of files you need to get started. You can and should change these files to serve the purpose of your website.
+
+* **Application controller:** You should use the application controller as a starting point. It calls methods related with user login.
+* **Static files:** These are all the javascripts, stylesheets and images used in Open Porch.
+* **Sample config files:** These are sample config files that will help you setup your own system.
+* **Migrations:** All the migrations needed by Open Porch
+
+
+
+* * *
+## Configuration
+
+Open Porch uses `config/open_porch.yml` aa it's main configuration file.
+
+### Mass mailing with PostageApp
+
+To send out the issues newsletter to all users in a forum, Open Porch makes use of [PostageApp](http://postageapp.com).
+
+To enable this functionality create a PostageApp account and fill in the respective section in `config/open_porch.yml`
+
+
+### POP3 server
+
+Open Porch can read emails posted to a POP3 server. 
+By looking up the FROM field it can find the user who sent the message. By looking up the TO field it can find the destination furum. This mechanism allows users to communicate directly with their neighbourhood forum via email.
+
+To enable this functionality fill in the respective section in `config/open_porch.yml`
+
+### Advertisement with OpenX
+
+Open Porch displays ads on each forum page. 
+
+To enable this functionality create an OpenX account and fill in the respective section in `config/open_porch.yml`
+
+
+
+
+* * *
+## Cronjobs
+
+Open Porch uses the `whenever` gem to send issue newsletters and to fetch new messages from the pop3 server.
+
+Install `whenever` and create you `schedule.rb` file 
+
+    set :output, "log/cron.log"
+    job_type :exec, "cd :path && RAILS_ENV=:environment :task :output"
+
+    every 5.minutes do
+      exec "open_porch_engine"
+    end
+
+
+* * *
+## License
+
+Open Porch is released under the [GNU General Public License, version 3 (GPLv3)](http://www.opensource.org/licenses/gpl-3.0)
+

data/Rakefile

@@ -0,0 +1,19 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+OpenPorch::Application.load_tasks
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "open_porch"
+  gem.homepage = "http://github.com/FrontPorchForum/open_porch"
+  gem.license = "MIT"
+  gem.summary = 'Open Porch is Rails Engine'
+  gem.description = ''
+  gem.email = "jack@theworkinggroup.ca"
+  gem.authors = ['The Working Group Inc']
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/app/controllers/admin/areas/base_controller.rb

@@ -0,0 +1,11 @@
+class Admin::Areas::BaseController < Admin::BaseController
+  before_filter :require_authority_to_manage_areas
+  before_filter :load_area
+
+protected
+  def load_area
+    @area = Area.find(params[:area_id])
+  rescue ActiveRecord::RecordNotFound
+    render :text => 'Area not found', :status => 404
+  end
+end

data/app/controllers/admin/areas/issues_controller.rb

@@ -0,0 +1,67 @@
+class Admin::Areas::IssuesController < Admin::Areas::BaseController
+  before_filter :load_issue,
+    :except => [:index, :new]
+  before_filter :block_edit_if_sent,
+    :except => [:index, :new, :show]
+  
+  def index
+    @issues = @area.issues.order("number DESC").paginate(:page => params[:page])
+  end
+  
+  def new
+    @issue = @area.issues.create!
+    redirect_to edit_admin_area_issue_path(@area, @issue)
+  end
+
+  def edit
+    load_posts
+  end
+  
+  def show
+    if @issue.sent_at.blank?
+      redirect_to edit_admin_area_issue_path(@area, @issue)
+    end
+  end
+  
+  def update
+    @issue.update_attributes!(params[:issue])
+    redirect_to edit_admin_area_issue_path(@area, @issue)
+  rescue ActiveRecord::RecordInvalid
+    load_posts
+    render :action => :edit
+  end
+
+  def add_posts
+    return if params[:posts].blank?
+    Post.update_all(['issue_id = %d', @issue.id], ['id IN (?)', params[:posts]])
+  end
+
+  def remove_posts
+    return if params[:posts].blank?
+    Post.update_all('issue_id = NULL', ['id IN (?)', params[:posts]])
+  end
+  
+protected
+  def load_area
+    @area = Area.find(params[:area_id])
+  rescue ActiveRecord::RecordNotFound
+    render :text => 'Area not found.', :status => 404
+  end
+
+  def load_issue
+    @issue = @area.issues.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    render :text => 'Issue not found.', :status => 404
+  end
+  
+  def load_posts
+    @new_posts = @area.posts.in_issue(nil).order('created_at DESC')
+    @issue_posts = @area.posts.in_issue(@issue).order('position')
+  end
+  
+  def block_edit_if_sent
+    if @issue.sent_at.present?
+      redirect_to admin_area_issue_path(@area, @issue) 
+    end
+  end
+end

data/app/controllers/admin/areas/memberships_controller.rb

@@ -0,0 +1,7 @@
+class Admin::Areas::MembershipsController < Admin::Areas::BaseController
+
+  def index
+    @memberships =  @area.memberships.includes(:user)
+  end
+
+end

data/app/controllers/admin/areas/posts_controller.rb

@@ -0,0 +1,44 @@
+class Admin::Areas::PostsController < Admin::Areas::BaseController
+  respond_to :js
+  before_filter :load_post,
+    :except => :order
+  
+  def edit
+  end
+  
+  def update
+    @post.update_attributes(params[:post])
+  end
+  
+  def show
+  end
+  
+  def order
+    if params[:post].present?
+      params[:post].each_with_index do |post, i|
+        Post.update_all(['position = %d', i], ['id = %d', post])
+      end
+    end
+    render :nothing => true
+  end
+  
+  def toggle_reviewed_by
+    if !@post.reviewed_by
+      @post.update_attribute(:reviewed_by, current_user.full_name)
+    else
+      @post.update_attribute(:reviewed_by, nil)
+    end
+    render :layout => false
+  end
+  
+  def destroy
+    @post.destroy
+  end
+
+protected
+  def load_post
+    @post = @area.posts.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    render :nothing => true, :status => 404
+  end
+end

data/app/controllers/admin/areas_controller.rb

@@ -0,0 +1,89 @@
+class Admin::AreasController < Admin::BaseController
+  before_filter :require_authority_to_manage_areas
+  before_filter :build_area,
+    :only => [:new, :create]
+  before_filter :load_area,
+    :except => [:index, :new, :create, :edit_borders, :bulk_update]
+    
+  def index
+    params[:search] ||= {}
+    params[:search][:meta_sort] ||= 'city'
+    @search = Area.search(params[:search])
+    @areas = @search.paginate(:page => params[:page])
+    @new_posts = Area.newposts_count
+    
+    start_date =  Time.parse(params[:activity_start_date]).to_date    rescue 30.days.ago.to_date
+    end_date =    Time.parse(params[:activity_end_date]).to_date      rescue Date.today
+    
+    @activities = AreaActivity.grouped_by_day
+                    .search(:day_between => [start_date, end_date])
+                    .where(:area_id => @search.all.collect(&:id))
+  end
+  
+  def new
+  end
+  
+  def create
+    @area.save!
+    respond_to do |format|
+      format.html do
+        redirect_to([:admin, :areas], :notice => 'Area has been successfully created.')
+      end
+      format.js do
+        render :text => @area.id
+      end
+    end
+  rescue ActiveRecord::RecordInvalid
+    render :action => :new
+  end
+  
+  def show
+    redirect_to [:edit, :admin, @area, @area.issues.last]
+  end
+  
+  def edit
+    # ...
+  end
+  
+  def edit_borders
+    @areas = Area.all
+    @area = @selected_area = @areas.detect{|area| area.id == params[:id].to_i}
+    if @selected_area.nil?
+      @default_area = @areas.first
+    end
+  end
+  
+  def update
+    @area.update_attributes!(params[:area])
+    redirect_to([:admin, :areas], :notice => 'Area has been successfully updated.')
+  rescue ActiveRecord::RecordInvalid
+    render :action => :edit
+  end
+  
+  def bulk_update
+    params[:areas].each do |index, area_params|
+      area = Area.find(area_params[:id])
+      area.coordinates = area_params[:coordinates]
+      area.save!
+    end
+    render :nothing => true
+  rescue ActiveRecord::RecordInvalid
+    render :nothing => true, :status => :bad_request
+  end
+  
+  def destroy
+    @area.destroy
+    redirect_to([:admin, :areas], :notice => 'Area has been successfully deleted.')
+  end
+
+protected
+  def build_area
+    @area = Area.new(params[:area])
+  end
+  
+  def load_area
+    @area = Area.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    render :text => 'Area not found', :status => 404
+  end
+end

data/app/controllers/admin/base_controller.rb

@@ -0,0 +1,16 @@
+class Admin::BaseController < ApplicationController
+  layout 'admin'
+
+protected
+  def require_authority_to_manage_users
+    unless current_user.has_authority_to?(:manage_users)
+      redirect_to(area_path(current_user.areas.first), :alert => "You're not authorized to access that page.") 
+    end
+  end
+  
+  def require_authority_to_manage_areas
+    unless current_user.has_authority_to?(:manage_areas)
+      redirect_to(area_path(current_user.areas.first), :alert => "You're not authorized to access that page.") 
+    end
+  end
+end

data/app/controllers/admin/user_activity_controller.rb

@@ -0,0 +1,29 @@
+class Admin::UserActivityController < Admin::BaseController
+  before_filter :require_authority_to_manage_areas
+  before_filter :load_user_activity
+  
+  def index
+  end
+  
+  def show
+    @user_activities = UserActivity.active_for_page(current_user.full_name, params[:url]).order('name DESC')
+    render :layout => false, :object => @user_activities
+  rescue ActiveRecord::RecordInvalid
+    head :bad_request
+  end
+  
+  def edit
+  end
+  
+  def update
+    @user_activity.set_expiration!
+    render :nothing => true
+  end
+  
+protected
+  
+  def load_user_activity
+    @user_activity = UserActivity.find_or_create_by_name_and_url(:name => current_user.full_name, :url => params[:url])
+  end
+  
+end

data/app/controllers/admin/users_controller.rb

@@ -0,0 +1,57 @@
+class Admin::UsersController < Admin::BaseController
+  before_filter :require_authority_to_manage_users
+  before_filter :load_user,
+    :except => [:index, :new, :create]
+  before_filter :build_user,
+    :only => [:new, :create]
+  
+  def index
+    params[:search] ||= {}
+    params[:search][:meta_sort] ||= 'created_at.desc'
+    @search = User.search(params[:search])
+    @users = @search.paginate(:page => params[:page])
+  end
+  
+  def new
+    @user.memberships.build
+  end
+  
+  def create
+    @user.save!
+    redirect_to(admin_users_path, :notice => 'User was successfully created.')
+  rescue ActiveRecord::RecordInvalid
+    render :action => :new
+  end
+  
+  def edit
+  end
+  
+  def update
+    @user.send(:attributes=, params[:user], false)
+    @user.save!
+    redirect_to(@return_url, :notice => 'User has been successfully updated.')
+  rescue ActiveRecord::RecordInvalid
+   render :action => :edit
+  end
+  
+  def destroy
+    @user.destroy
+    redirect_to([:admin, :users], :notice => 'User has been successfully deleted.')
+  end
+  
+protected
+  def load_user
+    @user = User.find(params[:id])
+    if params[:area_id]
+      @return_url = admin_area_memberships_path(params[:area_id])
+    else
+      @return_url = admin_users_path
+    end
+  rescue ActiveRecord::RecordNotFound
+    render :text => 'User not found', :status => 404
+  end
+  
+  def build_user
+    @user = User.new(params[:user])
+  end
+end