muck-friends 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,51 @@
+= MuckFriends
+
+== Installation
+
+The muck friends engine is part of the muck framework and relies upon the muck_engine as well as the muck-users gem.  Both gems should be installed automatically when you install the muck-friends gem.  Refer
+to the documentation for muck-users for muck-users configuration.
+
+  sudo gem install muck-friends
+
+Add this to environment.rb:
+
+    config.gem 'muck-friends', :lib => 'muck_friends'
+
+
+Inside of global_config.yml add the following, changing the emails to match your application:
+
+  default: &DEFAULT
+
+    # Sent in emails to users
+    application_name: 'Name of my application'
+    from_email: 'support@example.com'
+    support_email: 'support@example.com'
+    admin_email: 'admin@example.com'
+
+    # Friend configuration
+    allow_following:  true        # If true then users can 'follow' each other.  If false then only friend requests will be used.
+    enable_friend_activity: true  # If true then friend related activity will show up in the activity feed.  Requires muck-activity gem
+    
+== Usage
+
+You will need a friend model that 'acts_as_muck_friend' and a user model that 'acts_as_muck_friend_user'
+
+== Example
+After installing the gem just create a friend model thus:
+
+  class Friend < ActiveRecord::Base  
+    acts_as_muck_friend
+    # install muck-activities and uncomment the following to have friend notifications show up in each user's activity feed.
+    # has_activities
+    # after_create :add_activity
+  end
+
+and a user model thus:
+
+  class User < ActiveRecord::Base
+    acts_as_muck_user
+    acts_as_muck_friend_user
+  end
+
+
+Copyright (c) 2009 Justin Ball, released under the MIT license

data/Rakefile

@@ -0,0 +1,101 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Translate this gem'
+task :translate do
+  file = File.join(File.dirname(__FILE__), 'locales', 'en.yml')
+  system("babelphish -o -y #{file}")
+end
+
+desc 'Test the muck_friends plugin.'
+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_friends plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MuckFriends'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "muck-friends"
+    gemspec.summary = "Friends engine for the muck system"
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/jbasdf/muck_friends"
+    gemspec.description = "Friend engine for the muck system."
+    gemspec.authors = ["Justin Ball"]
+    gemspec.rubyforge_project = 'muck-friends'
+    gemspec.add_dependency "muck-engine"
+    gemspec.add_dependency "muck-users"
+    gemspec.add_dependency "muck-profiles"
+    # gemspec.files.include %w( 
+    #                         tasks/*
+    #                         db/migrate/*.rb
+    #                         app/**/**/**/*
+    #                         config/*
+    #                         locales/*
+    #                         rails/*
+    #                         test/*
+    #                         lib/**/*
+    #                         public/**/* )
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# rubyforge tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/muck-friends/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION

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

data/app/controllers/muck/friends_controller.rb

@@ -0,0 +1,70 @@
+class Muck::FriendsController < ApplicationController
+  unloadable
+
+  before_filter :login_required, :except => [:index]
+  before_filter :get_user_and_target, :except => [:index]
+  
+  def index
+    @user = User.find(params[:user_id]) rescue current_user
+    respond_to do |format|
+      format.html { render :template => 'friends/index' }
+    end
+  end
+  
+  def create
+    respond_to do |format|
+      if Friend.make_friends(@user, @target)
+        friend = current_user.reload.friend_of? @target
+        format.html do
+          if GlobalConfig.allow_following
+            flash[:notice] = t('muck.friends.you_are_now_following', :user => @target.login)
+          else
+            flash[:notice] = t('muck.friends.friend_request_sent')
+          end             
+          redirect_to profile_path(@target)
+        end
+        format.js { render( :update ) {|page| page.replace make_id(@user, @target), get_friend_link(@user, @target)}}
+      else
+        if GlobalConfig.allow_following
+          message = t('muck.friends.problem_adding_follow', :user => @target.login)
+        else
+          message = t('muck.friends.problem_sending_friend_request', :user  => @target.login)
+        end
+        format.html do
+          flash[:notice] = message
+          redirect_to profile_path(@target)
+        end
+        format.js {render( :update ){|page| page.alert message}}
+      end
+    end
+  end
+
+  def destroy
+    @user.drop_friend(@target)
+    respond_to do |format|
+      format.html do
+        flash[:notice] = t('muck.friends.removed_friendship')
+        redirect_to profile_path(@target)
+      end
+      format.js do
+        render( :update ){|page| page.replace make_id(@user, @target), get_friend_link(@user, @target)}
+      end
+    end
+  end
+  
+  protected
+  
+  def make_id(user, target)
+    user.dom_id(target.dom_id + '_friendship_')
+  end
+  
+  def get_user_and_target
+    if admin? && params[:user_id]
+      @user = User.find(params[:user_id]) rescue current_user
+    else
+      @user = current_user
+    end
+    @target = User.find(params[:id])
+  end
+  
+end

data/app/helpers/muck_friends_helper.rb

@@ -0,0 +1,93 @@
+module MuckFriendsHelper
+
+  def follow_or_friend_requests
+    # TODO
+  end
+    
+  def follow_or_friend_request
+    render :partial => 'friends/friend_or_follow_request', :locals => { :user => user }
+  end
+
+  def all_friends(user)
+    render :partial => 'friends/friends', :locals => { :user => user }
+  end
+  
+  def friends(user)
+    return '' if user.nil?
+    users = user.friends.find(:all, :limit => size, :order => 'RAND()') rescue []
+    if users
+      render :partial => 'friends/friend_simple', :collection => users, :locals => { :user => user }
+    else
+      "<p>#{t('muck.friends.no_friends')}</p>"
+    end
+  end
+  
+  def followers(user)
+    return '' if user.nil?
+    users = user.followers.find(:all, :limit => size, :order => 'RAND()') rescue []
+    if users
+      render :partial => 'friends/friend_simple', :collection => users, :locals => { :user => user }
+    else
+      "<p>#{t('muck.friends.no_followers')}</p>"
+    end
+  end
+  
+  def followings(user)
+    return '' if user.nil?
+    users = user.followings.find(:all, :limit => size, :order => 'RAND()') rescue []
+    if users
+      render :partial => 'friends/friend_simple', :collection => users, :locals => { :user => user }
+    else
+      "<p>#{t('muck.friends.not_following_anyone')}</p>"
+    end
+  end
+
+  # TODO review this code
+  def get_friend_link(user, target)
+    
+    return wrap_get_friend_link(link_to( I18n.t('muck.friends.muck.friends.sign_up_to_follow'), signup_path)) if user.blank?
+    return '' unless user != :false && target
+    
+    dom_id = make_id(user, target)
+    
+    return wrap_get_friend_link('') if user == target
+    return wrap_get_friend_link(link_to_remote( I18n.t('muck.friends.stop_being_friends'), :url => user_friend_path(user, target), :method => :delete), dom_id) if user.friend_of? target
+    
+    if GlobalConfig.allow_following
+      return wrap_get_friend_link(link_to_remote( I18n.t('muck.friends.stop_following'), :url => user_friend_path(user, target), :method => :delete), dom_id) if user.following? target
+    else
+      if user.following? target
+        return wrap_get_friend_link( I18n.t('muck.friends.friend_request_pending', :link => link_to_remote(I18n.t('muck.friends.delete'), :url => user_friend_path(user, target), :method => :delete)), dom_id)
+      end
+    end
+    
+    return wrap_get_friend_link(link_to_remote( I18n.t('muck.friends.acccept_friend_request'), :url => user_friends_path(user, :id => target), :method => :post), dom_id) if user.followed_by? target
+    
+    if GlobalConfig.allow_following
+      wrap_get_friend_link(link_to_remote( I18n.t('muck.friends.start_following'), :url => user_friends_path(user, :id => target), :method => :post), dom_id)
+    else
+      wrap_get_friend_link(link_to_remote( I18n.t('muck.friends.friend_request'), :url => user_friends_path(user, :id => target), :method => :post), dom_id)
+    end
+    
+  end
+
+  def accept_follower_link user, target
+    dom_id = make_id(user, target)
+    wrap_get_friend_link(link_to_remote( I18n.t('muck.friends.accept'), { :url => user_friends_path(user, :id => target), :method => :post}, {:id => "accept-#{target.id}", :class => 'notification-link'}), dom_id)
+  end
+
+  def ignore_friend_request_link user, target
+    dom_id = make_id(user, target)
+    wrap_get_friend_link(link_to_remote( I18n.t('muck.friends.ignore'), { :url => user_friend_path(user, target), :method => :delete }, {:id => "ignore-#{target.id}", :class => 'notification-link'}), dom_id)
+  end
+
+  protected
+  def wrap_get_friend_link str, dom_id = ''
+    content_tag :span, str, :id => dom_id, :class => 'friendship-description'
+  end
+
+  def make_id user, target
+    user.dom_id(target.dom_id + '_friendship_')
+  end
+  
+end

data/app/models/friend_mailer.rb

@@ -0,0 +1,25 @@
+class FriendMailer < ActionMailer::Base
+  unloadable
+  layout 'email_default'
+  default_url_options[:host] = GlobalConfig.application_url
+  
+  def follow(inviter, invited)
+    setup_email(invited.email)
+    subject       I18n.t('muck.friends.following_you', :name => inviter.login, :application_name => GlobalConfig.application_name)
+    body          :inviter => inviter, :invited => invited
+  end
+
+  def friend_request(inviter, invited)
+    setup_email(invited.email)
+    subject       I18n.t('muck.friends.friend_request', :name => inviter.login, :application_name => GlobalConfig.application_name)
+    body          :inviter => inviter, :invited => invited
+  end
+  
+  protected
+  def setup_email(email)
+    recipients  email
+    from        "#{GlobalConfig.from_email_name} <#{GlobalConfig.from_email}>"
+    sent_on     Time.now
+  end
+  
+end

data/app/views/activity_templates/follow.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'activity_templates/generic', :locals => { :activity => activity, :activity_css_class => 'activity-follow' } %>

data/app/views/activity_templates/friends_with.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'activity_templates/generic', :locals => { :activity => activity, :activity_css_class => 'activity-friends-with' } %>

data/app/views/friend_mailer/follow.text.html.erb

@@ -0,0 +1,8 @@
+<p>Hi <%= h(@invited.login) %></p>
+
+<p><%= h(@inviter.login) %> is now following your updates on <%= GlobalConfig.application_name %>.</p>
+
+<p>You may find more information about <%= h(@inviter.login) %> on their profile <%= profile_url(@inviter) %></p>
+
+<p>Thanks, <br />
+The <%= GlobalConfig.application_name %> Team</p>

data/app/views/friend_mailer/follow.text.plain.erb

@@ -0,0 +1,8 @@
+Hi <%= h(invited.login) %>
+
+<%= h(inviter.login) %> is now following your updates on <%= GlobalConfig.application_name %>.
+
+You may find more information about <%= h(inviter.login) %> on their profile <%= profile_url(inviter) %>
+
+Thanks,
+The <%= GlobalConfig.application_name %> Team

data/app/views/friend_mailer/friend_request.text.html.erb

@@ -0,0 +1,8 @@
+<p>Hi <%= h(@invited.login) %></p>
+
+<p><%= h(@inviter.login) %> has sent you a friend request on <%= GlobalConfig.application_name %>.</p>
+
+<p>You may find more information about <%= h(@inviter.login) %> on their profile <%= profile_url(@inviter) %></p>
+
+<p>Thanks, <br />
+The <%= GlobalConfig.application_name %> Team</p>

data/app/views/friend_mailer/friend_request.text.plain.erb

@@ -0,0 +1,8 @@
+Hi <%= h(invited.login) %>
+
+<%= h(inviter.login) %> has sent you a friend request on <%= GlobalConfig.application_name %>.
+
+You may find more information about <%= h(inviter.login) %> on their profile <%= profile_url(inviter) %>
+
+Thanks,
+The <%= GlobalConfig.application_name %> Team

data/app/views/friends/_friend_simple.html.erb

@@ -0,0 +1,4 @@
+<div class="friend">
+	<%= icon friend %>
+	<%= link_to h(friend.display_name), profile_path(friend) %>
+</div>

data/app/views/friends/_friends.html.erb

@@ -0,0 +1,8 @@
+<h2>Friends</h2>
+<%= friends(user) %>
+<% if GlobalConfig.allow_following -%>
+  <h2>Followers</h2>
+  <%= followers(user) %>  
+  <h2>Following</h2>
+  <%= followings(user) %>
+<% end -%>

data/app/views/friends/_notifications.html.erb

@@ -0,0 +1,32 @@
+<div id="decline_request_to_join" class="hidden">
+	<%= render :partial => 'messages/decline', :locals => {:hide_header => true} %>
+</div>
+<% if !(@user.followers.empty? && @user.unread_messages.empty? && @user.pledge_requests.empty?) %>
+  <div id="notifications" class="activity_box">
+  	<h2><%= _('Notifications') %></h2>
+	  <ul>
+			<% if !GlobalConfig.allow_following -%>
+	    	<% @user.followers.each do |follower| %>
+		      <li>
+				<%= _("%{profile} requests to be your Friend %{accept} %{ignore}") % {:profile => link_to(h(follower.full_name), profile_path(follower)), 
+					:accept => accept_follower_link(current_user, follower),
+					:ignore => ignore_friend_request_link(current_user, follower) } -%></li>
+	      <% end %>
+			<% end %>
+	    <% @user.pledge_requests.each do |pledge| %>
+	      <li><%= _("%{profile} requests to join %{group_link} group %{admin_links}") % {
+				:profile => link_to(h(pledge.full_name), profile_path(pledge)), 
+				:group_link => link_to(h(pledge.group_name), group_path(pledge.url_key)),
+				:admin_links => pledge_admin_links(pledge) } -%>
+				</li>
+      <% end %>
+	  </ul>
+  </div>
+<% end %>
+<script type="text/javascript" language="JavaScript">
+jQuery(document).ready(function(){
+	jQuery(".notification-link").click(function(){
+		jQuery(this).parent().parent().fadeOut();
+  });
+});
+</script>