muck-services 0.1.34 → 0.1.35

data/VERSION

@@ -1 +1 @@
-0.1.34
+0.1.35

data/app/controllers/muck/entries_controller.rb

@@ -42,15 +42,14 @@ class Muck::EntriesController < ApplicationController
       render_text "Unable to find the specified document"
       return
     end
-    @entry_title = @entry.title + ' (' + @entry.feed.short_title + ')'
-    @page_title = @entry_title + ' - ' + I18n.t('muck.services.related_resources_title')
-#    I18n.locale = @entry.language[0..1]
+    @entry_title = "#{@entry.title} (#{@entry.feed.short_title})"
+    @page_title = "#{@entry_title} - #{I18n.t('muck.services.related_resources_title')}"
     @limit = params[:limit] ? params[:limit].to_i : 20
     @limit = 40 if @limit > 40
 
     respond_to do |format|
       format.html do
-        @recommendations = @entry.recommendations(@limit, 'relevance', params[:details] == 'true')
+        @recommendations = @entry.related_entries.top(true, @limit)
         if params[:details] == 'true'
           render :template => "entries/details"
         else

data/app/controllers/muck/recommendations_controller.rb

@@ -1,51 +1,45 @@
 class Muck::RecommendationsController < ApplicationController
-  
+
   unloadable
     
-  # GET /recommendations
-  # GET /recommendations.xml
   def index
-    @details = (params[:details] == 'true')
-
+    # if a uri isn't specified in params, we assume that they are requesting from the page doing the requesting
     @uri = params[:u] || request.env['HTTP_REFERER']
     if @uri.blank? || !allowed_uri(@uri)
       render :text => '<!-- permission denied -->'
       return
     end
-    
+
+    # we trim eduCommons urls back to the course so all pages in the course get the same recommendations
     if params[:educommons]
       @uri = @uri[%r=http://.*?/.*?/[^/]+=] || @uri
       params[:title] = true
       params[:more_link] = true
     end
 
-#    Entry.track_time_on_page(session, @uri)
-    @entry = Entry.recommender_entry(@uri)
-#    I18n.locale = @entry.language[0..1] if !@entry.nil?
-
+    @details = (params[:details] == 'true')
     @limit = params[:limit] ? params[:limit].to_i : 5
     @limit = 25 if @limit > 25
-    
+    @omit_feeds = params[:omit_feeds]
+    @order = params[:order] || "rank"
+
+    Entry.track_time_on_page(session, @uri)
+    @entry = Entry.recommender_entry(@uri)
+    @recommendations = @entry.related_entries.top(@details, @limit, @omit_feeds, @order)
+    @app = request.protocol + request.host_with_port
+
     respond_to do |format|
       format.html do
-        order = params[:order] || "mixed"
         if !@entry.id.nil?
-          redirect_to resource_path(@entry) + "?limit=#{@limit}&order=#{order}&details=#{@details}"
+          redirect_to resource_path(@entry) + "?limit=#{@limit}&order=#{@order}&details=#{@details}"
         else
-          @recommendations = @entry.ranked_recommendations(@limit, params[:order] || "mixed", @details)
-          render :template => 'recommendations/index'
+          render(:text => t('muck.services.url_not_in_index', :uri => params[:uri]), :layout => true)
         end
       end
-      format.xml  { 
-        render('recommendations/index.xml.builder', :layout => false)
-      }
-      format.pjs {
-        @host = "http://#{URI.parse(@uri).host}"
-        render('recommendations/index.pjs.erb', :layout => false)
-      }
-      format.rss {
-        render(:template => 'recommendations/index.rss.builder', :layout => false)  
-      }
+      format.xml  { render('recommendations/index.xml.builder', :layout => false) }
+      format.pjs { render('recommendations/index.pjs.erb', :layout => false) }
+      format.rss { render('recommendations/index.rss.builder', :layout => false) }
+      format.js { render('recommendations/index.js.erb', :layout => false) }
     end
   end
 

data/app/controllers/muck/visits_controller.rb

@@ -9,7 +9,7 @@ class Muck::VisitsController < ApplicationController
     @page_title = @entry.title
     @resource_uri = @entry.resource_uri
     @share = Share.new(:title => @entry.title, :uri => @resource_uri, :entry_id => @entry.id) if GlobalConfig.enable_services_shares
-    @recommendations = @entry.recommendations(5)
+    @recommendations = @entry.related_entries.top
 
     if GlobalConfig.enable_services_comments
       # Show the activities related to this entry

data/app/models/entry.rb

@@ -34,18 +34,31 @@ class Entry < ActiveRecord::Base
   has_many :activities, :as => :attachable, :dependent => :destroy
   has_many :attentions, :dependent => :destroy
   has_many :personal_recommendations, :as => :destination
+
+  has_many :related_to, :foreign_key => 'entry_id', :class_name => 'Recommendation'
+  has_many :related_entries, :through => :related_to, :source => :dest_entry do
+    def top(details=false, limit=5, omit_feeds=nil, order='rank desc, relevance desc')
+      select = 'entries.feed_id, recommendations.id recommendation_id, recommendations.relevance, ' +
+               'entries.title, feeds.short_title collection, recommendations.dest_entry_id '
+      select << ', entries.author, entries.published_at, recommendations.clicks, entries.permalink, ' +
+                'entries.direct_link direct_uri, ' +
+                'recommendations.avg_time_at_dest average_time_at_dest, entries.description' if details
+      conditions = omit_feeds == nil ? '' : "entries.feed_id NOT IN (#{omit_feeds.gsub(/[^0-9,]/,'')})"
+      joins = 'INNER JOIN feeds ON entries.feed_id = feeds.id'
+      find(:all, :select => select, :joins => joins, :conditions => conditions, :limit => limit, :order => order)
+    end
+  end
+
   acts_as_commentable
   acts_as_taggable
   acts_as_muck_recommendation
   
+  @@min_secs_tracked = 5
+  @@max_secs_tracked = 120
   @@default_time_on_page = 60.0
   
   acts_as_solr({:if => false, :fields => [{:aggregation => :integer}, {:feed_id => :integer}, {:grain_size => :string}, {:tags => :string}]}, {:type_field => :type_s})
 
-  def resource_uri 
-    self.direct_link.nil? ? self.permalink : self.direct_link
-  end
-  
   def self.search(search_terms, grain_size = nil, language = "en", limit = 10, offset = 0, operator = :or)
     raise MuckServices::Exceptions::LanguageNotSupported, I18n.t('muck.services.language_not_supported') unless Recommender::Languages.supported_languages.include?(language)
     query = ((!grain_size.nil? && grain_size != 'all') ? (search_terms + ") AND (grain_size:#{grain_size}") : search_terms) + ") AND (aggregation:#{Aggregation.global_feeds_id}"
@@ -54,198 +67,36 @@ class Entry < ActiveRecord::Base
         :joins => "INNER JOIN feeds ON feeds.id = entries.feed_id", :core => language, :operator => operator)
   end
 
-  def self.recommender_entry(uri)
-    uri = normalized_uri(uri)
-    Entry.find(:first, :conditions => ['permalink = ? OR direct_link = ?', uri, uri], :order => 'direct_link IS NULL DESC') || Entry.new(:permalink => uri)
-  end
-  
-  def recommendation_entries(limit = 20, order = "relevance", details = false, omit_feeds = nil)
-    sql = "SELECT recommendations.dest_entry_id AS id, entries.permalink, entries.title, entries.description, entries.direct_link, feeds.short_title AS collection "
-    sql << ", relevance_calculated_at, relevance, clicks, avg_time_at_dest AS avg_time_on_target, author, published_at " if details == true
-    sql << "FROM recommendations "
-    sql << "INNER JOIN entries ON recommendations.dest_entry_id = entries.id "
-    sql << "INNER JOIN feeds ON entries.feed_id = feeds.id "
-    sql << "WHERE recommendations.entry_id = ? "
-    sql << ("AND entries.feed_id NOT IN (" + omit_feeds.gsub(/[^0-9,]/,'') + ") ") if omit_feeds != nil
-    sql << "ORDER BY " + order + " DESC "
-    sql << "LIMIT " + limit.to_s
-    Entry.find_by_sql([sql,self.id])
-  end
-
-  def recommendations(limit = 20, order = "relevance", details = false, omit_feeds = nil)
-    sql = "SELECT recommendations.id, dest_entry_id, entries.permalink, entries.title, entries.description, entries.direct_link, feeds.short_title AS collection "
-    sql << ", relevance_calculated_at, relevance, clicks, avg_time_at_dest AS avg_time_on_target, author, published_at " if details == true
-    sql << "FROM recommendations "
-    sql << "INNER JOIN entries ON recommendations.dest_entry_id = entries.id "
-    sql << "INNER JOIN feeds ON entries.feed_id = feeds.id "
-    sql << "WHERE recommendations.entry_id = ? "
-    sql << ("AND entries.feed_id NOT IN (" + omit_feeds.gsub(/[^0-9,]/,'') + ") ") if omit_feeds != nil
-    sql << "ORDER BY " + order + " DESC "
-    sql << "LIMIT " + limit.to_s
-    Entry.find_by_sql([sql,self.id])
-  end
-
-  def relevant_recommendations(limit = 5, order = "relevance", details = false, omit_feeds = nil)
-    return self.recommendations(limit, order, details, omit_feeds)
-  end
-
-  def ranked_recommendations(limit = 5, order = "mixed", details = false, omit_feeds = nil)
-    return self.recommendations(limit, "clicks DESC, relevance", details, omit_feeds) if order == "clicks"
-    return self.recommendations(limit, "relevance", details, omit_feeds) if (order == "relevance" || details == true)
-    return relevant_recommendations_filtered(limit, details, omit_feeds) if omit_feeds != nil
-
-    recs = []
-    if self.popular != nil && !self.popular.empty?
-      recs.concat(ActiveSupport::JSON.decode(self.popular).first(limit))
-    end
-    if recs.length < limit && self.relevant != nil && !self.relevant.empty?
-      relevant_recs = randomize(ActiveSupport::JSON.decode(self.relevant))
-      recs.concat(relevant_recs.first(limit - recs.length))
-    end
-    if recs.length < limit && self.relevant != nil && !self.other.empty?
-      other_recs = randomize(ActiveSupport::JSON.decode(self.other))
-      recs.concat(other_recs.first(limit - recs.length))
-    end
-    return recs
-  end
-  
-  def json_recommendations(limit = 5, order = "mixed", details = false, omit_feeds = nil)
-    recs = ranked_recommendations(limit, order, details, omit_feeds)
-    (recs.nil? || recs.empty?) ? "" : ActiveSupport::JSON.encode(recs)
-  end
-
-  def relevant_recommendations_filtered(limit, details, omit_feeds)
-    # get recommendations for the entry from the recommendations table
-    recs = self.recommendations(limit, "mixed", details, omit_feeds)
-    
-    # for storing the various lists
-    popular_recs = []
-    relevant_recs = []
-    other_recs = []
-
-    # see where to cut draw the lines for popular and relevant
-    click_threshold = calc_click_threshold(recs)
-    relevance_threshold = calc_relevance_threshold(recs)
-    
-    # store the recommendations
-    recs.each do |r|
-      if (r["clicks"].to_i > click_threshold)
-        popular_recs << r 
-      elsif (r["relevance"].to_f > relevance_threshold)
-        relevant_recs << r
-      else 
-        other_recs << r
-      end
-    end
-    
-    # order popular items strictly by clicks
-    popular_recs.sort{|r1,r2| r2["avg_time_on_target"].to_i <=> r1["avg_time_on_target"].to_i}
-    
-    return popular_recs[0..limit] if popular_recs.size > limit 
-    return (popular_recs + relevant_recs)[0..limit] if (popular_recs.size + relevant_recs.size) > limit
-    return (popular_recs + relevant_recs + other_recs)[0..limit]
+  def resource_uri
+    self.direct_link.nil? ? self.permalink : self.direct_link
   end
 
-  def rank_recommendations
-    return
-    # get recommendations for the entry from the recommendations table
-    recs = self.recommendations
-    
-    # for storing the various lists
-    popular_recs = []
-    relevant_recs = []
-    other_recs = []
-
-    # see where to cut draw the lines for popular and relevant
-    click_threshold = calc_click_threshold(recs)
-    relevance_threshold = calc_relevance_threshold(recs)
-    
-    # store the recommendations
-    recs.each do |r|
-      if (r["clicks"].to_i > click_threshold)
-        popular_recs << r 
-      elsif (r["relevance"].to_f > relevance_threshold)
-        relevant_recs << r
-      else 
-        other_recs << r
-      end
-    end
-    
-    # order popular items strictly by clicks
-    popular_recs.sort{|r1,r2| r2["avg_time_on_target"].to_i <=> r1["avg_time_on_target"].to_i}
-    
-    # cache the JSON for the lists in the entry record
-    self.popular = ActiveSupport::JSON.encode(popular_recs)
-    self.relevant = ActiveSupport::JSON.encode(relevant_recs)
-    self.other = ActiveSupport::JSON.encode(other_recs)
-    self.save!
-  end
-  
-  def randomize(recs)
-    i = recs.length
-    return recs if (i == 0)
-    while (i > 0)
-      i = i - 1
-      j = (rand*(i+1)).floor
-      ti = recs[i]
-      tj =recs[j]
-      recs[i] = tj
-      recs[j] = ti
-    end
-    return recs
+  def self.normalized_uri(uri)
+    uri.sub(/index.?\.(html|aspx|shtm|htm|asp|php|cfm|jsp|shtml|jhtml)$/, '')
   end
 
-  def calc_relevance_threshold(recs)
-    sum = 0
-    recs.each do |r|
-      sum += r["relevance"].to_f
-    end
-    average = sum/recs.length
-    sum = 0
-    recs.each do |r|
-      sum += (r["relevance"].to_f-average)**2
-    end
-    standard_deviation = Math.sqrt(sum/recs.length);
-    return average + standard_deviation
-  end
-  
-  def calc_click_threshold(recs)
-    sum = 0
-    recs.each do |r|
-      sum += r["clicks"].to_f
-    end
-    average = sum/recs.length
-    sum = 0
-    recs.each do |r|
-      sum += (r["clicks"].to_f-average)**2
-    end
-    standard_deviation = Math.sqrt(sum/recs.length);
-    threshold = average + standard_deviation
-    return threshold > 5 ? threshold : 5
+  def self.recommender_entry(uri)
+    uri = normalized_uri(uri)
+    Entry.find(:first, :conditions => ['permalink = ? OR direct_link = ?', uri, uri], :order => 'direct_link IS NULL DESC') || Entry.new(:permalink => uri)
   end
   
-  def self.avg_time(clicks, old_avg, time_on_page)
-    return (old_avg*(clicks-1) + time_on_page)/clicks
-  end
-
   def self.track_time_on_page(session, uri)
     recommendation_id = session[:last_clicked_recommendation]
     if !recommendation_id.nil?
       time_on_page = (Time.now - session[:last_clicked_recommendation_time].to_f).to_i
 
-      # if they spend longer than two minutes on a page, we don't infer anything
-      if time_on_page > 5 and time_on_page < 120
+      # if they spend less or more than time is reasonable, we don't infer anything
+      if time_on_page > @@min_secs_tracked and time_on_page < @@max_secs_tracked
         if normalized_uri(uri) != session[:last_clicked_recommendation_uri]
           recommendation = Recommendation.find(recommendation_id)
           entry = Entry.find(recommendation.entry_id)
           new_avg = (recommendation.avg_time_at_dest*recommendation.clicks - @@default_time_on_page + time_on_page)/recommendation.clicks
           recommendation.avg_time_at_dest = new_avg
           recommendation.save!
-          entry.rank_recommendations
           session[:last_clicked_recommendation] = nil
         end
       else
-        session[:last_clicked_recommendation] = nil if time_on_page > 5
+        session[:last_clicked_recommendation] = nil if time_on_page > @@min_secs_tracked
       end
     end
   end
@@ -255,10 +106,6 @@ class Entry < ActiveRecord::Base
     recommendation = Recommendation.find(recommendation_id)
     return "" if !recommendation
 
-    # get the entries being linked from and to
-    entry = Entry.find(recommendation.entry_id)
-    target = Entry.find(recommendation.dest_entry_id)
-
     # get the list of recommendations that have been clicked during this session
     clicks = session[:rids] || Array.new
 
@@ -286,9 +133,6 @@ class Entry < ActiveRecord::Base
       session[:last_clicked_recommendation_time] = now
       session[:last_clicked_recommendation_uri] = redirect
 
-      # update the recommendation cache for the entry
-      entry.rank_recommendations if entry
-
       # track the click in the db
       Click.create(:recommendation_id => recommendation_id, :when => now, :referrer => referrer, :requester => requester, :user_agent => user_agent)
     end
@@ -296,28 +140,6 @@ class Entry < ActiveRecord::Base
     return redirect
   end
 
-  def self.truncate_words(text, length = 30, end_string = ' ...')
-    words = text.split()
-    words[0..(length-1)].join(' ') + (words.length > length ? end_string : '')
-  end
-
-  protected
-  
-#  def self.redirect_uri(target, referrer, redirect_type)
-#    if !target.direct_link.nil? and redirect_type != "metadata"
-#      return target.direct_link if redirect_type == "direct_link" 
-#      if !referrer.nil?
-#        domain = "http://" + URI.parse(referrer).host
-#        return target.direct_link if target.permalink[0..domain.length-1] != domain
-#      end
-#    end
-#    return target.permalink
-#  end
-
-  def self.normalized_uri(uri)
-    uri.sub(/index.?\.(html|aspx|shtm|htm|asp|php|cfm|jsp|shtml|jhtml)$/, '')
-  end
-  
   def self.real_time_recommendations(uri, language='en', limit=5, details=false, options = {})
     raise MuckServices::Exceptions::LanguageNotSupported, I18n.t('muck.services.language_not_supported') unless Recommender::Languages.supported_languages.include?(language)
     fields = "entries.id, entries.title, entries.permalink, entries.direct_link, feeds.short_title AS collection"

data/app/models/feed.rb

@@ -181,7 +181,12 @@ class Feed < ActiveRecord::Base
   
   # Looks for feeds from a given url
   def self.discover_feeds(uri)
-    Feedbag.find(uri)
+    begin
+      Feedbag.find(uri)
+    rescue URI::InvalidURIError
+      # if we aren't able to discover a feed then just return the original uri
+      [Struct.new(:url => uri, :title => '')]
+    end
   end
   
   # Finds or creates a feed based on the url.  Any give feed uri should only exist once in the system

data/app/models/recommendation.rb

@@ -12,4 +12,6 @@
 #
 
 class Recommendation < ActiveRecord::Base
+  belongs_to :entry, :class_name => 'Entry', :foreign_key => 'entry_id'
+  belongs_to :dest_entry, :class_name => 'Entry', :foreign_key => 'dest_entry_id'
 end

data/app/views/entries/_related_entry.html.erb

@@ -1,4 +1,4 @@
 <%= link_to related_entry.title + " (" + related_entry.collection + ")", "/r?id=#{related_entry.id}", :class => "title_link", :rel => "nofollow" %>
 - <%= link_to t('muck.services.related_resources'), resource_path(related_entry.dest_entry_id), :class => "related_resources_link", :rel => "nofollow" %>
-<% if !related_entry.direct_link.nil? %> - <%= link_to t('muck.services.metadata'), "/r?id=#{related_entry.id}&target=metadata", :class => "catalog_link" %><% end %>
+<% if !related_entry.direct_uri.nil? %> - <%= link_to t('muck.services.metadata'), "/r?id=#{related_entry.id}&target=metadata", :class => "catalog_link" %><% end %>
 <% if related_entry.description.length > 0 %><br/><span class="description"><%= truncate_words(related_entry.description) %></span><% end %>

data/app/views/entries/_tag_cloud.html.erb

@@ -1,3 +1,4 @@
+<% cache({:locale => Language.locale_id, :format => 'html', :grain_size => @grain_size, :tag_filter => @tag_filter}) do %>
 <div id="tag-cloud">
   <fieldset>
     <legend><%= @tag_filter.nil? ? (@grain_size == 'course' ? t('muck.services.courses_tag_cloud_label') : t('muck.services.resources_tag_cloud_label')) : t('muck.services.narrow_further') %></legend>
@@ -15,4 +16,5 @@
       <% end %>
     <% end -%>
   </fieldset>
-</div>
+</div>
+<% end %>

data/app/views/entries/browse_by_tags.html.erb

@@ -1,6 +1,6 @@
 <%= output_errors('', {:class => 'help-box'}) %>
 <div class="block">
-  <% if @results.length > 0 %>
+  <% if !@results.blank? %>
     <%= render(:partial => 'entries/result_status') %>
     <div class="column span-15">
       <%= render(:partial => 'entries/results') %>

data/app/views/entries/index.html.erb

@@ -1,3 +1,5 @@
+<% cache({:locale => Language.locale_id, :format => 'html', :grain_size => @grain_size) do %>
 <div align="center">
   <%= render :partial => 'entries/tag_cloud' %>
 </div>
+<% end %>

data/app/views/recommendations/index.js.erb

@@ -0,0 +1 @@
+<% cache({:locale => Language.locale_id, :format => 'js', :details => @details, :limit => @limit, :order => @order, :id => + @entry.id}, :omit_feeds => @omit_feeds) do %>{"document":{"document_id":<%= @entry.id.to_s %>,"uri":"<%= @entry.permalink %>","recommendations":<%= @recommendations.to_json %>}}<% end %>

data/app/views/recommendations/index.pjs.erb

@@ -1,12 +1,13 @@
+<% cache({:locale => Language.locale_id, :format => 'pjs', :details => @details, :limit => @limit, :order => @order, :id => + @entry.id, :omit_feeds => @omit_feeds}) do %>
 <%
-@json_recommendations = @entry.json_recommendations(@limit, params[:order] || "mixed", true, params[:omit_feeds] || nil) 
-if !@json_recommendations.empty? 
+@host = "http://#{URI.parse(@uri).host}"
+if !@recommendations.empty?
 @direct_link_text = params[:direct_link_text] || t('muck.services.direct_link')
 %>
 var catalog_page = <%= !@entry.direct_link.nil? and @uri == @entry.permalink %>;
 var document_host = '<%= @host %>';
-var recs = <%= @json_recommendations %>;
-var app = "<%= app = request.protocol + request.host_with_port + '/' %>"; 
+var recs = <%= @recommendations.to_json %>;
+var app = "<%= request.protocol + request.host_with_port + '/' %>"; 
 <% if @details == true -%>
 function truncate(text, length) {
 	nEnd = text.indexOf(" ", 200);
@@ -30,8 +31,8 @@ for(nRec = 0; nRec < recs.length; nRec++) {
 	metadata_link = catalog_page && document_host == r.uri.substring(0, document_host.length);
 	direct_link = metadata_link && r.direct_link;
 	document.write('<p class="oer_recommender_item">');
-	document.write('<a class="oer_recommender_recommendation_link" href="' + app + 'r?id=' + r.id + (metadata_link ? "&target=metadata" : "") + '">' + r.title + ' (' + r.collection + ')</a>');
-	if (direct_link) document.write(' <a class="oer_recommender_direct_link" href="' + app + 'r?id=' + r.id + '&target=direct_link"><%= @direct_link_text %></a>');
+	document.write('<a class="oer_recommender_recommendation_link" href="' + app + 'r?id=' + r.recommendation_id + (metadata_link ? "&target=metadata" : "") + '">' + r.title + ' (' + r.collection + ')</a>');
+	if (direct_link) document.write(' <a class="oer_recommender_direct_link" href="' + app + 'r?id=' + r.recommendation_id + '&target=direct_link"><%= @direct_link_text %></a>');
 <% if @details == true -%>
 	document.write(' <span class="oer_recommender_published_at">(' + format_date(r.published_at) + ')</span>');
 	document.write(' <span class="oer_recommender_relevance_score"><%= t('muck.services.relevance')%>: ' + Math.round(r.relevance*100)/100 + '</span>');
@@ -44,3 +45,4 @@ document.write('</div>');
 <% if params[:more_link] %>document.write('<div class="oer_recommender_more_link"><a href="' + app + 'resources/<%= @entry.id %>"><%= t('muck.services.gm_more_prompt') %></a></div>');<% end %>
 document.write('</div>');	
 <% end %>
+<% end %>

data/app/views/recommendations/index.rss.builder

@@ -1,37 +1,37 @@
-if @entry.nil?
-	@recommendations = Array.new
-else 
-	@recommendations = @entry.ranked_recommendations(@limit, params[:order] || "mixed")
-end
+cache({:locale => Language.locale_id, :format => 'rss', :details => @details, :limit => @limit, :order => @order, :id => + @entry.id, :omit_feeds => @omit_feeds}) do
+  headers["Content-Type"] = "application/rss+xml"
+  xml.instruct!
 
-headers["Content-Type"] = "application/rss+xml"
-xml.instruct!
-	
-xml.rss "version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/", "xmlns:oerr" => "http://www.oerrecommender.org/oerr/elements/1.0/" do
+  xml.rss "version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/", "xmlns:oerr" => "http://www.folksemantic.com/oerr/elements/1.0/" do
     xml.channel do
 
-    xml.title       "OER Recommender recommendations for " + @entry.permalink
-    xml.link        url_for(request.env["REQUEST_URI"])
-#    xml.pubDate     CGI.rfc1123_date @entries.first.updated_at if @entries.any?
-#    xml.description "Blog posts for " + @event.title
-	xml.generator 'OER Recommender'
+      xml.title "Folksemantic recommendations for " + @entry.permalink
+      xml.link url_for(request.env["REQUEST_URI"])
+      xml.generator 'Folksemantic'
 
-    @recommendations.each do |recommendation|
-      xml.item do
-        xml.link recommendation["uri"]
-        xml.oerr :clicks, recommendation["clicks"]
-        xml.oerr :relevance, round(recommendation["relevance"])
-        xml.title recommendation["title"]
-        if recommendation["description"] != nil
-	        xml.description "type" => "html" do
-	        	xml.text! recommendation["description"]
-	        end
-	    end
-#        xml.pubDate     CGI.rfc1123_date recommendation.created_at
-        xml.guid        "http://www.oerrecommender.org/r?id=" + recommendation["id"].to_s
-#        xml.author      "#{entry.author} (#{entry.author})"
+      @recommendations.each do |recommendation|
+        xml.item do
+          xml.title recommendation["title"]
+          xml.link (@app +'/r?id=' + recommendation["recommendation_id"])
+          xml.guid (@app +'/r?id=' + recommendation["recommendation_id"])
+          xml.oerr :relevance, recommendation["relevance"]
+
+          if @details == true
+            xml.oerr :recommendation_id, recommendation["recommendation_id"]
+            xml.oerr :uri, recommendation["permalink"]
+            xml.oerr :direct_uri, recommendation["direct_link"]
+            if recommendation["description"] != nil
+              xml.description "type" => "html" do
+                xml.text! recommendation["description"]
+              end
+            end
+            xml.oerr :clicks, recommendation["clicks"]
+            xml.oerr :average_time_at_dest, recommendation["avg_time_on_target"]
+            xml.pubDate CGI.rfc1123_date recommendation["published_at"]
+            xml.author recommendation["author"]
+          end
+        end
       end
     end
-
   end
-end
+end

data/app/views/recommendations/index.xml.builder

@@ -1,34 +1,25 @@
-xml.instruct!
-
-if @entry.nil?
-	xml.recommendations
-else
-
-app = request.protocol + request.host_with_port + '/'
-@recommendations = @entry.ranked_recommendations(@limit, params[:order] || "mixed", @details)
-xml.recommendations(:document_id => @entry.nil? ? "" : @entry.id, :uri => @uri, :title => t("muck.services.gm_title"), :more_prompt => t("muck.services.gm_more_prompt"), :direct_link_text => t("muck.services.direct_link")) do
+cache({:locale => Language.locale_id, :format => 'xml', :details => @details, :limit => @limit, :order => @order, :id => + @entry.id, :omit_feeds => @omit_feeds}) do
+  xml.instruct!
+  xml.recommendations(:document_id => @entry.id, :uri => @entry.permalink, :title => t("muck.services.gm_title"),
+          :more_prompt => t("muck.services.gm_more_prompt"), :direct_link_text => t("muck.services.direct_link")) do
     @recommendations.each do |recommendation|
-        xml.recommendation do
-            xml.title recommendation["title"]
-            xml.collection recommendation["collection"]
-            xml.link app + 'r?id=' + recommendation['id'].to_s  
-            xml.has_direct_link "true" if (recommendation["direct_link"] != nil and @uri[0..20] == recommendation["uri"][0..20])
-            
-            if @details == true
-	            xml.direct_link app + 'r?id=' + recommendation["id"].to_s + "&u=" + recommendation["direct_link"] if recommendation["direct_link"] != nil 
-	            xml.uri recommendation["uri"]
-	            xml.direct_uri recommendation["direct_link"]
-	            xml.description recommendation["description"]
-	            xml.clicks recommendation["clicks"]
-	            xml.average_time_at_dest recommendation["avg_time_on_target"]
-	            xml.relevance round(recommendation["relevance"])
-	            xml.published_at recommendation["published_at"]
-	            xml.author recommendation["author"]
-	            xml.tag_list recommendation["tag_list"]
-	        else
-	            xml.description ""
-	        end
+      xml.recommendation do
+        xml.title recommendation["title"]
+        xml.collection recommendation["collection"]
+        xml.link @app + '/r?id=' + recommendation["recommendation_id"].to_s
+        xml.relevance recommendation["relevance"]
+
+        if @details == true
+          xml.recommendation_id recommendation["recommendation_id"]
+          xml.uri recommendation["permalink"]
+          xml.direct_uri recommendation["direct_link"]
+          xml.description recommendation["description"]
+          xml.clicks recommendation["clicks"]
+          xml.average_time_at_dest recommendation["avg_time_on_target"]
+          xml.published_at recommendation["published_at"]
+          xml.author recommendation["author"]
         end
+      end
     end
-end
+  end
 end

data/app/views/recommendations/real_time.pjs.erb

@@ -36,7 +36,7 @@ for(nRec = 0; nRec < recs.length; nRec++) {
 	document.write('<br/><span class="oer_recommender_description">' + truncate(r.description) + '</span>');
 	document.write('<br/><span class="oer_recommender_uri">' + r.uri + '</span>');
 <% end -%>	
-	document.write('</a></p>');
+	document.write('</p>');
 }
 document.write('</div>');	
 <% if params[:more_link] %>document.write('<div class="oer_recommender_more_link"><a href="' + app + 'documents/<%= @entry.id %>"><%= t('muck.services.gm_more_prompt') %></a></div>');<% end %>	

data/lib/muck_services/tasks.rb

@@ -39,7 +39,7 @@ module MuckServices
               }
             end
 
-            desc "Loads some feeds oai endpoints to get things started"
+            desc "Loads some feeds and oai endpoints to get things started (this should be run before muck:services:db:create_global_aggregation_feeds)"
             task :bootstrap => :environment do
               require 'active_record/fixtures'
               ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
@@ -78,6 +78,15 @@ module MuckServices
 
             end
 
+            desc "Creates a global feeds aggregation and adds all existing feeds to it"
+            task :create_global_feeds_aggregation => :environment do
+              if Aggregation.find_by_title('global_feeds') == nil
+                global_feeds_id = Aggregation.create(:title => 'global_feeds', :terms => 'global_feeds',
+                          :description => 'Feeds included in the site indexes.').id
+                Feed.find(:all).each { |feed| AggregationFeed.create(:feed_id => feed.id, :aggregation_id => global_feeds_id) }
+              end
+            end
+
           end
 
           desc "Sync files from muck services."
@@ -87,21 +96,6 @@ module MuckServices
             system "rsync -ruv #{path}/public ."
           end
 
-          desc "Create global_feeds aggregation and add feeds to it"
-          task :create_global_feeds => :environment do
-            admin_id = User.find_by_login('admin').id
-                    global_aggregation = Aggregation.create(:title => 'global_feeds', :terms => 'global_feeds',
-                          :description => 'Feeds included in the site indexes.',
-                          :ownable_id => admin_id, :ownable_type => 'User')
-            global_aggregation = Aggregation.find_by_title('global_feeds')
-            global_aggregation.feeds << Feed.find(:all, :conditions => "uri LIKE 'http://www.oercommons.org%' OR id < 1047364815")
-            global_aggregation.save!
-            AggregationFeed.update_all("feed_type = 'Feed'")
-            OaiEndpoint.find(:all).each do |ep|
-              AggregationFeed.create(:aggregation_id => global_aggregation.id, :feed_type => 'OaiEndpoint', :feed_id => ep.id)
-            end
-          end
-
           desc "Add attention types"
           task :add_attention_types => :environment do
             AttentionType.create(:id => AttentionType::WRITE, :name => 'write', :default_weight => 10)

data/locales/en.yml

@@ -214,5 +214,6 @@ en:
       previous: Previous
       facebook_notes: Facebook Notes
       opml_generated: Feeds for {{terms}}
+      url_not_in_index: The <a href='{{uri}}'>resource you requested recommendations for</a> has not been indexed. Please add a repository containing metadata for the resource to add it to the index.
     activity_templates: 
       entry_comment: Comment

data/muck-services.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{muck-services}
-  s.version = "0.1.34"
+  s.version = "0.1.35"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joel Duffin", "Justin Ball"]
-  s.date = %q{2010-01-25}
+  s.date = %q{2010-02-08}
   s.description = %q{This gem contains the rails specific code for dealing with feeds, aggregations and recommendations.  It is meant to work with the muck-raker gem.}
   s.email = %q{justin@tatemae.com}
   s.extra_rdoc_files = [
@@ -114,7 +114,7 @@ Gem::Specification.new do |s|
      "app/views/parts/_add_feed.html.erb",
      "app/views/parts/_select_feed.html.erb",
      "app/views/recommendations/get_button.html.erb",
-     "app/views/recommendations/index.html.erb",
+     "app/views/recommendations/index.js.erb",
      "app/views/recommendations/index.pjs.erb",
      "app/views/recommendations/index.rss.builder",
      "app/views/recommendations/index.xml.builder",
@@ -505,6 +505,8 @@ Gem::Specification.new do |s|
      "test/rails_root/db/migrate/20091115011828_add_aggregations_for_personal_recs.rb",
      "test/rails_root/db/migrate/20091116094447_rename_action_table.rb",
      "test/rails_root/db/migrate/20091118203605_add_default_feed_type_to_aggregation_feed.rb",
+     "test/rails_root/db/migrate/20100123035450_create_access_codes.rb",
+     "test/rails_root/db/migrate/20100123233654_create_access_code_requests.rb",
      "test/rails_root/db/schema.rb",
      "test/rails_root/features/step_definitions/common_steps.rb",
      "test/rails_root/features/step_definitions/visit_steps.rb",
@@ -534,6 +536,7 @@ Gem::Specification.new do |s|
      "test/rails_root/test/unit/identity_feed_test.rb",
      "test/rails_root/test/unit/oai_endpoint_test.rb",
      "test/rails_root/test/unit/personal_recommendation_test.rb",
+     "test/rails_root/test/unit/recommendation_test.rb",
      "test/rails_root/test/unit/service_category_test.rb",
      "test/rails_root/test/unit/service_test.rb",
      "test/rails_root/test/unit/services_mailer_test.rb",

data/test/rails_root/config/environment.rb

@@ -1,4 +1,4 @@
-RAILS_GEM_VERSION = '2.3.4' unless defined? RAILS_GEM_VERSION
+RAILS_GEM_VERSION = '2.3.5' unless defined? RAILS_GEM_VERSION
 
 require File.join(File.dirname(__FILE__), 'boot')
 

data/test/rails_root/db/migrate/20100123035450_create_access_codes.rb

@@ -0,0 +1,19 @@
+class CreateAccessCodes < ActiveRecord::Migration
+  def self.up
+    create_table :access_codes do |t|
+      t.string    :code
+      t.integer   :uses,       :default => 0,     :null => false
+      t.boolean   :unlimited,  :default => false, :null => false
+      t.datetime  :expires_at
+      t.integer   :use_limit,  :default => 1,     :null => false
+      t.timestamps
+    end
+    add_index :access_codes, :code
+    add_column :users, :access_code_id, :integer
+  end
+
+  def self.down
+    drop_table :access_codes
+    remove_column :users, :access_code_id
+  end
+end

data/test/rails_root/db/migrate/20100123233654_create_access_code_requests.rb

@@ -0,0 +1,14 @@
+class CreateAccessCodeRequests < ActiveRecord::Migration
+  def self.up
+    create_table :access_code_requests do |t|
+      t.string    :email
+      t.datetime  :code_sent_at
+      t.timestamps
+    end
+    add_index :access_code_requests, :email
+  end
+
+  def self.down
+    drop_table :access_code_requests
+  end
+end

data/test/rails_root/db/schema.rb

@@ -9,7 +9,28 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20091118203605) do
+ActiveRecord::Schema.define(:version => 20100123233654) do
+
+  create_table "access_code_requests", :force => true do |t|
+    t.string   "email"
+    t.datetime "code_sent_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "access_code_requests", ["email"], :name => "index_access_code_requests_on_email"
+
+  create_table "access_codes", :force => true do |t|
+    t.string   "code"
+    t.integer  "uses",       :default => 0,     :null => false
+    t.boolean  "unlimited",  :default => false, :null => false
+    t.datetime "expires_at"
+    t.integer  "use_limit",  :default => 1,     :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "access_codes", ["code"], :name => "index_access_codes_on_code"
 
   create_table "activities", :force => true do |t|
     t.integer  "item_id"
@@ -462,6 +483,7 @@ ActiveRecord::Schema.define(:version => 20091118203605) do
     t.datetime "updated_at"
     t.string   "identity_url"
     t.string   "url_key"
+    t.integer  "access_code_id"
   end
 
   add_index "users", ["email"], :name => "index_users_on_email"

data/test/rails_root/test/factories.rb

@@ -3,4 +3,9 @@ Factory.define :share do |f|
   f.title { Factory.next(:title) }
   f.shared_by {|a| a.association(:user)}
   f.entry {|a| a.association(:entry)}
-end
+end
+
+Factory.define :recommendation do |r|
+  r.entry {|a| a.association(:entry)}
+  r.dest_entry {|a| a.association(:entry)}
+end

data/test/rails_root/test/test_helper.rb

@@ -16,6 +16,7 @@ class ActiveSupport::TestCase
   TEST_URI = 'http://www.engadget.com'
   TEST_RSS_URI = 'http://www.engadget.com/rss.xml'
   TEST_USERNAME_TEMPLATE = 'http://feeds.delicious.com/v2/rss/{username}?count=100'
+  TEST_XML_URI = 'http://ocw.mit.edu/OcwWeb/rss/all/mit-allcourses.xml'
   
 end
 

data/test/rails_root/test/unit/entry_test.rb

@@ -37,6 +37,40 @@ class EntryTest < ActiveSupport::TestCase
     subject { @entry }
     
     should_belong_to :feed
+
+
+    context "recommender_entry" do
+      should "return an entry if the direct_link matches the specified uri" do
+        uri = Factory.next(:uri)
+        e = Factory.create(:entry, :direct_link => uri)
+        assert_equal e.id, Entry.recommender_entry(uri).id
+      end
+
+      should "return an entry if the permalink matches the specified uri" do
+        uri = Factory.next(:uri)
+        e = Factory.create(:entry, :permalink => uri)
+        assert_equal e.id, Entry.recommender_entry(uri).id
+      end
+
+      should "return an empty entry with the specified uri if the specified uri doesn't match" do
+        uri = Factory.next(:uri)
+        e = Factory.create(:entry, :permalink => uri)
+        assert_not_nil Entry.recommender_entry(uri)
+        assert_equal uri, Entry.recommender_entry(uri).permalink
+      end
+    end
+
+    context "resource_uri" do
+      should "return the permalink when no direct_link is specified" do
+        @entry.direct_link = nil
+        assert_equal @entry.permalink, @entry.resource_uri
+      end
+
+      should "return the direct_link when a direct_link is specified" do
+        @entry.direct_link = Factory.next(:uri)
+        assert_equal @entry.direct_link, @entry.resource_uri
+      end
+    end
     
     context "search" do
       # should "search indexes for ruby" do
@@ -48,7 +82,118 @@ class EntryTest < ActiveSupport::TestCase
         end
       end
     end
+
+    context "normalized_uri" do
+      should "remove the trailing file name from any url that ends in index.*" do
+        index_uri = 'http://example.com/some_dir/'
+        ['html','aspx','shtm','htm','asp','php','cfm','jsp','shtml','jhtml'].each { |ext|
+          assert_equal index_uri, Entry.normalized_uri(index_uri + 'index.' + ext)
+        }
+      end
+    end
+
+    context "recommendation requested omitting certain feeds" do
+      should "not contain entries from those feeds" do
+        feed1_id = Factory(:feed).id
+        feed2_id = Factory(:feed).id
+        assert_not_equal feed1_id, feed2_id
+        Recommendation.create(:entry_id => @entry.id, :dest_entry_id => Factory.create(:entry, :feed_id => feed1_id).id)
+        Recommendation.create(:entry_id => @entry.id, :dest_entry_id => Factory.create(:entry, :feed_id => feed2_id).id)
+        r = @entry.related_entries.top(false, 5, feed2_id.to_s)
+        assert_equal 1, r.length
+        r.each { |e| assert_not_equal feed2_id, e.feed_id}
+      end
+    end
+
+    context "with 3 recommendations" do
+
+      setup do
+        3.times { |n| Recommendation.create(:entry_id => @entry.id,
+                      :dest_entry_id => Factory(:entry).id, :relevance => n.to_f/10.0) }
+      end
+
+      should "have 3 related_entries" do
+        assert_equal 3, @entry.related_entries.top.length
+      end
+
+      should "return only 2 if specified" do
+        assert_equal 2, @entry.related_entries.top(true,2).length
+      end
+
+      should "return results in order of relevance by default" do
+        related_entries = @entry.related_entries.top
+        assert related_entries[1].relevance < related_entries[0].relevance
+        assert related_entries[2].relevance < related_entries[1].relevance
+      end
+
+    end
     
+    context "recommendation requested without details" do
+      should "not have an author" do
+        Recommendation.create(:entry_id => @entry.id,
+                              :dest_entry_id => Factory.create(:entry, :author => Factory.next(:name)).id,
+                              :relevance => '.3')
+        assert_raise ActiveRecord::MissingAttributeError do
+          @entry.related_entries.top.first.author
+        end
+      end
+
+      should "have basic fields" do
+        title = Factory.next(:name)
+        collection = Factory.next(:name)
+        feed_id = Factory(:feed, :short_title => collection).id
+        dest_entry_id = Factory.create(:entry, :title => title, :feed_id => feed_id).id
+        relevance = '.3'
+        recommendation_id = Recommendation.create(:entry_id => @entry.id, :relevance => relevance,
+               :dest_entry_id => dest_entry_id).id.to_s
+        r = @entry.related_entries.top(true).first
+        assert_nothing_raised do
+          assert_equal recommendation_id, r.recommendation_id
+          assert_equal relevance.to_f, r.relevance.to_f
+          assert_equal title, r.title
+          assert_equal collection, r.collection
+          assert_not_nil r.dest_entry_id
+        end
+      end
+    end
+
+    context "recommendation requested with details" do
+      should "have basic and detailed fields" do
+        title = Factory.next(:name)
+        collection = Factory.next(:name)
+        author = Factory.next(:name)
+        published_at = DateTime.now
+        clicks = 23
+        average_time_at_dest = 44
+        description = Factory.next(:name)
+        permalink = Factory.next(:uri)
+        direct_uri = Factory.next(:uri)
+        feed_id = Factory(:feed, :short_title => collection).id
+        relevance = '.3'
+        dest_entry_id = Factory.create(:entry, :feed_id => feed_id, :title => title,
+               :author => author, :published_at => published_at, :permalink => permalink,
+               :direct_link => direct_uri, :description => description).id
+        recommendation_id = Recommendation.create(:entry_id => @entry.id, :relevance => relevance,
+               :avg_time_at_dest => average_time_at_dest, :clicks => clicks, :dest_entry_id => dest_entry_id).id.to_s
+        r = @entry.related_entries.top(true).first
+        assert_nothing_raised do
+          assert_equal recommendation_id, r.recommendation_id
+          assert_equal relevance.to_f, r.relevance.to_f
+          assert_equal title, r.title
+          assert_equal collection, r.collection
+          assert_not_nil r.dest_entry_id
+
+          assert_equal author, r.author
+#          assert_equal published_at, r.published_at
+          assert_equal clicks, r.clicks.to_i
+          assert_equal permalink, r.permalink
+          assert_equal direct_uri, r.direct_uri
+          assert_equal average_time_at_dest, r.average_time_at_dest.to_i
+          assert_equal description, r.description
+        end
+      end
+    end
+
   end
   
 end

data/test/rails_root/test/unit/feed_test.rb

@@ -122,6 +122,9 @@ class FeedTest < ActiveSupport::TestCase
     should "Discover feeds from url" do
       Feed.discover_feeds(TEST_URI)
     end
+    should "Discover feeds from xml url" do
+      assert_equal TEST_XML_URI, Feed.discover_feeds(TEST_XML_URI)[0].url
+    end
   end
   
   context "Harvest feed" do

data/test/rails_root/test/unit/recommendation_test.rb

@@ -0,0 +1,29 @@
+# == Schema Information
+#
+# Table name: recommendations
+#
+#  id               :integer(4)      not null, primary key
+#  entry_id         :integer(4)
+#  dest_entry_id    :integer(4)
+#  rank             :integer(4)
+#  relevance        :decimal(8, 6)   default(0.0)
+#  clicks           :integer(4)      default(0)
+#  avg_time_at_dest :integer(4)      default(60)
+#
+
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RecommendationTest < ActiveSupport::TestCase
+
+  context "recommendation" do
+    setup do
+      @recommendation = Factory(:recommendation)
+    end
+
+    subject { @recommendation }
+
+    should_belong_to :entry
+    should_belong_to :dest_entry
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: muck-services
 version: !ruby/object:Gem::Version 
-  version: 0.1.34
+  version: 0.1.35
 platform: ruby
 authors: 
 - Joel Duffin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 -07:00
+date: 2010-02-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -240,7 +240,7 @@ files:
 - app/views/parts/_add_feed.html.erb
 - app/views/parts/_select_feed.html.erb
 - app/views/recommendations/get_button.html.erb
-- app/views/recommendations/index.html.erb
+- app/views/recommendations/index.js.erb
 - app/views/recommendations/index.pjs.erb
 - app/views/recommendations/index.rss.builder
 - app/views/recommendations/index.xml.builder
@@ -652,6 +652,8 @@ test_files:
 - test/rails_root/db/migrate/20091115011828_add_aggregations_for_personal_recs.rb
 - test/rails_root/db/migrate/20091116094447_rename_action_table.rb
 - test/rails_root/db/migrate/20091118203605_add_default_feed_type_to_aggregation_feed.rb
+- test/rails_root/db/migrate/20100123035450_create_access_codes.rb
+- test/rails_root/db/migrate/20100123233654_create_access_code_requests.rb
 - test/rails_root/db/schema.rb
 - test/rails_root/features/step_definitions/common_steps.rb
 - test/rails_root/features/step_definitions/visit_steps.rb
@@ -681,6 +683,7 @@ test_files:
 - test/rails_root/test/unit/identity_feed_test.rb
 - test/rails_root/test/unit/oai_endpoint_test.rb
 - test/rails_root/test/unit/personal_recommendation_test.rb
+- test/rails_root/test/unit/recommendation_test.rb
 - test/rails_root/test/unit/service_category_test.rb
 - test/rails_root/test/unit/service_test.rb
 - test/rails_root/test/unit/services_mailer_test.rb

data/app/views/recommendations/index.html.erb

@@ -1,5 +0,0 @@
-<% if @recommendations.blank? || @recommendations.results.blank? -%>
-  <%= t('muck.services.no_recommendations') %>
-<% else -%>
-  <%= render :partial => 'entries/result', :collection => @recommendations.results -%>
-<% end -%>