muck-invites 0.1.1

data/.gitignore

@@ -0,0 +1,30 @@
+**/*.pid
+log/*.log
+log/*.pid
+tmp
+.DS_Store
+public/cache/**/*
+public/system/**/*
+doc/**/*
+db/*.sqlite3
+.project
+.loadpath
+nbproject/
+.idea
+testjour.log
+*.so
+*.o
+Makefile
+mkmf.log
+*.bundle
+conftest
+content/
+REVISION
+deploy.rb
+pkg/*
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+test/feed_archive

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Ball
+
+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.rdoc

@@ -0,0 +1,6 @@
+= Muck Invites
+
+
+== Setup
+
+Copyright (c) 2009 Muck Your App, released under the MIT license

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test muck-invites.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test/rails_root/test'
+  t.pattern = 'test/rails_root/test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    #t.libs << 'lib'
+    t.libs << 'test/rails_root/lib'
+    t.pattern = 'test/rails_root/test/**/*_test.rb'
+    t.verbose = true
+    t.output_dir = 'coverage'
+    t.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+desc 'Generate documentation for the muck-invites gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MuckInvites'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Translate this gem'
+task :translate do
+  file = File.join(File.dirname(__FILE__), 'locales', 'en.yml')
+  system("babelphish -o -y #{file}")
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "muck-invites"
+    gemspec.summary = "The invite engine for the muck system"
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/jbasdf/muck_invites"
+    gemspec.description = "The invite engine for the muck system."
+    gemspec.authors = ["Justin Ball, Joel Duffin"]
+    gemspec.rubyforge_project = 'muck-invites'
+    gemspec.add_dependency "contacts"
+    gemspec.add_dependency "muck-engine"
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/app/controllers/muck/invites_controller.rb

@@ -0,0 +1,62 @@
+class Muck::InvitesController < ApplicationController
+
+  unloadable
+
+  before_filter :login_required
+
+  def new
+    flash.discard
+    @page_title = t('muck.invites.new_invites', :app_name => GlobalConfig.application_name)
+    respond_to do |format|
+      format.html { render :template => 'invites/new' }
+      format.pjs { render :template => 'invites/new', :layout => false }
+    end
+  end
+
+  def get_contacts
+    success = true
+    begin
+      @contacts = User.get_contacts(params[:get_contacts][:email], params[:get_contacts][:password])
+      if @contacts.blank?
+        message = t('muck.invites.no_contacts_found')
+        success = false
+      end
+    rescue Contacts::AuthenticationError => ex
+      success = false
+      message = ex.to_s
+    end    
+    respond_to do |format|
+      format.html do
+        flash[:error] = message if message
+        render :template => 'invites/_get_contacts'
+      end
+      format.json do
+        render :json => { :success => success, :message => message, :html => get_contacts_html }
+      end
+    end
+  end
+
+  def create
+    if params[:emails]
+      current_user.invite(params[:emails])
+      flash[:notice] = t('muck.invites.create_success', :emails => params[:emails].join(', '), :app_name => GlobalConfig.application_name)
+    end  
+    redirect_to('/')
+  rescue ActiveRecord::RecordInvalid => ex
+    if @invite
+      errors = @invite.errors.full_messages.to_sentence
+    else
+      errors = ex
+    end
+    flash[:error] = t('muck.invites.create_error', :errors => errors)
+  end
+
+  protected
+
+    def get_contacts_html
+      render_as_html do
+        render_to_string(:partial => 'invites/get_contacts')
+      end
+    end
+  
+end

data/app/models/invite_mailer.rb

@@ -0,0 +1,28 @@
+class InviteMailer < ActionMailer::Base
+  unloadable
+  
+  layout 'email_default'
+  default_url_options[:host] = GlobalConfig.application_url
+  
+  def invite_notification(user, email)
+    setup_email(email)
+    subject   I18n.t('muck.invites.invite', :inviter => user.full_name, :app_name => GlobalConfig.application_name)
+    body      :user => user
+  end
+
+  def invited_joined_notification(user, inviter)
+    setup_email(inviter.email)
+    subject   I18n.t('muck.invites.invited_joined', :user => inviter.full_name)
+    body      :user => user, :inviter => inviter
+  end
+  
+  protected
+
+  def setup_email(email)
+    recipients    email
+    from          "#{GlobalConfig.from_email_name} <#{GlobalConfig.from_email}>"
+    sent_on       Time.now
+    content_type "text/html" # There is a bug in Rails that prevents multipart emails from working inside an engine.  See: https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2263-rails-232-breaks-implicit-multipart-actionmailer-tests#ticket-2263-22
+  end
+
+end

data/app/models/user_invite.rb

@@ -0,0 +1,6 @@
+class UserInvite < ActiveRecord::Base
+  unloadable
+
+  belongs_to :user
+  belongs_to :invite
+end

data/app/views/invite_mailer/invite_notification.text.html.erb

@@ -0,0 +1,9 @@
+<p><%= h(@user.full_name) %> invites you to join Folksemantic.</p>
+
+<p>Folksemantic is the leading OpenCourseWare search engine. It has over 110,000 resources in its index and provides tools for sharing and discussing resources and receiving personalized recommendations.</p>
+
+<p>Visit Folksemantic at: <a href="<%= root_url %>"><%= root_url %></a></p>
+
+<p>See what <%= h(@user.full_name) %> is doing at: <a href="<%= profile_path(@user) %>"><%= profile_path(@user) %></a></p>
+
+<p>If the links do not work, try copying and pasting them into your web browser.</p>

data/app/views/invite_mailer/invite_notification.text.plain.erb

@@ -0,0 +1,9 @@
+<%= h(@user.full_name) %> invites you to join Folksemantic.
+
+Folksemantic is the leading OpenCourseWare search engine. It has over 110,000 resources in its index and provides tools for sharing and discussing resources and receiving personalized recommendations.
+
+Visit Folksemantic at: <%= root_url %>
+
+See what <%= h(@user.full_name) %> is doing at: <%= profile_path(@user) %>
+
+If the links do not work, try copying and pasting them into your web browser.

data/app/views/invite_mailer/invited_joined_notification.text.html.erb

@@ -0,0 +1,5 @@
+<p><%= h(@user.full_name) %>, a contact you invited, joined Folksemantic.</p>
+
+<p>Visit <%= h(@user.full_name) %>'s profile to see what they are doing and to begin following them: <a href="<%= profile_path(@inviter) %>"><%= profile_path(@inviter) %></a></p>
+
+<p>If the links do not work, try copying and pasting them into your web browser.</p>

data/app/views/invite_mailer/invited_joined_notification.text.plain.erb

@@ -0,0 +1,5 @@
+<%= h(@user.full_name) %>, a contact you invited, joined Folksemantic.
+
+Visit <%= h(@user.full_name) %>'s profile to see what they are doing and to begin following them: <%= profile_path(@inviter) %>
+
+If the links do not work, try copying and pasting them into your web browser.

data/app/views/invites/_get_contacts.html.erb

@@ -0,0 +1,27 @@
+<%= output_errors(t('muck.invites.problem_adding_invite'), {:class => 'help-box'}, @invite) %>
+<% if !@contacts.blank? -%>
+  <% custom_form_for(:invite_contacts, :url => {:action => 'create'}, :html => {:id => "invite-contacts-form", :name => 'invite-contacts-form'} ) do |f| -%>
+     <div id="contact-chooser">
+       <div id="contact-chooser-list">
+         <fieldset>
+           <div id="select-all-contacts">
+             <input id="select-all" type="checkbox" onclick='jQuery("input[type=checkbox]").attr("checked",jQuery("#select-all:checked").val() != null);' />
+             <%= t('muck.invites.select_all') %>
+           </div>
+           <div class="table-wrapper">
+             <table id="contacts-list">
+               <% @contacts.each do |contact| %>
+                 <tr class="contact">
+                   <td class="cb"><input type="checkbox" value="<%= h(contact[1]) %>" name="emails[]"></td>
+                   <td class="name"><%= contact[0] %></td>
+                   <td class="email"><%= contact[1] %></td>
+                 </tr>
+               <% end %>
+             </table>
+           </div>
+         </fieldset>
+       </div>
+     </div>
+     <%= f.submit t('muck.invites.invite_button'), :class => "button invite-submit" %>
+  <% end -%>
+<% end -%>

data/app/views/invites/new.html.erb

@@ -0,0 +1,50 @@
+<div id="invite-contacts">
+  <h1><%= @page_title %></h1>
+  <div id="notice-error" class="error message" style="display:none"></div>
+  <div id="get-contacts-form">
+    <% custom_form_for(:get_contacts, :url => get_contacts_invites_path,
+                                    :html => {:id => "get-contacts-form", :name => 'get-contacts-form',
+                                    :class => 'get-contacts-form', :autocomplete => 'off'} ) do |f| -%>
+      <%= f.text_field :email, { :label => t('muck.invites.your_email'),
+                                 :tip => t('muck.invites.your_email_help')} -%>
+      <%= f.password_field :password, { :label => t('muck.invites.email_password'),
+                                        :tip => t('muck.invites.email_password_help')} -%>
+      <%= f.submit t('muck.invites.continue_button'), :class => "button invite-submit", :id => 'get-contacts-button' %>
+    <% end -%>
+  </div>
+  <div id="contacts-loading" style="display:none">
+    <img src="/images/spinner.gif" alt="loading..." />
+    <%= t('muck.invites.retrieving_contacts') %>
+  </div>
+  <div id="contacts-chooser-wrapper" style="display:none;"></div>
+</div>
+
+<script type="text/javascript">
+jQuery(document).ready(function() {
+  jQuery("#get-contacts-button").click(function() {
+    jQuery("#get-contacts-form").hide();
+    jQuery("#contacts-loading").show();
+    jQuery("#notice-error").hide();
+    var form = jQuery(this).parents('form');
+    jQuery.post(form.attr('action'), form.serialize() + '&format=json',
+    function(data){
+      var json = eval('(' + data + ')');
+      jQuery("#contacts-loading").hide();
+      if(!json.success){
+        <% if GlobalConfig.growl_enabled -%>
+          jQuery.jGrowl.info(json.message);
+        <% else -%>
+          jQuery("#notice-error").html(json.message);
+          jQuery("#notice-error").show();
+          jQuery("#get-contacts-form").show();
+        <% end -%>
+      } else {
+        jQuery("#contacts-chooser-wrapper").html(json.html);
+        jQuery("#contacts-chooser-wrapper").show();
+      }
+    });
+    return false;
+  });
+});
+</script>
+

data/config/muck_invites_routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :invites, :controller => 'muck/invites', :collection => { :get_contacts => :post }
+end

data/db/migrate/20090928213532_create_invites.rb

@@ -0,0 +1,20 @@
+class CreateInvites < ActiveRecord::Migration
+  def self.up
+    create_table :invites, :force => true do |t|
+      t.string  "email", :null => false
+    end
+    add_index :invites, ["email"]
+
+    create_table :user_invites, :force => true do |t|
+      t.integer  "user_id", :null => false
+      t.integer  "invite_id", :null => false
+      t.timestamp "created_at", :null => false
+    end
+    add_index :user_invites, ["user_id"]
+  end
+
+  def self.down
+    drop_table :user_invites
+    drop_table :invites
+  end
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/active_record/acts/muck_invite.rb

@@ -0,0 +1,57 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckInvite #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def acts_as_muck_invite(options = {})
+
+          has_many :user_invites
+          has_many :users, :through => :user_invites
+          validates_presence_of :email
+
+          named_scope :by_newest, :order => "created_at DESC"
+          named_scope :by_oldest, :order => "created_at ASC"
+          named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
+
+          email_name_regex  = '[\w\.%\+\-]+'.freeze
+          domain_head_regex = '(?:[A-Z0-9\-]+\.)+'.freeze
+          domain_tld_regex  = '(?:[A-Z]{2}|com|org|net|edu|gov|mil|biz|info|mobi|name|aero|jobs|museum)'.freeze
+          email_regex       = /\A#{email_name_regex}@#{domain_head_regex}#{domain_tld_regex}\z/i
+
+          validates_format_of :email, :with => email_regex, :message => 'does not look like a valid email address.'
+
+          include ActiveRecord::Acts::MuckInvite::InstanceMethods
+          extend ActiveRecord::Acts::MuckInvite::SingletonMethods
+          
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+
+        def who_invited?(email, id = nil)
+          users = []
+
+          if !id.nil?
+            invite = Invite.find(id)
+            users |= invite.users if !invite.nil?
+          end
+
+          invite = Invite.find_by_email(email)
+          users |= invite.users if !invite.nil?
+
+          users
+        end
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_invite</tt> specified.
+      module InstanceMethods
+
+      end
+    end
+  end
+end

data/lib/active_record/acts/muck_inviter.rb

@@ -0,0 +1,68 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckInviter #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def acts_as_muck_inviter(options = {})
+
+          has_many :user_invites
+          has_many :invites, :through => :user_invites
+
+          named_scope :by_newest, :order => "created_at DESC"
+          named_scope :by_oldest, :order => "created_at ASC"
+          named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
+                            
+          include ActiveRecord::Acts::MuckInviter::InstanceMethods
+          extend ActiveRecord::Acts::MuckInviter::SingletonMethods
+          
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+        def get_contacts(email, password)
+          return Contacts::Gmail.new(email, password).contacts if email.include?('@gmail.com')
+          return Contacts::Yahoo.new(email, password).contacts if email.include?('@yahoo.com')
+          return Contacts::Hotmail.new(email, password).contacts if email.include?('@hotmail.com')
+        end
+      end
+      
+      # All the methods available to a record that has had <tt>acts_as_muck_inviter</tt> specified.
+      module InstanceMethods
+
+        def notify_inviters(invite_id = nil)
+          inviters = Invite.who_invited?(self.email, invite_id)
+          if inviters.size > 0
+            content = I18n.t('muck.activities.joined_status', :name => self.full_name, :application_name => GlobalConfig.application_name)
+            inviters.each do |inviter|
+              add_activity(self, self, self, 'status_update', '', content) if GlobalConfig.create_activities_when_invited_joins
+              send_invited_joined_emails(inviters) if GlobalConfig.email_inviters_when_invited_joins
+            end
+          end 
+        end
+
+        def send_invited_joined_emails(inviters)
+          
+        end
+
+        def invite(emails)
+          emails = emails.split(/[, ]/) if !emails.is_a?(Array)
+          emails = emails.find_all { |email| !email.blank?}
+          raise I18n.t('muck.invites.no_email_error') if emails.blank?
+          emails.each do |email|
+            invite = Invite.find_by_email(email) || Invite.create(:email => email)
+            invites << invite if !invites.include?(invite)
+          end 
+        end
+
+        def inviters
+          Invite.who_invited?(self.email)
+        end
+      end
+    end
+  end
+end