muck-raker 0.1.0

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,24 @@
+Recommender
+===========
+The recommender adds the ability to aggregate, search and analyze data from many different web sources.
+
+Installation
+===========
+Install gem dependencies:
+
+  sudo gem install mbleigh-acts-as-taggable-on
+  sudo gem install mislav-will_paginate
+
+After install acts-as-taggable-on be sure to include the helper in application_helper.rb:
+
+  module ApplicationHelper
+    include TagsHelper
+  end
+
+
+
+Example
+=======
+
+
+Copyright (c) 2009 Justin Ball and Joel Duffin, released under the MIT license

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the recommender plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the recommender plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Recommender'
+  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-raker"
+    gemspec.summary = "The aggregation and recommendation engine for the muck system"
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/jbasdf/muck_raker"
+    gemspec.description = "The aggregation and recommendation engine for the muck system."
+    gemspec.authors = ["Joel Duffin Justin Ball"]
+    gemspec.rubyforge_project = 'muck-raker'
+    gemspec.add_dependency "muck-engine"
+    gemspec.add_dependency "muck-users"
+    gemspec.add_dependency "muck-solr"
+    gemspec.files.include %w( tasks/*
+                          db/migrate/*.rb
+                          app/**/**/**/*
+                          config/*
+                          locales/*
+                          rails/*
+                          test/*
+                          lib/**/*
+                          public/javascripts/* )
+  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-comments/"
+        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.0

data/app/controllers/admin/recommender/feeds_controller.rb

@@ -0,0 +1,174 @@
+class Admin::Recommender::FeedsController < ApplicationController
+
+  layout "default"
+
+  before_filter :login_required, :only => [:index, :edit, :ban, :unban, :destroy, :update, :new]
+
+  # GET /feeds
+  # GET /feeds.xml
+  def index
+    @feeds = Feed.find(:all, :conditions => "status >= 0", :order => "title")
+    @banned_feeds = Feed.find(:all, :conditions => "status < 0", :order => "title")
+
+    respond_to do |format|
+      format.html # index.rhtml
+      format.xml  { render :xml => @feeds.to_xml }
+    end
+  end
+
+  def entries
+    @new_feed = params[:new_feed]
+    @feed = Feed.find(params[:id])
+    @courses = @feed.entries.find(:all, :order => "title")
+
+    respond_to do |format|
+      format.html { render :partial => "courses", :layout => "default" }
+      format.xml  { render :xml => @courses.to_xml }
+    end
+  end
+
+  # GET /feeds/selection_list
+  def selection_list
+    @feeds = Feed.find(:all, :order => "short_title")
+    render :partial => "feed_selection", :collection => @feeds, :layout => false
+  end
+
+  # GET /feeds/1
+  # GET /feeds/1.xml
+  def show
+    redirect_to "/feeds/" + params[:id] + "/entries" 
+  end
+
+  # GET /feeds/new
+  def new
+    @no_follow = true
+    @feeds = Feed.find(:all, :conditions => "status >= 0", :order => "title")
+    @feed = Feed.new
+    render :layout => "default"
+  end
+
+  # GET /feeds/1;edit
+  def edit
+    @feed = Feed.find(params[:id])
+    render :layout => "default"
+  end
+
+#  # GET /feeds/1;reharvest
+#  def harvest_now
+#    @no_index = true
+#    @feed = Feed.find(params[:id])
+#    @feed.entries.destroy_all
+#    @feed.failed_requests = "0"
+#    @feed.refreshed_at = "2001"
+#    @feed.save!
+#  end
+
+  # GET /feeds/1;ban
+  def ban
+    @feed = Feed.find(params[:id])
+    @feed.entries.destroy_all
+    @feed.status = -1
+    @feed.save!
+    #redirect_to feeds_path
+    redirect_to "/feeds"
+  end
+
+  # GET /feeds/1;unban
+  def unban
+    @feed = Feed.find(params[:id])
+    @feed.unban = true
+    @feed.status = 0
+    @feed.refreshed_at = "2001"
+    @feed.save!
+    #redirect_to feeds_path
+    redirect_to "/feeds"
+  end
+
+#  def notification_feed_added(feed)
+#    begin
+#        FeedNotify.deliver_feed_added(feed)
+#        return
+#    rescue Exception => e
+#        # unble to send activation email.  Activate the user anyway which means
+#        # letting flow continue below
+#        logger.error 'Unable to send feed added notification E-Mail:'
+#        logger.error e
+#    end
+#  end
+#
+#  def notification_feed_updated(feed)
+#    begin
+#        FeedNotify.deliver_feed_updated(feed)
+#        return
+#    rescue Exception => e
+#        # unble to send activation email.  Activate the user anyway which means
+#        # letting flow continue below
+#        logger.error 'Unable to send feed added notification E-Mail:'
+#        logger.error e
+#    end
+#  end
+
+  # POST /feeds
+  # POST /feeds.xml
+  def create
+    @feed = Feed.new(params[:feed])
+    @feed.harvested_from_display_uri = @feed.display_uri
+    @feed.entries_count = 0
+    @feed.last_requested_at = Time.now - 2592000 
+    @feed.last_harvested_at = Time.now - 2592000
+
+    respond_to do |format|
+      if @feed.save
+        flash[:notice] = 'Feed was successfully created.'
+
+        # email the admin to let them know a feed has been added
+#        notification_feed_added(@feed)
+
+        # redirect to a page letting them know the feed has been created
+        #format.html { redirect_to entries_path(@feed) + "?new_feed=true" }
+        format.html { redirect_to "/feeds/" }
+        format.xml  { head :created, :location => feed_url(@feed) }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @feed.errors.to_xml }
+      end
+    end
+  end
+
+  # PUT /feeds/1
+  # PUT /feeds/1.xml
+  def update
+    @feed = Feed.find(params[:id])
+
+    # force a harvest now
+#    harvest_now
+
+    respond_to do |format|
+      if @feed.update_attributes(params[:feed])
+#        notification_feed_updated(@feed)
+        flash[:notice] = 'Feed was successfully updated.'
+        format.html { 
+        redirect_to "/feeds/"
+        return
+        }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @feed.errors.to_xml }
+      end
+    end
+  end
+
+#  # DELETE /feeds/1
+#  # DELETE /feeds/1.xml
+#  def destroy
+#    @feed = Feed.find(params[:id])
+#    @feed.destroy
+#
+#    respond_to do |format|
+#      format.html { redirect_to feeds_url }
+#      format.xml  { head :ok }
+#    end
+#  end
+
+end

data/app/controllers/recommender/default_controller.rb

@@ -0,0 +1,15 @@
+class Recommender::DefaultController < ApplicationController
+
+  def widgets
+    respond_to do |format|
+      format.html { render :template => 'default/widgets' }
+    end
+  end
+  
+  def tour
+    respond_to do |format|
+      format.html { render :template => 'default/tour' }
+    end
+  end
+
+end

data/app/controllers/recommender/entries_controller.rb

@@ -0,0 +1,79 @@
+class Recommender::EntriesController < ApplicationController
+
+  def initialize
+    @no_index = true
+  end
+  
+  def index
+    @tags = CloudCache.language_tags('en') unless fragment_exist?({:controller => 'entries', :action => 'index'})
+    respond_to do |format|
+      format.html { render :template => 'entries/index' }
+    end
+  end
+  
+  def browse_by_tags
+    @browse_tags = params[:tags]
+    @top_tags = Entry.top_tags(@browse_tags)
+    @search = @browse_tags.join(' ') if (!@browse_tags.nil? && !@browse_tags.empty?)
+    _search
+    respond_to do |format|
+      format.html { render :template => 'entries/browse_by_tags' }
+    end
+  end
+  
+  def show
+    @search = params[:q]
+    _search
+    respond_to do |format|
+      format.html { render :template => 'entries/search' }
+    end
+  end
+  
+  def _search
+    @offset = (params[:offset] || 0).to_i
+    @limit = (params[:limit] || 10).to_i
+    @term_list = URI.escape(@search) if !@search.nil?
+    if !@search.nil?
+      results = Entry.search(@search, 'en', @limit, @offset)
+      @results = results.results
+      @hit_count = results.total
+    end
+  end
+
+  def show_old
+    @languages = Language.find(:all, :order => "name")
+    @page_title = "Related Resources"
+    @entry = Entry.find(params[:id], :include => :feed)
+    if @entry.nil?
+      render_text "Unable to find the specified document"
+      return
+    end
+    @entry_title = @entry.title + " (" + @entry.feed.short_title + ")"
+    I18n.locale = @entry.language[0..1]
+    @limit = params[:limit] ? params[:limit].to_i : 20
+    @limit = 40 if @limit > 40
+
+    respond_to do |format|
+      format.html { 
+      if params[:details] == 'true'
+        render :template => "documents/details", :layout => "default"
+      else
+        render :template => "documents/show", :layout => "default"
+      end
+      }# show.html.erb
+      format.xml  { render :xml => @entry }
+    end
+  end
+  
+  def track_clicks
+    user_agent = request.env['HTTP_USER_AGENT']
+    redirect_to Entry.track_click(session, params[:id], request.env['HTTP_REFERER'], params[:target], request.env['HTTP_X_FORWARDED_FOR'], user_agent) if !/Googlebot/.match(user_agent) 
+  end
+  
+  def collections
+    @feeds = Feed.find(:all, :order => "harvested_from_title, title")
+    @languages = Language.find(:all, :order => "name")
+    render :template => "documents/collections", :layout => "default"
+  end
+
+end

data/app/controllers/recommender/recommendations_controller.rb

@@ -0,0 +1,46 @@
+class Recommender::EntriesController < ApplicationController
+  
+  # GET /recommendations
+  # GET /recommendations.xml
+  def index
+    @details = params[:details] == "true"
+
+    @referrer = request.env['HTTP_REFERER']
+    @uri = params[:u] || @referrer
+    
+    if params[:educommons]
+      @uri = @uri[%r=http://.*?/.*?/[^/]+=] || @uri
+      params[:title] = true
+      params[:more_link] = true
+    end
+
+    Entry.track_time_on_page(session, @uri)
+    @document = Entry.recommender_entry(@uri)
+    I18n.locale = @document.language[0..1] if !@document.nil?
+
+    @limit = params[:limit] ? params[:limit].to_i : 5
+    @limit = 25 if @limit > 25
+    
+    respond_to do |format|
+      format.html {
+        @languages = Language.find(:all, :order => "name")
+        order = params[:order] || "mixed"
+        redirect_to "/documents/" + @document.id.to_s + "?limit=" + @limit.to_s + "&order=" + order + "&details=" + @details.to_s if !@document.nil?
+        render(:template => '/recommendations/document_not_found.html.erb', :layout => false) if @document.nil?
+      } 
+      format.xml  { 
+        render(:template => '/recommendations/index.xml.builder', :layout => false) 
+      }
+      format.pjs {
+        if @document.nil?
+          render_text ""
+        else
+          @host = "http://" + URI.parse(@uri).host
+          render(:template => 'recommendations/index.pjs.erb', :layout => false)  
+        end
+      }
+      format.rss { render(:template => 'recommendations/index.rss.builder', :layout => false)  }
+    end
+  end
+  
+end

data/app/controllers/recommender/search_controller.rb

@@ -0,0 +1,82 @@
+class Recommender::SearchController < ApplicationController
+
+  def initialize
+    @limit = 50
+    @no_index = true
+  end
+
+  #########################################################
+  # Show search page if there is nothing specified to search for
+  # or if there are searchable params search for them
+  def index
+    if request.post?
+      if params[:form_terms].nil? or params[:form_terms].empty?
+        flash[:message] = 'Please enter something to search for.'
+      else
+        redirect_to '/search/results?terms=' + URI.escape(params[:form_terms])
+      end
+    end
+  end
+
+  #########################################################
+  # search all fields for the given terms
+  def results
+    @page_title = "Search"
+    @language = params[:locale] || 'en'
+    @languages = Language.find(:all, :order => "name")
+    @limit = params[:limit] ? params[:limit].to_i : 10
+    @limit = 25 if @limit > 25
+    @offset = params[:offset] ? params[:offset].to_i : 0
+    @term_list = ''
+    if !params[:terms].nil? && !params[:terms].empty?
+      @term_list += URI.escape(params[:terms])
+    end
+
+    if request.post?
+      if params[:form_terms].nil? or params[:form_terms].empty?
+        flash[:message] = 'Please enter something to search for.'
+        redirect_to '/'
+      else
+        redirect_to '/search/results?terms=' + URI.escape(params[:form_terms]) + (@language.nil? ? "" : "&locale=" + @language)
+      end
+    else
+      @current_uri = '/search/results'
+      if params[:terms]
+        @url_terms = '?terms=' + @term_list
+        results = Entry.search(URI.unescape(params[:terms]), @language, @limit, @offset)
+        @results = results.records
+        @hit_count = results.total
+        @terms = URI.unescape(params[:terms])
+      else
+        @url_terms = ''
+        @results = []
+        @terms = '' 
+      end
+
+      respond_to do |format|
+        format.html 
+        format.xml  { render :layout=>false }
+        format.rss  { render :layout=>false }
+        format.pjs { 
+          @json_results = ActiveSupport::JSON.encode(@results)
+          render(:template => 'search/results.pjs.erb', :layout => false)  
+        }
+        format.atom { render :layout=>false }
+        format.rdf  { render :layout=>false }
+      end
+    end
+  end
+
+  #########################################################
+  # all the results are rendered the same
+  def render_search
+    respond_to do |format|
+      format.html { render :template => '/search/index' }
+      format.xml  { render :xml => flash.to_xml }
+      format.rss  { render :xml => flash.to_xml }
+      format.atom  { render :xml => flash.to_xml }
+      format.rdf  { render :xml => flash.to_xml }
+    end
+  end
+
+end

data/app/helpers/muck_raker_helper.rb

@@ -0,0 +1,29 @@
+module MuckRakerHelper
+
+  def tag_cloud(tag_list, classes)
+    tag_list.split(',').each_slice(2){|tag,index| yield tag, classes[index.to_i]}
+  end
+  
+  def round(flt)
+    return (((flt.to_f*100).to_i.round).to_f)/100.0
+  end
+
+  def truncate_on_word(text, length = 270, end_string = ' ...')
+    if text.length > length
+      stop_index = text.rindex(' ', length)
+      stop_index = length - 10 if stop_index < length-10
+      text[0,stop_index] + (text.length > 260 ? end_string : '')
+    else
+      text
+    end
+  end
+  
+  def truncate_words(text, length = 40, end_string = ' ...')
+    words = text.split()
+    words[0..(length-1)].join(' ') + (words.length > length ? end_string : '')
+  end
+  
+  def feed_query_uri(feed)
+    "/search/results?terms=feed_id:" + feed.id.to_s + "&locale=en"
+  end
+end

data/app/models/click.rb

@@ -0,0 +1,2 @@
+class Click < ActiveRecord::Base
+end

data/app/models/cloud_cache.rb

@@ -0,0 +1,9 @@
+class CloudCache < ActiveRecord::Base
+  
+  def self.language_tags language
+    english_id = 38
+    results = CloudCache.find(:all, :conditions => ["language_id = ? AND filter = 'all'", english_id])
+    results.empty? ? '' : results[0].tag_list
+  end
+  
+end